orinoco: encapsulate driver locking
[safe/jmp/linux-2.6] / drivers / net / wireless / orinoco / main.c
1 /* main.c - (formerly known as dldwd_cs.c, orinoco_cs.c and orinoco.c)
2  *
3  * A driver for Hermes or Prism 2 chipset based PCMCIA wireless
4  * adaptors, with Lucent/Agere, Intersil or Symbol firmware.
5  *
6  * Current maintainers (as of 29 September 2003) are:
7  *      Pavel Roskin <proski AT gnu.org>
8  * and  David Gibson <hermes AT gibson.dropbear.id.au>
9  *
10  * (C) Copyright David Gibson, IBM Corporation 2001-2003.
11  * Copyright (C) 2000 David Gibson, Linuxcare Australia.
12  *      With some help from :
13  * Copyright (C) 2001 Jean Tourrilhes, HP Labs
14  * Copyright (C) 2001 Benjamin Herrenschmidt
15  *
16  * Based on dummy_cs.c 1.27 2000/06/12 21:27:25
17  *
18  * Portions based on wvlan_cs.c 1.0.6, Copyright Andreas Neuhaus <andy
19  * AT fasta.fh-dortmund.de>
20  *      http://www.stud.fh-dortmund.de/~andy/wvlan/
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  * The initial developer of the original code is David A. Hinds
33  * <dahinds AT users.sourceforge.net>.  Portions created by David
34  * A. Hinds are Copyright (C) 1999 David A. Hinds.  All Rights
35  * Reserved.
36  *
37  * Alternatively, the contents of this file may be used under the
38  * terms of the GNU General Public License version 2 (the "GPL"), in
39  * which case the provisions of the GPL are applicable instead of the
40  * above.  If you wish to allow the use of your version of this file
41  * only under the terms of the GPL and not to allow others to use your
42  * version of this file under the MPL, indicate your decision by
43  * deleting the provisions above and replace them with the notice and
44  * other provisions required by the GPL.  If you do not delete the
45  * provisions above, a recipient may use your version of this file
46  * under either the MPL or the GPL.  */
47
48 /*
49  * TODO
50  *      o Handle de-encapsulation within network layer, provide 802.11
51  *        headers (patch from Thomas 'Dent' Mirlacher)
52  *      o Fix possible races in SPY handling.
53  *      o Disconnect wireless extensions from fundamental configuration.
54  *      o (maybe) Software WEP support (patch from Stano Meduna).
55  *      o (maybe) Use multiple Tx buffers - driver handling queue
56  *        rather than firmware.
57  */
58
59 /* Locking and synchronization:
60  *
61  * The basic principle is that everything is serialized through a
62  * single spinlock, priv->lock.  The lock is used in user, bh and irq
63  * context, so when taken outside hardirq context it should always be
64  * taken with interrupts disabled.  The lock protects both the
65  * hardware and the struct orinoco_private.
66  *
67  * Another flag, priv->hw_unavailable indicates that the hardware is
68  * unavailable for an extended period of time (e.g. suspended, or in
69  * the middle of a hard reset).  This flag is protected by the
70  * spinlock.  All code which touches the hardware should check the
71  * flag after taking the lock, and if it is set, give up on whatever
72  * they are doing and drop the lock again.  The orinoco_lock()
73  * function handles this (it unlocks and returns -EBUSY if
74  * hw_unavailable is non-zero).
75  */
76
77 #define DRIVER_NAME "orinoco"
78
79 #include <linux/module.h>
80 #include <linux/kernel.h>
81 #include <linux/init.h>
82 #include <linux/delay.h>
83 #include <linux/device.h>
84 #include <linux/netdevice.h>
85 #include <linux/etherdevice.h>
86 #include <linux/suspend.h>
87 #include <linux/if_arp.h>
88 #include <linux/wireless.h>
89 #include <linux/ieee80211.h>
90 #include <net/iw_handler.h>
91 #include <net/cfg80211.h>
92
93 #include "hermes_rid.h"
94 #include "hermes_dld.h"
95 #include "hw.h"
96 #include "scan.h"
97 #include "mic.h"
98 #include "fw.h"
99 #include "wext.h"
100 #include "cfg.h"
101 #include "main.h"
102
103 #include "orinoco.h"
104
105 /********************************************************************/
106 /* Module information                                               */
107 /********************************************************************/
108
109 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org> & "
110               "David Gibson <hermes@gibson.dropbear.id.au>");
111 MODULE_DESCRIPTION("Driver for Lucent Orinoco, Prism II based "
112                    "and similar wireless cards");
113 MODULE_LICENSE("Dual MPL/GPL");
114
115 /* Level of debugging. Used in the macros in orinoco.h */
116 #ifdef ORINOCO_DEBUG
117 int orinoco_debug = ORINOCO_DEBUG;
118 EXPORT_SYMBOL(orinoco_debug);
119 module_param(orinoco_debug, int, 0644);
120 MODULE_PARM_DESC(orinoco_debug, "Debug level");
121 #endif
122
123 static int suppress_linkstatus; /* = 0 */
124 module_param(suppress_linkstatus, bool, 0644);
125 MODULE_PARM_DESC(suppress_linkstatus, "Don't log link status changes");
126
127 static int ignore_disconnect; /* = 0 */
128 module_param(ignore_disconnect, int, 0644);
129 MODULE_PARM_DESC(ignore_disconnect,
130                  "Don't report lost link to the network layer");
131
132 int force_monitor; /* = 0 */
133 module_param(force_monitor, int, 0644);
134 MODULE_PARM_DESC(force_monitor, "Allow monitor mode for all firmware versions");
135
136 /********************************************************************/
137 /* Internal constants                                               */
138 /********************************************************************/
139
140 /* 802.2 LLC/SNAP header used for Ethernet encapsulation over 802.11 */
141 static const u8 encaps_hdr[] = {0xaa, 0xaa, 0x03, 0x00, 0x00, 0x00};
142 #define ENCAPS_OVERHEAD         (sizeof(encaps_hdr) + 2)
143
144 #define ORINOCO_MIN_MTU         256
145 #define ORINOCO_MAX_MTU         (IEEE80211_MAX_DATA_LEN - ENCAPS_OVERHEAD)
146
147 #define MAX_IRQLOOPS_PER_IRQ    10
148 #define MAX_IRQLOOPS_PER_JIFFY  (20000/HZ) /* Based on a guestimate of
149                                             * how many events the
150                                             * device could
151                                             * legitimately generate */
152
153 #define DUMMY_FID               0xFFFF
154
155 /*#define MAX_MULTICAST(priv)   (priv->firmware_type == FIRMWARE_TYPE_AGERE ? \
156   HERMES_MAX_MULTICAST : 0)*/
157 #define MAX_MULTICAST(priv)     (HERMES_MAX_MULTICAST)
158
159 #define ORINOCO_INTEN           (HERMES_EV_RX | HERMES_EV_ALLOC \
160                                  | HERMES_EV_TX | HERMES_EV_TXEXC \
161                                  | HERMES_EV_WTERR | HERMES_EV_INFO \
162                                  | HERMES_EV_INFDROP)
163
164 /********************************************************************/
165 /* Data types                                                       */
166 /********************************************************************/
167
168 /* Beginning of the Tx descriptor, used in TxExc handling */
169 struct hermes_txexc_data {
170         struct hermes_tx_descriptor desc;
171         __le16 frame_ctl;
172         __le16 duration_id;
173         u8 addr1[ETH_ALEN];
174 } __attribute__ ((packed));
175
176 /* Rx frame header except compatibility 802.3 header */
177 struct hermes_rx_descriptor {
178         /* Control */
179         __le16 status;
180         __le32 time;
181         u8 silence;
182         u8 signal;
183         u8 rate;
184         u8 rxflow;
185         __le32 reserved;
186
187         /* 802.11 header */
188         __le16 frame_ctl;
189         __le16 duration_id;
190         u8 addr1[ETH_ALEN];
191         u8 addr2[ETH_ALEN];
192         u8 addr3[ETH_ALEN];
193         __le16 seq_ctl;
194         u8 addr4[ETH_ALEN];
195
196         /* Data length */
197         __le16 data_len;
198 } __attribute__ ((packed));
199
200 struct orinoco_rx_data {
201         struct hermes_rx_descriptor *desc;
202         struct sk_buff *skb;
203         struct list_head list;
204 };
205
206 struct orinoco_scan_data {
207         void *buf;
208         size_t len;
209         int type;
210         struct list_head list;
211 };
212
213 /********************************************************************/
214 /* Function prototypes                                              */
215 /********************************************************************/
216
217 static int __orinoco_set_multicast_list(struct net_device *dev);
218 static int __orinoco_up(struct orinoco_private *priv);
219 static int __orinoco_down(struct orinoco_private *priv);
220 static int __orinoco_commit(struct orinoco_private *priv);
221
222 /********************************************************************/
223 /* Internal helper functions                                        */
224 /********************************************************************/
225
226 void set_port_type(struct orinoco_private *priv)
227 {
228         switch (priv->iw_mode) {
229         case NL80211_IFTYPE_STATION:
230                 priv->port_type = 1;
231                 priv->createibss = 0;
232                 break;
233         case NL80211_IFTYPE_ADHOC:
234                 if (priv->prefer_port3) {
235                         priv->port_type = 3;
236                         priv->createibss = 0;
237                 } else {
238                         priv->port_type = priv->ibss_port;
239                         priv->createibss = 1;
240                 }
241                 break;
242         case NL80211_IFTYPE_MONITOR:
243                 priv->port_type = 3;
244                 priv->createibss = 0;
245                 break;
246         default:
247                 printk(KERN_ERR "%s: Invalid priv->iw_mode in set_port_type()\n",
248                        priv->ndev->name);
249         }
250 }
251
252 /********************************************************************/
253 /* Device methods                                                   */
254 /********************************************************************/
255
256 int orinoco_open(struct net_device *dev)
257 {
258         struct orinoco_private *priv = ndev_priv(dev);
259         unsigned long flags;
260         int err;
261
262         if (orinoco_lock(priv, &flags) != 0)
263                 return -EBUSY;
264
265         err = __orinoco_up(priv);
266
267         if (!err)
268                 priv->open = 1;
269
270         orinoco_unlock(priv, &flags);
271
272         return err;
273 }
274 EXPORT_SYMBOL(orinoco_open);
275
276 int orinoco_stop(struct net_device *dev)
277 {
278         struct orinoco_private *priv = ndev_priv(dev);
279         int err = 0;
280
281         /* We mustn't use orinoco_lock() here, because we need to be
282            able to close the interface even if hw_unavailable is set
283            (e.g. as we're released after a PC Card removal) */
284         orinoco_lock_irq(priv);
285
286         priv->open = 0;
287
288         err = __orinoco_down(priv);
289
290         orinoco_unlock_irq(priv);
291
292         return err;
293 }
294 EXPORT_SYMBOL(orinoco_stop);
295
296 struct net_device_stats *orinoco_get_stats(struct net_device *dev)
297 {
298         struct orinoco_private *priv = ndev_priv(dev);
299
300         return &priv->stats;
301 }
302 EXPORT_SYMBOL(orinoco_get_stats);
303
304 void orinoco_set_multicast_list(struct net_device *dev)
305 {
306         struct orinoco_private *priv = ndev_priv(dev);
307         unsigned long flags;
308
309         if (orinoco_lock(priv, &flags) != 0) {
310                 printk(KERN_DEBUG "%s: orinoco_set_multicast_list() "
311                        "called when hw_unavailable\n", dev->name);
312                 return;
313         }
314
315         __orinoco_set_multicast_list(dev);
316         orinoco_unlock(priv, &flags);
317 }
318 EXPORT_SYMBOL(orinoco_set_multicast_list);
319
320 int orinoco_change_mtu(struct net_device *dev, int new_mtu)
321 {
322         struct orinoco_private *priv = ndev_priv(dev);
323
324         if ((new_mtu < ORINOCO_MIN_MTU) || (new_mtu > ORINOCO_MAX_MTU))
325                 return -EINVAL;
326
327         /* MTU + encapsulation + header length */
328         if ((new_mtu + ENCAPS_OVERHEAD + sizeof(struct ieee80211_hdr)) >
329              (priv->nicbuf_size - ETH_HLEN))
330                 return -EINVAL;
331
332         dev->mtu = new_mtu;
333
334         return 0;
335 }
336 EXPORT_SYMBOL(orinoco_change_mtu);
337
338 /********************************************************************/
339 /* Tx path                                                          */
340 /********************************************************************/
341
342 static netdev_tx_t orinoco_xmit(struct sk_buff *skb, struct net_device *dev)
343 {
344         struct orinoco_private *priv = ndev_priv(dev);
345         struct net_device_stats *stats = &priv->stats;
346         struct orinoco_tkip_key *key;
347         hermes_t *hw = &priv->hw;
348         int err = 0;
349         u16 txfid = priv->txfid;
350         struct ethhdr *eh;
351         int tx_control;
352         unsigned long flags;
353         int do_mic;
354
355         if (!netif_running(dev)) {
356                 printk(KERN_ERR "%s: Tx on stopped device!\n",
357                        dev->name);
358                 return NETDEV_TX_BUSY;
359         }
360
361         if (netif_queue_stopped(dev)) {
362                 printk(KERN_DEBUG "%s: Tx while transmitter busy!\n",
363                        dev->name);
364                 return NETDEV_TX_BUSY;
365         }
366
367         if (orinoco_lock(priv, &flags) != 0) {
368                 printk(KERN_ERR "%s: orinoco_xmit() called while hw_unavailable\n",
369                        dev->name);
370                 return NETDEV_TX_BUSY;
371         }
372
373         if (!netif_carrier_ok(dev) ||
374             (priv->iw_mode == NL80211_IFTYPE_MONITOR)) {
375                 /* Oops, the firmware hasn't established a connection,
376                    silently drop the packet (this seems to be the
377                    safest approach). */
378                 goto drop;
379         }
380
381         /* Check packet length */
382         if (skb->len < ETH_HLEN)
383                 goto drop;
384
385         key = (struct orinoco_tkip_key *) priv->keys[priv->tx_key].key;
386
387         do_mic = ((priv->encode_alg == ORINOCO_ALG_TKIP) &&
388                   (key != NULL));
389
390         tx_control = HERMES_TXCTRL_TX_OK | HERMES_TXCTRL_TX_EX;
391
392         if (do_mic)
393                 tx_control |= (priv->tx_key << HERMES_MIC_KEY_ID_SHIFT) |
394                         HERMES_TXCTRL_MIC;
395
396         if (priv->has_alt_txcntl) {
397                 /* WPA enabled firmwares have tx_cntl at the end of
398                  * the 802.11 header.  So write zeroed descriptor and
399                  * 802.11 header at the same time
400                  */
401                 char desc[HERMES_802_3_OFFSET];
402                 __le16 *txcntl = (__le16 *) &desc[HERMES_TXCNTL2_OFFSET];
403
404                 memset(&desc, 0, sizeof(desc));
405
406                 *txcntl = cpu_to_le16(tx_control);
407                 err = hw->ops->bap_pwrite(hw, USER_BAP, &desc, sizeof(desc),
408                                           txfid, 0);
409                 if (err) {
410                         if (net_ratelimit())
411                                 printk(KERN_ERR "%s: Error %d writing Tx "
412                                        "descriptor to BAP\n", dev->name, err);
413                         goto busy;
414                 }
415         } else {
416                 struct hermes_tx_descriptor desc;
417
418                 memset(&desc, 0, sizeof(desc));
419
420                 desc.tx_control = cpu_to_le16(tx_control);
421                 err = hw->ops->bap_pwrite(hw, USER_BAP, &desc, sizeof(desc),
422                                           txfid, 0);
423                 if (err) {
424                         if (net_ratelimit())
425                                 printk(KERN_ERR "%s: Error %d writing Tx "
426                                        "descriptor to BAP\n", dev->name, err);
427                         goto busy;
428                 }
429
430                 /* Clear the 802.11 header and data length fields - some
431                  * firmwares (e.g. Lucent/Agere 8.xx) appear to get confused
432                  * if this isn't done. */
433                 hermes_clear_words(hw, HERMES_DATA0,
434                                    HERMES_802_3_OFFSET - HERMES_802_11_OFFSET);
435         }
436
437         eh = (struct ethhdr *)skb->data;
438
439         /* Encapsulate Ethernet-II frames */
440         if (ntohs(eh->h_proto) > ETH_DATA_LEN) { /* Ethernet-II frame */
441                 struct header_struct {
442                         struct ethhdr eth;      /* 802.3 header */
443                         u8 encap[6];            /* 802.2 header */
444                 } __attribute__ ((packed)) hdr;
445
446                 /* Strip destination and source from the data */
447                 skb_pull(skb, 2 * ETH_ALEN);
448
449                 /* And move them to a separate header */
450                 memcpy(&hdr.eth, eh, 2 * ETH_ALEN);
451                 hdr.eth.h_proto = htons(sizeof(encaps_hdr) + skb->len);
452                 memcpy(hdr.encap, encaps_hdr, sizeof(encaps_hdr));
453
454                 /* Insert the SNAP header */
455                 if (skb_headroom(skb) < sizeof(hdr)) {
456                         printk(KERN_ERR
457                                "%s: Not enough headroom for 802.2 headers %d\n",
458                                dev->name, skb_headroom(skb));
459                         goto drop;
460                 }
461                 eh = (struct ethhdr *) skb_push(skb, sizeof(hdr));
462                 memcpy(eh, &hdr, sizeof(hdr));
463         }
464
465         err = hw->ops->bap_pwrite(hw, USER_BAP, skb->data, skb->len,
466                                   txfid, HERMES_802_3_OFFSET);
467         if (err) {
468                 printk(KERN_ERR "%s: Error %d writing packet to BAP\n",
469                        dev->name, err);
470                 goto busy;
471         }
472
473         /* Calculate Michael MIC */
474         if (do_mic) {
475                 u8 mic_buf[MICHAEL_MIC_LEN + 1];
476                 u8 *mic;
477                 size_t offset;
478                 size_t len;
479
480                 if (skb->len % 2) {
481                         /* MIC start is on an odd boundary */
482                         mic_buf[0] = skb->data[skb->len - 1];
483                         mic = &mic_buf[1];
484                         offset = skb->len - 1;
485                         len = MICHAEL_MIC_LEN + 1;
486                 } else {
487                         mic = &mic_buf[0];
488                         offset = skb->len;
489                         len = MICHAEL_MIC_LEN;
490                 }
491
492                 orinoco_mic(priv->tx_tfm_mic, key->tx_mic,
493                             eh->h_dest, eh->h_source, 0 /* priority */,
494                             skb->data + ETH_HLEN, skb->len - ETH_HLEN, mic);
495
496                 /* Write the MIC */
497                 err = hw->ops->bap_pwrite(hw, USER_BAP, &mic_buf[0], len,
498                                           txfid, HERMES_802_3_OFFSET + offset);
499                 if (err) {
500                         printk(KERN_ERR "%s: Error %d writing MIC to BAP\n",
501                                dev->name, err);
502                         goto busy;
503                 }
504         }
505
506         /* Finally, we actually initiate the send */
507         netif_stop_queue(dev);
508
509         err = hw->ops->cmd_wait(hw, HERMES_CMD_TX | HERMES_CMD_RECL,
510                                 txfid, NULL);
511         if (err) {
512                 netif_start_queue(dev);
513                 if (net_ratelimit())
514                         printk(KERN_ERR "%s: Error %d transmitting packet\n",
515                                 dev->name, err);
516                 goto busy;
517         }
518
519         dev->trans_start = jiffies;
520         stats->tx_bytes += HERMES_802_3_OFFSET + skb->len;
521         goto ok;
522
523  drop:
524         stats->tx_errors++;
525         stats->tx_dropped++;
526
527  ok:
528         orinoco_unlock(priv, &flags);
529         dev_kfree_skb(skb);
530         return NETDEV_TX_OK;
531
532  busy:
533         if (err == -EIO)
534                 schedule_work(&priv->reset_work);
535         orinoco_unlock(priv, &flags);
536         return NETDEV_TX_BUSY;
537 }
538
539 static void __orinoco_ev_alloc(struct net_device *dev, hermes_t *hw)
540 {
541         struct orinoco_private *priv = ndev_priv(dev);
542         u16 fid = hermes_read_regn(hw, ALLOCFID);
543
544         if (fid != priv->txfid) {
545                 if (fid != DUMMY_FID)
546                         printk(KERN_WARNING "%s: Allocate event on unexpected fid (%04X)\n",
547                                dev->name, fid);
548                 return;
549         }
550
551         hermes_write_regn(hw, ALLOCFID, DUMMY_FID);
552 }
553
554 static void __orinoco_ev_tx(struct net_device *dev, hermes_t *hw)
555 {
556         struct orinoco_private *priv = ndev_priv(dev);
557         struct net_device_stats *stats = &priv->stats;
558
559         stats->tx_packets++;
560
561         netif_wake_queue(dev);
562
563         hermes_write_regn(hw, TXCOMPLFID, DUMMY_FID);
564 }
565
566 static void __orinoco_ev_txexc(struct net_device *dev, hermes_t *hw)
567 {
568         struct orinoco_private *priv = ndev_priv(dev);
569         struct net_device_stats *stats = &priv->stats;
570         u16 fid = hermes_read_regn(hw, TXCOMPLFID);
571         u16 status;
572         struct hermes_txexc_data hdr;
573         int err = 0;
574
575         if (fid == DUMMY_FID)
576                 return; /* Nothing's really happened */
577
578         /* Read part of the frame header - we need status and addr1 */
579         err = hw->ops->bap_pread(hw, IRQ_BAP, &hdr,
580                                  sizeof(struct hermes_txexc_data),
581                                  fid, 0);
582
583         hermes_write_regn(hw, TXCOMPLFID, DUMMY_FID);
584         stats->tx_errors++;
585
586         if (err) {
587                 printk(KERN_WARNING "%s: Unable to read descriptor on Tx error "
588                        "(FID=%04X error %d)\n",
589                        dev->name, fid, err);
590                 return;
591         }
592
593         DEBUG(1, "%s: Tx error, err %d (FID=%04X)\n", dev->name,
594               err, fid);
595
596         /* We produce a TXDROP event only for retry or lifetime
597          * exceeded, because that's the only status that really mean
598          * that this particular node went away.
599          * Other errors means that *we* screwed up. - Jean II */
600         status = le16_to_cpu(hdr.desc.status);
601         if (status & (HERMES_TXSTAT_RETRYERR | HERMES_TXSTAT_AGEDERR)) {
602                 union iwreq_data        wrqu;
603
604                 /* Copy 802.11 dest address.
605                  * We use the 802.11 header because the frame may
606                  * not be 802.3 or may be mangled...
607                  * In Ad-Hoc mode, it will be the node address.
608                  * In managed mode, it will be most likely the AP addr
609                  * User space will figure out how to convert it to
610                  * whatever it needs (IP address or else).
611                  * - Jean II */
612                 memcpy(wrqu.addr.sa_data, hdr.addr1, ETH_ALEN);
613                 wrqu.addr.sa_family = ARPHRD_ETHER;
614
615                 /* Send event to user space */
616                 wireless_send_event(dev, IWEVTXDROP, &wrqu, NULL);
617         }
618
619         netif_wake_queue(dev);
620 }
621
622 void orinoco_tx_timeout(struct net_device *dev)
623 {
624         struct orinoco_private *priv = ndev_priv(dev);
625         struct net_device_stats *stats = &priv->stats;
626         struct hermes *hw = &priv->hw;
627
628         printk(KERN_WARNING "%s: Tx timeout! "
629                "ALLOCFID=%04x, TXCOMPLFID=%04x, EVSTAT=%04x\n",
630                dev->name, hermes_read_regn(hw, ALLOCFID),
631                hermes_read_regn(hw, TXCOMPLFID), hermes_read_regn(hw, EVSTAT));
632
633         stats->tx_errors++;
634
635         schedule_work(&priv->reset_work);
636 }
637 EXPORT_SYMBOL(orinoco_tx_timeout);
638
639 /********************************************************************/
640 /* Rx path (data frames)                                            */
641 /********************************************************************/
642
643 /* Does the frame have a SNAP header indicating it should be
644  * de-encapsulated to Ethernet-II? */
645 static inline int is_ethersnap(void *_hdr)
646 {
647         u8 *hdr = _hdr;
648
649         /* We de-encapsulate all packets which, a) have SNAP headers
650          * (i.e. SSAP=DSAP=0xaa and CTRL=0x3 in the 802.2 LLC header
651          * and where b) the OUI of the SNAP header is 00:00:00 or
652          * 00:00:f8 - we need both because different APs appear to use
653          * different OUIs for some reason */
654         return (memcmp(hdr, &encaps_hdr, 5) == 0)
655                 && ((hdr[5] == 0x00) || (hdr[5] == 0xf8));
656 }
657
658 static inline void orinoco_spy_gather(struct net_device *dev, u_char *mac,
659                                       int level, int noise)
660 {
661         struct iw_quality wstats;
662         wstats.level = level - 0x95;
663         wstats.noise = noise - 0x95;
664         wstats.qual = (level > noise) ? (level - noise) : 0;
665         wstats.updated = IW_QUAL_ALL_UPDATED | IW_QUAL_DBM;
666         /* Update spy records */
667         wireless_spy_update(dev, mac, &wstats);
668 }
669
670 static void orinoco_stat_gather(struct net_device *dev,
671                                 struct sk_buff *skb,
672                                 struct hermes_rx_descriptor *desc)
673 {
674         struct orinoco_private *priv = ndev_priv(dev);
675
676         /* Using spy support with lots of Rx packets, like in an
677          * infrastructure (AP), will really slow down everything, because
678          * the MAC address must be compared to each entry of the spy list.
679          * If the user really asks for it (set some address in the
680          * spy list), we do it, but he will pay the price.
681          * Note that to get here, you need both WIRELESS_SPY
682          * compiled in AND some addresses in the list !!!
683          */
684         /* Note : gcc will optimise the whole section away if
685          * WIRELESS_SPY is not defined... - Jean II */
686         if (SPY_NUMBER(priv)) {
687                 orinoco_spy_gather(dev, skb_mac_header(skb) + ETH_ALEN,
688                                    desc->signal, desc->silence);
689         }
690 }
691
692 /*
693  * orinoco_rx_monitor - handle received monitor frames.
694  *
695  * Arguments:
696  *      dev             network device
697  *      rxfid           received FID
698  *      desc            rx descriptor of the frame
699  *
700  * Call context: interrupt
701  */
702 static void orinoco_rx_monitor(struct net_device *dev, u16 rxfid,
703                                struct hermes_rx_descriptor *desc)
704 {
705         u32 hdrlen = 30;        /* return full header by default */
706         u32 datalen = 0;
707         u16 fc;
708         int err;
709         int len;
710         struct sk_buff *skb;
711         struct orinoco_private *priv = ndev_priv(dev);
712         struct net_device_stats *stats = &priv->stats;
713         hermes_t *hw = &priv->hw;
714
715         len = le16_to_cpu(desc->data_len);
716
717         /* Determine the size of the header and the data */
718         fc = le16_to_cpu(desc->frame_ctl);
719         switch (fc & IEEE80211_FCTL_FTYPE) {
720         case IEEE80211_FTYPE_DATA:
721                 if ((fc & IEEE80211_FCTL_TODS)
722                     && (fc & IEEE80211_FCTL_FROMDS))
723                         hdrlen = 30;
724                 else
725                         hdrlen = 24;
726                 datalen = len;
727                 break;
728         case IEEE80211_FTYPE_MGMT:
729                 hdrlen = 24;
730                 datalen = len;
731                 break;
732         case IEEE80211_FTYPE_CTL:
733                 switch (fc & IEEE80211_FCTL_STYPE) {
734                 case IEEE80211_STYPE_PSPOLL:
735                 case IEEE80211_STYPE_RTS:
736                 case IEEE80211_STYPE_CFEND:
737                 case IEEE80211_STYPE_CFENDACK:
738                         hdrlen = 16;
739                         break;
740                 case IEEE80211_STYPE_CTS:
741                 case IEEE80211_STYPE_ACK:
742                         hdrlen = 10;
743                         break;
744                 }
745                 break;
746         default:
747                 /* Unknown frame type */
748                 break;
749         }
750
751         /* sanity check the length */
752         if (datalen > IEEE80211_MAX_DATA_LEN + 12) {
753                 printk(KERN_DEBUG "%s: oversized monitor frame, "
754                        "data length = %d\n", dev->name, datalen);
755                 stats->rx_length_errors++;
756                 goto update_stats;
757         }
758
759         skb = dev_alloc_skb(hdrlen + datalen);
760         if (!skb) {
761                 printk(KERN_WARNING "%s: Cannot allocate skb for monitor frame\n",
762                        dev->name);
763                 goto update_stats;
764         }
765
766         /* Copy the 802.11 header to the skb */
767         memcpy(skb_put(skb, hdrlen), &(desc->frame_ctl), hdrlen);
768         skb_reset_mac_header(skb);
769
770         /* If any, copy the data from the card to the skb */
771         if (datalen > 0) {
772                 err = hw->ops->bap_pread(hw, IRQ_BAP, skb_put(skb, datalen),
773                                          ALIGN(datalen, 2), rxfid,
774                                          HERMES_802_2_OFFSET);
775                 if (err) {
776                         printk(KERN_ERR "%s: error %d reading monitor frame\n",
777                                dev->name, err);
778                         goto drop;
779                 }
780         }
781
782         skb->dev = dev;
783         skb->ip_summed = CHECKSUM_NONE;
784         skb->pkt_type = PACKET_OTHERHOST;
785         skb->protocol = cpu_to_be16(ETH_P_802_2);
786
787         stats->rx_packets++;
788         stats->rx_bytes += skb->len;
789
790         netif_rx(skb);
791         return;
792
793  drop:
794         dev_kfree_skb_irq(skb);
795  update_stats:
796         stats->rx_errors++;
797         stats->rx_dropped++;
798 }
799
800 static void __orinoco_ev_rx(struct net_device *dev, hermes_t *hw)
801 {
802         struct orinoco_private *priv = ndev_priv(dev);
803         struct net_device_stats *stats = &priv->stats;
804         struct iw_statistics *wstats = &priv->wstats;
805         struct sk_buff *skb = NULL;
806         u16 rxfid, status;
807         int length;
808         struct hermes_rx_descriptor *desc;
809         struct orinoco_rx_data *rx_data;
810         int err;
811
812         desc = kmalloc(sizeof(*desc), GFP_ATOMIC);
813         if (!desc) {
814                 printk(KERN_WARNING
815                        "%s: Can't allocate space for RX descriptor\n",
816                        dev->name);
817                 goto update_stats;
818         }
819
820         rxfid = hermes_read_regn(hw, RXFID);
821
822         err = hw->ops->bap_pread(hw, IRQ_BAP, desc, sizeof(*desc),
823                                  rxfid, 0);
824         if (err) {
825                 printk(KERN_ERR "%s: error %d reading Rx descriptor. "
826                        "Frame dropped.\n", dev->name, err);
827                 goto update_stats;
828         }
829
830         status = le16_to_cpu(desc->status);
831
832         if (status & HERMES_RXSTAT_BADCRC) {
833                 DEBUG(1, "%s: Bad CRC on Rx. Frame dropped.\n",
834                       dev->name);
835                 stats->rx_crc_errors++;
836                 goto update_stats;
837         }
838
839         /* Handle frames in monitor mode */
840         if (priv->iw_mode == NL80211_IFTYPE_MONITOR) {
841                 orinoco_rx_monitor(dev, rxfid, desc);
842                 goto out;
843         }
844
845         if (status & HERMES_RXSTAT_UNDECRYPTABLE) {
846                 DEBUG(1, "%s: Undecryptable frame on Rx. Frame dropped.\n",
847                       dev->name);
848                 wstats->discard.code++;
849                 goto update_stats;
850         }
851
852         length = le16_to_cpu(desc->data_len);
853
854         /* Sanity checks */
855         if (length < 3) { /* No for even an 802.2 LLC header */
856                 /* At least on Symbol firmware with PCF we get quite a
857                    lot of these legitimately - Poll frames with no
858                    data. */
859                 goto out;
860         }
861         if (length > IEEE80211_MAX_DATA_LEN) {
862                 printk(KERN_WARNING "%s: Oversized frame received (%d bytes)\n",
863                        dev->name, length);
864                 stats->rx_length_errors++;
865                 goto update_stats;
866         }
867
868         /* Payload size does not include Michael MIC. Increase payload
869          * size to read it together with the data. */
870         if (status & HERMES_RXSTAT_MIC)
871                 length += MICHAEL_MIC_LEN;
872
873         /* We need space for the packet data itself, plus an ethernet
874            header, plus 2 bytes so we can align the IP header on a
875            32bit boundary, plus 1 byte so we can read in odd length
876            packets from the card, which has an IO granularity of 16
877            bits */
878         skb = dev_alloc_skb(length+ETH_HLEN+2+1);
879         if (!skb) {
880                 printk(KERN_WARNING "%s: Can't allocate skb for Rx\n",
881                        dev->name);
882                 goto update_stats;
883         }
884
885         /* We'll prepend the header, so reserve space for it.  The worst
886            case is no decapsulation, when 802.3 header is prepended and
887            nothing is removed.  2 is for aligning the IP header.  */
888         skb_reserve(skb, ETH_HLEN + 2);
889
890         err = hw->ops->bap_pread(hw, IRQ_BAP, skb_put(skb, length),
891                                  ALIGN(length, 2), rxfid,
892                                  HERMES_802_2_OFFSET);
893         if (err) {
894                 printk(KERN_ERR "%s: error %d reading frame. "
895                        "Frame dropped.\n", dev->name, err);
896                 goto drop;
897         }
898
899         /* Add desc and skb to rx queue */
900         rx_data = kzalloc(sizeof(*rx_data), GFP_ATOMIC);
901         if (!rx_data) {
902                 printk(KERN_WARNING "%s: Can't allocate RX packet\n",
903                         dev->name);
904                 goto drop;
905         }
906         rx_data->desc = desc;
907         rx_data->skb = skb;
908         list_add_tail(&rx_data->list, &priv->rx_list);
909         tasklet_schedule(&priv->rx_tasklet);
910
911         return;
912
913 drop:
914         dev_kfree_skb_irq(skb);
915 update_stats:
916         stats->rx_errors++;
917         stats->rx_dropped++;
918 out:
919         kfree(desc);
920 }
921
922 static void orinoco_rx(struct net_device *dev,
923                        struct hermes_rx_descriptor *desc,
924                        struct sk_buff *skb)
925 {
926         struct orinoco_private *priv = ndev_priv(dev);
927         struct net_device_stats *stats = &priv->stats;
928         u16 status, fc;
929         int length;
930         struct ethhdr *hdr;
931
932         status = le16_to_cpu(desc->status);
933         length = le16_to_cpu(desc->data_len);
934         fc = le16_to_cpu(desc->frame_ctl);
935
936         /* Calculate and check MIC */
937         if (status & HERMES_RXSTAT_MIC) {
938                 struct orinoco_tkip_key *key;
939                 int key_id = ((status & HERMES_RXSTAT_MIC_KEY_ID) >>
940                               HERMES_MIC_KEY_ID_SHIFT);
941                 u8 mic[MICHAEL_MIC_LEN];
942                 u8 *rxmic;
943                 u8 *src = (fc & IEEE80211_FCTL_FROMDS) ?
944                         desc->addr3 : desc->addr2;
945
946                 /* Extract Michael MIC from payload */
947                 rxmic = skb->data + skb->len - MICHAEL_MIC_LEN;
948
949                 skb_trim(skb, skb->len - MICHAEL_MIC_LEN);
950                 length -= MICHAEL_MIC_LEN;
951
952                 key = (struct orinoco_tkip_key *) priv->keys[key_id].key;
953
954                 if (!key) {
955                         printk(KERN_WARNING "%s: Received encrypted frame from "
956                                "%pM using key %i, but key is not installed\n",
957                                dev->name, src, key_id);
958                         goto drop;
959                 }
960
961                 orinoco_mic(priv->rx_tfm_mic, key->rx_mic, desc->addr1, src,
962                             0, /* priority or QoS? */
963                             skb->data, skb->len, &mic[0]);
964
965                 if (memcmp(mic, rxmic,
966                            MICHAEL_MIC_LEN)) {
967                         union iwreq_data wrqu;
968                         struct iw_michaelmicfailure wxmic;
969
970                         printk(KERN_WARNING "%s: "
971                                "Invalid Michael MIC in data frame from %pM, "
972                                "using key %i\n",
973                                dev->name, src, key_id);
974
975                         /* TODO: update stats */
976
977                         /* Notify userspace */
978                         memset(&wxmic, 0, sizeof(wxmic));
979                         wxmic.flags = key_id & IW_MICFAILURE_KEY_ID;
980                         wxmic.flags |= (desc->addr1[0] & 1) ?
981                                 IW_MICFAILURE_GROUP : IW_MICFAILURE_PAIRWISE;
982                         wxmic.src_addr.sa_family = ARPHRD_ETHER;
983                         memcpy(wxmic.src_addr.sa_data, src, ETH_ALEN);
984
985                         (void) orinoco_hw_get_tkip_iv(priv, key_id,
986                                                       &wxmic.tsc[0]);
987
988                         memset(&wrqu, 0, sizeof(wrqu));
989                         wrqu.data.length = sizeof(wxmic);
990                         wireless_send_event(dev, IWEVMICHAELMICFAILURE, &wrqu,
991                                             (char *) &wxmic);
992
993                         goto drop;
994                 }
995         }
996
997         /* Handle decapsulation
998          * In most cases, the firmware tell us about SNAP frames.
999          * For some reason, the SNAP frames sent by LinkSys APs
1000          * are not properly recognised by most firmwares.
1001          * So, check ourselves */
1002         if (length >= ENCAPS_OVERHEAD &&
1003             (((status & HERMES_RXSTAT_MSGTYPE) == HERMES_RXSTAT_1042) ||
1004              ((status & HERMES_RXSTAT_MSGTYPE) == HERMES_RXSTAT_TUNNEL) ||
1005              is_ethersnap(skb->data))) {
1006                 /* These indicate a SNAP within 802.2 LLC within
1007                    802.11 frame which we'll need to de-encapsulate to
1008                    the original EthernetII frame. */
1009                 hdr = (struct ethhdr *)skb_push(skb,
1010                                                 ETH_HLEN - ENCAPS_OVERHEAD);
1011         } else {
1012                 /* 802.3 frame - prepend 802.3 header as is */
1013                 hdr = (struct ethhdr *)skb_push(skb, ETH_HLEN);
1014                 hdr->h_proto = htons(length);
1015         }
1016         memcpy(hdr->h_dest, desc->addr1, ETH_ALEN);
1017         if (fc & IEEE80211_FCTL_FROMDS)
1018                 memcpy(hdr->h_source, desc->addr3, ETH_ALEN);
1019         else
1020                 memcpy(hdr->h_source, desc->addr2, ETH_ALEN);
1021
1022         skb->protocol = eth_type_trans(skb, dev);
1023         skb->ip_summed = CHECKSUM_NONE;
1024         if (fc & IEEE80211_FCTL_TODS)
1025                 skb->pkt_type = PACKET_OTHERHOST;
1026
1027         /* Process the wireless stats if needed */
1028         orinoco_stat_gather(dev, skb, desc);
1029
1030         /* Pass the packet to the networking stack */
1031         netif_rx(skb);
1032         stats->rx_packets++;
1033         stats->rx_bytes += length;
1034
1035         return;
1036
1037  drop:
1038         dev_kfree_skb(skb);
1039         stats->rx_errors++;
1040         stats->rx_dropped++;
1041 }
1042
1043 static void orinoco_rx_isr_tasklet(unsigned long data)
1044 {
1045         struct orinoco_private *priv = (struct orinoco_private *) data;
1046         struct net_device *dev = priv->ndev;
1047         struct orinoco_rx_data *rx_data, *temp;
1048         struct hermes_rx_descriptor *desc;
1049         struct sk_buff *skb;
1050         unsigned long flags;
1051
1052         /* orinoco_rx requires the driver lock, and we also need to
1053          * protect priv->rx_list, so just hold the lock over the
1054          * lot.
1055          *
1056          * If orinoco_lock fails, we've unplugged the card. In this
1057          * case just abort. */
1058         if (orinoco_lock(priv, &flags) != 0)
1059                 return;
1060
1061         /* extract desc and skb from queue */
1062         list_for_each_entry_safe(rx_data, temp, &priv->rx_list, list) {
1063                 desc = rx_data->desc;
1064                 skb = rx_data->skb;
1065                 list_del(&rx_data->list);
1066                 kfree(rx_data);
1067
1068                 orinoco_rx(dev, desc, skb);
1069
1070                 kfree(desc);
1071         }
1072
1073         orinoco_unlock(priv, &flags);
1074 }
1075
1076 /********************************************************************/
1077 /* Rx path (info frames)                                            */
1078 /********************************************************************/
1079
1080 static void print_linkstatus(struct net_device *dev, u16 status)
1081 {
1082         char *s;
1083
1084         if (suppress_linkstatus)
1085                 return;
1086
1087         switch (status) {
1088         case HERMES_LINKSTATUS_NOT_CONNECTED:
1089                 s = "Not Connected";
1090                 break;
1091         case HERMES_LINKSTATUS_CONNECTED:
1092                 s = "Connected";
1093                 break;
1094         case HERMES_LINKSTATUS_DISCONNECTED:
1095                 s = "Disconnected";
1096                 break;
1097         case HERMES_LINKSTATUS_AP_CHANGE:
1098                 s = "AP Changed";
1099                 break;
1100         case HERMES_LINKSTATUS_AP_OUT_OF_RANGE:
1101                 s = "AP Out of Range";
1102                 break;
1103         case HERMES_LINKSTATUS_AP_IN_RANGE:
1104                 s = "AP In Range";
1105                 break;
1106         case HERMES_LINKSTATUS_ASSOC_FAILED:
1107                 s = "Association Failed";
1108                 break;
1109         default:
1110                 s = "UNKNOWN";
1111         }
1112
1113         printk(KERN_DEBUG "%s: New link status: %s (%04x)\n",
1114                dev->name, s, status);
1115 }
1116
1117 /* Search scan results for requested BSSID, join it if found */
1118 static void orinoco_join_ap(struct work_struct *work)
1119 {
1120         struct orinoco_private *priv =
1121                 container_of(work, struct orinoco_private, join_work);
1122         struct net_device *dev = priv->ndev;
1123         struct hermes *hw = &priv->hw;
1124         int err;
1125         unsigned long flags;
1126         struct join_req {
1127                 u8 bssid[ETH_ALEN];
1128                 __le16 channel;
1129         } __attribute__ ((packed)) req;
1130         const int atom_len = offsetof(struct prism2_scan_apinfo, atim);
1131         struct prism2_scan_apinfo *atom = NULL;
1132         int offset = 4;
1133         int found = 0;
1134         u8 *buf;
1135         u16 len;
1136
1137         /* Allocate buffer for scan results */
1138         buf = kmalloc(MAX_SCAN_LEN, GFP_KERNEL);
1139         if (!buf)
1140                 return;
1141
1142         if (orinoco_lock(priv, &flags) != 0)
1143                 goto fail_lock;
1144
1145         /* Sanity checks in case user changed something in the meantime */
1146         if (!priv->bssid_fixed)
1147                 goto out;
1148
1149         if (strlen(priv->desired_essid) == 0)
1150                 goto out;
1151
1152         /* Read scan results from the firmware */
1153         err = hw->ops->read_ltv(hw, USER_BAP,
1154                                 HERMES_RID_SCANRESULTSTABLE,
1155                                 MAX_SCAN_LEN, &len, buf);
1156         if (err) {
1157                 printk(KERN_ERR "%s: Cannot read scan results\n",
1158                        dev->name);
1159                 goto out;
1160         }
1161
1162         len = HERMES_RECLEN_TO_BYTES(len);
1163
1164         /* Go through the scan results looking for the channel of the AP
1165          * we were requested to join */
1166         for (; offset + atom_len <= len; offset += atom_len) {
1167                 atom = (struct prism2_scan_apinfo *) (buf + offset);
1168                 if (memcmp(&atom->bssid, priv->desired_bssid, ETH_ALEN) == 0) {
1169                         found = 1;
1170                         break;
1171                 }
1172         }
1173
1174         if (!found) {
1175                 DEBUG(1, "%s: Requested AP not found in scan results\n",
1176                       dev->name);
1177                 goto out;
1178         }
1179
1180         memcpy(req.bssid, priv->desired_bssid, ETH_ALEN);
1181         req.channel = atom->channel;    /* both are little-endian */
1182         err = HERMES_WRITE_RECORD(hw, USER_BAP, HERMES_RID_CNFJOINREQUEST,
1183                                   &req);
1184         if (err)
1185                 printk(KERN_ERR "%s: Error issuing join request\n", dev->name);
1186
1187  out:
1188         orinoco_unlock(priv, &flags);
1189
1190  fail_lock:
1191         kfree(buf);
1192 }
1193
1194 /* Send new BSSID to userspace */
1195 static void orinoco_send_bssid_wevent(struct orinoco_private *priv)
1196 {
1197         struct net_device *dev = priv->ndev;
1198         struct hermes *hw = &priv->hw;
1199         union iwreq_data wrqu;
1200         int err;
1201
1202         err = hw->ops->read_ltv(hw, USER_BAP, HERMES_RID_CURRENTBSSID,
1203                                 ETH_ALEN, NULL, wrqu.ap_addr.sa_data);
1204         if (err != 0)
1205                 return;
1206
1207         wrqu.ap_addr.sa_family = ARPHRD_ETHER;
1208
1209         /* Send event to user space */
1210         wireless_send_event(dev, SIOCGIWAP, &wrqu, NULL);
1211 }
1212
1213 static void orinoco_send_assocreqie_wevent(struct orinoco_private *priv)
1214 {
1215         struct net_device *dev = priv->ndev;
1216         struct hermes *hw = &priv->hw;
1217         union iwreq_data wrqu;
1218         int err;
1219         u8 buf[88];
1220         u8 *ie;
1221
1222         if (!priv->has_wpa)
1223                 return;
1224
1225         err = hw->ops->read_ltv(hw, USER_BAP, HERMES_RID_CURRENT_ASSOC_REQ_INFO,
1226                                 sizeof(buf), NULL, &buf);
1227         if (err != 0)
1228                 return;
1229
1230         ie = orinoco_get_wpa_ie(buf, sizeof(buf));
1231         if (ie) {
1232                 int rem = sizeof(buf) - (ie - &buf[0]);
1233                 wrqu.data.length = ie[1] + 2;
1234                 if (wrqu.data.length > rem)
1235                         wrqu.data.length = rem;
1236
1237                 if (wrqu.data.length)
1238                         /* Send event to user space */
1239                         wireless_send_event(dev, IWEVASSOCREQIE, &wrqu, ie);
1240         }
1241 }
1242
1243 static void orinoco_send_assocrespie_wevent(struct orinoco_private *priv)
1244 {
1245         struct net_device *dev = priv->ndev;
1246         struct hermes *hw = &priv->hw;
1247         union iwreq_data wrqu;
1248         int err;
1249         u8 buf[88]; /* TODO: verify max size or IW_GENERIC_IE_MAX */
1250         u8 *ie;
1251
1252         if (!priv->has_wpa)
1253                 return;
1254
1255         err = hw->ops->read_ltv(hw, USER_BAP,
1256                                 HERMES_RID_CURRENT_ASSOC_RESP_INFO,
1257                                 sizeof(buf), NULL, &buf);
1258         if (err != 0)
1259                 return;
1260
1261         ie = orinoco_get_wpa_ie(buf, sizeof(buf));
1262         if (ie) {
1263                 int rem = sizeof(buf) - (ie - &buf[0]);
1264                 wrqu.data.length = ie[1] + 2;
1265                 if (wrqu.data.length > rem)
1266                         wrqu.data.length = rem;
1267
1268                 if (wrqu.data.length)
1269                         /* Send event to user space */
1270                         wireless_send_event(dev, IWEVASSOCRESPIE, &wrqu, ie);
1271         }
1272 }
1273
1274 static void orinoco_send_wevents(struct work_struct *work)
1275 {
1276         struct orinoco_private *priv =
1277                 container_of(work, struct orinoco_private, wevent_work);
1278         unsigned long flags;
1279
1280         if (orinoco_lock(priv, &flags) != 0)
1281                 return;
1282
1283         orinoco_send_assocreqie_wevent(priv);
1284         orinoco_send_assocrespie_wevent(priv);
1285         orinoco_send_bssid_wevent(priv);
1286
1287         orinoco_unlock(priv, &flags);
1288 }
1289
1290 static void qbuf_scan(struct orinoco_private *priv, void *buf,
1291                       int len, int type)
1292 {
1293         struct orinoco_scan_data *sd;
1294         unsigned long flags;
1295
1296         sd = kmalloc(sizeof(*sd), GFP_ATOMIC);
1297         sd->buf = buf;
1298         sd->len = len;
1299         sd->type = type;
1300
1301         spin_lock_irqsave(&priv->scan_lock, flags);
1302         list_add_tail(&sd->list, &priv->scan_list);
1303         spin_unlock_irqrestore(&priv->scan_lock, flags);
1304
1305         schedule_work(&priv->process_scan);
1306 }
1307
1308 static void qabort_scan(struct orinoco_private *priv)
1309 {
1310         struct orinoco_scan_data *sd;
1311         unsigned long flags;
1312
1313         sd = kmalloc(sizeof(*sd), GFP_ATOMIC);
1314         sd->len = -1; /* Abort */
1315
1316         spin_lock_irqsave(&priv->scan_lock, flags);
1317         list_add_tail(&sd->list, &priv->scan_list);
1318         spin_unlock_irqrestore(&priv->scan_lock, flags);
1319
1320         schedule_work(&priv->process_scan);
1321 }
1322
1323 static void orinoco_process_scan_results(struct work_struct *work)
1324 {
1325         struct orinoco_private *priv =
1326                 container_of(work, struct orinoco_private, process_scan);
1327         struct orinoco_scan_data *sd, *temp;
1328         unsigned long flags;
1329         void *buf;
1330         int len;
1331         int type;
1332
1333         spin_lock_irqsave(&priv->scan_lock, flags);
1334         list_for_each_entry_safe(sd, temp, &priv->scan_list, list) {
1335                 spin_unlock_irqrestore(&priv->scan_lock, flags);
1336
1337                 buf = sd->buf;
1338                 len = sd->len;
1339                 type = sd->type;
1340
1341                 list_del(&sd->list);
1342                 kfree(sd);
1343
1344                 if (len > 0) {
1345                         if (type == HERMES_INQ_CHANNELINFO)
1346                                 orinoco_add_extscan_result(priv, buf, len);
1347                         else
1348                                 orinoco_add_hostscan_results(priv, buf, len);
1349
1350                         kfree(buf);
1351                 } else if (priv->scan_request) {
1352                         /* Either abort or complete the scan */
1353                         cfg80211_scan_done(priv->scan_request, (len < 0));
1354                         priv->scan_request = NULL;
1355                 }
1356
1357                 spin_lock_irqsave(&priv->scan_lock, flags);
1358         }
1359         spin_unlock_irqrestore(&priv->scan_lock, flags);
1360 }
1361
1362 static void __orinoco_ev_info(struct net_device *dev, hermes_t *hw)
1363 {
1364         struct orinoco_private *priv = ndev_priv(dev);
1365         u16 infofid;
1366         struct {
1367                 __le16 len;
1368                 __le16 type;
1369         } __attribute__ ((packed)) info;
1370         int len, type;
1371         int err;
1372
1373         /* This is an answer to an INQUIRE command that we did earlier,
1374          * or an information "event" generated by the card
1375          * The controller return to us a pseudo frame containing
1376          * the information in question - Jean II */
1377         infofid = hermes_read_regn(hw, INFOFID);
1378
1379         /* Read the info frame header - don't try too hard */
1380         err = hw->ops->bap_pread(hw, IRQ_BAP, &info, sizeof(info),
1381                                  infofid, 0);
1382         if (err) {
1383                 printk(KERN_ERR "%s: error %d reading info frame. "
1384                        "Frame dropped.\n", dev->name, err);
1385                 return;
1386         }
1387
1388         len = HERMES_RECLEN_TO_BYTES(le16_to_cpu(info.len));
1389         type = le16_to_cpu(info.type);
1390
1391         switch (type) {
1392         case HERMES_INQ_TALLIES: {
1393                 struct hermes_tallies_frame tallies;
1394                 struct iw_statistics *wstats = &priv->wstats;
1395
1396                 if (len > sizeof(tallies)) {
1397                         printk(KERN_WARNING "%s: Tallies frame too long (%d bytes)\n",
1398                                dev->name, len);
1399                         len = sizeof(tallies);
1400                 }
1401
1402                 err = hw->ops->bap_pread(hw, IRQ_BAP, &tallies, len,
1403                                          infofid, sizeof(info));
1404                 if (err)
1405                         break;
1406
1407                 /* Increment our various counters */
1408                 /* wstats->discard.nwid - no wrong BSSID stuff */
1409                 wstats->discard.code +=
1410                         le16_to_cpu(tallies.RxWEPUndecryptable);
1411                 if (len == sizeof(tallies))
1412                         wstats->discard.code +=
1413                                 le16_to_cpu(tallies.RxDiscards_WEPICVError) +
1414                                 le16_to_cpu(tallies.RxDiscards_WEPExcluded);
1415                 wstats->discard.misc +=
1416                         le16_to_cpu(tallies.TxDiscardsWrongSA);
1417                 wstats->discard.fragment +=
1418                         le16_to_cpu(tallies.RxMsgInBadMsgFragments);
1419                 wstats->discard.retries +=
1420                         le16_to_cpu(tallies.TxRetryLimitExceeded);
1421                 /* wstats->miss.beacon - no match */
1422         }
1423         break;
1424         case HERMES_INQ_LINKSTATUS: {
1425                 struct hermes_linkstatus linkstatus;
1426                 u16 newstatus;
1427                 int connected;
1428
1429                 if (priv->iw_mode == NL80211_IFTYPE_MONITOR)
1430                         break;
1431
1432                 if (len != sizeof(linkstatus)) {
1433                         printk(KERN_WARNING "%s: Unexpected size for linkstatus frame (%d bytes)\n",
1434                                dev->name, len);
1435                         break;
1436                 }
1437
1438                 err = hw->ops->bap_pread(hw, IRQ_BAP, &linkstatus, len,
1439                                          infofid, sizeof(info));
1440                 if (err)
1441                         break;
1442                 newstatus = le16_to_cpu(linkstatus.linkstatus);
1443
1444                 /* Symbol firmware uses "out of range" to signal that
1445                  * the hostscan frame can be requested.  */
1446                 if (newstatus == HERMES_LINKSTATUS_AP_OUT_OF_RANGE &&
1447                     priv->firmware_type == FIRMWARE_TYPE_SYMBOL &&
1448                     priv->has_hostscan && priv->scan_request) {
1449                         hermes_inquire(hw, HERMES_INQ_HOSTSCAN_SYMBOL);
1450                         break;
1451                 }
1452
1453                 connected = (newstatus == HERMES_LINKSTATUS_CONNECTED)
1454                         || (newstatus == HERMES_LINKSTATUS_AP_CHANGE)
1455                         || (newstatus == HERMES_LINKSTATUS_AP_IN_RANGE);
1456
1457                 if (connected)
1458                         netif_carrier_on(dev);
1459                 else if (!ignore_disconnect)
1460                         netif_carrier_off(dev);
1461
1462                 if (newstatus != priv->last_linkstatus) {
1463                         priv->last_linkstatus = newstatus;
1464                         print_linkstatus(dev, newstatus);
1465                         /* The info frame contains only one word which is the
1466                          * status (see hermes.h). The status is pretty boring
1467                          * in itself, that's why we export the new BSSID...
1468                          * Jean II */
1469                         schedule_work(&priv->wevent_work);
1470                 }
1471         }
1472         break;
1473         case HERMES_INQ_SCAN:
1474                 if (!priv->scan_request && priv->bssid_fixed &&
1475                     priv->firmware_type == FIRMWARE_TYPE_INTERSIL) {
1476                         schedule_work(&priv->join_work);
1477                         break;
1478                 }
1479                 /* fall through */
1480         case HERMES_INQ_HOSTSCAN:
1481         case HERMES_INQ_HOSTSCAN_SYMBOL: {
1482                 /* Result of a scanning. Contains information about
1483                  * cells in the vicinity - Jean II */
1484                 unsigned char *buf;
1485
1486                 /* Sanity check */
1487                 if (len > 4096) {
1488                         printk(KERN_WARNING "%s: Scan results too large (%d bytes)\n",
1489                                dev->name, len);
1490                         qabort_scan(priv);
1491                         break;
1492                 }
1493
1494                 /* Allocate buffer for results */
1495                 buf = kmalloc(len, GFP_ATOMIC);
1496                 if (buf == NULL) {
1497                         /* No memory, so can't printk()... */
1498                         qabort_scan(priv);
1499                         break;
1500                 }
1501
1502                 /* Read scan data */
1503                 err = hw->ops->bap_pread(hw, IRQ_BAP, (void *) buf, len,
1504                                          infofid, sizeof(info));
1505                 if (err) {
1506                         kfree(buf);
1507                         qabort_scan(priv);
1508                         break;
1509                 }
1510
1511 #ifdef ORINOCO_DEBUG
1512                 {
1513                         int     i;
1514                         printk(KERN_DEBUG "Scan result [%02X", buf[0]);
1515                         for (i = 1; i < (len * 2); i++)
1516                                 printk(":%02X", buf[i]);
1517                         printk("]\n");
1518                 }
1519 #endif  /* ORINOCO_DEBUG */
1520
1521                 qbuf_scan(priv, buf, len, type);
1522         }
1523         break;
1524         case HERMES_INQ_CHANNELINFO:
1525         {
1526                 struct agere_ext_scan_info *bss;
1527
1528                 if (!priv->scan_request) {
1529                         printk(KERN_DEBUG "%s: Got chaninfo without scan, "
1530                                "len=%d\n", dev->name, len);
1531                         break;
1532                 }
1533
1534                 /* An empty result indicates that the scan is complete */
1535                 if (len == 0) {
1536                         qbuf_scan(priv, NULL, len, type);
1537                         break;
1538                 }
1539
1540                 /* Sanity check */
1541                 else if (len < (offsetof(struct agere_ext_scan_info,
1542                                            data) + 2)) {
1543                         /* Drop this result now so we don't have to
1544                          * keep checking later */
1545                         printk(KERN_WARNING
1546                                "%s: Ext scan results too short (%d bytes)\n",
1547                                dev->name, len);
1548                         break;
1549                 }
1550
1551                 bss = kmalloc(len, GFP_ATOMIC);
1552                 if (bss == NULL)
1553                         break;
1554
1555                 /* Read scan data */
1556                 err = hw->ops->bap_pread(hw, IRQ_BAP, (void *) bss, len,
1557                                          infofid, sizeof(info));
1558                 if (err)
1559                         kfree(bss);
1560                 else
1561                         qbuf_scan(priv, bss, len, type);
1562
1563                 break;
1564         }
1565         case HERMES_INQ_SEC_STAT_AGERE:
1566                 /* Security status (Agere specific) */
1567                 /* Ignore this frame for now */
1568                 if (priv->firmware_type == FIRMWARE_TYPE_AGERE)
1569                         break;
1570                 /* fall through */
1571         default:
1572                 printk(KERN_DEBUG "%s: Unknown information frame received: "
1573                        "type 0x%04x, length %d\n", dev->name, type, len);
1574                 /* We don't actually do anything about it */
1575                 break;
1576         }
1577
1578         return;
1579 }
1580
1581 static void __orinoco_ev_infdrop(struct net_device *dev, hermes_t *hw)
1582 {
1583         if (net_ratelimit())
1584                 printk(KERN_DEBUG "%s: Information frame lost.\n", dev->name);
1585 }
1586
1587 /********************************************************************/
1588 /* Internal hardware control routines                               */
1589 /********************************************************************/
1590
1591 static int __orinoco_up(struct orinoco_private *priv)
1592 {
1593         struct net_device *dev = priv->ndev;
1594         struct hermes *hw = &priv->hw;
1595         int err;
1596
1597         netif_carrier_off(dev); /* just to make sure */
1598
1599         err = __orinoco_commit(priv);
1600         if (err) {
1601                 printk(KERN_ERR "%s: Error %d configuring card\n",
1602                        dev->name, err);
1603                 return err;
1604         }
1605
1606         /* Fire things up again */
1607         hermes_set_irqmask(hw, ORINOCO_INTEN);
1608         err = hermes_enable_port(hw, 0);
1609         if (err) {
1610                 printk(KERN_ERR "%s: Error %d enabling MAC port\n",
1611                        dev->name, err);
1612                 return err;
1613         }
1614
1615         netif_start_queue(dev);
1616
1617         return 0;
1618 }
1619
1620 static int __orinoco_down(struct orinoco_private *priv)
1621 {
1622         struct net_device *dev = priv->ndev;
1623         struct hermes *hw = &priv->hw;
1624         int err;
1625
1626         netif_stop_queue(dev);
1627
1628         if (!priv->hw_unavailable) {
1629                 if (!priv->broken_disableport) {
1630                         err = hermes_disable_port(hw, 0);
1631                         if (err) {
1632                                 /* Some firmwares (e.g. Intersil 1.3.x) seem
1633                                  * to have problems disabling the port, oh
1634                                  * well, too bad. */
1635                                 printk(KERN_WARNING "%s: Error %d disabling MAC port\n",
1636                                        dev->name, err);
1637                                 priv->broken_disableport = 1;
1638                         }
1639                 }
1640                 hermes_set_irqmask(hw, 0);
1641                 hermes_write_regn(hw, EVACK, 0xffff);
1642         }
1643
1644         /* firmware will have to reassociate */
1645         netif_carrier_off(dev);
1646         priv->last_linkstatus = 0xffff;
1647
1648         return 0;
1649 }
1650
1651 static int orinoco_reinit_firmware(struct orinoco_private *priv)
1652 {
1653         struct hermes *hw = &priv->hw;
1654         int err;
1655
1656         err = hw->ops->init(hw);
1657         if (priv->do_fw_download && !err) {
1658                 err = orinoco_download(priv);
1659                 if (err)
1660                         priv->do_fw_download = 0;
1661         }
1662         if (!err)
1663                 err = orinoco_hw_allocate_fid(priv);
1664
1665         return err;
1666 }
1667
1668 static int
1669 __orinoco_set_multicast_list(struct net_device *dev)
1670 {
1671         struct orinoco_private *priv = ndev_priv(dev);
1672         int err = 0;
1673         int promisc, mc_count;
1674
1675         /* The Hermes doesn't seem to have an allmulti mode, so we go
1676          * into promiscuous mode and let the upper levels deal. */
1677         if ((dev->flags & IFF_PROMISC) || (dev->flags & IFF_ALLMULTI) ||
1678             (netdev_mc_count(dev) > MAX_MULTICAST(priv))) {
1679                 promisc = 1;
1680                 mc_count = 0;
1681         } else {
1682                 promisc = 0;
1683                 mc_count = netdev_mc_count(dev);
1684         }
1685
1686         err = __orinoco_hw_set_multicast_list(priv, dev, mc_count, promisc);
1687
1688         return err;
1689 }
1690
1691 /* This must be called from user context, without locks held - use
1692  * schedule_work() */
1693 void orinoco_reset(struct work_struct *work)
1694 {
1695         struct orinoco_private *priv =
1696                 container_of(work, struct orinoco_private, reset_work);
1697         struct net_device *dev = priv->ndev;
1698         struct hermes *hw = &priv->hw;
1699         int err;
1700         unsigned long flags;
1701
1702         if (orinoco_lock(priv, &flags) != 0)
1703                 /* When the hardware becomes available again, whatever
1704                  * detects that is responsible for re-initializing
1705                  * it. So no need for anything further */
1706                 return;
1707
1708         netif_stop_queue(dev);
1709
1710         /* Shut off interrupts.  Depending on what state the hardware
1711          * is in, this might not work, but we'll try anyway */
1712         hermes_set_irqmask(hw, 0);
1713         hermes_write_regn(hw, EVACK, 0xffff);
1714
1715         priv->hw_unavailable++;
1716         priv->last_linkstatus = 0xffff; /* firmware will have to reassociate */
1717         netif_carrier_off(dev);
1718
1719         orinoco_unlock(priv, &flags);
1720
1721         /* Scanning support: Notify scan cancellation */
1722         if (priv->scan_request) {
1723                 cfg80211_scan_done(priv->scan_request, 1);
1724                 priv->scan_request = NULL;
1725         }
1726
1727         if (priv->hard_reset) {
1728                 err = (*priv->hard_reset)(priv);
1729                 if (err) {
1730                         printk(KERN_ERR "%s: orinoco_reset: Error %d "
1731                                "performing hard reset\n", dev->name, err);
1732                         goto disable;
1733                 }
1734         }
1735
1736         err = orinoco_reinit_firmware(priv);
1737         if (err) {
1738                 printk(KERN_ERR "%s: orinoco_reset: Error %d re-initializing firmware\n",
1739                        dev->name, err);
1740                 goto disable;
1741         }
1742
1743         /* This has to be called from user context */
1744         orinoco_lock_irq(priv);
1745
1746         priv->hw_unavailable--;
1747
1748         /* priv->open or priv->hw_unavailable might have changed while
1749          * we dropped the lock */
1750         if (priv->open && (!priv->hw_unavailable)) {
1751                 err = __orinoco_up(priv);
1752                 if (err) {
1753                         printk(KERN_ERR "%s: orinoco_reset: Error %d reenabling card\n",
1754                                dev->name, err);
1755                 } else
1756                         dev->trans_start = jiffies;
1757         }
1758
1759         orinoco_unlock_irq(priv);
1760
1761         return;
1762  disable:
1763         hermes_set_irqmask(hw, 0);
1764         netif_device_detach(dev);
1765         printk(KERN_ERR "%s: Device has been disabled!\n", dev->name);
1766 }
1767
1768 static int __orinoco_commit(struct orinoco_private *priv)
1769 {
1770         struct net_device *dev = priv->ndev;
1771         int err = 0;
1772
1773         err = orinoco_hw_program_rids(priv);
1774
1775         /* FIXME: what about netif_tx_lock */
1776         (void) __orinoco_set_multicast_list(dev);
1777
1778         return err;
1779 }
1780
1781 /* Ensures configuration changes are applied. May result in a reset.
1782  * The caller should hold priv->lock
1783  */
1784 int orinoco_commit(struct orinoco_private *priv)
1785 {
1786         struct net_device *dev = priv->ndev;
1787         hermes_t *hw = &priv->hw;
1788         int err;
1789
1790         if (priv->broken_disableport) {
1791                 schedule_work(&priv->reset_work);
1792                 return 0;
1793         }
1794
1795         err = hermes_disable_port(hw, 0);
1796         if (err) {
1797                 printk(KERN_WARNING "%s: Unable to disable port "
1798                        "while reconfiguring card\n", dev->name);
1799                 priv->broken_disableport = 1;
1800                 goto out;
1801         }
1802
1803         err = __orinoco_commit(priv);
1804         if (err) {
1805                 printk(KERN_WARNING "%s: Unable to reconfigure card\n",
1806                        dev->name);
1807                 goto out;
1808         }
1809
1810         err = hermes_enable_port(hw, 0);
1811         if (err) {
1812                 printk(KERN_WARNING "%s: Unable to enable port while reconfiguring card\n",
1813                        dev->name);
1814                 goto out;
1815         }
1816
1817  out:
1818         if (err) {
1819                 printk(KERN_WARNING "%s: Resetting instead...\n", dev->name);
1820                 schedule_work(&priv->reset_work);
1821                 err = 0;
1822         }
1823         return err;
1824 }
1825
1826 /********************************************************************/
1827 /* Interrupt handler                                                */
1828 /********************************************************************/
1829
1830 static void __orinoco_ev_tick(struct net_device *dev, hermes_t *hw)
1831 {
1832         printk(KERN_DEBUG "%s: TICK\n", dev->name);
1833 }
1834
1835 static void __orinoco_ev_wterr(struct net_device *dev, hermes_t *hw)
1836 {
1837         /* This seems to happen a fair bit under load, but ignoring it
1838            seems to work fine...*/
1839         printk(KERN_DEBUG "%s: MAC controller error (WTERR). Ignoring.\n",
1840                dev->name);
1841 }
1842
1843 irqreturn_t orinoco_interrupt(int irq, void *dev_id)
1844 {
1845         struct orinoco_private *priv = dev_id;
1846         struct net_device *dev = priv->ndev;
1847         hermes_t *hw = &priv->hw;
1848         int count = MAX_IRQLOOPS_PER_IRQ;
1849         u16 evstat, events;
1850         /* These are used to detect a runaway interrupt situation.
1851          *
1852          * If we get more than MAX_IRQLOOPS_PER_JIFFY iterations in a jiffy,
1853          * we panic and shut down the hardware
1854          */
1855         /* jiffies value the last time we were called */
1856         static int last_irq_jiffy; /* = 0 */
1857         static int loops_this_jiffy; /* = 0 */
1858         unsigned long flags;
1859
1860         if (orinoco_lock(priv, &flags) != 0) {
1861                 /* If hw is unavailable - we don't know if the irq was
1862                  * for us or not */
1863                 return IRQ_HANDLED;
1864         }
1865
1866         evstat = hermes_read_regn(hw, EVSTAT);
1867         events = evstat & hw->inten;
1868         if (!events) {
1869                 orinoco_unlock(priv, &flags);
1870                 return IRQ_NONE;
1871         }
1872
1873         if (jiffies != last_irq_jiffy)
1874                 loops_this_jiffy = 0;
1875         last_irq_jiffy = jiffies;
1876
1877         while (events && count--) {
1878                 if (++loops_this_jiffy > MAX_IRQLOOPS_PER_JIFFY) {
1879                         printk(KERN_WARNING "%s: IRQ handler is looping too "
1880                                "much! Resetting.\n", dev->name);
1881                         /* Disable interrupts for now */
1882                         hermes_set_irqmask(hw, 0);
1883                         schedule_work(&priv->reset_work);
1884                         break;
1885                 }
1886
1887                 /* Check the card hasn't been removed */
1888                 if (!hermes_present(hw)) {
1889                         DEBUG(0, "orinoco_interrupt(): card removed\n");
1890                         break;
1891                 }
1892
1893                 if (events & HERMES_EV_TICK)
1894                         __orinoco_ev_tick(dev, hw);
1895                 if (events & HERMES_EV_WTERR)
1896                         __orinoco_ev_wterr(dev, hw);
1897                 if (events & HERMES_EV_INFDROP)
1898                         __orinoco_ev_infdrop(dev, hw);
1899                 if (events & HERMES_EV_INFO)
1900                         __orinoco_ev_info(dev, hw);
1901                 if (events & HERMES_EV_RX)
1902                         __orinoco_ev_rx(dev, hw);
1903                 if (events & HERMES_EV_TXEXC)
1904                         __orinoco_ev_txexc(dev, hw);
1905                 if (events & HERMES_EV_TX)
1906                         __orinoco_ev_tx(dev, hw);
1907                 if (events & HERMES_EV_ALLOC)
1908                         __orinoco_ev_alloc(dev, hw);
1909
1910                 hermes_write_regn(hw, EVACK, evstat);
1911
1912                 evstat = hermes_read_regn(hw, EVSTAT);
1913                 events = evstat & hw->inten;
1914         };
1915
1916         orinoco_unlock(priv, &flags);
1917         return IRQ_HANDLED;
1918 }
1919 EXPORT_SYMBOL(orinoco_interrupt);
1920
1921 /********************************************************************/
1922 /* Power management                                                 */
1923 /********************************************************************/
1924 #if defined(CONFIG_PM_SLEEP) && !defined(CONFIG_HERMES_CACHE_FW_ON_INIT)
1925 static int orinoco_pm_notifier(struct notifier_block *notifier,
1926                                unsigned long pm_event,
1927                                void *unused)
1928 {
1929         struct orinoco_private *priv = container_of(notifier,
1930                                                     struct orinoco_private,
1931                                                     pm_notifier);
1932
1933         /* All we need to do is cache the firmware before suspend, and
1934          * release it when we come out.
1935          *
1936          * Only need to do this if we're downloading firmware. */
1937         if (!priv->do_fw_download)
1938                 return NOTIFY_DONE;
1939
1940         switch (pm_event) {
1941         case PM_HIBERNATION_PREPARE:
1942         case PM_SUSPEND_PREPARE:
1943                 orinoco_cache_fw(priv, 0);
1944                 break;
1945
1946         case PM_POST_RESTORE:
1947                 /* Restore from hibernation failed. We need to clean
1948                  * up in exactly the same way, so fall through. */
1949         case PM_POST_HIBERNATION:
1950         case PM_POST_SUSPEND:
1951                 orinoco_uncache_fw(priv);
1952                 break;
1953
1954         case PM_RESTORE_PREPARE:
1955         default:
1956                 break;
1957         }
1958
1959         return NOTIFY_DONE;
1960 }
1961
1962 static void orinoco_register_pm_notifier(struct orinoco_private *priv)
1963 {
1964         priv->pm_notifier.notifier_call = orinoco_pm_notifier;
1965         register_pm_notifier(&priv->pm_notifier);
1966 }
1967
1968 static void orinoco_unregister_pm_notifier(struct orinoco_private *priv)
1969 {
1970         unregister_pm_notifier(&priv->pm_notifier);
1971 }
1972 #else /* !PM_SLEEP || HERMES_CACHE_FW_ON_INIT */
1973 #define orinoco_register_pm_notifier(priv) do { } while(0)
1974 #define orinoco_unregister_pm_notifier(priv) do { } while(0)
1975 #endif
1976
1977 /********************************************************************/
1978 /* Initialization                                                   */
1979 /********************************************************************/
1980
1981 int orinoco_init(struct orinoco_private *priv)
1982 {
1983         struct device *dev = priv->dev;
1984         struct wiphy *wiphy = priv_to_wiphy(priv);
1985         hermes_t *hw = &priv->hw;
1986         int err = 0;
1987
1988         /* No need to lock, the hw_unavailable flag is already set in
1989          * alloc_orinocodev() */
1990         priv->nicbuf_size = IEEE80211_MAX_FRAME_LEN + ETH_HLEN;
1991
1992         /* Initialize the firmware */
1993         err = hw->ops->init(hw);
1994         if (err != 0) {
1995                 dev_err(dev, "Failed to initialize firmware (err = %d)\n",
1996                         err);
1997                 goto out;
1998         }
1999
2000         err = determine_fw_capabilities(priv, wiphy->fw_version,
2001                                         sizeof(wiphy->fw_version),
2002                                         &wiphy->hw_version);
2003         if (err != 0) {
2004                 dev_err(dev, "Incompatible firmware, aborting\n");
2005                 goto out;
2006         }
2007
2008         if (priv->do_fw_download) {
2009 #ifdef CONFIG_HERMES_CACHE_FW_ON_INIT
2010                 orinoco_cache_fw(priv, 0);
2011 #endif
2012
2013                 err = orinoco_download(priv);
2014                 if (err)
2015                         priv->do_fw_download = 0;
2016
2017                 /* Check firmware version again */
2018                 err = determine_fw_capabilities(priv, wiphy->fw_version,
2019                                                 sizeof(wiphy->fw_version),
2020                                                 &wiphy->hw_version);
2021                 if (err != 0) {
2022                         dev_err(dev, "Incompatible firmware, aborting\n");
2023                         goto out;
2024                 }
2025         }
2026
2027         if (priv->has_port3)
2028                 dev_info(dev, "Ad-hoc demo mode supported\n");
2029         if (priv->has_ibss)
2030                 dev_info(dev, "IEEE standard IBSS ad-hoc mode supported\n");
2031         if (priv->has_wep)
2032                 dev_info(dev, "WEP supported, %s-bit key\n",
2033                          priv->has_big_wep ? "104" : "40");
2034         if (priv->has_wpa) {
2035                 dev_info(dev, "WPA-PSK supported\n");
2036                 if (orinoco_mic_init(priv)) {
2037                         dev_err(dev, "Failed to setup MIC crypto algorithm. "
2038                                 "Disabling WPA support\n");
2039                         priv->has_wpa = 0;
2040                 }
2041         }
2042
2043         err = orinoco_hw_read_card_settings(priv, wiphy->perm_addr);
2044         if (err)
2045                 goto out;
2046
2047         err = orinoco_hw_allocate_fid(priv);
2048         if (err) {
2049                 dev_err(dev, "Failed to allocate NIC buffer!\n");
2050                 goto out;
2051         }
2052
2053         /* Set up the default configuration */
2054         priv->iw_mode = NL80211_IFTYPE_STATION;
2055         /* By default use IEEE/IBSS ad-hoc mode if we have it */
2056         priv->prefer_port3 = priv->has_port3 && (!priv->has_ibss);
2057         set_port_type(priv);
2058         priv->channel = 0; /* use firmware default */
2059
2060         priv->promiscuous = 0;
2061         priv->encode_alg = ORINOCO_ALG_NONE;
2062         priv->tx_key = 0;
2063         priv->wpa_enabled = 0;
2064         priv->tkip_cm_active = 0;
2065         priv->key_mgmt = 0;
2066         priv->wpa_ie_len = 0;
2067         priv->wpa_ie = NULL;
2068
2069         if (orinoco_wiphy_register(wiphy)) {
2070                 err = -ENODEV;
2071                 goto out;
2072         }
2073
2074         /* Make the hardware available, as long as it hasn't been
2075          * removed elsewhere (e.g. by PCMCIA hot unplug) */
2076         orinoco_lock_irq(priv);
2077         priv->hw_unavailable--;
2078         orinoco_unlock_irq(priv);
2079
2080         dev_dbg(dev, "Ready\n");
2081
2082  out:
2083         return err;
2084 }
2085 EXPORT_SYMBOL(orinoco_init);
2086
2087 static const struct net_device_ops orinoco_netdev_ops = {
2088         .ndo_open               = orinoco_open,
2089         .ndo_stop               = orinoco_stop,
2090         .ndo_start_xmit         = orinoco_xmit,
2091         .ndo_set_multicast_list = orinoco_set_multicast_list,
2092         .ndo_change_mtu         = orinoco_change_mtu,
2093         .ndo_set_mac_address    = eth_mac_addr,
2094         .ndo_validate_addr      = eth_validate_addr,
2095         .ndo_tx_timeout         = orinoco_tx_timeout,
2096         .ndo_get_stats          = orinoco_get_stats,
2097 };
2098
2099 /* Allocate private data.
2100  *
2101  * This driver has a number of structures associated with it
2102  *  netdev - Net device structure for each network interface
2103  *  wiphy - structure associated with wireless phy
2104  *  wireless_dev (wdev) - structure for each wireless interface
2105  *  hw - structure for hermes chip info
2106  *  card - card specific structure for use by the card driver
2107  *         (airport, orinoco_cs)
2108  *  priv - orinoco private data
2109  *  device - generic linux device structure
2110  *
2111  *  +---------+    +---------+
2112  *  |  wiphy  |    | netdev  |
2113  *  | +-------+    | +-------+
2114  *  | | priv  |    | | wdev  |
2115  *  | | +-----+    +-+-------+
2116  *  | | | hw  |
2117  *  | +-+-----+
2118  *  | | card  |
2119  *  +-+-------+
2120  *
2121  * priv has a link to netdev and device
2122  * wdev has a link to wiphy
2123  */
2124 struct orinoco_private
2125 *alloc_orinocodev(int sizeof_card,
2126                   struct device *device,
2127                   int (*hard_reset)(struct orinoco_private *),
2128                   int (*stop_fw)(struct orinoco_private *, int))
2129 {
2130         struct orinoco_private *priv;
2131         struct wiphy *wiphy;
2132
2133         /* allocate wiphy
2134          * NOTE: We only support a single virtual interface
2135          *       but this may change when monitor mode is added
2136          */
2137         wiphy = wiphy_new(&orinoco_cfg_ops,
2138                           sizeof(struct orinoco_private) + sizeof_card);
2139         if (!wiphy)
2140                 return NULL;
2141
2142         priv = wiphy_priv(wiphy);
2143         priv->dev = device;
2144
2145         if (sizeof_card)
2146                 priv->card = (void *)((unsigned long)priv
2147                                       + sizeof(struct orinoco_private));
2148         else
2149                 priv->card = NULL;
2150
2151         orinoco_wiphy_init(wiphy);
2152
2153 #ifdef WIRELESS_SPY
2154         priv->wireless_data.spy_data = &priv->spy_data;
2155 #endif
2156
2157         /* Set up default callbacks */
2158         priv->hard_reset = hard_reset;
2159         priv->stop_fw = stop_fw;
2160
2161         spin_lock_init(&priv->lock);
2162         priv->open = 0;
2163         priv->hw_unavailable = 1; /* orinoco_init() must clear this
2164                                    * before anything else touches the
2165                                    * hardware */
2166         INIT_WORK(&priv->reset_work, orinoco_reset);
2167         INIT_WORK(&priv->join_work, orinoco_join_ap);
2168         INIT_WORK(&priv->wevent_work, orinoco_send_wevents);
2169
2170         INIT_LIST_HEAD(&priv->rx_list);
2171         tasklet_init(&priv->rx_tasklet, orinoco_rx_isr_tasklet,
2172                      (unsigned long) priv);
2173
2174         spin_lock_init(&priv->scan_lock);
2175         INIT_LIST_HEAD(&priv->scan_list);
2176         INIT_WORK(&priv->process_scan, orinoco_process_scan_results);
2177
2178         priv->last_linkstatus = 0xffff;
2179
2180 #if defined(CONFIG_HERMES_CACHE_FW_ON_INIT) || defined(CONFIG_PM_SLEEP)
2181         priv->cached_pri_fw = NULL;
2182         priv->cached_fw = NULL;
2183 #endif
2184
2185         /* Register PM notifiers */
2186         orinoco_register_pm_notifier(priv);
2187
2188         return priv;
2189 }
2190 EXPORT_SYMBOL(alloc_orinocodev);
2191
2192 /* We can only support a single interface. We provide a separate
2193  * function to set it up to distinguish between hardware
2194  * initialisation and interface setup.
2195  *
2196  * The base_addr and irq parameters are passed on to netdev for use
2197  * with SIOCGIFMAP.
2198  */
2199 int orinoco_if_add(struct orinoco_private *priv,
2200                    unsigned long base_addr,
2201                    unsigned int irq,
2202                    const struct net_device_ops *ops)
2203 {
2204         struct wiphy *wiphy = priv_to_wiphy(priv);
2205         struct wireless_dev *wdev;
2206         struct net_device *dev;
2207         int ret;
2208
2209         dev = alloc_etherdev(sizeof(struct wireless_dev));
2210
2211         if (!dev)
2212                 return -ENOMEM;
2213
2214         /* Initialise wireless_dev */
2215         wdev = netdev_priv(dev);
2216         wdev->wiphy = wiphy;
2217         wdev->iftype = NL80211_IFTYPE_STATION;
2218
2219         /* Setup / override net_device fields */
2220         dev->ieee80211_ptr = wdev;
2221         dev->watchdog_timeo = HZ; /* 1 second timeout */
2222         dev->wireless_handlers = &orinoco_handler_def;
2223 #ifdef WIRELESS_SPY
2224         dev->wireless_data = &priv->wireless_data;
2225 #endif
2226         /* Default to standard ops if not set */
2227         if (ops)
2228                 dev->netdev_ops = ops;
2229         else
2230                 dev->netdev_ops = &orinoco_netdev_ops;
2231
2232         /* we use the default eth_mac_addr for setting the MAC addr */
2233
2234         /* Reserve space in skb for the SNAP header */
2235         dev->hard_header_len += ENCAPS_OVERHEAD;
2236
2237         netif_carrier_off(dev);
2238
2239         memcpy(dev->dev_addr, wiphy->perm_addr, ETH_ALEN);
2240         memcpy(dev->perm_addr, wiphy->perm_addr, ETH_ALEN);
2241
2242         dev->base_addr = base_addr;
2243         dev->irq = irq;
2244
2245         SET_NETDEV_DEV(dev, priv->dev);
2246         ret = register_netdev(dev);
2247         if (ret)
2248                 goto fail;
2249
2250         priv->ndev = dev;
2251
2252         /* Report what we've done */
2253         dev_dbg(priv->dev, "Registerred interface %s.\n", dev->name);
2254
2255         return 0;
2256
2257  fail:
2258         free_netdev(dev);
2259         return ret;
2260 }
2261 EXPORT_SYMBOL(orinoco_if_add);
2262
2263 void orinoco_if_del(struct orinoco_private *priv)
2264 {
2265         struct net_device *dev = priv->ndev;
2266
2267         unregister_netdev(dev);
2268         free_netdev(dev);
2269 }
2270 EXPORT_SYMBOL(orinoco_if_del);
2271
2272 void free_orinocodev(struct orinoco_private *priv)
2273 {
2274         struct wiphy *wiphy = priv_to_wiphy(priv);
2275         struct orinoco_rx_data *rx_data, *temp;
2276         struct orinoco_scan_data *sd, *sdtemp;
2277
2278         wiphy_unregister(wiphy);
2279
2280         /* If the tasklet is scheduled when we call tasklet_kill it
2281          * will run one final time. However the tasklet will only
2282          * drain priv->rx_list if the hw is still available. */
2283         tasklet_kill(&priv->rx_tasklet);
2284
2285         /* Explicitly drain priv->rx_list */
2286         list_for_each_entry_safe(rx_data, temp, &priv->rx_list, list) {
2287                 list_del(&rx_data->list);
2288
2289                 dev_kfree_skb(rx_data->skb);
2290                 kfree(rx_data->desc);
2291                 kfree(rx_data);
2292         }
2293
2294         cancel_work_sync(&priv->process_scan);
2295         /* Explicitly drain priv->scan_list */
2296         list_for_each_entry_safe(sd, sdtemp, &priv->scan_list, list) {
2297                 list_del(&sd->list);
2298
2299                 if ((sd->len > 0) && sd->buf)
2300                         kfree(sd->buf);
2301                 kfree(sd);
2302         }
2303
2304         orinoco_unregister_pm_notifier(priv);
2305         orinoco_uncache_fw(priv);
2306
2307         priv->wpa_ie_len = 0;
2308         kfree(priv->wpa_ie);
2309         orinoco_mic_free(priv);
2310         wiphy_free(wiphy);
2311 }
2312 EXPORT_SYMBOL(free_orinocodev);
2313
2314 int orinoco_up(struct orinoco_private *priv)
2315 {
2316         struct net_device *dev = priv->ndev;
2317         unsigned long flags;
2318         int err;
2319
2320         priv->hw.ops->lock_irqsave(&priv->lock, &flags);
2321
2322         err = orinoco_reinit_firmware(priv);
2323         if (err) {
2324                 printk(KERN_ERR "%s: Error %d re-initializing firmware\n",
2325                        dev->name, err);
2326                 goto exit;
2327         }
2328
2329         netif_device_attach(dev);
2330         priv->hw_unavailable--;
2331
2332         if (priv->open && !priv->hw_unavailable) {
2333                 err = __orinoco_up(priv);
2334                 if (err)
2335                         printk(KERN_ERR "%s: Error %d restarting card\n",
2336                                dev->name, err);
2337         }
2338
2339 exit:
2340         priv->hw.ops->unlock_irqrestore(&priv->lock, &flags);
2341
2342         return 0;
2343 }
2344 EXPORT_SYMBOL(orinoco_up);
2345
2346 void orinoco_down(struct orinoco_private *priv)
2347 {
2348         struct net_device *dev = priv->ndev;
2349         unsigned long flags;
2350         int err;
2351
2352         priv->hw.ops->lock_irqsave(&priv->lock, &flags);
2353         err = __orinoco_down(priv);
2354         if (err)
2355                 printk(KERN_WARNING "%s: Error %d downing interface\n",
2356                        dev->name, err);
2357
2358         netif_device_detach(dev);
2359         priv->hw_unavailable++;
2360         priv->hw.ops->unlock_irqrestore(&priv->lock, &flags);
2361 }
2362 EXPORT_SYMBOL(orinoco_down);
2363
2364 /********************************************************************/
2365 /* Module initialization                                            */
2366 /********************************************************************/
2367
2368 /* Can't be declared "const" or the whole __initdata section will
2369  * become const */
2370 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
2371         " (David Gibson <hermes@gibson.dropbear.id.au>, "
2372         "Pavel Roskin <proski@gnu.org>, et al)";
2373
2374 static int __init init_orinoco(void)
2375 {
2376         printk(KERN_DEBUG "%s\n", version);
2377         return 0;
2378 }
2379
2380 static void __exit exit_orinoco(void)
2381 {
2382 }
2383
2384 module_init(init_orinoco);
2385 module_exit(exit_orinoco);