lincan/src/setup.c

   1 /* setup.c
   2  * Linux CAN-bus device 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.3  17 Jun 2004
   8  */
   9
  10 #include "../include/can.h"
  11 #include "../include/can_sysdep.h"
  12 #include "../include/main.h"
  13 #include "../include/devcommon.h"
  14 #include "../include/setup.h"
  15 #include "../include/finish.h"
  16
  17 int init_hwspecops(struct candevice_t *candev, int *irqnum_p);
  18 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p);
  19 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate, long clock);
  20 int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr);
  21
  22 /**
  23  * can_base_addr_fixup - relocates board physical memory addresses to the CPU accessible ones
  24  * @candev: pointer to the previously filled device/board, chips and message objects structures
  25  * @new_base: @candev new base address
  26  *
  27  * This function adapts base addresses of all structures of one board
  28  * to the new board base address.
  29  * It is required for translation between physical and virtual address mappings.
  30  * This function is prepared to simplify board specific xxx_request_io() function
  31  * for memory mapped devices.
  32  */
  33 int can_base_addr_fixup(struct candevice_t *candev, can_ioptr_t new_base)
  34 {
  35         long offs;
  36         int i, j;
  37
  38         offs=new_base-candev->dev_base_addr;
  39         candev->dev_base_addr=new_base;
  40         for(i=0;i<candev->nr_all_chips;i++){
  41                 candev->chip[i]->chip_base_addr += offs;
  42                 for(j=0;j<candev->chip[i]->max_objects;j++)
  43                         candev->chip[i]->msgobj[j]->obj_base_addr += offs;
  44         }
  45         return 0;
  46 }
  47
  48 /**
  49  * can_check_dev_taken - checks if bus device description is already taken by driver
  50  * @anydev:     pointer to bus specific Linux device description
  51  *
  52  * Returns: Returns 1 if device is already used by LinCAN driver, 0 otherwise.
  53  */
  54 int can_check_dev_taken(void *anydev)
  55 {
  56         int board_nr;
  57         struct candevice_t *candev;
  58         void *boarddev;
  59
  60         for (board_nr=hardware_p->nr_boards; board_nr--; ) {
  61                 if((candev=hardware_p->candevice[board_nr])==NULL)
  62                         continue;
  63                 boarddev=candev->sysdevptr.anydev;
  64                 if(boarddev == anydev)
  65                         return 1;
  66         }
  67
  68         return 0;
  69 }
  70
  71
  72 /**
  73  * register_obj_struct - registers message object into global array
  74  * @obj: the initialized message object being registered
  75  * @minorbase: wanted minor number, if (-1) automatically selected
  76  *
  77  * Return Value: returns negative number in the case of fail
  78  */
  79 int register_obj_struct(struct msgobj_t *obj, int minorbase)
  80 {
  81         static int next_minor=0;
  82         int i;
  83
  84         if(minorbase>=0)
  85                 next_minor=minorbase;
  86         if(next_minor>=MAX_TOT_MSGOBJS)
  87                 next_minor=0;
  88         i=next_minor;
  89         do{
  90                 if(objects_p[i]==NULL){
  91                         objects_p[i]=obj;
  92                         obj->minor=i;
  93                         next_minor=i+1;
  94                         return 0;
  95                 }
  96                 if(++i >= MAX_TOT_MSGOBJS) i=0;
  97         }while(i!=next_minor);
  98         obj->minor=-1;
  99         return -1;
 100 }
 101
 102
 103 /**
 104  * register_chip_struct - registers chip into global array
 105  * @chip: the initialized chip structure being registered
 106  * @minorbase: wanted minor number base, if (-1) automatically selected
 107  *
 108  * Return Value: returns negative number in the case of fail
 109  */
 110 int register_chip_struct(struct canchip_t *chip, int minorbase)
 111 {
 112         static int next_chip_slot=0;
 113         int i;
 114
 115         if(next_chip_slot>=MAX_TOT_CHIPS)
 116                 next_chip_slot=0;
 117         i=next_chip_slot;
 118         do{
 119                 if(chips_p[i]==NULL){
 120                         chips_p[i]=chip;
 121
 122                         next_chip_slot=i+1;
 123                         return 0;
 124                 }
 125                 if(++i >= MAX_TOT_CHIPS) i=0;
 126         }while(i!=next_chip_slot);
 127         return -1;
 128 }
 129
 130
 131
 132 /**
 133  * init_hw_struct - initializes driver hardware description structures
 134  *
 135  * The function init_hw_struct() is used to initialize the hardware structure.
 136  *
 137  * Return Value: returns negative number in the case of fail
 138  */
 139 int init_hw_struct(void)
 140 {
 141         int i=0;
 142         int irq_param_idx=0;
 143         int chan_param_idx=0;
 144
 145         hardware_p->nr_boards=0;
 146         while ( (hw[i] != NULL) & (i < MAX_HW_CARDS) ) {
 147                 hardware_p->nr_boards++;
 148
 149                 if (init_device_struct(i, &chan_param_idx, &irq_param_idx)) {
 150                         CANMSG("Error initializing candevice_t structures.\n");
 151                         return -ENODEV;
 152                 }
 153                 i++;
 154         }
 155
 156         return 0;
 157 }
 158
 159 /**
 160  * init_device_struct - initializes single CAN device/board
 161  * @card: index into @hardware_p HW description
 162  * @chan_param_idx_p: pointer to the index into arrays of the CAN channel parameters
 163  * @irq_param_idx_p: pointer to the index into arrays of the per CAN channel IRQ parameters
 164  *
 165  * The function builds representation of the one board from parameters provided
 166  * in the module parameters arrays:
 167  *      @hw[card] .. hardware type,
 168  *      @io[card] .. base IO address,
 169  *      @baudrate[chan_param_idx] .. per channel baudrate,
 170  *      @minor[chan_param_idx] .. optional specification of requested channel minor base,
 171  *      @irq[irq_param_idx] .. one or more board/chips IRQ parameters.
 172  * The indexes are advanced after consumed parameters if the registration is successful.
 173  *
 174  * The hardware specific operations of the device/board are initialized by call to
 175  * init_hwspecops() function. Then board data are initialized by board specific
 176  * init_hw_data() function. Then chips and objects representation is build by
 177  * init_chip_struct() function. If all above steps are successful, chips and
 178  * message objects are registered into global arrays.
 179  *
 180  * Return Value: returns negative number in the case of fail
 181  */
 182 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
 183 {
 184         struct candevice_t *candev;
 185         int ret;
 186         int irqnum;
 187         int chipnr;
 188         long bd;
 189         int irqsig=-1;
 190         long clock;
 191
 192         candev=(struct candevice_t *)can_checked_malloc(sizeof(struct candevice_t));
 193         if (candev==NULL)
 194                 return -ENOMEM;
 195
 196         memset(candev, 0, sizeof(struct candevice_t));
 197
 198         hardware_p->candevice[card]=candev;
 199         candev->candev_idx=card;
 200
 201         candev=candev;
 202
 203         candev->hwname=hw[card];
 204         candev->io_addr=io[card];
 205         candev->dev_base_addr=io[card];
 206         clock=clockfreq[card];
 207
 208         candev->hwspecops=(struct hwspecops_t *)can_checked_malloc(sizeof(struct hwspecops_t));
 209         if (candev->hwspecops==NULL)
 210                 goto error_nomem;
 211
 212         memset(candev->hwspecops, 0, sizeof(struct hwspecops_t));
 213
 214         if (init_hwspecops(candev, &irqnum))
 215                 goto error_nodev;
 216
 217         if (candev->hwspecops->init_hw_data(candev))
 218                 goto error_nodev;
 219
 220         /* Alocate and initialize the chip structures */
 221         for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
 222
 223                 if(chipnr<irqnum)
 224                         irqsig=irq[*irq_param_idx_p+chipnr];
 225
 226                 bd=baudrate[*chan_param_idx_p+chipnr];
 227                 if(!bd) bd=baudrate[0];
 228
 229                 if ((ret=init_chip_struct(candev, chipnr, irqsig, bd*1000, clock*1000)))
 230                         goto error_chip;
 231         }
 232
 233
 234
 235         for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
 236                 int m=minor[*chan_param_idx_p+chipnr];
 237                 struct canchip_t *chip=candev->chip[chipnr];
 238                 int objnr;
 239
 240                 register_chip_struct(chip, m);
 241
 242                 for (objnr=0; objnr<chip->max_objects; objnr++) {
 243                         register_obj_struct(chip->msgobj[objnr], m);
 244                         if(m>=0) m++;
 245                 }
 246         }
 247
 248         *irq_param_idx_p += irqnum;
 249         *chan_param_idx_p += candev->nr_all_chips;
 250
 251         return 0;
 252
 253     error_nodev:
 254         ret=-ENODEV;
 255     error_chip:
 256         candevice_done(candev);
 257         goto error_both;
 258
 259     error_nomem:
 260         ret=-ENOMEM;
 261
 262     error_both:
 263         hardware_p->candevice[card]=NULL;
 264         can_checked_free(candev);
 265         return ret;
 266
 267 }
 268
 269 /**
 270  * init_chip_struct - initializes one CAN chip structure
 271  * @candev: pointer to the corresponding CAN device/board
 272  * @chipnr: index of the chip in the corresponding device/board structure
 273  * @irq: chip IRQ number or (-1) if not appropriate
 274  * @baudrate: baudrate in the units of 1Bd
 275  * @clock: optional chip base clock frequency in 1Hz step
 276  *
 277  * Chip structure is allocated and chip specific operations are filled by
 278  * call to board specific init_chip_data() which calls chip specific
 279  * fill_chipspecops(). The message objects are generated by
 280  * calls to init_obj_struct() function.
 281  *
 282  * Return Value: returns negative number in the case of fail
 283  */
 284 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate, long clock)
 285 {
 286         struct canchip_t *chip;
 287         int objnr;
 288         int ret;
 289
 290         candev->chip[chipnr]=(struct canchip_t *)can_checked_malloc(sizeof(struct canchip_t));
 291         if ((chip=candev->chip[chipnr])==NULL)
 292                 return -ENOMEM;
 293
 294         memset(chip, 0, sizeof(struct canchip_t));
 295
 296         chip->write_register=candev->hwspecops->write_register;
 297         chip->read_register=candev->hwspecops->read_register;
 298
 299         chip->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
 300         if (chip->chipspecops==NULL)
 301                 return -ENOMEM;
 302         memset(chip->chipspecops,0,sizeof(struct chipspecops_t));
 303
 304         chip->chip_idx=chipnr;
 305         chip->hostdevice=candev;
 306         chip->chip_irq=irq;
 307         chip->baudrate=baudrate;
 308         chip->clock=clock;
 309         chip->flags=0x0;
 310
 311         if(candev->hwspecops->init_chip_data(candev,chipnr)<0)
 312                 return -ENODEV;
 313
 314         for (objnr=0; objnr<chip->max_objects; objnr++) {
 315                 ret=init_obj_struct(candev, chip, objnr);
 316                 if(ret<0) return ret;
 317         }
 318
 319         return 0;
 320 }
 321
 322
 323 /**
 324  * init_obj_struct - initializes one CAN message object structure
 325  * @candev: pointer to the corresponding CAN device/board
 326  * @hostchip: pointer to the chip containing this object
 327  * @objnr: index of the builded object in the chip structure
 328  *
 329  * The function initializes message object structure and allocates and initializes
 330  * CAN queue chip ends structure.
 331  *
 332  * Return Value: returns negative number in the case of fail
 333  */
 334 int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr)
 335 {
 336         struct canque_ends_t *qends;
 337         struct msgobj_t *obj;
 338         int ret;
 339
 340         obj=(struct msgobj_t *)can_checked_malloc(sizeof(struct msgobj_t));
 341         hostchip->msgobj[objnr]=obj;
 342         if (obj == NULL)
 343                 return -ENOMEM;
 344
 345         memset(obj, 0, sizeof(struct msgobj_t));
 346         obj->minor=-1;
 347
 348         atomic_set(&obj->obj_used,0);
 349         INIT_LIST_HEAD(&obj->obj_users);
 350         init_timer(&obj->tx_timeout);
 351
 352         qends = (struct canque_ends_t *)can_checked_malloc(sizeof(struct canque_ends_t));
 353         if(qends == NULL) return -ENOMEM;
 354         memset(qends, 0, sizeof(struct canque_ends_t));
 355         obj->hostchip=hostchip;
 356         obj->object=objnr+1;
 357         obj->qends=qends;
 358         obj->tx_qedge=NULL;
 359         obj->tx_slot=NULL;
 360         obj->obj_flags = 0x0;
 361
 362         ret=canqueue_ends_init_chip(qends, hostchip, obj);
 363         if(ret<0) return ret;
 364
 365         ret=candev->hwspecops->init_obj_data(hostchip,objnr);
 366         if(ret<0) return ret;
 367
 368         return 0;
 369 }
 370
 371
 372 /**
 373  * init_hwspecops - finds and initializes board/device specific operations
 374  * @candev: pointer to the corresponding CAN device/board
 375  * @irqnum_p: optional pointer to the number of interrupts required by board
 376  *
 377  * The function searches board @hwname in the list of supported boards types.
 378  * The board type specific board_register() function is used to initialize
 379  * @hwspecops operations.
 380  *
 381  * Return Value: returns negative number in the case of fail
 382  */
 383 int init_hwspecops(struct candevice_t *candev, int *irqnum_p)
 384 {
 385         const struct boardtype_t *brp;
 386
 387         brp = boardtype_find(candev->hwname);
 388
 389         if(!brp) {
 390                 CANMSG("Sorry, hardware \"%s\" is currently not supported.\n",candev->hwname);
 391                 return -EINVAL;
 392         }
 393
 394         if(irqnum_p)
 395                 *irqnum_p=brp->irqnum;
 396         brp->board_register(candev->hwspecops);
 397
 398         return 0;
 399 }