OLD | NEW |
(Empty) | |
| 1 /* |
| 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. |
| 5 * |
| 6 * The driver implements Symbol firmware download. The rest is handled |
| 7 * in hermes.c and main.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 main.c. |
| 19 */ |
| 20 |
| 21 #define DRIVER_NAME "spectrum_cs" |
| 22 #define PFX DRIVER_NAME ": " |
| 23 |
| 24 #include <linux/module.h> |
| 25 #include <linux/kernel.h> |
| 26 #include <linux/init.h> |
| 27 #include <linux/delay.h> |
| 28 #include <pcmcia/cs.h> |
| 29 #include <pcmcia/cistpl.h> |
| 30 #include <pcmcia/cisreg.h> |
| 31 #include <pcmcia/ds.h> |
| 32 |
| 33 #include "orinoco.h" |
| 34 |
| 35 /********************************************************************/ |
| 36 /* Module stuff */ |
| 37 /********************************************************************/ |
| 38 |
| 39 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>"); |
| 40 MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware dow
nloader"); |
| 41 MODULE_LICENSE("Dual MPL/GPL"); |
| 42 |
| 43 /* Module parameters */ |
| 44 |
| 45 /* Some D-Link cards have buggy CIS. They do work at 5v properly, but |
| 46 * don't have any CIS entry for it. This workaround it... */ |
| 47 static int ignore_cis_vcc; /* = 0 */ |
| 48 module_param(ignore_cis_vcc, int, 0); |
| 49 MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket
"); |
| 50 |
| 51 /********************************************************************/ |
| 52 /* Data structures */ |
| 53 /********************************************************************/ |
| 54 |
| 55 /* PCMCIA specific device information (goes in the card field of |
| 56 * struct orinoco_private */ |
| 57 struct orinoco_pccard { |
| 58 struct pcmcia_device *p_dev; |
| 59 }; |
| 60 |
| 61 /********************************************************************/ |
| 62 /* Function prototypes */ |
| 63 /********************************************************************/ |
| 64 |
| 65 static int spectrum_cs_config(struct pcmcia_device *link); |
| 66 static void spectrum_cs_release(struct pcmcia_device *link); |
| 67 |
| 68 /* Constants for the CISREG_CCSR register */ |
| 69 #define HCR_RUN 0x07 /* run firmware after reset */ |
| 70 #define HCR_IDLE 0x0E /* don't run firmware after reset */ |
| 71 #define HCR_MEM16 0x10 /* memory width bit, should be preserved */ |
| 72 |
| 73 |
| 74 /* |
| 75 * Reset the card using configuration registers COR and CCSR. |
| 76 * If IDLE is 1, stop the firmware, so that it can be safely rewritten. |
| 77 */ |
| 78 static int |
| 79 spectrum_reset(struct pcmcia_device *link, int idle) |
| 80 { |
| 81 int ret; |
| 82 u8 save_cor; |
| 83 u8 ccsr; |
| 84 |
| 85 /* Doing it if hardware is gone is guaranteed crash */ |
| 86 if (!pcmcia_dev_present(link)) |
| 87 return -ENODEV; |
| 88 |
| 89 /* Save original COR value */ |
| 90 ret = pcmcia_read_config_byte(link, CISREG_COR, &save_cor); |
| 91 if (ret) |
| 92 goto failed; |
| 93 |
| 94 /* Soft-Reset card */ |
| 95 ret = pcmcia_write_config_byte(link, CISREG_COR, |
| 96 (save_cor | COR_SOFT_RESET)); |
| 97 if (ret) |
| 98 goto failed; |
| 99 udelay(1000); |
| 100 |
| 101 /* Read CCSR */ |
| 102 ret = pcmcia_read_config_byte(link, CISREG_CCSR, &ccsr); |
| 103 if (ret) |
| 104 goto failed; |
| 105 |
| 106 /* |
| 107 * Start or stop the firmware. Memory width bit should be |
| 108 * preserved from the value we've just read. |
| 109 */ |
| 110 ccsr = (idle ? HCR_IDLE : HCR_RUN) | (ccsr & HCR_MEM16); |
| 111 ret = pcmcia_write_config_byte(link, CISREG_CCSR, ccsr); |
| 112 if (ret) |
| 113 goto failed; |
| 114 udelay(1000); |
| 115 |
| 116 /* Restore original COR configuration index */ |
| 117 ret = pcmcia_write_config_byte(link, CISREG_COR, |
| 118 (save_cor & ~COR_SOFT_RESET)); |
| 119 if (ret) |
| 120 goto failed; |
| 121 udelay(1000); |
| 122 return 0; |
| 123 |
| 124 failed: |
| 125 return -ENODEV; |
| 126 } |
| 127 |
| 128 /********************************************************************/ |
| 129 /* Device methods */ |
| 130 /********************************************************************/ |
| 131 |
| 132 static int |
| 133 spectrum_cs_hard_reset(struct orinoco_private *priv) |
| 134 { |
| 135 struct orinoco_pccard *card = priv->card; |
| 136 struct pcmcia_device *link = card->p_dev; |
| 137 |
| 138 /* Soft reset using COR and HCR */ |
| 139 spectrum_reset(link, 0); |
| 140 |
| 141 return 0; |
| 142 } |
| 143 |
| 144 static int |
| 145 spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle) |
| 146 { |
| 147 struct orinoco_pccard *card = priv->card; |
| 148 struct pcmcia_device *link = card->p_dev; |
| 149 |
| 150 return spectrum_reset(link, idle); |
| 151 } |
| 152 |
| 153 /********************************************************************/ |
| 154 /* PCMCIA stuff */ |
| 155 /********************************************************************/ |
| 156 |
| 157 /* |
| 158 * This creates an "instance" of the driver, allocating local data |
| 159 * structures for one device. The device is registered with Card |
| 160 * Services. |
| 161 * |
| 162 * The dev_link structure is initialized, but we don't actually |
| 163 * configure the card at this point -- we wait until we receive a card |
| 164 * insertion event. */ |
| 165 static int |
| 166 spectrum_cs_probe(struct pcmcia_device *link) |
| 167 { |
| 168 struct orinoco_private *priv; |
| 169 struct orinoco_pccard *card; |
| 170 |
| 171 priv = alloc_orinocodev(sizeof(*card), &link->dev, |
| 172 spectrum_cs_hard_reset, |
| 173 spectrum_cs_stop_firmware); |
| 174 if (!priv) |
| 175 return -ENOMEM; |
| 176 card = priv->card; |
| 177 |
| 178 /* Link both structures together */ |
| 179 card->p_dev = link; |
| 180 link->priv = priv; |
| 181 |
| 182 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,35)) |
| 183 /* Interrupt setup */ |
| 184 link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING; |
| 185 link->irq.Handler = orinoco_interrupt; |
| 186 #endif |
| 187 |
| 188 /* General socket configuration defaults can go here. In this |
| 189 * client, we assume very little, and rely on the CIS for |
| 190 * almost everything. In most clients, many details (i.e., |
| 191 * number, sizes, and attributes of IO windows) are fixed by |
| 192 * the nature of the device, and can be hard-wired here. */ |
| 193 link->conf.Attributes = 0; |
| 194 link->conf.IntType = INT_MEMORY_AND_IO; |
| 195 |
| 196 return spectrum_cs_config(link); |
| 197 } /* spectrum_cs_attach */ |
| 198 |
| 199 /* |
| 200 * This deletes a driver "instance". The device is de-registered with |
| 201 * Card Services. If it has been released, all local data structures |
| 202 * are freed. Otherwise, the structures will be freed when the device |
| 203 * is released. |
| 204 */ |
| 205 static void spectrum_cs_detach(struct pcmcia_device *link) |
| 206 { |
| 207 struct orinoco_private *priv = link->priv; |
| 208 |
| 209 orinoco_if_del(priv); |
| 210 |
| 211 spectrum_cs_release(link); |
| 212 |
| 213 free_orinocodev(priv); |
| 214 } /* spectrum_cs_detach */ |
| 215 |
| 216 /* |
| 217 * spectrum_cs_config() is scheduled to run after a CARD_INSERTION |
| 218 * event is received, to configure the PCMCIA socket, and to make the |
| 219 * device available to the system. |
| 220 */ |
| 221 |
| 222 static int spectrum_cs_config_check(struct pcmcia_device *p_dev, |
| 223 cistpl_cftable_entry_t *cfg, |
| 224 cistpl_cftable_entry_t *dflt, |
| 225 unsigned int vcc, |
| 226 void *priv_data) |
| 227 { |
| 228 if (cfg->index == 0) |
| 229 goto next_entry; |
| 230 |
| 231 /* Use power settings for Vcc and Vpp if present */ |
| 232 /* Note that the CIS values need to be rescaled */ |
| 233 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) { |
| 234 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000) { |
| 235 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n", |
| 236 __func__, vcc, |
| 237 cfg->vcc.param[CISTPL_POWER_VNOM] / 10000); |
| 238 if (!ignore_cis_vcc) |
| 239 goto next_entry; |
| 240 } |
| 241 } else if (dflt->vcc.present & (1 << CISTPL_POWER_VNOM)) { |
| 242 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM] / 10000) { |
| 243 DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n", |
| 244 __func__, vcc, |
| 245 dflt->vcc.param[CISTPL_POWER_VNOM] / 10000); |
| 246 if (!ignore_cis_vcc) |
| 247 goto next_entry; |
| 248 } |
| 249 } |
| 250 |
| 251 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM)) |
| 252 p_dev->conf.Vpp = |
| 253 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000; |
| 254 else if (dflt->vpp1.present & (1 << CISTPL_POWER_VNOM)) |
| 255 p_dev->conf.Vpp = |
| 256 dflt->vpp1.param[CISTPL_POWER_VNOM] / 10000; |
| 257 |
| 258 /* Do we need to allocate an interrupt? */ |
| 259 p_dev->conf.Attributes |= CONF_ENABLE_IRQ; |
| 260 |
| 261 /* IO window settings */ |
| 262 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36) |
| 263 p_dev->resource[0]->end = p_dev->resource[1]->end = 0; |
| 264 #else |
| 265 p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0; |
| 266 #endif |
| 267 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) { |
| 268 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io; |
| 269 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36) |
| 270 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK; |
| 271 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH; |
| 272 p_dev->resource[0]->flags |= |
| 273 pcmcia_io_cfg_data_width(io->flags); |
| 274 p_dev->resource[0]->start = io->win[0].base; |
| 275 p_dev->resource[0]->end = io->win[0].len; |
| 276 #else |
| 277 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO; |
| 278 if (!(io->flags & CISTPL_IO_8BIT)) |
| 279 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16; |
| 280 if (!(io->flags & CISTPL_IO_16BIT)) |
| 281 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8; |
| 282 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK; |
| 283 p_dev->io.BasePort1 = io->win[0].base; |
| 284 p_dev->io.NumPorts1 = io->win[0].len; |
| 285 #endif |
| 286 if (io->nwin > 1) { |
| 287 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36) |
| 288 p_dev->resource[1]->flags = p_dev->resource[0]->flags; |
| 289 p_dev->resource[1]->start = io->win[1].base; |
| 290 p_dev->resource[1]->end = io->win[1].len; |
| 291 #else |
| 292 p_dev->io.Attributes2 = p_dev->io.Attributes1; |
| 293 p_dev->io.BasePort2 = io->win[1].base; |
| 294 p_dev->io.NumPorts2 = io->win[1].len; |
| 295 #endif |
| 296 } |
| 297 |
| 298 /* This reserves IO space but doesn't actually enable it */ |
| 299 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36) |
| 300 if (pcmcia_request_io(p_dev) != 0) |
| 301 #else |
| 302 if (pcmcia_request_io(p_dev, &p_dev->io) != 0) |
| 303 #endif |
| 304 goto next_entry; |
| 305 } |
| 306 return 0; |
| 307 |
| 308 next_entry: |
| 309 pcmcia_disable_device(p_dev); |
| 310 return -ENODEV; |
| 311 }; |
| 312 |
| 313 static int |
| 314 spectrum_cs_config(struct pcmcia_device *link) |
| 315 { |
| 316 struct orinoco_private *priv = link->priv; |
| 317 hermes_t *hw = &priv->hw; |
| 318 int ret; |
| 319 void __iomem *mem; |
| 320 |
| 321 /* |
| 322 * In this loop, we scan the CIS for configuration table |
| 323 * entries, each of which describes a valid card |
| 324 * configuration, including voltage, IO window, memory window, |
| 325 * and interrupt settings. |
| 326 * |
| 327 * We make no assumptions about the card to be configured: we |
| 328 * use just the information available in the CIS. In an ideal |
| 329 * world, this would work for any PCMCIA card, but it requires |
| 330 * a complete and accurate CIS. In practice, a driver usually |
| 331 * "knows" most of these things without consulting the CIS, |
| 332 * and most client drivers will only use the CIS to fill in |
| 333 * implementation-defined details. |
| 334 */ |
| 335 ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL); |
| 336 if (ret) { |
| 337 if (!ignore_cis_vcc) |
| 338 printk(KERN_ERR PFX "GetNextTuple(): No matching " |
| 339 "CIS configuration. Maybe you need the " |
| 340 "ignore_cis_vcc=1 parameter.\n"); |
| 341 goto failed; |
| 342 } |
| 343 |
| 344 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)) |
| 345 ret = pcmcia_request_irq(link, orinoco_interrupt); |
| 346 #else |
| 347 ret = pcmcia_request_irq(link, &link->irq); |
| 348 #endif |
| 349 if (ret) |
| 350 goto failed; |
| 351 |
| 352 /* We initialize the hermes structure before completing PCMCIA |
| 353 * configuration just in case the interrupt handler gets |
| 354 * called. */ |
| 355 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36) |
| 356 mem = ioport_map(link->resource[0]->start, |
| 357 resource_size(link->resource[0])); |
| 358 #else |
| 359 mem = ioport_map(link->io.BasePort1, link->io.NumPorts1); |
| 360 #endif |
| 361 if (!mem) |
| 362 goto failed; |
| 363 |
| 364 hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING); |
| 365 hw->eeprom_pda = true; |
| 366 |
| 367 /* |
| 368 * This actually configures the PCMCIA socket -- setting up |
| 369 * the I/O windows and the interrupt mapping, and putting the |
| 370 * card and host interface into "Memory and IO" mode. |
| 371 */ |
| 372 ret = pcmcia_request_configuration(link, &link->conf); |
| 373 if (ret) |
| 374 goto failed; |
| 375 |
| 376 /* Reset card */ |
| 377 if (spectrum_cs_hard_reset(priv) != 0) |
| 378 goto failed; |
| 379 |
| 380 /* Initialise the main driver */ |
| 381 if (orinoco_init(priv) != 0) { |
| 382 printk(KERN_ERR PFX "orinoco_init() failed\n"); |
| 383 goto failed; |
| 384 } |
| 385 |
| 386 /* Register an interface with the stack */ |
| 387 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,36)) |
| 388 if (orinoco_if_add(priv, link->resource[0]->start, |
| 389 link->irq, NULL) != 0) { |
| 390 #elif (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35)) |
| 391 if (orinoco_if_add(priv, link->io.BasePort1, |
| 392 link->irq, NULL) != 0) { |
| 393 #else |
| 394 if (orinoco_if_add(priv, link->io.BasePort1, |
| 395 link->irq.AssignedIRQ, NULL) != 0) { |
| 396 #endif |
| 397 printk(KERN_ERR PFX "orinoco_if_add() failed\n"); |
| 398 goto failed; |
| 399 } |
| 400 |
| 401 return 0; |
| 402 |
| 403 failed: |
| 404 spectrum_cs_release(link); |
| 405 return -ENODEV; |
| 406 } /* spectrum_cs_config */ |
| 407 |
| 408 /* |
| 409 * After a card is removed, spectrum_cs_release() will unregister the |
| 410 * device, and release the PCMCIA configuration. If the device is |
| 411 * still open, this will be postponed until it is closed. |
| 412 */ |
| 413 static void |
| 414 spectrum_cs_release(struct pcmcia_device *link) |
| 415 { |
| 416 struct orinoco_private *priv = link->priv; |
| 417 unsigned long flags; |
| 418 |
| 419 /* We're committed to taking the device away now, so mark the |
| 420 * hardware as unavailable */ |
| 421 priv->hw.ops->lock_irqsave(&priv->lock, &flags); |
| 422 priv->hw_unavailable++; |
| 423 priv->hw.ops->unlock_irqrestore(&priv->lock, &flags); |
| 424 |
| 425 pcmcia_disable_device(link); |
| 426 if (priv->hw.iobase) |
| 427 ioport_unmap(priv->hw.iobase); |
| 428 } /* spectrum_cs_release */ |
| 429 |
| 430 |
| 431 static int |
| 432 spectrum_cs_suspend(struct pcmcia_device *link) |
| 433 { |
| 434 struct orinoco_private *priv = link->priv; |
| 435 int err = 0; |
| 436 |
| 437 /* Mark the device as stopped, to block IO until later */ |
| 438 orinoco_down(priv); |
| 439 |
| 440 return err; |
| 441 } |
| 442 |
| 443 static int |
| 444 spectrum_cs_resume(struct pcmcia_device *link) |
| 445 { |
| 446 struct orinoco_private *priv = link->priv; |
| 447 int err = orinoco_up(priv); |
| 448 |
| 449 return err; |
| 450 } |
| 451 |
| 452 |
| 453 /********************************************************************/ |
| 454 /* Module initialization */ |
| 455 /********************************************************************/ |
| 456 |
| 457 /* Can't be declared "const" or the whole __initdata section will |
| 458 * become const */ |
| 459 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION |
| 460 " (Pavel Roskin <proski@gnu.org>," |
| 461 " David Gibson <hermes@gibson.dropbear.id.au>, et al)"; |
| 462 |
| 463 static struct pcmcia_device_id spectrum_cs_ids[] = { |
| 464 PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */ |
| 465 PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */ |
| 466 PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815,
0x6fbf459a), /* 2011B, not 2011 */ |
| 467 PCMCIA_DEVICE_NULL, |
| 468 }; |
| 469 MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids); |
| 470 |
| 471 static struct pcmcia_driver orinoco_driver = { |
| 472 .owner = THIS_MODULE, |
| 473 .drv = { |
| 474 .name = DRIVER_NAME, |
| 475 }, |
| 476 .probe = spectrum_cs_probe, |
| 477 .remove = spectrum_cs_detach, |
| 478 .suspend = spectrum_cs_suspend, |
| 479 .resume = spectrum_cs_resume, |
| 480 .id_table = spectrum_cs_ids, |
| 481 }; |
| 482 |
| 483 static int __init |
| 484 init_spectrum_cs(void) |
| 485 { |
| 486 printk(KERN_DEBUG "%s\n", version); |
| 487 |
| 488 return pcmcia_register_driver(&orinoco_driver); |
| 489 } |
| 490 |
| 491 static void __exit |
| 492 exit_spectrum_cs(void) |
| 493 { |
| 494 pcmcia_unregister_driver(&orinoco_driver); |
| 495 } |
| 496 |
| 497 module_init(init_spectrum_cs); |
| 498 module_exit(exit_spectrum_cs); |
OLD | NEW |