Commit | Line | Data |
---|---|---|
3a48c4c2 PR |
1 | /* |
2 | * Driver for 802.11b cards using RAM-loadable Symbol firmware, such as | |
4ebe2eb0 | 3 | * Symbol Wireless Networker LA4137, CompactFlash cards by Socket |
3a48c4c2 PR |
4 | * Communications and Intel PRO/Wireless 2011B. |
5 | * | |
6 | * The driver implements Symbol firmware download. The rest is handled | |
47445cb9 | 7 | * in hermes.c and main.c. |
3a48c4c2 PR |
8 | * |
9 | * Utilities for downloading the Symbol firmware are available at | |
10 | * http://sourceforge.net/projects/orinoco/ | |
11 | * | |
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. | |
17 | * | |
47445cb9 | 18 | * See copyright notice in file main.c. |
3a48c4c2 PR |
19 | */ |
20 | ||
21 | #define DRIVER_NAME "spectrum_cs" | |
22 | #define PFX DRIVER_NAME ": " | |
23 | ||
3a48c4c2 PR |
24 | #include <linux/module.h> |
25 | #include <linux/kernel.h> | |
26 | #include <linux/init.h> | |
ef846bf0 | 27 | #include <linux/delay.h> |
3a48c4c2 PR |
28 | #include <pcmcia/cistpl.h> |
29 | #include <pcmcia/cisreg.h> | |
30 | #include <pcmcia/ds.h> | |
31 | ||
3a48c4c2 | 32 | #include "orinoco.h" |
3a48c4c2 PR |
33 | |
34 | /********************************************************************/ | |
35 | /* Module stuff */ | |
36 | /********************************************************************/ | |
37 | ||
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"); | |
41 | ||
42 | /* Module parameters */ | |
43 | ||
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"); | |
49 | ||
3a48c4c2 PR |
50 | /********************************************************************/ |
51 | /* Data structures */ | |
52 | /********************************************************************/ | |
53 | ||
54 | /* PCMCIA specific device information (goes in the card field of | |
55 | * struct orinoco_private */ | |
56 | struct orinoco_pccard { | |
fd238232 | 57 | struct pcmcia_device *p_dev; |
3a48c4c2 PR |
58 | }; |
59 | ||
3a48c4c2 PR |
60 | /********************************************************************/ |
61 | /* Function prototypes */ | |
62 | /********************************************************************/ | |
63 | ||
15b99ac1 | 64 | static int spectrum_cs_config(struct pcmcia_device *link); |
fba395ee | 65 | static void spectrum_cs_release(struct pcmcia_device *link); |
3a48c4c2 | 66 | |
3a48c4c2 PR |
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 */ | |
71 | ||
3a48c4c2 | 72 | |
3a48c4c2 PR |
73 | /* |
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. | |
76 | */ | |
77 | static int | |
fba395ee | 78 | spectrum_reset(struct pcmcia_device *link, int idle) |
3a48c4c2 | 79 | { |
2caff147 | 80 | int ret; |
1d5cc192 DB |
81 | u8 save_cor; |
82 | u8 ccsr; | |
3a48c4c2 PR |
83 | |
84 | /* Doing it if hardware is gone is guaranteed crash */ | |
c5ab964d | 85 | if (!pcmcia_dev_present(link)) |
3a48c4c2 PR |
86 | return -ENODEV; |
87 | ||
88 | /* Save original COR value */ | |
1d5cc192 | 89 | ret = pcmcia_read_config_byte(link, CISREG_COR, &save_cor); |
2caff147 DB |
90 | if (ret) |
91 | goto failed; | |
3a48c4c2 PR |
92 | |
93 | /* Soft-Reset card */ | |
1d5cc192 DB |
94 | ret = pcmcia_write_config_byte(link, CISREG_COR, |
95 | (save_cor | COR_SOFT_RESET)); | |
2caff147 DB |
96 | if (ret) |
97 | goto failed; | |
3a48c4c2 PR |
98 | udelay(1000); |
99 | ||
100 | /* Read CCSR */ | |
1d5cc192 | 101 | ret = pcmcia_read_config_byte(link, CISREG_CCSR, &ccsr); |
2caff147 DB |
102 | if (ret) |
103 | goto failed; | |
3a48c4c2 PR |
104 | |
105 | /* | |
106 | * Start or stop the firmware. Memory width bit should be | |
107 | * preserved from the value we've just read. | |
108 | */ | |
1d5cc192 DB |
109 | ccsr = (idle ? HCR_IDLE : HCR_RUN) | (ccsr & HCR_MEM16); |
110 | ret = pcmcia_write_config_byte(link, CISREG_CCSR, ccsr); | |
2caff147 DB |
111 | if (ret) |
112 | goto failed; | |
3a48c4c2 PR |
113 | udelay(1000); |
114 | ||
115 | /* Restore original COR configuration index */ | |
1d5cc192 DB |
116 | ret = pcmcia_write_config_byte(link, CISREG_COR, |
117 | (save_cor & ~COR_SOFT_RESET)); | |
2caff147 DB |
118 | if (ret) |
119 | goto failed; | |
3a48c4c2 PR |
120 | udelay(1000); |
121 | return 0; | |
122 | ||
2caff147 | 123 | failed: |
3a48c4c2 PR |
124 | return -ENODEV; |
125 | } | |
126 | ||
3994d502 DK |
127 | /********************************************************************/ |
128 | /* Device methods */ | |
129 | /********************************************************************/ | |
3a48c4c2 | 130 | |
3a48c4c2 | 131 | static int |
3994d502 | 132 | spectrum_cs_hard_reset(struct orinoco_private *priv) |
3a48c4c2 | 133 | { |
3994d502 DK |
134 | struct orinoco_pccard *card = priv->card; |
135 | struct pcmcia_device *link = card->p_dev; | |
3a48c4c2 | 136 | |
3994d502 DK |
137 | /* Soft reset using COR and HCR */ |
138 | spectrum_reset(link, 0); | |
3a48c4c2 PR |
139 | |
140 | return 0; | |
141 | } | |
142 | ||
3a48c4c2 | 143 | static int |
3994d502 | 144 | spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle) |
3a48c4c2 PR |
145 | { |
146 | struct orinoco_pccard *card = priv->card; | |
fba395ee | 147 | struct pcmcia_device *link = card->p_dev; |
3a48c4c2 | 148 | |
3994d502 | 149 | return spectrum_reset(link, idle); |
3a48c4c2 PR |
150 | } |
151 | ||
152 | /********************************************************************/ | |
153 | /* PCMCIA stuff */ | |
154 | /********************************************************************/ | |
155 | ||
156 | /* | |
157 | * This creates an "instance" of the driver, allocating local data | |
158 | * structures for one device. The device is registered with Card | |
159 | * Services. | |
d14c7c1d | 160 | * |
3a48c4c2 PR |
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. */ | |
f8cfa618 | 164 | static int |
15b99ac1 | 165 | spectrum_cs_probe(struct pcmcia_device *link) |
3a48c4c2 | 166 | { |
3a48c4c2 PR |
167 | struct orinoco_private *priv; |
168 | struct orinoco_pccard *card; | |
3a48c4c2 | 169 | |
dd2e5a15 | 170 | priv = alloc_orinocodev(sizeof(*card), &link->dev, |
a2608362 DK |
171 | spectrum_cs_hard_reset, |
172 | spectrum_cs_stop_firmware); | |
173 | if (!priv) | |
f8cfa618 | 174 | return -ENOMEM; |
3a48c4c2 PR |
175 | card = priv->card; |
176 | ||
177 | /* Link both structures together */ | |
fba395ee | 178 | card->p_dev = link; |
a2608362 | 179 | link->priv = priv; |
3a48c4c2 | 180 | |
15b99ac1 | 181 | return spectrum_cs_config(link); |
3a48c4c2 PR |
182 | } /* spectrum_cs_attach */ |
183 | ||
184 | /* | |
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 | |
188 | * is released. | |
189 | */ | |
fba395ee | 190 | static void spectrum_cs_detach(struct pcmcia_device *link) |
3a48c4c2 | 191 | { |
a2608362 | 192 | struct orinoco_private *priv = link->priv; |
3a48c4c2 | 193 | |
c7c2fa07 | 194 | orinoco_if_del(priv); |
e4f4f98e | 195 | |
e2d40963 | 196 | spectrum_cs_release(link); |
3a48c4c2 | 197 | |
a2608362 | 198 | free_orinocodev(priv); |
3a48c4c2 PR |
199 | } /* spectrum_cs_detach */ |
200 | ||
201 | /* | |
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. | |
205 | */ | |
206 | ||
b54bf94b | 207 | static int spectrum_cs_config_check(struct pcmcia_device *p_dev, |
b54bf94b DB |
208 | void *priv_data) |
209 | { | |
00990e7c DB |
210 | if (p_dev->config_index == 0) |
211 | return -EINVAL; | |
b54bf94b | 212 | |
00990e7c | 213 | return pcmcia_request_io(p_dev); |
b54bf94b DB |
214 | }; |
215 | ||
15b99ac1 | 216 | static int |
fba395ee | 217 | spectrum_cs_config(struct pcmcia_device *link) |
3a48c4c2 | 218 | { |
a2608362 | 219 | struct orinoco_private *priv = link->priv; |
3a48c4c2 | 220 | hermes_t *hw = &priv->hw; |
2caff147 | 221 | int ret; |
3a48c4c2 PR |
222 | void __iomem *mem; |
223 | ||
3a48c4c2 PR |
224 | /* |
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. | |
229 | * | |
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. | |
237 | */ | |
00990e7c DB |
238 | link->config_flags |= CONF_AUTO_SET_VPP | CONF_AUTO_CHECK_VCC | |
239 | CONF_AUTO_SET_IO | CONF_ENABLE_IRQ; | |
440eed43 DB |
240 | if (ignore_cis_vcc) |
241 | link->config_flags &= ~CONF_AUTO_CHECK_VCC; | |
2caff147 DB |
242 | ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL); |
243 | if (ret) { | |
b54bf94b | 244 | if (!ignore_cis_vcc) |
3a48c4c2 PR |
245 | printk(KERN_ERR PFX "GetNextTuple(): No matching " |
246 | "CIS configuration. Maybe you need the " | |
247 | "ignore_cis_vcc=1 parameter.\n"); | |
b54bf94b | 248 | goto failed; |
3a48c4c2 PR |
249 | } |
250 | ||
eb14120f | 251 | ret = pcmcia_request_irq(link, orinoco_interrupt); |
2caff147 DB |
252 | if (ret) |
253 | goto failed; | |
3a48c4c2 PR |
254 | |
255 | /* We initialize the hermes structure before completing PCMCIA | |
256 | * configuration just in case the interrupt handler gets | |
257 | * called. */ | |
9a017a91 DB |
258 | mem = ioport_map(link->resource[0]->start, |
259 | resource_size(link->resource[0])); | |
3a48c4c2 | 260 | if (!mem) |
2caff147 | 261 | goto failed; |
3a48c4c2 PR |
262 | |
263 | hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING); | |
07cefe7a | 264 | hw->eeprom_pda = true; |
3a48c4c2 PR |
265 | |
266 | /* | |
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. | |
270 | */ | |
1ac71e5a | 271 | ret = pcmcia_enable_device(link); |
2caff147 DB |
272 | if (ret) |
273 | goto failed; | |
3a48c4c2 | 274 | |
3994d502 | 275 | /* Reset card */ |
d14c7c1d | 276 | if (spectrum_cs_hard_reset(priv) != 0) |
3a48c4c2 | 277 | goto failed; |
3a48c4c2 | 278 | |
8e638267 DK |
279 | /* Initialise the main driver */ |
280 | if (orinoco_init(priv) != 0) { | |
281 | printk(KERN_ERR PFX "orinoco_init() failed\n"); | |
282 | goto failed; | |
283 | } | |
284 | ||
5381956b | 285 | /* Register an interface with the stack */ |
9a017a91 | 286 | if (orinoco_if_add(priv, link->resource[0]->start, |
f8965467 | 287 | link->irq, NULL) != 0) { |
5381956b | 288 | printk(KERN_ERR PFX "orinoco_if_add() failed\n"); |
3a48c4c2 PR |
289 | goto failed; |
290 | } | |
291 | ||
15b99ac1 | 292 | return 0; |
3a48c4c2 | 293 | |
3a48c4c2 PR |
294 | failed: |
295 | spectrum_cs_release(link); | |
15b99ac1 | 296 | return -ENODEV; |
3a48c4c2 PR |
297 | } /* spectrum_cs_config */ |
298 | ||
299 | /* | |
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. | |
303 | */ | |
304 | static void | |
fba395ee | 305 | spectrum_cs_release(struct pcmcia_device *link) |
3a48c4c2 | 306 | { |
a2608362 | 307 | struct orinoco_private *priv = link->priv; |
3a48c4c2 PR |
308 | unsigned long flags; |
309 | ||
310 | /* We're committed to taking the device away now, so mark the | |
311 | * hardware as unavailable */ | |
bcad6e80 | 312 | priv->hw.ops->lock_irqsave(&priv->lock, &flags); |
3a48c4c2 | 313 | priv->hw_unavailable++; |
bcad6e80 | 314 | priv->hw.ops->unlock_irqrestore(&priv->lock, &flags); |
3a48c4c2 | 315 | |
fba395ee | 316 | pcmcia_disable_device(link); |
3a48c4c2 PR |
317 | if (priv->hw.iobase) |
318 | ioport_unmap(priv->hw.iobase); | |
319 | } /* spectrum_cs_release */ | |
320 | ||
98e4c28b DB |
321 | |
322 | static int | |
fba395ee | 323 | spectrum_cs_suspend(struct pcmcia_device *link) |
98e4c28b | 324 | { |
a2608362 | 325 | struct orinoco_private *priv = link->priv; |
98e4c28b DB |
326 | int err = 0; |
327 | ||
98e4c28b | 328 | /* Mark the device as stopped, to block IO until later */ |
6415f7df | 329 | orinoco_down(priv); |
98e4c28b | 330 | |
6cbaa330 | 331 | return err; |
98e4c28b DB |
332 | } |
333 | ||
334 | static int | |
fba395ee | 335 | spectrum_cs_resume(struct pcmcia_device *link) |
98e4c28b | 336 | { |
a2608362 | 337 | struct orinoco_private *priv = link->priv; |
6415f7df | 338 | int err = orinoco_up(priv); |
ac7cafd7 | 339 | |
6415f7df | 340 | return err; |
98e4c28b DB |
341 | } |
342 | ||
3a48c4c2 PR |
343 | |
344 | /********************************************************************/ | |
345 | /* Module initialization */ | |
346 | /********************************************************************/ | |
347 | ||
348 | /* Can't be declared "const" or the whole __initdata section will | |
349 | * become const */ | |
350 | static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION | |
351 | " (Pavel Roskin <proski@gnu.org>," | |
352 | " David Gibson <hermes@gibson.dropbear.id.au>, et al)"; | |
353 | ||
354 | static struct pcmcia_device_id spectrum_cs_ids[] = { | |
4ebe2eb0 | 355 | PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */ |
3a48c4c2 | 356 | PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */ |
9c8a11d7 | 357 | PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */ |
3a48c4c2 PR |
358 | PCMCIA_DEVICE_NULL, |
359 | }; | |
360 | MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids); | |
361 | ||
362 | static struct pcmcia_driver orinoco_driver = { | |
363 | .owner = THIS_MODULE, | |
364 | .drv = { | |
365 | .name = DRIVER_NAME, | |
366 | }, | |
15b99ac1 | 367 | .probe = spectrum_cs_probe, |
cc3b4866 | 368 | .remove = spectrum_cs_detach, |
98e4c28b DB |
369 | .suspend = spectrum_cs_suspend, |
370 | .resume = spectrum_cs_resume, | |
3a48c4c2 PR |
371 | .id_table = spectrum_cs_ids, |
372 | }; | |
373 | ||
374 | static int __init | |
375 | init_spectrum_cs(void) | |
376 | { | |
377 | printk(KERN_DEBUG "%s\n", version); | |
378 | ||
379 | return pcmcia_register_driver(&orinoco_driver); | |
380 | } | |
381 | ||
382 | static void __exit | |
383 | exit_spectrum_cs(void) | |
384 | { | |
385 | pcmcia_unregister_driver(&orinoco_driver); | |
3a48c4c2 PR |
386 | } |
387 | ||
388 | module_init(init_spectrum_cs); | |
389 | module_exit(exit_spectrum_cs); |