2 * Header file for the Linux CAN-bus driver.
3 * Written by Arnaud Westenberg email:arnaud@wanadoo.nl
4 * Rewritten for new CAN queues by Pavel Pisa - OCERA team member
5 * email:pisa@cmp.felk.cvut.cz
6 * This software is released under the GPL-License.
7 * Version lincan-0.2 9 Jul 2003
11 #include "./constants.h"
12 #include "./can_sysdep.h"
13 #include "./can_queue.h"
16 #define DEBUGMSG(fmt,args...) can_printk(KERN_ERR "can.o (debug): " fmt,\
19 #define DEBUGMSG(fmt,args...)
22 #define CANMSG(fmt,args...) can_printk(KERN_ERR "can.o: " fmt,##args)
25 extern can_spinlock_t canuser_manipulation_lock;
28 * struct canhardware_t - structure representing pointers to all CAN boards
29 * @nr_boards: number of present boards
30 * @rtr_queue: RTR - remote transmission request queue (expect some changes there)
31 * @rtr_lock: locking for RTR queue
32 * @candevice: array of pointers to CAN devices/boards
34 struct canhardware_t {
36 struct rtr_id *rtr_queue;
37 can_spinlock_t rtr_lock;
38 struct candevice_t *candevice[MAX_HW_CARDS];
42 * struct candevice_t - CAN device/board structure
43 * @hwname: text string with board type
44 * @candev_idx: board index in canhardware_t.candevice[]
45 * @io_addr: IO/physical MEM address
46 * @res_addr: optional reset register port
47 * @dev_base_addr: CPU translated IO/virtual MEM address
48 * @flags: board flags: %PROGRAMMABLE_IRQ .. interrupt number
49 * can be programmed into board
50 * @nr_all_chips: number of chips present on the board
51 * @nr_82527_chips: number of Intel 8257 chips
52 * @nr_sja1000_chips: number of Philips SJA100 chips
53 * @chip: array of pointers to the chip structures
54 * @hwspecops: pointer to board specific operations
55 * @hosthardware_p: pointer to the root hardware structure
57 * The structure represent configuration and state of associated board.
58 * The driver infrastructure prepares this structure and calls
59 * board type specific board_register() function. The board support provided
60 * register function fills right function pointers in @hwspecops structure.
61 * Then driver setup calls functions init_hw_data(), init_chip_data(),
62 * init_chip_data(), init_obj_data() and program_irq(). Function init_hw_data()
63 * and init_chip_data() have to specify number and types of connected chips
64 * or objects respectively.
65 * The use of @nr_all_chips is preferred over use of fields @nr_82527_chips
66 * and @nr_sja1000_chips in the board non-specific functions.
67 * The @io_addr and @dev_base_addr is filled from module parameters
68 * to the same value. The request_io function can fix-up @dev_base_addr
69 * field if virtual address is different than bus address.
72 char *hwname; /* text board type */
73 int candev_idx; /* board index in canhardware_t.candevice[] */
74 unsigned long io_addr; /* IO/physical MEM address */
75 unsigned long res_addr; /* optional seset register port */
76 unsigned long dev_base_addr; /* CPU translated IO/virtual MEM address */
81 struct chip_t *chip[MAX_HW_CHIPS];
83 struct hwspecops_t *hwspecops;
85 struct canhardware_t *hosthardware_p;
89 * struct chip_t - CAN chip state and type information
90 * @chip_type: text string describing chip type
91 * @chip_idx: index of the chip in candevice_t.chip[] array
92 * @chip_irq: chip interrupt number if any
93 * @chip_base_addr: chip base address in the CPU IO or virtual memory space
94 * @flags: chip flags: %CHIP_CONFIGURED .. chip is configured,
95 * %CHIP_SEGMENTED .. access to the chip is segmented (mainly for i82527 chips)
96 * @clock: chip base clock frequency in Hz
97 * @baudrate: selected chip baudrate in Hz
98 * @write_register: write chip register function copy -
99 * @read_register: read chip register function copy
100 * @sja_cdr_reg: SJA specific register -
101 * holds hardware specific options for the Clock Divider
102 * register. Options defined in the sja1000.h file:
103 * %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN
104 * @sja_ocr_reg: SJA specific register -
105 * hold hardware specific options for the Output Control
106 * register. Options defined in the sja1000.h file:
107 * %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK,
108 * %OCR_TX0_LH, %OCR_TX1_ZZ.
109 * @int_cpu_reg: Intel specific register -
110 * holds hardware specific options for the CPU Interface
111 * register. Options defined in the i82527.h file:
112 * %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
113 * @int_clk_reg: Intel specific register -
114 * holds hardware specific options for the Clock Out
115 * register. Options defined in the i82527.h file:
116 * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
117 * @int_bus_reg: Intel specific register -
118 * holds hardware specific options for the Bus Configuration
119 * register. Options defined in the i82527.h file:
120 * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
121 * @msgobj: array of pointers to individual communication objects
122 * @chipspecops: pointer to the set of chip specific object filled by init_chip_data() function
123 * @hostdevice: pointer to chip hosting board
124 * @max_objects: maximal number of communication objects connected to this chip
126 * The fields @write_register and @read_register are copied from
127 * corresponding fields from @hwspecops structure
128 * (chip->hostdevice->hwspecops->write_register and
129 * chip->hostdevice->hwspecops->read_register)
130 * to speedup can_write_reg() and can_read_reg() functions.
134 int chip_idx; /* chip index in candevice_t.chip[] */
136 unsigned long chip_base_addr;
138 long clock; /* Chip clock in Hz */
141 void (*write_register)(unsigned char data,unsigned long address);
142 unsigned (*read_register)(unsigned long address);
144 unsigned short sja_cdr_reg; /* sja1000 only! */
145 unsigned short sja_ocr_reg; /* sja1000 only! */
146 unsigned short int_cpu_reg; /* intel 82527 only! */
147 unsigned short int_clk_reg; /* intel 82527 only! */
148 unsigned short int_bus_reg; /* intel 82527 only! */
150 struct msgobj_t *msgobj[MAX_MSGOBJS];
152 struct chipspecops_t *chipspecops;
154 struct candevice_t *hostdevice;
156 int max_objects; /* 1 for sja1000, 15 for i82527 */
158 can_spinlock_t chip_lock;
161 pthread_t worker_thread;
162 unsigned long pend_flags;
163 #endif /*CAN_WITH_RTL*/
167 * struct msgobj_t - structure holding communication object state
169 * @minor: associated device minor number
170 * @object: object number in chip_t structure +1
171 * @flags: message object flags
172 * @ret: field holding status of the last Tx operation
173 * @qends: pointer to message object corresponding ends structure
174 * @tx_qedge: edge corresponding to transmitted message
175 * @tx_slot: slot holding transmitted message, slot is taken from
176 * canque_test_outslot() call and is freed by canque_free_outslot()
177 * or rescheduled canque_again_outslot()
178 * @tx_retry_cnt: transmission attempt counter
179 * @tx_timeout: can be used by chip driver to check for the transmission timeout
180 * @rx_msg: temporary storage to hold received messages before
181 * calling to canque_filter_msg2edges()
182 * @hostchip: pointer to the &chip_t structure this object belongs to
183 * @obj_used: counter of users (associated file structures for Linux
184 * userspace clients) of this object
185 * @obj_users: list of user structures of type &canuser_t.
188 unsigned long obj_base_addr;
189 unsigned int minor; /* associated device minor number */
190 unsigned int object; /* object number in chip_t +1 for debug printk */
191 unsigned long obj_flags;
194 struct canque_ends_t *qends;
196 struct canque_edge_t *tx_qedge;
197 struct canque_slot_t *tx_slot;
199 struct timer_list tx_timeout;
201 struct canmsg_t rx_msg;
203 struct chip_t *hostchip;
206 struct list_head obj_users;
209 #define CAN_USER_MAGIC 0x05402033
212 * struct canuser_t - structure holding CAN user/client state
213 * @flags: used to distinguish Linux/RT-Linux type
214 * @peers: for connection into list of object users
215 * @qends: pointer to the ends structure corresponding for this user
216 * @msgobj: communication object the user is connected to
217 * @rx_edge0: default receive queue for filter IOCTL
218 * @userinfo: stores user context specific information.
219 * The field @fileinfo.file holds pointer to open device file state structure
220 * for the Linux user-space client applications
221 * @magic: magic number to check consistency when pointer is retrieved
222 * from file private field
226 struct list_head peers;
227 struct canque_ends_t *qends;
228 struct msgobj_t *msgobj;
229 struct canque_edge_t *rx_edge0; /* simplifies IOCTL */
232 struct file *file; /* back ptr to file */
236 struct rtl_file *file;
238 #endif /*CAN_WITH_RTL*/
244 * struct hwspecops_t - hardware/board specific operations
245 * @request_io: reserve io or memory range for can board
246 * @release_io: free reserved io memory range
247 * @reset: hardware reset routine
248 * @init_hw_data: called to initialize &candevice_t structure, mainly
249 * @res_add, @nr_all_chips, @nr_82527_chips, @nr_sja1000_chips
251 * @init_chip_data: called initialize each &chip_t structure, mainly
252 * @chip_type, @chip_base_addr, @clock and chip specific registers.
253 * It is responsible to setup &chip_t->@chipspecops functions
254 * for non-standard chip types (type other than "i82527", "sja1000" or "sja1000p")
255 * @init_obj_data: called initialize each &msgobj_t structure,
256 * mainly @obj_base_addr field.
257 * @program_irq: program interrupt generation hardware of the board
258 * if flag %PROGRAMMABLE_IRQ is present for specified device/board
259 * @write_register: low level write register routine
260 * @read_register: low level read register routine
263 int (*request_io)(struct candevice_t *candev);
264 int (*release_io)(struct candevice_t *candev);
265 int (*reset)(struct candevice_t *candev);
266 int (*init_hw_data)(struct candevice_t *candev);
267 int (*init_chip_data)(struct candevice_t *candev, int chipnr);
268 int (*init_obj_data)(struct chip_t *chip, int objnr);
269 int (*program_irq)(struct candevice_t *candev);
270 void (*write_register)(unsigned char data,unsigned long address);
271 unsigned (*read_register)(unsigned long address);
275 * struct chipspecops_t - can controller chip specific operations
276 * @chip_config: CAN chip configuration
277 * @baud_rate: set communication parameters
278 * @standard_mask: setup of mask for message filtering
279 * @extended_mask: setup of extended mask for message filtering
280 * @message15_mask: set mask of i82527 message object 15
281 * @clear_objects: clears state of all message object residing in chip
282 * @config_irqs: tunes chip hardware interrupt delivery
283 * @pre_read_config: prepares message object for message reception
284 * @pre_write_config: prepares message object for message transmission
285 * @send_msg: initiate message transmission
286 * @remote_request: configures message object and asks for RTR message
287 * @check_tx_stat: checks state of transmission engine
288 * @wakeup_tx: wakeup TX processing
289 * @enable_configuration: enable chip configuration mode
290 * @disable_configuration: disable chip configuration mode
291 * @set_btregs: configures bitrate registers
292 * @start_chip: starts chip message processing
293 * @stop_chip: stops chip message processing
294 * @irq_handler: interrupt service routine
296 struct chipspecops_t {
297 int (*chip_config)(struct chip_t *chip);
298 int (*baud_rate)(struct chip_t *chip, int rate, int clock, int sjw,
299 int sampl_pt, int flags);
300 int (*standard_mask)(struct chip_t *chip, unsigned short code,
301 unsigned short mask);
302 int (*extended_mask)(struct chip_t *chip, unsigned long code,
304 int (*message15_mask)(struct chip_t *chip, unsigned long code,
306 int (*clear_objects)(struct chip_t *chip);
307 int (*config_irqs)(struct chip_t *chip, short irqs);
308 int (*pre_read_config)(struct chip_t *chip, struct msgobj_t *obj);
309 int (*pre_write_config)(struct chip_t *chip, struct msgobj_t *obj,
310 struct canmsg_t *msg);
311 int (*send_msg)(struct chip_t *chip, struct msgobj_t *obj,
312 struct canmsg_t *msg);
313 int (*remote_request)(struct chip_t *chip, struct msgobj_t *obj);
314 int (*check_tx_stat)(struct chip_t *chip);
315 int (*wakeup_tx)(struct chip_t *chip, struct msgobj_t *obj);
316 int (*enable_configuration)(struct chip_t *chip);
317 int (*disable_configuration)(struct chip_t *chip);
318 int (*set_btregs)(struct chip_t *chip, unsigned short btr0,
319 unsigned short btr1);
320 int (*start_chip)(struct chip_t *chip);
321 int (*stop_chip)(struct chip_t *chip);
322 can_irqreturn_t (*irq_handler)(int irq, void *dev_id, struct pt_regs *regs);
327 struct mem_addr *next;
331 /* Structure for the RTR queue */
334 struct canmsg_t *rtr_message;
335 wait_queue_head_t rtr_wq;
340 extern int minor[MAX_TOT_CHIPS];
342 extern int baudrate[MAX_TOT_CHIPS];
343 extern char *hw[MAX_HW_CARDS];
344 extern int irq[MAX_IRQ];
345 extern unsigned long io[MAX_HW_CARDS];
346 extern int processlocal;
348 extern struct canhardware_t *hardware_p;
349 extern struct chip_t *chips_p[MAX_TOT_CHIPS];
350 extern struct msgobj_t *objects_p[MAX_TOT_MSGOBJS];
352 extern struct mem_addr *mem_head;
354 /* Inline function to write to the hardware registers. The argument address is
355 * relative to the memory map of the chip and not the absolute memory address.
357 extern inline void can_write_reg(const struct chip_t *chip, unsigned char data, unsigned address)
359 unsigned long address_to_write;
360 address_to_write = chip->chip_base_addr+address;
361 chip->write_register(data, address_to_write);
364 extern inline unsigned can_read_reg(const struct chip_t *chip, unsigned address)
366 unsigned long address_to_read;
367 address_to_read = chip->chip_base_addr+address;
368 return chip->read_register(address_to_read);
371 extern inline void canobj_write_reg(const struct chip_t *chip, const struct msgobj_t *obj,
372 unsigned char data, unsigned address)
374 unsigned long address_to_write;
375 address_to_write = obj->obj_base_addr+address;
376 chip->write_register(data, address_to_write);
379 extern inline unsigned canobj_read_reg(const struct chip_t *chip, const struct msgobj_t *obj,
382 unsigned long address_to_read;
383 address_to_read = obj->obj_base_addr+address;
384 return chip->read_register(address_to_read);
387 int can_base_addr_fixup(struct candevice_t *candev, unsigned long new_base);
388 int can_request_io_region(unsigned long start, unsigned long n, const char *name);
389 void can_release_io_region(unsigned long start, unsigned long n);
390 int can_request_mem_region(unsigned long start, unsigned long n, const char *name);
391 void can_release_mem_region(unsigned long start, unsigned long n);
394 const char *boardtype;
395 int (*board_register)(struct hwspecops_t *hwspecops);
399 const struct boardtype_t* boardtype_find(const char *str);