Merge branch 'upstream'
[linux-2.6] / 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     dev_link_t          link;
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;
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     link = &local->link; link->priv = local;
164     
165     /* Interrupt setup */
166     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
167     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
168     link->irq.Handler = NULL;
169
170     /*
171       General socket configuration defaults can go here.  In this
172       client, we assume very little, and rely on the CIS for almost
173       everything.  In most clients, many details (i.e., number, sizes,
174       and attributes of IO windows) are fixed by the nature of the
175       device, and can be hard-wired here.
176     */
177
178     /* from old sedl_cs 
179     */
180     /* The io structure describes IO port mapping */
181     link->io.NumPorts1 = 8;
182     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
183     link->io.IOAddrLines = 3;
184
185
186     link->conf.Attributes = 0;
187     link->conf.Vcc = 50;
188     link->conf.IntType = INT_MEMORY_AND_IO;
189
190     link->handle = p_dev;
191     p_dev->instance = link;
192
193     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
194     sedlbauer_config(link);
195
196     return 0;
197 } /* sedlbauer_attach */
198
199 /*======================================================================
200
201     This deletes a driver "instance".  The device is de-registered
202     with Card Services.  If it has been released, all local data
203     structures are freed.  Otherwise, the structures will be freed
204     when the device is released.
205
206 ======================================================================*/
207
208 static void sedlbauer_detach(struct pcmcia_device *p_dev)
209 {
210     dev_link_t *link = dev_to_instance(p_dev);
211
212     DEBUG(0, "sedlbauer_detach(0x%p)\n", link);
213
214     if (link->state & DEV_CONFIG) {
215             ((local_info_t *)link->priv)->stop = 1;
216             sedlbauer_release(link);
217     }
218
219     /* This points to the parent local_info_t struct */
220     kfree(link->priv);
221 } /* sedlbauer_detach */
222
223 /*======================================================================
224
225     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
226     is received, to configure the PCMCIA socket, and to make the
227     device available to the system.
228     
229 ======================================================================*/
230 #define CS_CHECK(fn, ret) \
231 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
232
233 static void sedlbauer_config(dev_link_t *link)
234 {
235     client_handle_t handle = link->handle;
236     local_info_t *dev = link->priv;
237     tuple_t tuple;
238     cisparse_t parse;
239     int last_fn, last_ret;
240     u8 buf[64];
241     config_info_t conf;
242     win_req_t req;
243     memreq_t map;
244     IsdnCard_t  icard;
245
246     DEBUG(0, "sedlbauer_config(0x%p)\n", link);
247
248     /*
249        This reads the card's CONFIG tuple to find its configuration
250        registers.
251     */
252     tuple.DesiredTuple = CISTPL_CONFIG;
253     tuple.Attributes = 0;
254     tuple.TupleData = buf;
255     tuple.TupleDataMax = sizeof(buf);
256     tuple.TupleOffset = 0;
257     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
258     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
259     CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
260     link->conf.ConfigBase = parse.config.base;
261     link->conf.Present = parse.config.rmask[0];
262     
263     /* Configure card */
264     link->state |= DEV_CONFIG;
265
266     /* Look up the current Vcc */
267     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &conf));
268     link->conf.Vcc = conf.Vcc;
269
270     /*
271       In this loop, we scan the CIS for configuration table entries,
272       each of which describes a valid card configuration, including
273       voltage, IO window, memory window, and interrupt settings.
274
275       We make no assumptions about the card to be configured: we use
276       just the information available in the CIS.  In an ideal world,
277       this would work for any PCMCIA card, but it requires a complete
278       and accurate CIS.  In practice, a driver usually "knows" most of
279       these things without consulting the CIS, and most client drivers
280       will only use the CIS to fill in implementation-defined details.
281     */
282     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
283     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
284     while (1) {
285         cistpl_cftable_entry_t dflt = { 0 };
286         cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
287         if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
288                 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
289             goto next_entry;
290
291         if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
292         if (cfg->index == 0) goto next_entry;
293         link->conf.ConfigIndex = cfg->index;
294         
295         /* Does this card need audio output? */
296         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
297             link->conf.Attributes |= CONF_ENABLE_SPKR;
298             link->conf.Status = CCSR_AUDIO_ENA;
299         }
300         
301         /* Use power settings for Vcc and Vpp if present */
302         /*  Note that the CIS values need to be rescaled */
303         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
304             if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
305                 goto next_entry;
306         } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
307             if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM]/10000)
308                 goto next_entry;
309         }
310             
311         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
312             link->conf.Vpp1 = link->conf.Vpp2 =
313                 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
314         else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
315             link->conf.Vpp1 = link->conf.Vpp2 =
316                 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
317         
318         /* Do we need to allocate an interrupt? */
319         if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
320             link->conf.Attributes |= CONF_ENABLE_IRQ;
321         
322         /* IO window settings */
323         link->io.NumPorts1 = link->io.NumPorts2 = 0;
324         if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
325             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
326             link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
327             if (!(io->flags & CISTPL_IO_8BIT))
328                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
329             if (!(io->flags & CISTPL_IO_16BIT))
330                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
331 /* new in dummy.cs 2001/01/28 MN 
332             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
333 */
334             link->io.BasePort1 = io->win[0].base;
335             link->io.NumPorts1 = io->win[0].len;
336             if (io->nwin > 1) {
337                 link->io.Attributes2 = link->io.Attributes1;
338                 link->io.BasePort2 = io->win[1].base;
339                 link->io.NumPorts2 = io->win[1].len;
340             }
341             /* This reserves IO space but doesn't actually enable it */
342             if (pcmcia_request_io(link->handle, &link->io) != 0)
343                 goto next_entry;
344         }
345
346         /*
347           Now set up a common memory window, if needed.  There is room
348           in the dev_link_t structure for one memory window handle,
349           but if the base addresses need to be saved, or if multiple
350           windows are needed, the info should go in the private data
351           structure for this device.
352
353           Note that the memory window base is a physical address, and
354           needs to be mapped to virtual space with ioremap() before it
355           is used.
356         */
357         if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
358             cistpl_mem_t *mem =
359                 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
360             req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
361             req.Attributes |= WIN_ENABLE;
362             req.Base = mem->win[0].host_addr;
363             req.Size = mem->win[0].len;
364 /* new in dummy.cs 2001/01/28 MN 
365             if (req.Size < 0x1000)
366                 req.Size = 0x1000;
367 */
368             req.AccessSpeed = 0;
369             if (pcmcia_request_window(&link->handle, &req, &link->win) != 0)
370                 goto next_entry;
371             map.Page = 0; map.CardOffset = mem->win[0].card_addr;
372             if (pcmcia_map_mem_page(link->win, &map) != 0)
373                 goto next_entry;
374         }
375         /* If we got this far, we're cool! */
376         break;
377         
378     next_entry:
379 /* new in dummy.cs 2001/01/28 MN 
380         if (link->io.NumPorts1)
381            pcmcia_release_io(link->handle, &link->io);
382 */
383         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
384     }
385     
386     /*
387        Allocate an interrupt line.  Note that this does not assign a
388        handler to the interrupt, unless the 'Handler' member of the
389        irq structure is initialized.
390     */
391     if (link->conf.Attributes & CONF_ENABLE_IRQ)
392         CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
393         
394     /*
395        This actually configures the PCMCIA socket -- setting up
396        the I/O windows and the interrupt mapping, and putting the
397        card and host interface into "Memory and IO" mode.
398     */
399     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
400
401     /*
402       At this point, the dev_node_t structure(s) need to be
403       initialized and arranged in a linked list at link->dev.
404     */
405     sprintf(dev->node.dev_name, "sedlbauer");
406     dev->node.major = dev->node.minor = 0;
407     link->dev = &dev->node;
408
409     /* Finally, report what we've done */
410     printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
411            dev->node.dev_name, link->conf.ConfigIndex,
412            link->conf.Vcc/10, link->conf.Vcc%10);
413     if (link->conf.Vpp1)
414         printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
415     if (link->conf.Attributes & CONF_ENABLE_IRQ)
416         printk(", irq %d", link->irq.AssignedIRQ);
417     if (link->io.NumPorts1)
418         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
419                link->io.BasePort1+link->io.NumPorts1-1);
420     if (link->io.NumPorts2)
421         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
422                link->io.BasePort2+link->io.NumPorts2-1);
423     if (link->win)
424         printk(", mem 0x%06lx-0x%06lx", req.Base,
425                req.Base+req.Size-1);
426     printk("\n");
427     
428     link->state &= ~DEV_CONFIG_PENDING;
429
430     icard.para[0] = link->irq.AssignedIRQ;
431     icard.para[1] = link->io.BasePort1;
432     icard.protocol = protocol;
433     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
434     
435     last_ret = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->stop), &icard);
436     if (last_ret < 0) {
437         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
438                 last_ret, link->io.BasePort1);
439         sedlbauer_release(link);
440     } else
441         ((local_info_t*)link->priv)->cardnr = last_ret;
442
443     return;
444
445 cs_failed:
446     cs_error(link->handle, last_fn, last_ret);
447     sedlbauer_release(link);
448
449 } /* sedlbauer_config */
450
451 /*======================================================================
452
453     After a card is removed, sedlbauer_release() will unregister the
454     device, and release the PCMCIA configuration.  If the device is
455     still open, this will be postponed until it is closed.
456     
457 ======================================================================*/
458
459 static void sedlbauer_release(dev_link_t *link)
460 {
461     local_info_t *local = link->priv;
462     DEBUG(0, "sedlbauer_release(0x%p)\n", link);
463
464     if (local) {
465         if (local->cardnr >= 0) {
466             /* no unregister function with hisax */
467             HiSax_closecard(local->cardnr);
468         }
469     }
470     /* Unlink the device chain */
471     link->dev = NULL;
472
473     /*
474       In a normal driver, additional code may be needed to release
475       other kernel data structures associated with this device. 
476     */
477     
478     /* Don't bother checking to see if these succeed or not */
479     if (link->win)
480         pcmcia_release_window(link->win);
481     pcmcia_release_configuration(link->handle);
482     if (link->io.NumPorts1)
483         pcmcia_release_io(link->handle, &link->io);
484     if (link->irq.AssignedIRQ)
485         pcmcia_release_irq(link->handle, &link->irq);
486     link->state &= ~DEV_CONFIG;
487 } /* sedlbauer_release */
488
489 static int sedlbauer_suspend(struct pcmcia_device *p_dev)
490 {
491         dev_link_t *link = dev_to_instance(p_dev);
492         local_info_t *dev = link->priv;
493
494         link->state |= DEV_SUSPEND;
495         dev->stop = 1;
496         if (link->state & DEV_CONFIG)
497                 pcmcia_release_configuration(link->handle);
498
499         return 0;
500 }
501
502 static int sedlbauer_resume(struct pcmcia_device *p_dev)
503 {
504         dev_link_t *link = dev_to_instance(p_dev);
505         local_info_t *dev = link->priv;
506
507         link->state &= ~DEV_SUSPEND;
508         if (link->state & DEV_CONFIG)
509                 pcmcia_request_configuration(link->handle, &link->conf);
510         dev->stop = 0;
511
512         return 0;
513 }
514
515
516 static struct pcmcia_device_id sedlbauer_ids[] = {
517         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
518         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
519         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
520         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
521         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
522         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
523 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
524         PCMCIA_DEVICE_NULL
525 };
526 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
527
528 static struct pcmcia_driver sedlbauer_driver = {
529         .owner          = THIS_MODULE,
530         .drv            = {
531                 .name   = "sedlbauer_cs",
532         },
533         .probe          = sedlbauer_attach,
534         .remove         = sedlbauer_detach,
535         .id_table       = sedlbauer_ids,
536         .suspend        = sedlbauer_suspend,
537         .resume         = sedlbauer_resume,
538 };
539
540 static int __init init_sedlbauer_cs(void)
541 {
542         return pcmcia_register_driver(&sedlbauer_driver);
543 }
544
545 static void __exit exit_sedlbauer_cs(void)
546 {
547         pcmcia_unregister_driver(&sedlbauer_driver);
548 }
549
550 module_init(init_sedlbauer_cs);
551 module_exit(exit_sedlbauer_cs);