Added support for Unicontrols PCI CAN card.
[lincan.git] / lincan / include / main.h
1 /* main.h
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
8  */
9
10 #include "./can.h"
11 #include "./constants.h"
12 #include "./can_sysdep.h"
13 #include "./can_queue.h"
14 #include "lincan_config.h"
15
16 #ifdef CAN_DEBUG
17         #define DEBUGMSG(fmt,args...) can_printk(KERN_ERR "can.o (debug): " fmt,\
18         ##args)
19 #else
20         #define DEBUGMSG(fmt,args...)
21 #endif
22
23 #define CANMSG(fmt,args...) can_printk(KERN_ERR "can.o: " fmt,##args)
24
25
26 extern can_spinlock_t canuser_manipulation_lock;
27
28 /**
29  * struct canhardware_t - structure representing pointers to all CAN boards
30  * @nr_boards: number of present boards
31  * @rtr_queue: RTR - remote transmission request queue (expect some changes there)
32  * @rtr_lock: locking for RTR queue
33  * @candevice: array of pointers to CAN devices/boards
34  */
35 struct canhardware_t {
36         int nr_boards;
37         struct rtr_id *rtr_queue;
38         can_spinlock_t rtr_lock;
39         struct candevice_t *candevice[MAX_HW_CARDS];
40 };
41
42 /**
43  * struct candevice_t - CAN device/board structure
44  * @hwname: text string with board type
45  * @candev_idx: board index in canhardware_t.candevice[]
46  * @io_addr: IO/physical MEM address
47  * @res_addr: optional reset register port
48  * @dev_base_addr: CPU translated IO/virtual MEM address
49  * @flags: board flags: %PROGRAMMABLE_IRQ .. interrupt number
50  *      can be programmed into board
51  * @nr_all_chips: number of chips present on the board
52  * @nr_82527_chips: number of Intel 8257 chips 
53  * @nr_sja1000_chips: number of Philips SJA100 chips
54  * @chip: array of pointers to the chip structures
55  * @hwspecops: pointer to board specific operations
56  * @hosthardware_p: pointer to the root hardware structure
57  * @sysdevptr: union reserved for pointer to bus specific
58  *      device structure (case @pcidev is used for PCI devices)
59  *
60  * The structure represent configuration and state of associated board.
61  * The driver infrastructure prepares this structure and calls
62  * board type specific board_register() function. The board support provided
63  * register function fills right function pointers in @hwspecops structure.
64  * Then driver setup calls functions init_hw_data(), init_chip_data(),
65  * init_chip_data(), init_obj_data() and program_irq(). Function init_hw_data()
66  * and init_chip_data() have to specify number and types of connected chips
67  * or objects respectively.
68  * The use of @nr_all_chips is preferred over use of fields @nr_82527_chips
69  * and @nr_sja1000_chips in the board non-specific functions.
70  * The @io_addr and @dev_base_addr is filled from module parameters
71  * to the same value. The request_io function can fix-up @dev_base_addr
72  * field if virtual address is different than bus address.
73  */
74 struct candevice_t {
75         char *hwname;                   /* text board type */
76         int candev_idx;                 /* board index in canhardware_t.candevice[] */
77         unsigned long io_addr;          /* IO/physical MEM address */
78         unsigned long res_addr;         /* optional seset register port */
79         unsigned long dev_base_addr;    /* CPU translated IO/virtual MEM address */
80         unsigned int flags;
81         int nr_all_chips;
82         int nr_82527_chips;
83         int nr_sja1000_chips;
84         struct chip_t *chip[MAX_HW_CHIPS];
85
86         struct hwspecops_t *hwspecops;
87
88         struct canhardware_t *hosthardware_p;
89         
90         union {
91                 void *anydev;
92             #ifdef CAN_ENABLE_PCI_SUPPORT
93                 struct pci_dev *pcidev;
94             #endif /*CAN_ENABLE_PCI_SUPPORT*/
95         } sysdevptr;
96
97 };
98
99 /**
100  * struct chip_t - CAN chip state and type information
101  * @chip_type: text string describing chip type
102  * @chip_idx: index of the chip in candevice_t.chip[] array
103  * @chip_irq: chip interrupt number if any
104  * @chip_base_addr: chip base address in the CPU IO or virtual memory space
105  * @flags: chip flags: %CHIP_CONFIGURED .. chip is configured,
106  *      %CHIP_SEGMENTED .. access to the chip is segmented (mainly for i82527 chips)
107  * @clock: chip base clock frequency in Hz
108  * @baudrate: selected chip baudrate in Hz
109  * @write_register: write chip register function copy
110  * @read_register: read chip register function copy
111  * @chip_data: pointer for optional chip specific data extension
112  * @sja_cdr_reg: SJA specific register -
113  *      holds hardware specific options for the Clock Divider
114  *      register. Options defined in the sja1000.h file:
115  *      %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN
116  * @sja_ocr_reg: SJA specific register -
117  *      hold hardware specific options for the Output Control
118  *      register. Options defined in the sja1000.h file:
119  *      %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK,
120  *      %OCR_TX0_LH, %OCR_TX1_ZZ.
121  * @int_cpu_reg: Intel specific register -
122  *      holds hardware specific options for the CPU Interface
123  *      register. Options defined in the i82527.h file:
124  *      %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
125  * @int_clk_reg: Intel specific register -
126  *      holds hardware specific options for the Clock Out
127  *      register. Options defined in the i82527.h file:
128  *      %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
129  * @int_bus_reg: Intel specific register -
130  *      holds hardware specific options for the Bus Configuration
131  *      register. Options defined in the i82527.h file:
132  *      %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
133  * @msgobj: array of pointers to individual communication objects
134  * @chipspecops: pointer to the set of chip specific object filled by init_chip_data() function
135  * @hostdevice: pointer to chip hosting board
136  * @max_objects: maximal number of communication objects connected to this chip
137  * @chip_lock: reserved for synchronization of the chip supporting routines
138  *      (not used in the current driver version)
139  * @worker_thread: chip worker thread ID (RT-Linux specific field)
140  * @pend_flags: holds information about pending interrupt and tx_wake() operations
141  *      (RT-Linux specific field). Masks values:
142  *      %MSGOBJ_TX_REQUEST .. some of the message objects requires tx_wake() call, 
143  *      %MSGOBJ_IRQ_REQUEST .. chip interrupt processing required
144  *      %MSGOBJ_WORKER_WAKE .. marks, that worker thread should be waked
145  *              for some of above reasons
146  *
147  * The fields @write_register and @read_register are copied from
148  * corresponding fields from @hwspecops structure
149  * (chip->hostdevice->hwspecops->write_register and 
150  * chip->hostdevice->hwspecops->read_register)
151  * to speedup can_write_reg() and can_read_reg() functions.
152  */
153 struct chip_t {
154         char *chip_type;
155         int chip_idx;   /* chip index in candevice_t.chip[] */
156         int chip_irq;
157         unsigned long chip_base_addr;
158         unsigned int flags;
159         long clock; /* Chip clock in Hz */
160         long baudrate;
161
162         void (*write_register)(unsigned char data,unsigned long address);
163         unsigned (*read_register)(unsigned long address);
164         
165         void *chip_data;
166         
167         unsigned short sja_cdr_reg; /* sja1000 only! */
168         unsigned short sja_ocr_reg; /* sja1000 only! */
169         unsigned short int_cpu_reg; /* intel 82527 only! */
170         unsigned short int_clk_reg; /* intel 82527 only! */
171         unsigned short int_bus_reg; /* intel 82527 only! */
172
173         struct msgobj_t *msgobj[MAX_MSGOBJS];
174
175         struct chipspecops_t *chipspecops;
176
177         struct candevice_t *hostdevice;
178         
179         int max_objects;        /* 1 for sja1000, 15 for i82527 */
180
181         can_spinlock_t chip_lock;
182
183     #ifdef CAN_WITH_RTL
184         pthread_t worker_thread;
185         unsigned long pend_flags;
186     #endif /*CAN_WITH_RTL*/
187 };
188
189 /**
190  * struct msgobj_t - structure holding communication object state
191  * @obj_base_addr: 
192  * @minor: associated device minor number
193  * @object: object number in chip_t structure +1
194  * @flags: message object flags
195  * @ret: field holding status of the last Tx operation
196  * @qends: pointer to message object corresponding ends structure
197  * @tx_qedge: edge corresponding to transmitted message
198  * @tx_slot: slot holding transmitted message, slot is taken from
199  *      canque_test_outslot() call and is freed by canque_free_outslot()
200  *      or rescheduled canque_again_outslot()
201  * @tx_retry_cnt: transmission attempt counter
202  * @tx_timeout: can be used by chip driver to check for the transmission timeout
203  * @rx_msg: temporary storage to hold received messages before
204  *      calling to canque_filter_msg2edges()
205  * @hostchip: pointer to the &chip_t structure this object belongs to
206  * @obj_used: counter of users (associated file structures for Linux
207  *      userspace clients) of this object
208  * @obj_users: list of user structures of type &canuser_t.
209  * @obj_flags: message object specific flags. Masks values:
210  *      %MSGOBJ_TX_REQUEST .. the message object requests TX activation
211  *      %MSGOBJ_TX_LOCK .. some IRQ routine or callback on some CPU 
212  *              is running inside TX activation processing code
213  */
214 struct msgobj_t {
215         unsigned long obj_base_addr;
216         unsigned int minor;     /* associated device minor number  */
217         unsigned int object;    /* object number in chip_t +1 for debug printk */
218         unsigned long obj_flags; 
219         int ret;
220
221         struct canque_ends_t *qends;
222
223         struct canque_edge_t *tx_qedge;
224         struct canque_slot_t *tx_slot;
225         int tx_retry_cnt;
226         struct timer_list tx_timeout;
227         
228         struct canmsg_t rx_msg;
229
230         struct chip_t *hostchip;
231
232         atomic_t obj_used;
233         struct list_head obj_users;
234 };
235
236 #define CAN_USER_MAGIC 0x05402033
237
238 /**
239  * struct canuser_t - structure holding CAN user/client state
240  * @flags: used to distinguish Linux/RT-Linux type
241  * @peers: for connection into list of object users
242  * @qends: pointer to the ends structure corresponding for this user
243  * @msgobj: communication object the user is connected to
244  * @rx_edge0: default receive queue for filter IOCTL
245  * @userinfo: stores user context specific information.
246  *      The field @fileinfo.file holds pointer to open device file state structure
247  *      for the Linux user-space client applications
248  * @magic: magic number to check consistency when pointer is retrieved
249  *      from file private field
250  */
251 struct canuser_t {
252         unsigned long flags;
253         struct list_head peers;
254         struct canque_ends_t *qends;
255         struct msgobj_t *msgobj;
256         struct canque_edge_t *rx_edge0; /* simplifies IOCTL */
257         union {
258                 struct {
259                         struct file *file;  /* back ptr to file */
260                 } fileinfo;
261             #ifdef CAN_WITH_RTL
262                 struct {
263                         struct rtl_file *file;
264                 } rtlinfo;
265             #endif /*CAN_WITH_RTL*/
266         } userinfo;
267         int magic;
268 };
269
270 /**
271  * struct hwspecops_t - hardware/board specific operations
272  * @request_io: reserve io or memory range for can board
273  * @release_io: free reserved io memory range
274  * @reset: hardware reset routine
275  * @init_hw_data: called to initialize &candevice_t structure, mainly 
276  *      @res_add, @nr_all_chips, @nr_82527_chips, @nr_sja1000_chips
277  *      and @flags fields
278  * @init_chip_data: called initialize each &chip_t structure, mainly
279  *      @chip_type, @chip_base_addr, @clock and chip specific registers.
280  *      It is responsible to setup &chip_t->@chipspecops functions
281  *      for non-standard chip types (type other than "i82527", "sja1000" or "sja1000p")
282  * @init_obj_data: called initialize each &msgobj_t structure,
283  *      mainly @obj_base_addr field.
284  * @program_irq: program interrupt generation hardware of the board
285  *      if flag %PROGRAMMABLE_IRQ is present for specified device/board 
286  * @write_register: low level write register routine
287  * @read_register: low level read register routine
288  */
289 struct hwspecops_t {
290         int (*request_io)(struct candevice_t *candev);
291         int (*release_io)(struct candevice_t *candev);
292         int (*reset)(struct candevice_t *candev);
293         int (*init_hw_data)(struct candevice_t *candev);
294         int (*init_chip_data)(struct candevice_t *candev, int chipnr);
295         int (*init_obj_data)(struct chip_t *chip, int objnr);
296         int (*program_irq)(struct candevice_t *candev);
297         void (*write_register)(unsigned char data,unsigned long address);
298         unsigned (*read_register)(unsigned long address);
299 };
300
301 /**
302  * struct chipspecops_t - can controller chip specific operations
303  * @chip_config: CAN chip configuration
304  * @baud_rate: set communication parameters
305  * @standard_mask: setup of mask for message filtering
306  * @extended_mask: setup of extended mask for message filtering
307  * @message15_mask: set mask of i82527 message object 15
308  * @clear_objects: clears state of all message object residing in chip
309  * @config_irqs: tunes chip hardware interrupt delivery
310  * @pre_read_config: prepares message object for message reception
311  * @pre_write_config: prepares message object for message transmission
312  * @send_msg: initiate message transmission
313  * @remote_request: configures message object and asks for RTR message
314  * @check_tx_stat: checks state of transmission engine
315  * @wakeup_tx: wakeup TX processing
316  * @filtch_rq: optional routine for propagation of outgoing edges filters to HW
317  * @enable_configuration: enable chip configuration mode
318  * @disable_configuration: disable chip configuration mode
319  * @set_btregs: configures bitrate registers
320  * @start_chip: starts chip message processing
321  * @stop_chip: stops chip message processing
322  * @irq_handler: interrupt service routine
323  */
324 struct chipspecops_t {
325         int (*chip_config)(struct chip_t *chip);
326         int (*baud_rate)(struct chip_t *chip, int rate, int clock, int sjw,
327                                                 int sampl_pt, int flags);
328         int (*standard_mask)(struct chip_t *chip, unsigned short code, 
329                                                         unsigned short mask);
330         int (*extended_mask)(struct chip_t *chip, unsigned long code, 
331                                                         unsigned long mask);
332         int (*message15_mask)(struct chip_t *chip, unsigned long code, 
333                                                         unsigned long mask);
334         int (*clear_objects)(struct chip_t *chip);
335         int (*config_irqs)(struct chip_t *chip, short irqs);
336         int (*pre_read_config)(struct chip_t *chip, struct msgobj_t *obj);
337         int (*pre_write_config)(struct chip_t *chip, struct msgobj_t *obj,
338                                                         struct canmsg_t *msg);
339         int (*send_msg)(struct chip_t *chip, struct msgobj_t *obj,
340                                                         struct canmsg_t *msg);
341         int (*remote_request)(struct chip_t *chip, struct msgobj_t *obj);
342         int (*check_tx_stat)(struct chip_t *chip);
343         int (*wakeup_tx)(struct chip_t *chip, struct msgobj_t *obj);
344         int (*filtch_rq)(struct chip_t *chip, struct msgobj_t *obj);
345         int (*enable_configuration)(struct chip_t *chip);
346         int (*disable_configuration)(struct chip_t *chip);
347         int (*set_btregs)(struct chip_t *chip, unsigned short btr0, 
348                                                         unsigned short btr1);
349         int (*start_chip)(struct chip_t *chip);
350         int (*stop_chip)(struct chip_t *chip);
351         can_irqreturn_t (*irq_handler)(int irq, void *dev_id, struct pt_regs *regs);
352 };
353
354 struct mem_addr {
355         void *address;
356         struct mem_addr *next;
357         size_t size;
358 };
359
360 /* Structure for the RTR queue */
361 struct rtr_id {
362         unsigned long id;
363         struct canmsg_t *rtr_message;
364         wait_queue_head_t rtr_wq;
365         struct rtr_id *next;
366 };
367
368 extern int major;
369 extern int minor[MAX_TOT_CHIPS];
370 extern int extended;
371 extern int baudrate[MAX_TOT_CHIPS];
372 extern char *hw[MAX_HW_CARDS];
373 extern int irq[MAX_IRQ];
374 extern unsigned long io[MAX_HW_CARDS];
375 extern int processlocal;
376
377 extern struct canhardware_t *hardware_p;
378 extern struct chip_t *chips_p[MAX_TOT_CHIPS];
379 extern struct msgobj_t *objects_p[MAX_TOT_MSGOBJS];
380
381 extern struct mem_addr *mem_head;
382
383
384 #if defined(CONFIG_OC_LINCAN_PORTIO_ONLY)
385 extern inline void can_write_reg(const struct chip_t *chip, unsigned char data, unsigned address)
386 {
387         outb(data, chip->chip_base_addr+address);
388 }
389 extern inline unsigned can_read_reg(const struct chip_t *chip, unsigned address)
390 {
391         return inb(chip->chip_base_addr+address);
392 }
393 extern inline void canobj_write_reg(const struct chip_t *chip, const struct msgobj_t *obj,
394                                 unsigned char data, unsigned address)
395 {
396         outb(data, obj->obj_base_addr+address);
397 }
398 extern inline unsigned canobj_read_reg(const struct chip_t *chip, const struct msgobj_t *obj,
399                                 unsigned address)
400 {
401         return inb(obj->obj_base_addr+address);
402 }
403
404 #elif defined(CONFIG_OC_LINCAN_MEMIO_ONLY)
405 extern inline void can_write_reg(const struct chip_t *chip, unsigned char data, unsigned address)
406 {
407         writeb(data, chip->chip_base_addr+address);
408 }
409 extern inline unsigned can_read_reg(const struct chip_t *chip, unsigned address)
410 {
411         return readb(chip->chip_base_addr+address);
412 }
413 extern inline void canobj_write_reg(const struct chip_t *chip, const struct msgobj_t *obj,
414                                 unsigned char data, unsigned address)
415 {
416         writeb(data, obj->obj_base_addr+address);
417 }
418 extern inline unsigned canobj_read_reg(const struct chip_t *chip, const struct msgobj_t *obj,
419                                 unsigned address)
420 {
421         return readb(obj->obj_base_addr+address);
422 }
423
424 #else /*CONFIG_OC_LINCAN_DYNAMICIO*/
425 #ifndef CONFIG_OC_LINCAN_DYNAMICIO
426 #define CONFIG_OC_LINCAN_DYNAMICIO
427 #endif
428
429 /* Inline function to write to the hardware registers. The argument address is 
430  * relative to the memory map of the chip and not the absolute memory address.
431  */
432 extern inline void can_write_reg(const struct chip_t *chip, unsigned char data, unsigned address)
433 {
434         unsigned long address_to_write;
435         address_to_write = chip->chip_base_addr+address;
436         chip->write_register(data, address_to_write);
437 }
438
439 extern inline unsigned can_read_reg(const struct chip_t *chip, unsigned address)
440 {
441         unsigned long address_to_read;
442         address_to_read = chip->chip_base_addr+address;
443         return chip->read_register(address_to_read);
444 }
445
446 extern inline void canobj_write_reg(const struct chip_t *chip, const struct msgobj_t *obj,
447                                 unsigned char data, unsigned address)
448 {
449         unsigned long address_to_write;
450         address_to_write = obj->obj_base_addr+address;
451         chip->write_register(data, address_to_write);
452 }
453
454 extern inline unsigned canobj_read_reg(const struct chip_t *chip, const struct msgobj_t *obj,
455                                 unsigned address)
456 {
457         unsigned long address_to_read;
458         address_to_read = obj->obj_base_addr+address;
459         return chip->read_register(address_to_read);
460 }
461
462 #endif /*CONFIG_OC_LINCAN_DYNAMICIO*/
463
464 int can_base_addr_fixup(struct candevice_t *candev, unsigned long new_base);
465 int can_request_io_region(unsigned long start, unsigned long n, const char *name);
466 void can_release_io_region(unsigned long start, unsigned long n);
467 int can_request_mem_region(unsigned long start, unsigned long n, const char *name);
468 void can_release_mem_region(unsigned long start, unsigned long n);
469
470 struct boardtype_t {
471         const char *boardtype;
472         int (*board_register)(struct hwspecops_t *hwspecops);
473         int irqnum;
474 };
475
476 const struct boardtype_t* boardtype_find(const char *str);
477
478 int can_check_dev_taken(void *anydev);
479
480 #ifdef CAN_WITH_RTL
481 extern int can_rtl_priority;
482 #endif /*CAN_WITH_RTL*/