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>
28 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
29 MODULE_DESCRIPTION("Prism54 PCI wireless driver");
30 MODULE_LICENSE("GPL");
31 MODULE_ALIAS("prism54pci");
32 MODULE_FIRMWARE("isl3886pci");
34 static struct pci_device_id p54p_table[] __devinitdata = {
35 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
36 { PCI_DEVICE(0x1260, 0x3890) },
37 /* 3COM 3CRWE154G72 Wireless LAN adapter */
38 { PCI_DEVICE(0x10b7, 0x6001) },
39 /* Intersil PRISM Indigo Wireless LAN adapter */
40 { PCI_DEVICE(0x1260, 0x3877) },
41 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
42 { PCI_DEVICE(0x1260, 0x3886) },
46 MODULE_DEVICE_TABLE(pci, p54p_table);
48 static int p54p_upload_firmware(struct ieee80211_hw *dev)
50 struct p54p_priv *priv = dev->priv;
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 /* wait for the firmware to reset properly */
79 err = p54_parse_firmware(dev, priv->firmware);
83 if (priv->common.fw_interface != FW_LM86) {
84 dev_err(&priv->pdev->dev, "wrong firmware, "
85 "please get a LM86(PCI) firmware a try again.\n");
89 data = (__le32 *) priv->firmware->data;
90 remains = priv->firmware->size;
91 device_addr = ISL38XX_DEV_FIRMWARE_ADDR;
94 left = min((u32)0x1000, remains);
95 P54P_WRITE(direct_mem_base, cpu_to_le32(device_addr));
96 P54P_READ(int_enable);
98 device_addr += 0x1000;
100 P54P_WRITE(direct_mem_win[i], *data++);
105 P54P_READ(int_enable);
108 reg = P54P_READ(ctrl_stat);
109 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN);
110 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
111 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RAMBOOT);
112 P54P_WRITE(ctrl_stat, reg);
113 P54P_READ(ctrl_stat);
116 reg |= cpu_to_le32(ISL38XX_CTRL_STAT_RESET);
117 P54P_WRITE(ctrl_stat, reg);
121 reg &= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET);
122 P54P_WRITE(ctrl_stat, reg);
126 /* wait for the firmware to boot properly */
132 static void p54p_refill_rx_ring(struct ieee80211_hw *dev,
133 int ring_index, struct p54p_desc *ring, u32 ring_limit,
134 struct sk_buff **rx_buf)
136 struct p54p_priv *priv = dev->priv;
137 struct p54p_ring_control *ring_control = priv->ring_control;
140 idx = le32_to_cpu(ring_control->host_idx[ring_index]);
142 limit -= le32_to_cpu(ring_control->device_idx[ring_index]);
143 limit = ring_limit - limit;
145 i = idx % ring_limit;
146 while (limit-- > 1) {
147 struct p54p_desc *desc = &ring[i];
149 if (!desc->host_addr) {
152 skb = dev_alloc_skb(priv->common.rx_mtu + 32);
156 mapping = pci_map_single(priv->pdev,
157 skb_tail_pointer(skb),
158 priv->common.rx_mtu + 32,
161 if (pci_dma_mapping_error(priv->pdev, mapping)) {
162 dev_kfree_skb_any(skb);
163 dev_err(&priv->pdev->dev,
164 "RX DMA Mapping error\n");
168 desc->host_addr = cpu_to_le32(mapping);
169 desc->device_addr = 0; // FIXME: necessary?
170 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
181 ring_control->host_idx[ring_index] = cpu_to_le32(idx);
184 static void p54p_check_rx_ring(struct ieee80211_hw *dev, u32 *index,
185 int ring_index, struct p54p_desc *ring, u32 ring_limit,
186 struct sk_buff **rx_buf)
188 struct p54p_priv *priv = dev->priv;
189 struct p54p_ring_control *ring_control = priv->ring_control;
190 struct p54p_desc *desc;
193 i = (*index) % ring_limit;
194 (*index) = idx = le32_to_cpu(ring_control->device_idx[ring_index]);
200 len = le16_to_cpu(desc->len);
209 if (unlikely(len > priv->common.rx_mtu)) {
211 dev_err(&priv->pdev->dev, "rx'd frame size "
212 "exceeds length threshold.\n");
214 len = priv->common.rx_mtu;
218 if (p54_rx(dev, skb)) {
219 pci_unmap_single(priv->pdev,
220 le32_to_cpu(desc->host_addr),
221 priv->common.rx_mtu + 32,
227 desc->len = cpu_to_le16(priv->common.rx_mtu + 32);
234 p54p_refill_rx_ring(dev, ring_index, ring, ring_limit, rx_buf);
237 /* caller must hold priv->lock */
238 static void p54p_check_tx_ring(struct ieee80211_hw *dev, u32 *index,
239 int ring_index, struct p54p_desc *ring, u32 ring_limit,
242 struct p54p_priv *priv = dev->priv;
243 struct p54p_ring_control *ring_control = priv->ring_control;
244 struct p54p_desc *desc;
247 i = (*index) % ring_limit;
248 (*index) = idx = le32_to_cpu(ring_control->device_idx[1]);
254 if (FREE_AFTER_TX((struct sk_buff *) tx_buf[i]))
255 p54_free_skb(dev, tx_buf[i]);
258 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
259 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
262 desc->device_addr = 0;
271 static void p54p_rx_tasklet(unsigned long dev_id)
273 struct ieee80211_hw *dev = (struct ieee80211_hw *)dev_id;
274 struct p54p_priv *priv = dev->priv;
275 struct p54p_ring_control *ring_control = priv->ring_control;
277 p54p_check_rx_ring(dev, &priv->rx_idx_mgmt, 2, ring_control->rx_mgmt,
278 ARRAY_SIZE(ring_control->rx_mgmt), priv->rx_buf_mgmt);
280 p54p_check_rx_ring(dev, &priv->rx_idx_data, 0, ring_control->rx_data,
281 ARRAY_SIZE(ring_control->rx_data), priv->rx_buf_data);
284 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
287 static irqreturn_t p54p_interrupt(int irq, void *dev_id)
289 struct ieee80211_hw *dev = dev_id;
290 struct p54p_priv *priv = dev->priv;
291 struct p54p_ring_control *ring_control = priv->ring_control;
294 spin_lock(&priv->lock);
295 reg = P54P_READ(int_ident);
296 if (unlikely(reg == cpu_to_le32(0xFFFFFFFF))) {
297 spin_unlock(&priv->lock);
301 P54P_WRITE(int_ack, reg);
303 reg &= P54P_READ(int_enable);
305 if (reg & cpu_to_le32(ISL38XX_INT_IDENT_UPDATE)) {
306 p54p_check_tx_ring(dev, &priv->tx_idx_mgmt,
307 3, ring_control->tx_mgmt,
308 ARRAY_SIZE(ring_control->tx_mgmt),
311 p54p_check_tx_ring(dev, &priv->tx_idx_data,
312 1, ring_control->tx_data,
313 ARRAY_SIZE(ring_control->tx_data),
316 tasklet_schedule(&priv->rx_tasklet);
318 } else if (reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT))
319 complete(&priv->boot_comp);
321 spin_unlock(&priv->lock);
323 return reg ? IRQ_HANDLED : IRQ_NONE;
326 static void p54p_tx(struct ieee80211_hw *dev, struct sk_buff *skb)
328 struct p54p_priv *priv = dev->priv;
329 struct p54p_ring_control *ring_control = priv->ring_control;
331 struct p54p_desc *desc;
333 u32 device_idx, idx, i;
335 spin_lock_irqsave(&priv->lock, flags);
336 device_idx = le32_to_cpu(ring_control->device_idx[1]);
337 idx = le32_to_cpu(ring_control->host_idx[1]);
338 i = idx % ARRAY_SIZE(ring_control->tx_data);
340 mapping = pci_map_single(priv->pdev, skb->data, skb->len,
342 if (pci_dma_mapping_error(priv->pdev, mapping)) {
343 spin_unlock_irqrestore(&priv->lock, flags);
344 p54_free_skb(dev, skb);
345 dev_err(&priv->pdev->dev, "TX DMA mapping error\n");
348 priv->tx_buf_data[i] = skb;
350 desc = &ring_control->tx_data[i];
351 desc->host_addr = cpu_to_le32(mapping);
352 desc->device_addr = ((struct p54_hdr *)skb->data)->req_id;
353 desc->len = cpu_to_le16(skb->len);
357 ring_control->host_idx[1] = cpu_to_le32(idx + 1);
358 spin_unlock_irqrestore(&priv->lock, flags);
360 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
364 static void p54p_stop(struct ieee80211_hw *dev)
366 struct p54p_priv *priv = dev->priv;
367 struct p54p_ring_control *ring_control = priv->ring_control;
369 struct p54p_desc *desc;
371 tasklet_kill(&priv->rx_tasklet);
373 P54P_WRITE(int_enable, cpu_to_le32(0));
374 P54P_READ(int_enable);
377 free_irq(priv->pdev->irq, dev);
379 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
381 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_data); i++) {
382 desc = &ring_control->rx_data[i];
384 pci_unmap_single(priv->pdev,
385 le32_to_cpu(desc->host_addr),
386 priv->common.rx_mtu + 32,
388 kfree_skb(priv->rx_buf_data[i]);
389 priv->rx_buf_data[i] = NULL;
392 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_mgmt); i++) {
393 desc = &ring_control->rx_mgmt[i];
395 pci_unmap_single(priv->pdev,
396 le32_to_cpu(desc->host_addr),
397 priv->common.rx_mtu + 32,
399 kfree_skb(priv->rx_buf_mgmt[i]);
400 priv->rx_buf_mgmt[i] = NULL;
403 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_data); i++) {
404 desc = &ring_control->tx_data[i];
406 pci_unmap_single(priv->pdev,
407 le32_to_cpu(desc->host_addr),
408 le16_to_cpu(desc->len),
411 p54_free_skb(dev, priv->tx_buf_data[i]);
412 priv->tx_buf_data[i] = NULL;
415 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_mgmt); i++) {
416 desc = &ring_control->tx_mgmt[i];
418 pci_unmap_single(priv->pdev,
419 le32_to_cpu(desc->host_addr),
420 le16_to_cpu(desc->len),
423 p54_free_skb(dev, priv->tx_buf_mgmt[i]);
424 priv->tx_buf_mgmt[i] = NULL;
427 memset(ring_control, 0, sizeof(*ring_control));
430 static int p54p_open(struct ieee80211_hw *dev)
432 struct p54p_priv *priv = dev->priv;
435 init_completion(&priv->boot_comp);
436 err = request_irq(priv->pdev->irq, p54p_interrupt,
437 IRQF_SHARED, "p54pci", dev);
439 dev_err(&priv->pdev->dev, "failed to register IRQ handler\n");
443 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
444 err = p54p_upload_firmware(dev);
446 free_irq(priv->pdev->irq, dev);
449 priv->rx_idx_data = priv->tx_idx_data = 0;
450 priv->rx_idx_mgmt = priv->tx_idx_mgmt = 0;
452 p54p_refill_rx_ring(dev, 0, priv->ring_control->rx_data,
453 ARRAY_SIZE(priv->ring_control->rx_data), priv->rx_buf_data);
455 p54p_refill_rx_ring(dev, 2, priv->ring_control->rx_mgmt,
456 ARRAY_SIZE(priv->ring_control->rx_mgmt), priv->rx_buf_mgmt);
458 P54P_WRITE(ring_control_base, cpu_to_le32(priv->ring_control_dma));
459 P54P_READ(ring_control_base);
463 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
464 P54P_READ(int_enable);
468 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
471 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
472 printk(KERN_ERR "%s: Cannot boot firmware!\n",
473 wiphy_name(dev->wiphy));
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 int __devinit p54p_probe(struct pci_dev *pdev,
492 const struct pci_device_id *id)
494 struct p54p_priv *priv;
495 struct ieee80211_hw *dev;
496 unsigned long mem_addr, mem_len;
499 err = pci_enable_device(pdev);
501 dev_err(&pdev->dev, "Cannot enable new PCI device\n");
505 mem_addr = pci_resource_start(pdev, 0);
506 mem_len = pci_resource_len(pdev, 0);
507 if (mem_len < sizeof(struct p54p_csr)) {
508 dev_err(&pdev->dev, "Too short PCI resources\n");
509 goto err_disable_dev;
512 err = pci_request_regions(pdev, "p54pci");
514 dev_err(&pdev->dev, "Cannot obtain PCI resources\n");
515 goto err_disable_dev;
518 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) ||
519 pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32))) {
520 dev_err(&pdev->dev, "No suitable DMA available\n");
524 pci_set_master(pdev);
525 pci_try_set_mwi(pdev);
527 pci_write_config_byte(pdev, 0x40, 0);
528 pci_write_config_byte(pdev, 0x41, 0);
530 dev = p54_init_common(sizeof(*priv));
532 dev_err(&pdev->dev, "ieee80211 alloc failed\n");
540 SET_IEEE80211_DEV(dev, &pdev->dev);
541 pci_set_drvdata(pdev, dev);
543 priv->map = ioremap(mem_addr, mem_len);
545 dev_err(&pdev->dev, "Cannot map device memory\n");
550 priv->ring_control = pci_alloc_consistent(pdev, sizeof(*priv->ring_control),
551 &priv->ring_control_dma);
552 if (!priv->ring_control) {
553 dev_err(&pdev->dev, "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 = request_firmware(&priv->firmware, "isl3886pci",
567 dev_err(&pdev->dev, "Cannot find firmware (isl3886pci)\n");
568 err = request_firmware(&priv->firmware, "isl3886",
571 goto err_free_common;
574 err = p54p_open(dev);
576 goto err_free_common;
577 err = p54_read_eeprom(dev);
580 goto err_free_common;
582 err = p54_register_common(dev, &pdev->dev);
584 goto err_free_common;
589 release_firmware(priv->firmware);
590 pci_free_consistent(pdev, sizeof(*priv->ring_control),
591 priv->ring_control, priv->ring_control_dma);
597 pci_set_drvdata(pdev, NULL);
598 p54_free_common(dev);
601 pci_release_regions(pdev);
603 pci_disable_device(pdev);
607 static void __devexit p54p_remove(struct pci_dev *pdev)
609 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
610 struct p54p_priv *priv;
615 p54_unregister_common(dev);
617 release_firmware(priv->firmware);
618 pci_free_consistent(pdev, sizeof(*priv->ring_control),
619 priv->ring_control, priv->ring_control_dma);
621 pci_release_regions(pdev);
622 pci_disable_device(pdev);
623 p54_free_common(dev);
627 static int p54p_suspend(struct pci_dev *pdev, pm_message_t state)
629 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
630 struct p54p_priv *priv = dev->priv;
632 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
633 ieee80211_stop_queues(dev);
637 pci_save_state(pdev);
638 pci_set_power_state(pdev, pci_choose_state(pdev, state));
642 static int p54p_resume(struct pci_dev *pdev)
644 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
645 struct p54p_priv *priv = dev->priv;
647 pci_set_power_state(pdev, PCI_D0);
648 pci_restore_state(pdev);
650 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
652 ieee80211_wake_queues(dev);
657 #endif /* CONFIG_PM */
659 static struct pci_driver p54p_driver = {
661 .id_table = p54p_table,
663 .remove = __devexit_p(p54p_remove),
665 .suspend = p54p_suspend,
666 .resume = p54p_resume,
667 #endif /* CONFIG_PM */
670 static int __init p54p_init(void)
672 return pci_register_driver(&p54p_driver);
675 static void __exit p54p_exit(void)
677 pci_unregister_driver(&p54p_driver);
680 module_init(p54p_init);
681 module_exit(p54p_exit);