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) },
43 /* Intersil PRISM Xbow Wireless LAN adapter (Symbol AP-300) */
44 { PCI_DEVICE(0x1260, 0xffff) },
48 MODULE_DEVICE_TABLE(pci
, p54p_table
);
50 static int p54p_upload_firmware(struct ieee80211_hw
*dev
)
52 struct p54p_priv
*priv
= dev
->priv
;
56 u32 remains
, left
, device_addr
;
58 P54P_WRITE(int_enable
, cpu_to_le32(0));
59 P54P_READ(int_enable
);
62 reg
= P54P_READ(ctrl_stat
);
63 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET
);
64 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_RAMBOOT
);
65 P54P_WRITE(ctrl_stat
, reg
);
69 reg
|= cpu_to_le32(ISL38XX_CTRL_STAT_RESET
);
70 P54P_WRITE(ctrl_stat
, reg
);
74 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET
);
75 P54P_WRITE(ctrl_stat
, reg
);
78 /* wait for the firmware to reset properly */
81 err
= p54_parse_firmware(dev
, priv
->firmware
);
85 if (priv
->common
.fw_interface
!= FW_LM86
) {
86 dev_err(&priv
->pdev
->dev
, "wrong firmware, "
87 "please get a LM86(PCI) firmware a try again.\n");
91 data
= (__le32
*) priv
->firmware
->data
;
92 remains
= priv
->firmware
->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 reg
= P54P_READ(ctrl_stat
);
111 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_CLKRUN
);
112 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET
);
113 reg
|= cpu_to_le32(ISL38XX_CTRL_STAT_RAMBOOT
);
114 P54P_WRITE(ctrl_stat
, reg
);
115 P54P_READ(ctrl_stat
);
118 reg
|= cpu_to_le32(ISL38XX_CTRL_STAT_RESET
);
119 P54P_WRITE(ctrl_stat
, reg
);
123 reg
&= cpu_to_le32(~ISL38XX_CTRL_STAT_RESET
);
124 P54P_WRITE(ctrl_stat
, reg
);
128 /* wait for the firmware to boot properly */
134 static void p54p_refill_rx_ring(struct ieee80211_hw
*dev
,
135 int ring_index
, struct p54p_desc
*ring
, u32 ring_limit
,
136 struct sk_buff
**rx_buf
)
138 struct p54p_priv
*priv
= dev
->priv
;
139 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
142 idx
= le32_to_cpu(ring_control
->host_idx
[ring_index
]);
144 limit
-= le32_to_cpu(ring_control
->device_idx
[ring_index
]);
145 limit
= ring_limit
- limit
;
147 i
= idx
% ring_limit
;
148 while (limit
-- > 1) {
149 struct p54p_desc
*desc
= &ring
[i
];
151 if (!desc
->host_addr
) {
154 skb
= dev_alloc_skb(priv
->common
.rx_mtu
+ 32);
158 mapping
= pci_map_single(priv
->pdev
,
159 skb_tail_pointer(skb
),
160 priv
->common
.rx_mtu
+ 32,
163 if (pci_dma_mapping_error(priv
->pdev
, mapping
)) {
164 dev_kfree_skb_any(skb
);
165 dev_err(&priv
->pdev
->dev
,
166 "RX DMA Mapping error\n");
170 desc
->host_addr
= cpu_to_le32(mapping
);
171 desc
->device_addr
= 0; // FIXME: necessary?
172 desc
->len
= cpu_to_le16(priv
->common
.rx_mtu
+ 32);
183 ring_control
->host_idx
[ring_index
] = cpu_to_le32(idx
);
186 static void p54p_check_rx_ring(struct ieee80211_hw
*dev
, u32
*index
,
187 int ring_index
, struct p54p_desc
*ring
, u32 ring_limit
,
188 struct sk_buff
**rx_buf
)
190 struct p54p_priv
*priv
= dev
->priv
;
191 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
192 struct p54p_desc
*desc
;
195 i
= (*index
) % ring_limit
;
196 (*index
) = idx
= le32_to_cpu(ring_control
->device_idx
[ring_index
]);
203 len
= le16_to_cpu(desc
->len
);
212 if (unlikely(len
> priv
->common
.rx_mtu
)) {
214 dev_err(&priv
->pdev
->dev
, "rx'd frame size "
215 "exceeds length threshold.\n");
217 len
= priv
->common
.rx_mtu
;
219 dma_addr
= le32_to_cpu(desc
->host_addr
);
220 pci_dma_sync_single_for_cpu(priv
->pdev
, dma_addr
,
221 priv
->common
.rx_mtu
+ 32, PCI_DMA_FROMDEVICE
);
224 if (p54_rx(dev
, skb
)) {
225 pci_unmap_single(priv
->pdev
, dma_addr
,
226 priv
->common
.rx_mtu
+ 32, PCI_DMA_FROMDEVICE
);
228 desc
->host_addr
= cpu_to_le32(0);
231 pci_dma_sync_single_for_device(priv
->pdev
, dma_addr
,
232 priv
->common
.rx_mtu
+ 32, PCI_DMA_FROMDEVICE
);
233 desc
->len
= cpu_to_le16(priv
->common
.rx_mtu
+ 32);
240 p54p_refill_rx_ring(dev
, ring_index
, ring
, ring_limit
, rx_buf
);
243 /* caller must hold priv->lock */
244 static void p54p_check_tx_ring(struct ieee80211_hw
*dev
, u32
*index
,
245 int ring_index
, struct p54p_desc
*ring
, u32 ring_limit
,
248 struct p54p_priv
*priv
= dev
->priv
;
249 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
250 struct p54p_desc
*desc
;
253 i
= (*index
) % ring_limit
;
254 (*index
) = idx
= le32_to_cpu(ring_control
->device_idx
[ring_index
]);
260 if (FREE_AFTER_TX((struct sk_buff
*) tx_buf
[i
]))
261 p54_free_skb(dev
, tx_buf
[i
]);
264 pci_unmap_single(priv
->pdev
, le32_to_cpu(desc
->host_addr
),
265 le16_to_cpu(desc
->len
), PCI_DMA_TODEVICE
);
268 desc
->device_addr
= 0;
277 static void p54p_rx_tasklet(unsigned long dev_id
)
279 struct ieee80211_hw
*dev
= (struct ieee80211_hw
*)dev_id
;
280 struct p54p_priv
*priv
= dev
->priv
;
281 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
283 p54p_check_rx_ring(dev
, &priv
->rx_idx_mgmt
, 2, ring_control
->rx_mgmt
,
284 ARRAY_SIZE(ring_control
->rx_mgmt
), priv
->rx_buf_mgmt
);
286 p54p_check_rx_ring(dev
, &priv
->rx_idx_data
, 0, ring_control
->rx_data
,
287 ARRAY_SIZE(ring_control
->rx_data
), priv
->rx_buf_data
);
290 P54P_WRITE(dev_int
, cpu_to_le32(ISL38XX_DEV_INT_UPDATE
));
293 static irqreturn_t
p54p_interrupt(int irq
, void *dev_id
)
295 struct ieee80211_hw
*dev
= dev_id
;
296 struct p54p_priv
*priv
= dev
->priv
;
297 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
300 spin_lock(&priv
->lock
);
301 reg
= P54P_READ(int_ident
);
302 if (unlikely(reg
== cpu_to_le32(0xFFFFFFFF))) {
303 spin_unlock(&priv
->lock
);
307 P54P_WRITE(int_ack
, reg
);
309 reg
&= P54P_READ(int_enable
);
311 if (reg
& cpu_to_le32(ISL38XX_INT_IDENT_UPDATE
)) {
312 p54p_check_tx_ring(dev
, &priv
->tx_idx_mgmt
,
313 3, ring_control
->tx_mgmt
,
314 ARRAY_SIZE(ring_control
->tx_mgmt
),
317 p54p_check_tx_ring(dev
, &priv
->tx_idx_data
,
318 1, ring_control
->tx_data
,
319 ARRAY_SIZE(ring_control
->tx_data
),
322 tasklet_schedule(&priv
->rx_tasklet
);
324 } else if (reg
& cpu_to_le32(ISL38XX_INT_IDENT_INIT
))
325 complete(&priv
->boot_comp
);
327 spin_unlock(&priv
->lock
);
329 return reg
? IRQ_HANDLED
: IRQ_NONE
;
332 static void p54p_tx(struct ieee80211_hw
*dev
, struct sk_buff
*skb
)
334 struct p54p_priv
*priv
= dev
->priv
;
335 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
337 struct p54p_desc
*desc
;
339 u32 device_idx
, idx
, i
;
341 spin_lock_irqsave(&priv
->lock
, flags
);
342 device_idx
= le32_to_cpu(ring_control
->device_idx
[1]);
343 idx
= le32_to_cpu(ring_control
->host_idx
[1]);
344 i
= idx
% ARRAY_SIZE(ring_control
->tx_data
);
346 mapping
= pci_map_single(priv
->pdev
, skb
->data
, skb
->len
,
348 if (pci_dma_mapping_error(priv
->pdev
, mapping
)) {
349 spin_unlock_irqrestore(&priv
->lock
, flags
);
350 p54_free_skb(dev
, skb
);
351 dev_err(&priv
->pdev
->dev
, "TX DMA mapping error\n");
354 priv
->tx_buf_data
[i
] = skb
;
356 desc
= &ring_control
->tx_data
[i
];
357 desc
->host_addr
= cpu_to_le32(mapping
);
358 desc
->device_addr
= ((struct p54_hdr
*)skb
->data
)->req_id
;
359 desc
->len
= cpu_to_le16(skb
->len
);
363 ring_control
->host_idx
[1] = cpu_to_le32(idx
+ 1);
364 spin_unlock_irqrestore(&priv
->lock
, flags
);
366 P54P_WRITE(dev_int
, cpu_to_le32(ISL38XX_DEV_INT_UPDATE
));
370 static void p54p_stop(struct ieee80211_hw
*dev
)
372 struct p54p_priv
*priv
= dev
->priv
;
373 struct p54p_ring_control
*ring_control
= priv
->ring_control
;
375 struct p54p_desc
*desc
;
377 tasklet_kill(&priv
->rx_tasklet
);
379 P54P_WRITE(int_enable
, cpu_to_le32(0));
380 P54P_READ(int_enable
);
383 free_irq(priv
->pdev
->irq
, dev
);
385 P54P_WRITE(dev_int
, cpu_to_le32(ISL38XX_DEV_INT_RESET
));
387 for (i
= 0; i
< ARRAY_SIZE(priv
->rx_buf_data
); i
++) {
388 desc
= &ring_control
->rx_data
[i
];
390 pci_unmap_single(priv
->pdev
,
391 le32_to_cpu(desc
->host_addr
),
392 priv
->common
.rx_mtu
+ 32,
394 kfree_skb(priv
->rx_buf_data
[i
]);
395 priv
->rx_buf_data
[i
] = NULL
;
398 for (i
= 0; i
< ARRAY_SIZE(priv
->rx_buf_mgmt
); i
++) {
399 desc
= &ring_control
->rx_mgmt
[i
];
401 pci_unmap_single(priv
->pdev
,
402 le32_to_cpu(desc
->host_addr
),
403 priv
->common
.rx_mtu
+ 32,
405 kfree_skb(priv
->rx_buf_mgmt
[i
]);
406 priv
->rx_buf_mgmt
[i
] = NULL
;
409 for (i
= 0; i
< ARRAY_SIZE(priv
->tx_buf_data
); i
++) {
410 desc
= &ring_control
->tx_data
[i
];
412 pci_unmap_single(priv
->pdev
,
413 le32_to_cpu(desc
->host_addr
),
414 le16_to_cpu(desc
->len
),
417 p54_free_skb(dev
, priv
->tx_buf_data
[i
]);
418 priv
->tx_buf_data
[i
] = NULL
;
421 for (i
= 0; i
< ARRAY_SIZE(priv
->tx_buf_mgmt
); i
++) {
422 desc
= &ring_control
->tx_mgmt
[i
];
424 pci_unmap_single(priv
->pdev
,
425 le32_to_cpu(desc
->host_addr
),
426 le16_to_cpu(desc
->len
),
429 p54_free_skb(dev
, priv
->tx_buf_mgmt
[i
]);
430 priv
->tx_buf_mgmt
[i
] = NULL
;
433 memset(ring_control
, 0, sizeof(*ring_control
));
436 static int p54p_open(struct ieee80211_hw
*dev
)
438 struct p54p_priv
*priv
= dev
->priv
;
441 init_completion(&priv
->boot_comp
);
442 err
= request_irq(priv
->pdev
->irq
, &p54p_interrupt
,
443 IRQF_SHARED
, "p54pci", dev
);
445 dev_err(&priv
->pdev
->dev
, "failed to register IRQ handler\n");
449 memset(priv
->ring_control
, 0, sizeof(*priv
->ring_control
));
450 err
= p54p_upload_firmware(dev
);
452 free_irq(priv
->pdev
->irq
, dev
);
455 priv
->rx_idx_data
= priv
->tx_idx_data
= 0;
456 priv
->rx_idx_mgmt
= priv
->tx_idx_mgmt
= 0;
458 p54p_refill_rx_ring(dev
, 0, priv
->ring_control
->rx_data
,
459 ARRAY_SIZE(priv
->ring_control
->rx_data
), priv
->rx_buf_data
);
461 p54p_refill_rx_ring(dev
, 2, priv
->ring_control
->rx_mgmt
,
462 ARRAY_SIZE(priv
->ring_control
->rx_mgmt
), priv
->rx_buf_mgmt
);
464 P54P_WRITE(ring_control_base
, cpu_to_le32(priv
->ring_control_dma
));
465 P54P_READ(ring_control_base
);
469 P54P_WRITE(int_enable
, cpu_to_le32(ISL38XX_INT_IDENT_INIT
));
470 P54P_READ(int_enable
);
474 P54P_WRITE(dev_int
, cpu_to_le32(ISL38XX_DEV_INT_RESET
));
477 if (!wait_for_completion_interruptible_timeout(&priv
->boot_comp
, HZ
)) {
478 printk(KERN_ERR
"%s: Cannot boot firmware!\n",
479 wiphy_name(dev
->wiphy
));
484 P54P_WRITE(int_enable
, cpu_to_le32(ISL38XX_INT_IDENT_UPDATE
));
485 P54P_READ(int_enable
);
489 P54P_WRITE(dev_int
, cpu_to_le32(ISL38XX_DEV_INT_UPDATE
));
497 static int __devinit
p54p_probe(struct pci_dev
*pdev
,
498 const struct pci_device_id
*id
)
500 struct p54p_priv
*priv
;
501 struct ieee80211_hw
*dev
;
502 unsigned long mem_addr
, mem_len
;
505 err
= pci_enable_device(pdev
);
507 dev_err(&pdev
->dev
, "Cannot enable new PCI device\n");
511 mem_addr
= pci_resource_start(pdev
, 0);
512 mem_len
= pci_resource_len(pdev
, 0);
513 if (mem_len
< sizeof(struct p54p_csr
)) {
514 dev_err(&pdev
->dev
, "Too short PCI resources\n");
515 goto err_disable_dev
;
518 err
= pci_request_regions(pdev
, "p54pci");
520 dev_err(&pdev
->dev
, "Cannot obtain PCI resources\n");
521 goto err_disable_dev
;
524 if (pci_set_dma_mask(pdev
, DMA_BIT_MASK(32)) ||
525 pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(32))) {
526 dev_err(&pdev
->dev
, "No suitable DMA available\n");
530 pci_set_master(pdev
);
531 pci_try_set_mwi(pdev
);
533 pci_write_config_byte(pdev
, 0x40, 0);
534 pci_write_config_byte(pdev
, 0x41, 0);
536 dev
= p54_init_common(sizeof(*priv
));
538 dev_err(&pdev
->dev
, "ieee80211 alloc failed\n");
546 SET_IEEE80211_DEV(dev
, &pdev
->dev
);
547 pci_set_drvdata(pdev
, dev
);
549 priv
->map
= ioremap(mem_addr
, mem_len
);
551 dev_err(&pdev
->dev
, "Cannot map device memory\n");
556 priv
->ring_control
= pci_alloc_consistent(pdev
, sizeof(*priv
->ring_control
),
557 &priv
->ring_control_dma
);
558 if (!priv
->ring_control
) {
559 dev_err(&pdev
->dev
, "Cannot allocate rings\n");
563 priv
->common
.open
= p54p_open
;
564 priv
->common
.stop
= p54p_stop
;
565 priv
->common
.tx
= p54p_tx
;
567 spin_lock_init(&priv
->lock
);
568 tasklet_init(&priv
->rx_tasklet
, p54p_rx_tasklet
, (unsigned long)dev
);
570 err
= request_firmware(&priv
->firmware
, "isl3886pci",
573 dev_err(&pdev
->dev
, "Cannot find firmware (isl3886pci)\n");
574 err
= request_firmware(&priv
->firmware
, "isl3886",
577 goto err_free_common
;
580 err
= p54p_open(dev
);
582 goto err_free_common
;
583 err
= p54_read_eeprom(dev
);
586 goto err_free_common
;
588 err
= p54_register_common(dev
, &pdev
->dev
);
590 goto err_free_common
;
595 release_firmware(priv
->firmware
);
596 pci_free_consistent(pdev
, sizeof(*priv
->ring_control
),
597 priv
->ring_control
, priv
->ring_control_dma
);
603 pci_set_drvdata(pdev
, NULL
);
604 p54_free_common(dev
);
607 pci_release_regions(pdev
);
609 pci_disable_device(pdev
);
613 static void __devexit
p54p_remove(struct pci_dev
*pdev
)
615 struct ieee80211_hw
*dev
= pci_get_drvdata(pdev
);
616 struct p54p_priv
*priv
;
621 p54_unregister_common(dev
);
623 release_firmware(priv
->firmware
);
624 pci_free_consistent(pdev
, sizeof(*priv
->ring_control
),
625 priv
->ring_control
, priv
->ring_control_dma
);
627 pci_release_regions(pdev
);
628 pci_disable_device(pdev
);
629 p54_free_common(dev
);
633 static int p54p_suspend(struct pci_dev
*pdev
, pm_message_t state
)
635 struct ieee80211_hw
*dev
= pci_get_drvdata(pdev
);
636 struct p54p_priv
*priv
= dev
->priv
;
638 if (priv
->common
.mode
!= NL80211_IFTYPE_UNSPECIFIED
) {
639 ieee80211_stop_queues(dev
);
643 pci_save_state(pdev
);
644 pci_set_power_state(pdev
, pci_choose_state(pdev
, state
));
648 static int p54p_resume(struct pci_dev
*pdev
)
650 struct ieee80211_hw
*dev
= pci_get_drvdata(pdev
);
651 struct p54p_priv
*priv
= dev
->priv
;
653 pci_set_power_state(pdev
, PCI_D0
);
654 pci_restore_state(pdev
);
656 if (priv
->common
.mode
!= NL80211_IFTYPE_UNSPECIFIED
) {
658 ieee80211_wake_queues(dev
);
663 #endif /* CONFIG_PM */
665 static struct pci_driver p54p_driver
= {
667 .id_table
= p54p_table
,
669 .remove
= __devexit_p(p54p_remove
),
671 .suspend
= p54p_suspend
,
672 .resume
= p54p_resume
,
673 #endif /* CONFIG_PM */
676 static int __init
p54p_init(void)
678 return pci_register_driver(&p54p_driver
);
681 static void __exit
p54p_exit(void)
683 pci_unregister_driver(&p54p_driver
);
686 module_init(p54p_init
);
687 module_exit(p54p_exit
);