1 /*======================================================================
3 A Sedlbauer PCMCIA client driver
5 This driver is for the Sedlbauer Speed Star and Speed Star II,
6 which are ISDN PCMCIA Cards.
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/
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.
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.
22 Modifications from dummy_cs.c are Copyright (C) 1999-2001 Marcus Niemann
23 <maniemann@users.sourceforge.net>. All Rights Reserved.
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.
36 ======================================================================*/
38 #include <linux/kernel.h>
39 #include <linux/module.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>
48 #include <asm/system.h>
50 #include <pcmcia/cs_types.h>
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/cisreg.h>
54 #include <pcmcia/ds.h>
55 #include "hisax_cfg.h"
57 MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
58 MODULE_AUTHOR("Marcus Niemann");
59 MODULE_LICENSE("Dual MPL/GPL");
62 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
63 you do not define PCMCIA_DEBUG at all, all the debug code will be
64 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
65 be present but disabled -- but it can then be enabled for specific
66 modules at load time with a 'pc_debug=#' option to insmod.
70 static int pc_debug = PCMCIA_DEBUG;
71 module_param(pc_debug, int, 0);
72 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
73 static char *version =
74 "sedlbauer_cs.c 1.1a 2001/01/28 15:04:04 (M.Niemann)";
76 #define DEBUG(n, args...)
80 /*====================================================================*/
82 /* Parameters that can be set with 'insmod' */
84 static int protocol = 2; /* EURO-ISDN Default */
85 module_param(protocol, int, 0);
87 /*====================================================================*/
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
94 insertion and ejection events. They are invoked from the sedlbauer
98 static void sedlbauer_config(dev_link_t *link);
99 static void sedlbauer_release(dev_link_t *link);
100 static int sedlbauer_event(event_t event, int priority,
101 event_callback_args_t *args);
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.
109 static dev_link_t *sedlbauer_attach(void);
110 static void sedlbauer_detach(struct pcmcia_device *p_dev);
113 You'll also need to prototype all the functions that will actually
114 be used to talk to your device. See 'memory_cs' for a good example
115 of a fully self-sufficient driver; the other drivers rely more or
116 less on other parts of the kernel.
120 The dev_info variable is the "key" that is used to match up this
121 device driver with appropriate cards, through the card configuration
125 static dev_info_t dev_info = "sedlbauer_cs";
128 A linked list of "instances" of the sedlbauer device. Each actual
129 PCMCIA card corresponds to one device instance, and is described
130 by one dev_link_t structure (defined in ds.h).
132 You may not want to use a linked list for this -- for example, the
133 memory card driver uses an array of dev_link_t pointers, where minor
134 device numbers are used to derive the corresponding array index.
138 A driver needs to provide a dev_node_t structure for each device
139 on a card. In some cases, there is only one device per card (for
140 example, ethernet cards, modems). In other cases, there may be
141 many actual or logical devices (SCSI adapters, memory cards with
142 multiple partitions). The dev_node_t structures need to be kept
143 in a linked list starting at the 'dev' field of a dev_link_t
144 structure. We allocate them in the card's private data structure,
145 because they generally shouldn't be allocated dynamically.
147 In this case, we also provide a flag to indicate if a device is
148 "stopped" due to a power management event, or card ejection. The
149 device IO routines can use a flag like this to throttle IO to a
150 card that is not ready to accept it.
153 typedef struct local_info_t {
160 /*======================================================================
162 sedlbauer_attach() creates an "instance" of the driver, allocating
163 local data structures for one device. The device is registered
166 The dev_link structure is initialized, but we don't actually
167 configure the card at this point -- we wait until we receive a
168 card insertion event.
170 ======================================================================*/
172 static dev_link_t *sedlbauer_attach(void)
176 client_reg_t client_reg;
179 DEBUG(0, "sedlbauer_attach()\n");
181 /* Allocate space for private device-specific data */
182 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
183 if (!local) return NULL;
184 memset(local, 0, sizeof(local_info_t));
186 link = &local->link; link->priv = local;
188 /* Interrupt setup */
189 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
190 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
191 link->irq.Handler = NULL;
194 General socket configuration defaults can go here. In this
195 client, we assume very little, and rely on the CIS for almost
196 everything. In most clients, many details (i.e., number, sizes,
197 and attributes of IO windows) are fixed by the nature of the
198 device, and can be hard-wired here.
203 /* The io structure describes IO port mapping */
204 link->io.NumPorts1 = 8;
205 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
206 link->io.IOAddrLines = 3;
209 link->conf.Attributes = 0;
211 link->conf.IntType = INT_MEMORY_AND_IO;
213 /* Register with Card Services */
215 client_reg.dev_info = &dev_info;
216 client_reg.Version = 0x0210;
217 client_reg.event_callback_args.client_data = link;
218 ret = pcmcia_register_client(&link->handle, &client_reg);
219 if (ret != CS_SUCCESS) {
220 cs_error(link->handle, RegisterClient, ret);
221 sedlbauer_detach(link->handle);
226 } /* sedlbauer_attach */
228 /*======================================================================
230 This deletes a driver "instance". The device is de-registered
231 with Card Services. If it has been released, all local data
232 structures are freed. Otherwise, the structures will be freed
233 when the device is released.
235 ======================================================================*/
237 static void sedlbauer_detach(struct pcmcia_device *p_dev)
239 dev_link_t *link = dev_to_instance(p_dev);
241 DEBUG(0, "sedlbauer_detach(0x%p)\n", link);
243 if (link->state & DEV_CONFIG) {
244 ((local_info_t *)link->priv)->stop = 1;
245 sedlbauer_release(link);
248 /* This points to the parent local_info_t struct */
250 } /* sedlbauer_detach */
252 /*======================================================================
254 sedlbauer_config() is scheduled to run after a CARD_INSERTION event
255 is received, to configure the PCMCIA socket, and to make the
256 device available to the system.
258 ======================================================================*/
259 #define CS_CHECK(fn, ret) \
260 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
262 static void sedlbauer_config(dev_link_t *link)
264 client_handle_t handle = link->handle;
265 local_info_t *dev = link->priv;
268 int last_fn, last_ret;
275 DEBUG(0, "sedlbauer_config(0x%p)\n", link);
278 This reads the card's CONFIG tuple to find its configuration
281 tuple.DesiredTuple = CISTPL_CONFIG;
282 tuple.Attributes = 0;
283 tuple.TupleData = buf;
284 tuple.TupleDataMax = sizeof(buf);
285 tuple.TupleOffset = 0;
286 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
287 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
288 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
289 link->conf.ConfigBase = parse.config.base;
290 link->conf.Present = parse.config.rmask[0];
293 link->state |= DEV_CONFIG;
295 /* Look up the current Vcc */
296 CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &conf));
297 link->conf.Vcc = conf.Vcc;
300 In this loop, we scan the CIS for configuration table entries,
301 each of which describes a valid card configuration, including
302 voltage, IO window, memory window, and interrupt settings.
304 We make no assumptions about the card to be configured: we use
305 just the information available in the CIS. In an ideal world,
306 this would work for any PCMCIA card, but it requires a complete
307 and accurate CIS. In practice, a driver usually "knows" most of
308 these things without consulting the CIS, and most client drivers
309 will only use the CIS to fill in implementation-defined details.
311 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
312 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
314 cistpl_cftable_entry_t dflt = { 0 };
315 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
316 if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
317 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
320 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
321 if (cfg->index == 0) goto next_entry;
322 link->conf.ConfigIndex = cfg->index;
324 /* Does this card need audio output? */
325 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
326 link->conf.Attributes |= CONF_ENABLE_SPKR;
327 link->conf.Status = CCSR_AUDIO_ENA;
330 /* Use power settings for Vcc and Vpp if present */
331 /* Note that the CIS values need to be rescaled */
332 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
333 if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
335 } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
336 if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM]/10000)
340 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
341 link->conf.Vpp1 = link->conf.Vpp2 =
342 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
343 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
344 link->conf.Vpp1 = link->conf.Vpp2 =
345 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
347 /* Do we need to allocate an interrupt? */
348 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
349 link->conf.Attributes |= CONF_ENABLE_IRQ;
351 /* IO window settings */
352 link->io.NumPorts1 = link->io.NumPorts2 = 0;
353 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
354 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
355 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
356 if (!(io->flags & CISTPL_IO_8BIT))
357 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
358 if (!(io->flags & CISTPL_IO_16BIT))
359 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
360 /* new in dummy.cs 2001/01/28 MN
361 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
363 link->io.BasePort1 = io->win[0].base;
364 link->io.NumPorts1 = io->win[0].len;
366 link->io.Attributes2 = link->io.Attributes1;
367 link->io.BasePort2 = io->win[1].base;
368 link->io.NumPorts2 = io->win[1].len;
370 /* This reserves IO space but doesn't actually enable it */
371 if (pcmcia_request_io(link->handle, &link->io) != 0)
376 Now set up a common memory window, if needed. There is room
377 in the dev_link_t structure for one memory window handle,
378 but if the base addresses need to be saved, or if multiple
379 windows are needed, the info should go in the private data
380 structure for this device.
382 Note that the memory window base is a physical address, and
383 needs to be mapped to virtual space with ioremap() before it
386 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
388 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
389 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
390 req.Attributes |= WIN_ENABLE;
391 req.Base = mem->win[0].host_addr;
392 req.Size = mem->win[0].len;
393 /* new in dummy.cs 2001/01/28 MN
394 if (req.Size < 0x1000)
398 if (pcmcia_request_window(&link->handle, &req, &link->win) != 0)
400 map.Page = 0; map.CardOffset = mem->win[0].card_addr;
401 if (pcmcia_map_mem_page(link->win, &map) != 0)
404 /* If we got this far, we're cool! */
408 /* new in dummy.cs 2001/01/28 MN
409 if (link->io.NumPorts1)
410 pcmcia_release_io(link->handle, &link->io);
412 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
416 Allocate an interrupt line. Note that this does not assign a
417 handler to the interrupt, unless the 'Handler' member of the
418 irq structure is initialized.
420 if (link->conf.Attributes & CONF_ENABLE_IRQ)
421 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
424 This actually configures the PCMCIA socket -- setting up
425 the I/O windows and the interrupt mapping, and putting the
426 card and host interface into "Memory and IO" mode.
428 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
431 At this point, the dev_node_t structure(s) need to be
432 initialized and arranged in a linked list at link->dev.
434 sprintf(dev->node.dev_name, "sedlbauer");
435 dev->node.major = dev->node.minor = 0;
436 link->dev = &dev->node;
438 /* Finally, report what we've done */
439 printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
440 dev->node.dev_name, link->conf.ConfigIndex,
441 link->conf.Vcc/10, link->conf.Vcc%10);
443 printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
444 if (link->conf.Attributes & CONF_ENABLE_IRQ)
445 printk(", irq %d", link->irq.AssignedIRQ);
446 if (link->io.NumPorts1)
447 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
448 link->io.BasePort1+link->io.NumPorts1-1);
449 if (link->io.NumPorts2)
450 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
451 link->io.BasePort2+link->io.NumPorts2-1);
453 printk(", mem 0x%06lx-0x%06lx", req.Base,
454 req.Base+req.Size-1);
457 link->state &= ~DEV_CONFIG_PENDING;
459 icard.para[0] = link->irq.AssignedIRQ;
460 icard.para[1] = link->io.BasePort1;
461 icard.protocol = protocol;
462 icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
464 last_ret = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->stop), &icard);
466 printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
467 last_ret, link->io.BasePort1);
468 sedlbauer_release(link);
470 ((local_info_t*)link->priv)->cardnr = last_ret;
475 cs_error(link->handle, last_fn, last_ret);
476 sedlbauer_release(link);
478 } /* sedlbauer_config */
480 /*======================================================================
482 After a card is removed, sedlbauer_release() will unregister the
483 device, and release the PCMCIA configuration. If the device is
484 still open, this will be postponed until it is closed.
486 ======================================================================*/
488 static void sedlbauer_release(dev_link_t *link)
490 local_info_t *local = link->priv;
491 DEBUG(0, "sedlbauer_release(0x%p)\n", link);
494 if (local->cardnr >= 0) {
495 /* no unregister function with hisax */
496 HiSax_closecard(local->cardnr);
499 /* Unlink the device chain */
503 In a normal driver, additional code may be needed to release
504 other kernel data structures associated with this device.
507 /* Don't bother checking to see if these succeed or not */
509 pcmcia_release_window(link->win);
510 pcmcia_release_configuration(link->handle);
511 if (link->io.NumPorts1)
512 pcmcia_release_io(link->handle, &link->io);
513 if (link->irq.AssignedIRQ)
514 pcmcia_release_irq(link->handle, &link->irq);
515 link->state &= ~DEV_CONFIG;
516 } /* sedlbauer_release */
518 static int sedlbauer_suspend(struct pcmcia_device *p_dev)
520 dev_link_t *link = dev_to_instance(p_dev);
521 local_info_t *dev = link->priv;
523 link->state |= DEV_SUSPEND;
525 if (link->state & DEV_CONFIG)
526 pcmcia_release_configuration(link->handle);
531 static int sedlbauer_resume(struct pcmcia_device *p_dev)
533 dev_link_t *link = dev_to_instance(p_dev);
534 local_info_t *dev = link->priv;
536 link->state &= ~DEV_SUSPEND;
537 if (link->state & DEV_CONFIG)
538 pcmcia_request_configuration(link->handle, &link->conf);
544 /*======================================================================
546 The card status event handler. Mostly, this schedules other
547 stuff to run after an event is received.
549 When a CARD_REMOVAL event is received, we immediately set a
550 private flag to block future accesses to this device. All the
551 functions that actually access the device should check this flag
552 to make sure the card is still present.
554 ======================================================================*/
556 static int sedlbauer_event(event_t event, int priority,
557 event_callback_args_t *args)
559 dev_link_t *link = args->client_data;
561 DEBUG(1, "sedlbauer_event(0x%06x)\n", event);
564 case CS_EVENT_CARD_INSERTION:
565 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
566 sedlbauer_config(link);
570 } /* sedlbauer_event */
572 static struct pcmcia_device_id sedlbauer_ids[] = {
573 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
574 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
575 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
576 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
577 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
578 PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
579 /* PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
582 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
584 static struct pcmcia_driver sedlbauer_driver = {
585 .owner = THIS_MODULE,
587 .name = "sedlbauer_cs",
589 .attach = sedlbauer_attach,
590 .event = sedlbauer_event,
591 .remove = sedlbauer_detach,
592 .id_table = sedlbauer_ids,
593 .suspend = sedlbauer_suspend,
594 .resume = sedlbauer_resume,
597 static int __init init_sedlbauer_cs(void)
599 return pcmcia_register_driver(&sedlbauer_driver);
602 static void __exit exit_sedlbauer_cs(void)
604 pcmcia_unregister_driver(&sedlbauer_driver);
607 module_init(init_sedlbauer_cs);
608 module_exit(exit_sedlbauer_cs);