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