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 orinoco.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 orinoco.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 <linux/firmware.h>
29 #include <pcmcia/cs_types.h>
30 #include <pcmcia/cs.h>
31 #include <pcmcia/cistpl.h>
32 #include <pcmcia/cisreg.h>
33 #include <pcmcia/ds.h>
36 #include "hermes_dld.h"
38 static const char primary_fw_name[] = "symbol_sp24t_prim_fw";
39 static const char secondary_fw_name[] = "symbol_sp24t_sec_fw";
41 /********************************************************************/
43 /********************************************************************/
45 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
46 MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
47 MODULE_LICENSE("Dual MPL/GPL");
49 /* Module parameters */
51 /* Some D-Link cards have buggy CIS. They do work at 5v properly, but
52 * don't have any CIS entry for it. This workaround it... */
53 static int ignore_cis_vcc; /* = 0 */
54 module_param(ignore_cis_vcc, int, 0);
55 MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");
57 /********************************************************************/
59 /********************************************************************/
61 /* PCMCIA specific device information (goes in the card field of
62 * struct orinoco_private */
63 struct orinoco_pccard {
64 struct pcmcia_device *p_dev;
68 /********************************************************************/
69 /* Function prototypes */
70 /********************************************************************/
72 static int spectrum_cs_config(struct pcmcia_device *link);
73 static void spectrum_cs_release(struct pcmcia_device *link);
75 /********************************************************************/
76 /* Firmware downloader */
77 /********************************************************************/
79 /* Position of PDA in the adapter memory */
80 #define EEPROM_ADDR 0x3000
81 #define EEPROM_LEN 0x200
82 #define PDA_OFFSET 0x100
84 #define PDA_ADDR (EEPROM_ADDR + PDA_OFFSET)
85 #define PDA_WORDS ((EEPROM_LEN - PDA_OFFSET) / 2)
87 /* Constants for the CISREG_CCSR register */
88 #define HCR_RUN 0x07 /* run firmware after reset */
89 #define HCR_IDLE 0x0E /* don't run firmware after reset */
90 #define HCR_MEM16 0x10 /* memory width bit, should be preserved */
93 #define TEXT_END 0x1A /* End of text header */
96 #define CS_CHECK(fn, ret) \
97 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
100 * Reset the card using configuration registers COR and CCSR.
101 * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
104 spectrum_reset(struct pcmcia_device *link, int idle)
106 int last_ret, last_fn;
110 /* Doing it if hardware is gone is guaranteed crash */
111 if (!pcmcia_dev_present(link))
114 /* Save original COR value */
116 reg.Action = CS_READ;
117 reg.Offset = CISREG_COR;
118 CS_CHECK(AccessConfigurationRegister,
119 pcmcia_access_configuration_register(link, ®));
120 save_cor = reg.Value;
122 /* Soft-Reset card */
123 reg.Action = CS_WRITE;
124 reg.Offset = CISREG_COR;
125 reg.Value = (save_cor | COR_SOFT_RESET);
126 CS_CHECK(AccessConfigurationRegister,
127 pcmcia_access_configuration_register(link, ®));
131 reg.Action = CS_READ;
132 reg.Offset = CISREG_CCSR;
133 CS_CHECK(AccessConfigurationRegister,
134 pcmcia_access_configuration_register(link, ®));
137 * Start or stop the firmware. Memory width bit should be
138 * preserved from the value we've just read.
140 reg.Action = CS_WRITE;
141 reg.Offset = CISREG_CCSR;
142 reg.Value = (idle ? HCR_IDLE : HCR_RUN) | (reg.Value & HCR_MEM16);
143 CS_CHECK(AccessConfigurationRegister,
144 pcmcia_access_configuration_register(link, ®));
147 /* Restore original COR configuration index */
148 reg.Action = CS_WRITE;
149 reg.Offset = CISREG_COR;
150 reg.Value = (save_cor & ~COR_SOFT_RESET);
151 CS_CHECK(AccessConfigurationRegister,
152 pcmcia_access_configuration_register(link, ®));
157 cs_error(link, last_fn, last_ret);
163 * Process a firmware image - stop the card, load the firmware, reset
164 * the card and make sure it responds. For the secondary firmware take
165 * care of the PDA - read it and then write it on top of the firmware.
168 spectrum_dl_image(hermes_t *hw, struct pcmcia_device *link,
169 const unsigned char *image, const unsigned char *end,
173 const unsigned char *ptr;
174 const unsigned char *first_block;
176 /* Plug Data Area (PDA) */
177 __le16 pda[PDA_WORDS];
179 /* Binary block begins after the 0x1A marker */
181 while (*ptr++ != TEXT_END);
184 /* Read the PDA from EEPROM */
186 ret = hermes_read_pda(hw, pda, PDA_ADDR, sizeof(pda), 1);
191 /* Stop the firmware, so that it can be safely rewritten */
192 ret = spectrum_reset(link, 1);
196 /* Program the adapter with new firmware */
197 ret = hermes_program(hw, first_block, end);
201 /* Write the PDA to the adapter */
203 size_t len = hermes_blocks_length(first_block);
204 ptr = first_block + len;
205 ret = hermes_apply_pda(hw, ptr, pda);
210 /* Run the firmware */
211 ret = spectrum_reset(link, 0);
215 /* Reset hermes chip and make sure it responds */
216 ret = hermes_init(hw);
218 /* hermes_reset() should return 0 with the secondary firmware */
219 if (secondary && ret != 0)
222 /* And this should work with any firmware */
223 if (!hermes_present(hw))
231 * Download the firmware into the card, this also does a PCMCIA soft
232 * reset on the card, to make sure it's in a sane state.
235 spectrum_dl_firmware(hermes_t *hw, struct pcmcia_device *link)
238 const struct firmware *fw_entry;
240 if (request_firmware(&fw_entry, primary_fw_name,
241 &handle_to_dev(link)) != 0) {
242 printk(KERN_ERR PFX "Cannot find firmware: %s\n",
247 /* Load primary firmware */
248 ret = spectrum_dl_image(hw, link, fw_entry->data,
249 fw_entry->data + fw_entry->size, 0);
250 release_firmware(fw_entry);
252 printk(KERN_ERR PFX "Primary firmware download failed\n");
256 if (request_firmware(&fw_entry, secondary_fw_name,
257 &handle_to_dev(link)) != 0) {
258 printk(KERN_ERR PFX "Cannot find firmware: %s\n",
263 /* Load secondary firmware */
264 ret = spectrum_dl_image(hw, link, fw_entry->data,
265 fw_entry->data + fw_entry->size, 1);
266 release_firmware(fw_entry);
268 printk(KERN_ERR PFX "Secondary firmware download failed\n");
274 /********************************************************************/
276 /********************************************************************/
279 spectrum_cs_hard_reset(struct orinoco_private *priv)
281 struct orinoco_pccard *card = priv->card;
282 struct pcmcia_device *link = card->p_dev;
285 if (!hermes_present(&priv->hw)) {
286 /* The firmware needs to be reloaded */
287 if (spectrum_dl_firmware(&priv->hw, link) != 0) {
288 printk(KERN_ERR PFX "Firmware download failed\n");
292 /* Soft reset using COR and HCR */
293 spectrum_reset(link, 0);
299 /********************************************************************/
301 /********************************************************************/
304 * This creates an "instance" of the driver, allocating local data
305 * structures for one device. The device is registered with Card
308 * The dev_link structure is initialized, but we don't actually
309 * configure the card at this point -- we wait until we receive a card
310 * insertion event. */
312 spectrum_cs_probe(struct pcmcia_device *link)
314 struct net_device *dev;
315 struct orinoco_private *priv;
316 struct orinoco_pccard *card;
318 dev = alloc_orinocodev(sizeof(*card), spectrum_cs_hard_reset);
321 priv = netdev_priv(dev);
324 /* Link both structures together */
328 /* Interrupt setup */
329 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
330 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
331 link->irq.Handler = orinoco_interrupt;
332 link->irq.Instance = dev;
334 /* General socket configuration defaults can go here. In this
335 * client, we assume very little, and rely on the CIS for
336 * almost everything. In most clients, many details (i.e.,
337 * number, sizes, and attributes of IO windows) are fixed by
338 * the nature of the device, and can be hard-wired here. */
339 link->conf.Attributes = 0;
340 link->conf.IntType = INT_MEMORY_AND_IO;
342 return spectrum_cs_config(link);
343 } /* spectrum_cs_attach */
346 * This deletes a driver "instance". The device is de-registered with
347 * Card Services. If it has been released, all local data structures
348 * are freed. Otherwise, the structures will be freed when the device
351 static void spectrum_cs_detach(struct pcmcia_device *link)
353 struct net_device *dev = link->priv;
356 unregister_netdev(dev);
358 spectrum_cs_release(link);
360 free_orinocodev(dev);
361 } /* spectrum_cs_detach */
364 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
365 * event is received, to configure the PCMCIA socket, and to make the
366 * device available to the system.
370 spectrum_cs_config(struct pcmcia_device *link)
372 struct net_device *dev = link->priv;
373 struct orinoco_private *priv = netdev_priv(dev);
374 struct orinoco_pccard *card = priv->card;
375 hermes_t *hw = &priv->hw;
376 int last_fn, last_ret;
383 /* Look up the current Vcc */
384 CS_CHECK(GetConfigurationInfo,
385 pcmcia_get_configuration_info(link, &conf));
388 * In this loop, we scan the CIS for configuration table
389 * entries, each of which describes a valid card
390 * configuration, including voltage, IO window, memory window,
391 * and interrupt settings.
393 * We make no assumptions about the card to be configured: we
394 * use just the information available in the CIS. In an ideal
395 * world, this would work for any PCMCIA card, but it requires
396 * a complete and accurate CIS. In practice, a driver usually
397 * "knows" most of these things without consulting the CIS,
398 * and most client drivers will only use the CIS to fill in
399 * implementation-defined details.
401 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
402 tuple.Attributes = 0;
403 tuple.TupleData = buf;
404 tuple.TupleDataMax = sizeof(buf);
405 tuple.TupleOffset = 0;
406 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
408 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
409 cistpl_cftable_entry_t dflt = { .index = 0 };
411 if ( (pcmcia_get_tuple_data(link, &tuple) != 0)
412 || (pcmcia_parse_tuple(link, &tuple, &parse) != 0))
415 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
419 link->conf.ConfigIndex = cfg->index;
421 /* Use power settings for Vcc and Vpp if present */
422 /* Note that the CIS values need to be rescaled */
423 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
424 if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000) {
425 DEBUG(2, "spectrum_cs_config: Vcc mismatch (conf.Vcc = %d, CIS = %d)\n", conf.Vcc, cfg->vcc.param[CISTPL_POWER_VNOM] / 10000);
429 } else if (dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
430 if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM] / 10000) {
431 DEBUG(2, "spectrum_cs_config: Vcc mismatch (conf.Vcc = %d, CIS = %d)\n", conf.Vcc, dflt.vcc.param[CISTPL_POWER_VNOM] / 10000);
437 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
439 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
440 else if (dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
442 dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
444 /* Do we need to allocate an interrupt? */
445 link->conf.Attributes |= CONF_ENABLE_IRQ;
447 /* IO window settings */
448 link->io.NumPorts1 = link->io.NumPorts2 = 0;
449 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
451 (cfg->io.nwin) ? &cfg->io : &dflt.io;
452 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
453 if (!(io->flags & CISTPL_IO_8BIT))
454 link->io.Attributes1 =
455 IO_DATA_PATH_WIDTH_16;
456 if (!(io->flags & CISTPL_IO_16BIT))
457 link->io.Attributes1 =
458 IO_DATA_PATH_WIDTH_8;
459 link->io.IOAddrLines =
460 io->flags & CISTPL_IO_LINES_MASK;
461 link->io.BasePort1 = io->win[0].base;
462 link->io.NumPorts1 = io->win[0].len;
464 link->io.Attributes2 =
465 link->io.Attributes1;
466 link->io.BasePort2 = io->win[1].base;
467 link->io.NumPorts2 = io->win[1].len;
470 /* This reserves IO space but doesn't actually enable it */
471 if (pcmcia_request_io(link, &link->io) != 0)
476 /* If we got this far, we're cool! */
481 pcmcia_disable_device(link);
482 last_ret = pcmcia_get_next_tuple(link, &tuple);
483 if (last_ret == CS_NO_MORE_ITEMS) {
484 printk(KERN_ERR PFX "GetNextTuple(): No matching "
485 "CIS configuration. Maybe you need the "
486 "ignore_cis_vcc=1 parameter.\n");
492 * Allocate an interrupt line. Note that this does not assign
493 * a handler to the interrupt, unless the 'Handler' member of
494 * the irq structure is initialized.
496 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
498 /* We initialize the hermes structure before completing PCMCIA
499 * configuration just in case the interrupt handler gets
501 mem = ioport_map(link->io.BasePort1, link->io.NumPorts1);
505 hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
508 * This actually configures the PCMCIA socket -- setting up
509 * the I/O windows and the interrupt mapping, and putting the
510 * card and host interface into "Memory and IO" mode.
512 CS_CHECK(RequestConfiguration,
513 pcmcia_request_configuration(link, &link->conf));
515 /* Ok, we have the configuration, prepare to register the netdev */
516 dev->base_addr = link->io.BasePort1;
517 dev->irq = link->irq.AssignedIRQ;
518 card->node.major = card->node.minor = 0;
520 /* Reset card and download firmware */
521 if (spectrum_cs_hard_reset(priv) != 0) {
525 SET_NETDEV_DEV(dev, &handle_to_dev(link));
526 /* Tell the stack we exist */
527 if (register_netdev(dev) != 0) {
528 printk(KERN_ERR PFX "register_netdev() failed\n");
532 /* At this point, the dev_node_t structure(s) needs to be
533 * initialized and arranged in a linked list at link->dev_node. */
534 strcpy(card->node.dev_name, dev->name);
535 link->dev_node = &card->node; /* link->dev_node being non-NULL is also
536 used to indicate that the
537 net_device has been registered */
539 /* Finally, report what we've done */
540 printk(KERN_DEBUG "%s: " DRIVER_NAME " at %s, irq %d, io "
541 "0x%04x-0x%04x\n", dev->name, dev->dev.parent->bus_id,
542 link->irq.AssignedIRQ, link->io.BasePort1,
543 link->io.BasePort1 + link->io.NumPorts1 - 1);
548 cs_error(link, last_fn, last_ret);
551 spectrum_cs_release(link);
553 } /* spectrum_cs_config */
556 * After a card is removed, spectrum_cs_release() will unregister the
557 * device, and release the PCMCIA configuration. If the device is
558 * still open, this will be postponed until it is closed.
561 spectrum_cs_release(struct pcmcia_device *link)
563 struct net_device *dev = link->priv;
564 struct orinoco_private *priv = netdev_priv(dev);
567 /* We're committed to taking the device away now, so mark the
568 * hardware as unavailable */
569 spin_lock_irqsave(&priv->lock, flags);
570 priv->hw_unavailable++;
571 spin_unlock_irqrestore(&priv->lock, flags);
573 pcmcia_disable_device(link);
575 ioport_unmap(priv->hw.iobase);
576 } /* spectrum_cs_release */
580 spectrum_cs_suspend(struct pcmcia_device *link)
582 struct net_device *dev = link->priv;
583 struct orinoco_private *priv = netdev_priv(dev);
586 /* Mark the device as stopped, to block IO until later */
587 spin_lock(&priv->lock);
589 err = __orinoco_down(dev);
591 printk(KERN_WARNING "%s: Error %d downing interface\n",
594 netif_device_detach(dev);
595 priv->hw_unavailable++;
597 spin_unlock(&priv->lock);
603 spectrum_cs_resume(struct pcmcia_device *link)
605 struct net_device *dev = link->priv;
606 struct orinoco_private *priv = netdev_priv(dev);
608 netif_device_attach(dev);
609 priv->hw_unavailable--;
610 schedule_work(&priv->reset_work);
616 /********************************************************************/
617 /* Module initialization */
618 /********************************************************************/
620 /* Can't be declared "const" or the whole __initdata section will
622 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
623 " (Pavel Roskin <proski@gnu.org>,"
624 " David Gibson <hermes@gibson.dropbear.id.au>, et al)";
626 static struct pcmcia_device_id spectrum_cs_ids[] = {
627 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
628 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
629 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
632 MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);
634 static struct pcmcia_driver orinoco_driver = {
635 .owner = THIS_MODULE,
639 .probe = spectrum_cs_probe,
640 .remove = spectrum_cs_detach,
641 .suspend = spectrum_cs_suspend,
642 .resume = spectrum_cs_resume,
643 .id_table = spectrum_cs_ids,
647 init_spectrum_cs(void)
649 printk(KERN_DEBUG "%s\n", version);
651 return pcmcia_register_driver(&orinoco_driver);
655 exit_spectrum_cs(void)
657 pcmcia_unregister_driver(&orinoco_driver);
660 module_init(init_spectrum_cs);
661 module_exit(exit_spectrum_cs);