pcmcia: introduce autoconfiguration feature
[linux-2.6.git] / drivers / isdn / hisax / elsa_cs.c
1 /*======================================================================
2
3     An elsa_cs PCMCIA client driver
4
5     This driver is for the Elsa PCM ISDN Cards, i.e. the MicroLink
6
7
8     The contents of this file are subject to the Mozilla Public
9     License Version 1.1 (the "License"); you may not use this file
10     except in compliance with the License. You may obtain a copy of
11     the License at http://www.mozilla.org/MPL/
12
13     Software distributed under the License is distributed on an "AS
14     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
15     implied. See the License for the specific language governing
16     rights and limitations under the License.
17
18     The initial developer of the original code is David A. Hinds
19     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
20     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
21
22     Modifications from dummy_cs.c are Copyright (C) 1999-2001 Klaus
23     Lichtenwalder <Lichtenwalder@ACM.org>. All Rights Reserved.
24
25     Alternatively, the contents of this file may be used under the
26     terms of the GNU General Public License version 2 (the "GPL"), in
27     which case the provisions of the GPL are applicable instead of the
28     above.  If you wish to allow the use of your version of this file
29     only under the terms of the GPL and not to allow others to use
30     your version of this file under the MPL, indicate your decision
31     by deleting the provisions above and replace them with the notice
32     and other provisions required by the GPL.  If you do not delete
33     the provisions above, a recipient may use your version of this
34     file under either the MPL or the GPL.
35
36 ======================================================================*/
37
38 #include <linux/module.h>
39 #include <linux/kernel.h>
40 #include <linux/init.h>
41 #include <linux/ptrace.h>
42 #include <linux/slab.h>
43 #include <linux/string.h>
44 #include <linux/timer.h>
45 #include <linux/ioport.h>
46 #include <asm/io.h>
47 #include <asm/system.h>
48
49 #include <pcmcia/cistpl.h>
50 #include <pcmcia/cisreg.h>
51 #include <pcmcia/ds.h>
52 #include "hisax_cfg.h"
53
54 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
55 MODULE_AUTHOR("Klaus Lichtenwalder");
56 MODULE_LICENSE("Dual MPL/GPL");
57
58
59 /*====================================================================*/
60
61 /* Parameters that can be set with 'insmod' */
62
63 static int protocol = 2;        /* EURO-ISDN Default */
64 module_param(protocol, int, 0);
65
66 /*====================================================================*/
67
68 /*
69    The event() function is this driver's Card Services event handler.
70    It will be called by Card Services when an appropriate card status
71    event is received.  The config() and release() entry points are
72    used to configure or release a socket, in response to card insertion
73    and ejection events.  They are invoked from the elsa_cs event
74    handler.
75 */
76
77 static int elsa_cs_config(struct pcmcia_device *link) __devinit ;
78 static void elsa_cs_release(struct pcmcia_device *link);
79
80 /*
81    The attach() and detach() entry points are used to create and destroy
82    "instances" of the driver, where each instance represents everything
83    needed to manage one actual PCMCIA card.
84 */
85
86 static void elsa_cs_detach(struct pcmcia_device *p_dev) __devexit;
87
88 typedef struct local_info_t {
89         struct pcmcia_device    *p_dev;
90     int                 busy;
91     int                 cardnr;
92 } local_info_t;
93
94 /*======================================================================
95
96     elsa_cs_attach() creates an "instance" of the driver, allocatingx
97     local data structures for one device.  The device is registered
98     with Card Services.
99
100     The dev_link structure is initialized, but we don't actually
101     configure the card at this point -- we wait until we receive a
102     card insertion event.
103
104 ======================================================================*/
105
106 static int __devinit elsa_cs_probe(struct pcmcia_device *link)
107 {
108     local_info_t *local;
109
110     dev_dbg(&link->dev, "elsa_cs_attach()\n");
111
112     /* Allocate space for private device-specific data */
113     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
114     if (!local) return -ENOMEM;
115
116     local->p_dev = link;
117     link->priv = local;
118
119     local->cardnr = -1;
120
121     /*
122       General socket configuration defaults can go here.  In this
123       client, we assume very little, and rely on the CIS for almost
124       everything.  In most clients, many details (i.e., number, sizes,
125       and attributes of IO windows) are fixed by the nature of the
126       device, and can be hard-wired here.
127     */
128     link->resource[0]->end = 8;
129     link->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO;
130
131     return elsa_cs_config(link);
132 } /* elsa_cs_attach */
133
134 /*======================================================================
135
136     This deletes a driver "instance".  The device is de-registered
137     with Card Services.  If it has been released, all local data
138     structures are freed.  Otherwise, the structures will be freed
139     when the device is released.
140
141 ======================================================================*/
142
143 static void __devexit elsa_cs_detach(struct pcmcia_device *link)
144 {
145         local_info_t *info = link->priv;
146
147         dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);
148
149         info->busy = 1;
150         elsa_cs_release(link);
151
152         kfree(info);
153 } /* elsa_cs_detach */
154
155 /*======================================================================
156
157     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
158     is received, to configure the PCMCIA socket, and to make the
159     device available to the system.
160
161 ======================================================================*/
162
163 static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
164                                cistpl_cftable_entry_t *cf,
165                                cistpl_cftable_entry_t *dflt,
166                                void *priv_data)
167 {
168         int j;
169
170         p_dev->io_lines = 3;
171
172         if ((cf->io.nwin > 0) && cf->io.win[0].base) {
173                 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
174                 p_dev->resource[0]->start = cf->io.win[0].base;
175                 if (!pcmcia_request_io(p_dev))
176                         return 0;
177         } else {
178                 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
179                 for (j = 0x2f0; j > 0x100; j -= 0x10) {
180                         p_dev->resource[0]->start = j;
181                         if (!pcmcia_request_io(p_dev))
182                                 return 0;
183                 }
184         }
185         return -ENODEV;
186 }
187
188 static int __devinit elsa_cs_config(struct pcmcia_device *link)
189 {
190     local_info_t *dev;
191     int i;
192     IsdnCard_t icard;
193
194     dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
195     dev = link->priv;
196
197     i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
198     if (i != 0)
199         goto failed;
200
201     if (!link->irq)
202         goto failed;
203
204     i = pcmcia_enable_device(link);
205     if (i != 0)
206         goto failed;
207
208     /* Finally, report what we've done */
209     dev_info(&link->dev, "index 0x%02x: ",
210             link->config_index);
211     printk(", irq %d", link->irq);
212     if (link->resource[0])
213         printk(" & %pR", link->resource[0]);
214     if (link->resource[1])
215         printk(" & %pR", link->resource[1]);
216     printk("\n");
217
218     icard.para[0] = link->irq;
219     icard.para[1] = link->resource[0]->start;
220     icard.protocol = protocol;
221     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
222     
223     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
224     if (i < 0) {
225         printk(KERN_ERR "elsa_cs: failed to initialize Elsa "
226                 "PCMCIA %d with %pR\n", i, link->resource[0]);
227         elsa_cs_release(link);
228     } else
229         ((local_info_t*)link->priv)->cardnr = i;
230
231     return 0;
232 failed:
233     elsa_cs_release(link);
234     return -ENODEV;
235 } /* elsa_cs_config */
236
237 /*======================================================================
238
239     After a card is removed, elsa_cs_release() will unregister the net
240     device, and release the PCMCIA configuration.  If the device is
241     still open, this will be postponed until it is closed.
242
243 ======================================================================*/
244
245 static void elsa_cs_release(struct pcmcia_device *link)
246 {
247     local_info_t *local = link->priv;
248
249     dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);
250
251     if (local) {
252         if (local->cardnr >= 0) {
253             /* no unregister function with hisax */
254             HiSax_closecard(local->cardnr);
255         }
256     }
257
258     pcmcia_disable_device(link);
259 } /* elsa_cs_release */
260
261 static int elsa_suspend(struct pcmcia_device *link)
262 {
263         local_info_t *dev = link->priv;
264
265         dev->busy = 1;
266
267         return 0;
268 }
269
270 static int elsa_resume(struct pcmcia_device *link)
271 {
272         local_info_t *dev = link->priv;
273
274         dev->busy = 0;
275
276         return 0;
277 }
278
279 static struct pcmcia_device_id elsa_ids[] = {
280         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
281         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
282         PCMCIA_DEVICE_NULL
283 };
284 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
285
286 static struct pcmcia_driver elsa_cs_driver = {
287         .owner          = THIS_MODULE,
288         .drv            = {
289                 .name   = "elsa_cs",
290         },
291         .probe          = elsa_cs_probe,
292         .remove         = __devexit_p(elsa_cs_detach),
293         .id_table       = elsa_ids,
294         .suspend        = elsa_suspend,
295         .resume         = elsa_resume,
296 };
297
298 static int __init init_elsa_cs(void)
299 {
300         return pcmcia_register_driver(&elsa_cs_driver);
301 }
302
303 static void __exit exit_elsa_cs(void)
304 {
305         pcmcia_unregister_driver(&elsa_cs_driver);
306 }
307
308 module_init(init_elsa_cs);
309 module_exit(exit_elsa_cs);