blob: 54f0d68ad796d94af0f08ab0928ed8cf8bfdc352 [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>
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/version.h>
51#include <pcmcia/cs_types.h>
52#include <pcmcia/cs.h>
53#include <pcmcia/cistpl.h>
54#include <pcmcia/cisreg.h>
55#include <pcmcia/ds.h>
56#include "hisax_cfg.h"
57
58MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Elsa PCM cards");
59MODULE_AUTHOR("Klaus Lichtenwalder");
60MODULE_LICENSE("Dual MPL/GPL");
61
62/*
63 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
64 you do not define PCMCIA_DEBUG at all, all the debug code will be
65 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
66 be present but disabled -- but it can then be enabled for specific
67 modules at load time with a 'pc_debug=#' option to insmod.
68*/
69
70#ifdef PCMCIA_DEBUG
71static int pc_debug = PCMCIA_DEBUG;
72module_param(pc_debug, int, 0);
73#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
74static char *version =
75"elsa_cs.c $Revision: 1.2.2.4 $ $Date: 2004/01/25 15:07:06 $ (K.Lichtenwalder)";
76#else
77#define DEBUG(n, args...)
78#endif
79
80/*====================================================================*/
81
82/* Parameters that can be set with 'insmod' */
83
84static int protocol = 2; /* EURO-ISDN Default */
85module_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 insertion
94 and ejection events. They are invoked from the elsa_cs event
95 handler.
96*/
97
98static void elsa_cs_config(dev_link_t *link);
99static void elsa_cs_release(dev_link_t *link);
100static int elsa_cs_event(event_t event, int priority,
101 event_callback_args_t *args);
102
103/*
104 The attach() and detach() entry points are used to create and destroy
105 "instances" of the driver, where each instance represents everything
106 needed to manage one actual PCMCIA card.
107*/
108
109static dev_link_t *elsa_cs_attach(void);
110static void elsa_cs_detach(dev_link_t *);
111
112/*
113 The dev_info variable is the "key" that is used to match up this
114 device driver with appropriate cards, through the card configuration
115 database.
116*/
117
118static dev_info_t dev_info = "elsa_cs";
119
120/*
121 A linked list of "instances" of the elsa_cs device. Each actual
122 PCMCIA card corresponds to one device instance, and is described
123 by one dev_link_t structure (defined in ds.h).
124
125 You may not want to use a linked list for this -- for example, the
126 memory card driver uses an array of dev_link_t pointers, where minor
127 device numbers are used to derive the corresponding array index.
128*/
129
130static dev_link_t *dev_list = NULL;
131
132/*
133 A dev_link_t structure has fields for most things that are needed
134 to keep track of a socket, but there will usually be some device
135 specific information that also needs to be kept track of. The
136 'priv' pointer in a dev_link_t structure can be used to point to
137 a device-specific private data structure, like this.
138
139 To simplify the data structure handling, we actually include the
140 dev_link_t structure in the device's private data structure.
141
142 A driver needs to provide a dev_node_t structure for each device
143 on a card. In some cases, there is only one device per card (for
144 example, ethernet cards, modems). In other cases, there may be
145 many actual or logical devices (SCSI adapters, memory cards with
146 multiple partitions). The dev_node_t structures need to be kept
147 in a linked list starting at the 'dev' field of a dev_link_t
148 structure. We allocate them in the card's private data structure,
149 because they generally shouldn't be allocated dynamically.
150 In this case, we also provide a flag to indicate if a device is
151 "stopped" due to a power management event, or card ejection. The
152 device IO routines can use a flag like this to throttle IO to a
153 card that is not ready to accept it.
154*/
155
156typedef struct local_info_t {
157 dev_link_t link;
158 dev_node_t node;
159 int busy;
160 int cardnr;
161} local_info_t;
162
163/*======================================================================
164
165 elsa_cs_attach() creates an "instance" of the driver, allocatingx
166 local data structures for one device. The device is registered
167 with Card Services.
168
169 The dev_link structure is initialized, but we don't actually
170 configure the card at this point -- we wait until we receive a
171 card insertion event.
172
173======================================================================*/
174
175static dev_link_t *elsa_cs_attach(void)
176{
177 client_reg_t client_reg;
178 dev_link_t *link;
179 local_info_t *local;
180 int ret;
181
182 DEBUG(0, "elsa_cs_attach()\n");
183
184 /* Allocate space for private device-specific data */
185 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
186 if (!local) return NULL;
187 memset(local, 0, sizeof(local_info_t));
188 local->cardnr = -1;
189 link = &local->link; link->priv = local;
190
191 /* Interrupt setup */
192 link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_FIRST_SHARED;
193 link->irq.IRQInfo1 = IRQ_LEVEL_ID|IRQ_SHARE_ID;
194 link->irq.Handler = NULL;
195
196 /*
197 General socket configuration defaults can go here. In this
198 client, we assume very little, and rely on the CIS for almost
199 everything. In most clients, many details (i.e., number, sizes,
200 and attributes of IO windows) are fixed by the nature of the
201 device, and can be hard-wired here.
202 */
203 link->io.NumPorts1 = 8;
204 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
205 link->io.IOAddrLines = 3;
206
207 link->conf.Attributes = CONF_ENABLE_IRQ;
208 link->conf.Vcc = 50;
209 link->conf.IntType = INT_MEMORY_AND_IO;
210
211 /* Register with Card Services */
212 link->next = dev_list;
213 dev_list = link;
214 client_reg.dev_info = &dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 client_reg.Version = 0x0210;
216 client_reg.event_callback_args.client_data = link;
217 ret = pcmcia_register_client(&link->handle, &client_reg);
218 if (ret != CS_SUCCESS) {
219 cs_error(link->handle, RegisterClient, ret);
220 elsa_cs_detach(link);
221 return NULL;
222 }
223
224 return link;
225} /* elsa_cs_attach */
226
227/*======================================================================
228
229 This deletes a driver "instance". The device is de-registered
230 with Card Services. If it has been released, all local data
231 structures are freed. Otherwise, the structures will be freed
232 when the device is released.
233
234======================================================================*/
235
236static void elsa_cs_detach(dev_link_t *link)
237{
238 dev_link_t **linkp;
239 local_info_t *info = link->priv;
240 int ret;
241
242 DEBUG(0, "elsa_cs_detach(0x%p)\n", link);
243
244 /* Locate device structure */
245 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
246 if (*linkp == link) break;
247 if (*linkp == NULL)
248 return;
249
250 if (link->state & DEV_CONFIG)
251 elsa_cs_release(link);
252
253 /* Break the link with Card Services */
254 if (link->handle) {
255 ret = pcmcia_deregister_client(link->handle);
256 if (ret != CS_SUCCESS)
257 cs_error(link->handle, DeregisterClient, ret);
258 }
259
260 /* Unlink device structure and free it */
261 *linkp = link->next;
262 kfree(info);
263
264} /* elsa_cs_detach */
265
266/*======================================================================
267
268 elsa_cs_config() is scheduled to run after a CARD_INSERTION event
269 is received, to configure the PCMCIA socket, and to make the
270 device available to the system.
271
272======================================================================*/
273static int get_tuple(client_handle_t handle, tuple_t *tuple,
274 cisparse_t *parse)
275{
276 int i = pcmcia_get_tuple_data(handle, tuple);
277 if (i != CS_SUCCESS) return i;
278 return pcmcia_parse_tuple(handle, tuple, parse);
279}
280
281static int first_tuple(client_handle_t handle, tuple_t *tuple,
282 cisparse_t *parse)
283{
284 int i = pcmcia_get_first_tuple(handle, tuple);
285 if (i != CS_SUCCESS) return i;
286 return get_tuple(handle, tuple, parse);
287}
288
289static int next_tuple(client_handle_t handle, tuple_t *tuple,
290 cisparse_t *parse)
291{
292 int i = pcmcia_get_next_tuple(handle, tuple);
293 if (i != CS_SUCCESS) return i;
294 return get_tuple(handle, tuple, parse);
295}
296
297static void elsa_cs_config(dev_link_t *link)
298{
299 client_handle_t handle;
300 tuple_t tuple;
301 cisparse_t parse;
302 local_info_t *dev;
303 int i, j, last_fn;
304 u_short buf[128];
305 cistpl_cftable_entry_t *cf = &parse.cftable_entry;
306 IsdnCard_t icard;
307
308 DEBUG(0, "elsa_config(0x%p)\n", link);
309 handle = link->handle;
310 dev = link->priv;
311
312 /*
313 This reads the card's CONFIG tuple to find its configuration
314 registers.
315 */
316 tuple.DesiredTuple = CISTPL_CONFIG;
317 tuple.TupleData = (cisdata_t *)buf;
318 tuple.TupleDataMax = 255;
319 tuple.TupleOffset = 0;
320 tuple.Attributes = 0;
321 i = first_tuple(handle, &tuple, &parse);
322 if (i != CS_SUCCESS) {
323 last_fn = ParseTuple;
324 goto cs_failed;
325 }
326 link->conf.ConfigBase = parse.config.base;
327 link->conf.Present = parse.config.rmask[0];
328
329 /* Configure card */
330 link->state |= DEV_CONFIG;
331
332 tuple.TupleData = (cisdata_t *)buf;
333 tuple.TupleOffset = 0; tuple.TupleDataMax = 255;
334 tuple.Attributes = 0;
335 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
336 i = first_tuple(handle, &tuple, &parse);
337 while (i == CS_SUCCESS) {
338 if ( (cf->io.nwin > 0) && cf->io.win[0].base) {
339 printk(KERN_INFO "(elsa_cs: looks like the 96 model)\n");
340 link->conf.ConfigIndex = cf->index;
341 link->io.BasePort1 = cf->io.win[0].base;
342 i = pcmcia_request_io(link->handle, &link->io);
343 if (i == CS_SUCCESS) break;
344 } else {
345 printk(KERN_INFO "(elsa_cs: looks like the 97 model)\n");
346 link->conf.ConfigIndex = cf->index;
347 for (i = 0, j = 0x2f0; j > 0x100; j -= 0x10) {
348 link->io.BasePort1 = j;
349 i = pcmcia_request_io(link->handle, &link->io);
350 if (i == CS_SUCCESS) break;
351 }
352 break;
353 }
354 i = next_tuple(handle, &tuple, &parse);
355 }
356
357 if (i != CS_SUCCESS) {
358 last_fn = RequestIO;
359 goto cs_failed;
360 }
361
362 i = pcmcia_request_irq(link->handle, &link->irq);
363 if (i != CS_SUCCESS) {
364 link->irq.AssignedIRQ = 0;
365 last_fn = RequestIRQ;
366 goto cs_failed;
367 }
368
369 i = pcmcia_request_configuration(link->handle, &link->conf);
370 if (i != CS_SUCCESS) {
371 last_fn = RequestConfiguration;
372 goto cs_failed;
373 }
374
375 /* At this point, the dev_node_t structure(s) should be
376 initialized and arranged in a linked list at link->dev. *//* */
377 sprintf(dev->node.dev_name, "elsa");
378 dev->node.major = dev->node.minor = 0x0;
379
380 link->dev = &dev->node;
381
382 /* Finally, report what we've done */
383 printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
384 dev->node.dev_name, link->conf.ConfigIndex,
385 link->conf.Vcc/10, link->conf.Vcc%10);
386 if (link->conf.Vpp1)
387 printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
388 if (link->conf.Attributes & CONF_ENABLE_IRQ)
389 printk(", irq %d", link->irq.AssignedIRQ);
390 if (link->io.NumPorts1)
391 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
392 link->io.BasePort1+link->io.NumPorts1-1);
393 if (link->io.NumPorts2)
394 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
395 link->io.BasePort2+link->io.NumPorts2-1);
396 printk("\n");
397
398 link->state &= ~DEV_CONFIG_PENDING;
399
400 icard.para[0] = link->irq.AssignedIRQ;
401 icard.para[1] = link->io.BasePort1;
402 icard.protocol = protocol;
403 icard.typ = ISDN_CTYPE_ELSA_PCMCIA;
404
405 i = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->busy), &icard);
406 if (i < 0) {
407 printk(KERN_ERR "elsa_cs: failed to initialize Elsa PCMCIA %d at i/o %#x\n",
408 i, link->io.BasePort1);
409 elsa_cs_release(link);
410 } else
411 ((local_info_t*)link->priv)->cardnr = i;
412
413 return;
414cs_failed:
415 cs_error(link->handle, last_fn, i);
416 elsa_cs_release(link);
417} /* elsa_cs_config */
418
419/*======================================================================
420
421 After a card is removed, elsa_cs_release() will unregister the net
422 device, and release the PCMCIA configuration. If the device is
423 still open, this will be postponed until it is closed.
424
425======================================================================*/
426
427static void elsa_cs_release(dev_link_t *link)
428{
429 local_info_t *local = link->priv;
430
431 DEBUG(0, "elsa_cs_release(0x%p)\n", link);
432
433 if (local) {
434 if (local->cardnr >= 0) {
435 /* no unregister function with hisax */
436 HiSax_closecard(local->cardnr);
437 }
438 }
439 /* Unlink the device chain */
440 link->dev = NULL;
441
442 /* Don't bother checking to see if these succeed or not */
443 if (link->win)
444 pcmcia_release_window(link->win);
445 pcmcia_release_configuration(link->handle);
446 pcmcia_release_io(link->handle, &link->io);
447 pcmcia_release_irq(link->handle, &link->irq);
448 link->state &= ~DEV_CONFIG;
449} /* elsa_cs_release */
450
451/*======================================================================
452
453 The card status event handler. Mostly, this schedules other
454 stuff to run after an event is received. A CARD_REMOVAL event
455 also sets some flags to discourage the net drivers from trying
456 to talk to the card any more.
457
458 When a CARD_REMOVAL event is received, we immediately set a flag
459 to block future accesses to this device. All the functions that
460 actually access the device should check this flag to make sure
461 the card is still present.
462
463======================================================================*/
464
465static int elsa_cs_event(event_t event, int priority,
466 event_callback_args_t *args)
467{
468 dev_link_t *link = args->client_data;
469 local_info_t *dev = link->priv;
470
471 DEBUG(1, "elsa_cs_event(%d)\n", event);
472
473 switch (event) {
474 case CS_EVENT_CARD_REMOVAL:
475 link->state &= ~DEV_PRESENT;
476 if (link->state & DEV_CONFIG) {
477 ((local_info_t*)link->priv)->busy = 1;
478 elsa_cs_release(link);
479 }
480 break;
481 case CS_EVENT_CARD_INSERTION:
482 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
483 elsa_cs_config(link);
484 break;
485 case CS_EVENT_PM_SUSPEND:
486 link->state |= DEV_SUSPEND;
487 /* Fall through... */
488 case CS_EVENT_RESET_PHYSICAL:
489 /* Mark the device as stopped, to block IO until later */
490 dev->busy = 1;
491 if (link->state & DEV_CONFIG)
492 pcmcia_release_configuration(link->handle);
493 break;
494 case CS_EVENT_PM_RESUME:
495 link->state &= ~DEV_SUSPEND;
496 /* Fall through... */
497 case CS_EVENT_CARD_RESET:
498 if (link->state & DEV_CONFIG)
499 pcmcia_request_configuration(link->handle, &link->conf);
500 dev->busy = 0;
501 break;
502 }
503 return 0;
504} /* elsa_cs_event */
505
Dominik Brodowski02ae38c2005-06-27 16:28:39 -0700506static struct pcmcia_device_id elsa_ids[] = {
507 PCMCIA_DEVICE_PROD_ID12("ELSA AG (Aachen, Germany)", "MicroLink ISDN/MC ", 0x983de2c4, 0x333ba257),
508 PCMCIA_DEVICE_PROD_ID12("ELSA GmbH, Aachen", "MicroLink ISDN/MC ", 0x639e5718, 0x333ba257),
509 PCMCIA_DEVICE_NULL
510};
511MODULE_DEVICE_TABLE(pcmcia, elsa_ids);
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513static struct pcmcia_driver elsa_cs_driver = {
514 .owner = THIS_MODULE,
515 .drv = {
516 .name = "elsa_cs",
517 },
518 .attach = elsa_cs_attach,
Dominik Brodowski1e212f32005-07-07 17:59:00 -0700519 .event = elsa_cs_event,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 .detach = elsa_cs_detach,
Dominik Brodowski02ae38c2005-06-27 16:28:39 -0700521 .id_table = elsa_ids,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522};
523
524static int __init init_elsa_cs(void)
525{
526 return pcmcia_register_driver(&elsa_cs_driver);
527}
528
529static void __exit exit_elsa_cs(void)
530{
531 pcmcia_unregister_driver(&elsa_cs_driver);
532 BUG_ON(dev_list != NULL);
533}
534
535module_init(init_elsa_cs);
536module_exit(exit_elsa_cs);