1 /**************************************************************************/
2 /* File: setup.c - CAN driver and chips setup code */
4 /* LinCAN - (Not only) Linux CAN bus driver */
5 /* Copyright (C) 2002-2009 DCE FEE CTU Prague <http://dce.felk.cvut.cz> */
6 /* Copyright (C) 2002-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz> */
7 /* Funded by OCERA and FRESCOR IST projects */
8 /* Based on CAN driver code by Arnaud Westenberg <arnaud@wanadoo.nl> */
10 /* LinCAN is free software; you can redistribute it and/or modify it */
11 /* under terms of the GNU General Public License as published by the */
12 /* Free Software Foundation; either version 2, or (at your option) any */
13 /* later version. LinCAN is distributed in the hope that it will be */
14 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
15 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
16 /* General Public License for more details. You should have received a */
17 /* copy of the GNU General Public License along with LinCAN; see file */
18 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
19 /* Cambridge, MA 02139, USA. */
21 /* To allow use of LinCAN in the compact embedded systems firmware */
22 /* and RT-executives (RTEMS for example), main authors agree with next */
23 /* special exception: */
25 /* Including LinCAN header files in a file, instantiating LinCAN generics */
26 /* or templates, or linking other files with LinCAN objects to produce */
27 /* an application image/executable, does not by itself cause the */
28 /* resulting application image/executable to be covered by */
29 /* the GNU General Public License. */
30 /* This exception does not however invalidate any other reasons */
31 /* why the executable file might be covered by the GNU Public License. */
32 /* Publication of enhanced or derived LinCAN files is required although. */
33 /**************************************************************************/
35 #include "../include/can.h"
36 #include "../include/can_sysdep.h"
37 #include "../include/main.h"
38 #include "../include/devcommon.h"
39 #include "../include/setup.h"
40 #include "../include/finish.h"
42 int init_hwspecops(struct candevice_t *candev, int *irqnum_p);
43 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p);
44 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate, long clock);
45 int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr);
48 * can_base_addr_fixup - relocates board physical memory addresses to the CPU accessible ones
49 * @candev: pointer to the previously filled device/board, chips and message objects structures
50 * @new_base: @candev new base address
52 * This function adapts base addresses of all structures of one board
53 * to the new board base address.
54 * It is required for translation between physical and virtual address mappings.
55 * This function is prepared to simplify board specific xxx_request_io() function
56 * for memory mapped devices.
58 int can_base_addr_fixup(struct candevice_t *candev, can_ioptr_t new_base)
63 offs=new_base-candev->dev_base_addr;
64 candev->dev_base_addr=new_base;
65 for(i=0;i<candev->nr_all_chips;i++){
66 candev->chip[i]->chip_base_addr += offs;
67 for(j=0;j<candev->chip[i]->max_objects;j++)
68 candev->chip[i]->msgobj[j]->obj_base_addr += offs;
74 * can_check_dev_taken - checks if bus device description is already taken by driver
75 * @anydev: pointer to bus specific Linux device description
77 * Returns: Returns 1 if device is already used by LinCAN driver, 0 otherwise.
79 int can_check_dev_taken(void *anydev)
82 struct candevice_t *candev;
85 for (board_nr=hardware_p->nr_boards; board_nr--; ) {
86 if((candev=hardware_p->candevice[board_nr])==NULL)
88 boarddev=candev->sysdevptr.anydev;
89 if(boarddev == anydev)
98 * register_obj_struct - registers message object into global array
99 * @obj: the initialized message object being registered
100 * @minorbase: wanted minor number, if (-1) automatically selected
102 * Return Value: returns negative number in the case of fail
104 int register_obj_struct(struct msgobj_t *obj, int minorbase)
106 static int next_minor=0;
110 next_minor=minorbase;
111 if(next_minor>=MAX_TOT_MSGOBJS)
115 if(objects_p[i]==NULL){
121 if(++i >= MAX_TOT_MSGOBJS) i=0;
122 }while(i!=next_minor);
129 * register_chip_struct - registers chip into global array
130 * @chip: the initialized chip structure being registered
131 * @minorbase: wanted minor number base, if (-1) automatically selected
133 * Return Value: returns negative number in the case of fail
135 int register_chip_struct(struct canchip_t *chip, int minorbase)
137 static int next_chip_slot=0;
140 if(next_chip_slot>=MAX_TOT_CHIPS)
144 if(chips_p[i]==NULL){
150 if(++i >= MAX_TOT_CHIPS) i=0;
151 }while(i!=next_chip_slot);
158 * init_hw_struct - initializes driver hardware description structures
160 * The function init_hw_struct() is used to initialize the hardware structure.
162 * Return Value: returns negative number in the case of fail
164 int init_hw_struct(void)
168 int chan_param_idx=0;
170 hardware_p->nr_boards=0;
171 while ( (hw[i] != NULL) & (i < MAX_HW_CARDS) ) {
172 hardware_p->nr_boards++;
174 if (init_device_struct(i, &chan_param_idx, &irq_param_idx)) {
175 CANMSG("Error initializing candevice_t structures.\n");
185 * init_device_struct - initializes single CAN device/board
186 * @card: index into @hardware_p HW description
187 * @chan_param_idx_p: pointer to the index into arrays of the CAN channel parameters
188 * @irq_param_idx_p: pointer to the index into arrays of the per CAN channel IRQ parameters
190 * The function builds representation of the one board from parameters provided
191 * in the module parameters arrays:
192 * @hw[card] .. hardware type,
193 * @io[card] .. base IO address,
194 * @baudrate[chan_param_idx] .. per channel baudrate,
195 * @minor[chan_param_idx] .. optional specification of requested channel minor base,
196 * @irq[irq_param_idx] .. one or more board/chips IRQ parameters.
197 * The indexes are advanced after consumed parameters if the registration is successful.
199 * The hardware specific operations of the device/board are initialized by call to
200 * init_hwspecops() function. Then board data are initialized by board specific
201 * init_hw_data() function. Then chips and objects representation is build by
202 * init_chip_struct() function. If all above steps are successful, chips and
203 * message objects are registered into global arrays.
205 * Return Value: returns negative number in the case of fail
207 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
209 struct candevice_t *candev;
217 candev=(struct candevice_t *)can_checked_malloc(sizeof(struct candevice_t));
221 memset(candev, 0, sizeof(struct candevice_t));
223 hardware_p->candevice[card]=candev;
224 candev->candev_idx=card;
228 candev->hwname=hw[card];
229 candev->io_addr=io[card];
230 candev->dev_base_addr=io[card];
231 clock=clockfreq[card];
233 candev->hwspecops=(struct hwspecops_t *)can_checked_malloc(sizeof(struct hwspecops_t));
234 if (candev->hwspecops==NULL)
237 memset(candev->hwspecops, 0, sizeof(struct hwspecops_t));
239 if (init_hwspecops(candev, &irqnum))
242 if (candev->hwspecops->init_hw_data(candev))
245 /* Alocate and initialize the chip structures */
246 for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
249 irqsig=irq[*irq_param_idx_p+chipnr];
251 bd=baudrate[*chan_param_idx_p+chipnr];
252 if(!bd) bd=baudrate[0];
254 if ((ret=init_chip_struct(candev, chipnr, irqsig, bd*1000, clock*1000)))
260 for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
261 int m=minor[*chan_param_idx_p+chipnr];
262 struct canchip_t *chip=candev->chip[chipnr];
265 register_chip_struct(chip, m);
267 for (objnr=0; objnr<chip->max_objects; objnr++) {
268 register_obj_struct(chip->msgobj[objnr], m);
273 *irq_param_idx_p += irqnum;
274 *chan_param_idx_p += candev->nr_all_chips;
281 candevice_done(candev);
288 hardware_p->candevice[card]=NULL;
289 can_checked_free(candev);
295 * init_chip_struct - initializes one CAN chip structure
296 * @candev: pointer to the corresponding CAN device/board
297 * @chipnr: index of the chip in the corresponding device/board structure
298 * @irq: chip IRQ number or (-1) if not appropriate
299 * @baudrate: baudrate in the units of 1Bd
300 * @clock: optional chip base clock frequency in 1Hz step
302 * Chip structure is allocated and chip specific operations are filled by
303 * call to board specific init_chip_data() which calls chip specific
304 * fill_chipspecops(). The message objects are generated by
305 * calls to init_obj_struct() function.
307 * Return Value: returns negative number in the case of fail
309 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate, long clock)
311 struct canchip_t *chip;
315 candev->chip[chipnr]=(struct canchip_t *)can_checked_malloc(sizeof(struct canchip_t));
316 if ((chip=candev->chip[chipnr])==NULL)
319 memset(chip, 0, sizeof(struct canchip_t));
321 chip->write_register=candev->hwspecops->write_register;
322 chip->read_register=candev->hwspecops->read_register;
324 chip->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
325 if (chip->chipspecops==NULL)
327 memset(chip->chipspecops,0,sizeof(struct chipspecops_t));
329 chip->chip_idx=chipnr;
330 chip->hostdevice=candev;
332 chip->baudrate=baudrate;
336 if(candev->hwspecops->init_chip_data(candev,chipnr)<0)
339 for (objnr=0; objnr<chip->max_objects; objnr++) {
340 ret=init_obj_struct(candev, chip, objnr);
341 if(ret<0) return ret;
349 * init_obj_struct - initializes one CAN message object structure
350 * @candev: pointer to the corresponding CAN device/board
351 * @hostchip: pointer to the chip containing this object
352 * @objnr: index of the builded object in the chip structure
354 * The function initializes message object structure and allocates and initializes
355 * CAN queue chip ends structure.
357 * Return Value: returns negative number in the case of fail
359 int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr)
361 struct canque_ends_t *qends;
362 struct msgobj_t *obj;
365 obj=(struct msgobj_t *)can_checked_malloc(sizeof(struct msgobj_t));
366 hostchip->msgobj[objnr]=obj;
370 memset(obj, 0, sizeof(struct msgobj_t));
373 atomic_set(&obj->obj_used,0);
374 INIT_LIST_HEAD(&obj->obj_users);
375 init_timer(&obj->tx_timeout);
377 qends = (struct canque_ends_t *)can_checked_malloc(sizeof(struct canque_ends_t));
378 if(qends == NULL) return -ENOMEM;
379 memset(qends, 0, sizeof(struct canque_ends_t));
380 obj->hostchip=hostchip;
385 obj->obj_flags = 0x0;
387 ret=canqueue_ends_init_chip(qends, hostchip, obj);
388 if(ret<0) return ret;
390 ret=candev->hwspecops->init_obj_data(hostchip,objnr);
391 if(ret<0) return ret;
398 * init_hwspecops - finds and initializes board/device specific operations
399 * @candev: pointer to the corresponding CAN device/board
400 * @irqnum_p: optional pointer to the number of interrupts required by board
402 * The function searches board @hwname in the list of supported boards types.
403 * The board type specific board_register() function is used to initialize
404 * @hwspecops operations.
406 * Return Value: returns negative number in the case of fail
408 int init_hwspecops(struct candevice_t *candev, int *irqnum_p)
410 const struct boardtype_t *brp;
412 brp = boardtype_find(candev->hwname);
415 CANMSG("Sorry, hardware \"%s\" is currently not supported.\n",candev->hwname);
420 *irqnum_p=brp->irqnum;
421 brp->board_register(candev->hwspecops);