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