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 /* General socket configuration defaults can go here. In this
197 * client, we assume very little, and rely on the CIS for
198 * almost everything. In most clients, many details (i.e.,
199 * number, sizes, and attributes of IO windows) are fixed by
200 * the nature of the device, and can be hard-wired here. */
201 link
->conf
.Attributes
= 0;
202 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
204 return spectrum_cs_config(link
);
205 } /* spectrum_cs_attach */
208 * This deletes a driver "instance". The device is de-registered with
209 * Card Services. If it has been released, all local data structures
210 * are freed. Otherwise, the structures will be freed when the device
213 static void spectrum_cs_detach(struct pcmcia_device
*link
)
215 struct orinoco_private
*priv
= link
->priv
;
218 orinoco_if_del(priv
);
220 spectrum_cs_release(link
);
222 free_orinocodev(priv
);
223 } /* spectrum_cs_detach */
226 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
227 * event is received, to configure the PCMCIA socket, and to make the
228 * device available to the system.
231 static int spectrum_cs_config_check(struct pcmcia_device
*p_dev
,
232 cistpl_cftable_entry_t
*cfg
,
233 cistpl_cftable_entry_t
*dflt
,
240 /* Use power settings for Vcc and Vpp if present */
241 /* Note that the CIS values need to be rescaled */
242 if (cfg
->vcc
.present
& (1 << CISTPL_POWER_VNOM
)) {
243 if (vcc
!= cfg
->vcc
.param
[CISTPL_POWER_VNOM
] / 10000) {
244 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
246 cfg
->vcc
.param
[CISTPL_POWER_VNOM
] / 10000);
250 } else if (dflt
->vcc
.present
& (1 << CISTPL_POWER_VNOM
)) {
251 if (vcc
!= dflt
->vcc
.param
[CISTPL_POWER_VNOM
] / 10000) {
252 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
254 dflt
->vcc
.param
[CISTPL_POWER_VNOM
] / 10000);
260 if (cfg
->vpp1
.present
& (1 << CISTPL_POWER_VNOM
))
262 cfg
->vpp1
.param
[CISTPL_POWER_VNOM
] / 10000;
263 else if (dflt
->vpp1
.present
& (1 << CISTPL_POWER_VNOM
))
265 dflt
->vpp1
.param
[CISTPL_POWER_VNOM
] / 10000;
267 /* Do we need to allocate an interrupt? */
268 p_dev
->conf
.Attributes
|= CONF_ENABLE_IRQ
;
270 /* IO window settings */
271 p_dev
->io
.NumPorts1
= p_dev
->io
.NumPorts2
= 0;
272 if ((cfg
->io
.nwin
> 0) || (dflt
->io
.nwin
> 0)) {
273 cistpl_io_t
*io
= (cfg
->io
.nwin
) ? &cfg
->io
: &dflt
->io
;
274 p_dev
->io
.Attributes1
= IO_DATA_PATH_WIDTH_AUTO
;
275 if (!(io
->flags
& CISTPL_IO_8BIT
))
276 p_dev
->io
.Attributes1
= IO_DATA_PATH_WIDTH_16
;
277 if (!(io
->flags
& CISTPL_IO_16BIT
))
278 p_dev
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
279 p_dev
->io
.IOAddrLines
= io
->flags
& CISTPL_IO_LINES_MASK
;
280 p_dev
->io
.BasePort1
= io
->win
[0].base
;
281 p_dev
->io
.NumPorts1
= io
->win
[0].len
;
283 p_dev
->io
.Attributes2
= p_dev
->io
.Attributes1
;
284 p_dev
->io
.BasePort2
= io
->win
[1].base
;
285 p_dev
->io
.NumPorts2
= io
->win
[1].len
;
288 /* This reserves IO space but doesn't actually enable it */
289 if (pcmcia_request_io(p_dev
, &p_dev
->io
) != 0)
295 pcmcia_disable_device(p_dev
);
300 spectrum_cs_config(struct pcmcia_device
*link
)
302 struct orinoco_private
*priv
= link
->priv
;
303 struct orinoco_pccard
*card
= priv
->card
;
304 hermes_t
*hw
= &priv
->hw
;
309 * In this loop, we scan the CIS for configuration table
310 * entries, each of which describes a valid card
311 * configuration, including voltage, IO window, memory window,
312 * and interrupt settings.
314 * We make no assumptions about the card to be configured: we
315 * use just the information available in the CIS. In an ideal
316 * world, this would work for any PCMCIA card, but it requires
317 * a complete and accurate CIS. In practice, a driver usually
318 * "knows" most of these things without consulting the CIS,
319 * and most client drivers will only use the CIS to fill in
320 * implementation-defined details.
322 ret
= pcmcia_loop_config(link
, spectrum_cs_config_check
, NULL
);
325 printk(KERN_ERR PFX
"GetNextTuple(): No matching "
326 "CIS configuration. Maybe you need the "
327 "ignore_cis_vcc=1 parameter.\n");
331 ret
= pcmcia_request_irq(link
, orinoco_interrupt
);
335 /* We initialize the hermes structure before completing PCMCIA
336 * configuration just in case the interrupt handler gets
338 mem
= ioport_map(link
->io
.BasePort1
, link
->io
.NumPorts1
);
342 hermes_struct_init(hw
, mem
, HERMES_16BIT_REGSPACING
);
345 * This actually configures the PCMCIA socket -- setting up
346 * the I/O windows and the interrupt mapping, and putting the
347 * card and host interface into "Memory and IO" mode.
349 ret
= pcmcia_request_configuration(link
, &link
->conf
);
353 /* Ok, we have the configuration, prepare to register the netdev */
354 card
->node
.major
= card
->node
.minor
= 0;
357 if (spectrum_cs_hard_reset(priv
) != 0)
360 /* Initialise the main driver */
361 if (orinoco_init(priv
) != 0) {
362 printk(KERN_ERR PFX
"orinoco_init() failed\n");
366 /* Register an interface with the stack */
367 if (orinoco_if_add(priv
, link
->io
.BasePort1
,
369 printk(KERN_ERR PFX
"orinoco_if_add() failed\n");
373 /* At this point, the dev_node_t structure(s) needs to be
374 * initialized and arranged in a linked list at link->dev_node. */
375 strcpy(card
->node
.dev_name
, priv
->ndev
->name
);
376 link
->dev_node
= &card
->node
; /* link->dev_node being non-NULL is also
377 * used to indicate that the
378 * net_device has been registered */
382 spectrum_cs_release(link
);
384 } /* spectrum_cs_config */
387 * After a card is removed, spectrum_cs_release() will unregister the
388 * device, and release the PCMCIA configuration. If the device is
389 * still open, this will be postponed until it is closed.
392 spectrum_cs_release(struct pcmcia_device
*link
)
394 struct orinoco_private
*priv
= link
->priv
;
397 /* We're committed to taking the device away now, so mark the
398 * hardware as unavailable */
399 spin_lock_irqsave(&priv
->lock
, flags
);
400 priv
->hw_unavailable
++;
401 spin_unlock_irqrestore(&priv
->lock
, flags
);
403 pcmcia_disable_device(link
);
405 ioport_unmap(priv
->hw
.iobase
);
406 } /* spectrum_cs_release */
410 spectrum_cs_suspend(struct pcmcia_device
*link
)
412 struct orinoco_private
*priv
= link
->priv
;
415 /* Mark the device as stopped, to block IO until later */
422 spectrum_cs_resume(struct pcmcia_device
*link
)
424 struct orinoco_private
*priv
= link
->priv
;
425 int err
= orinoco_up(priv
);
431 /********************************************************************/
432 /* Module initialization */
433 /********************************************************************/
435 /* Can't be declared "const" or the whole __initdata section will
437 static char version
[] __initdata
= DRIVER_NAME
" " DRIVER_VERSION
438 " (Pavel Roskin <proski@gnu.org>,"
439 " David Gibson <hermes@gibson.dropbear.id.au>, et al)";
441 static struct pcmcia_device_id spectrum_cs_ids
[] = {
442 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
443 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
444 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
447 MODULE_DEVICE_TABLE(pcmcia
, spectrum_cs_ids
);
449 static struct pcmcia_driver orinoco_driver
= {
450 .owner
= THIS_MODULE
,
454 .probe
= spectrum_cs_probe
,
455 .remove
= spectrum_cs_detach
,
456 .suspend
= spectrum_cs_suspend
,
457 .resume
= spectrum_cs_resume
,
458 .id_table
= spectrum_cs_ids
,
462 init_spectrum_cs(void)
464 printk(KERN_DEBUG
"%s\n", version
);
466 return pcmcia_register_driver(&orinoco_driver
);
470 exit_spectrum_cs(void)
472 pcmcia_unregister_driver(&orinoco_driver
);
475 module_init(init_spectrum_cs
);
476 module_exit(exit_spectrum_cs
);