3 * Copyright (C) 2002 Intersil Americas Inc.
4 * Copyright (C) 2003 Herbert Valerio Riedel <hvr@gnu.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/module.h>
22 #include <linux/pci.h>
23 #include <linux/delay.h>
24 #include <linux/init.h> /* For __init, __exit */
26 #include "prismcompat.h"
27 #include "islpci_dev.h"
28 #include "islpci_mgt.h" /* for pc_debug */
31 #define DRV_NAME "prism54"
32 #define DRV_VERSION "1.2"
34 MODULE_AUTHOR("[Intersil] R.Bastings and W.Termorshuizen, The prism54.org Development Team <prism54-devel@prism54.org>");
35 MODULE_DESCRIPTION("The Prism54 802.11 Wireless LAN adapter");
36 MODULE_LICENSE("GPL");
38 static int init_pcitm = 0;
39 module_param(init_pcitm, int, 0);
41 /* In this order: vendor, device, subvendor, subdevice, class, class_mask,
43 * If you have an update for this please contact prism54-devel@prism54.org
44 * The latest list can be found at http://prism54.org/supported_cards.php */
45 static const struct pci_device_id prism54_id_tbl[] = {
46 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
49 PCI_ANY_ID, PCI_ANY_ID,
53 /* 3COM 3CRWE154G72 Wireless LAN adapter */
56 PCI_ANY_ID, PCI_ANY_ID,
60 /* Intersil PRISM Indigo Wireless LAN adapter */
63 PCI_ANY_ID, PCI_ANY_ID,
67 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
70 PCI_ANY_ID, PCI_ANY_ID,
78 /* register the device with the Hotplug facilities of the kernel */
79 MODULE_DEVICE_TABLE(pci, prism54_id_tbl);
81 static int prism54_probe(struct pci_dev *, const struct pci_device_id *);
82 static void prism54_remove(struct pci_dev *);
83 static int prism54_suspend(struct pci_dev *, pm_message_t state);
84 static int prism54_resume(struct pci_dev *);
86 static struct pci_driver prism54_driver = {
88 .id_table = prism54_id_tbl,
89 .probe = prism54_probe,
90 .remove = prism54_remove,
91 .suspend = prism54_suspend,
92 .resume = prism54_resume,
93 /* .enable_wake ; we don't support this yet */
96 /******************************************************************************
97 Module initialization functions
98 ******************************************************************************/
101 prism54_probe(struct pci_dev *pdev, const struct pci_device_id *id)
103 struct net_device *ndev;
106 islpci_private *priv;
109 /* Enable the pci device */
110 if (pci_enable_device(pdev)) {
111 printk(KERN_ERR "%s: pci_enable_device() failed.\n", DRV_NAME);
115 /* check whether the latency timer is set correctly */
116 pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &latency_tmr);
117 #if VERBOSE > SHOW_ERROR_MESSAGES
118 DEBUG(SHOW_TRACING, "latency timer: %x\n", latency_tmr);
120 if (latency_tmr < PCIDEVICE_LATENCY_TIMER_MIN) {
121 /* set the latency timer */
122 pci_write_config_byte(pdev, PCI_LATENCY_TIMER,
123 PCIDEVICE_LATENCY_TIMER_VAL);
127 if (pci_set_dma_mask(pdev, 0xffffffff)) {
128 printk(KERN_ERR "%s: 32-bit PCI DMA not supported", DRV_NAME);
129 goto do_pci_disable_device;
132 /* 0x40 is the programmable timer to configure the response timeout (TRDY_TIMEOUT)
133 * 0x41 is the programmable timer to configure the retry timeout (RETRY_TIMEOUT)
134 * The RETRY_TIMEOUT is used to set the number of retries that the core, as a
135 * Master, will perform before abandoning a cycle. The default value for
136 * RETRY_TIMEOUT is 0x80, which far exceeds the PCI 2.1 requirement for new
137 * devices. A write of zero to the RETRY_TIMEOUT register disables this
138 * function to allow use with any non-compliant legacy devices that may
139 * execute more retries.
141 * Writing zero to both these two registers will disable both timeouts and
142 * *can* solve problems caused by devices that are slow to respond.
143 * Make this configurable - MSW
145 if ( init_pcitm >= 0 ) {
146 pci_write_config_byte(pdev, 0x40, (u8)init_pcitm);
147 pci_write_config_byte(pdev, 0x41, (u8)init_pcitm);
149 printk(KERN_INFO "PCI TRDY/RETRY unchanged\n");
152 /* request the pci device I/O regions */
153 rvalue = pci_request_regions(pdev, DRV_NAME);
155 printk(KERN_ERR "%s: pci_request_regions failure (rc=%d)\n",
157 goto do_pci_disable_device;
160 /* check if the memory window is indeed set */
161 rvalue = pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &mem_addr);
162 if (rvalue || !mem_addr) {
163 printk(KERN_ERR "%s: PCI device memory region not configured; fix your BIOS or CardBus bridge/drivers\n",
165 goto do_pci_release_regions;
168 /* enable PCI bus-mastering */
169 DEBUG(SHOW_TRACING, "%s: pci_set_master(pdev)\n", DRV_NAME);
170 pci_set_master(pdev);
175 /* setup the network device interface and its structure */
176 if (!(ndev = islpci_setup(pdev))) {
177 /* error configuring the driver as a network device */
178 printk(KERN_ERR "%s: could not configure network device\n",
180 goto do_pci_release_regions;
183 priv = netdev_priv(ndev);
184 islpci_set_state(priv, PRV_STATE_PREBOOT); /* we are attempting to boot */
186 /* card is in unknown state yet, might have some interrupts pending */
187 isl38xx_disable_interrupts(priv->device_base);
189 /* request for the interrupt before uploading the firmware */
190 rvalue = request_irq(pdev->irq, &islpci_interrupt,
191 SA_SHIRQ, ndev->name, priv);
194 /* error, could not hook the handler to the irq */
195 printk(KERN_ERR "%s: could not install IRQ handler\n",
197 goto do_unregister_netdev;
200 /* firmware upload is triggered in islpci_open */
204 do_unregister_netdev:
205 unregister_netdev(ndev);
206 islpci_free_memory(priv);
207 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);
257 pci_release_regions(pdev);
259 pci_disable_device(pdev);
263 prism54_suspend(struct pci_dev *pdev, pm_message_t state)
265 struct net_device *ndev = pci_get_drvdata(pdev);
266 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
270 pci_save_state(pdev);
272 /* tell the device not to trigger interrupts for now... */
273 isl38xx_disable_interrupts(priv->device_base);
275 /* from now on assume the hardware was already powered down
276 and don't touch it anymore */
277 islpci_set_state(priv, PRV_STATE_OFF);
279 netif_stop_queue(ndev);
280 netif_device_detach(ndev);
286 prism54_resume(struct pci_dev *pdev)
288 struct net_device *ndev = pci_get_drvdata(pdev);
289 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
292 pci_enable_device(pdev);
294 printk(KERN_NOTICE "%s: got resume request\n", ndev->name);
296 pci_restore_state(pdev);
298 /* alright let's go into the PREBOOT state */
299 islpci_reset(priv, 1);
301 netif_device_attach(ndev);
302 netif_start_queue(ndev);
308 prism54_module_init(void)
310 printk(KERN_INFO "Loaded %s driver, version %s\n",
311 DRV_NAME, DRV_VERSION);
313 __bug_on_wrong_struct_sizes ();
315 return pci_module_init(&prism54_driver);
318 /* by the time prism54_module_exit() terminates, as a postcondition
319 * all instances will have been destroyed by calls to
320 * prism54_remove() */
322 prism54_module_exit(void)
324 __in_cleanup_module = 1;
326 pci_unregister_driver(&prism54_driver);
328 printk(KERN_INFO "Unloaded %s driver\n", DRV_NAME);
330 __in_cleanup_module = 0;
333 /* register entry points */
334 module_init(prism54_module_init);
335 module_exit(prism54_module_exit);