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.
137 static dev_link_t
*dev_list
= NULL
;
140 A dev_link_t structure has fields for most things that are needed
141 to keep track of a socket, but there will usually be some device
142 specific information that also needs to be kept track of. The
143 'priv' pointer in a dev_link_t structure can be used to point to
144 a device-specific private data structure, like this.
146 To simplify the data structure handling, we actually include the
147 dev_link_t structure in the device's private data structure.
149 A driver needs to provide a dev_node_t structure for each device
150 on a card. In some cases, there is only one device per card (for
151 example, ethernet cards, modems). In other cases, there may be
152 many actual or logical devices (SCSI adapters, memory cards with
153 multiple partitions). The dev_node_t structures need to be kept
154 in a linked list starting at the 'dev' field of a dev_link_t
155 structure. We allocate them in the card's private data structure,
156 because they generally shouldn't be allocated dynamically.
158 In this case, we also provide a flag to indicate if a device is
159 "stopped" due to a power management event, or card ejection. The
160 device IO routines can use a flag like this to throttle IO to a
161 card that is not ready to accept it.
164 typedef struct local_info_t
{
171 /*======================================================================
173 sedlbauer_attach() creates an "instance" of the driver, allocating
174 local data structures for one device. The device is registered
177 The dev_link structure is initialized, but we don't actually
178 configure the card at this point -- we wait until we receive a
179 card insertion event.
181 ======================================================================*/
183 static dev_link_t
*sedlbauer_attach(void)
187 client_reg_t client_reg
;
190 DEBUG(0, "sedlbauer_attach()\n");
192 /* Allocate space for private device-specific data */
193 local
= kmalloc(sizeof(local_info_t
), GFP_KERNEL
);
194 if (!local
) return NULL
;
195 memset(local
, 0, sizeof(local_info_t
));
197 link
= &local
->link
; link
->priv
= local
;
199 /* Interrupt setup */
200 link
->irq
.Attributes
= IRQ_TYPE_EXCLUSIVE
;
201 link
->irq
.IRQInfo1
= IRQ_LEVEL_ID
;
202 link
->irq
.Handler
= NULL
;
205 General socket configuration defaults can go here. In this
206 client, we assume very little, and rely on the CIS for almost
207 everything. In most clients, many details (i.e., number, sizes,
208 and attributes of IO windows) are fixed by the nature of the
209 device, and can be hard-wired here.
214 /* The io structure describes IO port mapping */
215 link
->io
.NumPorts1
= 8;
216 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
217 link
->io
.IOAddrLines
= 3;
220 link
->conf
.Attributes
= 0;
222 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
224 /* Register with Card Services */
225 link
->next
= dev_list
;
227 client_reg
.dev_info
= &dev_info
;
228 client_reg
.Version
= 0x0210;
229 client_reg
.event_callback_args
.client_data
= link
;
230 ret
= pcmcia_register_client(&link
->handle
, &client_reg
);
231 if (ret
!= CS_SUCCESS
) {
232 cs_error(link
->handle
, RegisterClient
, ret
);
233 sedlbauer_detach(link
->handle
);
238 } /* sedlbauer_attach */
240 /*======================================================================
242 This deletes a driver "instance". The device is de-registered
243 with Card Services. If it has been released, all local data
244 structures are freed. Otherwise, the structures will be freed
245 when the device is released.
247 ======================================================================*/
249 static void sedlbauer_detach(struct pcmcia_device
*p_dev
)
251 dev_link_t
*link
= dev_to_instance(p_dev
);
254 DEBUG(0, "sedlbauer_detach(0x%p)\n", link
);
256 /* Locate device structure */
257 for (linkp
= &dev_list
; *linkp
; linkp
= &(*linkp
)->next
)
258 if (*linkp
== link
) break;
262 if (link
->state
& DEV_CONFIG
) {
263 ((local_info_t
*)link
->priv
)->stop
= 1;
264 sedlbauer_release(link
);
267 /* Unlink device structure, and free it */
269 /* This points to the parent local_info_t struct */
271 } /* sedlbauer_detach */
273 /*======================================================================
275 sedlbauer_config() is scheduled to run after a CARD_INSERTION event
276 is received, to configure the PCMCIA socket, and to make the
277 device available to the system.
279 ======================================================================*/
280 #define CS_CHECK(fn, ret) \
281 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
283 static void sedlbauer_config(dev_link_t
*link
)
285 client_handle_t handle
= link
->handle
;
286 local_info_t
*dev
= link
->priv
;
289 int last_fn
, last_ret
;
296 DEBUG(0, "sedlbauer_config(0x%p)\n", link
);
299 This reads the card's CONFIG tuple to find its configuration
302 tuple
.DesiredTuple
= CISTPL_CONFIG
;
303 tuple
.Attributes
= 0;
304 tuple
.TupleData
= buf
;
305 tuple
.TupleDataMax
= sizeof(buf
);
306 tuple
.TupleOffset
= 0;
307 CS_CHECK(GetFirstTuple
, pcmcia_get_first_tuple(handle
, &tuple
));
308 CS_CHECK(GetTupleData
, pcmcia_get_tuple_data(handle
, &tuple
));
309 CS_CHECK(ParseTuple
, pcmcia_parse_tuple(handle
, &tuple
, &parse
));
310 link
->conf
.ConfigBase
= parse
.config
.base
;
311 link
->conf
.Present
= parse
.config
.rmask
[0];
314 link
->state
|= DEV_CONFIG
;
316 /* Look up the current Vcc */
317 CS_CHECK(GetConfigurationInfo
, pcmcia_get_configuration_info(handle
, &conf
));
318 link
->conf
.Vcc
= conf
.Vcc
;
321 In this loop, we scan the CIS for configuration table entries,
322 each of which describes a valid card configuration, including
323 voltage, IO window, memory window, and interrupt settings.
325 We make no assumptions about the card to be configured: we use
326 just the information available in the CIS. In an ideal world,
327 this would work for any PCMCIA card, but it requires a complete
328 and accurate CIS. In practice, a driver usually "knows" most of
329 these things without consulting the CIS, and most client drivers
330 will only use the CIS to fill in implementation-defined details.
332 tuple
.DesiredTuple
= CISTPL_CFTABLE_ENTRY
;
333 CS_CHECK(GetFirstTuple
, pcmcia_get_first_tuple(handle
, &tuple
));
335 cistpl_cftable_entry_t dflt
= { 0 };
336 cistpl_cftable_entry_t
*cfg
= &(parse
.cftable_entry
);
337 if (pcmcia_get_tuple_data(handle
, &tuple
) != 0 ||
338 pcmcia_parse_tuple(handle
, &tuple
, &parse
) != 0)
341 if (cfg
->flags
& CISTPL_CFTABLE_DEFAULT
) dflt
= *cfg
;
342 if (cfg
->index
== 0) goto next_entry
;
343 link
->conf
.ConfigIndex
= cfg
->index
;
345 /* Does this card need audio output? */
346 if (cfg
->flags
& CISTPL_CFTABLE_AUDIO
) {
347 link
->conf
.Attributes
|= CONF_ENABLE_SPKR
;
348 link
->conf
.Status
= CCSR_AUDIO_ENA
;
351 /* Use power settings for Vcc and Vpp if present */
352 /* Note that the CIS values need to be rescaled */
353 if (cfg
->vcc
.present
& (1<<CISTPL_POWER_VNOM
)) {
354 if (conf
.Vcc
!= cfg
->vcc
.param
[CISTPL_POWER_VNOM
]/10000)
356 } else if (dflt
.vcc
.present
& (1<<CISTPL_POWER_VNOM
)) {
357 if (conf
.Vcc
!= dflt
.vcc
.param
[CISTPL_POWER_VNOM
]/10000)
361 if (cfg
->vpp1
.present
& (1<<CISTPL_POWER_VNOM
))
362 link
->conf
.Vpp1
= link
->conf
.Vpp2
=
363 cfg
->vpp1
.param
[CISTPL_POWER_VNOM
]/10000;
364 else if (dflt
.vpp1
.present
& (1<<CISTPL_POWER_VNOM
))
365 link
->conf
.Vpp1
= link
->conf
.Vpp2
=
366 dflt
.vpp1
.param
[CISTPL_POWER_VNOM
]/10000;
368 /* Do we need to allocate an interrupt? */
369 if (cfg
->irq
.IRQInfo1
|| dflt
.irq
.IRQInfo1
)
370 link
->conf
.Attributes
|= CONF_ENABLE_IRQ
;
372 /* IO window settings */
373 link
->io
.NumPorts1
= link
->io
.NumPorts2
= 0;
374 if ((cfg
->io
.nwin
> 0) || (dflt
.io
.nwin
> 0)) {
375 cistpl_io_t
*io
= (cfg
->io
.nwin
) ? &cfg
->io
: &dflt
.io
;
376 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_AUTO
;
377 if (!(io
->flags
& CISTPL_IO_8BIT
))
378 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_16
;
379 if (!(io
->flags
& CISTPL_IO_16BIT
))
380 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
381 /* new in dummy.cs 2001/01/28 MN
382 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
384 link
->io
.BasePort1
= io
->win
[0].base
;
385 link
->io
.NumPorts1
= io
->win
[0].len
;
387 link
->io
.Attributes2
= link
->io
.Attributes1
;
388 link
->io
.BasePort2
= io
->win
[1].base
;
389 link
->io
.NumPorts2
= io
->win
[1].len
;
391 /* This reserves IO space but doesn't actually enable it */
392 if (pcmcia_request_io(link
->handle
, &link
->io
) != 0)
397 Now set up a common memory window, if needed. There is room
398 in the dev_link_t structure for one memory window handle,
399 but if the base addresses need to be saved, or if multiple
400 windows are needed, the info should go in the private data
401 structure for this device.
403 Note that the memory window base is a physical address, and
404 needs to be mapped to virtual space with ioremap() before it
407 if ((cfg
->mem
.nwin
> 0) || (dflt
.mem
.nwin
> 0)) {
409 (cfg
->mem
.nwin
) ? &cfg
->mem
: &dflt
.mem
;
410 req
.Attributes
= WIN_DATA_WIDTH_16
|WIN_MEMORY_TYPE_CM
;
411 req
.Attributes
|= WIN_ENABLE
;
412 req
.Base
= mem
->win
[0].host_addr
;
413 req
.Size
= mem
->win
[0].len
;
414 /* new in dummy.cs 2001/01/28 MN
415 if (req.Size < 0x1000)
419 if (pcmcia_request_window(&link
->handle
, &req
, &link
->win
) != 0)
421 map
.Page
= 0; map
.CardOffset
= mem
->win
[0].card_addr
;
422 if (pcmcia_map_mem_page(link
->win
, &map
) != 0)
425 /* If we got this far, we're cool! */
429 /* new in dummy.cs 2001/01/28 MN
430 if (link->io.NumPorts1)
431 pcmcia_release_io(link->handle, &link->io);
433 CS_CHECK(GetNextTuple
, pcmcia_get_next_tuple(handle
, &tuple
));
437 Allocate an interrupt line. Note that this does not assign a
438 handler to the interrupt, unless the 'Handler' member of the
439 irq structure is initialized.
441 if (link
->conf
.Attributes
& CONF_ENABLE_IRQ
)
442 CS_CHECK(RequestIRQ
, pcmcia_request_irq(link
->handle
, &link
->irq
));
445 This actually configures the PCMCIA socket -- setting up
446 the I/O windows and the interrupt mapping, and putting the
447 card and host interface into "Memory and IO" mode.
449 CS_CHECK(RequestConfiguration
, pcmcia_request_configuration(link
->handle
, &link
->conf
));
452 At this point, the dev_node_t structure(s) need to be
453 initialized and arranged in a linked list at link->dev.
455 sprintf(dev
->node
.dev_name
, "sedlbauer");
456 dev
->node
.major
= dev
->node
.minor
= 0;
457 link
->dev
= &dev
->node
;
459 /* Finally, report what we've done */
460 printk(KERN_INFO
"%s: index 0x%02x: Vcc %d.%d",
461 dev
->node
.dev_name
, link
->conf
.ConfigIndex
,
462 link
->conf
.Vcc
/10, link
->conf
.Vcc
%10);
464 printk(", Vpp %d.%d", link
->conf
.Vpp1
/10, link
->conf
.Vpp1
%10);
465 if (link
->conf
.Attributes
& CONF_ENABLE_IRQ
)
466 printk(", irq %d", link
->irq
.AssignedIRQ
);
467 if (link
->io
.NumPorts1
)
468 printk(", io 0x%04x-0x%04x", link
->io
.BasePort1
,
469 link
->io
.BasePort1
+link
->io
.NumPorts1
-1);
470 if (link
->io
.NumPorts2
)
471 printk(" & 0x%04x-0x%04x", link
->io
.BasePort2
,
472 link
->io
.BasePort2
+link
->io
.NumPorts2
-1);
474 printk(", mem 0x%06lx-0x%06lx", req
.Base
,
475 req
.Base
+req
.Size
-1);
478 link
->state
&= ~DEV_CONFIG_PENDING
;
480 icard
.para
[0] = link
->irq
.AssignedIRQ
;
481 icard
.para
[1] = link
->io
.BasePort1
;
482 icard
.protocol
= protocol
;
483 icard
.typ
= ISDN_CTYPE_SEDLBAUER_PCMCIA
;
485 last_ret
= hisax_init_pcmcia(link
, &(((local_info_t
*)link
->priv
)->stop
), &icard
);
487 printk(KERN_ERR
"sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d at i/o %#x\n",
488 last_ret
, link
->io
.BasePort1
);
489 sedlbauer_release(link
);
491 ((local_info_t
*)link
->priv
)->cardnr
= last_ret
;
496 cs_error(link
->handle
, last_fn
, last_ret
);
497 sedlbauer_release(link
);
499 } /* sedlbauer_config */
501 /*======================================================================
503 After a card is removed, sedlbauer_release() will unregister the
504 device, and release the PCMCIA configuration. If the device is
505 still open, this will be postponed until it is closed.
507 ======================================================================*/
509 static void sedlbauer_release(dev_link_t
*link
)
511 local_info_t
*local
= link
->priv
;
512 DEBUG(0, "sedlbauer_release(0x%p)\n", link
);
515 if (local
->cardnr
>= 0) {
516 /* no unregister function with hisax */
517 HiSax_closecard(local
->cardnr
);
520 /* Unlink the device chain */
524 In a normal driver, additional code may be needed to release
525 other kernel data structures associated with this device.
528 /* Don't bother checking to see if these succeed or not */
530 pcmcia_release_window(link
->win
);
531 pcmcia_release_configuration(link
->handle
);
532 if (link
->io
.NumPorts1
)
533 pcmcia_release_io(link
->handle
, &link
->io
);
534 if (link
->irq
.AssignedIRQ
)
535 pcmcia_release_irq(link
->handle
, &link
->irq
);
536 link
->state
&= ~DEV_CONFIG
;
537 } /* sedlbauer_release */
539 static int sedlbauer_suspend(struct pcmcia_device
*p_dev
)
541 dev_link_t
*link
= dev_to_instance(p_dev
);
542 local_info_t
*dev
= link
->priv
;
544 link
->state
|= DEV_SUSPEND
;
546 if (link
->state
& DEV_CONFIG
)
547 pcmcia_release_configuration(link
->handle
);
552 static int sedlbauer_resume(struct pcmcia_device
*p_dev
)
554 dev_link_t
*link
= dev_to_instance(p_dev
);
555 local_info_t
*dev
= link
->priv
;
557 link
->state
&= ~DEV_SUSPEND
;
558 if (link
->state
& DEV_CONFIG
)
559 pcmcia_request_configuration(link
->handle
, &link
->conf
);
565 /*======================================================================
567 The card status event handler. Mostly, this schedules other
568 stuff to run after an event is received.
570 When a CARD_REMOVAL event is received, we immediately set a
571 private flag to block future accesses to this device. All the
572 functions that actually access the device should check this flag
573 to make sure the card is still present.
575 ======================================================================*/
577 static int sedlbauer_event(event_t event
, int priority
,
578 event_callback_args_t
*args
)
580 dev_link_t
*link
= args
->client_data
;
582 DEBUG(1, "sedlbauer_event(0x%06x)\n", event
);
585 case CS_EVENT_CARD_INSERTION
:
586 link
->state
|= DEV_PRESENT
| DEV_CONFIG_PENDING
;
587 sedlbauer_config(link
);
591 } /* sedlbauer_event */
593 static struct pcmcia_device_id sedlbauer_ids
[] = {
594 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
595 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
596 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
597 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
598 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
599 PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
600 /* PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
603 MODULE_DEVICE_TABLE(pcmcia
, sedlbauer_ids
);
605 static struct pcmcia_driver sedlbauer_driver
= {
606 .owner
= THIS_MODULE
,
608 .name
= "sedlbauer_cs",
610 .attach
= sedlbauer_attach
,
611 .event
= sedlbauer_event
,
612 .remove
= sedlbauer_detach
,
613 .id_table
= sedlbauer_ids
,
614 .suspend
= sedlbauer_suspend
,
615 .resume
= sedlbauer_resume
,
618 static int __init
init_sedlbauer_cs(void)
620 return pcmcia_register_driver(&sedlbauer_driver
);
623 static void __exit
exit_sedlbauer_cs(void)
625 pcmcia_unregister_driver(&sedlbauer_driver
);
626 BUG_ON(dev_list
!= NULL
);
629 module_init(init_sedlbauer_cs
);
630 module_exit(exit_sedlbauer_cs
);