1 /* $Id: avm_cs.c,v 1.4.6.3 2001/09/23 22:24:33 kai Exp $
3 * A PCMCIA client driver for AVM B1/M1/M2
5 * Copyright 1999 by Carsten Paeth <calle@calle.de>
7 * This software may be used and distributed according to the terms
8 * of the GNU General Public License, incorporated herein by reference.
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/sched.h>
16 #include <linux/ptrace.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/tty.h>
20 #include <linux/serial.h>
21 #include <linux/major.h>
23 #include <asm/system.h>
25 #include <pcmcia/cs_types.h>
26 #include <pcmcia/cs.h>
27 #include <pcmcia/cistpl.h>
28 #include <pcmcia/ciscode.h>
29 #include <pcmcia/ds.h>
30 #include <pcmcia/cisreg.h>
32 #include <linux/skbuff.h>
33 #include <linux/capi.h>
34 #include <linux/b1lli.h>
35 #include <linux/b1pcmcia.h>
37 /*====================================================================*/
39 MODULE_DESCRIPTION("CAPI4Linux: PCMCIA client driver for AVM B1/M1/M2");
40 MODULE_AUTHOR("Carsten Paeth");
41 MODULE_LICENSE("GPL");
43 /*====================================================================*/
46 The event() function is this driver's Card Services event handler.
47 It will be called by Card Services when an appropriate card status
48 event is received. The config() and release() entry points are
49 used to configure or release a socket, in response to card insertion
50 and ejection events. They are invoked from the skeleton event
54 static void avmcs_config(dev_link_t *link);
55 static void avmcs_release(dev_link_t *link);
56 static int avmcs_event(event_t event, int priority,
57 event_callback_args_t *args);
60 The attach() and detach() entry points are used to create and destroy
61 "instances" of the driver, where each instance represents everything
62 needed to manage one actual PCMCIA card.
65 static dev_link_t *avmcs_attach(void);
66 static void avmcs_detach(dev_link_t *);
69 The dev_info variable is the "key" that is used to match up this
70 device driver with appropriate cards, through the card configuration
74 static dev_info_t dev_info = "avm_cs";
77 A linked list of "instances" of the skeleton device. Each actual
78 PCMCIA card corresponds to one device instance, and is described
79 by one dev_link_t structure (defined in ds.h).
81 You may not want to use a linked list for this -- for example, the
82 memory card driver uses an array of dev_link_t pointers, where minor
83 device numbers are used to derive the corresponding array index.
86 static dev_link_t *dev_list = NULL;
89 A dev_link_t structure has fields for most things that are needed
90 to keep track of a socket, but there will usually be some device
91 specific information that also needs to be kept track of. The
92 'priv' pointer in a dev_link_t structure can be used to point to
93 a device-specific private data structure, like this.
95 A driver needs to provide a dev_node_t structure for each device
96 on a card. In some cases, there is only one device per card (for
97 example, ethernet cards, modems). In other cases, there may be
98 many actual or logical devices (SCSI adapters, memory cards with
99 multiple partitions). The dev_node_t structures need to be kept
100 in a linked list starting at the 'dev' field of a dev_link_t
101 structure. We allocate them in the card's private data structure,
102 because they generally can't be allocated dynamically.
105 typedef struct local_info_t {
109 /*======================================================================
111 avmcs_attach() creates an "instance" of the driver, allocating
112 local data structures for one device. The device is registered
115 The dev_link structure is initialized, but we don't actually
116 configure the card at this point -- we wait until we receive a
117 card insertion event.
119 ======================================================================*/
121 static dev_link_t *avmcs_attach(void)
123 client_reg_t client_reg;
128 /* Initialize the dev_link_t structure */
129 link = kmalloc(sizeof(struct dev_link_t), GFP_KERNEL);
132 memset(link, 0, sizeof(struct dev_link_t));
134 /* The io structure describes IO port mapping */
135 link->io.NumPorts1 = 16;
136 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
137 link->io.NumPorts2 = 0;
139 /* Interrupt setup */
140 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
141 link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
143 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
145 /* General socket configuration */
146 link->conf.Attributes = CONF_ENABLE_IRQ;
148 link->conf.IntType = INT_MEMORY_AND_IO;
149 link->conf.ConfigIndex = 1;
150 link->conf.Present = PRESENT_OPTION;
152 /* Allocate space for private device-specific data */
153 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
156 memset(local, 0, sizeof(local_info_t));
159 /* Register with Card Services */
160 link->next = dev_list;
162 client_reg.dev_info = &dev_info;
163 client_reg.Version = 0x0210;
164 client_reg.event_callback_args.client_data = link;
165 ret = pcmcia_register_client(&link->handle, &client_reg);
167 cs_error(link->handle, RegisterClient, ret);
179 /*======================================================================
181 This deletes a driver "instance". The device is de-registered
182 with Card Services. If it has been released, all local data
183 structures are freed. Otherwise, the structures will be freed
184 when the device is released.
186 ======================================================================*/
188 static void avmcs_detach(dev_link_t *link)
192 /* Locate device structure */
193 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
194 if (*linkp == link) break;
199 If the device is currently configured and active, we won't
200 actually delete it yet. Instead, it is marked so that when
201 the release() function is called, that will trigger a proper
204 if (link->state & DEV_CONFIG) {
205 link->state |= DEV_STALE_LINK;
209 /* Break the link with Card Services */
211 pcmcia_deregister_client(link->handle);
213 /* Unlink device structure, free pieces */
219 /*======================================================================
221 avmcs_config() is scheduled to run after a CARD_INSERTION event
222 is received, to configure the PCMCIA socket, and to make the
223 ethernet device available to the system.
225 ======================================================================*/
227 static int get_tuple(client_handle_t handle, tuple_t *tuple,
230 int i = pcmcia_get_tuple_data(handle, tuple);
231 if (i != CS_SUCCESS) return i;
232 return pcmcia_parse_tuple(handle, tuple, parse);
235 static int first_tuple(client_handle_t handle, tuple_t *tuple,
238 int i = pcmcia_get_first_tuple(handle, tuple);
239 if (i != CS_SUCCESS) return i;
240 return get_tuple(handle, tuple, parse);
243 static int next_tuple(client_handle_t handle, tuple_t *tuple,
246 int i = pcmcia_get_next_tuple(handle, tuple);
247 if (i != CS_SUCCESS) return i;
248 return get_tuple(handle, tuple, parse);
251 static void avmcs_config(dev_link_t *link)
253 client_handle_t handle;
256 cistpl_cftable_entry_t *cf = &parse.cftable_entry;
262 int (*addcard)(unsigned int port, unsigned irq);
264 handle = link->handle;
268 This reads the card's CONFIG tuple to find its configuration
272 tuple.DesiredTuple = CISTPL_CONFIG;
273 i = pcmcia_get_first_tuple(handle, &tuple);
274 if (i != CS_SUCCESS) break;
275 tuple.TupleData = buf;
276 tuple.TupleDataMax = 64;
277 tuple.TupleOffset = 0;
278 i = pcmcia_get_tuple_data(handle, &tuple);
279 if (i != CS_SUCCESS) break;
280 i = pcmcia_parse_tuple(handle, &tuple, &parse);
281 if (i != CS_SUCCESS) break;
282 link->conf.ConfigBase = parse.config.base;
284 if (i != CS_SUCCESS) {
285 cs_error(link->handle, ParseTuple, i);
286 link->state &= ~DEV_CONFIG_PENDING;
291 link->state |= DEV_CONFIG;
295 tuple.Attributes = 0;
296 tuple.TupleData = buf;
297 tuple.TupleDataMax = 254;
298 tuple.TupleOffset = 0;
299 tuple.DesiredTuple = CISTPL_VERS_1;
302 if( !first_tuple(handle, &tuple, &parse) && parse.version_1.ns > 1 ) {
303 strlcpy(devname,parse.version_1.str + parse.version_1.ofs[1],
309 tuple.TupleData = (cisdata_t *)buf;
310 tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
311 tuple.Attributes = 0;
312 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
313 i = first_tuple(handle, &tuple, &parse);
314 while (i == CS_SUCCESS) {
315 if (cf->io.nwin > 0) {
316 link->conf.ConfigIndex = cf->index;
317 link->io.BasePort1 = cf->io.win[0].base;
318 link->io.NumPorts1 = cf->io.win[0].len;
319 link->io.NumPorts2 = 0;
320 printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
322 link->io.BasePort1+link->io.NumPorts1-1);
323 i = pcmcia_request_io(link->handle, &link->io);
324 if (i == CS_SUCCESS) goto found_port;
326 i = next_tuple(handle, &tuple, &parse);
330 if (i != CS_SUCCESS) {
331 cs_error(link->handle, RequestIO, i);
336 * allocate an interrupt line
338 i = pcmcia_request_irq(link->handle, &link->irq);
339 if (i != CS_SUCCESS) {
340 cs_error(link->handle, RequestIRQ, i);
341 pcmcia_release_io(link->handle, &link->io);
346 * configure the PCMCIA socket
348 i = pcmcia_request_configuration(link->handle, &link->conf);
349 if (i != CS_SUCCESS) {
350 cs_error(link->handle, RequestConfiguration, i);
351 pcmcia_release_io(link->handle, &link->io);
352 pcmcia_release_irq(link->handle, &link->irq);
358 /* At this point, the dev_node_t structure(s) should be
359 initialized and arranged in a linked list at link->dev. */
362 char *s = strrchr(devname, ' ');
366 strcpy(dev->node.dev_name, s);
367 if (strcmp("M1", s) == 0) {
368 cardtype = AVM_CARDTYPE_M1;
369 } else if (strcmp("M2", s) == 0) {
370 cardtype = AVM_CARDTYPE_M2;
372 cardtype = AVM_CARDTYPE_B1;
375 strcpy(dev->node.dev_name, "b1");
376 cardtype = AVM_CARDTYPE_B1;
379 dev->node.major = 64;
381 link->dev = &dev->node;
383 link->state &= ~DEV_CONFIG_PENDING;
384 /* If any step failed, release any partially configured state */
392 case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
393 case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
395 case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
397 if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
398 printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
399 dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
407 /*======================================================================
409 After a card is removed, avmcs_release() will unregister the net
410 device, and release the PCMCIA configuration. If the device is
411 still open, this will be postponed until it is closed.
413 ======================================================================*/
415 static void avmcs_release(dev_link_t *link)
417 b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
419 /* Unlink the device chain */
422 /* Don't bother checking to see if these succeed or not */
423 pcmcia_release_configuration(link->handle);
424 pcmcia_release_io(link->handle, &link->io);
425 pcmcia_release_irq(link->handle, &link->irq);
426 link->state &= ~DEV_CONFIG;
428 if (link->state & DEV_STALE_LINK)
431 } /* avmcs_release */
433 /*======================================================================
435 The card status event handler. Mostly, this schedules other
436 stuff to run after an event is received. A CARD_REMOVAL event
437 also sets some flags to discourage the net drivers from trying
438 to talk to the card any more.
440 When a CARD_REMOVAL event is received, we immediately set a flag
441 to block future accesses to this device. All the functions that
442 actually access the device should check this flag to make sure
443 the card is still present.
445 ======================================================================*/
447 static int avmcs_event(event_t event, int priority,
448 event_callback_args_t *args)
450 dev_link_t *link = args->client_data;
453 case CS_EVENT_CARD_REMOVAL:
454 link->state &= ~DEV_PRESENT;
455 if (link->state & DEV_CONFIG)
458 case CS_EVENT_CARD_INSERTION:
459 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
462 case CS_EVENT_PM_SUSPEND:
463 link->state |= DEV_SUSPEND;
464 /* Fall through... */
465 case CS_EVENT_RESET_PHYSICAL:
466 if (link->state & DEV_CONFIG)
467 pcmcia_release_configuration(link->handle);
469 case CS_EVENT_PM_RESUME:
470 link->state &= ~DEV_SUSPEND;
471 /* Fall through... */
472 case CS_EVENT_CARD_RESET:
473 if (link->state & DEV_CONFIG)
474 pcmcia_request_configuration(link->handle, &link->conf);
480 static struct pcmcia_device_id avmcs_ids[] = {
481 PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
482 PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
483 PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
486 MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);
488 static struct pcmcia_driver avmcs_driver = {
489 .owner = THIS_MODULE,
493 .attach = avmcs_attach,
494 .event = avmcs_event,
495 .detach = avmcs_detach,
496 .id_table = avmcs_ids,
499 static int __init avmcs_init(void)
501 return pcmcia_register_driver(&avmcs_driver);
504 static void __exit avmcs_exit(void)
506 pcmcia_unregister_driver(&avmcs_driver);
507 BUG_ON(dev_list != NULL);
510 module_init(avmcs_init);
511 module_exit(avmcs_exit);