Introduced basic support for registration of "can" class and call devices,
[lincan.git] / 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);
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, unsigned long new_base)
34 {
35         unsigned 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         
191         candev=(struct candevice_t *)can_checked_malloc(sizeof(struct candevice_t));
192         if (candev==NULL)
193                 return -ENOMEM;
194
195         memset(candev, 0, sizeof(struct candevice_t));
196
197         hardware_p->candevice[card]=candev;
198         candev->candev_idx=card;
199
200         candev=candev;
201
202         candev->hwname=hw[card];
203         candev->io_addr=io[card];
204         candev->dev_base_addr=io[card];
205
206         candev->hwspecops=(struct hwspecops_t *)can_checked_malloc(sizeof(struct hwspecops_t));
207         if (candev->hwspecops==NULL)
208                 goto error_nomem;
209
210         memset(candev->hwspecops, 0, sizeof(struct hwspecops_t));
211
212         if (init_hwspecops(candev, &irqnum))
213                 goto error_nodev;
214
215         if (candev->hwspecops->init_hw_data(candev))
216                 goto error_nodev;
217
218         /* Alocate and initialize the chip structures */
219         for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
220
221                 if(chipnr<irqnum)
222                         irqsig=irq[*irq_param_idx_p+chipnr];
223                 
224                 bd=baudrate[*chan_param_idx_p+chipnr];
225                 if(!bd) bd=baudrate[0];
226         
227                 if ((ret=init_chip_struct(candev, chipnr, irqsig, bd*1000)))
228                         goto error_chip;
229         }
230         
231
232
233         for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
234                 int m=minor[*chan_param_idx_p+chipnr];
235                 struct canchip_t *chip=candev->chip[chipnr];
236                 int objnr;
237
238                 register_chip_struct(chip, m);
239                 
240                 for (objnr=0; objnr<chip->max_objects; objnr++) {
241                         register_obj_struct(chip->msgobj[objnr], m);
242                         if(m>=0) m++;
243                 }
244         }
245
246         *irq_param_idx_p += irqnum;
247         *chan_param_idx_p += candev->nr_all_chips;
248
249         return 0;
250
251     error_nodev:
252         ret=-ENODEV;
253     error_chip:
254         candevice_done(candev);
255         goto error_both;
256
257     error_nomem:
258         ret=-ENOMEM;
259
260     error_both:
261         hardware_p->candevice[card]=NULL;
262         can_checked_free(candev);
263         return ret;
264         
265 }
266
267 /**
268  * init_chip_struct - initializes one CAN chip structure
269  * @candev: pointer to the corresponding CAN device/board
270  * @chipnr: index of the chip in the corresponding device/board structure
271  * @irq: chip IRQ number or (-1) if not appropriate
272  * @baudrate: baudrate in the units of 1Bd
273  *
274  * Chip structure is allocated and chip specific operations are filled by 
275  * call to board specific init_chip_data() which calls chip specific
276  * fill_chipspecops(). The message objects are generated by 
277  * calls to init_obj_struct() function.
278  *
279  * Return Value: returns negative number in the case of fail
280  */
281 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate)
282 {
283         struct canchip_t *chip;
284         int objnr;
285         int ret;
286
287         candev->chip[chipnr]=(struct canchip_t *)can_checked_malloc(sizeof(struct canchip_t));
288         if ((chip=candev->chip[chipnr])==NULL)
289                 return -ENOMEM;
290
291         memset(chip, 0, sizeof(struct canchip_t));
292
293         chip->write_register=candev->hwspecops->write_register;
294         chip->read_register=candev->hwspecops->read_register;
295
296         chip->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
297         if (chip->chipspecops==NULL)
298                 return -ENOMEM;
299         memset(chip->chipspecops,0,sizeof(struct chipspecops_t));
300
301         chip->chip_idx=chipnr;
302         chip->hostdevice=candev;
303         chip->chip_irq=irq;
304         chip->baudrate=baudrate;
305         chip->flags=0x0;
306
307         if(candev->hwspecops->init_chip_data(candev,chipnr)<0)
308                 return -ENODEV;
309
310         for (objnr=0; objnr<chip->max_objects; objnr++) {
311                 ret=init_obj_struct(candev, chip, objnr);
312                 if(ret<0) return ret;
313         }
314
315         return 0;
316 }
317
318
319 /**
320  * init_obj_struct - initializes one CAN message object structure
321  * @candev: pointer to the corresponding CAN device/board
322  * @hostchip: pointer to the chip containing this object
323  * @objnr: index of the builded object in the chip structure
324  *
325  * The function initializes message object structure and allocates and initializes
326  * CAN queue chip ends structure.
327  *
328  * Return Value: returns negative number in the case of fail
329  */
330 int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr)
331 {
332         struct canque_ends_t *qends;
333         struct msgobj_t *obj;
334         int ret;
335
336         obj=(struct msgobj_t *)can_checked_malloc(sizeof(struct msgobj_t));
337         hostchip->msgobj[objnr]=obj;
338         if (obj == NULL) 
339                 return -ENOMEM;
340
341         memset(obj, 0, sizeof(struct msgobj_t));
342         obj->minor=-1;
343
344         atomic_set(&obj->obj_used,0);
345         INIT_LIST_HEAD(&obj->obj_users);
346         init_timer(&obj->tx_timeout);
347
348         qends = (struct canque_ends_t *)can_checked_malloc(sizeof(struct canque_ends_t));
349         if(qends == NULL) return -ENOMEM;
350         memset(qends, 0, sizeof(struct canque_ends_t));
351         obj->hostchip=hostchip;
352         obj->object=objnr+1;
353         obj->qends=qends;
354         obj->tx_qedge=NULL;
355         obj->tx_slot=NULL;
356         obj->obj_flags = 0x0;
357
358         ret=canqueue_ends_init_chip(qends, hostchip, obj);
359         if(ret<0) return ret;
360
361         ret=candev->hwspecops->init_obj_data(hostchip,objnr);
362         if(ret<0) return ret;
363         
364         return 0;
365 }
366
367
368 /**
369  * init_hwspecops - finds and initializes board/device specific operations
370  * @candev: pointer to the corresponding CAN device/board
371  * @irqnum_p: optional pointer to the number of interrupts required by board
372  *
373  * The function searches board @hwname in the list of supported boards types.
374  * The board type specific board_register() function is used to initialize
375  * @hwspecops operations.
376  *
377  * Return Value: returns negative number in the case of fail
378  */
379 int init_hwspecops(struct candevice_t *candev, int *irqnum_p)
380 {
381         const struct boardtype_t *brp;
382         
383         brp = boardtype_find(candev->hwname);
384         
385         if(!brp) {
386                 CANMSG("Sorry, hardware \"%s\" is currently not supported.\n",candev->hwname);
387                 return -EINVAL;
388         }
389         
390         if(irqnum_p)
391                 *irqnum_p=brp->irqnum;
392         brp->board_register(candev->hwspecops);
393
394         return 0;
395 }