449800898dcf6bdc69e981910404c5aa864de4a1
[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/cs_types.h>
50 #include <pcmcia/cs.h>
51 #include <pcmcia/cistpl.h>
52 #include <pcmcia/cisreg.h>
53 #include <pcmcia/ds.h>
54 #include "hisax_cfg.h"
55
56 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
57 MODULE_AUTHOR("Klaus Lichtenwalder");
58 MODULE_LICENSE("Dual MPL/GPL");
59
60 /*
61    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
62    you do not define PCMCIA_DEBUG at all, all the debug code will be
63    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
64    be present but disabled -- but it can then be enabled for specific
65    modules at load time with a 'pc_debug=#' option to insmod.
66 */
67
68 #ifdef PCMCIA_DEBUG
69 static int pc_debug = PCMCIA_DEBUG;
70 module_param(pc_debug, int, 0);
71 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
72 static char *version =
73 "elsa_cs.c $Revision: 1.2.2.4 $ $Date: 2004/01/25 15:07:06 $ (K.Lichtenwalder)";
74 #else
75 #define DEBUG(n, args...)
76 #endif
77
78 /*====================================================================*/
79
80 /* Parameters that can be set with 'insmod' */
81
82 static int protocol = 2;        /* EURO-ISDN Default */
83 module_param(protocol, int, 0);
84
85 /*====================================================================*/
86
87 /*
88    The event() function is this driver's Card Services event handler.
89    It will be called by Card Services when an appropriate card status
90    event is received.  The config() and release() entry points are
91    used to configure or release a socket, in response to card insertion
92    and ejection events.  They are invoked from the elsa_cs event
93    handler.
94 */
95
96 static int elsa_cs_config(struct pcmcia_device *link);
97 static void elsa_cs_release(struct pcmcia_device *link);
98
99 /*
100    The attach() and detach() entry points are used to create and destroy
101    "instances" of the driver, where each instance represents everything
102    needed to manage one actual PCMCIA card.
103 */
104
105 static void elsa_cs_detach(struct pcmcia_device *p_dev);
106
107 /*
108    A driver needs to provide a dev_node_t structure for each device
109    on a card.  In some cases, there is only one device per card (for
110    example, ethernet cards, modems).  In other cases, there may be
111    many actual or logical devices (SCSI adapters, memory cards with
112    multiple partitions).  The dev_node_t structures need to be kept
113    in a linked list starting at the 'dev' field of a struct pcmcia_device
114    structure.  We allocate them in the card's private data structure,
115    because they generally shouldn't be allocated dynamically.
116    In this case, we also provide a flag to indicate if a device is
117    "stopped" due to a power management event, or card ejection.  The
118    device IO routines can use a flag like this to throttle IO to a
119    card that is not ready to accept it.
120 */
121
122 typedef struct local_info_t {
123         struct pcmcia_device    *p_dev;
124     dev_node_t          node;
125     int                 busy;
126     int                 cardnr;
127 } local_info_t;
128
129 /*======================================================================
130
131     elsa_cs_attach() creates an "instance" of the driver, allocatingx
132     local data structures for one device.  The device is registered
133     with Card Services.
134
135     The dev_link structure is initialized, but we don't actually
136     configure the card at this point -- we wait until we receive a
137     card insertion event.
138
139 ======================================================================*/
140
141 static int elsa_cs_probe(struct pcmcia_device *link)
142 {
143     local_info_t *local;
144
145     DEBUG(0, "elsa_cs_attach()\n");
146
147     /* Allocate space for private device-specific data */
148     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
149     if (!local) return -ENOMEM;
150
151     local->p_dev = link;
152     link->priv = local;
153
154     local->cardnr = -1;
155
156     /* Interrupt setup */
157     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
158     link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
159     link->irq.Handler = NULL;
160
161     /*
162       General socket configuration defaults can go here.  In this
163       client, we assume very little, and rely on the CIS for almost
164       everything.  In most clients, many details (i.e., number, sizes,
165       and attributes of IO windows) are fixed by the nature of the
166       device, and can be hard-wired here.
167     */
168     link->io.NumPorts1 = 8;
169     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
170     link->io.IOAddrLines = 3;
171
172     link->conf.Attributes = CONF_ENABLE_IRQ;
173     link->conf.IntType = INT_MEMORY_AND_IO;
174
175     return elsa_cs_config(link);
176 } /* elsa_cs_attach */
177
178 /*======================================================================
179
180     This deletes a driver "instance".  The device is de-registered
181     with Card Services.  If it has been released, all local data
182     structures are freed.  Otherwise, the structures will be freed
183     when the device is released.
184
185 ======================================================================*/
186
187 static void elsa_cs_detach(struct pcmcia_device *link)
188 {
189         local_info_t *info = link->priv;
190
191         DEBUG(0, "elsa_cs_detach(0x%p)\n", link);
192
193         info->busy = 1;
194         elsa_cs_release(link);
195
196         kfree(info);
197 } /* elsa_cs_detach */
198
199 /*======================================================================
200
201     elsa_cs_config() is scheduled to run after a CARD_INSERTION event
202     is received, to configure the PCMCIA socket, and to make the
203     device available to the system.
204
205 ======================================================================*/
206
207 static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
208                                cistpl_cftable_entry_t *cf,
209                                void *priv_data)
210 {
211         int j;
212
213         if ((cf->io.nwin > 0) && cf->io.win[0].base) {
214                 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
215                 p_dev->conf.ConfigIndex = cf->index;
216                 p_dev->io.BasePort1 = cf->io.win[0].base;
217                 if (!pcmcia_request_io(p_dev, &p_dev->io))
218                         return 0;
219         } else {
220                 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
221                 p_dev->conf.ConfigIndex = cf->index;
222                 for (j = 0x2f0; j > 0x100; j -= 0x10) {
223                         p_dev->io.BasePort1 = j;
224                         if (!pcmcia_request_io(p_dev, &p_dev->io))
225                                 return 0;
226                 }
227         }
228         return -ENODEV;
229 }
230
231 static int elsa_cs_config(struct pcmcia_device *link)
232 {
233     local_info_t *dev;
234     int i, last_fn;
235     IsdnCard_t icard;
236
237     DEBUG(0, "elsa_config(0x%p)\n", link);
238     dev = link->priv;
239
240     i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
241     if (i != CS_SUCCESS) {
242         last_fn = RequestIO;
243         goto cs_failed;
244     }
245
246     i = pcmcia_request_irq(link, &link->irq);
247     if (i != CS_SUCCESS) {
248         link->irq.AssignedIRQ = 0;
249         last_fn = RequestIRQ;
250         goto cs_failed;
251     }
252
253     i = pcmcia_request_configuration(link, &link->conf);
254     if (i != CS_SUCCESS) {
255       last_fn = RequestConfiguration;
256       goto cs_failed;
257     }
258
259     /* At this point, the dev_node_t structure(s) should be
260        initialized and arranged in a linked list at link->dev. *//*  */
261     sprintf(dev->node.dev_name, "elsa");
262     dev->node.major = dev->node.minor = 0x0;
263
264     link->dev_node = &dev->node;
265
266     /* Finally, report what we've done */
267     printk(KERN_INFO "%s: index 0x%02x: ",
268            dev->node.dev_name, link->conf.ConfigIndex);
269     if (link->conf.Attributes & CONF_ENABLE_IRQ)
270         printk(", irq %d", link->irq.AssignedIRQ);
271     if (link->io.NumPorts1)
272         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
273                link->io.BasePort1+link->io.NumPorts1-1);
274     if (link->io.NumPorts2)
275         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
276                link->io.BasePort2+link->io.NumPorts2-1);
277     printk("\n");
278
279     icard.para[0] = link->irq.AssignedIRQ;
280     icard.para[1] = link->io.BasePort1;
281     icard.protocol = protocol;
282     icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
283     
284     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
285     if (i < 0) {
286         printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
287                 i, link->io.BasePort1);
288         elsa_cs_release(link);
289     } else
290         ((local_info_t*)link->priv)->cardnr = i;
291
292     return 0;
293 cs_failed:
294     cs_error(link, last_fn, i);
295     elsa_cs_release(link);
296     return -ENODEV;
297 } /* elsa_cs_config */
298
299 /*======================================================================
300
301     After a card is removed, elsa_cs_release() will unregister the net
302     device, and release the PCMCIA configuration.  If the device is
303     still open, this will be postponed until it is closed.
304
305 ======================================================================*/
306
307 static void elsa_cs_release(struct pcmcia_device *link)
308 {
309     local_info_t *local = link->priv;
310
311     DEBUG(0, "elsa_cs_release(0x%p)\n", link);
312
313     if (local) {
314         if (local->cardnr >= 0) {
315             /* no unregister function with hisax */
316             HiSax_closecard(local->cardnr);
317         }
318     }
319
320     pcmcia_disable_device(link);
321 } /* elsa_cs_release */
322
323 static int elsa_suspend(struct pcmcia_device *link)
324 {
325         local_info_t *dev = link->priv;
326
327         dev->busy = 1;
328
329         return 0;
330 }
331
332 static int elsa_resume(struct pcmcia_device *link)
333 {
334         local_info_t *dev = link->priv;
335
336         dev->busy = 0;
337
338         return 0;
339 }
340
341 static struct pcmcia_device_id elsa_ids[] = {
342         PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
343         PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
344         PCMCIA_DEVICE_NULL
345 };
346 MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
347
348 static struct pcmcia_driver elsa_cs_driver = {
349         .owner          = THIS_MODULE,
350         .drv            = {
351                 .name   = "elsa_cs",
352         },
353         .probe          = elsa_cs_probe,
354         .remove         = elsa_cs_detach,
355         .id_table       = elsa_ids,
356         .suspend        = elsa_suspend,
357         .resume         = elsa_resume,
358 };
359
360 static int __init init_elsa_cs(void)
361 {
362         return pcmcia_register_driver(&elsa_cs_driver);
363 }
364
365 static void __exit exit_elsa_cs(void)
366 {
367         pcmcia_unregister_driver(&elsa_cs_driver);
368 }
369
370 module_init(init_elsa_cs);
371 module_exit(exit_elsa_cs);