[PATCH] pcmcia: add return value to _config() functions
[safe/jmp/linux-2.6] / 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/cs_types.h>
32 #include <pcmcia/cs.h>
33 #include <pcmcia/cistpl.h>
34 #include <pcmcia/cisreg.h>
35 #include <pcmcia/ds.h>
36 #include "hisax_cfg.h"
37
38 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Teles PCMCIA cards");
39 MODULE_AUTHOR("Christof Petig, christof.petig@wtal.de, Karsten Keil, kkeil@suse.de");
40 MODULE_LICENSE("GPL");
41
42 /*
43    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
44    you do not define PCMCIA_DEBUG at all, all the debug code will be
45    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
46    be present but disabled -- but it can then be enabled for specific
47    modules at load time with a 'pc_debug=#' option to insmod.
48 */
49
50 #ifdef PCMCIA_DEBUG
51 static int pc_debug = PCMCIA_DEBUG;
52 module_param(pc_debug, int, 0);
53 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
54 static char *version =
55 "teles_cs.c 2.10 2002/07/30 22:23:34 kkeil";
56 #else
57 #define DEBUG(n, args...)
58 #endif
59
60 /*====================================================================*/
61
62 /* Parameters that can be set with 'insmod' */
63
64 static int protocol = 2;        /* EURO-ISDN Default */
65 module_param(protocol, int, 0);
66
67 /*====================================================================*/
68
69 /*
70    The event() function is this driver's Card Services event handler.
71    It will be called by Card Services when an appropriate card status
72    event is received.  The config() and release() entry points are
73    used to configure or release a socket, in response to card insertion
74    and ejection events.  They are invoked from the teles_cs event
75    handler.
76 */
77
78 static int teles_cs_config(struct pcmcia_device *link);
79 static void teles_cs_release(struct pcmcia_device *link);
80
81 /*
82    The attach() and detach() entry points are used to create and destroy
83    "instances" of the driver, where each instance represents everything
84    needed to manage one actual PCMCIA card.
85 */
86
87 static void teles_detach(struct pcmcia_device *p_dev);
88
89 /*
90    A linked list of "instances" of the teles_cs device.  Each actual
91    PCMCIA card corresponds to one device instance, and is described
92    by one struct pcmcia_device structure (defined in ds.h).
93
94    You may not want to use a linked list for this -- for example, the
95    memory card driver uses an array of struct pcmcia_device pointers, where minor
96    device numbers are used to derive the corresponding array index.
97 */
98
99 /*
100    A driver needs to provide a dev_node_t structure for each device
101    on a card.  In some cases, there is only one device per card (for
102    example, ethernet cards, modems).  In other cases, there may be
103    many actual or logical devices (SCSI adapters, memory cards with
104    multiple partitions).  The dev_node_t structures need to be kept
105    in a linked list starting at the 'dev' field of a struct pcmcia_device
106    structure.  We allocate them in the card's private data structure,
107    because they generally shouldn't be allocated dynamically.
108    In this case, we also provide a flag to indicate if a device is
109    "stopped" due to a power management event, or card ejection.  The
110    device IO routines can use a flag like this to throttle IO to a
111    card that is not ready to accept it.
112 */
113
114 typedef struct local_info_t {
115         struct pcmcia_device    *p_dev;
116     dev_node_t          node;
117     int                 busy;
118     int                 cardnr;
119 } local_info_t;
120
121 /*======================================================================
122
123     teles_attach() creates an "instance" of the driver, allocatingx
124     local data structures for one device.  The device is registered
125     with Card Services.
126
127     The dev_link structure is initialized, but we don't actually
128     configure the card at this point -- we wait until we receive a
129     card insertion event.
130
131 ======================================================================*/
132
133 static int teles_probe(struct pcmcia_device *link)
134 {
135     local_info_t *local;
136
137     DEBUG(0, "teles_attach()\n");
138
139     /* Allocate space for private device-specific data */
140     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
141     if (!local) return -ENOMEM;
142     memset(local, 0, sizeof(local_info_t));
143     local->cardnr = -1;
144
145     local->p_dev = link;
146     link->priv = local;
147
148     /* Interrupt setup */
149     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
150     link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
151     link->irq.Handler = NULL;
152
153     /*
154       General socket configuration defaults can go here.  In this
155       client, we assume very little, and rely on the CIS for almost
156       everything.  In most clients, many details (i.e., number, sizes,
157       and attributes of IO windows) are fixed by the nature of the
158       device, and can be hard-wired here.
159     */
160     link->io.NumPorts1 = 96;
161     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
162     link->io.IOAddrLines = 5;
163
164     link->conf.Attributes = CONF_ENABLE_IRQ;
165     link->conf.IntType = INT_MEMORY_AND_IO;
166
167     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
168     return teles_cs_config(link);
169 } /* teles_attach */
170
171 /*======================================================================
172
173     This deletes a driver "instance".  The device is de-registered
174     with Card Services.  If it has been released, all local data
175     structures are freed.  Otherwise, the structures will be freed
176     when the device is released.
177
178 ======================================================================*/
179
180 static void teles_detach(struct pcmcia_device *link)
181 {
182     local_info_t *info = link->priv;
183
184     DEBUG(0, "teles_detach(0x%p)\n", link);
185
186     if (link->state & DEV_CONFIG) {
187             info->busy = 1;
188             teles_cs_release(link);
189     }
190
191     kfree(info);
192
193 } /* teles_detach */
194
195 /*======================================================================
196
197     teles_cs_config() is scheduled to run after a CARD_INSERTION event
198     is received, to configure the PCMCIA socket, and to make the
199     device available to the system.
200
201 ======================================================================*/
202 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple,
203                      cisparse_t *parse)
204 {
205     int i = pcmcia_get_tuple_data(handle, tuple);
206     if (i != CS_SUCCESS) return i;
207     return pcmcia_parse_tuple(handle, tuple, parse);
208 }
209
210 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple,
211                      cisparse_t *parse)
212 {
213     int i = pcmcia_get_first_tuple(handle, tuple);
214     if (i != CS_SUCCESS) return i;
215     return get_tuple(handle, tuple, parse);
216 }
217
218 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple,
219                      cisparse_t *parse)
220 {
221     int i = pcmcia_get_next_tuple(handle, tuple);
222     if (i != CS_SUCCESS) return i;
223     return get_tuple(handle, tuple, parse);
224 }
225
226 static int teles_cs_config(struct pcmcia_device *link)
227 {
228     tuple_t tuple;
229     cisparse_t parse;
230     local_info_t *dev;
231     int i, j, last_fn;
232     u_short buf[128];
233     cistpl_cftable_entry_t *cf = &parse.cftable_entry;
234     IsdnCard_t icard;
235
236     DEBUG(0, "teles_config(0x%p)\n", link);
237     dev = link->priv;
238
239     /*
240        This reads the card's CONFIG tuple to find its configuration
241        registers.
242     */
243     tuple.DesiredTuple = CISTPL_CONFIG;
244     tuple.TupleData = (cisdata_t *)buf;
245     tuple.TupleDataMax = 255;
246     tuple.TupleOffset = 0;
247     tuple.Attributes = 0;
248     i = first_tuple(link, &tuple, &parse);
249     if (i != CS_SUCCESS) {
250         last_fn = ParseTuple;
251         goto cs_failed;
252     }
253     link->conf.ConfigBase = parse.config.base;
254     link->conf.Present = parse.config.rmask[0];
255
256     /* Configure card */
257     link->state |= DEV_CONFIG;
258
259     tuple.TupleData = (cisdata_t *)buf;
260     tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
261     tuple.Attributes = 0;
262     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
263     i = first_tuple(link, &tuple, &parse);
264     while (i == CS_SUCCESS) {
265         if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
266             printk(KERN_INFO "(teles_cs: looks like the 96 model)\n");
267             link->conf.ConfigIndex = cf->index;
268             link->io.BasePort1 = cf->io.win[0].base;
269             i = pcmcia_request_io(link, &link->io);
270             if (i == CS_SUCCESS) break;
271         } else {
272           printk(KERN_INFO "(teles_cs: looks like the 97 model)\n");
273           link->conf.ConfigIndex = cf->index;
274           for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
275             link->io.BasePort1 = j;
276             i = pcmcia_request_io(link, &link->io);
277             if (i == CS_SUCCESS) break;
278           }
279           break;
280         }
281         i = next_tuple(link, &tuple, &parse);
282     }
283
284     if (i != CS_SUCCESS) {
285         last_fn = RequestIO;
286         goto cs_failed;
287     }
288
289     i = pcmcia_request_irq(link, &link->irq);
290     if (i != CS_SUCCESS) {
291         link->irq.AssignedIRQ = 0;
292         last_fn = RequestIRQ;
293         goto cs_failed;
294     }
295
296     i = pcmcia_request_configuration(link, &link->conf);
297     if (i != CS_SUCCESS) {
298       last_fn = RequestConfiguration;
299       goto cs_failed;
300     }
301
302     /* At this point, the dev_node_t structure(s) should be
303        initialized and arranged in a linked list at link->dev. *//*  */
304     sprintf(dev->node.dev_name, "teles");
305     dev->node.major = dev->node.minor = 0x0;
306
307     link->dev_node = &dev->node;
308
309     /* Finally, report what we've done */
310     printk(KERN_INFO "%s: index 0x%02x:",
311            dev->node.dev_name, link->conf.ConfigIndex);
312     if (link->conf.Attributes & CONF_ENABLE_IRQ)
313         printk(", irq %d", link->irq.AssignedIRQ);
314     if (link->io.NumPorts1)
315         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
316                link->io.BasePort1+link->io.NumPorts1-1);
317     if (link->io.NumPorts2)
318         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
319                link->io.BasePort2+link->io.NumPorts2-1);
320     printk("\n");
321
322     link->state &= ~DEV_CONFIG_PENDING;
323
324     icard.para[0] = link->irq.AssignedIRQ;
325     icard.para[1] = link->io.BasePort1;
326     icard.protocol = protocol;
327     icard.typ = ISDN_CTYPE_TELESPCMCIA;
328     
329     i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
330     if (i < 0) {
331         printk(KERN_ERR "teles_cs: failed to initialize Teles PCMCIA %d at i/o %#x\n",
332                 i, link->io.BasePort1);
333         teles_cs_release(link);
334         return -ENODEV;
335     }
336
337     ((local_info_t*)link->priv)->cardnr = i;
338     return 0;
339
340 cs_failed:
341     cs_error(link, last_fn, i);
342     teles_cs_release(link);
343     return -ENODEV;
344 } /* teles_cs_config */
345
346 /*======================================================================
347
348     After a card is removed, teles_cs_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 teles_cs_release(struct pcmcia_device *link)
355 {
356     local_info_t *local = link->priv;
357
358     DEBUG(0, "teles_cs_release(0x%p)\n", link);
359
360     if (local) {
361         if (local->cardnr >= 0) {
362             /* no unregister function with hisax */
363             HiSax_closecard(local->cardnr);
364         }
365     }
366
367     pcmcia_disable_device(link);
368 } /* teles_cs_release */
369
370 static int teles_suspend(struct pcmcia_device *link)
371 {
372         local_info_t *dev = link->priv;
373
374         dev->busy = 1;
375
376         return 0;
377 }
378
379 static int teles_resume(struct pcmcia_device *link)
380 {
381         local_info_t *dev = link->priv;
382
383         dev->busy = 0;
384
385         return 0;
386 }
387
388
389 static struct pcmcia_device_id teles_ids[] = {
390         PCMCIA_DEVICE_PROD_ID12("TELES", "S0/PC", 0x67b50eae, 0xe9e70119),
391         PCMCIA_DEVICE_NULL,
392 };
393 MODULE_DEVICE_TABLE(pcmcia, teles_ids);
394
395 static struct pcmcia_driver teles_cs_driver = {
396         .owner          = THIS_MODULE,
397         .drv            = {
398                 .name   = "teles_cs",
399         },
400         .probe          = teles_probe,
401         .remove         = teles_detach,
402         .id_table       = teles_ids,
403         .suspend        = teles_suspend,
404         .resume         = teles_resume,
405 };
406
407 static int __init init_teles_cs(void)
408 {
409         return pcmcia_register_driver(&teles_cs_driver);
410 }
411
412 static void __exit exit_teles_cs(void)
413 {
414         pcmcia_unregister_driver(&teles_cs_driver);
415 }
416
417 module_init(init_teles_cs);
418 module_exit(exit_teles_cs);