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/cistpl.h>
29 #include <pcmcia/cisreg.h>
30 #include <pcmcia/ds.h>
34 /********************************************************************/
36 /********************************************************************/
38 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
39 MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
40 MODULE_LICENSE("Dual MPL/GPL");
42 /* Module parameters */
44 /* Some D-Link cards have buggy CIS. They do work at 5v properly, but
45 * don't have any CIS entry for it. This workaround it... */
46 static int ignore_cis_vcc; /* = 0 */
47 module_param(ignore_cis_vcc, int, 0);
48 MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");
50 /********************************************************************/
52 /********************************************************************/
54 /* PCMCIA specific device information (goes in the card field of
55 * struct orinoco_private */
56 struct orinoco_pccard {
57 struct pcmcia_device *p_dev;
60 /********************************************************************/
61 /* Function prototypes */
62 /********************************************************************/
64 static int spectrum_cs_config(struct pcmcia_device *link);
65 static void spectrum_cs_release(struct pcmcia_device *link);
67 /* Constants for the CISREG_CCSR register */
68 #define HCR_RUN 0x07 /* run firmware after reset */
69 #define HCR_IDLE 0x0E /* don't run firmware after reset */
70 #define HCR_MEM16 0x10 /* memory width bit, should be preserved */
74 * Reset the card using configuration registers COR and CCSR.
75 * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
78 spectrum_reset(struct pcmcia_device *link, int idle)
84 /* Doing it if hardware is gone is guaranteed crash */
85 if (!pcmcia_dev_present(link))
88 /* Save original COR value */
89 ret = pcmcia_read_config_byte(link, CISREG_COR, &save_cor);
94 ret = pcmcia_write_config_byte(link, CISREG_COR,
95 (save_cor | COR_SOFT_RESET));
101 ret = pcmcia_read_config_byte(link, CISREG_CCSR, &ccsr);
106 * Start or stop the firmware. Memory width bit should be
107 * preserved from the value we've just read.
109 ccsr = (idle ? HCR_IDLE : HCR_RUN) | (ccsr & HCR_MEM16);
110 ret = pcmcia_write_config_byte(link, CISREG_CCSR, ccsr);
115 /* Restore original COR configuration index */
116 ret = pcmcia_write_config_byte(link, CISREG_COR,
117 (save_cor & ~COR_SOFT_RESET));
127 /********************************************************************/
129 /********************************************************************/
132 spectrum_cs_hard_reset(struct orinoco_private *priv)
134 struct orinoco_pccard *card = priv->card;
135 struct pcmcia_device *link = card->p_dev;
137 /* Soft reset using COR and HCR */
138 spectrum_reset(link, 0);
144 spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle)
146 struct orinoco_pccard *card = priv->card;
147 struct pcmcia_device *link = card->p_dev;
149 return spectrum_reset(link, idle);
152 /********************************************************************/
154 /********************************************************************/
157 * This creates an "instance" of the driver, allocating local data
158 * structures for one device. The device is registered with Card
161 * The dev_link structure is initialized, but we don't actually
162 * configure the card at this point -- we wait until we receive a card
163 * insertion event. */
165 spectrum_cs_probe(struct pcmcia_device *link)
167 struct orinoco_private *priv;
168 struct orinoco_pccard *card;
170 priv = alloc_orinocodev(sizeof(*card), &link->dev,
171 spectrum_cs_hard_reset,
172 spectrum_cs_stop_firmware);
177 /* Link both structures together */
181 return spectrum_cs_config(link);
182 } /* spectrum_cs_attach */
185 * This deletes a driver "instance". The device is de-registered with
186 * Card Services. If it has been released, all local data structures
187 * are freed. Otherwise, the structures will be freed when the device
190 static void spectrum_cs_detach(struct pcmcia_device *link)
192 struct orinoco_private *priv = link->priv;
194 orinoco_if_del(priv);
196 spectrum_cs_release(link);
198 free_orinocodev(priv);
199 } /* spectrum_cs_detach */
202 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
203 * event is received, to configure the PCMCIA socket, and to make the
204 * device available to the system.
207 static int spectrum_cs_config_check(struct pcmcia_device *p_dev,
210 if (p_dev->config_index == 0)
213 return pcmcia_request_io(p_dev);
217 spectrum_cs_config(struct pcmcia_device *link)
219 struct orinoco_private *priv = link->priv;
220 hermes_t *hw = &priv->hw;
225 * In this loop, we scan the CIS for configuration table
226 * entries, each of which describes a valid card
227 * configuration, including voltage, IO window, memory window,
228 * and interrupt settings.
230 * We make no assumptions about the card to be configured: we
231 * use just the information available in the CIS. In an ideal
232 * world, this would work for any PCMCIA card, but it requires
233 * a complete and accurate CIS. In practice, a driver usually
234 * "knows" most of these things without consulting the CIS,
235 * and most client drivers will only use the CIS to fill in
236 * implementation-defined details.
238 link->config_flags |= CONF_AUTO_SET_VPP | CONF_AUTO_CHECK_VCC |
239 CONF_AUTO_SET_IO | CONF_ENABLE_IRQ;
241 link->config_flags &= ~CONF_AUTO_CHECK_VCC;
242 ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL);
245 printk(KERN_ERR PFX "GetNextTuple(): No matching "
246 "CIS configuration. Maybe you need the "
247 "ignore_cis_vcc=1 parameter.\n");
251 ret = pcmcia_request_irq(link, orinoco_interrupt);
255 /* We initialize the hermes structure before completing PCMCIA
256 * configuration just in case the interrupt handler gets
258 mem = ioport_map(link->resource[0]->start,
259 resource_size(link->resource[0]));
263 hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
264 hw->eeprom_pda = true;
267 * This actually configures the PCMCIA socket -- setting up
268 * the I/O windows and the interrupt mapping, and putting the
269 * card and host interface into "Memory and IO" mode.
271 ret = pcmcia_enable_device(link);
276 if (spectrum_cs_hard_reset(priv) != 0)
279 /* Initialise the main driver */
280 if (orinoco_init(priv) != 0) {
281 printk(KERN_ERR PFX "orinoco_init() failed\n");
285 /* Register an interface with the stack */
286 if (orinoco_if_add(priv, link->resource[0]->start,
287 link->irq, NULL) != 0) {
288 printk(KERN_ERR PFX "orinoco_if_add() failed\n");
295 spectrum_cs_release(link);
297 } /* spectrum_cs_config */
300 * After a card is removed, spectrum_cs_release() will unregister the
301 * device, and release the PCMCIA configuration. If the device is
302 * still open, this will be postponed until it is closed.
305 spectrum_cs_release(struct pcmcia_device *link)
307 struct orinoco_private *priv = link->priv;
310 /* We're committed to taking the device away now, so mark the
311 * hardware as unavailable */
312 priv->hw.ops->lock_irqsave(&priv->lock, &flags);
313 priv->hw_unavailable++;
314 priv->hw.ops->unlock_irqrestore(&priv->lock, &flags);
316 pcmcia_disable_device(link);
318 ioport_unmap(priv->hw.iobase);
319 } /* spectrum_cs_release */
323 spectrum_cs_suspend(struct pcmcia_device *link)
325 struct orinoco_private *priv = link->priv;
328 /* Mark the device as stopped, to block IO until later */
335 spectrum_cs_resume(struct pcmcia_device *link)
337 struct orinoco_private *priv = link->priv;
338 int err = orinoco_up(priv);
344 /********************************************************************/
345 /* Module initialization */
346 /********************************************************************/
348 static struct pcmcia_device_id spectrum_cs_ids[] = {
349 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
350 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
351 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
354 MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);
356 static struct pcmcia_driver orinoco_driver = {
357 .owner = THIS_MODULE,
359 .probe = spectrum_cs_probe,
360 .remove = spectrum_cs_detach,
361 .suspend = spectrum_cs_suspend,
362 .resume = spectrum_cs_resume,
363 .id_table = spectrum_cs_ids,
367 init_spectrum_cs(void)
369 return pcmcia_register_driver(&orinoco_driver);
373 exit_spectrum_cs(void)
375 pcmcia_unregister_driver(&orinoco_driver);
378 module_init(init_spectrum_cs);
379 module_exit(exit_spectrum_cs);