blob: df37b95607ff3825f3cc0d6da8185a4a08415fe5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* orinoco_pci.c
2 *
Pavel Roskindc3437d2006-04-07 04:11:00 -04003 * Driver for Prism 2.5/3 devices that have a direct PCI interface
4 * (i.e. these are not PCMCIA cards in a PCMCIA-to-PCI bridge).
5 * The card contains only one PCI region, which contains all the usual
6 * hermes registers, as well as the COR register.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
Pavel Roskindc3437d2006-04-07 04:11:00 -04008 * Current maintainers are:
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * Pavel Roskin <proski AT gnu.org>
10 * and David Gibson <hermes AT gibson.dropbear.id.au>
11 *
12 * Some of this code is borrowed from orinoco_plx.c
13 * Copyright (C) 2001 Daniel Barlow <dan AT telent.net>
14 * Some of this code is "inspired" by linux-wlan-ng-0.1.10, but nothing
15 * has been copied from it. linux-wlan-ng-0.1.10 is originally :
16 * Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved.
17 * This file originally written by:
18 * Copyright (C) 2001 Jean Tourrilhes <jt AT hpl.hp.com>
19 * And is now maintained by:
20 * (C) Copyright David Gibson, IBM Corp. 2002-2003.
21 *
22 * The contents of this file are subject to the Mozilla Public License
23 * Version 1.1 (the "License"); you may not use this file except in
24 * compliance with the License. You may obtain a copy of the License
25 * at http://www.mozilla.org/MPL/
26 *
27 * Software distributed under the License is distributed on an "AS IS"
28 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
29 * the License for the specific language governing rights and
30 * limitations under the License.
31 *
32 * Alternatively, the contents of this file may be used under the
33 * terms of the GNU General Public License version 2 (the "GPL"), in
34 * which case the provisions of the GPL are applicable instead of the
35 * above. If you wish to allow the use of your version of this file
36 * only under the terms of the GPL and not to allow others to use your
37 * version of this file under the MPL, indicate your decision by
38 * deleting the provisions above and replace them with the notice and
39 * other provisions required by the GPL. If you do not delete the
40 * provisions above, a recipient may use your version of this file
41 * under either the MPL or the GPL.
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#define DRIVER_NAME "orinoco_pci"
45#define PFX DRIVER_NAME ": "
46
47#include <linux/config.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/module.h>
49#include <linux/kernel.h>
50#include <linux/init.h>
Pavel Roskinef846bf2005-09-23 04:18:07 -040051#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/pci.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include "orinoco.h"
Pavel Roskinb884c872006-04-07 04:10:57 -040055#include "orinoco_pci.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Pavel Roskindc3437d2006-04-07 04:11:00 -040057/* Offset of the COR register of the PCI card */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define HERMES_PCI_COR (0x26)
Pavel Roskindc3437d2006-04-07 04:11:00 -040059
60/* Bitmask to reset the card */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#define HERMES_PCI_COR_MASK (0x0080)
Pavel Roskindc3437d2006-04-07 04:11:00 -040062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/* Magic timeouts for doing the reset.
64 * Those times are straight from wlan-ng, and it is claimed that they
65 * are necessary. Alan will kill me. Take your time and grab a coffee. */
66#define HERMES_PCI_COR_ONT (250) /* ms */
67#define HERMES_PCI_COR_OFFT (500) /* ms */
68#define HERMES_PCI_COR_BUSYT (500) /* ms */
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070/*
Pavel Roskindc3437d2006-04-07 04:11:00 -040071 * Do a soft reset of the card using the Configuration Option Register
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * We need this to get going...
73 * This is the part of the code that is strongly inspired from wlan-ng
74 *
75 * Note : This code is done with irq enabled. This mean that many
76 * interrupts will occur while we are there. This is why we use the
77 * jiffies to regulate time instead of a straight mdelay(). Usually we
78 * need only around 245 iteration of the loop to do 250 ms delay.
79 *
80 * Note bis : Don't try to access HERMES_CMD during the reset phase.
81 * It just won't work !
82 */
Pavel Roskinb884c872006-04-07 04:10:57 -040083static int orinoco_pci_cor_reset(struct orinoco_private *priv)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
85 hermes_t *hw = &priv->hw;
Pavel Roskinb884c872006-04-07 04:10:57 -040086 unsigned long timeout;
87 u16 reg;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Pavel Roskindc3437d2006-04-07 04:11:00 -040089 /* Assert the reset until the card notices */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 hermes_write_regn(hw, PCI_COR, HERMES_PCI_COR_MASK);
91 mdelay(HERMES_PCI_COR_ONT);
92
93 /* Give time for the card to recover from this hard effort */
94 hermes_write_regn(hw, PCI_COR, 0x0000);
95 mdelay(HERMES_PCI_COR_OFFT);
96
97 /* The card is ready when it's no longer busy */
98 timeout = jiffies + (HERMES_PCI_COR_BUSYT * HZ / 1000);
99 reg = hermes_read_regn(hw, CMD);
100 while (time_before(jiffies, timeout) && (reg & HERMES_CMD_BUSY)) {
101 mdelay(1);
102 reg = hermes_read_regn(hw, CMD);
103 }
104
105 /* Still busy? */
106 if (reg & HERMES_CMD_BUSY) {
107 printk(KERN_ERR PFX "Busy timeout\n");
108 return -ETIMEDOUT;
109 }
110
111 return 0;
112}
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114static int orinoco_pci_init_one(struct pci_dev *pdev,
115 const struct pci_device_id *ent)
116{
Pavel Roskinb884c872006-04-07 04:10:57 -0400117 int err;
118 struct orinoco_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 struct orinoco_pci_card *card;
Pavel Roskinb884c872006-04-07 04:10:57 -0400120 struct net_device *dev;
121 void __iomem *hermes_io;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123 err = pci_enable_device(pdev);
124 if (err) {
125 printk(KERN_ERR PFX "Cannot enable PCI device\n");
126 return err;
127 }
128
129 err = pci_request_regions(pdev, DRIVER_NAME);
Pavel Roskinb884c872006-04-07 04:10:57 -0400130 if (err) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 printk(KERN_ERR PFX "Cannot obtain PCI resources\n");
132 goto fail_resources;
133 }
134
Pavel Roskinb884c872006-04-07 04:10:57 -0400135 hermes_io = pci_iomap(pdev, 0, 0);
136 if (!hermes_io) {
137 printk(KERN_ERR PFX "Cannot remap chipset registers\n");
Pavel Roskin3d529962006-04-07 04:10:53 -0400138 err = -EIO;
Pavel Roskinb884c872006-04-07 04:10:57 -0400139 goto fail_map_hermes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 }
141
142 /* Allocate network device */
143 dev = alloc_orinocodev(sizeof(*card), orinoco_pci_cor_reset);
Pavel Roskinb884c872006-04-07 04:10:57 -0400144 if (!dev) {
145 printk(KERN_ERR PFX "Cannot allocate network device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 err = -ENOMEM;
147 goto fail_alloc;
148 }
149
150 priv = netdev_priv(dev);
151 card = priv->card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 SET_MODULE_OWNER(dev);
153 SET_NETDEV_DEV(dev, &pdev->dev);
154
Pavel Roskinb884c872006-04-07 04:10:57 -0400155 hermes_struct_init(&priv->hw, hermes_io, HERMES_32BIT_REGSPACING);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 err = request_irq(pdev->irq, orinoco_interrupt, SA_SHIRQ,
158 dev->name, dev);
159 if (err) {
160 printk(KERN_ERR PFX "Cannot allocate IRQ %d\n", pdev->irq);
161 err = -EBUSY;
162 goto fail_irq;
163 }
Pavel Roskinb884c872006-04-07 04:10:57 -0400164 orinoco_pci_setup_netdev(dev, pdev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 err = orinoco_pci_cor_reset(priv);
167 if (err) {
168 printk(KERN_ERR PFX "Initial reset failed\n");
169 goto fail;
170 }
171
172 err = register_netdev(dev);
173 if (err) {
Pavel Roskinb884c872006-04-07 04:10:57 -0400174 printk(KERN_ERR PFX "Cannot register network device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 goto fail;
176 }
177
178 pci_set_drvdata(pdev, dev);
179
180 return 0;
181
182 fail:
183 free_irq(pdev->irq, dev);
184
185 fail_irq:
186 pci_set_drvdata(pdev, NULL);
187 free_orinocodev(dev);
188
189 fail_alloc:
Pavel Roskinb884c872006-04-07 04:10:57 -0400190 pci_iounmap(pdev, hermes_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Pavel Roskinb884c872006-04-07 04:10:57 -0400192 fail_map_hermes:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 pci_release_regions(pdev);
194
195 fail_resources:
196 pci_disable_device(pdev);
197
198 return err;
199}
200
201static void __devexit orinoco_pci_remove_one(struct pci_dev *pdev)
202{
203 struct net_device *dev = pci_get_drvdata(pdev);
204 struct orinoco_private *priv = netdev_priv(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206 unregister_netdev(dev);
207 free_irq(dev->irq, dev);
208 pci_set_drvdata(pdev, NULL);
209 free_orinocodev(dev);
Pavel Roskinb884c872006-04-07 04:10:57 -0400210 pci_iounmap(pdev, priv->hw.iobase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 pci_release_regions(pdev);
212 pci_disable_device(pdev);
213}
214
Pavel Roskinb884c872006-04-07 04:10:57 -0400215static struct pci_device_id orinoco_pci_id_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 /* Intersil Prism 3 */
217 {0x1260, 0x3872, PCI_ANY_ID, PCI_ANY_ID,},
218 /* Intersil Prism 2.5 */
219 {0x1260, 0x3873, PCI_ANY_ID, PCI_ANY_ID,},
220 /* Samsung MagicLAN SWL-2210P */
221 {0x167d, 0xa000, PCI_ANY_ID, PCI_ANY_ID,},
222 {0,},
223};
224
Pavel Roskinb884c872006-04-07 04:10:57 -0400225MODULE_DEVICE_TABLE(pci, orinoco_pci_id_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227static struct pci_driver orinoco_pci_driver = {
228 .name = DRIVER_NAME,
Pavel Roskinb884c872006-04-07 04:10:57 -0400229 .id_table = orinoco_pci_id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 .probe = orinoco_pci_init_one,
231 .remove = __devexit_p(orinoco_pci_remove_one),
232 .suspend = orinoco_pci_suspend,
233 .resume = orinoco_pci_resume,
234};
235
236static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
237 " (Pavel Roskin <proski@gnu.org>,"
238 " David Gibson <hermes@gibson.dropbear.id.au> &"
239 " Jean Tourrilhes <jt@hpl.hp.com>)";
240MODULE_AUTHOR("Pavel Roskin <proski@gnu.org> & David Gibson <hermes@gibson.dropbear.id.au>");
241MODULE_DESCRIPTION("Driver for wireless LAN cards using direct PCI interface");
242MODULE_LICENSE("Dual MPL/GPL");
243
244static int __init orinoco_pci_init(void)
245{
246 printk(KERN_DEBUG "%s\n", version);
247 return pci_module_init(&orinoco_pci_driver);
248}
249
250static void __exit orinoco_pci_exit(void)
251{
252 pci_unregister_driver(&orinoco_pci_driver);
253}
254
255module_init(orinoco_pci_init);
256module_exit(orinoco_pci_exit);
257
258/*
259 * Local variables:
260 * c-indent-level: 8
261 * c-basic-offset: 8
262 * tab-width: 8
263 * End:
264 */