3 * Linux device driver for PCI based Prism54
5 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
7 * Based on the islsm (softmac prism54) driver, which is:
8 * Copyright 2004-2006 Jean-Baptiste Note <jean-baptiste.note@m4x.org>, et al.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/init.h>
16 #include <linux/pci.h>
17 #include <linux/firmware.h>
18 #include <linux/etherdevice.h>
19 #include <linux/delay.h>
20 #include <linux/completion.h>
21 #include <net/mac80211.h>
26 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
27 MODULE_DESCRIPTION("Prism54 PCI wireless driver");
28 MODULE_LICENSE("GPL");
29 MODULE_ALIAS("prism54pci");
31 static struct pci_device_id p54p_table[] __devinitdata = {
32 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
33 { PCI_DEVICE(0x1260, 0x3890) },
34 /* 3COM 3CRWE154G72 Wireless LAN adapter */
35 { PCI_DEVICE(0x10b7, 0x6001) },
36 /* Intersil PRISM Indigo Wireless LAN adapter */
37 { PCI_DEVICE(0x1260, 0x3877) },
38 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
39 { PCI_DEVICE(0x1260, 0x3886) },
42 MODULE_DEVICE_TABLE(pci, p54p_table);
44 static int p54p_upload_firmware(struct ieee80211_hw *dev)
46 struct p54p_priv *priv = dev->priv;
47 const struct firmware *fw_entry = NULL;
51 u32 remains, left, device_addr;
53 P54P_WRITE(int_enable, 0);
54 P54P_READ(int_enable);
57 reg = P54P_READ(ctrl_stat);
58 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
59 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RAMBOOT);
60 P54P_WRITE(ctrl_stat, reg);
64 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
65 P54P_WRITE(ctrl_stat, reg);
69 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
70 P54P_WRITE(ctrl_stat, reg);
75 err = request_firmware(&fw_entry, "isl3886", &priv->pdev->dev);
77 printk(KERN_ERR "%s (prism54pci): cannot find firmware "
78 "(isl3886)\n", pci_name(priv->pdev));
82 p54_parse_firmware(dev, fw_entry);
84 data = (u32 *) fw_entry->data;
85 remains = fw_entry->size;
86 device_addr = ISL38XX_DEV_FIRMWARE_ADDR;
89 left = min((u32)0x1000, remains);
90 P54P_WRITE(direct_mem_base, cpu_to_le32(device_addr));
91 P54P_READ(int_enable);
93 device_addr += 0x1000;
95 P54P_WRITE(direct_mem_win[i], *data++);
100 P54P_READ(int_enable);
103 release_firmware(fw_entry);
105 reg = P54P_READ(ctrl_stat);
106 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN);
107 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
108 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RAMBOOT);
109 P54P_WRITE(ctrl_stat, reg);
110 P54P_READ(ctrl_stat);
113 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
114 P54P_WRITE(ctrl_stat, reg);
118 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
119 P54P_WRITE(ctrl_stat, reg);
126 static irqreturn_t p54p_simple_interrupt(int irq, void *dev_id)
128 struct p54p_priv *priv = (struct p54p_priv *) dev_id;
131 reg = P54P_READ(int_ident);
132 P54P_WRITE(int_ack, reg);
134 if (reg & P54P_READ(int_enable))
135 complete(&priv->boot_comp);
140 static int p54p_read_eeprom(struct ieee80211_hw *dev)
142 struct p54p_priv *priv = dev->priv;
144 struct p54_control_hdr *hdr;
146 dma_addr_t rx_mapping, tx_mapping;
149 init_completion(&priv->boot_comp);
150 err = request_irq(priv->pdev->irq, &p54p_simple_interrupt,
151 IRQF_SHARED, "prism54pci", priv);
153 printk(KERN_ERR "%s (prism54pci): failed to register IRQ handler\n",
154 pci_name(priv->pdev));
158 eeprom = kmalloc(0x2010 + EEPROM_READBACK_LEN, GFP_KERNEL);
160 printk(KERN_ERR "%s (prism54pci): no memory for eeprom!\n",
161 pci_name(priv->pdev));
166 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
167 P54P_WRITE(ring_control_base, priv->ring_control_dma);
168 P54P_READ(ring_control_base);
171 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
172 P54P_READ(int_enable);
175 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
177 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
178 printk(KERN_ERR "%s (prism54pci): Cannot boot firmware!\n",
179 pci_name(priv->pdev));
184 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE));
185 P54P_READ(int_enable);
187 hdr = eeprom + 0x2010;
188 p54_fill_eeprom_readback(hdr);
189 hdr->req_id = cpu_to_le32(priv->common.rx_start);
191 rx_mapping = pci_map_single(priv->pdev, eeprom,
192 0x2010, PCI_DMA_FROMDEVICE);
193 tx_mapping = pci_map_single(priv->pdev, (void *)hdr,
194 EEPROM_READBACK_LEN, PCI_DMA_TODEVICE);
196 priv->ring_control->rx_mgmt[0].host_addr = cpu_to_le32(rx_mapping);
197 priv->ring_control->rx_mgmt[0].len = cpu_to_le16(0x2010);
198 priv->ring_control->tx_data[0].host_addr = cpu_to_le32(tx_mapping);
199 priv->ring_control->tx_data[0].device_addr = hdr->req_id;
200 priv->ring_control->tx_data[0].len = cpu_to_le16(EEPROM_READBACK_LEN);
202 priv->ring_control->host_idx[2] = cpu_to_le32(1);
203 priv->ring_control->host_idx[1] = cpu_to_le32(1);
207 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
209 wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ);
210 wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ);
212 pci_unmap_single(priv->pdev, tx_mapping,
213 EEPROM_READBACK_LEN, PCI_DMA_TODEVICE);
214 pci_unmap_single(priv->pdev, rx_mapping,
215 0x2010, PCI_DMA_FROMDEVICE);
217 alen = le16_to_cpu(priv->ring_control->rx_mgmt[0].len);
218 if (le32_to_cpu(priv->ring_control->device_idx[2]) != 1 ||
220 printk(KERN_ERR "%s (prism54pci): Cannot read eeprom!\n",
221 pci_name(priv->pdev));
226 p54_parse_eeprom(dev, (u8 *)eeprom + 0x10, alen - 0x10);
230 P54P_WRITE(int_enable, 0);
231 P54P_READ(int_enable);
233 free_irq(priv->pdev->irq, priv);
234 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
238 static void p54p_refill_rx_ring(struct ieee80211_hw *dev)
240 struct p54p_priv *priv = dev->priv;
241 u32 limit, host_idx, idx;
243 host_idx = le32_to_cpu(priv->ring_control->host_idx[0]);
245 limit -= le32_to_cpu(priv->ring_control->device_idx[0]);
246 limit = ARRAY_SIZE(priv->ring_control->rx_data) - limit;
248 idx = host_idx % ARRAY_SIZE(priv->ring_control->rx_data);
249 while (limit-- > 1) {
250 struct p54p_desc *desc = &priv->ring_control->rx_data[idx];
252 if (!desc->host_addr) {
255 skb = dev_alloc_skb(MAX_RX_SIZE);
259 mapping = pci_map_single(priv->pdev,
260 skb_tail_pointer(skb),
263 desc->host_addr = cpu_to_le32(mapping);
264 desc->device_addr = 0; // FIXME: necessary?
265 desc->len = cpu_to_le16(MAX_RX_SIZE);
267 priv->rx_buf[idx] = skb;
272 idx %= ARRAY_SIZE(priv->ring_control->rx_data);
276 priv->ring_control->host_idx[0] = cpu_to_le32(host_idx);
279 static irqreturn_t p54p_interrupt(int irq, void *dev_id)
281 struct ieee80211_hw *dev = dev_id;
282 struct p54p_priv *priv = dev->priv;
285 spin_lock(&priv->lock);
286 reg = P54P_READ(int_ident);
287 if (unlikely(reg == 0xFFFFFFFF)) {
288 spin_unlock(&priv->lock);
292 P54P_WRITE(int_ack, reg);
294 reg &= P54P_READ(int_enable);
296 if (reg & cpu_to_le32(ISL38XX_INT_IDENT_UPDATE)) {
297 struct p54p_desc *desc;
300 i %= ARRAY_SIZE(priv->ring_control->tx_data);
301 priv->tx_idx = idx = le32_to_cpu(priv->ring_control->device_idx[1]);
302 idx %= ARRAY_SIZE(priv->ring_control->tx_data);
305 desc = &priv->ring_control->tx_data[i];
306 if (priv->tx_buf[i]) {
307 kfree(priv->tx_buf[i]);
308 priv->tx_buf[i] = NULL;
311 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
312 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
315 desc->device_addr = 0;
320 i %= ARRAY_SIZE(priv->ring_control->tx_data);
324 i %= ARRAY_SIZE(priv->ring_control->rx_data);
325 priv->rx_idx = idx = le32_to_cpu(priv->ring_control->device_idx[0]);
326 idx %= ARRAY_SIZE(priv->ring_control->rx_data);
330 desc = &priv->ring_control->rx_data[i];
331 len = le16_to_cpu(desc->len);
332 skb = priv->rx_buf[i];
336 if (p54_rx(dev, skb)) {
337 pci_unmap_single(priv->pdev,
338 le32_to_cpu(desc->host_addr),
339 MAX_RX_SIZE, PCI_DMA_FROMDEVICE);
341 priv->rx_buf[i] = NULL;
345 desc->len = cpu_to_le16(MAX_RX_SIZE);
349 i %= ARRAY_SIZE(priv->ring_control->rx_data);
352 p54p_refill_rx_ring(dev);
355 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
356 } else if (reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT))
357 complete(&priv->boot_comp);
359 spin_unlock(&priv->lock);
361 return reg ? IRQ_HANDLED : IRQ_NONE;
364 static void p54p_tx(struct ieee80211_hw *dev, struct p54_control_hdr *data,
365 size_t len, int free_on_tx)
367 struct p54p_priv *priv = dev->priv;
369 struct p54p_desc *desc;
371 u32 device_idx, idx, i;
373 spin_lock_irqsave(&priv->lock, flags);
375 device_idx = le32_to_cpu(priv->ring_control->device_idx[1]);
376 idx = le32_to_cpu(priv->ring_control->host_idx[1]);
377 i = idx % ARRAY_SIZE(priv->ring_control->tx_data);
379 mapping = pci_map_single(priv->pdev, data, len, PCI_DMA_TODEVICE);
380 desc = &priv->ring_control->tx_data[i];
381 desc->host_addr = cpu_to_le32(mapping);
382 desc->device_addr = data->req_id;
383 desc->len = cpu_to_le16(len);
387 priv->ring_control->host_idx[1] = cpu_to_le32(idx + 1);
390 priv->tx_buf[i] = data;
392 spin_unlock_irqrestore(&priv->lock, flags);
394 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
397 /* FIXME: unlikely to happen because the device usually runs out of
398 memory before we fill the ring up, but we can make it impossible */
399 if (idx - device_idx > ARRAY_SIZE(priv->ring_control->tx_data) - 2)
400 printk(KERN_INFO "%s: tx overflow.\n", wiphy_name(dev->wiphy));
403 static int p54p_open(struct ieee80211_hw *dev)
405 struct p54p_priv *priv = dev->priv;
408 init_completion(&priv->boot_comp);
409 err = request_irq(priv->pdev->irq, &p54p_interrupt,
410 IRQF_SHARED, "prism54pci", dev);
412 printk(KERN_ERR "%s: failed to register IRQ handler\n",
413 wiphy_name(dev->wiphy));
417 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
418 priv->rx_idx = priv->tx_idx = 0;
419 p54p_refill_rx_ring(dev);
421 p54p_upload_firmware(dev);
423 P54P_WRITE(ring_control_base, priv->ring_control_dma);
424 P54P_READ(ring_control_base);
428 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
429 P54P_READ(int_enable);
433 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
436 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
437 printk(KERN_ERR "%s: Cannot boot firmware!\n",
438 wiphy_name(dev->wiphy));
439 free_irq(priv->pdev->irq, dev);
443 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE));
444 P54P_READ(int_enable);
448 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
456 static void p54p_stop(struct ieee80211_hw *dev)
458 struct p54p_priv *priv = dev->priv;
460 struct p54p_desc *desc;
462 P54P_WRITE(int_enable, 0);
463 P54P_READ(int_enable);
466 free_irq(priv->pdev->irq, dev);
468 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
470 for (i = 0; i < ARRAY_SIZE(priv->rx_buf); i++) {
471 desc = &priv->ring_control->rx_data[i];
473 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
474 MAX_RX_SIZE, PCI_DMA_FROMDEVICE);
475 kfree_skb(priv->rx_buf[i]);
476 priv->rx_buf[i] = NULL;
479 for (i = 0; i < ARRAY_SIZE(priv->tx_buf); i++) {
480 desc = &priv->ring_control->tx_data[i];
482 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
483 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
485 kfree(priv->tx_buf[i]);
486 priv->tx_buf[i] = NULL;
489 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
492 static int __devinit p54p_probe(struct pci_dev *pdev,
493 const struct pci_device_id *id)
495 struct p54p_priv *priv;
496 struct ieee80211_hw *dev;
497 unsigned long mem_addr, mem_len;
499 DECLARE_MAC_BUF(mac);
501 err = pci_enable_device(pdev);
503 printk(KERN_ERR "%s (prism54pci): Cannot enable new PCI device\n",
508 mem_addr = pci_resource_start(pdev, 0);
509 mem_len = pci_resource_len(pdev, 0);
510 if (mem_len < sizeof(struct p54p_csr)) {
511 printk(KERN_ERR "%s (prism54pci): Too short PCI resources\n",
513 pci_disable_device(pdev);
517 err = pci_request_regions(pdev, "prism54pci");
519 printk(KERN_ERR "%s (prism54pci): Cannot obtain PCI resources\n",
524 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK) ||
525 pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK)) {
526 printk(KERN_ERR "%s (prism54pci): No suitable DMA available\n",
531 pci_set_master(pdev);
532 pci_try_set_mwi(pdev);
534 pci_write_config_byte(pdev, 0x40, 0);
535 pci_write_config_byte(pdev, 0x41, 0);
537 dev = p54_init_common(sizeof(*priv));
539 printk(KERN_ERR "%s (prism54pci): ieee80211 alloc failed\n",
548 SET_IEEE80211_DEV(dev, &pdev->dev);
549 pci_set_drvdata(pdev, dev);
551 priv->map = ioremap(mem_addr, mem_len);
553 printk(KERN_ERR "%s (prism54pci): Cannot map device memory\n",
555 err = -EINVAL; // TODO: use a better error code?
559 priv->ring_control = pci_alloc_consistent(pdev, sizeof(*priv->ring_control),
560 &priv->ring_control_dma);
561 if (!priv->ring_control) {
562 printk(KERN_ERR "%s (prism54pci): Cannot allocate rings\n",
567 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
569 err = p54p_upload_firmware(dev);
573 err = p54p_read_eeprom(dev);
577 priv->common.open = p54p_open;
578 priv->common.stop = p54p_stop;
579 priv->common.tx = p54p_tx;
581 spin_lock_init(&priv->lock);
583 err = ieee80211_register_hw(dev);
585 printk(KERN_ERR "%s (prism54pci): Cannot register netdevice\n",
587 goto err_free_common;
590 printk(KERN_INFO "%s: hwaddr %s, isl38%02x\n",
591 wiphy_name(dev->wiphy),
592 print_mac(mac, dev->wiphy->perm_addr),
593 priv->common.version);
598 p54_free_common(dev);
601 pci_free_consistent(pdev, sizeof(*priv->ring_control),
602 priv->ring_control, priv->ring_control_dma);
608 pci_set_drvdata(pdev, NULL);
609 ieee80211_free_hw(dev);
612 pci_release_regions(pdev);
613 pci_disable_device(pdev);
617 static void __devexit p54p_remove(struct pci_dev *pdev)
619 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
620 struct p54p_priv *priv;
625 ieee80211_unregister_hw(dev);
627 pci_free_consistent(pdev, sizeof(*priv->ring_control),
628 priv->ring_control, priv->ring_control_dma);
629 p54_free_common(dev);
631 pci_release_regions(pdev);
632 pci_disable_device(pdev);
633 ieee80211_free_hw(dev);
637 static int p54p_suspend(struct pci_dev *pdev, pm_message_t state)
639 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
640 struct p54p_priv *priv = dev->priv;
642 if (priv->common.mode != IEEE80211_IF_TYPE_MGMT) {
643 ieee80211_stop_queues(dev);
647 pci_save_state(pdev);
648 pci_set_power_state(pdev, pci_choose_state(pdev, state));
652 static int p54p_resume(struct pci_dev *pdev)
654 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
655 struct p54p_priv *priv = dev->priv;
657 pci_set_power_state(pdev, PCI_D0);
658 pci_restore_state(pdev);
660 if (priv->common.mode != IEEE80211_IF_TYPE_MGMT) {
662 ieee80211_start_queues(dev);
667 #endif /* CONFIG_PM */
669 static struct pci_driver p54p_driver = {
670 .name = "prism54pci",
671 .id_table = p54p_table,
673 .remove = __devexit_p(p54p_remove),
675 .suspend = p54p_suspend,
676 .resume = p54p_resume,
677 #endif /* CONFIG_PM */
680 static int __init p54p_init(void)
682 return pci_register_driver(&p54p_driver);
685 static void __exit p54p_exit(void)
687 pci_unregister_driver(&p54p_driver);
690 module_init(p54p_init);
691 module_exit(p54p_exit);