sja1000.h revision 57c8a456640fa3ca777652f11f2db4179a3e66b6
1429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* 2429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * sja1000.h - Philips SJA1000 network device driver 3429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 4429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Copyright (c) 2003 Matthias Brukner, Trajet Gmbh, Rebenring 33, 5429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 38106 Braunschweig, GERMANY 6429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 7429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Copyright (c) 2002-2007 Volkswagen Group Electronic Research 8429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * All rights reserved. 9429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 10429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Redistribution and use in source and binary forms, with or without 11429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * modification, are permitted provided that the following conditions 12429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * are met: 13429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 1. Redistributions of source code must retain the above copyright 14429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * notice, this list of conditions and the following disclaimer. 15429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 2. Redistributions in binary form must reproduce the above copyright 16429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * notice, this list of conditions and the following disclaimer in the 17429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * documentation and/or other materials provided with the distribution. 18429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 3. Neither the name of Volkswagen nor the names of its contributors 19429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * may be used to endorse or promote products derived from this software 20429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * without specific prior written permission. 21429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 22429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Alternatively, provided that this notice is retained in full, this 23429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * software may be distributed under the terms of the GNU General 24429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Public License ("GPL") version 2, in which case the provisions of the 25429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * GPL apply INSTEAD OF those given above. 26429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 27429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * The provided data structures and external interfaces from this code 28429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * are not restricted to be used by modules with a GPL compatible license. 29429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 30429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 31429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 32429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 33429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 34429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 35429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 36429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 37429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 38429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 39429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 40429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 41429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * DAMAGE. 42429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 43429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Send feedback to <socketcan-users@lists.berlios.de> 44429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * 45429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger */ 46429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 47429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#ifndef SJA1000_DEV_H 48429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SJA1000_DEV_H 49429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 50429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#include <linux/can/dev.h> 51429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#include <linux/can/platform/sja1000.h> 52429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 53a6e4bc5304033e434fabccabb230b8e9ff55d76fWolfgang Grandegger#define SJA1000_ECHO_SKB_MAX 1 /* the SJA1000 has one TX buffer object */ 54a6e4bc5304033e434fabccabb230b8e9ff55d76fWolfgang Grandegger 55429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SJA1000_MAX_IRQ 20 /* max. number of interrupts handled in ISR */ 56429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 57429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* SJA1000 registers - manual section 6.4 (Pelican Mode) */ 58429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_MOD 0x00 59429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_CMR 0x01 60429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_SR 0x02 61429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_IR 0x03 62429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_IER 0x04 63429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ALC 0x0B 64429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ECC 0x0C 65429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_EWL 0x0D 66429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_RXERR 0x0E 67429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_TXERR 0x0F 68429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCC0 0x10 69429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCC1 0x11 70429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCC2 0x12 71429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCC3 0x13 72429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCM0 0x14 73429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCM1 0x15 74429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCM2 0x16 75429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ACCM3 0x17 76429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_RMC 0x1D 77429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_RBSA 0x1E 78429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 79429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* Common registers - manual section 6.5 */ 80429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_BTR0 0x06 81429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_BTR1 0x07 82429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_OCR 0x08 83429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_CDR 0x1F 84429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 85429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_FI 0x10 86429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SFF_BUF 0x13 87429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define EFF_BUF 0x15 88429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 89429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define FI_FF 0x80 90429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define FI_RTR 0x40 91429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 92429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ID1 0x11 93429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ID2 0x12 94429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ID3 0x13 95429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define REG_ID4 0x14 96429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 97429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CAN_RAM 0x20 98429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 99429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* mode register */ 100429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define MOD_RM 0x01 101429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define MOD_LOM 0x02 102429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define MOD_STM 0x04 103429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define MOD_AFM 0x08 104429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define MOD_SM 0x10 105429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 106429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* commands */ 107429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CMD_SRR 0x10 108429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CMD_CDO 0x08 109429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CMD_RRB 0x04 110429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CMD_AT 0x02 111429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define CMD_TR 0x01 112429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 113429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* interrupt sources */ 114429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_BEI 0x80 115429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_ALI 0x40 116429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_EPI 0x20 117429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_WUI 0x10 118429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_DOI 0x08 119429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_EI 0x04 120429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_TI 0x02 121429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_RI 0x01 122429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_ALL 0xFF 123429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define IRQ_OFF 0x00 124429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 125429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* status register content */ 126429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_BS 0x80 127429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_ES 0x40 128429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_TS 0x20 129429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_RS 0x10 130429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_TCS 0x08 131429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_TBS 0x04 132429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_DOS 0x02 133429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_RBS 0x01 134429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 135429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SR_CRIT (SR_BS|SR_ES) 136429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 137429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* ECC register */ 138429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_SEG 0x1F 139429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_DIR 0x20 140429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_ERR 6 141429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_BIT 0x00 142429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_FORM 0x40 143429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_STUFF 0x80 144429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define ECC_MASK 0xc0 145429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 146429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* 147429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * Flags for sja1000priv.flags 148429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger */ 149429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#define SJA1000_CUSTOM_IRQ_HANDLER 0x1 150429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 151429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger/* 152429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger * SJA1000 private data structure 153429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger */ 154429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggerstruct sja1000_priv { 155429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger struct can_priv can; /* must be the first member */ 156429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger int open_time; 157429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger struct sk_buff *echo_skb; 158429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 159429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger /* the lower-layer is responsible for appropriate locking */ 160255a9154319d3cf475d527458037758935f6445bWolfgang Grandegger u8 (*read_reg) (const struct sja1000_priv *priv, int reg); 161255a9154319d3cf475d527458037758935f6445bWolfgang Grandegger void (*write_reg) (const struct sja1000_priv *priv, int reg, u8 val); 162255a9154319d3cf475d527458037758935f6445bWolfgang Grandegger void (*pre_irq) (const struct sja1000_priv *priv); 163255a9154319d3cf475d527458037758935f6445bWolfgang Grandegger void (*post_irq) (const struct sja1000_priv *priv); 164429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 165429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger void *priv; /* for board-specific data */ 166429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger struct net_device *dev; 167429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 168255a9154319d3cf475d527458037758935f6445bWolfgang Grandegger void __iomem *reg_base; /* ioremap'ed address to registers */ 169429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger unsigned long irq_flags; /* for request_irq() */ 17057c8a456640fa3ca777652f11f2db4179a3e66b6Oliver Hartkopp spinlock_t cmdreg_lock; /* lock for concurrent cmd register writes */ 171429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 172429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger u16 flags; /* custom mode flags */ 173429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger u8 ocr; /* output control register */ 174429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger u8 cdr; /* clock divider register */ 175429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger}; 176429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 177429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggerstruct net_device *alloc_sja1000dev(int sizeof_priv); 178429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggervoid free_sja1000dev(struct net_device *dev); 179429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggerint register_sja1000dev(struct net_device *dev); 180429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggervoid unregister_sja1000dev(struct net_device *dev); 181429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 182429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandeggerirqreturn_t sja1000_interrupt(int irq, void *dev_id); 183429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger 184429da1cc841bc9f2e762fd7272fc2b80314b890aWolfgang Grandegger#endif /* SJA1000_DEV_H */ 185