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 int sedlbauer_config(struct pcmcia_device *link);
99 static void sedlbauer_release(struct pcmcia_device *link);
102 The attach() and detach() entry points are used to create and destroy
103 "instances" of the driver, where each instance represents everything
104 needed to manage one actual PCMCIA card.
107 static void sedlbauer_detach(struct pcmcia_device *p_dev);
110 You'll also need to prototype all the functions that will actually
111 be used to talk to your device. See 'memory_cs' for a good example
112 of a fully self-sufficient driver; the other drivers rely more or
113 less on other parts of the kernel.
117 A driver needs to provide a dev_node_t structure for each device
118 on a card. In some cases, there is only one device per card (for
119 example, ethernet cards, modems). In other cases, there may be
120 many actual or logical devices (SCSI adapters, memory cards with
121 multiple partitions). The dev_node_t structures need to be kept
122 in a linked list starting at the 'dev' field of a struct pcmcia_device
123 structure. We allocate them in the card's private data structure,
124 because they generally shouldn't be allocated dynamically.
126 In this case, we also provide a flag to indicate if a device is
127 "stopped" due to a power management event, or card ejection. The
128 device IO routines can use a flag like this to throttle IO to a
129 card that is not ready to accept it.
132 typedef struct local_info_t {
133 struct pcmcia_device *p_dev;
139 /*======================================================================
141 sedlbauer_attach() creates an "instance" of the driver, allocating
142 local data structures for one device. The device is registered
145 The dev_link structure is initialized, but we don't actually
146 configure the card at this point -- we wait until we receive a
147 card insertion event.
149 ======================================================================*/
151 static int sedlbauer_probe(struct pcmcia_device *link)
155 DEBUG(0, "sedlbauer_attach()\n");
157 /* Allocate space for private device-specific data */
158 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
159 if (!local) return -ENOMEM;
160 memset(local, 0, sizeof(local_info_t));
166 /* Interrupt setup */
167 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
168 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
169 link->irq.Handler = NULL;
172 General socket configuration defaults can go here. In this
173 client, we assume very little, and rely on the CIS for almost
174 everything. In most clients, many details (i.e., number, sizes,
175 and attributes of IO windows) are fixed by the nature of the
176 device, and can be hard-wired here.
181 /* The io structure describes IO port mapping */
182 link->io.NumPorts1 = 8;
183 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
184 link->io.IOAddrLines = 3;
186 link->conf.Attributes = 0;
187 link->conf.IntType = INT_MEMORY_AND_IO;
189 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
190 return sedlbauer_config(link);
191 } /* sedlbauer_attach */
193 /*======================================================================
195 This deletes a driver "instance". The device is de-registered
196 with Card Services. If it has been released, all local data
197 structures are freed. Otherwise, the structures will be freed
198 when the device is released.
200 ======================================================================*/
202 static void sedlbauer_detach(struct pcmcia_device *link)
204 DEBUG(0, "sedlbauer_detach(0x%p)\n", link);
206 if (link->state & DEV_CONFIG) {
207 ((local_info_t *)link->priv)->stop = 1;
208 sedlbauer_release(link);
211 /* This points to the parent local_info_t struct */
213 } /* sedlbauer_detach */
215 /*======================================================================
217 sedlbauer_config() is scheduled to run after a CARD_INSERTION event
218 is received, to configure the PCMCIA socket, and to make the
219 device available to the system.
221 ======================================================================*/
222 #define CS_CHECK(fn, ret) \
223 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
225 static int sedlbauer_config(struct pcmcia_device *link)
227 local_info_t *dev = link->priv;
230 int last_fn, last_ret;
237 DEBUG(0, "sedlbauer_config(0x%p)\n", link);
240 This reads the card's CONFIG tuple to find its configuration
243 tuple.DesiredTuple = CISTPL_CONFIG;
244 tuple.Attributes = 0;
245 tuple.TupleData = buf;
246 tuple.TupleDataMax = sizeof(buf);
247 tuple.TupleOffset = 0;
248 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
249 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
250 CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
251 link->conf.ConfigBase = parse.config.base;
252 link->conf.Present = parse.config.rmask[0];
255 link->state |= DEV_CONFIG;
257 CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(link, &conf));
260 In this loop, we scan the CIS for configuration table entries,
261 each of which describes a valid card configuration, including
262 voltage, IO window, memory window, and interrupt settings.
264 We make no assumptions about the card to be configured: we use
265 just the information available in the CIS. In an ideal world,
266 this would work for any PCMCIA card, but it requires a complete
267 and accurate CIS. In practice, a driver usually "knows" most of
268 these things without consulting the CIS, and most client drivers
269 will only use the CIS to fill in implementation-defined details.
271 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
272 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
274 cistpl_cftable_entry_t dflt = { 0 };
275 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
276 if (pcmcia_get_tuple_data(link, &tuple) != 0 ||
277 pcmcia_parse_tuple(link, &tuple, &parse) != 0)
280 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
281 if (cfg->index == 0) goto next_entry;
282 link->conf.ConfigIndex = cfg->index;
284 /* Does this card need audio output? */
285 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
286 link->conf.Attributes |= CONF_ENABLE_SPKR;
287 link->conf.Status = CCSR_AUDIO_ENA;
290 /* Use power settings for Vcc and Vpp if present */
291 /* Note that the CIS values need to be rescaled */
292 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
293 if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
295 } else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM)) {
296 if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM]/10000)
300 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
302 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
303 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
305 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
307 /* Do we need to allocate an interrupt? */
308 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
309 link->conf.Attributes |= CONF_ENABLE_IRQ;
311 /* IO window settings */
312 link->io.NumPorts1 = link->io.NumPorts2 = 0;
313 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
314 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
315 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
316 if (!(io->flags & CISTPL_IO_8BIT))
317 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
318 if (!(io->flags & CISTPL_IO_16BIT))
319 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
320 /* new in dummy.cs 2001/01/28 MN
321 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
323 link->io.BasePort1 = io->win[0].base;
324 link->io.NumPorts1 = io->win[0].len;
326 link->io.Attributes2 = link->io.Attributes1;
327 link->io.BasePort2 = io->win[1].base;
328 link->io.NumPorts2 = io->win[1].len;
330 /* This reserves IO space but doesn't actually enable it */
331 if (pcmcia_request_io(link, &link->io) != 0)
336 Now set up a common memory window, if needed. There is room
337 in the struct pcmcia_device structure for one memory window handle,
338 but if the base addresses need to be saved, or if multiple
339 windows are needed, the info should go in the private data
340 structure for this device.
342 Note that the memory window base is a physical address, and
343 needs to be mapped to virtual space with ioremap() before it
346 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
348 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
349 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
350 req.Attributes |= WIN_ENABLE;
351 req.Base = mem->win[0].host_addr;
352 req.Size = mem->win[0].len;
353 /* new in dummy.cs 2001/01/28 MN
354 if (req.Size < 0x1000)
358 if (pcmcia_request_window(&link, &req, &link->win) != 0)
360 map.Page = 0; map.CardOffset = mem->win[0].card_addr;
361 if (pcmcia_map_mem_page(link->win, &map) != 0)
364 /* If we got this far, we're cool! */
368 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
372 Allocate an interrupt line. Note that this does not assign a
373 handler to the interrupt, unless the 'Handler' member of the
374 irq structure is initialized.
376 if (link->conf.Attributes & CONF_ENABLE_IRQ)
377 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
380 This actually configures the PCMCIA socket -- setting up
381 the I/O windows and the interrupt mapping, and putting the
382 card and host interface into "Memory and IO" mode.
384 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
387 At this point, the dev_node_t structure(s) need to be
388 initialized and arranged in a linked list at link->dev.
390 sprintf(dev->node.dev_name, "sedlbauer");
391 dev->node.major = dev->node.minor = 0;
392 link->dev_node = &dev->node;
394 /* Finally, report what we've done */
395 printk(KERN_INFO "%s: index 0x%02x:",
396 dev->node.dev_name, link->conf.ConfigIndex);
398 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
399 if (link->conf.Attributes & CONF_ENABLE_IRQ)
400 printk(", irq %d", link->irq.AssignedIRQ);
401 if (link->io.NumPorts1)
402 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
403 link->io.BasePort1+link->io.NumPorts1-1);
404 if (link->io.NumPorts2)
405 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
406 link->io.BasePort2+link->io.NumPorts2-1);
408 printk(", mem 0x%06lx-0x%06lx", req.Base,
409 req.Base+req.Size-1);
412 link->state &= ~DEV_CONFIG_PENDING;
414 icard.para[0] = link->irq.AssignedIRQ;
415 icard.para[1] = link->io.BasePort1;
416 icard.protocol = protocol;
417 icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
419 last_ret = hisax_init_pcmcia(link, &(((local_info_t*)link->priv)->stop), &icard);
421 printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
422 last_ret, link->io.BasePort1);
423 sedlbauer_release(link);
426 ((local_info_t*)link->priv)->cardnr = last_ret;
431 cs_error(link, last_fn, last_ret);
432 sedlbauer_release(link);
435 } /* sedlbauer_config */
437 /*======================================================================
439 After a card is removed, sedlbauer_release() will unregister the
440 device, and release the PCMCIA configuration. If the device is
441 still open, this will be postponed until it is closed.
443 ======================================================================*/
445 static void sedlbauer_release(struct pcmcia_device *link)
447 local_info_t *local = link->priv;
448 DEBUG(0, "sedlbauer_release(0x%p)\n", link);
451 if (local->cardnr >= 0) {
452 /* no unregister function with hisax */
453 HiSax_closecard(local->cardnr);
457 pcmcia_disable_device(link);
458 } /* sedlbauer_release */
460 static int sedlbauer_suspend(struct pcmcia_device *link)
462 local_info_t *dev = link->priv;
469 static int sedlbauer_resume(struct pcmcia_device *link)
471 local_info_t *dev = link->priv;
479 static struct pcmcia_device_id sedlbauer_ids[] = {
480 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
481 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
482 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
483 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
484 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
485 PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
486 /* PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
489 MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
491 static struct pcmcia_driver sedlbauer_driver = {
492 .owner = THIS_MODULE,
494 .name = "sedlbauer_cs",
496 .probe = sedlbauer_probe,
497 .remove = sedlbauer_detach,
498 .id_table = sedlbauer_ids,
499 .suspend = sedlbauer_suspend,
500 .resume = sedlbauer_resume,
503 static int __init init_sedlbauer_cs(void)
505 return pcmcia_register_driver(&sedlbauer_driver);
508 static void __exit exit_sedlbauer_cs(void)
510 pcmcia_unregister_driver(&sedlbauer_driver);
513 module_init(init_sedlbauer_cs);
514 module_exit(exit_sedlbauer_cs);