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/slab.h>
19 #include <linux/firmware.h>
20 #include <linux/etherdevice.h>
21 #include <linux/delay.h>
22 #include <linux/completion.h>
23 #include <linux/module.h>
24 #include <net/mac80211.h>
30 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
31 MODULE_DESCRIPTION("Prism54 PCI wireless driver");
32 MODULE_LICENSE("GPL");
33 MODULE_ALIAS("prism54pci");
34 MODULE_FIRMWARE("isl3886pci");
36 static DEFINE_PCI_DEVICE_TABLE(p54p_table) = {
37 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
38 { PCI_DEVICE(0x1260, 0x3890) },
39 /* 3COM 3CRWE154G72 Wireless LAN adapter */
40 { PCI_DEVICE(0x10b7, 0x6001) },
41 /* Intersil PRISM Indigo Wireless LAN adapter */
42 { PCI_DEVICE(0x1260, 0x3877) },
43 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
44 { PCI_DEVICE(0x1260, 0x3886) },
45 /* Intersil PRISM Xbow Wireless LAN adapter (Symbol AP-300) */
46 { PCI_DEVICE(0x1260, 0xffff) },
50 MODULE_DEVICE_TABLE(pci, p54p_table);
52 static int p54p_upload_firmware(struct ieee80211_hw *dev)
54 struct p54p_priv *priv = dev->priv;
58 u32 remains, left, device_addr;
60 P54P_WRITE(int_enable, cpu_to_le32(0));
61 P54P_READ(int_enable);
64 reg = P54P_READ(ctrl_stat);
65 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
66 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RAMBOOT);
67 P54P_WRITE(ctrl_stat, reg);
71 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
72 P54P_WRITE(ctrl_stat, reg);
76 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
77 P54P_WRITE(ctrl_stat, reg);
80 /* wait for the firmware to reset properly */
83 err = p54_parse_firmware(dev, priv->firmware);
87 if (priv->common.fw_interface != FW_LM86) {
88 dev_err(&priv->pdev->dev, "wrong firmware, "
89 "please get a LM86(PCI) firmware a try again.\n");
93 data = (__le32 *) priv->firmware->data;
94 remains = priv->firmware->size;
95 device_addr = ISL38XX_DEV_FIRMWARE_ADDR;
98 left = min((u32)0x1000, remains);
99 P54P_WRITE(direct_mem_base, cpu_to_le32(device_addr));
100 P54P_READ(int_enable);
102 device_addr += 0x1000;
104 P54P_WRITE(direct_mem_win[i], *data++);
109 P54P_READ(int_enable);
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, u32 index)
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]);
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,
165 if (pci_dma_mapping_error(priv->pdev, mapping)) {
166 dev_kfree_skb_any(skb);
167 dev_err(&priv->pdev->dev,
168 "RX DMA Mapping error\n");
172 desc->host_addr = cpu_to_le32(mapping);
173 desc->device_addr = 0; // FIXME: necessary?
174 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
185 ring_control->host_idx[ring_index] = cpu_to_le32(idx);
188 static void p54p_check_rx_ring(struct ieee80211_hw *dev, u32 *index,
189 int ring_index, struct p54p_desc *ring, u32 ring_limit,
190 struct sk_buff **rx_buf)
192 struct p54p_priv *priv = dev->priv;
193 struct p54p_ring_control *ring_control = priv->ring_control;
194 struct p54p_desc *desc;
197 i = (*index) % ring_limit;
198 (*index) = idx = le32_to_cpu(ring_control->device_idx[ring_index]);
205 len = le16_to_cpu(desc->len);
214 if (unlikely(len > priv->common.rx_mtu)) {
216 dev_err(&priv->pdev->dev, "rx'd frame size "
217 "exceeds length threshold.\n");
219 len = priv->common.rx_mtu;
221 dma_addr = le32_to_cpu(desc->host_addr);
222 pci_dma_sync_single_for_cpu(priv->pdev, dma_addr,
223 priv->common.rx_mtu + 32, PCI_DMA_FROMDEVICE);
226 if (p54_rx(dev, skb)) {
227 pci_unmap_single(priv->pdev, dma_addr,
228 priv->common.rx_mtu + 32, PCI_DMA_FROMDEVICE);
230 desc->host_addr = cpu_to_le32(0);
233 pci_dma_sync_single_for_device(priv->pdev, dma_addr,
234 priv->common.rx_mtu + 32, PCI_DMA_FROMDEVICE);
235 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
242 p54p_refill_rx_ring(dev, ring_index, ring, ring_limit, rx_buf, *index);
245 static void p54p_check_tx_ring(struct ieee80211_hw *dev, u32 *index,
246 int ring_index, struct p54p_desc *ring, u32 ring_limit,
247 struct sk_buff **tx_buf)
249 struct p54p_priv *priv = dev->priv;
250 struct p54p_ring_control *ring_control = priv->ring_control;
251 struct p54p_desc *desc;
255 i = (*index) % ring_limit;
256 (*index) = idx = le32_to_cpu(ring_control->device_idx[ring_index]);
265 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
266 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
269 desc->device_addr = 0;
273 if (skb && FREE_AFTER_TX(skb))
274 p54_free_skb(dev, skb);
281 static void p54p_tasklet(unsigned long dev_id)
283 struct ieee80211_hw *dev = (struct ieee80211_hw *)dev_id;
284 struct p54p_priv *priv = dev->priv;
285 struct p54p_ring_control *ring_control = priv->ring_control;
287 p54p_check_tx_ring(dev, &priv->tx_idx_mgmt, 3, ring_control->tx_mgmt,
288 ARRAY_SIZE(ring_control->tx_mgmt),
291 p54p_check_tx_ring(dev, &priv->tx_idx_data, 1, ring_control->tx_data,
292 ARRAY_SIZE(ring_control->tx_data),
295 p54p_check_rx_ring(dev, &priv->rx_idx_mgmt, 2, ring_control->rx_mgmt,
296 ARRAY_SIZE(ring_control->rx_mgmt), priv->rx_buf_mgmt);
298 p54p_check_rx_ring(dev, &priv->rx_idx_data, 0, ring_control->rx_data,
299 ARRAY_SIZE(ring_control->rx_data), priv->rx_buf_data);
302 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
305 static irqreturn_t p54p_interrupt(int irq, void *dev_id)
307 struct ieee80211_hw *dev = dev_id;
308 struct p54p_priv *priv = dev->priv;
311 reg = P54P_READ(int_ident);
312 if (unlikely(reg == cpu_to_le32(0xFFFFFFFF))) {
315 P54P_WRITE(int_ack, reg);
317 reg &= P54P_READ(int_enable);
319 if (reg & cpu_to_le32(ISL38XX_INT_IDENT_UPDATE))
320 tasklet_schedule(&priv->tasklet);
321 else if (reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT))
322 complete(&priv->boot_comp);
325 return reg ? IRQ_HANDLED : IRQ_NONE;
328 static void p54p_tx(struct ieee80211_hw *dev, struct sk_buff *skb)
331 struct p54p_priv *priv = dev->priv;
332 struct p54p_ring_control *ring_control = priv->ring_control;
333 struct p54p_desc *desc;
337 spin_lock_irqsave(&priv->lock, flags);
338 idx = le32_to_cpu(ring_control->host_idx[1]);
339 i = idx % ARRAY_SIZE(ring_control->tx_data);
341 mapping = pci_map_single(priv->pdev, skb->data, skb->len,
343 if (pci_dma_mapping_error(priv->pdev, mapping)) {
344 spin_unlock_irqrestore(&priv->lock, flags);
345 p54_free_skb(dev, skb);
346 dev_err(&priv->pdev->dev, "TX DMA mapping error\n");
349 priv->tx_buf_data[i] = skb;
351 desc = &ring_control->tx_data[i];
352 desc->host_addr = cpu_to_le32(mapping);
353 desc->device_addr = ((struct p54_hdr *)skb->data)->req_id;
354 desc->len = cpu_to_le16(skb->len);
358 ring_control->host_idx[1] = cpu_to_le32(idx + 1);
359 spin_unlock_irqrestore(&priv->lock, flags);
361 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
365 static void p54p_stop(struct ieee80211_hw *dev)
367 struct p54p_priv *priv = dev->priv;
368 struct p54p_ring_control *ring_control = priv->ring_control;
370 struct p54p_desc *desc;
372 P54P_WRITE(int_enable, cpu_to_le32(0));
373 P54P_READ(int_enable);
376 free_irq(priv->pdev->irq, dev);
378 tasklet_kill(&priv->tasklet);
380 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
382 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_data); i++) {
383 desc = &ring_control->rx_data[i];
385 pci_unmap_single(priv->pdev,
386 le32_to_cpu(desc->host_addr),
387 priv->common.rx_mtu + 32,
389 kfree_skb(priv->rx_buf_data[i]);
390 priv->rx_buf_data[i] = NULL;
393 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_mgmt); i++) {
394 desc = &ring_control->rx_mgmt[i];
396 pci_unmap_single(priv->pdev,
397 le32_to_cpu(desc->host_addr),
398 priv->common.rx_mtu + 32,
400 kfree_skb(priv->rx_buf_mgmt[i]);
401 priv->rx_buf_mgmt[i] = NULL;
404 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_data); i++) {
405 desc = &ring_control->tx_data[i];
407 pci_unmap_single(priv->pdev,
408 le32_to_cpu(desc->host_addr),
409 le16_to_cpu(desc->len),
412 p54_free_skb(dev, priv->tx_buf_data[i]);
413 priv->tx_buf_data[i] = NULL;
416 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_mgmt); i++) {
417 desc = &ring_control->tx_mgmt[i];
419 pci_unmap_single(priv->pdev,
420 le32_to_cpu(desc->host_addr),
421 le16_to_cpu(desc->len),
424 p54_free_skb(dev, priv->tx_buf_mgmt[i]);
425 priv->tx_buf_mgmt[i] = NULL;
428 memset(ring_control, 0, sizeof(*ring_control));
431 static int p54p_open(struct ieee80211_hw *dev)
433 struct p54p_priv *priv = dev->priv;
436 init_completion(&priv->boot_comp);
437 err = request_irq(priv->pdev->irq, p54p_interrupt,
438 IRQF_SHARED, "p54pci", dev);
440 dev_err(&priv->pdev->dev, "failed to register IRQ handler\n");
444 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
445 err = p54p_upload_firmware(dev);
447 free_irq(priv->pdev->irq, dev);
450 priv->rx_idx_data = priv->tx_idx_data = 0;
451 priv->rx_idx_mgmt = priv->tx_idx_mgmt = 0;
453 p54p_refill_rx_ring(dev, 0, priv->ring_control->rx_data,
454 ARRAY_SIZE(priv->ring_control->rx_data), priv->rx_buf_data, 0);
456 p54p_refill_rx_ring(dev, 2, priv->ring_control->rx_mgmt,
457 ARRAY_SIZE(priv->ring_control->rx_mgmt), priv->rx_buf_mgmt, 0);
459 P54P_WRITE(ring_control_base, cpu_to_le32(priv->ring_control_dma));
460 P54P_READ(ring_control_base);
464 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
465 P54P_READ(int_enable);
469 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
472 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
473 wiphy_err(dev->wiphy, "Cannot boot firmware!\n");
478 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE));
479 P54P_READ(int_enable);
483 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
491 static void p54p_firmware_step2(const struct firmware *fw,
494 struct p54p_priv *priv = context;
495 struct ieee80211_hw *dev = priv->common.hw;
496 struct pci_dev *pdev = priv->pdev;
500 dev_err(&pdev->dev, "Cannot find firmware (isl3886pci)\n");
507 err = p54p_open(dev);
510 err = p54_read_eeprom(dev);
515 err = p54_register_common(dev, &pdev->dev);
521 complete(&priv->fw_loaded);
524 struct device *parent = pdev->dev.parent;
530 * This will indirectly result in a call to p54p_remove.
531 * Hence, we don't need to bother with freeing any
532 * allocated ressources at all.
534 device_release_driver(&pdev->dev);
537 device_unlock(parent);
543 static int __devinit p54p_probe(struct pci_dev *pdev,
544 const struct pci_device_id *id)
546 struct p54p_priv *priv;
547 struct ieee80211_hw *dev;
548 unsigned long mem_addr, mem_len;
552 err = pci_enable_device(pdev);
554 dev_err(&pdev->dev, "Cannot enable new PCI device\n");
558 mem_addr = pci_resource_start(pdev, 0);
559 mem_len = pci_resource_len(pdev, 0);
560 if (mem_len < sizeof(struct p54p_csr)) {
561 dev_err(&pdev->dev, "Too short PCI resources\n");
562 goto err_disable_dev;
565 err = pci_request_regions(pdev, "p54pci");
567 dev_err(&pdev->dev, "Cannot obtain PCI resources\n");
568 goto err_disable_dev;
571 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) ||
572 pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32))) {
573 dev_err(&pdev->dev, "No suitable DMA available\n");
577 pci_set_master(pdev);
578 pci_try_set_mwi(pdev);
580 pci_write_config_byte(pdev, 0x40, 0);
581 pci_write_config_byte(pdev, 0x41, 0);
583 dev = p54_init_common(sizeof(*priv));
585 dev_err(&pdev->dev, "ieee80211 alloc failed\n");
593 init_completion(&priv->fw_loaded);
594 SET_IEEE80211_DEV(dev, &pdev->dev);
595 pci_set_drvdata(pdev, dev);
597 priv->map = ioremap(mem_addr, mem_len);
599 dev_err(&pdev->dev, "Cannot map device memory\n");
604 priv->ring_control = pci_alloc_consistent(pdev, sizeof(*priv->ring_control),
605 &priv->ring_control_dma);
606 if (!priv->ring_control) {
607 dev_err(&pdev->dev, "Cannot allocate rings\n");
611 priv->common.open = p54p_open;
612 priv->common.stop = p54p_stop;
613 priv->common.tx = p54p_tx;
615 spin_lock_init(&priv->lock);
616 tasklet_init(&priv->tasklet, p54p_tasklet, (unsigned long)dev);
618 err = request_firmware_nowait(THIS_MODULE, 1, "isl3886pci",
619 &priv->pdev->dev, GFP_KERNEL,
620 priv, p54p_firmware_step2);
624 pci_free_consistent(pdev, sizeof(*priv->ring_control),
625 priv->ring_control, priv->ring_control_dma);
631 pci_set_drvdata(pdev, NULL);
632 p54_free_common(dev);
635 pci_release_regions(pdev);
637 pci_disable_device(pdev);
642 static void __devexit p54p_remove(struct pci_dev *pdev)
644 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
645 struct p54p_priv *priv;
651 wait_for_completion(&priv->fw_loaded);
652 p54_unregister_common(dev);
653 release_firmware(priv->firmware);
654 pci_free_consistent(pdev, sizeof(*priv->ring_control),
655 priv->ring_control, priv->ring_control_dma);
657 pci_release_regions(pdev);
658 pci_disable_device(pdev);
659 p54_free_common(dev);
663 static int p54p_suspend(struct device *device)
665 struct pci_dev *pdev = to_pci_dev(device);
667 pci_save_state(pdev);
668 pci_set_power_state(pdev, PCI_D3hot);
669 pci_disable_device(pdev);
673 static int p54p_resume(struct device *device)
675 struct pci_dev *pdev = to_pci_dev(device);
678 err = pci_reenable_device(pdev);
681 return pci_set_power_state(pdev, PCI_D0);
684 static const struct dev_pm_ops p54pci_pm_ops = {
685 .suspend = p54p_suspend,
686 .resume = p54p_resume,
687 .freeze = p54p_suspend,
689 .poweroff = p54p_suspend,
690 .restore = p54p_resume,
693 #define P54P_PM_OPS (&p54pci_pm_ops)
695 #define P54P_PM_OPS (NULL)
696 #endif /* CONFIG_PM */
698 static struct pci_driver p54p_driver = {
700 .id_table = p54p_table,
702 .remove = __devexit_p(p54p_remove),
703 .driver.pm = P54P_PM_OPS,
706 module_pci_driver(p54p_driver);