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 */
25 #include <linux/dma-mapping.h>
27 #include "prismcompat.h"
28 #include "islpci_dev.h"
29 #include "islpci_mgt.h" /* for pc_debug */
32 #define DRV_NAME "prism54"
33 #define DRV_VERSION "1.2"
35 MODULE_AUTHOR("[Intersil] R.Bastings and W.Termorshuizen, The prism54.org Development Team <prism54-devel@prism54.org>");
36 MODULE_DESCRIPTION("The Prism54 802.11 Wireless LAN adapter");
37 MODULE_LICENSE("GPL");
39 static int init_pcitm = 0;
40 module_param(init_pcitm, int, 0);
42 /* In this order: vendor, device, subvendor, subdevice, class, class_mask,
44 * If you have an update for this please contact prism54-devel@prism54.org
45 * The latest list can be found at http://prism54.org/supported_cards.php */
46 static const struct pci_device_id prism54_id_tbl[] = {
47 /* Intersil PRISM Duette/Prism GT Wireless LAN adapter */
50 PCI_ANY_ID, PCI_ANY_ID,
54 /* 3COM 3CRWE154G72 Wireless LAN adapter */
57 PCI_ANY_ID, PCI_ANY_ID,
61 /* Intersil PRISM Indigo Wireless LAN adapter */
64 PCI_ANY_ID, PCI_ANY_ID,
68 /* Intersil PRISM Javelin/Xbow Wireless LAN adapter */
71 PCI_ANY_ID, PCI_ANY_ID,
79 /* register the device with the Hotplug facilities of the kernel */
80 MODULE_DEVICE_TABLE(pci, prism54_id_tbl);
82 static int prism54_probe(struct pci_dev *, const struct pci_device_id *);
83 static void prism54_remove(struct pci_dev *);
84 static int prism54_suspend(struct pci_dev *, pm_message_t state);
85 static int prism54_resume(struct pci_dev *);
87 static struct pci_driver prism54_driver = {
89 .id_table = prism54_id_tbl,
90 .probe = prism54_probe,
91 .remove = prism54_remove,
92 .suspend = prism54_suspend,
93 .resume = prism54_resume,
94 /* .enable_wake ; we don't support this yet */
97 /******************************************************************************
98 Module initialization functions
99 ******************************************************************************/
102 prism54_probe(struct pci_dev *pdev, const struct pci_device_id *id)
104 struct net_device *ndev;
107 islpci_private *priv;
110 /* Enable the pci device */
111 if (pci_enable_device(pdev)) {
112 printk(KERN_ERR "%s: pci_enable_device() failed.\n", DRV_NAME);
116 /* check whether the latency timer is set correctly */
117 pci_read_config_byte(pdev, PCI_LATENCY_TIMER, &latency_tmr);
118 #if VERBOSE > SHOW_ERROR_MESSAGES
119 DEBUG(SHOW_TRACING, "latency timer: %x\n", latency_tmr);
121 if (latency_tmr < PCIDEVICE_LATENCY_TIMER_MIN) {
122 /* set the latency timer */
123 pci_write_config_byte(pdev, PCI_LATENCY_TIMER,
124 PCIDEVICE_LATENCY_TIMER_VAL);
128 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
129 printk(KERN_ERR "%s: 32-bit PCI DMA not supported", DRV_NAME);
130 goto do_pci_disable_device;
133 /* 0x40 is the programmable timer to configure the response timeout (TRDY_TIMEOUT)
134 * 0x41 is the programmable timer to configure the retry timeout (RETRY_TIMEOUT)
135 * The RETRY_TIMEOUT is used to set the number of retries that the core, as a
136 * Master, will perform before abandoning a cycle. The default value for
137 * RETRY_TIMEOUT is 0x80, which far exceeds the PCI 2.1 requirement for new
138 * devices. A write of zero to the RETRY_TIMEOUT register disables this
139 * function to allow use with any non-compliant legacy devices that may
140 * execute more retries.
142 * Writing zero to both these two registers will disable both timeouts and
143 * *can* solve problems caused by devices that are slow to respond.
144 * Make this configurable - MSW
146 if ( init_pcitm >= 0 ) {
147 pci_write_config_byte(pdev, 0x40, (u8)init_pcitm);
148 pci_write_config_byte(pdev, 0x41, (u8)init_pcitm);
150 printk(KERN_INFO "PCI TRDY/RETRY unchanged\n");
153 /* request the pci device I/O regions */
154 rvalue = pci_request_regions(pdev, DRV_NAME);
156 printk(KERN_ERR "%s: pci_request_regions failure (rc=%d)\n",
158 goto do_pci_disable_device;
161 /* check if the memory window is indeed set */
162 rvalue = pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &mem_addr);
163 if (rvalue || !mem_addr) {
164 printk(KERN_ERR "%s: PCI device memory region not configured; fix your BIOS or CardBus bridge/drivers\n",
166 goto do_pci_release_regions;
169 /* enable PCI bus-mastering */
170 DEBUG(SHOW_TRACING, "%s: pci_set_master(pdev)\n", DRV_NAME);
171 pci_set_master(pdev);
176 /* setup the network device interface and its structure */
177 if (!(ndev = islpci_setup(pdev))) {
178 /* error configuring the driver as a network device */
179 printk(KERN_ERR "%s: could not configure network device\n",
181 goto do_pci_release_regions;
184 priv = netdev_priv(ndev);
185 islpci_set_state(priv, PRV_STATE_PREBOOT); /* we are attempting to boot */
187 /* card is in unknown state yet, might have some interrupts pending */
188 isl38xx_disable_interrupts(priv->device_base);
190 /* request for the interrupt before uploading the firmware */
191 rvalue = request_irq(pdev->irq, &islpci_interrupt,
192 IRQF_SHARED, ndev->name, priv);
195 /* error, could not hook the handler to the irq */
196 printk(KERN_ERR "%s: could not install IRQ handler\n",
198 goto do_unregister_netdev;
201 /* firmware upload is triggered in islpci_open */
205 do_unregister_netdev:
206 unregister_netdev(ndev);
207 islpci_free_memory(priv);
208 pci_set_drvdata(pdev, NULL);
211 do_pci_release_regions:
212 pci_release_regions(pdev);
213 do_pci_disable_device:
214 pci_disable_device(pdev);
218 /* set by cleanup_module */
219 static volatile int __in_cleanup_module = 0;
221 /* this one removes one(!!) instance only */
223 prism54_remove(struct pci_dev *pdev)
225 struct net_device *ndev = pci_get_drvdata(pdev);
226 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
229 if (!__in_cleanup_module) {
230 printk(KERN_DEBUG "%s: hot unplug detected\n", ndev->name);
231 islpci_set_state(priv, PRV_STATE_OFF);
234 printk(KERN_DEBUG "%s: removing device\n", ndev->name);
236 unregister_netdev(ndev);
238 /* free the interrupt request */
240 if (islpci_get_state(priv) != PRV_STATE_OFF) {
241 isl38xx_disable_interrupts(priv->device_base);
242 islpci_set_state(priv, PRV_STATE_OFF);
243 /* This bellow causes a lockup at rmmod time. It might be
244 * because some interrupts still linger after rmmod time,
246 /* pci_set_power_state(pdev, 3);*/ /* try to power-off */
249 free_irq(pdev->irq, priv);
251 /* free the PCI memory and unmap the remapped page */
252 islpci_free_memory(priv);
254 pci_set_drvdata(pdev, NULL);
258 pci_release_regions(pdev);
260 pci_disable_device(pdev);
264 prism54_suspend(struct pci_dev *pdev, pm_message_t state)
266 struct net_device *ndev = pci_get_drvdata(pdev);
267 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
271 pci_save_state(pdev);
273 /* tell the device not to trigger interrupts for now... */
274 isl38xx_disable_interrupts(priv->device_base);
276 /* from now on assume the hardware was already powered down
277 and don't touch it anymore */
278 islpci_set_state(priv, PRV_STATE_OFF);
280 netif_stop_queue(ndev);
281 netif_device_detach(ndev);
287 prism54_resume(struct pci_dev *pdev)
289 struct net_device *ndev = pci_get_drvdata(pdev);
290 islpci_private *priv = ndev ? netdev_priv(ndev) : NULL;
293 pci_enable_device(pdev);
295 printk(KERN_NOTICE "%s: got resume request\n", ndev->name);
297 pci_restore_state(pdev);
299 /* alright let's go into the PREBOOT state */
300 islpci_reset(priv, 1);
302 netif_device_attach(ndev);
303 netif_start_queue(ndev);
309 prism54_module_init(void)
311 printk(KERN_INFO "Loaded %s driver, version %s\n",
312 DRV_NAME, DRV_VERSION);
314 __bug_on_wrong_struct_sizes ();
316 return pci_register_driver(&prism54_driver);
319 /* by the time prism54_module_exit() terminates, as a postcondition
320 * all instances will have been destroyed by calls to
321 * prism54_remove() */
323 prism54_module_exit(void)
325 __in_cleanup_module = 1;
327 pci_unregister_driver(&prism54_driver);
329 printk(KERN_INFO "Unloaded %s driver\n", DRV_NAME);
331 __in_cleanup_module = 0;
334 /* register entry points */
335 module_init(prism54_module_init);
336 module_exit(prism54_module_exit);