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