blob: c9a30b1c92372373a652f877dad6d62d65dbf19f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*======================================================================
2
3 An elsa_cs PCMCIA client driver
4
5 This driver is for the Elsa PCM ISDN Cards, i.e. the MicroLink
6
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 Klaus
23 Lichtenwalder <Lichtenwalder@ACM.org>. 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/module.h>
39#include <linux/kernel.h>
40#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#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
56MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
57MODULE_AUTHOR("Klaus Lichtenwalder");
58MODULE_LICENSE("Dual MPL/GPL");
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61/*====================================================================*/
62
63/* Parameters that can be set with 'insmod' */
64
65static int protocol = 2; /* EURO-ISDN Default */
66module_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 insertion
75 and ejection events. They are invoked from the elsa_cs event
76 handler.
77*/
78
Dominik Brodowski15b99ac2006-03-31 17:26:06 +020079static int elsa_cs_config(struct pcmcia_device *link);
Dominik Brodowskifba395e2006-03-31 17:21:06 +020080static void elsa_cs_release(struct pcmcia_device *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
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
Dominik Brodowskicc3b4862005-11-14 21:23:14 +010088static void elsa_cs_detach(struct pcmcia_device *p_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 A driver needs to provide a dev_node_t structure for each device
92 on a card. In some cases, there is only one device per card (for
93 example, ethernet cards, modems). In other cases, there may be
94 many actual or logical devices (SCSI adapters, memory cards with
95 multiple partitions). The dev_node_t structures need to be kept
Dominik Brodowskifba395e2006-03-31 17:21:06 +020096 in a linked list starting at the 'dev' field of a struct pcmcia_device
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 structure. We allocate them in the card's private data structure,
98 because they generally shouldn't be allocated dynamically.
99 In this case, we also provide a flag to indicate if a device is
100 "stopped" due to a power management event, or card ejection. The
101 device IO routines can use a flag like this to throttle IO to a
102 card that is not ready to accept it.
103*/
104
105typedef struct local_info_t {
Dominik Brodowskifd238232006-03-05 10:45:09 +0100106 struct pcmcia_device *p_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 dev_node_t node;
108 int busy;
109 int cardnr;
110} local_info_t;
111
112/*======================================================================
113
114 elsa_cs_attach() creates an "instance" of the driver, allocatingx
115 local data structures for one device. The device is registered
116 with Card Services.
117
118 The dev_link structure is initialized, but we don't actually
119 configure the card at this point -- we wait until we receive a
120 card insertion event.
121
122======================================================================*/
123
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200124static int elsa_cs_probe(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 local_info_t *local;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200128 dev_dbg(&link->dev, "elsa_cs_attach()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130 /* Allocate space for private device-specific data */
Burman Yan41f96932006-12-08 02:39:35 -0800131 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100132 if (!local) return -ENOMEM;
Dominik Brodowskifd238232006-03-05 10:45:09 +0100133
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200134 local->p_dev = link;
Dominik Brodowskifd238232006-03-05 10:45:09 +0100135 link->priv = local;
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 local->cardnr = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139 /* Interrupt setup */
Dominik Brodowskie15c1c12009-11-28 18:12:06 +0100140 link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 link->irq.Handler = NULL;
142
143 /*
144 General socket configuration defaults can go here. In this
145 client, we assume very little, and rely on the CIS for almost
146 everything. In most clients, many details (i.e., number, sizes,
147 and attributes of IO windows) are fixed by the nature of the
148 device, and can be hard-wired here.
149 */
150 link->io.NumPorts1 = 8;
151 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
152 link->io.IOAddrLines = 3;
153
154 link->conf.Attributes = CONF_ENABLE_IRQ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 link->conf.IntType = INT_MEMORY_AND_IO;
156
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200157 return elsa_cs_config(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158} /* elsa_cs_attach */
159
160/*======================================================================
161
162 This deletes a driver "instance". The device is de-registered
163 with Card Services. If it has been released, all local data
164 structures are freed. Otherwise, the structures will be freed
165 when the device is released.
166
167======================================================================*/
168
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200169static void elsa_cs_detach(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100171 local_info_t *info = link->priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200173 dev_dbg(&link->dev, "elsa_cs_detach(0x%p)\n", link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100175 info->busy = 1;
176 elsa_cs_release(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100178 kfree(info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179} /* elsa_cs_detach */
180
181/*======================================================================
182
183 elsa_cs_config() is scheduled to run after a CARD_INSERTION event
184 is received, to configure the PCMCIA socket, and to make the
185 device available to the system.
186
187======================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200189static int elsa_cs_configcheck(struct pcmcia_device *p_dev,
190 cistpl_cftable_entry_t *cf,
Dominik Brodowski8e2fc392008-08-02 15:30:31 +0200191 cistpl_cftable_entry_t *dflt,
Dominik Brodowskiad913c12008-08-02 16:12:00 +0200192 unsigned int vcc,
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200193 void *priv_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200195 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200197 if ((cf->io.nwin > 0) && cf->io.win[0].base) {
198 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200199 p_dev->io.BasePort1 = cf->io.win[0].base;
200 if (!pcmcia_request_io(p_dev, &p_dev->io))
201 return 0;
202 } else {
203 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200204 for (j = 0x2f0; j > 0x100; j -= 0x10) {
205 p_dev->io.BasePort1 = j;
206 if (!pcmcia_request_io(p_dev, &p_dev->io))
207 return 0;
208 }
209 }
210 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211}
212
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200213static int elsa_cs_config(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 local_info_t *dev;
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200216 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 IsdnCard_t icard;
218
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200219 dev_dbg(&link->dev, "elsa_config(0x%p)\n", link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 dev = link->priv;
221
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200222 i = pcmcia_loop_config(link, elsa_cs_configcheck, NULL);
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200223 if (i != 0)
224 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200226 i = pcmcia_request_irq(link, &link->irq);
Dominik Brodowski4c89e882008-08-03 10:07:45 +0200227 if (i != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 link->irq.AssignedIRQ = 0;
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200229 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 }
231
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200232 i = pcmcia_request_configuration(link, &link->conf);
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200233 if (i != 0)
234 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236 /* At this point, the dev_node_t structure(s) should be
237 initialized and arranged in a linked list at link->dev. *//* */
238 sprintf(dev->node.dev_name, "elsa");
239 dev->node.major = dev->node.minor = 0x0;
240
Dominik Brodowskifd238232006-03-05 10:45:09 +0100241 link->dev_node = &dev->node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 /* Finally, report what we've done */
Dominik Brodowski70294b42006-01-15 12:43:16 +0100244 printk(KERN_INFO "%s: index 0x%02x: ",
245 dev->node.dev_name, link->conf.ConfigIndex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 if (link->conf.Attributes & CONF_ENABLE_IRQ)
247 printk(", irq %d", link->irq.AssignedIRQ);
248 if (link->io.NumPorts1)
249 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
250 link->io.BasePort1+link->io.NumPorts1-1);
251 if (link->io.NumPorts2)
252 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
253 link->io.BasePort2+link->io.NumPorts2-1);
254 printk("\n");
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 icard.para[0] = link->irq.AssignedIRQ;
257 icard.para[1] = link->io.BasePort1;
258 icard.protocol = protocol;
259 icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
260
261 i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
262 if (i < 0) {
263 printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
264 i, link->io.BasePort1);
265 elsa_cs_release(link);
266 } else
267 ((local_info_t*)link->priv)->cardnr = i;
268
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200269 return 0;
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200270failed:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 elsa_cs_release(link);
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200272 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273} /* elsa_cs_config */
274
275/*======================================================================
276
277 After a card is removed, elsa_cs_release() will unregister the net
278 device, and release the PCMCIA configuration. If the device is
279 still open, this will be postponed until it is closed.
280
281======================================================================*/
282
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200283static void elsa_cs_release(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 local_info_t *local = link->priv;
286
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200287 dev_dbg(&link->dev, "elsa_cs_release(0x%p)\n", link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 if (local) {
290 if (local->cardnr >= 0) {
291 /* no unregister function with hisax */
292 HiSax_closecard(local->cardnr);
293 }
294 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200296 pcmcia_disable_device(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297} /* elsa_cs_release */
298
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200299static int elsa_suspend(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100300{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100301 local_info_t *dev = link->priv;
302
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100303 dev->busy = 1;
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100304
305 return 0;
306}
307
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200308static int elsa_resume(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100309{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100310 local_info_t *dev = link->priv;
311
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100312 dev->busy = 0;
313
314 return 0;
315}
316
Dominik Brodowski02ae38c2005-06-27 16:28:39 -0700317static struct pcmcia_device_id elsa_ids[] = {
318 PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
319 PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
320 PCMCIA_DEVICE_NULL
321};
322MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324static struct pcmcia_driver elsa_cs_driver = {
325 .owner = THIS_MODULE,
326 .drv = {
327 .name = "elsa_cs",
328 },
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200329 .probe = elsa_cs_probe,
Dominik Brodowskicc3b4862005-11-14 21:23:14 +0100330 .remove = elsa_cs_detach,
Dominik Brodowski02ae38c2005-06-27 16:28:39 -0700331 .id_table = elsa_ids,
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100332 .suspend = elsa_suspend,
333 .resume = elsa_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334};
335
336static int __init init_elsa_cs(void)
337{
338 return pcmcia_register_driver(&elsa_cs_driver);
339}
340
341static void __exit exit_elsa_cs(void)
342{
343 pcmcia_unregister_driver(&elsa_cs_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344}
345
346module_init(init_elsa_cs);
347module_exit(exit_elsa_cs);