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 static void p54p_check_tx_ring(struct ieee80211_hw *dev, u32 *index,
238 int ring_index, struct p54p_desc *ring, u32 ring_limit,
239 struct sk_buff **tx_buf)
242 struct p54p_priv *priv = dev->priv;
243 struct p54p_ring_control *ring_control = priv->ring_control;
244 struct p54p_desc *desc;
248 i = (*index) % ring_limit;
249 (*index) = idx = le32_to_cpu(ring_control->device_idx[1]);
252 spin_lock_irqsave(&priv->lock, flags);
259 pci_unmap_single(priv->pdev, le32_to_cpu(desc->host_addr),
260 le16_to_cpu(desc->len), PCI_DMA_TODEVICE);
263 desc->device_addr = 0;
267 if (skb && FREE_AFTER_TX(skb)) {
268 spin_unlock_irqrestore(&priv->lock, flags);
269 p54_free_skb(dev, skb);
270 spin_lock_irqsave(&priv->lock, flags);
276 spin_unlock_irqrestore(&priv->lock, flags);
279 static void p54p_tasklet(unsigned long dev_id)
281 struct ieee80211_hw *dev = (struct ieee80211_hw *)dev_id;
282 struct p54p_priv *priv = dev->priv;
283 struct p54p_ring_control *ring_control = priv->ring_control;
285 p54p_check_tx_ring(dev, &priv->tx_idx_mgmt, 3, ring_control->tx_mgmt,
286 ARRAY_SIZE(ring_control->tx_mgmt),
289 p54p_check_tx_ring(dev, &priv->tx_idx_data, 1, ring_control->tx_data,
290 ARRAY_SIZE(ring_control->tx_data),
293 p54p_check_rx_ring(dev, &priv->rx_idx_mgmt, 2, ring_control->rx_mgmt,
294 ARRAY_SIZE(ring_control->rx_mgmt), priv->rx_buf_mgmt);
296 p54p_check_rx_ring(dev, &priv->rx_idx_data, 0, ring_control->rx_data,
297 ARRAY_SIZE(ring_control->rx_data), priv->rx_buf_data);
300 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
303 static irqreturn_t p54p_interrupt(int irq, void *dev_id)
305 struct ieee80211_hw *dev = dev_id;
306 struct p54p_priv *priv = dev->priv;
309 spin_lock(&priv->lock);
310 reg = P54P_READ(int_ident);
311 if (unlikely(reg == cpu_to_le32(0xFFFFFFFF))) {
314 P54P_WRITE(int_ack, reg);
316 reg &= P54P_READ(int_enable);
318 if (reg & cpu_to_le32(ISL38XX_INT_IDENT_UPDATE))
319 tasklet_schedule(&priv->tasklet);
320 else if (reg & cpu_to_le32(ISL38XX_INT_IDENT_INIT))
321 complete(&priv->boot_comp);
324 spin_unlock(&priv->lock);
325 return reg ? IRQ_HANDLED : IRQ_NONE;
328 static void p54p_tx(struct ieee80211_hw *dev, struct sk_buff *skb)
330 struct p54p_priv *priv = dev->priv;
331 struct p54p_ring_control *ring_control = priv->ring_control;
333 struct p54p_desc *desc;
335 u32 device_idx, idx, i;
337 spin_lock_irqsave(&priv->lock, flags);
338 device_idx = le32_to_cpu(ring_control->device_idx[1]);
339 idx = le32_to_cpu(ring_control->host_idx[1]);
340 i = idx % ARRAY_SIZE(ring_control->tx_data);
342 mapping = pci_map_single(priv->pdev, skb->data, skb->len,
344 if (pci_dma_mapping_error(priv->pdev, mapping)) {
345 spin_unlock_irqrestore(&priv->lock, flags);
346 p54_free_skb(dev, skb);
347 dev_err(&priv->pdev->dev, "TX DMA mapping error\n");
350 priv->tx_buf_data[i] = skb;
352 desc = &ring_control->tx_data[i];
353 desc->host_addr = cpu_to_le32(mapping);
354 desc->device_addr = ((struct p54_hdr *)skb->data)->req_id;
355 desc->len = cpu_to_le16(skb->len);
359 ring_control->host_idx[1] = cpu_to_le32(idx + 1);
360 spin_unlock_irqrestore(&priv->lock, flags);
362 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
366 static void p54p_stop(struct ieee80211_hw *dev)
368 struct p54p_priv *priv = dev->priv;
369 struct p54p_ring_control *ring_control = priv->ring_control;
371 struct p54p_desc *desc;
373 tasklet_kill(&priv->tasklet);
375 P54P_WRITE(int_enable, cpu_to_le32(0));
376 P54P_READ(int_enable);
379 free_irq(priv->pdev->irq, dev);
381 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
383 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_data); i++) {
384 desc = &ring_control->rx_data[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_data[i]);
391 priv->rx_buf_data[i] = NULL;
394 for (i = 0; i < ARRAY_SIZE(priv->rx_buf_mgmt); i++) {
395 desc = &ring_control->rx_mgmt[i];
397 pci_unmap_single(priv->pdev,
398 le32_to_cpu(desc->host_addr),
399 priv->common.rx_mtu + 32,
401 kfree_skb(priv->rx_buf_mgmt[i]);
402 priv->rx_buf_mgmt[i] = NULL;
405 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_data); i++) {
406 desc = &ring_control->tx_data[i];
408 pci_unmap_single(priv->pdev,
409 le32_to_cpu(desc->host_addr),
410 le16_to_cpu(desc->len),
413 p54_free_skb(dev, priv->tx_buf_data[i]);
414 priv->tx_buf_data[i] = NULL;
417 for (i = 0; i < ARRAY_SIZE(priv->tx_buf_mgmt); i++) {
418 desc = &ring_control->tx_mgmt[i];
420 pci_unmap_single(priv->pdev,
421 le32_to_cpu(desc->host_addr),
422 le16_to_cpu(desc->len),
425 p54_free_skb(dev, priv->tx_buf_mgmt[i]);
426 priv->tx_buf_mgmt[i] = NULL;
429 memset(ring_control, 0, sizeof(*ring_control));
432 static int p54p_open(struct ieee80211_hw *dev)
434 struct p54p_priv *priv = dev->priv;
437 init_completion(&priv->boot_comp);
438 err = request_irq(priv->pdev->irq, p54p_interrupt,
439 IRQF_SHARED, "p54pci", dev);
441 dev_err(&priv->pdev->dev, "failed to register IRQ handler\n");
445 memset(priv->ring_control, 0, sizeof(*priv->ring_control));
446 err = p54p_upload_firmware(dev);
448 free_irq(priv->pdev->irq, dev);
451 priv->rx_idx_data = priv->tx_idx_data = 0;
452 priv->rx_idx_mgmt = priv->tx_idx_mgmt = 0;
454 p54p_refill_rx_ring(dev, 0, priv->ring_control->rx_data,
455 ARRAY_SIZE(priv->ring_control->rx_data), priv->rx_buf_data);
457 p54p_refill_rx_ring(dev, 2, priv->ring_control->rx_mgmt,
458 ARRAY_SIZE(priv->ring_control->rx_mgmt), priv->rx_buf_mgmt);
460 P54P_WRITE(ring_control_base, cpu_to_le32(priv->ring_control_dma));
461 P54P_READ(ring_control_base);
465 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_INIT));
466 P54P_READ(int_enable);
470 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_RESET));
473 if (!wait_for_completion_interruptible_timeout(&priv->boot_comp, HZ)) {
474 printk(KERN_ERR "%s: Cannot boot firmware!\n",
475 wiphy_name(dev->wiphy));
480 P54P_WRITE(int_enable, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE));
481 P54P_READ(int_enable);
485 P54P_WRITE(dev_int, cpu_to_le32(ISL38XX_DEV_INT_UPDATE));
493 static int __devinit p54p_probe(struct pci_dev *pdev,
494 const struct pci_device_id *id)
496 struct p54p_priv *priv;
497 struct ieee80211_hw *dev;
498 unsigned long mem_addr, mem_len;
501 err = pci_enable_device(pdev);
503 dev_err(&pdev->dev, "Cannot enable new PCI device\n");
507 mem_addr = pci_resource_start(pdev, 0);
508 mem_len = pci_resource_len(pdev, 0);
509 if (mem_len < sizeof(struct p54p_csr)) {
510 dev_err(&pdev->dev, "Too short PCI resources\n");
511 goto err_disable_dev;
514 err = pci_request_regions(pdev, "p54pci");
516 dev_err(&pdev->dev, "Cannot obtain PCI resources\n");
517 goto err_disable_dev;
520 if (pci_set_dma_mask(pdev, DMA_BIT_MASK(32)) ||
521 pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32))) {
522 dev_err(&pdev->dev, "No suitable DMA available\n");
526 pci_set_master(pdev);
527 pci_try_set_mwi(pdev);
529 pci_write_config_byte(pdev, 0x40, 0);
530 pci_write_config_byte(pdev, 0x41, 0);
532 dev = p54_init_common(sizeof(*priv));
534 dev_err(&pdev->dev, "ieee80211 alloc failed\n");
542 SET_IEEE80211_DEV(dev, &pdev->dev);
543 pci_set_drvdata(pdev, dev);
545 priv->map = ioremap(mem_addr, mem_len);
547 dev_err(&pdev->dev, "Cannot map device memory\n");
552 priv->ring_control = pci_alloc_consistent(pdev, sizeof(*priv->ring_control),
553 &priv->ring_control_dma);
554 if (!priv->ring_control) {
555 dev_err(&pdev->dev, "Cannot allocate rings\n");
559 priv->common.open = p54p_open;
560 priv->common.stop = p54p_stop;
561 priv->common.tx = p54p_tx;
563 spin_lock_init(&priv->lock);
564 tasklet_init(&priv->tasklet, p54p_tasklet, (unsigned long)dev);
566 err = request_firmware(&priv->firmware, "isl3886pci",
569 dev_err(&pdev->dev, "Cannot find firmware (isl3886pci)\n");
570 err = request_firmware(&priv->firmware, "isl3886",
573 goto err_free_common;
576 err = p54p_open(dev);
578 goto err_free_common;
579 err = p54_read_eeprom(dev);
582 goto err_free_common;
584 err = p54_register_common(dev, &pdev->dev);
586 goto err_free_common;
591 release_firmware(priv->firmware);
592 pci_free_consistent(pdev, sizeof(*priv->ring_control),
593 priv->ring_control, priv->ring_control_dma);
599 pci_set_drvdata(pdev, NULL);
600 p54_free_common(dev);
603 pci_release_regions(pdev);
605 pci_disable_device(pdev);
609 static void __devexit p54p_remove(struct pci_dev *pdev)
611 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
612 struct p54p_priv *priv;
617 p54_unregister_common(dev);
619 release_firmware(priv->firmware);
620 pci_free_consistent(pdev, sizeof(*priv->ring_control),
621 priv->ring_control, priv->ring_control_dma);
623 pci_release_regions(pdev);
624 pci_disable_device(pdev);
625 p54_free_common(dev);
629 static int p54p_suspend(struct pci_dev *pdev, pm_message_t state)
631 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
632 struct p54p_priv *priv = dev->priv;
634 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
635 ieee80211_stop_queues(dev);
639 pci_save_state(pdev);
640 pci_set_power_state(pdev, pci_choose_state(pdev, state));
644 static int p54p_resume(struct pci_dev *pdev)
646 struct ieee80211_hw *dev = pci_get_drvdata(pdev);
647 struct p54p_priv *priv = dev->priv;
649 pci_set_power_state(pdev, PCI_D0);
650 pci_restore_state(pdev);
652 if (priv->common.mode != NL80211_IFTYPE_UNSPECIFIED) {
654 ieee80211_wake_queues(dev);
659 #endif /* CONFIG_PM */
661 static struct pci_driver p54p_driver = {
663 .id_table = p54p_table,
665 .remove = __devexit_p(p54p_remove),
667 .suspend = p54p_suspend,
668 .resume = p54p_resume,
669 #endif /* CONFIG_PM */
672 static int __init p54p_init(void)
674 return pci_register_driver(&p54p_driver);
677 static void __exit p54p_exit(void)
679 pci_unregister_driver(&p54p_driver);
682 module_init(p54p_init);
683 module_exit(p54p_exit);