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