blob: a024192b672a3113c0e6663fc1778c5abe4ac6f2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*======================================================================
2
3 A Sedlbauer PCMCIA client driver
4
5 This driver is for the Sedlbauer Speed Star and Speed Star II,
6 which are ISDN PCMCIA Cards.
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 Marcus Niemann
23 <maniemann@users.sourceforge.net>. 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/kernel.h>
39#include <linux/module.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.h>
50#include <pcmcia/cistpl.h>
51#include <pcmcia/cisreg.h>
52#include <pcmcia/ds.h>
53#include "hisax_cfg.h"
54
55MODULE_DESCRIPTION("ISDN4Linux: PCMCIA client driver for Sedlbauer cards");
56MODULE_AUTHOR("Marcus Niemann");
57MODULE_LICENSE("Dual MPL/GPL");
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60/*====================================================================*/
61
62/* Parameters that can be set with 'insmod' */
63
64static int protocol = 2; /* EURO-ISDN Default */
65module_param(protocol, int, 0);
66
67/*====================================================================*/
68
69/*
70 The event() function is this driver's Card Services event handler.
71 It will be called by Card Services when an appropriate card status
72 event is received. The config() and release() entry points are
73 used to configure or release a socket, in response to card
74 insertion and ejection events. They are invoked from the sedlbauer
75 event handler.
76*/
77
Henne93b39a02010-03-25 12:05:29 +000078static int sedlbauer_config(struct pcmcia_device *link) __devinit ;
Dominik Brodowskifba395e2006-03-31 17:21:06 +020079static void sedlbauer_release(struct pcmcia_device *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/*
82 The attach() and detach() entry points are used to create and destroy
83 "instances" of the driver, where each instance represents everything
84 needed to manage one actual PCMCIA card.
85*/
86
Henne93b39a02010-03-25 12:05:29 +000087static void sedlbauer_detach(struct pcmcia_device *p_dev) __devexit;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Linus Torvalds1da177e2005-04-16 15:20:36 -070089typedef struct local_info_t {
Dominik Brodowskifd238232006-03-05 10:45:09 +010090 struct pcmcia_device *p_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 int stop;
92 int cardnr;
93} local_info_t;
94
95/*======================================================================
96
97 sedlbauer_attach() creates an "instance" of the driver, allocating
98 local data structures for one device. The device is registered
99 with Card Services.
100
101 The dev_link structure is initialized, but we don't actually
102 configure the card at this point -- we wait until we receive a
103 card insertion event.
104
105======================================================================*/
106
Henne93b39a02010-03-25 12:05:29 +0000107static int __devinit sedlbauer_probe(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108{
109 local_info_t *local;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200110
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200111 dev_dbg(&link->dev, "sedlbauer_attach()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113 /* Allocate space for private device-specific data */
Burman Yan41f96932006-12-08 02:39:35 -0800114 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100115 if (!local) return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 local->cardnr = -1;
Dominik Brodowskifd238232006-03-05 10:45:09 +0100117
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200118 local->p_dev = link;
Dominik Brodowskifd238232006-03-05 10:45:09 +0100119 link->priv = local;
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 /*
122 General socket configuration defaults can go here. In this
123 client, we assume very little, and rely on the CIS for almost
124 everything. In most clients, many details (i.e., number, sizes,
125 and attributes of IO windows) are fixed by the nature of the
126 device, and can be hard-wired here.
127 */
128
129 /* from old sedl_cs
130 */
131 /* The io structure describes IO port mapping */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200132 link->resource[0]->end = 8;
133 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 link->conf.Attributes = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 link->conf.IntType = INT_MEMORY_AND_IO;
137
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200138 return sedlbauer_config(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139} /* sedlbauer_attach */
140
141/*======================================================================
142
143 This deletes a driver "instance". The device is de-registered
144 with Card Services. If it has been released, all local data
145 structures are freed. Otherwise, the structures will be freed
146 when the device is released.
147
148======================================================================*/
149
Henne93b39a02010-03-25 12:05:29 +0000150static void __devexit sedlbauer_detach(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200152 dev_dbg(&link->dev, "sedlbauer_detach(0x%p)\n", link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100154 ((local_info_t *)link->priv)->stop = 1;
155 sedlbauer_release(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100157 /* This points to the parent local_info_t struct */
158 kfree(link->priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159} /* sedlbauer_detach */
160
161/*======================================================================
162
163 sedlbauer_config() is scheduled to run after a CARD_INSERTION event
164 is received, to configure the PCMCIA socket, and to make the
165 device available to the system.
166
167======================================================================*/
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200168static int sedlbauer_config_check(struct pcmcia_device *p_dev,
169 cistpl_cftable_entry_t *cfg,
Dominik Brodowski8e2fc392008-08-02 15:30:31 +0200170 cistpl_cftable_entry_t *dflt,
Dominik Brodowskiad913c12008-08-02 16:12:00 +0200171 unsigned int vcc,
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200172 void *priv_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200174 if (cfg->index == 0)
175 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 /* Does this card need audio output? */
178 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200179 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
180 p_dev->conf.Status = CCSR_AUDIO_ENA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 }
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 /* Use power settings for Vcc and Vpp if present */
184 /* Note that the CIS values need to be rescaled */
185 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM)) {
Dominik Brodowskiad913c12008-08-02 16:12:00 +0200186 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM]/10000)
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200187 return -ENODEV;
Dominik Brodowski8e2fc392008-08-02 15:30:31 +0200188 } else if (dflt->vcc.present & (1<<CISTPL_POWER_VNOM)) {
Dominik Brodowskiad913c12008-08-02 16:12:00 +0200189 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM]/10000)
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200190 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 }
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200194 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
Dominik Brodowski8e2fc392008-08-02 15:30:31 +0200195 else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
196 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200197
Dominik Brodowskieb141202010-03-07 12:21:16 +0100198 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 /* IO window settings */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200201 p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
Dominik Brodowski8e2fc392008-08-02 15:30:31 +0200202 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
203 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200204 p_dev->resource[0]->start = io->win[0].base;
205 p_dev->resource[0]->end = io->win[0].len;
206 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
207 p_dev->resource[0]->flags |=
208 pcmcia_io_cfg_data_width(io->flags);
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200209 if (io->nwin > 1) {
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200210 p_dev->resource[1]->flags = p_dev->resource[0]->flags;
211 p_dev->resource[1]->start = io->win[1].base;
212 p_dev->resource[1]->end = io->win[1].len;
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200213 }
214 /* This reserves IO space but doesn't actually enable it */
Dominik Brodowski90abdc32010-07-24 17:23:51 +0200215 p_dev->io_lines = 3;
216 if (pcmcia_request_io(p_dev) != 0)
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200217 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 }
219
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200220 return 0;
221}
Dominik Brodowski50db3fd2006-01-15 10:05:19 +0100222
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200223
224
Henne93b39a02010-03-25 12:05:29 +0000225static int __devinit sedlbauer_config(struct pcmcia_device *link)
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200226{
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200227 int ret;
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200228 IsdnCard_t icard;
229
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200230 dev_dbg(&link->dev, "sedlbauer_config(0x%p)\n", link);
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200231
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200232 /*
233 In this loop, we scan the CIS for configuration table entries,
234 each of which describes a valid card configuration, including
235 voltage, IO window, memory window, and interrupt settings.
236
237 We make no assumptions about the card to be configured: we use
238 just the information available in the CIS. In an ideal world,
239 this would work for any PCMCIA card, but it requires a complete
240 and accurate CIS. In practice, a driver usually "knows" most of
241 these things without consulting the CIS, and most client drivers
242 will only use the CIS to fill in implementation-defined details.
243 */
Dominik Brodowski0f52e862010-07-28 09:32:02 +0200244 ret = pcmcia_loop_config(link, sedlbauer_config_check, NULL);
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200245 if (ret)
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200246 goto failed;
Dominik Brodowski50db3fd2006-01-15 10:05:19 +0100247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 This actually configures the PCMCIA socket -- setting up
250 the I/O windows and the interrupt mapping, and putting the
251 card and host interface into "Memory and IO" mode.
252 */
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200253 ret = pcmcia_request_configuration(link, &link->conf);
254 if (ret)
255 goto failed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 /* Finally, report what we've done */
Dominik Brodowskided6a1a2010-03-20 19:35:12 +0100258 dev_info(&link->dev, "index 0x%02x:",
259 link->conf.ConfigIndex);
Dominik Brodowski70294b42006-01-15 12:43:16 +0100260 if (link->conf.Vpp)
261 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 if (link->conf.Attributes & CONF_ENABLE_IRQ)
Dominik Brodowskieb141202010-03-07 12:21:16 +0100263 printk(", irq %d", link->irq);
Dominik Brodowski9a017a92010-07-24 15:58:54 +0200264 if (link->resource[0])
265 printk(" & %pR", link->resource[0]);
266 if (link->resource[1])
267 printk(" & %pR", link->resource[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 printk("\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Dominik Brodowskieb141202010-03-07 12:21:16 +0100270 icard.para[0] = link->irq;
Dominik Brodowski9a017a92010-07-24 15:58:54 +0200271 icard.para[1] = link->resource[0]->start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 icard.protocol = protocol;
273 icard.typ = ISDN_CTYPE_SEDLBAUER_PCMCIA;
274
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200275 ret = hisax_init_pcmcia(link,
276 &(((local_info_t *)link->priv)->stop), &icard);
277 if (ret < 0) {
Dominik Brodowski9a017a92010-07-24 15:58:54 +0200278 printk(KERN_ERR "sedlbauer_cs: failed to initialize SEDLBAUER PCMCIA %d with %pR\n",
279 ret, link->resource[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 sedlbauer_release(link);
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200281 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 } else
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200283 ((local_info_t *)link->priv)->cardnr = ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200285 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Dominik Brodowski5fcd4da2008-07-29 08:38:55 +0200287failed:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 sedlbauer_release(link);
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200289 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291} /* sedlbauer_config */
292
293/*======================================================================
294
295 After a card is removed, sedlbauer_release() will unregister the
296 device, and release the PCMCIA configuration. If the device is
297 still open, this will be postponed until it is closed.
298
299======================================================================*/
300
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200301static void sedlbauer_release(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302{
303 local_info_t *local = link->priv;
Dominik Brodowskie773cfe2009-10-24 15:50:13 +0200304 dev_dbg(&link->dev, "sedlbauer_release(0x%p)\n", link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 if (local) {
307 if (local->cardnr >= 0) {
308 /* no unregister function with hisax */
309 HiSax_closecard(local->cardnr);
310 }
311 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200313 pcmcia_disable_device(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314} /* sedlbauer_release */
315
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200316static int sedlbauer_suspend(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100317{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100318 local_info_t *dev = link->priv;
319
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100320 dev->stop = 1;
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100321
322 return 0;
323}
324
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200325static int sedlbauer_resume(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100326{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100327 local_info_t *dev = link->priv;
328
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100329 dev->stop = 0;
330
331 return 0;
332}
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Dominik Brodowski70799732005-06-27 16:28:41 -0700335static struct pcmcia_device_id sedlbauer_ids[] = {
Karsten Keil84d370b2005-09-14 14:19:13 -0700336 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "speed star II", "V 3.1", 0x81fb79f5, 0xf3612e1d, 0x6b95c78a),
Dominik Brodowski70799732005-06-27 16:28:41 -0700337 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D67", 0x81fb79f5, 0xe4e9bc12, 0x397b7e90),
338 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", "4D98", 0x81fb79f5, 0xe4e9bc12, 0x2e5c7fce),
339 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (C) 93-94 VK", 0x81fb79f5, 0xe4e9bc12, 0x8db143fe),
340 PCMCIA_DEVICE_PROD_ID123("SEDLBAUER", "ISDN-Adapter", " (c) 93-95 VK", 0x81fb79f5, 0xe4e9bc12, 0xb391ab4c),
341 PCMCIA_DEVICE_PROD_ID12("HST High Soft Tech GmbH", "Saphir II B", 0xd79e0b84, 0x21d083ae),
342/* PCMCIA_DEVICE_PROD_ID1234("SEDLBAUER", 0x81fb79f5), */ /* too generic*/
343 PCMCIA_DEVICE_NULL
344};
345MODULE_DEVICE_TABLE(pcmcia, sedlbauer_ids);
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347static struct pcmcia_driver sedlbauer_driver = {
348 .owner = THIS_MODULE,
349 .drv = {
350 .name = "sedlbauer_cs",
351 },
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200352 .probe = sedlbauer_probe,
Henne93b39a02010-03-25 12:05:29 +0000353 .remove = __devexit_p(sedlbauer_detach),
Dominik Brodowski70799732005-06-27 16:28:41 -0700354 .id_table = sedlbauer_ids,
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100355 .suspend = sedlbauer_suspend,
356 .resume = sedlbauer_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357};
358
359static int __init init_sedlbauer_cs(void)
360{
361 return pcmcia_register_driver(&sedlbauer_driver);
362}
363
364static void __exit exit_sedlbauer_cs(void)
365{
366 pcmcia_unregister_driver(&sedlbauer_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
368
369module_init(init_sedlbauer_cs);
370module_exit(exit_sedlbauer_cs);