2 * Copyright (C) 2002 Intersil Americas Inc.
3 * Copyright (C) 2003 Herbert Valerio Riedel <hvr@gnu.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/module.h>
21 #include <linux/pci.h>
22 #include <linux/delay.h>
23 #include <linux/init.h> /* For __init, __exit */
24 #include <linux/dma-mapping.h>
26 #include "prismcompat.h"
27 #include "islpci_dev.h"
28 #include "islpci_mgt.h" /* for pc_debug */
31 MODULE_AUTHOR("[Intersil] R.Bastings and W.Termorshuizen, The prism54.org Development Team <prism54-devel@prism54.org>");
32 MODULE_DESCRIPTION("The Prism54 802.11 Wireless LAN adapter");
33 MODULE_LICENSE("GPL");
35 static int init_pcitm = 0;
36 module_param(init_pcitm, int, 0);
38 /* In this order: vendor, device, subvendor, subdevice, class, class_mask,
40 * If you have an update for this please contact prism54-devel@prism54.org
41 * The latest list can be found at http://prism54.org/supported_cards.php */
42 static const struct pci_device_id prism54_id_tbl[] = {
43 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
46 PCI_ANY_ID, PCI_ANY_ID,
50 /* 3COM 3CRWE154G72 Wireless LAN adapter */
53 PCI_ANY_ID, PCI_ANY_ID,
57 /* Intersil PRISM Indigo Wireless LAN adapter */
60 PCI_ANY_ID, PCI_ANY_ID,
64 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
67 PCI_ANY_ID, PCI_ANY_ID,
75 /* register the device with the Hotplug facilities of the kernel */
76 MODULE_DEVICE_TABLE(pci, prism54_id_tbl);
78 static int prism54_probe(struct pci_dev *, const struct pci_device_id *);
79 static void prism54_remove(struct pci_dev *);
80 static int prism54_suspend(struct pci_dev *, pm_message_t state);
81 static int prism54_resume(struct pci_dev *);
83 static struct pci_driver prism54_driver = {
85 .id_table = prism54_id_tbl,
86 .probe = prism54_probe,
87 .remove = prism54_remove,
88 .suspend = prism54_suspend,
89 .resume = prism54_resume,
90 /* .enable_wake ; we don't support this yet */
93 /******************************************************************************
94 Module initialization functions
95 ******************************************************************************/
98 prism54_probe(struct pci_dev *pdev, const struct pci_device_id *id)
100 struct net_device *ndev;
103 islpci_private *priv;
106 /* Enable the pci device */
107 if (pci_enable_device(pdev)) {
108 printk(KERN_ERR "%s: pci_enable_device() failed.\n", DRV_NAME);
112 /* check whether the latency timer is set correctly */
113 pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &latency_tmr);
114 #if VERBOSE > SHOW_ERROR_MESSAGES
115 DEBUG(SHOW_TRACING, "latency timer: %x\n", latency_tmr);
117 if (latency_tmr < PCIDEVICE_LATENCY_TIMER_MIN) {
118 /* set the latency timer */
119 pci_write_config_byte(pdev, PCI_LATENCY_TIMER,
120 PCIDEVICE_LATENCY_TIMER_VAL);
124 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
125 printk(KERN_ERR "%s: 32-bit PCI DMA not supported", DRV_NAME);
126 goto do_pci_disable_device;
129 /* 0x40 is the programmable timer to configure the response timeout (TRDY_TIMEOUT)
130 * 0x41 is the programmable timer to configure the retry timeout (RETRY_TIMEOUT)
131 * The RETRY_TIMEOUT is used to set the number of retries that the core, as a
132 * Master, will perform before abandoning a cycle. The default value for
133 * RETRY_TIMEOUT is 0x80, which far exceeds the PCI 2.1 requirement for new
134 * devices. A write of zero to the RETRY_TIMEOUT register disables this
135 * function to allow use with any non-compliant legacy devices that may
136 * execute more retries.
138 * Writing zero to both these two registers will disable both timeouts and
139 * *can* solve problems caused by devices that are slow to respond.
140 * Make this configurable - MSW
142 if ( init_pcitm >= 0 ) {
143 pci_write_config_byte(pdev, 0x40, (u8)init_pcitm);
144 pci_write_config_byte(pdev, 0x41, (u8)init_pcitm);
146 printk(KERN_INFO "PCI TRDY/RETRY unchanged\n");
149 /* request the pci device I/O regions */
150 rvalue = pci_request_regions(pdev, DRV_NAME);
152 printk(KERN_ERR "%s: pci_request_regions failure (rc=%d)\n",
154 goto do_pci_disable_device;
157 /* check if the memory window is indeed set */
158 rvalue = pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &mem_addr);
159 if (rvalue || !mem_addr) {
160 printk(KERN_ERR "%s: PCI device memory region not configured; fix your BIOS or CardBus bridge/drivers\n",
162 goto do_pci_release_regions;
165 /* enable PCI bus-mastering */
166 DEBUG(SHOW_TRACING, "%s: pci_set_master(pdev)\n", DRV_NAME);
167 pci_set_master(pdev);
170 if (!pci_set_mwi(pdev))
171 printk(KERN_INFO "%s: pci_set_mwi(pdev) succeeded\n", DRV_NAME);
173 /* setup the network device interface and its structure */
174 if (!(ndev = islpci_setup(pdev))) {
175 /* error configuring the driver as a network device */
176 printk(KERN_ERR "%s: could not configure network device\n",
178 goto do_pci_clear_mwi;
181 priv = netdev_priv(ndev);
182 islpci_set_state(priv, PRV_STATE_PREBOOT); /* we are attempting to boot */
184 /* card is in unknown state yet, might have some interrupts pending */
185 isl38xx_disable_interrupts(priv->device_base);
187 /* request for the interrupt before uploading the firmware */
188 rvalue = request_irq(pdev->irq, &islpci_interrupt,
189 IRQF_SHARED, ndev->name, priv);
192 /* error, could not hook the handler to the irq */
193 printk(KERN_ERR "%s: could not install IRQ handler\n",
195 goto do_unregister_netdev;
198 /* firmware upload is triggered in islpci_open */
202 do_unregister_netdev:
203 unregister_netdev(ndev);
204 islpci_free_memory(priv);
205 pci_set_drvdata(pdev, NULL);
210 do_pci_release_regions:
211 pci_release_regions(pdev);
212 do_pci_disable_device:
213 pci_disable_device(pdev);
217 /* set by cleanup_module */
218 static volatile int __in_cleanup_module = 0;
220 /* this one removes one(!!) instance only */
222 prism54_remove(struct pci_dev *pdev)
224 struct net_device *ndev = pci_get_drvdata(pdev);
225 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
228 if (!__in_cleanup_module) {
229 printk(KERN_DEBUG "%s: hot unplug detected\n", ndev->name);
230 islpci_set_state(priv, PRV_STATE_OFF);
233 printk(KERN_DEBUG "%s: removing device\n", ndev->name);
235 unregister_netdev(ndev);
237 /* free the interrupt request */
239 if (islpci_get_state(priv) != PRV_STATE_OFF) {
240 isl38xx_disable_interrupts(priv->device_base);
241 islpci_set_state(priv, PRV_STATE_OFF);
242 /* This bellow causes a lockup at rmmod time. It might be
243 * because some interrupts still linger after rmmod time,
245 /* pci_set_power_state(pdev, 3);*/ /* try to power-off */
248 free_irq(pdev->irq, priv);
250 /* free the PCI memory and unmap the remapped page */
251 islpci_free_memory(priv);
253 pci_set_drvdata(pdev, NULL);
259 pci_release_regions(pdev);
261 pci_disable_device(pdev);
265 prism54_suspend(struct pci_dev *pdev, pm_message_t state)
267 struct net_device *ndev = pci_get_drvdata(pdev);
268 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
272 pci_save_state(pdev);
274 /* tell the device not to trigger interrupts for now... */
275 isl38xx_disable_interrupts(priv->device_base);
277 /* from now on assume the hardware was already powered down
278 and don't touch it anymore */
279 islpci_set_state(priv, PRV_STATE_OFF);
281 netif_stop_queue(ndev);
282 netif_device_detach(ndev);
288 prism54_resume(struct pci_dev *pdev)
290 struct net_device *ndev = pci_get_drvdata(pdev);
291 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
296 printk(KERN_NOTICE "%s: got resume request\n", ndev->name);
298 err = pci_enable_device(pdev);
300 printk(KERN_ERR "%s: pci_enable_device failed on resume\n",
305 pci_restore_state(pdev);
307 /* alright let's go into the PREBOOT state */
308 islpci_reset(priv, 1);
310 netif_device_attach(ndev);
311 netif_start_queue(ndev);
317 prism54_module_init(void)
319 printk(KERN_INFO "Loaded %s driver, version %s\n",
320 DRV_NAME, DRV_VERSION);
322 __bug_on_wrong_struct_sizes ();
324 return pci_register_driver(&prism54_driver);
327 /* by the time prism54_module_exit() terminates, as a postcondition
328 * all instances will have been destroyed by calls to
329 * prism54_remove() */
331 prism54_module_exit(void)
333 __in_cleanup_module = 1;
335 pci_unregister_driver(&prism54_driver);
337 printk(KERN_INFO "Unloaded %s driver\n", DRV_NAME);
339 __in_cleanup_module = 0;
342 /* register entry points */
343 module_init(prism54_module_init);
344 module_exit(prism54_module_exit);