3 * Linux device driver for PCI based Prism54
5 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
6 * Copyright (c) 2008, Christian Lamparter <chunkeey@web.de>
8 * Based on the islsm (softmac prism54) driver, which is:
9 * Copyright 2004-2006 Jean-Baptiste Note <jean-baptiste.note@m4x.org>, et al.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/init.h>
17 #include <linux/pci.h>
18 #include <linux/firmware.h>
19 #include <linux/etherdevice.h>
20 #include <linux/delay.h>
21 #include <linux/completion.h>
22 #include <net/mac80211.h>
27 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
28 MODULE_DESCRIPTION("Prism54 PCI wireless driver");
29 MODULE_LICENSE("GPL");
30 MODULE_ALIAS("prism54pci");
31 MODULE_FIRMWARE("isl3886pci");
33 static struct pci_device_id p54p_table[] __devinitdata = {
34 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
35 { PCI_DEVICE(0x1260, 0x3890) },
36 /* 3COM 3CRWE154G72 Wireless LAN adapter */
37 { PCI_DEVICE(0x10b7, 0x6001) },
38 /* Intersil PRISM Indigo Wireless LAN adapter */
39 { PCI_DEVICE(0x1260, 0x3877) },
40 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
41 { PCI_DEVICE(0x1260, 0x3886) },
45 MODULE_DEVICE_TABLE(pci, p54p_table);
47 static int p54p_upload_firmware(struct ieee80211_hw *dev)
49 struct p54p_priv *priv = dev->priv;
50 const struct firmware *fw_entry = NULL;
54 u32 remains, left, device_addr;
56 P54P_WRITE(int_enable, cpu_to_le32(0));
57 P54P_READ(int_enable);
60 reg = P54P_READ(ctrl_stat);
61 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
62 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RAMBOOT);
63 P54P_WRITE(ctrl_stat, reg);
67 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
68 P54P_WRITE(ctrl_stat, reg);
72 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
73 P54P_WRITE(ctrl_stat, reg);
76 err = request_firmware(&fw_entry, "isl3886pci", &priv->pdev->dev);
78 printk(KERN_ERR "%s (p54pci): cannot find firmware "
79 "(isl3886pci)\n", pci_name(priv->pdev));
80 err = request_firmware(&fw_entry, "isl3886", &priv->pdev->dev);
85 err = p54_parse_firmware(dev, fw_entry);
87 release_firmware(fw_entry);
91 data = (__le32 *) fw_entry->data;
92 remains = fw_entry->size;
93 device_addr = ISL38XX_DEV_FIRMWARE_ADDR;
96 left = min((u32)0x1000, remains);
97 P54P_WRITE(direct_mem_base, cpu_to_le32(device_addr));
98 P54P_READ(int_enable);
100 device_addr += 0x1000;
102 P54P_WRITE(direct_mem_win[i], *data++);
107 P54P_READ(int_enable);
110 release_firmware(fw_entry);
112 reg = P54P_READ(ctrl_stat);
113 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN);
114 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
115 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RAMBOOT);
116 P54P_WRITE(ctrl_stat, reg);
117 P54P_READ(ctrl_stat);
120 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
121 P54P_WRITE(ctrl_stat, reg);
125 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
126 P54P_WRITE(ctrl_stat, reg);
130 /* wait for the firmware to boot properly */
136 static void p54p_refill_rx_ring(struct ieee80211_hw *dev,
137 int ring_index, struct p54p_desc *ring, u32 ring_limit,
138 struct sk_buff **rx_buf)
140 struct p54p_priv *priv = dev->priv;
141 struct p54p_ring_control *ring_control = priv->ring_control;
144 idx = le32_to_cpu(ring_control->host_idx[ring_index]);
146 limit -= le32_to_cpu(ring_control->device_idx[ring_index]);
147 limit = ring_limit - limit;
149 i = idx % ring_limit;
150 while (limit-- > 1) {
151 struct p54p_desc *desc = &ring[i];
153 if (!desc->host_addr) {
156 skb = dev_alloc_skb(priv->common.rx_mtu + 32);
160 mapping = pci_map_single(priv->pdev,
161 skb_tail_pointer(skb),
162 priv->common.rx_mtu + 32,
164 desc->host_addr = cpu_to_le32(mapping);
165 desc->device_addr = 0; // FIXME: necessary?
166 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
177 ring_control->host_idx[ring_index] = cpu_to_le32(idx);
180 static void p54p_check_rx_ring(struct ieee80211_hw *dev, u32 *index,
181 int ring_index, struct p54p_desc *ring, u32 ring_limit,
182 struct sk_buff **rx_buf)
184 struct p54p_priv *priv = dev->priv;
185 struct p54p_ring_control *ring_control = priv->ring_control;
186 struct p54p_desc *desc;
189 i = (*index) % ring_limit;
190 (*index) = idx = le32_to_cpu(ring_control->device_idx[ring_index]);
196 len = le16_to_cpu(desc->len);
206 if (p54_rx(dev, skb)) {
207 pci_unmap_single(priv->pdev,
208 le32_to_cpu(desc->host_addr),
209 priv->common.rx_mtu + 32,
215 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
222 p54p_refill_rx_ring(dev, ring_index, ring, ring_limit, rx_buf);
225 /* caller must hold priv->lock */
226 static void p54p_check_tx_ring(struct ieee80211_hw *dev, u32 *index,
227 int ring_index, struct p54p_desc *ring, u32 ring_limit,
230 struct p54p_priv *priv = dev->priv;
231 struct p54p_ring_control *ring_control = priv->ring_control;
232 struct p54p_desc *desc;
235 i = (*index) % ring_limit;
236 (*index) = idx = le32_to_cpu(ring_control->device_idx[1]);
241 p54_free_skb(dev, tx_buf[i]);
244 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
245 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
248 desc->device_addr = 0;
257 static void p54p_rx_tasklet(unsigned long dev_id)
259 struct ieee80211_hw *dev = (struct ieee80211_hw *)dev_id;
260 struct p54p_priv *priv = dev->priv;
261 struct p54p_ring_control *ring_control = priv->ring_control;
263 p54p_check_rx_ring(dev, &priv->rx_idx_mgmt, 2, ring_control->rx_mgmt,
264 ARRAY_SIZE(ring_control->rx_mgmt), priv->rx_buf_mgmt);
266 p54p_check_rx_ring(dev, &priv->rx_idx_data, 0, ring_control->rx_data,
267 ARRAY_SIZE(ring_control->rx_data), priv->rx_buf_data);
270 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
273 static irqreturn_t p54p_interrupt(int irq, void *dev_id)
275 struct ieee80211_hw *dev = dev_id;
276 struct p54p_priv *priv = dev->priv;
277 struct p54p_ring_control *ring_control = priv->ring_control;
280 spin_lock(&priv->lock);
281 reg = P54P_READ(int_ident);
282 if (unlikely(reg == cpu_to_le32(0xFFFFFFFF))) {
283 spin_unlock(&priv->lock);
287 P54P_WRITE(int_ack, reg);
289 reg &= P54P_READ(int_enable);
291 if (reg & cpu_to_le32(ISL38XX_INT_IDENT_UPDATE)) {
292 p54p_check_tx_ring(dev, &priv->tx_idx_mgmt,
293 3, ring_control->tx_mgmt,
294 ARRAY_SIZE(ring_control->tx_mgmt),
297 p54p_check_tx_ring(dev, &priv->tx_idx_data,
298 1, ring_control->tx_data,
299 ARRAY_SIZE(ring_control->tx_data),
302 tasklet_schedule(&priv->rx_tasklet);
304 } else if (reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT))
305 complete(&priv->boot_comp);
307 spin_unlock(&priv->lock);
309 return reg ? IRQ_HANDLED : IRQ_NONE;
312 static void p54p_tx(struct ieee80211_hw *dev, struct sk_buff *skb,
315 struct p54p_priv *priv = dev->priv;
316 struct p54p_ring_control *ring_control = priv->ring_control;
318 struct p54p_desc *desc;
320 u32 device_idx, idx, i;
322 spin_lock_irqsave(&priv->lock, flags);
324 device_idx = le32_to_cpu(ring_control->device_idx[1]);
325 idx = le32_to_cpu(ring_control->host_idx[1]);
326 i = idx % ARRAY_SIZE(ring_control->tx_data);
328 mapping = pci_map_single(priv->pdev, skb->data, skb->len,
330 desc = &ring_control->tx_data[i];
331 desc->host_addr = cpu_to_le32(mapping);
332 desc->device_addr = ((struct p54_hdr *)skb->data)->req_id;
333 desc->len = cpu_to_le16(skb->len);
337 ring_control->host_idx[1] = cpu_to_le32(idx + 1);
340 priv->tx_buf_data[i] = skb;
342 spin_unlock_irqrestore(&priv->lock, flags);
344 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
347 /* FIXME: unlikely to happen because the device usually runs out of
348 memory before we fill the ring up, but we can make it impossible */
349 if (idx - device_idx > ARRAY_SIZE(ring_control->tx_data) - 2) {
350 p54_free_skb(dev, skb);
351 printk(KERN_INFO "%s: tx overflow.\n", wiphy_name(dev->wiphy));
355 static void p54p_stop(struct ieee80211_hw *dev)
357 struct p54p_priv *priv = dev->priv;
358 struct p54p_ring_control *ring_control = priv->ring_control;
360 struct p54p_desc *desc;
362 tasklet_kill(&priv->rx_tasklet);
364 P54P_WRITE(int_enable, cpu_to_le32(0));
365 P54P_READ(int_enable);
368 free_irq(priv->pdev->irq, dev);
370 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
372 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_data); i++) {
373 desc = &ring_control->rx_data[i];
375 pci_unmap_single(priv->pdev,
376 le32_to_cpu(desc->host_addr),
377 priv->common.rx_mtu + 32,
379 kfree_skb(priv->rx_buf_data[i]);
380 priv->rx_buf_data[i] = NULL;
383 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_mgmt); i++) {
384 desc = &ring_control->rx_mgmt[i];
386 pci_unmap_single(priv->pdev,
387 le32_to_cpu(desc->host_addr),
388 priv->common.rx_mtu + 32,
390 kfree_skb(priv->rx_buf_mgmt[i]);
391 priv->rx_buf_mgmt[i] = NULL;
394 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_data); i++) {
395 desc = &ring_control->tx_data[i];
397 pci_unmap_single(priv->pdev,
398 le32_to_cpu(desc->host_addr),
399 le16_to_cpu(desc->len),
402 p54_free_skb(dev, priv->tx_buf_data[i]);
403 priv->tx_buf_data[i] = NULL;
406 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_mgmt); i++) {
407 desc = &ring_control->tx_mgmt[i];
409 pci_unmap_single(priv->pdev,
410 le32_to_cpu(desc->host_addr),
411 le16_to_cpu(desc->len),
414 p54_free_skb(dev, priv->tx_buf_mgmt[i]);
415 priv->tx_buf_mgmt[i] = NULL;
418 memset(ring_control, 0, sizeof(*ring_control));
421 static int p54p_open(struct ieee80211_hw *dev)
423 struct p54p_priv *priv = dev->priv;
426 init_completion(&priv->boot_comp);
427 err = request_irq(priv->pdev->irq, &p54p_interrupt,
428 IRQF_SHARED, "p54pci", dev);
430 printk(KERN_ERR "%s: failed to register IRQ handler\n",
431 wiphy_name(dev->wiphy));
435 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
436 err = p54p_upload_firmware(dev);
438 free_irq(priv->pdev->irq, dev);
441 priv->rx_idx_data = priv->tx_idx_data = 0;
442 priv->rx_idx_mgmt = priv->tx_idx_mgmt = 0;
444 p54p_refill_rx_ring(dev, 0, priv->ring_control->rx_data,
445 ARRAY_SIZE(priv->ring_control->rx_data), priv->rx_buf_data);
447 p54p_refill_rx_ring(dev, 2, priv->ring_control->rx_mgmt,
448 ARRAY_SIZE(priv->ring_control->rx_mgmt), priv->rx_buf_mgmt);
450 P54P_WRITE(ring_control_base, cpu_to_le32(priv->ring_control_dma));
451 P54P_READ(ring_control_base);
455 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
456 P54P_READ(int_enable);
460 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
463 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
464 printk(KERN_ERR "%s: Cannot boot firmware!\n",
465 wiphy_name(dev->wiphy));
470 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE));
471 P54P_READ(int_enable);
475 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
483 static int __devinit p54p_probe(struct pci_dev *pdev,
484 const struct pci_device_id *id)
486 struct p54p_priv *priv;
487 struct ieee80211_hw *dev;
488 unsigned long mem_addr, mem_len;
491 err = pci_enable_device(pdev);
493 printk(KERN_ERR "%s (p54pci): Cannot enable new PCI device\n",
498 mem_addr = pci_resource_start(pdev, 0);
499 mem_len = pci_resource_len(pdev, 0);
500 if (mem_len < sizeof(struct p54p_csr)) {
501 printk(KERN_ERR "%s (p54pci): Too short PCI resources\n",
503 pci_disable_device(pdev);
507 err = pci_request_regions(pdev, "p54pci");
509 printk(KERN_ERR "%s (p54pci): Cannot obtain PCI resources\n",
514 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK) ||
515 pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK)) {
516 printk(KERN_ERR "%s (p54pci): No suitable DMA available\n",
521 pci_set_master(pdev);
522 pci_try_set_mwi(pdev);
524 pci_write_config_byte(pdev, 0x40, 0);
525 pci_write_config_byte(pdev, 0x41, 0);
527 dev = p54_init_common(sizeof(*priv));
529 printk(KERN_ERR "%s (p54pci): ieee80211 alloc failed\n",
538 SET_IEEE80211_DEV(dev, &pdev->dev);
539 pci_set_drvdata(pdev, dev);
541 priv->map = ioremap(mem_addr, mem_len);
543 printk(KERN_ERR "%s (p54pci): Cannot map device memory\n",
545 err = -EINVAL; // TODO: use a better error code?
549 priv->ring_control = pci_alloc_consistent(pdev, sizeof(*priv->ring_control),
550 &priv->ring_control_dma);
551 if (!priv->ring_control) {
552 printk(KERN_ERR "%s (p54pci): Cannot allocate rings\n",
557 priv->common.open = p54p_open;
558 priv->common.stop = p54p_stop;
559 priv->common.tx = p54p_tx;
561 spin_lock_init(&priv->lock);
562 tasklet_init(&priv->rx_tasklet, p54p_rx_tasklet, (unsigned long)dev);
564 err = p54p_open(dev);
566 goto err_free_common;
567 err = p54_read_eeprom(dev);
570 goto err_free_common;
572 err = ieee80211_register_hw(dev);
574 printk(KERN_ERR "%s (p54pci): Cannot register netdevice\n",
576 goto err_free_common;
582 p54_free_common(dev);
583 pci_free_consistent(pdev, sizeof(*priv->ring_control),
584 priv->ring_control, priv->ring_control_dma);
590 pci_set_drvdata(pdev, NULL);
591 ieee80211_free_hw(dev);
594 pci_release_regions(pdev);
595 pci_disable_device(pdev);
599 static void __devexit p54p_remove(struct pci_dev *pdev)
601 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
602 struct p54p_priv *priv;
607 ieee80211_unregister_hw(dev);
609 pci_free_consistent(pdev, sizeof(*priv->ring_control),
610 priv->ring_control, priv->ring_control_dma);
611 p54_free_common(dev);
613 pci_release_regions(pdev);
614 pci_disable_device(pdev);
615 ieee80211_free_hw(dev);
619 static int p54p_suspend(struct pci_dev *pdev, pm_message_t state)
621 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
622 struct p54p_priv *priv = dev->priv;
624 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
625 ieee80211_stop_queues(dev);
629 pci_save_state(pdev);
630 pci_set_power_state(pdev, pci_choose_state(pdev, state));
634 static int p54p_resume(struct pci_dev *pdev)
636 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
637 struct p54p_priv *priv = dev->priv;
639 pci_set_power_state(pdev, PCI_D0);
640 pci_restore_state(pdev);
642 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
644 ieee80211_wake_queues(dev);
649 #endif /* CONFIG_PM */
651 static struct pci_driver p54p_driver = {
653 .id_table = p54p_table,
655 .remove = __devexit_p(p54p_remove),
657 .suspend = p54p_suspend,
658 .resume = p54p_resume,
659 #endif /* CONFIG_PM */
662 static int __init p54p_init(void)
664 return pci_register_driver(&p54p_driver);
667 static void __exit p54p_exit(void)
669 pci_unregister_driver(&p54p_driver);
672 module_init(p54p_init);
673 module_exit(p54p_exit);