[PATCH] pcmcia: embed dev_link_t into struct pcmcia_device
[linux-3.10.git] / drivers / isdn / hisax / sedlbauer_cs.c
1 /*======================================================================
2
3     A Sedlbauer PCMCIA client driver
4
5     This driver is for the Sedlbauer Speed Star and Speed Star II, 
6     which are ISDN PCMCIA Cards.
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 Marcus Niemann
23     <maniemann@users.sourceforge.net>. 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/kernel.h>
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/sched.h>
42 #include <linux/ptrace.h>
43 #include <linux/slab.h>
44 #include <linux/string.h>
45 #include <linux/timer.h>
46 #include <linux/ioport.h>
47 #include <asm/io.h>
48 #include <asm/system.h>
49
50 #include <pcmcia/cs_types.h>
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/cisreg.h>
54 #include <pcmcia/ds.h>
55 #include "hisax_cfg.h"
56
57 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
58 MODULE_AUTHOR("Marcus Niemann");
59 MODULE_LICENSE("Dual MPL/GPL");
60
61 /*
62    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
63    you do not define PCMCIA_DEBUG at all, all the debug code will be
64    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
65    be present but disabled -- but it can then be enabled for specific
66    modules at load time with a 'pc_debug=#' option to insmod.
67 */
68
69 #ifdef PCMCIA_DEBUG
70 static int pc_debug = PCMCIA_DEBUG;
71 module_param(pc_debug, int, 0);
72 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args); 
73 static char *version =
74 "sedlbauer_cs.c 1.1a 2001/01/28 15:04:04 (M.Niemann)";
75 #else
76 #define DEBUG(n, args...)
77 #endif
78
79
80 /*====================================================================*/
81
82 /* Parameters that can be set with 'insmod' */
83
84 static int protocol = 2;        /* EURO-ISDN Default */
85 module_param(protocol, int, 0);
86
87 /*====================================================================*/
88
89 /*
90    The event() function is this driver's Card Services event handler.
91    It will be called by Card Services when an appropriate card status
92    event is received.  The config() and release() entry points are
93    used to configure or release a socket, in response to card
94    insertion and ejection events.  They are invoked from the sedlbauer
95    event handler. 
96 */
97
98 static void sedlbauer_config(dev_link_t *link);
99 static void sedlbauer_release(dev_link_t *link);
100
101 /*
102    The attach() and detach() entry points are used to create and destroy
103    "instances" of the driver, where each instance represents everything
104    needed to manage one actual PCMCIA card.
105 */
106
107 static void sedlbauer_detach(struct pcmcia_device *p_dev);
108
109 /*
110    You'll also need to prototype all the functions that will actually
111    be used to talk to your device.  See 'memory_cs' for a good example
112    of a fully self-sufficient driver; the other drivers rely more or
113    less on other parts of the kernel.
114 */
115
116 /*
117    A driver needs to provide a dev_node_t structure for each device
118    on a card.  In some cases, there is only one device per card (for
119    example, ethernet cards, modems).  In other cases, there may be
120    many actual or logical devices (SCSI adapters, memory cards with
121    multiple partitions).  The dev_node_t structures need to be kept
122    in a linked list starting at the 'dev' field of a dev_link_t
123    structure.  We allocate them in the card's private data structure,
124    because they generally shouldn't be allocated dynamically.
125
126    In this case, we also provide a flag to indicate if a device is
127    "stopped" due to a power management event, or card ejection.  The
128    device IO routines can use a flag like this to throttle IO to a
129    card that is not ready to accept it.
130 */
131    
132 typedef struct local_info_t {
133         struct pcmcia_device    *p_dev;
134     dev_node_t          node;
135     int                 stop;
136     int                 cardnr;
137 } local_info_t;
138
139 /*======================================================================
140
141     sedlbauer_attach() creates an "instance" of the driver, allocating
142     local data structures for one device.  The device is registered
143     with Card Services.
144
145     The dev_link structure is initialized, but we don't actually
146     configure the card at this point -- we wait until we receive a
147     card insertion event.
148     
149 ======================================================================*/
150
151 static int sedlbauer_attach(struct pcmcia_device *p_dev)
152 {
153     local_info_t *local;
154     dev_link_t *link = dev_to_instance(p_dev);
155     
156     DEBUG(0, "sedlbauer_attach()\n");
157
158     /* Allocate space for private device-specific data */
159     local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
160     if (!local) return -ENOMEM;
161     memset(local, 0, sizeof(local_info_t));
162     local->cardnr = -1;
163
164     local->p_dev = p_dev;
165     link->priv = local;
166
167     /* Interrupt setup */
168     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
169     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
170     link->irq.Handler = NULL;
171
172     /*
173       General socket configuration defaults can go here.  In this
174       client, we assume very little, and rely on the CIS for almost
175       everything.  In most clients, many details (i.e., number, sizes,
176       and attributes of IO windows) are fixed by the nature of the
177       device, and can be hard-wired here.
178     */
179
180     /* from old sedl_cs 
181     */
182     /* The io structure describes IO port mapping */
183     link->io.NumPorts1 = 8;
184     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
185     link->io.IOAddrLines = 3;
186
187     link->conf.Attributes = 0;
188     link->conf.IntType = INT_MEMORY_AND_IO;
189
190     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
191     sedlbauer_config(link);
192
193     return 0;
194 } /* sedlbauer_attach */
195
196 /*======================================================================
197
198     This deletes a driver "instance".  The device is de-registered
199     with Card Services.  If it has been released, all local data
200     structures are freed.  Otherwise, the structures will be freed
201     when the device is released.
202
203 ======================================================================*/
204
205 static void sedlbauer_detach(struct pcmcia_device *p_dev)
206 {
207     dev_link_t *link = dev_to_instance(p_dev);
208
209     DEBUG(0, "sedlbauer_detach(0x%p)\n", link);
210
211     if (link->state & DEV_CONFIG) {
212             ((local_info_t *)link->priv)->stop = 1;
213             sedlbauer_release(link);
214     }
215
216     /* This points to the parent local_info_t struct */
217     kfree(link->priv);
218 } /* sedlbauer_detach */
219
220 /*======================================================================
221
222     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
223     is received, to configure the PCMCIA socket, and to make the
224     device available to the system.
225     
226 ======================================================================*/
227 #define CS_CHECK(fn, ret) \
228 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
229
230 static void sedlbauer_config(dev_link_t *link)
231 {
232     client_handle_t handle = link->handle;
233     local_info_t *dev = link->priv;
234     tuple_t tuple;
235     cisparse_t parse;
236     int last_fn, last_ret;
237     u8 buf[64];
238     config_info_t conf;
239     win_req_t req;
240     memreq_t map;
241     IsdnCard_t  icard;
242
243     DEBUG(0, "sedlbauer_config(0x%p)\n", link);
244
245     /*
246        This reads the card's CONFIG tuple to find its configuration
247        registers.
248     */
249     tuple.DesiredTuple = CISTPL_CONFIG;
250     tuple.Attributes = 0;
251     tuple.TupleData = buf;
252     tuple.TupleDataMax = sizeof(buf);
253     tuple.TupleOffset = 0;
254     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
255     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
256     CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
257     link->conf.ConfigBase = parse.config.base;
258     link->conf.Present = parse.config.rmask[0];
259     
260     /* Configure card */
261     link->state |= DEV_CONFIG;
262
263     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &conf));
264
265     /*
266       In this loop, we scan the CIS for configuration table entries,
267       each of which describes a valid card configuration, including
268       voltage, IO window, memory window, and interrupt settings.
269
270       We make no assumptions about the card to be configured: we use
271       just the information available in the CIS.  In an ideal world,
272       this would work for any PCMCIA card, but it requires a complete
273       and accurate CIS.  In practice, a driver usually "knows" most of
274       these things without consulting the CIS, and most client drivers
275       will only use the CIS to fill in implementation-defined details.
276     */
277     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
278     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
279     while (1) {
280         cistpl_cftable_entry_t dflt = { 0 };
281         cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
282         if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
283                 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
284             goto next_entry;
285
286         if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
287         if (cfg->index == 0) goto next_entry;
288         link->conf.ConfigIndex = cfg->index;
289         
290         /* Does this card need audio output? */
291         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
292             link->conf.Attributes |= CONF_ENABLE_SPKR;
293             link->conf.Status = CCSR_AUDIO_ENA;
294         }
295         
296         /* Use power settings for Vcc and Vpp if present */
297         /*  Note that the CIS values need to be rescaled */
298         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
299             if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
300                 goto next_entry;
301         } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
302             if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM]/10000)
303                 goto next_entry;
304         }
305             
306         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
307             link->conf.Vpp =
308                 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
309         else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
310             link->conf.Vpp =
311                 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
312         
313         /* Do we need to allocate an interrupt? */
314         if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
315             link->conf.Attributes |= CONF_ENABLE_IRQ;
316         
317         /* IO window settings */
318         link->io.NumPorts1 = link->io.NumPorts2 = 0;
319         if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
320             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
321             link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
322             if (!(io->flags & CISTPL_IO_8BIT))
323                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
324             if (!(io->flags & CISTPL_IO_16BIT))
325                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
326 /* new in dummy.cs 2001/01/28 MN 
327             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
328 */
329             link->io.BasePort1 = io->win[0].base;
330             link->io.NumPorts1 = io->win[0].len;
331             if (io->nwin > 1) {
332                 link->io.Attributes2 = link->io.Attributes1;
333                 link->io.BasePort2 = io->win[1].base;
334                 link->io.NumPorts2 = io->win[1].len;
335             }
336             /* This reserves IO space but doesn't actually enable it */
337             if (pcmcia_request_io(link->handle, &link->io) != 0)
338                 goto next_entry;
339         }
340
341         /*
342           Now set up a common memory window, if needed.  There is room
343           in the dev_link_t structure for one memory window handle,
344           but if the base addresses need to be saved, or if multiple
345           windows are needed, the info should go in the private data
346           structure for this device.
347
348           Note that the memory window base is a physical address, and
349           needs to be mapped to virtual space with ioremap() before it
350           is used.
351         */
352         if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
353             cistpl_mem_t *mem =
354                 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
355             req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
356             req.Attributes |= WIN_ENABLE;
357             req.Base = mem->win[0].host_addr;
358             req.Size = mem->win[0].len;
359 /* new in dummy.cs 2001/01/28 MN 
360             if (req.Size < 0x1000)
361                 req.Size = 0x1000;
362 */
363             req.AccessSpeed = 0;
364             if (pcmcia_request_window(&link->handle, &req, &link->win) != 0)
365                 goto next_entry;
366             map.Page = 0; map.CardOffset = mem->win[0].card_addr;
367             if (pcmcia_map_mem_page(link->win, &map) != 0)
368                 goto next_entry;
369         }
370         /* If we got this far, we're cool! */
371         break;
372
373     next_entry:
374         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
375     }
376
377     /*
378        Allocate an interrupt line.  Note that this does not assign a
379        handler to the interrupt, unless the 'Handler' member of the
380        irq structure is initialized.
381     */
382     if (link->conf.Attributes & CONF_ENABLE_IRQ)
383         CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
384         
385     /*
386        This actually configures the PCMCIA socket -- setting up
387        the I/O windows and the interrupt mapping, and putting the
388        card and host interface into "Memory and IO" mode.
389     */
390     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
391
392     /*
393       At this point, the dev_node_t structure(s) need to be
394       initialized and arranged in a linked list at link->dev.
395     */
396     sprintf(dev->node.dev_name, "sedlbauer");
397     dev->node.major = dev->node.minor = 0;
398     link->dev_node = &dev->node;
399
400     /* Finally, report what we've done */
401     printk(KERN_INFO "%s: index 0x%02x:",
402            dev->node.dev_name, link->conf.ConfigIndex);
403     if (link->conf.Vpp)
404         printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
405     if (link->conf.Attributes & CONF_ENABLE_IRQ)
406         printk(", irq %d", link->irq.AssignedIRQ);
407     if (link->io.NumPorts1)
408         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
409                link->io.BasePort1+link->io.NumPorts1-1);
410     if (link->io.NumPorts2)
411         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
412                link->io.BasePort2+link->io.NumPorts2-1);
413     if (link->win)
414         printk(", mem 0x%06lx-0x%06lx", req.Base,
415                req.Base+req.Size-1);
416     printk("\n");
417     
418     link->state &= ~DEV_CONFIG_PENDING;
419
420     icard.para[0] = link->irq.AssignedIRQ;
421     icard.para[1] = link->io.BasePort1;
422     icard.protocol = protocol;
423     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
424     
425     last_ret = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->stop), &icard);
426     if (last_ret < 0) {
427         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
428                 last_ret, link->io.BasePort1);
429         sedlbauer_release(link);
430     } else
431         ((local_info_t*)link->priv)->cardnr = last_ret;
432
433     return;
434
435 cs_failed:
436     cs_error(link->handle, last_fn, last_ret);
437     sedlbauer_release(link);
438
439 } /* sedlbauer_config */
440
441 /*======================================================================
442
443     After a card is removed, sedlbauer_release() will unregister the
444     device, and release the PCMCIA configuration.  If the device is
445     still open, this will be postponed until it is closed.
446     
447 ======================================================================*/
448
449 static void sedlbauer_release(dev_link_t *link)
450 {
451     local_info_t *local = link->priv;
452     DEBUG(0, "sedlbauer_release(0x%p)\n", link);
453
454     if (local) {
455         if (local->cardnr >= 0) {
456             /* no unregister function with hisax */
457             HiSax_closecard(local->cardnr);
458         }
459     }
460
461     pcmcia_disable_device(link->handle);
462 } /* sedlbauer_release */
463
464 static int sedlbauer_suspend(struct pcmcia_device *p_dev)
465 {
466         dev_link_t *link = dev_to_instance(p_dev);
467         local_info_t *dev = link->priv;
468
469         dev->stop = 1;
470
471         return 0;
472 }
473
474 static int sedlbauer_resume(struct pcmcia_device *p_dev)
475 {
476         dev_link_t *link = dev_to_instance(p_dev);
477         local_info_t *dev = link->priv;
478
479         dev->stop = 0;
480
481         return 0;
482 }
483
484
485 static struct pcmcia_device_id sedlbauer_ids[] = {
486         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
487         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
488         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
489         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
490         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
491         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
492 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
493         PCMCIA_DEVICE_NULL
494 };
495 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
496
497 static struct pcmcia_driver sedlbauer_driver = {
498         .owner          = THIS_MODULE,
499         .drv            = {
500                 .name   = "sedlbauer_cs",
501         },
502         .probe          = sedlbauer_attach,
503         .remove         = sedlbauer_detach,
504         .id_table       = sedlbauer_ids,
505         .suspend        = sedlbauer_suspend,
506         .resume         = sedlbauer_resume,
507 };
508
509 static int __init init_sedlbauer_cs(void)
510 {
511         return pcmcia_register_driver(&sedlbauer_driver);
512 }
513
514 static void __exit exit_sedlbauer_cs(void)
515 {
516         pcmcia_unregister_driver(&sedlbauer_driver);
517 }
518
519 module_init(init_sedlbauer_cs);
520 module_exit(exit_sedlbauer_cs);