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