pcmcia: remove cs_types.h
[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->io.NumPorts1 = 8;
133     link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
134     link->io.IOAddrLines = 3;
135
136     link->conf.Attributes = 0;
137     link->conf.IntType = INT_MEMORY_AND_IO;
138
139     return sedlbauer_config(link);
140 } /* sedlbauer_attach */
141
142 /*======================================================================
143
144     This deletes a driver "instance".  The device is de-registered
145     with Card Services.  If it has been released, all local data
146     structures are freed.  Otherwise, the structures will be freed
147     when the device is released.
148
149 ======================================================================*/
150
151 static void __devexit sedlbauer_detach(struct pcmcia_device *link)
152 {
153         dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
154
155         ((local_info_t *)link->priv)->stop = 1;
156         sedlbauer_release(link);
157
158         /* This points to the parent local_info_t struct */
159         kfree(link->priv);
160 } /* sedlbauer_detach */
161
162 /*======================================================================
163
164     sedlbauer_config() is scheduled to run after a CARD_INSERTION event
165     is received, to configure the PCMCIA socket, and to make the
166     device available to the system.
167     
168 ======================================================================*/
169 static int sedlbauer_config_check(struct pcmcia_device *p_dev,
170                                   cistpl_cftable_entry_t *cfg,
171                                   cistpl_cftable_entry_t *dflt,
172                                   unsigned int vcc,
173                                   void *priv_data)
174 {
175         win_req_t *req = priv_data;
176
177         if (cfg->index == 0)
178                 return -ENODEV;
179
180         /* Does this card need audio output? */
181         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
182                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
183                 p_dev->conf.Status = CCSR_AUDIO_ENA;
184         }
185
186         /* Use power settings for Vcc and Vpp if present */
187         /*  Note that the CIS values need to be rescaled */
188         if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
189                 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
190                         return -ENODEV;
191         } else if (dflt->vcc.present & (1<<CISTPL_POWER_VNOM)) {
192                 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM]/10000)
193                         return -ENODEV;
194         }
195
196         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
197                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
198         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
199                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
200
201         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
202
203         /* IO window settings */
204         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
205         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
206                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
207                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
208                 if (!(io->flags & CISTPL_IO_8BIT))
209                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
210                 if (!(io->flags & CISTPL_IO_16BIT))
211                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
212                 p_dev->io.BasePort1 = io->win[0].base;
213                 p_dev->io.NumPorts1 = io->win[0].len;
214                 if (io->nwin > 1) {
215                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
216                         p_dev->io.BasePort2 = io->win[1].base;
217                         p_dev->io.NumPorts2 = io->win[1].len;
218                 }
219                 /* This reserves IO space but doesn't actually enable it */
220                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
221                         return -ENODEV;
222         }
223
224         /*
225           Now set up a common memory window, if needed.  There is room
226           in the struct pcmcia_device structure for one memory window handle,
227           but if the base addresses need to be saved, or if multiple
228           windows are needed, the info should go in the private data
229           structure for this device.
230
231           Note that the memory window base is a physical address, and
232           needs to be mapped to virtual space with ioremap() before it
233           is used.
234         */
235         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
236                 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
237                 memreq_t map;
238                 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
239                 req->Attributes |= WIN_ENABLE;
240                 req->Base = mem->win[0].host_addr;
241                 req->Size = mem->win[0].len;
242                 req->AccessSpeed = 0;
243                 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
244                         return -ENODEV;
245                 map.Page = 0;
246                 map.CardOffset = mem->win[0].card_addr;
247                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
248                         return -ENODEV;
249         }
250         return 0;
251 }
252
253
254
255 static int __devinit sedlbauer_config(struct pcmcia_device *link)
256 {
257     win_req_t *req;
258     int ret;
259     IsdnCard_t  icard;
260
261     dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
262
263     req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
264     if (!req)
265             return -ENOMEM;
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     ret = pcmcia_loop_config(link, sedlbauer_config_check, req);
280     if (ret)
281             goto failed;
282
283     /*
284        This actually configures the PCMCIA socket -- setting up
285        the I/O windows and the interrupt mapping, and putting the
286        card and host interface into "Memory and IO" mode.
287     */
288     ret = pcmcia_request_configuration(link, &link->conf);
289     if (ret)
290             goto failed;
291
292     /* Finally, report what we've done */
293     dev_info(&link->dev, "index 0x%02x:",
294            link->conf.ConfigIndex);
295     if (link->conf.Vpp)
296         printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
297     if (link->conf.Attributes & CONF_ENABLE_IRQ)
298         printk(", irq %d", link->irq);
299     if (link->io.NumPorts1)
300         printk(", io 0x%04x-0x%04x", link->io.BasePort1,
301                link->io.BasePort1+link->io.NumPorts1-1);
302     if (link->io.NumPorts2)
303         printk(" & 0x%04x-0x%04x", link->io.BasePort2,
304                link->io.BasePort2+link->io.NumPorts2-1);
305     if (link->win)
306         printk(", mem 0x%06lx-0x%06lx", req->Base,
307                req->Base+req->Size-1);
308     printk("\n");
309
310     icard.para[0] = link->irq;
311     icard.para[1] = link->io.BasePort1;
312     icard.protocol = protocol;
313     icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
314     
315     ret = hisax_init_pcmcia(link, 
316                             &(((local_info_t *)link->priv)->stop), &icard);
317     if (ret < 0) {
318         printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
319                 ret, link->io.BasePort1);
320         sedlbauer_release(link);
321         return -ENODEV;
322     } else
323         ((local_info_t *)link->priv)->cardnr = ret;
324
325     return 0;
326
327 failed:
328     sedlbauer_release(link);
329     return -ENODEV;
330
331 } /* sedlbauer_config */
332
333 /*======================================================================
334
335     After a card is removed, sedlbauer_release() will unregister the
336     device, and release the PCMCIA configuration.  If the device is
337     still open, this will be postponed until it is closed.
338     
339 ======================================================================*/
340
341 static void sedlbauer_release(struct pcmcia_device *link)
342 {
343     local_info_t *local = link->priv;
344     dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
345
346     if (local) {
347         if (local->cardnr >= 0) {
348             /* no unregister function with hisax */
349             HiSax_closecard(local->cardnr);
350         }
351     }
352
353     pcmcia_disable_device(link);
354 } /* sedlbauer_release */
355
356 static int sedlbauer_suspend(struct pcmcia_device *link)
357 {
358         local_info_t *dev = link->priv;
359
360         dev->stop = 1;
361
362         return 0;
363 }
364
365 static int sedlbauer_resume(struct pcmcia_device *link)
366 {
367         local_info_t *dev = link->priv;
368
369         dev->stop = 0;
370
371         return 0;
372 }
373
374
375 static struct pcmcia_device_id sedlbauer_ids[] = {
376         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
377         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
378         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
379         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
380         PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
381         PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
382 /*      PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
383         PCMCIA_DEVICE_NULL
384 };
385 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
386
387 static struct pcmcia_driver sedlbauer_driver = {
388         .owner          = THIS_MODULE,
389         .drv            = {
390                 .name   = "sedlbauer_cs",
391         },
392         .probe          = sedlbauer_probe,
393         .remove         = __devexit_p(sedlbauer_detach),
394         .id_table       = sedlbauer_ids,
395         .suspend        = sedlbauer_suspend,
396         .resume         = sedlbauer_resume,
397 };
398
399 static int __init init_sedlbauer_cs(void)
400 {
401         return pcmcia_register_driver(&sedlbauer_driver);
402 }
403
404 static void __exit exit_sedlbauer_cs(void)
405 {
406         pcmcia_unregister_driver(&sedlbauer_driver);
407 }
408
409 module_init(init_sedlbauer_cs);
410 module_exit(exit_sedlbauer_cs);