2 * Driver for 802.11b cards using RAM-loadable Symbol firmware, such as
3 * Symbol Wireless Networker LA4137, CompactFlash cards by Socket
4 * Communications and Intel PRO/Wireless 2011B.
6 * The driver implements Symbol firmware download. The rest is handled
7 * in hermes.c and main.c.
9 * Utilities for downloading the Symbol firmware are available at
10 * http://sourceforge.net/projects/orinoco/
12 * Copyright (C) 2002-2005 Pavel Roskin <proski@gnu.org>
13 * Portions based on orinoco_cs.c:
14 * Copyright (C) David Gibson, Linuxcare Australia
15 * Portions based on Spectrum24tDnld.c from original spectrum24 driver:
16 * Copyright (C) Symbol Technologies.
18 * See copyright notice in file main.c.
21 #define DRIVER_NAME "spectrum_cs"
22 #define PFX DRIVER_NAME ": "
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/init.h>
27 #include <linux/delay.h>
28 #include <pcmcia/cs_types.h>
29 #include <pcmcia/cs.h>
30 #include <pcmcia/cistpl.h>
31 #include <pcmcia/cisreg.h>
32 #include <pcmcia/ds.h>
36 /********************************************************************/
38 /********************************************************************/
40 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
41 MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
42 MODULE_LICENSE("Dual MPL/GPL");
44 /* Module parameters */
46 /* Some D-Link cards have buggy CIS. They do work at 5v properly, but
47 * don't have any CIS entry for it. This workaround it... */
48 static int ignore_cis_vcc; /* = 0 */
49 module_param(ignore_cis_vcc, int, 0);
50 MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");
52 /********************************************************************/
54 /********************************************************************/
56 /* PCMCIA specific device information (goes in the card field of
57 * struct orinoco_private */
58 struct orinoco_pccard {
59 struct pcmcia_device *p_dev;
63 /********************************************************************/
64 /* Function prototypes */
65 /********************************************************************/
67 static int spectrum_cs_config(struct pcmcia_device *link);
68 static void spectrum_cs_release(struct pcmcia_device *link);
70 /* Constants for the CISREG_CCSR register */
71 #define HCR_RUN 0x07 /* run firmware after reset */
72 #define HCR_IDLE 0x0E /* don't run firmware after reset */
73 #define HCR_MEM16 0x10 /* memory width bit, should be preserved */
77 * Reset the card using configuration registers COR and CCSR.
78 * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
81 spectrum_reset(struct pcmcia_device *link, int idle)
87 /* Doing it if hardware is gone is guaranteed crash */
88 if (!pcmcia_dev_present(link))
91 /* Save original COR value */
94 reg.Offset = CISREG_COR;
95 ret = pcmcia_access_configuration_register(link, ®);
100 /* Soft-Reset card */
101 reg.Action = CS_WRITE;
102 reg.Offset = CISREG_COR;
103 reg.Value = (save_cor | COR_SOFT_RESET);
104 ret = pcmcia_access_configuration_register(link, ®);
110 reg.Action = CS_READ;
111 reg.Offset = CISREG_CCSR;
112 ret = pcmcia_access_configuration_register(link, ®);
117 * Start or stop the firmware. Memory width bit should be
118 * preserved from the value we've just read.
120 reg.Action = CS_WRITE;
121 reg.Offset = CISREG_CCSR;
122 reg.Value = (idle ? HCR_IDLE : HCR_RUN) | (reg.Value & HCR_MEM16);
123 ret = pcmcia_access_configuration_register(link, ®);
128 /* Restore original COR configuration index */
129 reg.Action = CS_WRITE;
130 reg.Offset = CISREG_COR;
131 reg.Value = (save_cor & ~COR_SOFT_RESET);
132 ret = pcmcia_access_configuration_register(link, ®);
142 /********************************************************************/
144 /********************************************************************/
147 spectrum_cs_hard_reset(struct orinoco_private *priv)
149 struct orinoco_pccard *card = priv->card;
150 struct pcmcia_device *link = card->p_dev;
152 /* Soft reset using COR and HCR */
153 spectrum_reset(link, 0);
159 spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle)
161 struct orinoco_pccard *card = priv->card;
162 struct pcmcia_device *link = card->p_dev;
164 return spectrum_reset(link, idle);
167 /********************************************************************/
169 /********************************************************************/
172 * This creates an "instance" of the driver, allocating local data
173 * structures for one device. The device is registered with Card
176 * The dev_link structure is initialized, but we don't actually
177 * configure the card at this point -- we wait until we receive a card
178 * insertion event. */
180 spectrum_cs_probe(struct pcmcia_device *link)
182 struct orinoco_private *priv;
183 struct orinoco_pccard *card;
185 priv = alloc_orinocodev(sizeof(*card), &link->dev,
186 spectrum_cs_hard_reset,
187 spectrum_cs_stop_firmware);
192 /* Link both structures together */
196 /* Interrupt setup */
197 link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
198 link->irq.Handler = orinoco_interrupt;
200 /* General socket configuration defaults can go here. In this
201 * client, we assume very little, and rely on the CIS for
202 * almost everything. In most clients, many details (i.e.,
203 * number, sizes, and attributes of IO windows) are fixed by
204 * the nature of the device, and can be hard-wired here. */
205 link->conf.Attributes = 0;
206 link->conf.IntType = INT_MEMORY_AND_IO;
208 return spectrum_cs_config(link);
209 } /* spectrum_cs_attach */
212 * This deletes a driver "instance". The device is de-registered with
213 * Card Services. If it has been released, all local data structures
214 * are freed. Otherwise, the structures will be freed when the device
217 static void spectrum_cs_detach(struct pcmcia_device *link)
219 struct orinoco_private *priv = link->priv;
222 orinoco_if_del(priv);
224 spectrum_cs_release(link);
226 free_orinocodev(priv);
227 } /* spectrum_cs_detach */
230 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
231 * event is received, to configure the PCMCIA socket, and to make the
232 * device available to the system.
235 static int spectrum_cs_config_check(struct pcmcia_device *p_dev,
236 cistpl_cftable_entry_t *cfg,
237 cistpl_cftable_entry_t *dflt,
244 /* Use power settings for Vcc and Vpp if present */
245 /* Note that the CIS values need to be rescaled */
246 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
247 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000) {
248 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
250 cfg->vcc.param[CISTPL_POWER_VNOM] / 10000);
254 } else if (dflt->vcc.present & (1 << CISTPL_POWER_VNOM)) {
255 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM] / 10000) {
256 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
258 dflt->vcc.param[CISTPL_POWER_VNOM] / 10000);
264 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
266 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
267 else if (dflt->vpp1.present & (1 << CISTPL_POWER_VNOM))
269 dflt->vpp1.param[CISTPL_POWER_VNOM] / 10000;
271 /* Do we need to allocate an interrupt? */
272 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
274 /* IO window settings */
275 p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
276 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
277 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
278 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
279 if (!(io->flags & CISTPL_IO_8BIT))
280 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
281 if (!(io->flags & CISTPL_IO_16BIT))
282 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
283 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
284 p_dev->io.BasePort1 = io->win[0].base;
285 p_dev->io.NumPorts1 = io->win[0].len;
287 p_dev->io.Attributes2 = p_dev->io.Attributes1;
288 p_dev->io.BasePort2 = io->win[1].base;
289 p_dev->io.NumPorts2 = io->win[1].len;
292 /* This reserves IO space but doesn't actually enable it */
293 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
299 pcmcia_disable_device(p_dev);
304 spectrum_cs_config(struct pcmcia_device *link)
306 struct orinoco_private *priv = link->priv;
307 struct orinoco_pccard *card = priv->card;
308 hermes_t *hw = &priv->hw;
313 * In this loop, we scan the CIS for configuration table
314 * entries, each of which describes a valid card
315 * configuration, including voltage, IO window, memory window,
316 * and interrupt settings.
318 * We make no assumptions about the card to be configured: we
319 * use just the information available in the CIS. In an ideal
320 * world, this would work for any PCMCIA card, but it requires
321 * a complete and accurate CIS. In practice, a driver usually
322 * "knows" most of these things without consulting the CIS,
323 * and most client drivers will only use the CIS to fill in
324 * implementation-defined details.
326 ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL);
329 printk(KERN_ERR PFX "GetNextTuple(): No matching "
330 "CIS configuration. Maybe you need the "
331 "ignore_cis_vcc=1 parameter.\n");
336 * Allocate an interrupt line. Note that this does not assign
337 * a handler to the interrupt, unless the 'Handler' member of
338 * the irq structure is initialized.
340 ret = pcmcia_request_irq(link, &link->irq);
344 /* We initialize the hermes structure before completing PCMCIA
345 * configuration just in case the interrupt handler gets
347 mem = ioport_map(link->io.BasePort1, link->io.NumPorts1);
351 hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
352 hw->eeprom_pda = true;
355 * This actually configures the PCMCIA socket -- setting up
356 * the I/O windows and the interrupt mapping, and putting the
357 * card and host interface into "Memory and IO" mode.
359 ret = pcmcia_request_configuration(link, &link->conf);
363 /* Ok, we have the configuration, prepare to register the netdev */
364 card->node.major = card->node.minor = 0;
367 if (spectrum_cs_hard_reset(priv) != 0)
370 /* Initialise the main driver */
371 if (orinoco_init(priv) != 0) {
372 printk(KERN_ERR PFX "orinoco_init() failed\n");
376 /* Register an interface with the stack */
377 if (orinoco_if_add(priv, link->io.BasePort1,
378 link->irq.AssignedIRQ, NULL) != 0) {
379 printk(KERN_ERR PFX "orinoco_if_add() failed\n");
383 /* At this point, the dev_node_t structure(s) needs to be
384 * initialized and arranged in a linked list at link->dev_node. */
385 strcpy(card->node.dev_name, priv->ndev->name);
386 link->dev_node = &card->node; /* link->dev_node being non-NULL is also
387 * used to indicate that the
388 * net_device has been registered */
392 spectrum_cs_release(link);
394 } /* spectrum_cs_config */
397 * After a card is removed, spectrum_cs_release() will unregister the
398 * device, and release the PCMCIA configuration. If the device is
399 * still open, this will be postponed until it is closed.
402 spectrum_cs_release(struct pcmcia_device *link)
404 struct orinoco_private *priv = link->priv;
407 /* We're committed to taking the device away now, so mark the
408 * hardware as unavailable */
409 priv->hw.ops->lock_irqsave(&priv->lock, &flags);
410 priv->hw_unavailable++;
411 priv->hw.ops->unlock_irqrestore(&priv->lock, &flags);
413 pcmcia_disable_device(link);
415 ioport_unmap(priv->hw.iobase);
416 } /* spectrum_cs_release */
420 spectrum_cs_suspend(struct pcmcia_device *link)
422 struct orinoco_private *priv = link->priv;
425 /* Mark the device as stopped, to block IO until later */
432 spectrum_cs_resume(struct pcmcia_device *link)
434 struct orinoco_private *priv = link->priv;
435 int err = orinoco_up(priv);
441 /********************************************************************/
442 /* Module initialization */
443 /********************************************************************/
445 /* Can't be declared "const" or the whole __initdata section will
447 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
448 " (Pavel Roskin <proski@gnu.org>,"
449 " David Gibson <hermes@gibson.dropbear.id.au>, et al)";
451 static struct pcmcia_device_id spectrum_cs_ids[] = {
452 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
453 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
454 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
457 MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);
459 static struct pcmcia_driver orinoco_driver = {
460 .owner = THIS_MODULE,
464 .probe = spectrum_cs_probe,
465 .remove = spectrum_cs_detach,
466 .suspend = spectrum_cs_suspend,
467 .resume = spectrum_cs_resume,
468 .id_table = spectrum_cs_ids,
472 init_spectrum_cs(void)
474 printk(KERN_DEBUG "%s\n", version);
476 return pcmcia_register_driver(&orinoco_driver);
480 exit_spectrum_cs(void)
482 pcmcia_unregister_driver(&orinoco_driver);
485 module_init(init_spectrum_cs);
486 module_exit(exit_spectrum_cs);