blob: 511bc59f1574d4a0616d2c1cf392ba841c027b6c [file] [log] [blame]
Pavel Roskin3a48c4c2005-09-01 20:10:06 -04001/*
2 * Driver for 802.11b cards using RAM-loadable Symbol firmware, such as
Pavel Roskin4ebe2eb2006-04-07 04:10:32 -04003 * Symbol Wireless Networker LA4137, CompactFlash cards by Socket
Pavel Roskin3a48c4c2005-09-01 20:10:06 -04004 * Communications and Intel PRO/Wireless 2011B.
5 *
6 * The driver implements Symbol firmware download. The rest is handled
7 * in hermes.c and orinoco.c.
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 *
18 * See copyright notice in file orinoco.c.
19 */
20
21#define DRIVER_NAME "spectrum_cs"
22#define PFX DRIVER_NAME ": "
23
24#include <linux/config.h>
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040025#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/init.h>
Pavel Roskinef846bf2005-09-23 04:18:07 -040028#include <linux/delay.h>
Pavel Roskin65853b12005-09-16 02:15:13 -040029#include <linux/firmware.h>
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040030#include <pcmcia/cs_types.h>
31#include <pcmcia/cs.h>
32#include <pcmcia/cistpl.h>
33#include <pcmcia/cisreg.h>
34#include <pcmcia/ds.h>
35
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040036#include "orinoco.h"
37
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040038static unsigned char *primsym;
39static unsigned char *secsym;
40static const char primary_fw_name[] = "symbol_sp24t_prim_fw";
41static const char secondary_fw_name[] = "symbol_sp24t_sec_fw";
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040042
43/********************************************************************/
44/* Module stuff */
45/********************************************************************/
46
47MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
48MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
49MODULE_LICENSE("Dual MPL/GPL");
50
51/* Module parameters */
52
53/* Some D-Link cards have buggy CIS. They do work at 5v properly, but
54 * don't have any CIS entry for it. This workaround it... */
55static int ignore_cis_vcc; /* = 0 */
56module_param(ignore_cis_vcc, int, 0);
57MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");
58
59/********************************************************************/
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040060/* Data structures */
61/********************************************************************/
62
63/* PCMCIA specific device information (goes in the card field of
64 * struct orinoco_private */
65struct orinoco_pccard {
Dominik Brodowskifd238232006-03-05 10:45:09 +010066 struct pcmcia_device *p_dev;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040067 dev_node_t node;
68};
69
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040070/********************************************************************/
71/* Function prototypes */
72/********************************************************************/
73
Dominik Brodowski15b99ac2006-03-31 17:26:06 +020074static int spectrum_cs_config(struct pcmcia_device *link);
Dominik Brodowskifba395e2006-03-31 17:21:06 +020075static void spectrum_cs_release(struct pcmcia_device *link);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -040076
77/********************************************************************/
78/* Firmware downloader */
79/********************************************************************/
80
81/* Position of PDA in the adapter memory */
82#define EEPROM_ADDR 0x3000
83#define EEPROM_LEN 0x200
84#define PDA_OFFSET 0x100
85
86#define PDA_ADDR (EEPROM_ADDR + PDA_OFFSET)
87#define PDA_WORDS ((EEPROM_LEN - PDA_OFFSET) / 2)
88
89/* Constants for the CISREG_CCSR register */
90#define HCR_RUN 0x07 /* run firmware after reset */
91#define HCR_IDLE 0x0E /* don't run firmware after reset */
92#define HCR_MEM16 0x10 /* memory width bit, should be preserved */
93
94/*
95 * AUX port access. To unlock the AUX port write the access keys to the
96 * PARAM0-2 registers, then write HERMES_AUX_ENABLE to the HERMES_CONTROL
97 * register. Then read it and make sure it's HERMES_AUX_ENABLED.
98 */
99#define HERMES_AUX_ENABLE 0x8000 /* Enable auxiliary port access */
100#define HERMES_AUX_DISABLE 0x4000 /* Disable to auxiliary port access */
101#define HERMES_AUX_ENABLED 0xC000 /* Auxiliary port is open */
102
103#define HERMES_AUX_PW0 0xFE01
104#define HERMES_AUX_PW1 0xDC23
105#define HERMES_AUX_PW2 0xBA45
106
107/* End markers */
108#define PDI_END 0x00000000 /* End of PDA */
109#define BLOCK_END 0xFFFFFFFF /* Last image block */
110#define TEXT_END 0x1A /* End of text header */
111
112/*
113 * The following structures have little-endian fields denoted by
114 * the leading underscore. Don't access them directly - use inline
115 * functions defined below.
116 */
117
118/*
119 * The binary image to be downloaded consists of series of data blocks.
120 * Each block has the following structure.
121 */
122struct dblock {
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400123 __le32 addr; /* adapter address where to write the block */
124 __le16 len; /* length of the data only, in bytes */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400125 char data[0]; /* data to be written */
126} __attribute__ ((packed));
127
128/*
129 * Plug Data References are located in in the image after the last data
130 * block. They refer to areas in the adapter memory where the plug data
131 * items with matching ID should be written.
132 */
133struct pdr {
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400134 __le32 id; /* record ID */
135 __le32 addr; /* adapter address where to write the data */
136 __le32 len; /* expected length of the data, in bytes */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400137 char next[0]; /* next PDR starts here */
138} __attribute__ ((packed));
139
140
141/*
142 * Plug Data Items are located in the EEPROM read from the adapter by
143 * primary firmware. They refer to the device-specific data that should
144 * be plugged into the secondary firmware.
145 */
146struct pdi {
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400147 __le16 len; /* length of ID and data, in words */
148 __le16 id; /* record ID */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400149 char data[0]; /* plug data */
Alexey Dobriyan53b35312006-03-24 03:16:13 -0800150} __attribute__ ((packed));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400151
152
153/* Functions for access to little-endian data */
154static inline u32
155dblock_addr(const struct dblock *blk)
156{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400157 return le32_to_cpu(blk->addr);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400158}
159
160static inline u32
161dblock_len(const struct dblock *blk)
162{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400163 return le16_to_cpu(blk->len);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400164}
165
166static inline u32
167pdr_id(const struct pdr *pdr)
168{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400169 return le32_to_cpu(pdr->id);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400170}
171
172static inline u32
173pdr_addr(const struct pdr *pdr)
174{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400175 return le32_to_cpu(pdr->addr);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400176}
177
178static inline u32
179pdr_len(const struct pdr *pdr)
180{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400181 return le32_to_cpu(pdr->len);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400182}
183
184static inline u32
185pdi_id(const struct pdi *pdi)
186{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400187 return le16_to_cpu(pdi->id);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400188}
189
190/* Return length of the data only, in bytes */
191static inline u32
192pdi_len(const struct pdi *pdi)
193{
Pavel Roskin7eeae2f2006-04-07 04:10:24 -0400194 return 2 * (le16_to_cpu(pdi->len) - 1);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400195}
196
197
198/* Set address of the auxiliary port */
199static inline void
200spectrum_aux_setaddr(hermes_t *hw, u32 addr)
201{
202 hermes_write_reg(hw, HERMES_AUXPAGE, (u16) (addr >> 7));
203 hermes_write_reg(hw, HERMES_AUXOFFSET, (u16) (addr & 0x7F));
204}
205
206
207/* Open access to the auxiliary port */
208static int
209spectrum_aux_open(hermes_t *hw)
210{
211 int i;
212
213 /* Already open? */
214 if (hermes_read_reg(hw, HERMES_CONTROL) == HERMES_AUX_ENABLED)
215 return 0;
216
217 hermes_write_reg(hw, HERMES_PARAM0, HERMES_AUX_PW0);
218 hermes_write_reg(hw, HERMES_PARAM1, HERMES_AUX_PW1);
219 hermes_write_reg(hw, HERMES_PARAM2, HERMES_AUX_PW2);
220 hermes_write_reg(hw, HERMES_CONTROL, HERMES_AUX_ENABLE);
221
222 for (i = 0; i < 20; i++) {
223 udelay(10);
224 if (hermes_read_reg(hw, HERMES_CONTROL) ==
225 HERMES_AUX_ENABLED)
226 return 0;
227 }
228
229 return -EBUSY;
230}
231
232
233#define CS_CHECK(fn, ret) \
234 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
235
236/*
237 * Reset the card using configuration registers COR and CCSR.
238 * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
239 */
240static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200241spectrum_reset(struct pcmcia_device *link, int idle)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400242{
243 int last_ret, last_fn;
244 conf_reg_t reg;
245 u_int save_cor;
246
247 /* Doing it if hardware is gone is guaranteed crash */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100248 if (pcmcia_dev_present(link))
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400249 return -ENODEV;
250
251 /* Save original COR value */
252 reg.Function = 0;
253 reg.Action = CS_READ;
254 reg.Offset = CISREG_COR;
255 CS_CHECK(AccessConfigurationRegister,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200256 pcmcia_access_configuration_register(link, &reg));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400257 save_cor = reg.Value;
258
259 /* Soft-Reset card */
260 reg.Action = CS_WRITE;
261 reg.Offset = CISREG_COR;
262 reg.Value = (save_cor | COR_SOFT_RESET);
263 CS_CHECK(AccessConfigurationRegister,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200264 pcmcia_access_configuration_register(link, &reg));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400265 udelay(1000);
266
267 /* Read CCSR */
268 reg.Action = CS_READ;
269 reg.Offset = CISREG_CCSR;
270 CS_CHECK(AccessConfigurationRegister,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200271 pcmcia_access_configuration_register(link, &reg));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400272
273 /*
274 * Start or stop the firmware. Memory width bit should be
275 * preserved from the value we've just read.
276 */
277 reg.Action = CS_WRITE;
278 reg.Offset = CISREG_CCSR;
279 reg.Value = (idle ? HCR_IDLE : HCR_RUN) | (reg.Value & HCR_MEM16);
280 CS_CHECK(AccessConfigurationRegister,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200281 pcmcia_access_configuration_register(link, &reg));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400282 udelay(1000);
283
284 /* Restore original COR configuration index */
285 reg.Action = CS_WRITE;
286 reg.Offset = CISREG_COR;
287 reg.Value = (save_cor & ~COR_SOFT_RESET);
288 CS_CHECK(AccessConfigurationRegister,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200289 pcmcia_access_configuration_register(link, &reg));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400290 udelay(1000);
291 return 0;
292
293 cs_failed:
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200294 cs_error(link, last_fn, last_ret);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400295 return -ENODEV;
296}
297
298
299/*
300 * Scan PDR for the record with the specified RECORD_ID.
301 * If it's not found, return NULL.
302 */
303static struct pdr *
304spectrum_find_pdr(struct pdr *first_pdr, u32 record_id)
305{
306 struct pdr *pdr = first_pdr;
307
308 while (pdr_id(pdr) != PDI_END) {
309 /*
310 * PDR area is currently not terminated by PDI_END.
311 * It's followed by CRC records, which have the type
312 * field where PDR has length. The type can be 0 or 1.
313 */
314 if (pdr_len(pdr) < 2)
315 return NULL;
316
317 /* If the record ID matches, we are done */
318 if (pdr_id(pdr) == record_id)
319 return pdr;
320
321 pdr = (struct pdr *) pdr->next;
322 }
323 return NULL;
324}
325
326
327/* Process one Plug Data Item - find corresponding PDR and plug it */
328static int
329spectrum_plug_pdi(hermes_t *hw, struct pdr *first_pdr, struct pdi *pdi)
330{
331 struct pdr *pdr;
332
333 /* Find the PDI corresponding to this PDR */
334 pdr = spectrum_find_pdr(first_pdr, pdi_id(pdi));
335
336 /* No match is found, safe to ignore */
337 if (!pdr)
338 return 0;
339
340 /* Lengths of the data in PDI and PDR must match */
341 if (pdi_len(pdi) != pdr_len(pdr))
342 return -EINVAL;
343
344 /* do the actual plugging */
345 spectrum_aux_setaddr(hw, pdr_addr(pdr));
346 hermes_write_words(hw, HERMES_AUXDATA, pdi->data,
347 pdi_len(pdi) / 2);
348
349 return 0;
350}
351
352
353/* Read PDA from the adapter */
354static int
Pavel Roskind133ae42005-09-23 04:18:06 -0400355spectrum_read_pda(hermes_t *hw, __le16 *pda, int pda_len)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400356{
357 int ret;
358 int pda_size;
359
360 /* Issue command to read EEPROM */
361 ret = hermes_docmd_wait(hw, HERMES_CMD_READMIF, 0, NULL);
362 if (ret)
363 return ret;
364
365 /* Open auxiliary port */
366 ret = spectrum_aux_open(hw);
367 if (ret)
368 return ret;
369
370 /* read PDA from EEPROM */
371 spectrum_aux_setaddr(hw, PDA_ADDR);
372 hermes_read_words(hw, HERMES_AUXDATA, pda, pda_len / 2);
373
374 /* Check PDA length */
375 pda_size = le16_to_cpu(pda[0]);
376 if (pda_size > pda_len)
377 return -EINVAL;
378
379 return 0;
380}
381
382
383/* Parse PDA and write the records into the adapter */
384static int
385spectrum_apply_pda(hermes_t *hw, const struct dblock *first_block,
Pavel Roskind133ae42005-09-23 04:18:06 -0400386 __le16 *pda)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400387{
388 int ret;
389 struct pdi *pdi;
390 struct pdr *first_pdr;
391 const struct dblock *blk = first_block;
392
393 /* Skip all blocks to locate Plug Data References */
394 while (dblock_addr(blk) != BLOCK_END)
395 blk = (struct dblock *) &blk->data[dblock_len(blk)];
396
397 first_pdr = (struct pdr *) blk;
398
399 /* Go through every PDI and plug them into the adapter */
400 pdi = (struct pdi *) (pda + 2);
401 while (pdi_id(pdi) != PDI_END) {
402 ret = spectrum_plug_pdi(hw, first_pdr, pdi);
403 if (ret)
404 return ret;
405
406 /* Increment to the next PDI */
407 pdi = (struct pdi *) &pdi->data[pdi_len(pdi)];
408 }
409 return 0;
410}
411
412
413/* Load firmware blocks into the adapter */
414static int
415spectrum_load_blocks(hermes_t *hw, const struct dblock *first_block)
416{
417 const struct dblock *blk;
418 u32 blkaddr;
419 u32 blklen;
420
421 blk = first_block;
422 blkaddr = dblock_addr(blk);
423 blklen = dblock_len(blk);
424
425 while (dblock_addr(blk) != BLOCK_END) {
426 spectrum_aux_setaddr(hw, blkaddr);
427 hermes_write_words(hw, HERMES_AUXDATA, blk->data,
428 blklen / 2);
429
430 blk = (struct dblock *) &blk->data[blklen];
431 blkaddr = dblock_addr(blk);
432 blklen = dblock_len(blk);
433 }
434 return 0;
435}
436
437
438/*
439 * Process a firmware image - stop the card, load the firmware, reset
440 * the card and make sure it responds. For the secondary firmware take
441 * care of the PDA - read it and then write it on top of the firmware.
442 */
443static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200444spectrum_dl_image(hermes_t *hw, struct pcmcia_device *link,
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400445 const unsigned char *image)
446{
447 int ret;
448 const unsigned char *ptr;
449 const struct dblock *first_block;
450
451 /* Plug Data Area (PDA) */
Pavel Roskind133ae42005-09-23 04:18:06 -0400452 __le16 pda[PDA_WORDS];
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400453
454 /* Binary block begins after the 0x1A marker */
455 ptr = image;
456 while (*ptr++ != TEXT_END);
457 first_block = (const struct dblock *) ptr;
458
459 /* Read the PDA */
460 if (image != primsym) {
461 ret = spectrum_read_pda(hw, pda, sizeof(pda));
462 if (ret)
463 return ret;
464 }
465
466 /* Stop the firmware, so that it can be safely rewritten */
467 ret = spectrum_reset(link, 1);
468 if (ret)
469 return ret;
470
471 /* Program the adapter with new firmware */
472 ret = spectrum_load_blocks(hw, first_block);
473 if (ret)
474 return ret;
475
476 /* Write the PDA to the adapter */
477 if (image != primsym) {
478 ret = spectrum_apply_pda(hw, first_block, pda);
479 if (ret)
480 return ret;
481 }
482
483 /* Run the firmware */
484 ret = spectrum_reset(link, 0);
485 if (ret)
486 return ret;
487
488 /* Reset hermes chip and make sure it responds */
489 ret = hermes_init(hw);
490
491 /* hermes_reset() should return 0 with the secondary firmware */
492 if (image != primsym && ret != 0)
493 return -ENODEV;
494
495 /* And this should work with any firmware */
496 if (!hermes_present(hw))
497 return -ENODEV;
498
499 return 0;
500}
501
502
503/*
504 * Download the firmware into the card, this also does a PCMCIA soft
505 * reset on the card, to make sure it's in a sane state.
506 */
507static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200508spectrum_dl_firmware(hermes_t *hw, struct pcmcia_device *link)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400509{
510 int ret;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400511 const struct firmware *fw_entry;
512
513 if (request_firmware(&fw_entry, primary_fw_name,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200514 &handle_to_dev(link)) == 0) {
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400515 primsym = fw_entry->data;
516 } else {
517 printk(KERN_ERR PFX "Cannot find firmware: %s\n",
518 primary_fw_name);
519 return -ENOENT;
520 }
521
522 if (request_firmware(&fw_entry, secondary_fw_name,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200523 &handle_to_dev(link)) == 0) {
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400524 secsym = fw_entry->data;
525 } else {
526 printk(KERN_ERR PFX "Cannot find firmware: %s\n",
527 secondary_fw_name);
528 return -ENOENT;
529 }
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400530
531 /* Load primary firmware */
532 ret = spectrum_dl_image(hw, link, primsym);
533 if (ret) {
534 printk(KERN_ERR PFX "Primary firmware download failed\n");
535 return ret;
536 }
537
538 /* Load secondary firmware */
539 ret = spectrum_dl_image(hw, link, secsym);
540
541 if (ret) {
542 printk(KERN_ERR PFX "Secondary firmware download failed\n");
543 }
544
545 return ret;
546}
547
548/********************************************************************/
549/* Device methods */
550/********************************************************************/
551
552static int
553spectrum_cs_hard_reset(struct orinoco_private *priv)
554{
555 struct orinoco_pccard *card = priv->card;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200556 struct pcmcia_device *link = card->p_dev;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400557 int err;
558
559 if (!hermes_present(&priv->hw)) {
560 /* The firmware needs to be reloaded */
Dominik Brodowskifd238232006-03-05 10:45:09 +0100561 if (spectrum_dl_firmware(&priv->hw, link) != 0) {
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400562 printk(KERN_ERR PFX "Firmware download failed\n");
563 err = -ENODEV;
564 }
565 } else {
566 /* Soft reset using COR and HCR */
567 spectrum_reset(link, 0);
568 }
569
570 return 0;
571}
572
573/********************************************************************/
574/* PCMCIA stuff */
575/********************************************************************/
576
577/*
578 * This creates an "instance" of the driver, allocating local data
579 * structures for one device. The device is registered with Card
580 * Services.
581 *
582 * The dev_link structure is initialized, but we don't actually
583 * configure the card at this point -- we wait until we receive a card
584 * insertion event. */
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100585static int
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200586spectrum_cs_probe(struct pcmcia_device *link)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400587{
588 struct net_device *dev;
589 struct orinoco_private *priv;
590 struct orinoco_pccard *card;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400591
592 dev = alloc_orinocodev(sizeof(*card), spectrum_cs_hard_reset);
593 if (! dev)
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100594 return -ENOMEM;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400595 priv = netdev_priv(dev);
596 card = priv->card;
597
598 /* Link both structures together */
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200599 card->p_dev = link;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400600 link->priv = dev;
601
602 /* Interrupt setup */
603 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
604 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
605 link->irq.Handler = orinoco_interrupt;
606 link->irq.Instance = dev;
607
608 /* General socket configuration defaults can go here. In this
609 * client, we assume very little, and rely on the CIS for
610 * almost everything. In most clients, many details (i.e.,
611 * number, sizes, and attributes of IO windows) are fixed by
612 * the nature of the device, and can be hard-wired here. */
613 link->conf.Attributes = 0;
614 link->conf.IntType = INT_MEMORY_AND_IO;
615
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200616 return spectrum_cs_config(link);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400617} /* spectrum_cs_attach */
618
619/*
620 * This deletes a driver "instance". The device is de-registered with
621 * Card Services. If it has been released, all local data structures
622 * are freed. Otherwise, the structures will be freed when the device
623 * is released.
624 */
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200625static void spectrum_cs_detach(struct pcmcia_device *link)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400626{
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400627 struct net_device *dev = link->priv;
628
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100629 spectrum_cs_release(link);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400630
Dominik Brodowskifd238232006-03-05 10:45:09 +0100631 DEBUG(0, PFX "detach: link=%p link->dev_node=%p\n", link, link->dev_node);
632 if (link->dev_node) {
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400633 DEBUG(0, PFX "About to unregister net device %p\n",
634 dev);
635 unregister_netdev(dev);
636 }
637 free_orinocodev(dev);
638} /* spectrum_cs_detach */
639
640/*
641 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
642 * event is received, to configure the PCMCIA socket, and to make the
643 * device available to the system.
644 */
645
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200646static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200647spectrum_cs_config(struct pcmcia_device *link)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400648{
649 struct net_device *dev = link->priv;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400650 struct orinoco_private *priv = netdev_priv(dev);
651 struct orinoco_pccard *card = priv->card;
652 hermes_t *hw = &priv->hw;
653 int last_fn, last_ret;
654 u_char buf[64];
655 config_info_t conf;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400656 tuple_t tuple;
657 cisparse_t parse;
658 void __iomem *mem;
659
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400660 /*
661 * This reads the card's CONFIG tuple to find its
662 * configuration registers.
663 */
664 tuple.DesiredTuple = CISTPL_CONFIG;
665 tuple.Attributes = 0;
666 tuple.TupleData = buf;
667 tuple.TupleDataMax = sizeof(buf);
668 tuple.TupleOffset = 0;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200669 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
670 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
671 CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400672 link->conf.ConfigBase = parse.config.base;
673 link->conf.Present = parse.config.rmask[0];
674
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400675 /* Look up the current Vcc */
676 CS_CHECK(GetConfigurationInfo,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200677 pcmcia_get_configuration_info(link, &conf));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400678
679 /*
680 * In this loop, we scan the CIS for configuration table
681 * entries, each of which describes a valid card
682 * configuration, including voltage, IO window, memory window,
683 * and interrupt settings.
684 *
685 * We make no assumptions about the card to be configured: we
686 * use just the information available in the CIS. In an ideal
687 * world, this would work for any PCMCIA card, but it requires
688 * a complete and accurate CIS. In practice, a driver usually
689 * "knows" most of these things without consulting the CIS,
690 * and most client drivers will only use the CIS to fill in
691 * implementation-defined details.
692 */
693 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200694 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400695 while (1) {
696 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
697 cistpl_cftable_entry_t dflt = { .index = 0 };
698
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200699 if ( (pcmcia_get_tuple_data(link, &tuple) != 0)
700 || (pcmcia_parse_tuple(link, &tuple, &parse) != 0))
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400701 goto next_entry;
702
703 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
704 dflt = *cfg;
705 if (cfg->index == 0)
706 goto next_entry;
707 link->conf.ConfigIndex = cfg->index;
708
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400709 /* Use power settings for Vcc and Vpp if present */
710 /* Note that the CIS values need to be rescaled */
711 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
712 if (conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000) {
713 DEBUG(2, "spectrum_cs_config: Vcc mismatch (conf.Vcc = %d, CIS = %d)\n", conf.Vcc, cfg->vcc.param[CISTPL_POWER_VNOM] / 10000);
714 if (!ignore_cis_vcc)
715 goto next_entry;
716 }
717 } else if (dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
718 if (conf.Vcc != dflt.vcc.param[CISTPL_POWER_VNOM] / 10000) {
719 DEBUG(2, "spectrum_cs_config: Vcc mismatch (conf.Vcc = %d, CIS = %d)\n", conf.Vcc, dflt.vcc.param[CISTPL_POWER_VNOM] / 10000);
720 if(!ignore_cis_vcc)
721 goto next_entry;
722 }
723 }
724
725 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
Dominik Brodowski70294b42006-01-15 12:43:16 +0100726 link->conf.Vpp =
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400727 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
728 else if (dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
Dominik Brodowski70294b42006-01-15 12:43:16 +0100729 link->conf.Vpp =
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400730 dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
731
732 /* Do we need to allocate an interrupt? */
733 link->conf.Attributes |= CONF_ENABLE_IRQ;
734
735 /* IO window settings */
736 link->io.NumPorts1 = link->io.NumPorts2 = 0;
737 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
738 cistpl_io_t *io =
739 (cfg->io.nwin) ? &cfg->io : &dflt.io;
740 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
741 if (!(io->flags & CISTPL_IO_8BIT))
742 link->io.Attributes1 =
743 IO_DATA_PATH_WIDTH_16;
744 if (!(io->flags & CISTPL_IO_16BIT))
745 link->io.Attributes1 =
746 IO_DATA_PATH_WIDTH_8;
747 link->io.IOAddrLines =
748 io->flags & CISTPL_IO_LINES_MASK;
749 link->io.BasePort1 = io->win[0].base;
750 link->io.NumPorts1 = io->win[0].len;
751 if (io->nwin > 1) {
752 link->io.Attributes2 =
753 link->io.Attributes1;
754 link->io.BasePort2 = io->win[1].base;
755 link->io.NumPorts2 = io->win[1].len;
756 }
757
758 /* This reserves IO space but doesn't actually enable it */
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200759 if (pcmcia_request_io(link, &link->io) != 0)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400760 goto next_entry;
761 }
762
763
764 /* If we got this far, we're cool! */
765
766 break;
767
768 next_entry:
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200769 pcmcia_disable_device(link);
770 last_ret = pcmcia_get_next_tuple(link, &tuple);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400771 if (last_ret == CS_NO_MORE_ITEMS) {
772 printk(KERN_ERR PFX "GetNextTuple(): No matching "
773 "CIS configuration. Maybe you need the "
774 "ignore_cis_vcc=1 parameter.\n");
775 goto cs_failed;
776 }
777 }
778
779 /*
780 * Allocate an interrupt line. Note that this does not assign
781 * a handler to the interrupt, unless the 'Handler' member of
782 * the irq structure is initialized.
783 */
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200784 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400785
786 /* We initialize the hermes structure before completing PCMCIA
787 * configuration just in case the interrupt handler gets
788 * called. */
789 mem = ioport_map(link->io.BasePort1, link->io.NumPorts1);
790 if (!mem)
791 goto cs_failed;
792
793 hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
794
795 /*
796 * This actually configures the PCMCIA socket -- setting up
797 * the I/O windows and the interrupt mapping, and putting the
798 * card and host interface into "Memory and IO" mode.
799 */
800 CS_CHECK(RequestConfiguration,
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200801 pcmcia_request_configuration(link, &link->conf));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400802
803 /* Ok, we have the configuration, prepare to register the netdev */
804 dev->base_addr = link->io.BasePort1;
805 dev->irq = link->irq.AssignedIRQ;
806 SET_MODULE_OWNER(dev);
807 card->node.major = card->node.minor = 0;
808
809 /* Reset card and download firmware */
810 if (spectrum_cs_hard_reset(priv) != 0) {
811 goto failed;
812 }
813
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200814 SET_NETDEV_DEV(dev, &handle_to_dev(link));
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400815 /* Tell the stack we exist */
816 if (register_netdev(dev) != 0) {
817 printk(KERN_ERR PFX "register_netdev() failed\n");
818 goto failed;
819 }
820
821 /* At this point, the dev_node_t structure(s) needs to be
Dominik Brodowskifd238232006-03-05 10:45:09 +0100822 * initialized and arranged in a linked list at link->dev_node. */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400823 strcpy(card->node.dev_name, dev->name);
Dominik Brodowskifd238232006-03-05 10:45:09 +0100824 link->dev_node = &card->node; /* link->dev_node being non-NULL is also
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400825 used to indicate that the
826 net_device has been registered */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400827
828 /* Finally, report what we've done */
Dominik Brodowski70294b42006-01-15 12:43:16 +0100829 printk(KERN_DEBUG "%s: index 0x%02x: ",
830 dev->name, link->conf.ConfigIndex);
831 if (link->conf.Vpp)
832 printk(", Vpp %d.%d", link->conf.Vpp / 10,
833 link->conf.Vpp % 10);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400834 printk(", irq %d", link->irq.AssignedIRQ);
835 if (link->io.NumPorts1)
836 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
837 link->io.BasePort1 + link->io.NumPorts1 - 1);
838 if (link->io.NumPorts2)
839 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
840 link->io.BasePort2 + link->io.NumPorts2 - 1);
841 printk("\n");
842
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200843 return 0;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400844
845 cs_failed:
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200846 cs_error(link, last_fn, last_ret);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400847
848 failed:
849 spectrum_cs_release(link);
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200850 return -ENODEV;
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400851} /* spectrum_cs_config */
852
853/*
854 * After a card is removed, spectrum_cs_release() will unregister the
855 * device, and release the PCMCIA configuration. If the device is
856 * still open, this will be postponed until it is closed.
857 */
858static void
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200859spectrum_cs_release(struct pcmcia_device *link)
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400860{
861 struct net_device *dev = link->priv;
862 struct orinoco_private *priv = netdev_priv(dev);
863 unsigned long flags;
864
865 /* We're committed to taking the device away now, so mark the
866 * hardware as unavailable */
867 spin_lock_irqsave(&priv->lock, flags);
868 priv->hw_unavailable++;
869 spin_unlock_irqrestore(&priv->lock, flags);
870
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200871 pcmcia_disable_device(link);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400872 if (priv->hw.iobase)
873 ioport_unmap(priv->hw.iobase);
874} /* spectrum_cs_release */
875
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100876
877static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200878spectrum_cs_suspend(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100879{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100880 struct net_device *dev = link->priv;
881 struct orinoco_private *priv = netdev_priv(dev);
882 unsigned long flags;
883 int err = 0;
884
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100885 /* Mark the device as stopped, to block IO until later */
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100886 spin_lock_irqsave(&priv->lock, flags);
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100887
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100888 err = __orinoco_down(dev);
889 if (err)
890 printk(KERN_WARNING "%s: Error %d downing interface\n",
891 dev->name, err);
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100892
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100893 netif_device_detach(dev);
894 priv->hw_unavailable++;
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100895
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100896 spin_unlock_irqrestore(&priv->lock, flags);
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100897
898 return 0;
899}
900
901static int
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200902spectrum_cs_resume(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100903{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100904 struct net_device *dev = link->priv;
905 struct orinoco_private *priv = netdev_priv(dev);
906
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100907 netif_device_attach(dev);
908 priv->hw_unavailable--;
909 schedule_work(&priv->reset_work);
910
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100911 return 0;
912}
913
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400914
915/********************************************************************/
916/* Module initialization */
917/********************************************************************/
918
919/* Can't be declared "const" or the whole __initdata section will
920 * become const */
921static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
922 " (Pavel Roskin <proski@gnu.org>,"
923 " David Gibson <hermes@gibson.dropbear.id.au>, et al)";
924
925static struct pcmcia_device_id spectrum_cs_ids[] = {
Pavel Roskin4ebe2eb2006-04-07 04:10:32 -0400926 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400927 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
Pavel Roskin9c8a11d2005-09-16 02:18:31 -0400928 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400929 PCMCIA_DEVICE_NULL,
930};
931MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);
932
933static struct pcmcia_driver orinoco_driver = {
934 .owner = THIS_MODULE,
935 .drv = {
936 .name = DRIVER_NAME,
937 },
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200938 .probe = spectrum_cs_probe,
Dominik Brodowskicc3b4862005-11-14 21:23:14 +0100939 .remove = spectrum_cs_detach,
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100940 .suspend = spectrum_cs_suspend,
941 .resume = spectrum_cs_resume,
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400942 .id_table = spectrum_cs_ids,
943};
944
945static int __init
946init_spectrum_cs(void)
947{
948 printk(KERN_DEBUG "%s\n", version);
949
950 return pcmcia_register_driver(&orinoco_driver);
951}
952
953static void __exit
954exit_spectrum_cs(void)
955{
956 pcmcia_unregister_driver(&orinoco_driver);
Pavel Roskin3a48c4c2005-09-01 20:10:06 -0400957}
958
959module_init(init_spectrum_cs);
960module_exit(exit_spectrum_cs);