pcmcia: do not use io_req_t when calling pcmcia_request_io()
[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.h>
50 #include <pcmcia/cistpl.h>
51 #include <pcmcia/cisreg.h>
52 #include <pcmcia/ds.h>
53 #include "hisax_cfg.h"
54
55 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
56 MODULE_AUTHOR("Marcus Niemann");
57 MODULE_LICENSE("Dual MPL/GPL");
58
59
60 /*====================================================================*/
61
62 /* Parameters that can be set with 'insmod' */
63
64 static int protocol = 2;        /* EURO-ISDN Default */
65 module_param(protocol, int, 0);
66
67 /*====================================================================*/
68
69 /*
70    The event() function is this driver's Card Services event handler.
71    It will be called by Card Services when an appropriate card status
72    event is received.  The config() and release() entry points are
73    used to configure or release a socket, in response to card
74    insertion and ejection events.  They are invoked from the sedlbauer
75    event handler. 
76 */
77
78 static int sedlbauer_config(struct pcmcia_device *link) __devinit ;
79 static void sedlbauer_release(struct pcmcia_device *link);
80
81 /*
82    The attach() and detach() entry points are used to create and destroy
83    "instances" of the driver, where each instance represents everything
84    needed to manage one actual PCMCIA card.
85 */
86
87 static void sedlbauer_detach(struct pcmcia_device *p_dev) __devexit;
88
89 typedef struct local_info_t {
90         struct pcmcia_device    *p_dev;
91     int                 stop;
92     int                 cardnr;
93 } local_info_t;
94
95 /*======================================================================
96
97     sedlbauer_attach() creates an "instance" of the driver, allocating
98     local data structures for one device.  The device is registered
99     with Card Services.
100
101     The dev_link structure is initialized, but we don't actually
102     configure the card at this point -- we wait until we receive a
103     card insertion event.
104     
105 ======================================================================*/
106
107 static int __devinit sedlbauer_probe(struct pcmcia_device *link)
108 {
109     local_info_t *local;
110
111     dev_dbg(&link->dev, "sedlbauer_attach()\n");
112
113     /* Allocate space for private device-specific data */
114     local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
115     if (!local) return -ENOMEM;
116     local->cardnr = -1;
117
118     local->p_dev = link;
119     link->priv = local;
120
121     /*
122       General socket configuration defaults can go here.  In this
123       client, we assume very little, and rely on the CIS for almost
124       everything.  In most clients, many details (i.e., number, sizes,
125       and attributes of IO windows) are fixed by the nature of the
126       device, and can be hard-wired here.
127     */
128
129     /* from old sedl_cs 
130     */
131     /* The io structure describes IO port mapping */
132     link->resource[0]->end = 8;
133     link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
134
135     link->conf.Attributes = 0;
136     link->conf.IntType = INT_MEMORY_AND_IO;
137
138     return sedlbauer_config(link);
139 } /* sedlbauer_attach */
140
141 /*======================================================================
142
143     This deletes a driver "instance".  The device is de-registered
144     with Card Services.  If it has been released, all local data
145     structures are freed.  Otherwise, the structures will be freed
146     when the device is released.
147
148 ======================================================================*/
149
150 static void __devexit sedlbauer_detach(struct pcmcia_device *link)
151 {
152         dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
153
154         ((local_info_t *)link->priv)->stop = 1;
155         sedlbauer_release(link);
156
157         /* This points to the parent local_info_t struct */
158         kfree(link->priv);
159 } /* sedlbauer_detach */
160
161 /*======================================================================
162
163     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
164     is received, to configure the PCMCIA socket, and to make the
165     device available to the system.
166     
167 ======================================================================*/
168 static int sedlbauer_config_check(struct pcmcia_device *p_dev,
169                                   cistpl_cftable_entry_t *cfg,
170                                   cistpl_cftable_entry_t *dflt,
171                                   unsigned int vcc,
172                                   void *priv_data)
173 {
174         win_req_t *req = priv_data;
175
176         if (cfg->index == 0)
177                 return -ENODEV;
178
179         /* Does this card need audio output? */
180         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
181                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
182                 p_dev->conf.Status = CCSR_AUDIO_ENA;
183         }
184
185         /* Use power settings for Vcc and Vpp if present */
186         /*  Note that the CIS values need to be rescaled */
187         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
188                 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
189                         return -ENODEV;
190         } else if (dflt->vcc.present & (1<<CISTPL_POWER_VNOM)) {
191                 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM]/10000)
192                         return -ENODEV;
193         }
194
195         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
196                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
197         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
198                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
199
200         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
201
202         /* IO window settings */
203         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
204         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
205                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
206                 p_dev->resource[0]->start = io->win[0].base;
207                 p_dev->resource[0]->end = io->win[0].len;
208                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
209                 p_dev->resource[0]->flags |=
210                                         pcmcia_io_cfg_data_width(io->flags);
211                 if (io->nwin > 1) {
212                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
213                         p_dev->resource[1]->start = io->win[1].base;
214                         p_dev->resource[1]->end = io->win[1].len;
215                 }
216                 /* This reserves IO space but doesn't actually enable it */
217                 p_dev->io_lines = 3;
218                 if (pcmcia_request_io(p_dev) != 0)
219                         return -ENODEV;
220         }
221
222         /*
223           Now set up a common memory window, if needed.  There is room
224           in the struct pcmcia_device structure for one memory window handle,
225           but if the base addresses need to be saved, or if multiple
226           windows are needed, the info should go in the private data
227           structure for this device.
228
229           Note that the memory window base is a physical address, and
230           needs to be mapped to virtual space with ioremap() before it
231           is used.
232         */
233         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
234                 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
235                 memreq_t map;
236                 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
237                 req->Attributes |= WIN_ENABLE;
238                 req->Base = mem->win[0].host_addr;
239                 req->Size = mem->win[0].len;
240                 req->AccessSpeed = 0;
241                 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
242                         return -ENODEV;
243                 map.Page = 0;
244                 map.CardOffset = mem->win[0].card_addr;
245                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
246                         return -ENODEV;
247         }
248         return 0;
249 }
250
251
252
253 static int __devinit sedlbauer_config(struct pcmcia_device *link)
254 {
255     win_req_t *req;
256     int ret;
257     IsdnCard_t  icard;
258
259     dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
260
261     req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
262     if (!req)
263             return -ENOMEM;
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     ret = pcmcia_loop_config(link, sedlbauer_config_check, req);
278     if (ret)
279             goto failed;
280
281     /*
282        This actually configures the PCMCIA socket -- setting up
283        the I/O windows and the interrupt mapping, and putting the
284        card and host interface into "Memory and IO" mode.
285     */
286     ret = pcmcia_request_configuration(link, &link->conf);
287     if (ret)
288             goto failed;
289
290     /* Finally, report what we've done */
291     dev_info(&link->dev, "index 0x%02x:",
292            link->conf.ConfigIndex);
293     if (link->conf.Vpp)
294         printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
295     if (link->conf.Attributes & CONF_ENABLE_IRQ)
296         printk(", irq %d", link->irq);
297     if (link->resource[0])
298         printk(" & %pR", link->resource[0]);
299     if (link->resource[1])
300         printk(" & %pR", link->resource[1]);
301     if (link->win)
302         printk(", mem 0x%06lx-0x%06lx", req->Base,
303                req->Base+req->Size-1);
304     printk("\n");
305
306     icard.para[0] = link->irq;
307     icard.para[1] = link->resource[0]->start;
308     icard.protocol = protocol;
309     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
310     
311     ret = hisax_init_pcmcia(link, 
312                             &(((local_info_t *)link->priv)->stop), &icard);
313     if (ret < 0) {
314         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d with %pR\n",
315                 ret, link->resource[0]);
316         sedlbauer_release(link);
317         return -ENODEV;
318     } else
319         ((local_info_t *)link->priv)->cardnr = ret;
320
321     return 0;
322
323 failed:
324     sedlbauer_release(link);
325     return -ENODEV;
326
327 } /* sedlbauer_config */
328
329 /*======================================================================
330
331     After a card is removed, sedlbauer_release() will unregister the
332     device, and release the PCMCIA configuration.  If the device is
333     still open, this will be postponed until it is closed.
334     
335 ======================================================================*/
336
337 static void sedlbauer_release(struct pcmcia_device *link)
338 {
339     local_info_t *local = link->priv;
340     dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
341
342     if (local) {
343         if (local->cardnr >= 0) {
344             /* no unregister function with hisax */
345             HiSax_closecard(local->cardnr);
346         }
347     }
348
349     pcmcia_disable_device(link);
350 } /* sedlbauer_release */
351
352 static int sedlbauer_suspend(struct pcmcia_device *link)
353 {
354         local_info_t *dev = link->priv;
355
356         dev->stop = 1;
357
358         return 0;
359 }
360
361 static int sedlbauer_resume(struct pcmcia_device *link)
362 {
363         local_info_t *dev = link->priv;
364
365         dev->stop = 0;
366
367         return 0;
368 }
369
370
371 static struct pcmcia_device_id sedlbauer_ids[] = {
372         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
373         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
374         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
375         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
376         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
377         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
378 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
379         PCMCIA_DEVICE_NULL
380 };
381 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
382
383 static struct pcmcia_driver sedlbauer_driver = {
384         .owner          = THIS_MODULE,
385         .drv            = {
386                 .name   = "sedlbauer_cs",
387         },
388         .probe          = sedlbauer_probe,
389         .remove         = __devexit_p(sedlbauer_detach),
390         .id_table       = sedlbauer_ids,
391         .suspend        = sedlbauer_suspend,
392         .resume         = sedlbauer_resume,
393 };
394
395 static int __init init_sedlbauer_cs(void)
396 {
397         return pcmcia_register_driver(&sedlbauer_driver);
398 }
399
400 static void __exit exit_sedlbauer_cs(void)
401 {
402         pcmcia_unregister_driver(&sedlbauer_driver);
403 }
404
405 module_init(init_sedlbauer_cs);
406 module_exit(exit_sedlbauer_cs);