[PATCH] pcmcia: embed dev_link_t into struct pcmcia_device
[linux-3.10.git] / drivers / isdn / hardware / avm / avm_cs.c
1 /* $Id: avm_cs.c,v 1.4.6.3 2001/09/23 22:24:33 kai Exp $
2  *
3  * A PCMCIA client driver for AVM B1/M1/M2
4  *
5  * Copyright 1999 by Carsten Paeth <calle@calle.de>
6  *
7  * This software may be used and distributed according to the terms
8  * of the GNU General Public License, incorporated herein by reference.
9  *
10  */
11
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>
22 #include <asm/io.h>
23 #include <asm/system.h>
24
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>
31
32 #include <linux/skbuff.h>
33 #include <linux/capi.h>
34 #include <linux/b1lli.h>
35 #include <linux/b1pcmcia.h>
36
37 /*====================================================================*/
38
39 MODULE_DESCRIPTION("CAPI4Linux: PCMCIA client driver for AVM B1/M1/M2");
40 MODULE_AUTHOR("Carsten Paeth");
41 MODULE_LICENSE("GPL");
42
43 /*====================================================================*/
44
45 /*
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
51    handler.
52 */
53
54 static void avmcs_config(dev_link_t *link);
55 static void avmcs_release(dev_link_t *link);
56
57 /*
58    The attach() and detach() entry points are used to create and destroy
59    "instances" of the driver, where each instance represents everything
60    needed to manage one actual PCMCIA card.
61 */
62
63 static void avmcs_detach(struct pcmcia_device *p_dev);
64
65 /*
66    A linked list of "instances" of the skeleton device.  Each actual
67    PCMCIA card corresponds to one device instance, and is described
68    by one dev_link_t structure (defined in ds.h).
69
70    You may not want to use a linked list for this -- for example, the
71    memory card driver uses an array of dev_link_t pointers, where minor
72    device numbers are used to derive the corresponding array index.
73 */
74
75 /*
76    A driver needs to provide a dev_node_t structure for each device
77    on a card.  In some cases, there is only one device per card (for
78    example, ethernet cards, modems).  In other cases, there may be
79    many actual or logical devices (SCSI adapters, memory cards with
80    multiple partitions).  The dev_node_t structures need to be kept
81    in a linked list starting at the 'dev' field of a dev_link_t
82    structure.  We allocate them in the card's private data structure,
83    because they generally can't be allocated dynamically.
84 */
85    
86 typedef struct local_info_t {
87     dev_node_t  node;
88 } local_info_t;
89
90 /*======================================================================
91
92     avmcs_attach() creates an "instance" of the driver, allocating
93     local data structures for one device.  The device is registered
94     with Card Services.
95
96     The dev_link structure is initialized, but we don't actually
97     configure the card at this point -- we wait until we receive a
98     card insertion event.
99     
100 ======================================================================*/
101
102 static int avmcs_attach(struct pcmcia_device *p_dev)
103 {
104     local_info_t *local;
105
106     /* The io structure describes IO port mapping */
107     p_dev->io.NumPorts1 = 16;
108     p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
109     p_dev->io.NumPorts2 = 0;
110
111     /* Interrupt setup */
112     p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
113     p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
114
115     p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
116
117     /* General socket configuration */
118     p_dev->conf.Attributes = CONF_ENABLE_IRQ;
119     p_dev->conf.IntType = INT_MEMORY_AND_IO;
120     p_dev->conf.ConfigIndex = 1;
121     p_dev->conf.Present = PRESENT_OPTION;
122
123     /* Allocate space for private device-specific data */
124     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
125     if (!local)
126         goto err;
127     memset(local, 0, sizeof(local_info_t));
128     p_dev->priv = local;
129
130     p_dev->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
131     avmcs_config(p_dev);
132
133     return 0;
134
135  err:
136     return -EINVAL;
137 } /* avmcs_attach */
138
139 /*======================================================================
140
141     This deletes a driver "instance".  The device is de-registered
142     with Card Services.  If it has been released, all local data
143     structures are freed.  Otherwise, the structures will be freed
144     when the device is released.
145
146 ======================================================================*/
147
148 static void avmcs_detach(struct pcmcia_device *p_dev)
149 {
150     dev_link_t *link = dev_to_instance(p_dev);
151
152     if (link->state & DEV_CONFIG)
153         avmcs_release(link);
154
155     kfree(link->priv);
156 } /* avmcs_detach */
157
158 /*======================================================================
159
160     avmcs_config() is scheduled to run after a CARD_INSERTION event
161     is received, to configure the PCMCIA socket, and to make the
162     ethernet device available to the system.
163     
164 ======================================================================*/
165
166 static int get_tuple(client_handle_t handle, tuple_t *tuple,
167                      cisparse_t *parse)
168 {
169     int i = pcmcia_get_tuple_data(handle, tuple);
170     if (i != CS_SUCCESS) return i;
171     return pcmcia_parse_tuple(handle, tuple, parse);
172 }
173
174 static int first_tuple(client_handle_t handle, tuple_t *tuple,
175                      cisparse_t *parse)
176 {
177     int i = pcmcia_get_first_tuple(handle, tuple);
178     if (i != CS_SUCCESS) return i;
179     return get_tuple(handle, tuple, parse);
180 }
181
182 static int next_tuple(client_handle_t handle, tuple_t *tuple,
183                      cisparse_t *parse)
184 {
185     int i = pcmcia_get_next_tuple(handle, tuple);
186     if (i != CS_SUCCESS) return i;
187     return get_tuple(handle, tuple, parse);
188 }
189
190 static void avmcs_config(dev_link_t *link)
191 {
192     client_handle_t handle;
193     tuple_t tuple;
194     cisparse_t parse;
195     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
196     local_info_t *dev;
197     int i;
198     u_char buf[64];
199     char devname[128];
200     int cardtype;
201     int (*addcard)(unsigned int port, unsigned irq);
202     
203     handle = link->handle;
204     dev = link->priv;
205
206     /*
207        This reads the card's CONFIG tuple to find its configuration
208        registers.
209     */
210     do {
211         tuple.DesiredTuple = CISTPL_CONFIG;
212         i = pcmcia_get_first_tuple(handle, &tuple);
213         if (i != CS_SUCCESS) break;
214         tuple.TupleData = buf;
215         tuple.TupleDataMax = 64;
216         tuple.TupleOffset = 0;
217         i = pcmcia_get_tuple_data(handle, &tuple);
218         if (i != CS_SUCCESS) break;
219         i = pcmcia_parse_tuple(handle, &tuple, &parse);
220         if (i != CS_SUCCESS) break;
221         link->conf.ConfigBase = parse.config.base;
222     } while (0);
223     if (i != CS_SUCCESS) {
224         cs_error(link->handle, ParseTuple, i);
225         link->state &= ~DEV_CONFIG_PENDING;
226         return;
227     }
228     
229     /* Configure card */
230     link->state |= DEV_CONFIG;
231
232     do {
233
234         tuple.Attributes = 0;
235         tuple.TupleData = buf;
236         tuple.TupleDataMax = 254;
237         tuple.TupleOffset = 0;
238         tuple.DesiredTuple = CISTPL_VERS_1;
239
240         devname[0] = 0;
241         if( !first_tuple(handle, &tuple, &parse) && parse.version_1.ns > 1 ) {
242             strlcpy(devname,parse.version_1.str + parse.version_1.ofs[1], 
243                         sizeof(devname));
244         }
245         /*
246          * find IO port
247          */
248         tuple.TupleData = (cisdata_t *)buf;
249         tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
250         tuple.Attributes = 0;
251         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
252         i = first_tuple(handle, &tuple, &parse);
253         while (i == CS_SUCCESS) {
254             if (cf->io.nwin > 0) {
255                 link->conf.ConfigIndex = cf->index;
256                 link->io.BasePort1 = cf->io.win[0].base;
257                 link->io.NumPorts1 = cf->io.win[0].len;
258                 link->io.NumPorts2 = 0;
259                 printk(KERN_INFO "avm_cs: testing i/o %#x-%#x\n",
260                         link->io.BasePort1,
261                         link->io.BasePort1+link->io.NumPorts1-1);
262                 i = pcmcia_request_io(link->handle, &link->io);
263                 if (i == CS_SUCCESS) goto found_port;
264             }
265             i = next_tuple(handle, &tuple, &parse);
266         }
267
268 found_port:
269         if (i != CS_SUCCESS) {
270             cs_error(link->handle, RequestIO, i);
271             break;
272         }
273
274         /*
275          * allocate an interrupt line
276          */
277         i = pcmcia_request_irq(link->handle, &link->irq);
278         if (i != CS_SUCCESS) {
279             cs_error(link->handle, RequestIRQ, i);
280             /* undo */
281             pcmcia_disable_device(link->handle);
282             break;
283         }
284
285         /*
286          * configure the PCMCIA socket
287           */
288         i = pcmcia_request_configuration(link->handle, &link->conf);
289         if (i != CS_SUCCESS) {
290             cs_error(link->handle, RequestConfiguration, i);
291             pcmcia_disable_device(link->handle);
292             break;
293         }
294
295     } while (0);
296
297     /* At this point, the dev_node_t structure(s) should be
298        initialized and arranged in a linked list at link->dev. */
299
300     if (devname[0]) {
301         char *s = strrchr(devname, ' ');
302         if (!s)
303            s = devname;
304         else s++;
305         strcpy(dev->node.dev_name, s);
306         if (strcmp("M1", s) == 0) {
307            cardtype = AVM_CARDTYPE_M1;
308         } else if (strcmp("M2", s) == 0) {
309            cardtype = AVM_CARDTYPE_M2;
310         } else {
311            cardtype = AVM_CARDTYPE_B1;
312         }
313     } else {
314         strcpy(dev->node.dev_name, "b1");
315         cardtype = AVM_CARDTYPE_B1;
316     }
317
318     dev->node.major = 64;
319     dev->node.minor = 0;
320     link->dev_node = &dev->node;
321     
322     link->state &= ~DEV_CONFIG_PENDING;
323     /* If any step failed, release any partially configured state */
324     if (i != 0) {
325         avmcs_release(link);
326         return;
327     }
328
329
330     switch (cardtype) {
331         case AVM_CARDTYPE_M1: addcard = b1pcmcia_addcard_m1; break;
332         case AVM_CARDTYPE_M2: addcard = b1pcmcia_addcard_m2; break;
333         default:
334         case AVM_CARDTYPE_B1: addcard = b1pcmcia_addcard_b1; break;
335     }
336     if ((i = (*addcard)(link->io.BasePort1, link->irq.AssignedIRQ)) < 0) {
337         printk(KERN_ERR "avm_cs: failed to add AVM-%s-Controller at i/o %#x, irq %d\n",
338                 dev->node.dev_name, link->io.BasePort1, link->irq.AssignedIRQ);
339         avmcs_release(link);
340         return;
341     }
342     dev->node.minor = i;
343
344 } /* avmcs_config */
345
346 /*======================================================================
347
348     After a card is removed, avmcs_release() will unregister the net
349     device, and release the PCMCIA configuration.  If the device is
350     still open, this will be postponed until it is closed.
351     
352 ======================================================================*/
353
354 static void avmcs_release(dev_link_t *link)
355 {
356         b1pcmcia_delcard(link->io.BasePort1, link->irq.AssignedIRQ);
357         pcmcia_disable_device(link->handle);
358 } /* avmcs_release */
359
360
361 static struct pcmcia_device_id avmcs_ids[] = {
362         PCMCIA_DEVICE_PROD_ID12("AVM", "ISDN-Controller B1", 0x95d42008, 0x845dc335),
363         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M1", 0x95d42008, 0x81e10430),
364         PCMCIA_DEVICE_PROD_ID12("AVM", "Mobile ISDN-Controller M2", 0x95d42008, 0x18e8558a),
365         PCMCIA_DEVICE_NULL
366 };
367 MODULE_DEVICE_TABLE(pcmcia, avmcs_ids);
368
369 static struct pcmcia_driver avmcs_driver = {
370         .owner  = THIS_MODULE,
371         .drv    = {
372                 .name   = "avm_cs",
373         },
374         .probe = avmcs_attach,
375         .remove = avmcs_detach,
376         .id_table = avmcs_ids,
377 };
378
379 static int __init avmcs_init(void)
380 {
381         return pcmcia_register_driver(&avmcs_driver);
382 }
383
384 static void __exit avmcs_exit(void)
385 {
386         pcmcia_unregister_driver(&avmcs_driver);
387 }
388
389 module_init(avmcs_init);
390 module_exit(avmcs_exit);