Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* $Id: teles_cs.c,v 1.1.2.2 2004/01/25 15:07:06 keil Exp $ */ |
2 | /*====================================================================== | |
3 | ||
4 | A teles S0 PCMCIA client driver | |
5 | ||
6 | Based on skeleton by David Hinds, dhinds@allegro.stanford.edu | |
7 | Written by Christof Petig, christof.petig@wtal.de | |
8 | ||
9 | Also inspired by ELSA PCMCIA driver | |
10 | by Klaus Lichtenwalder <Lichtenwalder@ACM.org> | |
11 | ||
12 | Extentions to new hisax_pcmcia by Karsten Keil | |
13 | ||
14 | minor changes to be compatible with kernel 2.4.x | |
15 | by Jan.Schubert@GMX.li | |
16 | ||
17 | ======================================================================*/ | |
18 | ||
19 | #include <linux/kernel.h> | |
20 | #include <linux/module.h> | |
21 | #include <linux/init.h> | |
22 | #include <linux/sched.h> | |
23 | #include <linux/ptrace.h> | |
24 | #include <linux/slab.h> | |
25 | #include <linux/string.h> | |
26 | #include <linux/timer.h> | |
27 | #include <linux/ioport.h> | |
28 | #include <asm/io.h> | |
29 | #include <asm/system.h> | |
30 | ||
1da177e4 LT |
31 | #include <pcmcia/cs_types.h> |
32 | #include <pcmcia/cs.h> | |
33 | #include <pcmcia/cistpl.h> | |
34 | #include <pcmcia/cisreg.h> | |
35 | #include <pcmcia/ds.h> | |
36 | #include "hisax_cfg.h" | |
37 | ||
38 | MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Teles PCMCIA cards"); | |
39 | MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de"); | |
40 | MODULE_LICENSE("GPL"); | |
41 | ||
42 | /* | |
43 | All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If | |
44 | you do not define PCMCIA_DEBUG at all, all the debug code will be | |
45 | left out. If you compile with PCMCIA_DEBUG=0, the debug code will | |
46 | be present but disabled -- but it can then be enabled for specific | |
47 | modules at load time with a 'pc_debug=#' option to insmod. | |
48 | */ | |
49 | ||
50 | #ifdef PCMCIA_DEBUG | |
51 | static int pc_debug = PCMCIA_DEBUG; | |
52 | module_param(pc_debug, int, 0); | |
53 | #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args); | |
54 | static char *version = | |
55 | "teles_cs.c 2.10 2002/07/30 22:23:34 kkeil"; | |
56 | #else | |
57 | #define DEBUG(n, args...) | |
58 | #endif | |
59 | ||
60 | /*====================================================================*/ | |
61 | ||
62 | /* Parameters that can be set with 'insmod' */ | |
63 | ||
64 | static int protocol = 2; /* EURO-ISDN Default */ | |
65 | module_param(protocol, int, 0); | |
66 | ||
67 | /*====================================================================*/ | |
68 | ||
69 | /* | |
70 | The event() function is this driver's Card Services event handler. | |
71 | It will be called by Card Services when an appropriate card status | |
72 | event is received. The config() and release() entry points are | |
73 | used to configure or release a socket, in response to card insertion | |
74 | and ejection events. They are invoked from the teles_cs event | |
75 | handler. | |
76 | */ | |
77 | ||
78 | static void teles_cs_config(dev_link_t *link); | |
79 | static void teles_cs_release(dev_link_t *link); | |
80 | static int teles_cs_event(event_t event, int priority, | |
81 | event_callback_args_t *args); | |
82 | ||
83 | /* | |
84 | The attach() and detach() entry points are used to create and destroy | |
85 | "instances" of the driver, where each instance represents everything | |
86 | needed to manage one actual PCMCIA card. | |
87 | */ | |
88 | ||
89 | static dev_link_t *teles_attach(void); | |
cc3b4866 | 90 | static void teles_detach(struct pcmcia_device *p_dev); |
1da177e4 LT |
91 | |
92 | /* | |
93 | The dev_info variable is the "key" that is used to match up this | |
94 | device driver with appropriate cards, through the card configuration | |
95 | database. | |
96 | */ | |
97 | ||
98 | static dev_info_t dev_info = "teles_cs"; | |
99 | ||
100 | /* | |
101 | A linked list of "instances" of the teles_cs device. Each actual | |
102 | PCMCIA card corresponds to one device instance, and is described | |
103 | by one dev_link_t structure (defined in ds.h). | |
104 | ||
105 | You may not want to use a linked list for this -- for example, the | |
106 | memory card driver uses an array of dev_link_t pointers, where minor | |
107 | device numbers are used to derive the corresponding array index. | |
108 | */ | |
109 | ||
110 | static dev_link_t *dev_list = NULL; | |
111 | ||
112 | /* | |
113 | A dev_link_t structure has fields for most things that are needed | |
114 | to keep track of a socket, but there will usually be some device | |
115 | specific information that also needs to be kept track of. The | |
116 | 'priv' pointer in a dev_link_t structure can be used to point to | |
117 | a device-specific private data structure, like this. | |
118 | ||
119 | To simplify the data structure handling, we actually include the | |
120 | dev_link_t structure in the device's private data structure. | |
121 | ||
122 | A driver needs to provide a dev_node_t structure for each device | |
123 | on a card. In some cases, there is only one device per card (for | |
124 | example, ethernet cards, modems). In other cases, there may be | |
125 | many actual or logical devices (SCSI adapters, memory cards with | |
126 | multiple partitions). The dev_node_t structures need to be kept | |
127 | in a linked list starting at the 'dev' field of a dev_link_t | |
128 | structure. We allocate them in the card's private data structure, | |
129 | because they generally shouldn't be allocated dynamically. | |
130 | In this case, we also provide a flag to indicate if a device is | |
131 | "stopped" due to a power management event, or card ejection. The | |
132 | device IO routines can use a flag like this to throttle IO to a | |
133 | card that is not ready to accept it. | |
134 | */ | |
135 | ||
136 | typedef struct local_info_t { | |
137 | dev_link_t link; | |
138 | dev_node_t node; | |
139 | int busy; | |
140 | int cardnr; | |
141 | } local_info_t; | |
142 | ||
143 | /*====================================================================== | |
144 | ||
145 | teles_attach() creates an "instance" of the driver, allocatingx | |
146 | local data structures for one device. The device is registered | |
147 | with Card Services. | |
148 | ||
149 | The dev_link structure is initialized, but we don't actually | |
150 | configure the card at this point -- we wait until we receive a | |
151 | card insertion event. | |
152 | ||
153 | ======================================================================*/ | |
154 | ||
155 | static dev_link_t *teles_attach(void) | |
156 | { | |
157 | client_reg_t client_reg; | |
158 | dev_link_t *link; | |
159 | local_info_t *local; | |
160 | int ret; | |
161 | ||
162 | DEBUG(0, "teles_attach()\n"); | |
163 | ||
164 | /* Allocate space for private device-specific data */ | |
165 | local = kmalloc(sizeof(local_info_t), GFP_KERNEL); | |
166 | if (!local) return NULL; | |
167 | memset(local, 0, sizeof(local_info_t)); | |
168 | local->cardnr = -1; | |
169 | link = &local->link; link->priv = local; | |
170 | ||
171 | /* Interrupt setup */ | |
172 | link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED; | |
173 | link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID; | |
174 | link->irq.Handler = NULL; | |
175 | ||
176 | /* | |
177 | General socket configuration defaults can go here. In this | |
178 | client, we assume very little, and rely on the CIS for almost | |
179 | everything. In most clients, many details (i.e., number, sizes, | |
180 | and attributes of IO windows) are fixed by the nature of the | |
181 | device, and can be hard-wired here. | |
182 | */ | |
183 | link->io.NumPorts1 = 96; | |
184 | link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO; | |
185 | link->io.IOAddrLines = 5; | |
186 | ||
187 | link->conf.Attributes = CONF_ENABLE_IRQ; | |
188 | link->conf.Vcc = 50; | |
189 | link->conf.IntType = INT_MEMORY_AND_IO; | |
190 | ||
191 | /* Register with Card Services */ | |
192 | link->next = dev_list; | |
193 | dev_list = link; | |
194 | client_reg.dev_info = &dev_info; | |
1da177e4 LT |
195 | client_reg.Version = 0x0210; |
196 | client_reg.event_callback_args.client_data = link; | |
197 | ret = pcmcia_register_client(&link->handle, &client_reg); | |
198 | if (ret != CS_SUCCESS) { | |
199 | cs_error(link->handle, RegisterClient, ret); | |
cc3b4866 | 200 | teles_detach(link->handle); |
1da177e4 LT |
201 | return NULL; |
202 | } | |
203 | ||
204 | return link; | |
205 | } /* teles_attach */ | |
206 | ||
207 | /*====================================================================== | |
208 | ||
209 | This deletes a driver "instance". The device is de-registered | |
210 | with Card Services. If it has been released, all local data | |
211 | structures are freed. Otherwise, the structures will be freed | |
212 | when the device is released. | |
213 | ||
214 | ======================================================================*/ | |
215 | ||
cc3b4866 | 216 | static void teles_detach(struct pcmcia_device *p_dev) |
1da177e4 | 217 | { |
cc3b4866 | 218 | dev_link_t *link = dev_to_instance(p_dev); |
1da177e4 LT |
219 | dev_link_t **linkp; |
220 | local_info_t *info = link->priv; | |
1da177e4 LT |
221 | |
222 | DEBUG(0, "teles_detach(0x%p)\n", link); | |
223 | ||
224 | /* Locate device structure */ | |
225 | for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next) | |
226 | if (*linkp == link) break; | |
227 | if (*linkp == NULL) | |
228 | return; | |
229 | ||
cc3b4866 DB |
230 | if (link->state & DEV_CONFIG) { |
231 | info->busy = 1; | |
1da177e4 | 232 | teles_cs_release(link); |
1da177e4 LT |
233 | } |
234 | ||
235 | /* Unlink device structure and free it */ | |
236 | *linkp = link->next; | |
237 | kfree(info); | |
238 | ||
239 | } /* teles_detach */ | |
240 | ||
241 | /*====================================================================== | |
242 | ||
243 | teles_cs_config() is scheduled to run after a CARD_INSERTION event | |
244 | is received, to configure the PCMCIA socket, and to make the | |
245 | device available to the system. | |
246 | ||
247 | ======================================================================*/ | |
248 | static int get_tuple(client_handle_t handle, tuple_t *tuple, | |
249 | cisparse_t *parse) | |
250 | { | |
251 | int i = pcmcia_get_tuple_data(handle, tuple); | |
252 | if (i != CS_SUCCESS) return i; | |
253 | return pcmcia_parse_tuple(handle, tuple, parse); | |
254 | } | |
255 | ||
256 | static int first_tuple(client_handle_t handle, tuple_t *tuple, | |
257 | cisparse_t *parse) | |
258 | { | |
259 | int i = pcmcia_get_first_tuple(handle, tuple); | |
260 | if (i != CS_SUCCESS) return i; | |
261 | return get_tuple(handle, tuple, parse); | |
262 | } | |
263 | ||
264 | static int next_tuple(client_handle_t handle, tuple_t *tuple, | |
265 | cisparse_t *parse) | |
266 | { | |
267 | int i = pcmcia_get_next_tuple(handle, tuple); | |
268 | if (i != CS_SUCCESS) return i; | |
269 | return get_tuple(handle, tuple, parse); | |
270 | } | |
271 | ||
272 | static void teles_cs_config(dev_link_t *link) | |
273 | { | |
274 | client_handle_t handle; | |
275 | tuple_t tuple; | |
276 | cisparse_t parse; | |
277 | local_info_t *dev; | |
278 | int i, j, last_fn; | |
279 | u_short buf[128]; | |
280 | cistpl_cftable_entry_t *cf = &parse.cftable_entry; | |
281 | IsdnCard_t icard; | |
282 | ||
283 | DEBUG(0, "teles_config(0x%p)\n", link); | |
284 | handle = link->handle; | |
285 | dev = link->priv; | |
286 | ||
287 | /* | |
288 | This reads the card's CONFIG tuple to find its configuration | |
289 | registers. | |
290 | */ | |
291 | tuple.DesiredTuple = CISTPL_CONFIG; | |
292 | tuple.TupleData = (cisdata_t *)buf; | |
293 | tuple.TupleDataMax = 255; | |
294 | tuple.TupleOffset = 0; | |
295 | tuple.Attributes = 0; | |
296 | i = first_tuple(handle, &tuple, &parse); | |
297 | if (i != CS_SUCCESS) { | |
298 | last_fn = ParseTuple; | |
299 | goto cs_failed; | |
300 | } | |
301 | link->conf.ConfigBase = parse.config.base; | |
302 | link->conf.Present = parse.config.rmask[0]; | |
303 | ||
304 | /* Configure card */ | |
305 | link->state |= DEV_CONFIG; | |
306 | ||
307 | tuple.TupleData = (cisdata_t *)buf; | |
308 | tuple.TupleOffset = 0; tuple.TupleDataMax = 255; | |
309 | tuple.Attributes = 0; | |
310 | tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY; | |
311 | i = first_tuple(handle, &tuple, &parse); | |
312 | while (i == CS_SUCCESS) { | |
313 | if ( (cf->io.nwin > 0) && cf->io.win[0].base) { | |
314 | printk(KERN_INFO "(teles_cs: looks like the 96 model)\n"); | |
315 | link->conf.ConfigIndex = cf->index; | |
316 | link->io.BasePort1 = cf->io.win[0].base; | |
317 | i = pcmcia_request_io(link->handle, &link->io); | |
318 | if (i == CS_SUCCESS) break; | |
319 | } else { | |
320 | printk(KERN_INFO "(teles_cs: looks like the 97 model)\n"); | |
321 | link->conf.ConfigIndex = cf->index; | |
322 | for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) { | |
323 | link->io.BasePort1 = j; | |
324 | i = pcmcia_request_io(link->handle, &link->io); | |
325 | if (i == CS_SUCCESS) break; | |
326 | } | |
327 | break; | |
328 | } | |
329 | i = next_tuple(handle, &tuple, &parse); | |
330 | } | |
331 | ||
332 | if (i != CS_SUCCESS) { | |
333 | last_fn = RequestIO; | |
334 | goto cs_failed; | |
335 | } | |
336 | ||
337 | i = pcmcia_request_irq(link->handle, &link->irq); | |
338 | if (i != CS_SUCCESS) { | |
339 | link->irq.AssignedIRQ = 0; | |
340 | last_fn = RequestIRQ; | |
341 | goto cs_failed; | |
342 | } | |
343 | ||
344 | i = pcmcia_request_configuration(link->handle, &link->conf); | |
345 | if (i != CS_SUCCESS) { | |
346 | last_fn = RequestConfiguration; | |
347 | goto cs_failed; | |
348 | } | |
349 | ||
350 | /* At this point, the dev_node_t structure(s) should be | |
351 | initialized and arranged in a linked list at link->dev. *//* */ | |
352 | sprintf(dev->node.dev_name, "teles"); | |
353 | dev->node.major = dev->node.minor = 0x0; | |
354 | ||
355 | link->dev = &dev->node; | |
356 | ||
357 | /* Finally, report what we've done */ | |
358 | printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d", | |
359 | dev->node.dev_name, link->conf.ConfigIndex, | |
360 | link->conf.Vcc/10, link->conf.Vcc%10); | |
361 | if (link->conf.Vpp1) | |
362 | printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10); | |
363 | if (link->conf.Attributes & CONF_ENABLE_IRQ) | |
364 | printk(", irq %d", link->irq.AssignedIRQ); | |
365 | if (link->io.NumPorts1) | |
366 | printk(", io 0x%04x-0x%04x", link->io.BasePort1, | |
367 | link->io.BasePort1+link->io.NumPorts1-1); | |
368 | if (link->io.NumPorts2) | |
369 | printk(" & 0x%04x-0x%04x", link->io.BasePort2, | |
370 | link->io.BasePort2+link->io.NumPorts2-1); | |
371 | printk("\n"); | |
372 | ||
373 | link->state &= ~DEV_CONFIG_PENDING; | |
374 | ||
375 | icard.para[0] = link->irq.AssignedIRQ; | |
376 | icard.para[1] = link->io.BasePort1; | |
377 | icard.protocol = protocol; | |
378 | icard.typ = ISDN_CTYPE_TELESPCMCIA; | |
379 | ||
380 | i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard); | |
381 | if (i < 0) { | |
382 | printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n", | |
383 | i, link->io.BasePort1); | |
384 | teles_cs_release(link); | |
385 | } else | |
386 | ((local_info_t*)link->priv)->cardnr = i; | |
387 | ||
388 | return; | |
389 | cs_failed: | |
390 | cs_error(link->handle, last_fn, i); | |
391 | teles_cs_release(link); | |
392 | } /* teles_cs_config */ | |
393 | ||
394 | /*====================================================================== | |
395 | ||
396 | After a card is removed, teles_cs_release() will unregister the net | |
397 | device, and release the PCMCIA configuration. If the device is | |
398 | still open, this will be postponed until it is closed. | |
399 | ||
400 | ======================================================================*/ | |
401 | ||
402 | static void teles_cs_release(dev_link_t *link) | |
403 | { | |
404 | local_info_t *local = link->priv; | |
405 | ||
406 | DEBUG(0, "teles_cs_release(0x%p)\n", link); | |
407 | ||
408 | if (local) { | |
409 | if (local->cardnr >= 0) { | |
410 | /* no unregister function with hisax */ | |
411 | HiSax_closecard(local->cardnr); | |
412 | } | |
413 | } | |
414 | /* Unlink the device chain */ | |
415 | link->dev = NULL; | |
416 | ||
417 | /* Don't bother checking to see if these succeed or not */ | |
418 | if (link->win) | |
419 | pcmcia_release_window(link->win); | |
420 | pcmcia_release_configuration(link->handle); | |
421 | pcmcia_release_io(link->handle, &link->io); | |
422 | pcmcia_release_irq(link->handle, &link->irq); | |
423 | link->state &= ~DEV_CONFIG; | |
424 | } /* teles_cs_release */ | |
425 | ||
98e4c28b DB |
426 | static int teles_suspend(struct pcmcia_device *p_dev) |
427 | { | |
428 | dev_link_t *link = dev_to_instance(p_dev); | |
429 | local_info_t *dev = link->priv; | |
430 | ||
431 | link->state |= DEV_SUSPEND; | |
432 | dev->busy = 1; | |
433 | if (link->state & DEV_CONFIG) | |
434 | pcmcia_release_configuration(link->handle); | |
435 | ||
436 | return 0; | |
437 | } | |
438 | ||
439 | static int teles_resume(struct pcmcia_device *p_dev) | |
440 | { | |
441 | dev_link_t *link = dev_to_instance(p_dev); | |
442 | local_info_t *dev = link->priv; | |
443 | ||
444 | link->state &= ~DEV_SUSPEND; | |
445 | if (link->state & DEV_CONFIG) | |
446 | pcmcia_request_configuration(link->handle, &link->conf); | |
447 | dev->busy = 0; | |
448 | ||
449 | return 0; | |
450 | } | |
451 | ||
1da177e4 LT |
452 | /*====================================================================== |
453 | ||
454 | The card status event handler. Mostly, this schedules other | |
455 | stuff to run after an event is received. A CARD_REMOVAL event | |
456 | also sets some flags to discourage the net drivers from trying | |
457 | to talk to the card any more. | |
458 | ||
459 | When a CARD_REMOVAL event is received, we immediately set a flag | |
460 | to block future accesses to this device. All the functions that | |
461 | actually access the device should check this flag to make sure | |
462 | the card is still present. | |
463 | ||
464 | ======================================================================*/ | |
465 | ||
466 | static int teles_cs_event(event_t event, int priority, | |
467 | event_callback_args_t *args) | |
468 | { | |
469 | dev_link_t *link = args->client_data; | |
1da177e4 LT |
470 | |
471 | DEBUG(1, "teles_cs_event(%d)\n", event); | |
472 | ||
473 | switch (event) { | |
1da177e4 LT |
474 | case CS_EVENT_CARD_INSERTION: |
475 | link->state |= DEV_PRESENT | DEV_CONFIG_PENDING; | |
476 | teles_cs_config(link); | |
477 | break; | |
1da177e4 LT |
478 | } |
479 | return 0; | |
480 | } /* teles_cs_event */ | |
481 | ||
0a10d73d DB |
482 | static struct pcmcia_device_id teles_ids[] = { |
483 | PCMCIA_DEVICE_PROD_ID12("TELES", "S0/PC", 0x67b50eae, 0xe9e70119), | |
484 | PCMCIA_DEVICE_NULL, | |
485 | }; | |
486 | MODULE_DEVICE_TABLE(pcmcia, teles_ids); | |
487 | ||
1da177e4 LT |
488 | static struct pcmcia_driver teles_cs_driver = { |
489 | .owner = THIS_MODULE, | |
490 | .drv = { | |
491 | .name = "teles_cs", | |
492 | }, | |
493 | .attach = teles_attach, | |
1e212f36 | 494 | .event = teles_cs_event, |
cc3b4866 | 495 | .remove = teles_detach, |
0a10d73d | 496 | .id_table = teles_ids, |
98e4c28b DB |
497 | .suspend = teles_suspend, |
498 | .resume = teles_resume, | |
1da177e4 LT |
499 | }; |
500 | ||
501 | static int __init init_teles_cs(void) | |
502 | { | |
503 | return pcmcia_register_driver(&teles_cs_driver); | |
504 | } | |
505 | ||
506 | static void __exit exit_teles_cs(void) | |
507 | { | |
508 | pcmcia_unregister_driver(&teles_cs_driver); | |
509 | BUG_ON(dev_list != NULL); | |
510 | } | |
511 | ||
512 | module_init(init_teles_cs); | |
513 | module_exit(exit_teles_cs); |