Merge master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6.git] / drivers / net / wireless / orinoco.c
1 /* orinoco.c - (formerly known as dldwd_cs.c and orinoco_cs.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/config.h>
80 #include <linux/module.h>
81 #include <linux/kernel.h>
82 #include <linux/init.h>
83 #include <linux/netdevice.h>
84 #include <linux/etherdevice.h>
85 #include <linux/ethtool.h>
86 #include <linux/wireless.h>
87 #include <net/iw_handler.h>
88 #include <net/ieee80211.h>
89
90 #include "hermes_rid.h"
91 #include "orinoco.h"
92
93 /********************************************************************/
94 /* Module information                                               */
95 /********************************************************************/
96
97 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org> & David Gibson <hermes@gibson.dropbear.id.au>");
98 MODULE_DESCRIPTION("Driver for Lucent Orinoco, Prism II based and similar wireless cards");
99 MODULE_LICENSE("Dual MPL/GPL");
100
101 /* Level of debugging. Used in the macros in orinoco.h */
102 #ifdef ORINOCO_DEBUG
103 int orinoco_debug = ORINOCO_DEBUG;
104 module_param(orinoco_debug, int, 0644);
105 MODULE_PARM_DESC(orinoco_debug, "Debug level");
106 EXPORT_SYMBOL(orinoco_debug);
107 #endif
108
109 static int suppress_linkstatus; /* = 0 */
110 module_param(suppress_linkstatus, bool, 0644);
111 MODULE_PARM_DESC(suppress_linkstatus, "Don't log link status changes");
112 static int ignore_disconnect; /* = 0 */
113 module_param(ignore_disconnect, int, 0644);
114 MODULE_PARM_DESC(ignore_disconnect, "Don't report lost link to the network layer");
115
116 static int force_monitor; /* = 0 */
117 module_param(force_monitor, int, 0644);
118 MODULE_PARM_DESC(force_monitor, "Allow monitor mode for all firmware versions");
119
120 /********************************************************************/
121 /* Compile time configuration and compatibility stuff               */
122 /********************************************************************/
123
124 /* We do this this way to avoid ifdefs in the actual code */
125 #ifdef WIRELESS_SPY
126 #define SPY_NUMBER(priv)        (priv->spy_data.spy_number)
127 #else
128 #define SPY_NUMBER(priv)        0
129 #endif /* WIRELESS_SPY */
130
131 /********************************************************************/
132 /* Internal constants                                               */
133 /********************************************************************/
134
135 /* 802.2 LLC/SNAP header used for Ethernet encapsulation over 802.11 */
136 static const u8 encaps_hdr[] = {0xaa, 0xaa, 0x03, 0x00, 0x00, 0x00};
137 #define ENCAPS_OVERHEAD         (sizeof(encaps_hdr) + 2)
138
139 #define ORINOCO_MIN_MTU         256
140 #define ORINOCO_MAX_MTU         (IEEE80211_DATA_LEN - ENCAPS_OVERHEAD)
141
142 #define SYMBOL_MAX_VER_LEN      (14)
143 #define USER_BAP                0
144 #define IRQ_BAP                 1
145 #define MAX_IRQLOOPS_PER_IRQ    10
146 #define MAX_IRQLOOPS_PER_JIFFY  (20000/HZ) /* Based on a guestimate of
147                                             * how many events the
148                                             * device could
149                                             * legitimately generate */
150 #define SMALL_KEY_SIZE          5
151 #define LARGE_KEY_SIZE          13
152 #define TX_NICBUF_SIZE_BUG      1585            /* Bug in Symbol firmware */
153
154 #define DUMMY_FID               0xFFFF
155
156 /*#define MAX_MULTICAST(priv)   (priv->firmware_type == FIRMWARE_TYPE_AGERE ? \
157   HERMES_MAX_MULTICAST : 0)*/
158 #define MAX_MULTICAST(priv)     (HERMES_MAX_MULTICAST)
159
160 #define ORINOCO_INTEN           (HERMES_EV_RX | HERMES_EV_ALLOC \
161                                  | HERMES_EV_TX | HERMES_EV_TXEXC \
162                                  | HERMES_EV_WTERR | HERMES_EV_INFO \
163                                  | HERMES_EV_INFDROP )
164
165 #define MAX_RID_LEN 1024
166
167 static const struct iw_handler_def orinoco_handler_def;
168 static struct ethtool_ops orinoco_ethtool_ops;
169
170 /********************************************************************/
171 /* Data tables                                                      */
172 /********************************************************************/
173
174 /* The frequency of each channel in MHz */
175 static const long channel_frequency[] = {
176         2412, 2417, 2422, 2427, 2432, 2437, 2442,
177         2447, 2452, 2457, 2462, 2467, 2472, 2484
178 };
179 #define NUM_CHANNELS ARRAY_SIZE(channel_frequency)
180
181 /* This tables gives the actual meanings of the bitrate IDs returned
182  * by the firmware. */
183 static struct {
184         int bitrate; /* in 100s of kilobits */
185         int automatic;
186         u16 agere_txratectrl;
187         u16 intersil_txratectrl;
188 } bitrate_table[] = {
189         {110, 1,  3, 15}, /* Entry 0 is the default */
190         {10,  0,  1,  1},
191         {10,  1,  1,  1},
192         {20,  0,  2,  2},
193         {20,  1,  6,  3},
194         {55,  0,  4,  4},
195         {55,  1,  7,  7},
196         {110, 0,  5,  8},
197 };
198 #define BITRATE_TABLE_SIZE ARRAY_SIZE(bitrate_table)
199
200 /********************************************************************/
201 /* Data types                                                       */
202 /********************************************************************/
203
204 /* Beginning of the Tx descriptor, used in TxExc handling */
205 struct hermes_txexc_data {
206         struct hermes_tx_descriptor desc;
207         __le16 frame_ctl;
208         __le16 duration_id;
209         u8 addr1[ETH_ALEN];
210 } __attribute__ ((packed));
211
212 /* Rx frame header except compatibility 802.3 header */
213 struct hermes_rx_descriptor {
214         /* Control */
215         __le16 status;
216         __le32 time;
217         u8 silence;
218         u8 signal;
219         u8 rate;
220         u8 rxflow;
221         __le32 reserved;
222
223         /* 802.11 header */
224         __le16 frame_ctl;
225         __le16 duration_id;
226         u8 addr1[ETH_ALEN];
227         u8 addr2[ETH_ALEN];
228         u8 addr3[ETH_ALEN];
229         __le16 seq_ctl;
230         u8 addr4[ETH_ALEN];
231
232         /* Data length */
233         __le16 data_len;
234 } __attribute__ ((packed));
235
236 /********************************************************************/
237 /* Function prototypes                                              */
238 /********************************************************************/
239
240 static int __orinoco_program_rids(struct net_device *dev);
241 static void __orinoco_set_multicast_list(struct net_device *dev);
242
243 /********************************************************************/
244 /* Internal helper functions                                        */
245 /********************************************************************/
246
247 static inline void set_port_type(struct orinoco_private *priv)
248 {
249         switch (priv->iw_mode) {
250         case IW_MODE_INFRA:
251                 priv->port_type = 1;
252                 priv->createibss = 0;
253                 break;
254         case IW_MODE_ADHOC:
255                 if (priv->prefer_port3) {
256                         priv->port_type = 3;
257                         priv->createibss = 0;
258                 } else {
259                         priv->port_type = priv->ibss_port;
260                         priv->createibss = 1;
261                 }
262                 break;
263         case IW_MODE_MONITOR:
264                 priv->port_type = 3;
265                 priv->createibss = 0;
266                 break;
267         default:
268                 printk(KERN_ERR "%s: Invalid priv->iw_mode in set_port_type()\n",
269                        priv->ndev->name);
270         }
271 }
272
273 /********************************************************************/
274 /* Device methods                                                   */
275 /********************************************************************/
276
277 static int orinoco_open(struct net_device *dev)
278 {
279         struct orinoco_private *priv = netdev_priv(dev);
280         unsigned long flags;
281         int err;
282
283         if (orinoco_lock(priv, &flags) != 0)
284                 return -EBUSY;
285
286         err = __orinoco_up(dev);
287
288         if (! err)
289                 priv->open = 1;
290
291         orinoco_unlock(priv, &flags);
292
293         return err;
294 }
295
296 static int orinoco_stop(struct net_device *dev)
297 {
298         struct orinoco_private *priv = netdev_priv(dev);
299         int err = 0;
300
301         /* We mustn't use orinoco_lock() here, because we need to be
302            able to close the interface even if hw_unavailable is set
303            (e.g. as we're released after a PC Card removal) */
304         spin_lock_irq(&priv->lock);
305
306         priv->open = 0;
307
308         err = __orinoco_down(dev);
309
310         spin_unlock_irq(&priv->lock);
311
312         return err;
313 }
314
315 static struct net_device_stats *orinoco_get_stats(struct net_device *dev)
316 {
317         struct orinoco_private *priv = netdev_priv(dev);
318         
319         return &priv->stats;
320 }
321
322 static struct iw_statistics *orinoco_get_wireless_stats(struct net_device *dev)
323 {
324         struct orinoco_private *priv = netdev_priv(dev);
325         hermes_t *hw = &priv->hw;
326         struct iw_statistics *wstats = &priv->wstats;
327         int err;
328         unsigned long flags;
329
330         if (! netif_device_present(dev)) {
331                 printk(KERN_WARNING "%s: get_wireless_stats() called while device not present\n",
332                        dev->name);
333                 return NULL; /* FIXME: Can we do better than this? */
334         }
335
336         /* If busy, return the old stats.  Returning NULL may cause
337          * the interface to disappear from /proc/net/wireless */
338         if (orinoco_lock(priv, &flags) != 0)
339                 return wstats;
340
341         /* We can't really wait for the tallies inquiry command to
342          * complete, so we just use the previous results and trigger
343          * a new tallies inquiry command for next time - Jean II */
344         /* FIXME: Really we should wait for the inquiry to come back -
345          * as it is the stats we give don't make a whole lot of sense.
346          * Unfortunately, it's not clear how to do that within the
347          * wireless extensions framework: I think we're in user
348          * context, but a lock seems to be held by the time we get in
349          * here so we're not safe to sleep here. */
350         hermes_inquire(hw, HERMES_INQ_TALLIES);
351
352         if (priv->iw_mode == IW_MODE_ADHOC) {
353                 memset(&wstats->qual, 0, sizeof(wstats->qual));
354                 /* If a spy address is defined, we report stats of the
355                  * first spy address - Jean II */
356                 if (SPY_NUMBER(priv)) {
357                         wstats->qual.qual = priv->spy_data.spy_stat[0].qual;
358                         wstats->qual.level = priv->spy_data.spy_stat[0].level;
359                         wstats->qual.noise = priv->spy_data.spy_stat[0].noise;
360                         wstats->qual.updated = priv->spy_data.spy_stat[0].updated;
361                 }
362         } else {
363                 struct {
364                         __le16 qual, signal, noise, unused;
365                 } __attribute__ ((packed)) cq;
366
367                 err = HERMES_READ_RECORD(hw, USER_BAP,
368                                          HERMES_RID_COMMSQUALITY, &cq);
369
370                 if (!err) {
371                         wstats->qual.qual = (int)le16_to_cpu(cq.qual);
372                         wstats->qual.level = (int)le16_to_cpu(cq.signal) - 0x95;
373                         wstats->qual.noise = (int)le16_to_cpu(cq.noise) - 0x95;
374                         wstats->qual.updated = 7;
375                 }
376         }
377
378         orinoco_unlock(priv, &flags);
379         return wstats;
380 }
381
382 static void orinoco_set_multicast_list(struct net_device *dev)
383 {
384         struct orinoco_private *priv = netdev_priv(dev);
385         unsigned long flags;
386
387         if (orinoco_lock(priv, &flags) != 0) {
388                 printk(KERN_DEBUG "%s: orinoco_set_multicast_list() "
389                        "called when hw_unavailable\n", dev->name);
390                 return;
391         }
392
393         __orinoco_set_multicast_list(dev);
394         orinoco_unlock(priv, &flags);
395 }
396
397 static int orinoco_change_mtu(struct net_device *dev, int new_mtu)
398 {
399         struct orinoco_private *priv = netdev_priv(dev);
400
401         if ( (new_mtu < ORINOCO_MIN_MTU) || (new_mtu > ORINOCO_MAX_MTU) )
402                 return -EINVAL;
403
404         if ( (new_mtu + ENCAPS_OVERHEAD + IEEE80211_HLEN) >
405              (priv->nicbuf_size - ETH_HLEN) )
406                 return -EINVAL;
407
408         dev->mtu = new_mtu;
409
410         return 0;
411 }
412
413 /********************************************************************/
414 /* Tx path                                                          */
415 /********************************************************************/
416
417 static int orinoco_xmit(struct sk_buff *skb, struct net_device *dev)
418 {
419         struct orinoco_private *priv = netdev_priv(dev);
420         struct net_device_stats *stats = &priv->stats;
421         hermes_t *hw = &priv->hw;
422         int err = 0;
423         u16 txfid = priv->txfid;
424         struct ethhdr *eh;
425         int data_off;
426         struct hermes_tx_descriptor desc;
427         unsigned long flags;
428
429         if (! netif_running(dev)) {
430                 printk(KERN_ERR "%s: Tx on stopped device!\n",
431                        dev->name);
432                 return NETDEV_TX_BUSY;
433         }
434         
435         if (netif_queue_stopped(dev)) {
436                 printk(KERN_DEBUG "%s: Tx while transmitter busy!\n", 
437                        dev->name);
438                 return NETDEV_TX_BUSY;
439         }
440         
441         if (orinoco_lock(priv, &flags) != 0) {
442                 printk(KERN_ERR "%s: orinoco_xmit() called while hw_unavailable\n",
443                        dev->name);
444                 return NETDEV_TX_BUSY;
445         }
446
447         if (! netif_carrier_ok(dev) || (priv->iw_mode == IW_MODE_MONITOR)) {
448                 /* Oops, the firmware hasn't established a connection,
449                    silently drop the packet (this seems to be the
450                    safest approach). */
451                 goto drop;
452         }
453
454         /* Check packet length */
455         if (skb->len < ETH_HLEN)
456                 goto drop;
457
458         eh = (struct ethhdr *)skb->data;
459
460         memset(&desc, 0, sizeof(desc));
461         desc.tx_control = cpu_to_le16(HERMES_TXCTRL_TX_OK | HERMES_TXCTRL_TX_EX);
462         err = hermes_bap_pwrite(hw, USER_BAP, &desc, sizeof(desc), txfid, 0);
463         if (err) {
464                 if (net_ratelimit())
465                         printk(KERN_ERR "%s: Error %d writing Tx descriptor "
466                                "to BAP\n", dev->name, err);
467                 goto busy;
468         }
469
470         /* Clear the 802.11 header and data length fields - some
471          * firmwares (e.g. Lucent/Agere 8.xx) appear to get confused
472          * if this isn't done. */
473         hermes_clear_words(hw, HERMES_DATA0,
474                            HERMES_802_3_OFFSET - HERMES_802_11_OFFSET);
475
476         /* Encapsulate Ethernet-II frames */
477         if (ntohs(eh->h_proto) > ETH_DATA_LEN) { /* Ethernet-II frame */
478                 struct header_struct {
479                         struct ethhdr eth;      /* 802.3 header */
480                         u8 encap[6];            /* 802.2 header */
481                 } __attribute__ ((packed)) hdr;
482
483                 /* Strip destination and source from the data */
484                 skb_pull(skb, 2 * ETH_ALEN);
485                 data_off = HERMES_802_2_OFFSET + sizeof(encaps_hdr);
486
487                 /* And move them to a separate header */
488                 memcpy(&hdr.eth, eh, 2 * ETH_ALEN);
489                 hdr.eth.h_proto = htons(sizeof(encaps_hdr) + skb->len);
490                 memcpy(hdr.encap, encaps_hdr, sizeof(encaps_hdr));
491
492                 err = hermes_bap_pwrite(hw, USER_BAP, &hdr, sizeof(hdr),
493                                         txfid, HERMES_802_3_OFFSET);
494                 if (err) {
495                         if (net_ratelimit())
496                                 printk(KERN_ERR "%s: Error %d writing packet "
497                                        "header to BAP\n", dev->name, err);
498                         goto busy;
499                 }
500         } else { /* IEEE 802.3 frame */
501                 data_off = HERMES_802_3_OFFSET;
502         }
503
504         err = hermes_bap_pwrite(hw, USER_BAP, skb->data, skb->len,
505                                 txfid, data_off);
506         if (err) {
507                 printk(KERN_ERR "%s: Error %d writing packet to BAP\n",
508                        dev->name, err);
509                 goto busy;
510         }
511
512         /* Finally, we actually initiate the send */
513         netif_stop_queue(dev);
514
515         err = hermes_docmd_wait(hw, HERMES_CMD_TX | HERMES_CMD_RECL,
516                                 txfid, NULL);
517         if (err) {
518                 netif_start_queue(dev);
519                 if (net_ratelimit())
520                         printk(KERN_ERR "%s: Error %d transmitting packet\n",
521                                 dev->name, err);
522                 goto busy;
523         }
524
525         dev->trans_start = jiffies;
526         stats->tx_bytes += data_off + skb->len;
527         goto ok;
528
529  drop:
530         stats->tx_errors++;
531         stats->tx_dropped++;
532
533  ok:
534         orinoco_unlock(priv, &flags);
535         dev_kfree_skb(skb);
536         return NETDEV_TX_OK;
537
538  busy:
539         if (err == -EIO)
540                 schedule_work(&priv->reset_work);
541         orinoco_unlock(priv, &flags);
542         return NETDEV_TX_BUSY;
543 }
544
545 static void __orinoco_ev_alloc(struct net_device *dev, hermes_t *hw)
546 {
547         struct orinoco_private *priv = netdev_priv(dev);
548         u16 fid = hermes_read_regn(hw, ALLOCFID);
549
550         if (fid != priv->txfid) {
551                 if (fid != DUMMY_FID)
552                         printk(KERN_WARNING "%s: Allocate event on unexpected fid (%04X)\n",
553                                dev->name, fid);
554                 return;
555         }
556
557         hermes_write_regn(hw, ALLOCFID, DUMMY_FID);
558 }
559
560 static void __orinoco_ev_tx(struct net_device *dev, hermes_t *hw)
561 {
562         struct orinoco_private *priv = netdev_priv(dev);
563         struct net_device_stats *stats = &priv->stats;
564
565         stats->tx_packets++;
566
567         netif_wake_queue(dev);
568
569         hermes_write_regn(hw, TXCOMPLFID, DUMMY_FID);
570 }
571
572 static void __orinoco_ev_txexc(struct net_device *dev, hermes_t *hw)
573 {
574         struct orinoco_private *priv = netdev_priv(dev);
575         struct net_device_stats *stats = &priv->stats;
576         u16 fid = hermes_read_regn(hw, TXCOMPLFID);
577         u16 status;
578         struct hermes_txexc_data hdr;
579         int err = 0;
580
581         if (fid == DUMMY_FID)
582                 return; /* Nothing's really happened */
583
584         /* Read part of the frame header - we need status and addr1 */
585         err = hermes_bap_pread(hw, IRQ_BAP, &hdr,
586                                sizeof(struct hermes_txexc_data),
587                                fid, 0);
588
589         hermes_write_regn(hw, TXCOMPLFID, DUMMY_FID);
590         stats->tx_errors++;
591
592         if (err) {
593                 printk(KERN_WARNING "%s: Unable to read descriptor on Tx error "
594                        "(FID=%04X error %d)\n",
595                        dev->name, fid, err);
596                 return;
597         }
598         
599         DEBUG(1, "%s: Tx error, err %d (FID=%04X)\n", dev->name,
600               err, fid);
601     
602         /* We produce a TXDROP event only for retry or lifetime
603          * exceeded, because that's the only status that really mean
604          * that this particular node went away.
605          * Other errors means that *we* screwed up. - Jean II */
606         status = le16_to_cpu(hdr.desc.status);
607         if (status & (HERMES_TXSTAT_RETRYERR | HERMES_TXSTAT_AGEDERR)) {
608                 union iwreq_data        wrqu;
609
610                 /* Copy 802.11 dest address.
611                  * We use the 802.11 header because the frame may
612                  * not be 802.3 or may be mangled...
613                  * In Ad-Hoc mode, it will be the node address.
614                  * In managed mode, it will be most likely the AP addr
615                  * User space will figure out how to convert it to
616                  * whatever it needs (IP address or else).
617                  * - Jean II */
618                 memcpy(wrqu.addr.sa_data, hdr.addr1, ETH_ALEN);
619                 wrqu.addr.sa_family = ARPHRD_ETHER;
620
621                 /* Send event to user space */
622                 wireless_send_event(dev, IWEVTXDROP, &wrqu, NULL);
623         }
624
625         netif_wake_queue(dev);
626 }
627
628 static void orinoco_tx_timeout(struct net_device *dev)
629 {
630         struct orinoco_private *priv = netdev_priv(dev);
631         struct net_device_stats *stats = &priv->stats;
632         struct hermes *hw = &priv->hw;
633
634         printk(KERN_WARNING "%s: Tx timeout! "
635                "ALLOCFID=%04x, TXCOMPLFID=%04x, EVSTAT=%04x\n",
636                dev->name, hermes_read_regn(hw, ALLOCFID),
637                hermes_read_regn(hw, TXCOMPLFID), hermes_read_regn(hw, EVSTAT));
638
639         stats->tx_errors++;
640
641         schedule_work(&priv->reset_work);
642 }
643
644 /********************************************************************/
645 /* Rx path (data frames)                                            */
646 /********************************************************************/
647
648 /* Does the frame have a SNAP header indicating it should be
649  * de-encapsulated to Ethernet-II? */
650 static inline int is_ethersnap(void *_hdr)
651 {
652         u8 *hdr = _hdr;
653
654         /* We de-encapsulate all packets which, a) have SNAP headers
655          * (i.e. SSAP=DSAP=0xaa and CTRL=0x3 in the 802.2 LLC header
656          * and where b) the OUI of the SNAP header is 00:00:00 or
657          * 00:00:f8 - we need both because different APs appear to use
658          * different OUIs for some reason */
659         return (memcmp(hdr, &encaps_hdr, 5) == 0)
660                 && ( (hdr[5] == 0x00) || (hdr[5] == 0xf8) );
661 }
662
663 static inline void orinoco_spy_gather(struct net_device *dev, u_char *mac,
664                                       int level, int noise)
665 {
666         struct iw_quality wstats;
667         wstats.level = level - 0x95;
668         wstats.noise = noise - 0x95;
669         wstats.qual = (level > noise) ? (level - noise) : 0;
670         wstats.updated = 7;
671         /* Update spy records */
672         wireless_spy_update(dev, mac, &wstats);
673 }
674
675 static void orinoco_stat_gather(struct net_device *dev,
676                                 struct sk_buff *skb,
677                                 struct hermes_rx_descriptor *desc)
678 {
679         struct orinoco_private *priv = netdev_priv(dev);
680
681         /* Using spy support with lots of Rx packets, like in an
682          * infrastructure (AP), will really slow down everything, because
683          * the MAC address must be compared to each entry of the spy list.
684          * If the user really asks for it (set some address in the
685          * spy list), we do it, but he will pay the price.
686          * Note that to get here, you need both WIRELESS_SPY
687          * compiled in AND some addresses in the list !!!
688          */
689         /* Note : gcc will optimise the whole section away if
690          * WIRELESS_SPY is not defined... - Jean II */
691         if (SPY_NUMBER(priv)) {
692                 orinoco_spy_gather(dev, skb->mac.raw + ETH_ALEN,
693                                    desc->signal, desc->silence);
694         }
695 }
696
697 /*
698  * orinoco_rx_monitor - handle received monitor frames.
699  *
700  * Arguments:
701  *      dev             network device
702  *      rxfid           received FID
703  *      desc            rx descriptor of the frame
704  *
705  * Call context: interrupt
706  */
707 static void orinoco_rx_monitor(struct net_device *dev, u16 rxfid,
708                                struct hermes_rx_descriptor *desc)
709 {
710         u32 hdrlen = 30;        /* return full header by default */
711         u32 datalen = 0;
712         u16 fc;
713         int err;
714         int len;
715         struct sk_buff *skb;
716         struct orinoco_private *priv = netdev_priv(dev);
717         struct net_device_stats *stats = &priv->stats;
718         hermes_t *hw = &priv->hw;
719
720         len = le16_to_cpu(desc->data_len);
721
722         /* Determine the size of the header and the data */
723         fc = le16_to_cpu(desc->frame_ctl);
724         switch (fc & IEEE80211_FCTL_FTYPE) {
725         case IEEE80211_FTYPE_DATA:
726                 if ((fc & IEEE80211_FCTL_TODS)
727                     && (fc & IEEE80211_FCTL_FROMDS))
728                         hdrlen = 30;
729                 else
730                         hdrlen = 24;
731                 datalen = len;
732                 break;
733         case IEEE80211_FTYPE_MGMT:
734                 hdrlen = 24;
735                 datalen = len;
736                 break;
737         case IEEE80211_FTYPE_CTL:
738                 switch (fc & IEEE80211_FCTL_STYPE) {
739                 case IEEE80211_STYPE_PSPOLL:
740                 case IEEE80211_STYPE_RTS:
741                 case IEEE80211_STYPE_CFEND:
742                 case IEEE80211_STYPE_CFENDACK:
743                         hdrlen = 16;
744                         break;
745                 case IEEE80211_STYPE_CTS:
746                 case IEEE80211_STYPE_ACK:
747                         hdrlen = 10;
748                         break;
749                 }
750                 break;
751         default:
752                 /* Unknown frame type */
753                 break;
754         }
755
756         /* sanity check the length */
757         if (datalen > IEEE80211_DATA_LEN + 12) {
758                 printk(KERN_DEBUG "%s: oversized monitor frame, "
759                        "data length = %d\n", dev->name, datalen);
760                 stats->rx_length_errors++;
761                 goto update_stats;
762         }
763
764         skb = dev_alloc_skb(hdrlen + datalen);
765         if (!skb) {
766                 printk(KERN_WARNING "%s: Cannot allocate skb for monitor frame\n",
767                        dev->name);
768                 goto update_stats;
769         }
770
771         /* Copy the 802.11 header to the skb */
772         memcpy(skb_put(skb, hdrlen), &(desc->frame_ctl), hdrlen);
773         skb->mac.raw = skb->data;
774
775         /* If any, copy the data from the card to the skb */
776         if (datalen > 0) {
777                 err = hermes_bap_pread(hw, IRQ_BAP, skb_put(skb, datalen),
778                                        ALIGN(datalen, 2), rxfid,
779                                        HERMES_802_2_OFFSET);
780                 if (err) {
781                         printk(KERN_ERR "%s: error %d reading monitor frame\n",
782                                dev->name, err);
783                         goto drop;
784                 }
785         }
786
787         skb->dev = dev;
788         skb->ip_summed = CHECKSUM_NONE;
789         skb->pkt_type = PACKET_OTHERHOST;
790         skb->protocol = __constant_htons(ETH_P_802_2);
791         
792         dev->last_rx = jiffies;
793         stats->rx_packets++;
794         stats->rx_bytes += skb->len;
795
796         netif_rx(skb);
797         return;
798
799  drop:
800         dev_kfree_skb_irq(skb);
801  update_stats:
802         stats->rx_errors++;
803         stats->rx_dropped++;
804 }
805
806 static void __orinoco_ev_rx(struct net_device *dev, hermes_t *hw)
807 {
808         struct orinoco_private *priv = netdev_priv(dev);
809         struct net_device_stats *stats = &priv->stats;
810         struct iw_statistics *wstats = &priv->wstats;
811         struct sk_buff *skb = NULL;
812         u16 rxfid, status, fc;
813         int length;
814         struct hermes_rx_descriptor desc;
815         struct ethhdr *hdr;
816         int err;
817
818         rxfid = hermes_read_regn(hw, RXFID);
819
820         err = hermes_bap_pread(hw, IRQ_BAP, &desc, sizeof(desc),
821                                rxfid, 0);
822         if (err) {
823                 printk(KERN_ERR "%s: error %d reading Rx descriptor. "
824                        "Frame dropped.\n", dev->name, err);
825                 goto update_stats;
826         }
827
828         status = le16_to_cpu(desc.status);
829
830         if (status & HERMES_RXSTAT_BADCRC) {
831                 DEBUG(1, "%s: Bad CRC on Rx. Frame dropped.\n",
832                       dev->name);
833                 stats->rx_crc_errors++;
834                 goto update_stats;
835         }
836
837         /* Handle frames in monitor mode */
838         if (priv->iw_mode == IW_MODE_MONITOR) {
839                 orinoco_rx_monitor(dev, rxfid, &desc);
840                 return;
841         }
842
843         if (status & HERMES_RXSTAT_UNDECRYPTABLE) {
844                 DEBUG(1, "%s: Undecryptable frame on Rx. Frame dropped.\n",
845                       dev->name);
846                 wstats->discard.code++;
847                 goto update_stats;
848         }
849
850         length = le16_to_cpu(desc.data_len);
851         fc = le16_to_cpu(desc.frame_ctl);
852
853         /* Sanity checks */
854         if (length < 3) { /* No for even an 802.2 LLC header */
855                 /* At least on Symbol firmware with PCF we get quite a
856                    lot of these legitimately - Poll frames with no
857                    data. */
858                 return;
859         }
860         if (length > IEEE80211_DATA_LEN) {
861                 printk(KERN_WARNING "%s: Oversized frame received (%d bytes)\n",
862                        dev->name, length);
863                 stats->rx_length_errors++;
864                 goto update_stats;
865         }
866
867         /* We need space for the packet data itself, plus an ethernet
868            header, plus 2 bytes so we can align the IP header on a
869            32bit boundary, plus 1 byte so we can read in odd length
870            packets from the card, which has an IO granularity of 16
871            bits */  
872         skb = dev_alloc_skb(length+ETH_HLEN+2+1);
873         if (!skb) {
874                 printk(KERN_WARNING "%s: Can't allocate skb for Rx\n",
875                        dev->name);
876                 goto update_stats;
877         }
878
879         /* We'll prepend the header, so reserve space for it.  The worst
880            case is no decapsulation, when 802.3 header is prepended and
881            nothing is removed.  2 is for aligning the IP header.  */
882         skb_reserve(skb, ETH_HLEN + 2);
883
884         err = hermes_bap_pread(hw, IRQ_BAP, skb_put(skb, length),
885                                ALIGN(length, 2), rxfid,
886                                HERMES_802_2_OFFSET);
887         if (err) {
888                 printk(KERN_ERR "%s: error %d reading frame. "
889                        "Frame dropped.\n", dev->name, err);
890                 goto drop;
891         }
892
893         /* Handle decapsulation
894          * In most cases, the firmware tell us about SNAP frames.
895          * For some reason, the SNAP frames sent by LinkSys APs
896          * are not properly recognised by most firmwares.
897          * So, check ourselves */
898         if (length >= ENCAPS_OVERHEAD &&
899             (((status & HERMES_RXSTAT_MSGTYPE) == HERMES_RXSTAT_1042) ||
900              ((status & HERMES_RXSTAT_MSGTYPE) == HERMES_RXSTAT_TUNNEL) ||
901              is_ethersnap(skb->data))) {
902                 /* These indicate a SNAP within 802.2 LLC within
903                    802.11 frame which we'll need to de-encapsulate to
904                    the original EthernetII frame. */
905                 hdr = (struct ethhdr *)skb_push(skb, ETH_HLEN - ENCAPS_OVERHEAD);
906         } else {
907                 /* 802.3 frame - prepend 802.3 header as is */
908                 hdr = (struct ethhdr *)skb_push(skb, ETH_HLEN);
909                 hdr->h_proto = htons(length);
910         }
911         memcpy(hdr->h_dest, desc.addr1, ETH_ALEN);
912         if (fc & IEEE80211_FCTL_FROMDS)
913                 memcpy(hdr->h_source, desc.addr3, ETH_ALEN);
914         else
915                 memcpy(hdr->h_source, desc.addr2, ETH_ALEN);
916
917         dev->last_rx = jiffies;
918         skb->dev = dev;
919         skb->protocol = eth_type_trans(skb, dev);
920         skb->ip_summed = CHECKSUM_NONE;
921         if (fc & IEEE80211_FCTL_TODS)
922                 skb->pkt_type = PACKET_OTHERHOST;
923         
924         /* Process the wireless stats if needed */
925         orinoco_stat_gather(dev, skb, &desc);
926
927         /* Pass the packet to the networking stack */
928         netif_rx(skb);
929         stats->rx_packets++;
930         stats->rx_bytes += length;
931
932         return;
933
934  drop:  
935         dev_kfree_skb_irq(skb);
936  update_stats:
937         stats->rx_errors++;
938         stats->rx_dropped++;
939 }
940
941 /********************************************************************/
942 /* Rx path (info frames)                                            */
943 /********************************************************************/
944
945 static void print_linkstatus(struct net_device *dev, u16 status)
946 {
947         char * s;
948
949         if (suppress_linkstatus)
950                 return;
951
952         switch (status) {
953         case HERMES_LINKSTATUS_NOT_CONNECTED:
954                 s = "Not Connected";
955                 break;
956         case HERMES_LINKSTATUS_CONNECTED:
957                 s = "Connected";
958                 break;
959         case HERMES_LINKSTATUS_DISCONNECTED:
960                 s = "Disconnected";
961                 break;
962         case HERMES_LINKSTATUS_AP_CHANGE:
963                 s = "AP Changed";
964                 break;
965         case HERMES_LINKSTATUS_AP_OUT_OF_RANGE:
966                 s = "AP Out of Range";
967                 break;
968         case HERMES_LINKSTATUS_AP_IN_RANGE:
969                 s = "AP In Range";
970                 break;
971         case HERMES_LINKSTATUS_ASSOC_FAILED:
972                 s = "Association Failed";
973                 break;
974         default:
975                 s = "UNKNOWN";
976         }
977         
978         printk(KERN_INFO "%s: New link status: %s (%04x)\n",
979                dev->name, s, status);
980 }
981
982 /* Search scan results for requested BSSID, join it if found */
983 static void orinoco_join_ap(struct net_device *dev)
984 {
985         struct orinoco_private *priv = netdev_priv(dev);
986         struct hermes *hw = &priv->hw;
987         int err;
988         unsigned long flags;
989         struct join_req {
990                 u8 bssid[ETH_ALEN];
991                 __le16 channel;
992         } __attribute__ ((packed)) req;
993         const int atom_len = offsetof(struct prism2_scan_apinfo, atim);
994         struct prism2_scan_apinfo *atom = NULL;
995         int offset = 4;
996         int found = 0;
997         u8 *buf;
998         u16 len;
999
1000         /* Allocate buffer for scan results */
1001         buf = kmalloc(MAX_SCAN_LEN, GFP_KERNEL);
1002         if (! buf)
1003                 return;
1004
1005         if (orinoco_lock(priv, &flags) != 0)
1006                 goto fail_lock;
1007
1008         /* Sanity checks in case user changed something in the meantime */
1009         if (! priv->bssid_fixed)
1010                 goto out;
1011
1012         if (strlen(priv->desired_essid) == 0)
1013                 goto out;
1014
1015         /* Read scan results from the firmware */
1016         err = hermes_read_ltv(hw, USER_BAP,
1017                               HERMES_RID_SCANRESULTSTABLE,
1018                               MAX_SCAN_LEN, &len, buf);
1019         if (err) {
1020                 printk(KERN_ERR "%s: Cannot read scan results\n",
1021                        dev->name);
1022                 goto out;
1023         }
1024
1025         len = HERMES_RECLEN_TO_BYTES(len);
1026
1027         /* Go through the scan results looking for the channel of the AP
1028          * we were requested to join */
1029         for (; offset + atom_len <= len; offset += atom_len) {
1030                 atom = (struct prism2_scan_apinfo *) (buf + offset);
1031                 if (memcmp(&atom->bssid, priv->desired_bssid, ETH_ALEN) == 0) {
1032                         found = 1;
1033                         break;
1034                 }
1035         }
1036
1037         if (! found) {
1038                 DEBUG(1, "%s: Requested AP not found in scan results\n",
1039                       dev->name);
1040                 goto out;
1041         }
1042
1043         memcpy(req.bssid, priv->desired_bssid, ETH_ALEN);
1044         req.channel = atom->channel;    /* both are little-endian */
1045         err = HERMES_WRITE_RECORD(hw, USER_BAP, HERMES_RID_CNFJOINREQUEST,
1046                                   &req);
1047         if (err)
1048                 printk(KERN_ERR "%s: Error issuing join request\n", dev->name);
1049
1050  out:
1051         orinoco_unlock(priv, &flags);
1052
1053  fail_lock:
1054         kfree(buf);
1055 }
1056
1057 /* Send new BSSID to userspace */
1058 static void orinoco_send_wevents(struct net_device *dev)
1059 {
1060         struct orinoco_private *priv = netdev_priv(dev);
1061         struct hermes *hw = &priv->hw;
1062         union iwreq_data wrqu;
1063         int err;
1064         unsigned long flags;
1065
1066         if (orinoco_lock(priv, &flags) != 0)
1067                 return;
1068
1069         err = hermes_read_ltv(hw, IRQ_BAP, HERMES_RID_CURRENTBSSID,
1070                               ETH_ALEN, NULL, wrqu.ap_addr.sa_data);
1071         if (err != 0)
1072                 goto out;
1073
1074         wrqu.ap_addr.sa_family = ARPHRD_ETHER;
1075
1076         /* Send event to user space */
1077         wireless_send_event(dev, SIOCGIWAP, &wrqu, NULL);
1078
1079  out:
1080         orinoco_unlock(priv, &flags);
1081 }
1082
1083 static void __orinoco_ev_info(struct net_device *dev, hermes_t *hw)
1084 {
1085         struct orinoco_private *priv = netdev_priv(dev);
1086         u16 infofid;
1087         struct {
1088                 __le16 len;
1089                 __le16 type;
1090         } __attribute__ ((packed)) info;
1091         int len, type;
1092         int err;
1093
1094         /* This is an answer to an INQUIRE command that we did earlier,
1095          * or an information "event" generated by the card
1096          * The controller return to us a pseudo frame containing
1097          * the information in question - Jean II */
1098         infofid = hermes_read_regn(hw, INFOFID);
1099
1100         /* Read the info frame header - don't try too hard */
1101         err = hermes_bap_pread(hw, IRQ_BAP, &info, sizeof(info),
1102                                infofid, 0);
1103         if (err) {
1104                 printk(KERN_ERR "%s: error %d reading info frame. "
1105                        "Frame dropped.\n", dev->name, err);
1106                 return;
1107         }
1108         
1109         len = HERMES_RECLEN_TO_BYTES(le16_to_cpu(info.len));
1110         type = le16_to_cpu(info.type);
1111
1112         switch (type) {
1113         case HERMES_INQ_TALLIES: {
1114                 struct hermes_tallies_frame tallies;
1115                 struct iw_statistics *wstats = &priv->wstats;
1116                 
1117                 if (len > sizeof(tallies)) {
1118                         printk(KERN_WARNING "%s: Tallies frame too long (%d bytes)\n",
1119                                dev->name, len);
1120                         len = sizeof(tallies);
1121                 }
1122                 
1123                 err = hermes_bap_pread(hw, IRQ_BAP, &tallies, len,
1124                                        infofid, sizeof(info));
1125                 if (err)
1126                         break;
1127                 
1128                 /* Increment our various counters */
1129                 /* wstats->discard.nwid - no wrong BSSID stuff */
1130                 wstats->discard.code +=
1131                         le16_to_cpu(tallies.RxWEPUndecryptable);
1132                 if (len == sizeof(tallies))  
1133                         wstats->discard.code +=
1134                                 le16_to_cpu(tallies.RxDiscards_WEPICVError) +
1135                                 le16_to_cpu(tallies.RxDiscards_WEPExcluded);
1136                 wstats->discard.misc +=
1137                         le16_to_cpu(tallies.TxDiscardsWrongSA);
1138                 wstats->discard.fragment +=
1139                         le16_to_cpu(tallies.RxMsgInBadMsgFragments);
1140                 wstats->discard.retries +=
1141                         le16_to_cpu(tallies.TxRetryLimitExceeded);
1142                 /* wstats->miss.beacon - no match */
1143         }
1144         break;
1145         case HERMES_INQ_LINKSTATUS: {
1146                 struct hermes_linkstatus linkstatus;
1147                 u16 newstatus;
1148                 int connected;
1149
1150                 if (priv->iw_mode == IW_MODE_MONITOR)
1151                         break;
1152
1153                 if (len != sizeof(linkstatus)) {
1154                         printk(KERN_WARNING "%s: Unexpected size for linkstatus frame (%d bytes)\n",
1155                                dev->name, len);
1156                         break;
1157                 }
1158
1159                 err = hermes_bap_pread(hw, IRQ_BAP, &linkstatus, len,
1160                                        infofid, sizeof(info));
1161                 if (err)
1162                         break;
1163                 newstatus = le16_to_cpu(linkstatus.linkstatus);
1164
1165                 /* Symbol firmware uses "out of range" to signal that
1166                  * the hostscan frame can be requested.  */
1167                 if (newstatus == HERMES_LINKSTATUS_AP_OUT_OF_RANGE &&
1168                     priv->firmware_type == FIRMWARE_TYPE_SYMBOL &&
1169                     priv->has_hostscan && priv->scan_inprogress) {
1170                         hermes_inquire(hw, HERMES_INQ_HOSTSCAN_SYMBOL);
1171                         break;
1172                 }
1173
1174                 connected = (newstatus == HERMES_LINKSTATUS_CONNECTED)
1175                         || (newstatus == HERMES_LINKSTATUS_AP_CHANGE)
1176                         || (newstatus == HERMES_LINKSTATUS_AP_IN_RANGE);
1177
1178                 if (connected)
1179                         netif_carrier_on(dev);
1180                 else if (!ignore_disconnect)
1181                         netif_carrier_off(dev);
1182
1183                 if (newstatus != priv->last_linkstatus) {
1184                         priv->last_linkstatus = newstatus;
1185                         print_linkstatus(dev, newstatus);
1186                         /* The info frame contains only one word which is the
1187                          * status (see hermes.h). The status is pretty boring
1188                          * in itself, that's why we export the new BSSID...
1189                          * Jean II */
1190                         schedule_work(&priv->wevent_work);
1191                 }
1192         }
1193         break;
1194         case HERMES_INQ_SCAN:
1195                 if (!priv->scan_inprogress && priv->bssid_fixed &&
1196                     priv->firmware_type == FIRMWARE_TYPE_INTERSIL) {
1197                         schedule_work(&priv->join_work);
1198                         break;
1199                 }
1200                 /* fall through */
1201         case HERMES_INQ_HOSTSCAN:
1202         case HERMES_INQ_HOSTSCAN_SYMBOL: {
1203                 /* Result of a scanning. Contains information about
1204                  * cells in the vicinity - Jean II */
1205                 union iwreq_data        wrqu;
1206                 unsigned char *buf;
1207
1208                 /* Sanity check */
1209                 if (len > 4096) {
1210                         printk(KERN_WARNING "%s: Scan results too large (%d bytes)\n",
1211                                dev->name, len);
1212                         break;
1213                 }
1214
1215                 /* We are a strict producer. If the previous scan results
1216                  * have not been consumed, we just have to drop this
1217                  * frame. We can't remove the previous results ourselves,
1218                  * that would be *very* racy... Jean II */
1219                 if (priv->scan_result != NULL) {
1220                         printk(KERN_WARNING "%s: Previous scan results not consumed, dropping info frame.\n", dev->name);
1221                         break;
1222                 }
1223
1224                 /* Allocate buffer for results */
1225                 buf = kmalloc(len, GFP_ATOMIC);
1226                 if (buf == NULL)
1227                         /* No memory, so can't printk()... */
1228                         break;
1229
1230                 /* Read scan data */
1231                 err = hermes_bap_pread(hw, IRQ_BAP, (void *) buf, len,
1232                                        infofid, sizeof(info));
1233                 if (err) {
1234                         kfree(buf);
1235                         break;
1236                 }
1237
1238 #ifdef ORINOCO_DEBUG
1239                 {
1240                         int     i;
1241                         printk(KERN_DEBUG "Scan result [%02X", buf[0]);
1242                         for(i = 1; i < (len * 2); i++)
1243                                 printk(":%02X", buf[i]);
1244                         printk("]\n");
1245                 }
1246 #endif  /* ORINOCO_DEBUG */
1247
1248                 /* Allow the clients to access the results */
1249                 priv->scan_len = len;
1250                 priv->scan_result = buf;
1251
1252                 /* Send an empty event to user space.
1253                  * We don't send the received data on the event because
1254                  * it would require us to do complex transcoding, and
1255                  * we want to minimise the work done in the irq handler
1256                  * Use a request to extract the data - Jean II */
1257                 wrqu.data.length = 0;
1258                 wrqu.data.flags = 0;
1259                 wireless_send_event(dev, SIOCGIWSCAN, &wrqu, NULL);
1260         }
1261         break;
1262         case HERMES_INQ_SEC_STAT_AGERE:
1263                 /* Security status (Agere specific) */
1264                 /* Ignore this frame for now */
1265                 if (priv->firmware_type == FIRMWARE_TYPE_AGERE)
1266                         break;
1267                 /* fall through */
1268         default:
1269                 printk(KERN_DEBUG "%s: Unknown information frame received: "
1270                        "type 0x%04x, length %d\n", dev->name, type, len);
1271                 /* We don't actually do anything about it */
1272                 break;
1273         }
1274 }
1275
1276 static void __orinoco_ev_infdrop(struct net_device *dev, hermes_t *hw)
1277 {
1278         if (net_ratelimit())
1279                 printk(KERN_DEBUG "%s: Information frame lost.\n", dev->name);
1280 }
1281
1282 /********************************************************************/
1283 /* Internal hardware control routines                               */
1284 /********************************************************************/
1285
1286 int __orinoco_up(struct net_device *dev)
1287 {
1288         struct orinoco_private *priv = netdev_priv(dev);
1289         struct hermes *hw = &priv->hw;
1290         int err;
1291
1292         netif_carrier_off(dev); /* just to make sure */
1293
1294         err = __orinoco_program_rids(dev);
1295         if (err) {
1296                 printk(KERN_ERR "%s: Error %d configuring card\n",
1297                        dev->name, err);
1298                 return err;
1299         }
1300
1301         /* Fire things up again */
1302         hermes_set_irqmask(hw, ORINOCO_INTEN);
1303         err = hermes_enable_port(hw, 0);
1304         if (err) {
1305                 printk(KERN_ERR "%s: Error %d enabling MAC port\n",
1306                        dev->name, err);
1307                 return err;
1308         }
1309
1310         netif_start_queue(dev);
1311
1312         return 0;
1313 }
1314
1315 int __orinoco_down(struct net_device *dev)
1316 {
1317         struct orinoco_private *priv = netdev_priv(dev);
1318         struct hermes *hw = &priv->hw;
1319         int err;
1320
1321         netif_stop_queue(dev);
1322
1323         if (! priv->hw_unavailable) {
1324                 if (! priv->broken_disableport) {
1325                         err = hermes_disable_port(hw, 0);
1326                         if (err) {
1327                                 /* Some firmwares (e.g. Intersil 1.3.x) seem
1328                                  * to have problems disabling the port, oh
1329                                  * well, too bad. */
1330                                 printk(KERN_WARNING "%s: Error %d disabling MAC port\n",
1331                                        dev->name, err);
1332                                 priv->broken_disableport = 1;
1333                         }
1334                 }
1335                 hermes_set_irqmask(hw, 0);
1336                 hermes_write_regn(hw, EVACK, 0xffff);
1337         }
1338         
1339         /* firmware will have to reassociate */
1340         netif_carrier_off(dev);
1341         priv->last_linkstatus = 0xffff;
1342
1343         return 0;
1344 }
1345
1346 static int orinoco_allocate_fid(struct net_device *dev)
1347 {
1348         struct orinoco_private *priv = netdev_priv(dev);
1349         struct hermes *hw = &priv->hw;
1350         int err;
1351
1352         err = hermes_allocate(hw, priv->nicbuf_size, &priv->txfid);
1353         if (err == -EIO && priv->nicbuf_size > TX_NICBUF_SIZE_BUG) {
1354                 /* Try workaround for old Symbol firmware bug */
1355                 printk(KERN_WARNING "%s: firmware ALLOC bug detected "
1356                        "(old Symbol firmware?). Trying to work around... ",
1357                        dev->name);
1358                 
1359                 priv->nicbuf_size = TX_NICBUF_SIZE_BUG;
1360                 err = hermes_allocate(hw, priv->nicbuf_size, &priv->txfid);
1361                 if (err)
1362                         printk("failed!\n");
1363                 else
1364                         printk("ok.\n");
1365         }
1366
1367         return err;
1368 }
1369
1370 int orinoco_reinit_firmware(struct net_device *dev)
1371 {
1372         struct orinoco_private *priv = netdev_priv(dev);
1373         struct hermes *hw = &priv->hw;
1374         int err;
1375
1376         err = hermes_init(hw);
1377         if (!err)
1378                 err = orinoco_allocate_fid(dev);
1379
1380         return err;
1381 }
1382
1383 static int __orinoco_hw_set_bitrate(struct orinoco_private *priv)
1384 {
1385         hermes_t *hw = &priv->hw;
1386         int err = 0;
1387
1388         if (priv->bitratemode >= BITRATE_TABLE_SIZE) {
1389                 printk(KERN_ERR "%s: BUG: Invalid bitrate mode %d\n",
1390                        priv->ndev->name, priv->bitratemode);
1391                 return -EINVAL;
1392         }
1393
1394         switch (priv->firmware_type) {
1395         case FIRMWARE_TYPE_AGERE:
1396                 err = hermes_write_wordrec(hw, USER_BAP,
1397                                            HERMES_RID_CNFTXRATECONTROL,
1398                                            bitrate_table[priv->bitratemode].agere_txratectrl);
1399                 break;
1400         case FIRMWARE_TYPE_INTERSIL:
1401         case FIRMWARE_TYPE_SYMBOL:
1402                 err = hermes_write_wordrec(hw, USER_BAP,
1403                                            HERMES_RID_CNFTXRATECONTROL,
1404                                            bitrate_table[priv->bitratemode].intersil_txratectrl);
1405                 break;
1406         default:
1407                 BUG();
1408         }
1409
1410         return err;
1411 }
1412
1413 /* Set fixed AP address */
1414 static int __orinoco_hw_set_wap(struct orinoco_private *priv)
1415 {
1416         int roaming_flag;
1417         int err = 0;
1418         hermes_t *hw = &priv->hw;
1419
1420         switch (priv->firmware_type) {
1421         case FIRMWARE_TYPE_AGERE:
1422                 /* not supported */
1423                 break;
1424         case FIRMWARE_TYPE_INTERSIL:
1425                 if (priv->bssid_fixed)
1426                         roaming_flag = 2;
1427                 else
1428                         roaming_flag = 1;
1429
1430                 err = hermes_write_wordrec(hw, USER_BAP,
1431                                            HERMES_RID_CNFROAMINGMODE,
1432                                            roaming_flag);
1433                 break;
1434         case FIRMWARE_TYPE_SYMBOL:
1435                 err = HERMES_WRITE_RECORD(hw, USER_BAP,
1436                                           HERMES_RID_CNFMANDATORYBSSID_SYMBOL,
1437                                           &priv->desired_bssid);
1438                 break;
1439         }
1440         return err;
1441 }
1442
1443 /* Change the WEP keys and/or the current keys.  Can be called
1444  * either from __orinoco_hw_setup_wep() or directly from
1445  * orinoco_ioctl_setiwencode().  In the later case the association
1446  * with the AP is not broken (if the firmware can handle it),
1447  * which is needed for 802.1x implementations. */
1448 static int __orinoco_hw_setup_wepkeys(struct orinoco_private *priv)
1449 {
1450         hermes_t *hw = &priv->hw;
1451         int err = 0;
1452
1453         switch (priv->firmware_type) {
1454         case FIRMWARE_TYPE_AGERE:
1455                 err = HERMES_WRITE_RECORD(hw, USER_BAP,
1456                                           HERMES_RID_CNFWEPKEYS_AGERE,
1457                                           &priv->keys);
1458                 if (err)
1459                         return err;
1460                 err = hermes_write_wordrec(hw, USER_BAP,
1461                                            HERMES_RID_CNFTXKEY_AGERE,
1462                                            priv->tx_key);
1463                 if (err)
1464                         return err;
1465                 break;
1466         case FIRMWARE_TYPE_INTERSIL:
1467         case FIRMWARE_TYPE_SYMBOL:
1468                 {
1469                         int keylen;
1470                         int i;
1471
1472                         /* Force uniform key length to work around firmware bugs */
1473                         keylen = le16_to_cpu(priv->keys[priv->tx_key].len);
1474                         
1475                         if (keylen > LARGE_KEY_SIZE) {
1476                                 printk(KERN_ERR "%s: BUG: Key %d has oversize length %d.\n",
1477                                        priv->ndev->name, priv->tx_key, keylen);
1478                                 return -E2BIG;
1479                         }
1480
1481                         /* Write all 4 keys */
1482                         for(i = 0; i < ORINOCO_MAX_KEYS; i++) {
1483                                 err = hermes_write_ltv(hw, USER_BAP,
1484                                                        HERMES_RID_CNFDEFAULTKEY0 + i,
1485                                                        HERMES_BYTES_TO_RECLEN(keylen),
1486                                                        priv->keys[i].data);
1487                                 if (err)
1488                                         return err;
1489                         }
1490
1491                         /* Write the index of the key used in transmission */
1492                         err = hermes_write_wordrec(hw, USER_BAP,
1493                                                    HERMES_RID_CNFWEPDEFAULTKEYID,
1494                                                    priv->tx_key);
1495                         if (err)
1496                                 return err;
1497                 }
1498                 break;
1499         }
1500
1501         return 0;
1502 }
1503
1504 static int __orinoco_hw_setup_wep(struct orinoco_private *priv)
1505 {
1506         hermes_t *hw = &priv->hw;
1507         int err = 0;
1508         int master_wep_flag;
1509         int auth_flag;
1510
1511         if (priv->wep_on)
1512                 __orinoco_hw_setup_wepkeys(priv);
1513
1514         if (priv->wep_restrict)
1515                 auth_flag = HERMES_AUTH_SHARED_KEY;
1516         else
1517                 auth_flag = HERMES_AUTH_OPEN;
1518
1519         switch (priv->firmware_type) {
1520         case FIRMWARE_TYPE_AGERE: /* Agere style WEP */
1521                 if (priv->wep_on) {
1522                         /* Enable the shared-key authentication. */
1523                         err = hermes_write_wordrec(hw, USER_BAP,
1524                                                    HERMES_RID_CNFAUTHENTICATION_AGERE,
1525                                                    auth_flag);
1526                 }
1527                 err = hermes_write_wordrec(hw, USER_BAP,
1528                                            HERMES_RID_CNFWEPENABLED_AGERE,
1529                                            priv->wep_on);
1530                 if (err)
1531                         return err;
1532                 break;
1533
1534         case FIRMWARE_TYPE_INTERSIL: /* Intersil style WEP */
1535         case FIRMWARE_TYPE_SYMBOL: /* Symbol style WEP */
1536                 if (priv->wep_on) {
1537                         if (priv->wep_restrict ||
1538                             (priv->firmware_type == FIRMWARE_TYPE_SYMBOL))
1539                                 master_wep_flag = HERMES_WEP_PRIVACY_INVOKED |
1540                                                   HERMES_WEP_EXCL_UNENCRYPTED;
1541                         else
1542                                 master_wep_flag = HERMES_WEP_PRIVACY_INVOKED;
1543
1544                         err = hermes_write_wordrec(hw, USER_BAP,
1545                                                    HERMES_RID_CNFAUTHENTICATION,
1546                                                    auth_flag);
1547                         if (err)
1548                                 return err;
1549                 } else
1550                         master_wep_flag = 0;
1551
1552                 if (priv->iw_mode == IW_MODE_MONITOR)
1553                         master_wep_flag |= HERMES_WEP_HOST_DECRYPT;
1554
1555                 /* Master WEP setting : on/off */
1556                 err = hermes_write_wordrec(hw, USER_BAP,
1557                                            HERMES_RID_CNFWEPFLAGS_INTERSIL,
1558                                            master_wep_flag);
1559                 if (err)
1560                         return err;     
1561
1562                 break;
1563         }
1564
1565         return 0;
1566 }
1567
1568 static int __orinoco_program_rids(struct net_device *dev)
1569 {
1570         struct orinoco_private *priv = netdev_priv(dev);
1571         hermes_t *hw = &priv->hw;
1572         int err;
1573         struct hermes_idstring idbuf;
1574
1575         /* Set the MAC address */
1576         err = hermes_write_ltv(hw, USER_BAP, HERMES_RID_CNFOWNMACADDR,
1577                                HERMES_BYTES_TO_RECLEN(ETH_ALEN), dev->dev_addr);
1578         if (err) {
1579                 printk(KERN_ERR "%s: Error %d setting MAC address\n",
1580                        dev->name, err);
1581                 return err;
1582         }
1583
1584         /* Set up the link mode */
1585         err = hermes_write_wordrec(hw, USER_BAP, HERMES_RID_CNFPORTTYPE,
1586                                    priv->port_type);
1587         if (err) {
1588                 printk(KERN_ERR "%s: Error %d setting port type\n",
1589                        dev->name, err);
1590                 return err;
1591         }
1592         /* Set the channel/frequency */
1593         if (priv->channel != 0 && priv->iw_mode != IW_MODE_INFRA) {
1594                 err = hermes_write_wordrec(hw, USER_BAP,
1595                                            HERMES_RID_CNFOWNCHANNEL,
1596                                            priv->channel);
1597                 if (err) {
1598                         printk(KERN_ERR "%s: Error %d setting channel %d\n",
1599                                dev->name, err, priv->channel);
1600                         return err;
1601                 }
1602         }
1603
1604         if (priv->has_ibss) {
1605                 u16 createibss;
1606
1607                 if ((strlen(priv->desired_essid) == 0) && (priv->createibss)) {
1608                         printk(KERN_WARNING "%s: This firmware requires an "
1609                                "ESSID in IBSS-Ad-Hoc mode.\n", dev->name);
1610                         /* With wvlan_cs, in this case, we would crash.
1611                          * hopefully, this driver will behave better...
1612                          * Jean II */
1613                         createibss = 0;
1614                 } else {
1615                         createibss = priv->createibss;
1616                 }
1617                 
1618                 err = hermes_write_wordrec(hw, USER_BAP,
1619                                            HERMES_RID_CNFCREATEIBSS,
1620                                            createibss);
1621                 if (err) {
1622                         printk(KERN_ERR "%s: Error %d setting CREATEIBSS\n",
1623                                dev->name, err);
1624                         return err;
1625                 }
1626         }
1627
1628         /* Set the desired BSSID */
1629         err = __orinoco_hw_set_wap(priv);
1630         if (err) {
1631                 printk(KERN_ERR "%s: Error %d setting AP address\n",
1632                        dev->name, err);
1633                 return err;
1634         }
1635         /* Set the desired ESSID */
1636         idbuf.len = cpu_to_le16(strlen(priv->desired_essid));
1637         memcpy(&idbuf.val, priv->desired_essid, sizeof(idbuf.val));
1638         /* WinXP wants partner to configure OWNSSID even in IBSS mode. (jimc) */
1639         err = hermes_write_ltv(hw, USER_BAP, HERMES_RID_CNFOWNSSID,
1640                                HERMES_BYTES_TO_RECLEN(strlen(priv->desired_essid)+2),
1641                                &idbuf);
1642         if (err) {
1643                 printk(KERN_ERR "%s: Error %d setting OWNSSID\n",
1644                        dev->name, err);
1645                 return err;
1646         }
1647         err = hermes_write_ltv(hw, USER_BAP, HERMES_RID_CNFDESIREDSSID,
1648                                HERMES_BYTES_TO_RECLEN(strlen(priv->desired_essid)+2),
1649                                &idbuf);
1650         if (err) {
1651                 printk(KERN_ERR "%s: Error %d setting DESIREDSSID\n",
1652                        dev->name, err);
1653                 return err;
1654         }
1655
1656         /* Set the station name */
1657         idbuf.len = cpu_to_le16(strlen(priv->nick));
1658         memcpy(&idbuf.val, priv->nick, sizeof(idbuf.val));
1659         err = hermes_write_ltv(hw, USER_BAP, HERMES_RID_CNFOWNNAME,
1660                                HERMES_BYTES_TO_RECLEN(strlen(priv->nick)+2),
1661                                &idbuf);
1662         if (err) {
1663                 printk(KERN_ERR "%s: Error %d setting nickname\n",
1664                        dev->name, err);
1665                 return err;
1666         }
1667
1668         /* Set AP density */
1669         if (priv->has_sensitivity) {
1670                 err = hermes_write_wordrec(hw, USER_BAP,
1671                                            HERMES_RID_CNFSYSTEMSCALE,
1672                                            priv->ap_density);
1673                 if (err) {
1674                         printk(KERN_WARNING "%s: Error %d setting SYSTEMSCALE.  "
1675                                "Disabling sensitivity control\n",
1676                                dev->name, err);
1677
1678                         priv->has_sensitivity = 0;
1679                 }
1680         }
1681
1682         /* Set RTS threshold */
1683         err = hermes_write_wordrec(hw, USER_BAP, HERMES_RID_CNFRTSTHRESHOLD,
1684                                    priv->rts_thresh);
1685         if (err) {
1686                 printk(KERN_ERR "%s: Error %d setting RTS threshold\n",
1687                        dev->name, err);
1688                 return err;
1689         }
1690
1691         /* Set fragmentation threshold or MWO robustness */
1692         if (priv->has_mwo)
1693                 err = hermes_write_wordrec(hw, USER_BAP,
1694                                            HERMES_RID_CNFMWOROBUST_AGERE,
1695                                            priv->mwo_robust);
1696         else
1697                 err = hermes_write_wordrec(hw, USER_BAP,
1698                                            HERMES_RID_CNFFRAGMENTATIONTHRESHOLD,
1699                                            priv->frag_thresh);
1700         if (err) {
1701                 printk(KERN_ERR "%s: Error %d setting fragmentation\n",
1702                        dev->name, err);
1703                 return err;
1704         }
1705
1706         /* Set bitrate */
1707         err = __orinoco_hw_set_bitrate(priv);
1708         if (err) {
1709                 printk(KERN_ERR "%s: Error %d setting bitrate\n",
1710                        dev->name, err);
1711                 return err;
1712         }
1713
1714         /* Set power management */
1715         if (priv->has_pm) {
1716                 err = hermes_write_wordrec(hw, USER_BAP,
1717                                            HERMES_RID_CNFPMENABLED,
1718                                            priv->pm_on);
1719                 if (err) {
1720                         printk(KERN_ERR "%s: Error %d setting up PM\n",
1721                                dev->name, err);
1722                         return err;
1723                 }
1724
1725                 err = hermes_write_wordrec(hw, USER_BAP,
1726                                            HERMES_RID_CNFMULTICASTRECEIVE,
1727                                            priv->pm_mcast);
1728                 if (err) {
1729                         printk(KERN_ERR "%s: Error %d setting up PM\n",
1730                                dev->name, err);
1731                         return err;
1732                 }
1733                 err = hermes_write_wordrec(hw, USER_BAP,
1734                                            HERMES_RID_CNFMAXSLEEPDURATION,
1735                                            priv->pm_period);
1736                 if (err) {
1737                         printk(KERN_ERR "%s: Error %d setting up PM\n",
1738                                dev->name, err);
1739                         return err;
1740                 }
1741                 err = hermes_write_wordrec(hw, USER_BAP,
1742                                            HERMES_RID_CNFPMHOLDOVERDURATION,
1743                                            priv->pm_timeout);
1744                 if (err) {
1745                         printk(KERN_ERR "%s: Error %d setting up PM\n",
1746                                dev->name, err);
1747                         return err;
1748                 }
1749         }
1750
1751         /* Set preamble - only for Symbol so far... */
1752         if (priv->has_preamble) {
1753                 err = hermes_write_wordrec(hw, USER_BAP,
1754                                            HERMES_RID_CNFPREAMBLE_SYMBOL,
1755                                            priv->preamble);
1756                 if (err) {
1757                         printk(KERN_ERR "%s: Error %d setting preamble\n",
1758                                dev->name, err);
1759                         return err;
1760                 }
1761         }
1762
1763         /* Set up encryption */
1764         if (priv->has_wep) {
1765                 err = __orinoco_hw_setup_wep(priv);
1766                 if (err) {
1767                         printk(KERN_ERR "%s: Error %d activating WEP\n",
1768                                dev->name, err);
1769                         return err;
1770                 }
1771         }
1772
1773         if (priv->iw_mode == IW_MODE_MONITOR) {
1774                 /* Enable monitor mode */
1775                 dev->type = ARPHRD_IEEE80211;
1776                 err = hermes_docmd_wait(hw, HERMES_CMD_TEST | 
1777                                             HERMES_TEST_MONITOR, 0, NULL);
1778         } else {
1779                 /* Disable monitor mode */
1780                 dev->type = ARPHRD_ETHER;
1781                 err = hermes_docmd_wait(hw, HERMES_CMD_TEST |
1782                                             HERMES_TEST_STOP, 0, NULL);
1783         }
1784         if (err)
1785                 return err;
1786
1787         /* Set promiscuity / multicast*/
1788         priv->promiscuous = 0;
1789         priv->mc_count = 0;
1790
1791         /* FIXME: what about netif_tx_lock */
1792         __orinoco_set_multicast_list(dev);
1793
1794         return 0;
1795 }
1796
1797 /* FIXME: return int? */
1798 static void
1799 __orinoco_set_multicast_list(struct net_device *dev)
1800 {
1801         struct orinoco_private *priv = netdev_priv(dev);
1802         hermes_t *hw = &priv->hw;
1803         int err = 0;
1804         int promisc, mc_count;
1805
1806         /* The Hermes doesn't seem to have an allmulti mode, so we go
1807          * into promiscuous mode and let the upper levels deal. */
1808         if ( (dev->flags & IFF_PROMISC) || (dev->flags & IFF_ALLMULTI) ||
1809              (dev->mc_count > MAX_MULTICAST(priv)) ) {
1810                 promisc = 1;
1811                 mc_count = 0;
1812         } else {
1813                 promisc = 0;
1814                 mc_count = dev->mc_count;
1815         }
1816
1817         if (promisc != priv->promiscuous) {
1818                 err = hermes_write_wordrec(hw, USER_BAP,
1819                                            HERMES_RID_CNFPROMISCUOUSMODE,
1820                                            promisc);
1821                 if (err) {
1822                         printk(KERN_ERR "%s: Error %d setting PROMISCUOUSMODE to 1.\n",
1823                                dev->name, err);
1824                 } else 
1825                         priv->promiscuous = promisc;
1826         }
1827
1828         if (! promisc && (mc_count || priv->mc_count) ) {
1829                 struct dev_mc_list *p = dev->mc_list;
1830                 struct hermes_multicast mclist;
1831                 int i;
1832
1833                 for (i = 0; i < mc_count; i++) {
1834                         /* paranoia: is list shorter than mc_count? */
1835                         BUG_ON(! p);
1836                         /* paranoia: bad address size in list? */
1837                         BUG_ON(p->dmi_addrlen != ETH_ALEN);
1838                         
1839                         memcpy(mclist.addr[i], p->dmi_addr, ETH_ALEN);
1840                         p = p->next;
1841                 }
1842                 
1843                 if (p)
1844                         printk(KERN_WARNING "%s: Multicast list is "
1845                                "longer than mc_count\n", dev->name);
1846
1847                 err = hermes_write_ltv(hw, USER_BAP, HERMES_RID_CNFGROUPADDRESSES,
1848                                        HERMES_BYTES_TO_RECLEN(priv->mc_count * ETH_ALEN),
1849                                        &mclist);
1850                 if (err)
1851                         printk(KERN_ERR "%s: Error %d setting multicast list.\n",
1852                                dev->name, err);
1853                 else
1854                         priv->mc_count = mc_count;
1855         }
1856
1857         /* Since we can set the promiscuous flag when it wasn't asked
1858            for, make sure the net_device knows about it. */
1859         if (priv->promiscuous)
1860                 dev->flags |= IFF_PROMISC;
1861         else
1862                 dev->flags &= ~IFF_PROMISC;
1863 }
1864
1865 /* This must be called from user context, without locks held - use
1866  * schedule_work() */
1867 static void orinoco_reset(struct net_device *dev)
1868 {
1869         struct orinoco_private *priv = netdev_priv(dev);
1870         struct hermes *hw = &priv->hw;
1871         int err;
1872         unsigned long flags;
1873
1874         if (orinoco_lock(priv, &flags) != 0)
1875                 /* When the hardware becomes available again, whatever
1876                  * detects that is responsible for re-initializing
1877                  * it. So no need for anything further */
1878                 return;
1879
1880         netif_stop_queue(dev);
1881
1882         /* Shut off interrupts.  Depending on what state the hardware
1883          * is in, this might not work, but we'll try anyway */
1884         hermes_set_irqmask(hw, 0);
1885         hermes_write_regn(hw, EVACK, 0xffff);
1886
1887         priv->hw_unavailable++;
1888         priv->last_linkstatus = 0xffff; /* firmware will have to reassociate */
1889         netif_carrier_off(dev);
1890
1891         orinoco_unlock(priv, &flags);
1892
1893         /* Scanning support: Cleanup of driver struct */
1894         kfree(priv->scan_result);
1895         priv->scan_result = NULL;
1896         priv->scan_inprogress = 0;
1897
1898         if (priv->hard_reset) {
1899                 err = (*priv->hard_reset)(priv);
1900                 if (err) {
1901                         printk(KERN_ERR "%s: orinoco_reset: Error %d "
1902                                "performing hard reset\n", dev->name, err);
1903                         goto disable;
1904                 }
1905         }
1906
1907         err = orinoco_reinit_firmware(dev);
1908         if (err) {
1909                 printk(KERN_ERR "%s: orinoco_reset: Error %d re-initializing firmware\n",
1910                        dev->name, err);
1911                 goto disable;
1912         }
1913
1914         spin_lock_irq(&priv->lock); /* This has to be called from user context */
1915
1916         priv->hw_unavailable--;
1917
1918         /* priv->open or priv->hw_unavailable might have changed while
1919          * we dropped the lock */
1920         if (priv->open && (! priv->hw_unavailable)) {
1921                 err = __orinoco_up(dev);
1922                 if (err) {
1923                         printk(KERN_ERR "%s: orinoco_reset: Error %d reenabling card\n",
1924                                dev->name, err);
1925                 } else
1926                         dev->trans_start = jiffies;
1927         }
1928
1929         spin_unlock_irq(&priv->lock);
1930
1931         return;
1932  disable:
1933         hermes_set_irqmask(hw, 0);
1934         netif_device_detach(dev);
1935         printk(KERN_ERR "%s: Device has been disabled!\n", dev->name);
1936 }
1937
1938 /********************************************************************/
1939 /* Interrupt handler                                                */
1940 /********************************************************************/
1941
1942 static void __orinoco_ev_tick(struct net_device *dev, hermes_t *hw)
1943 {
1944         printk(KERN_DEBUG "%s: TICK\n", dev->name);
1945 }
1946
1947 static void __orinoco_ev_wterr(struct net_device *dev, hermes_t *hw)
1948 {
1949         /* This seems to happen a fair bit under load, but ignoring it
1950            seems to work fine...*/
1951         printk(KERN_DEBUG "%s: MAC controller error (WTERR). Ignoring.\n",
1952                dev->name);
1953 }
1954
1955 irqreturn_t orinoco_interrupt(int irq, void *dev_id, struct pt_regs *regs)
1956 {
1957         struct net_device *dev = (struct net_device *)dev_id;
1958         struct orinoco_private *priv = netdev_priv(dev);
1959         hermes_t *hw = &priv->hw;
1960         int count = MAX_IRQLOOPS_PER_IRQ;
1961         u16 evstat, events;
1962         /* These are used to detect a runaway interrupt situation */
1963         /* If we get more than MAX_IRQLOOPS_PER_JIFFY iterations in a jiffy,
1964          * we panic and shut down the hardware */
1965         static int last_irq_jiffy = 0; /* jiffies value the last time
1966                                         * we were called */
1967         static int loops_this_jiffy = 0;
1968         unsigned long flags;
1969
1970         if (orinoco_lock(priv, &flags) != 0) {
1971                 /* If hw is unavailable - we don't know if the irq was
1972                  * for us or not */
1973                 return IRQ_HANDLED;
1974         }
1975
1976         evstat = hermes_read_regn(hw, EVSTAT);
1977         events = evstat & hw->inten;
1978         if (! events) {
1979                 orinoco_unlock(priv, &flags);
1980                 return IRQ_NONE;
1981         }
1982         
1983         if (jiffies != last_irq_jiffy)
1984                 loops_this_jiffy = 0;
1985         last_irq_jiffy = jiffies;
1986
1987         while (events && count--) {
1988                 if (++loops_this_jiffy > MAX_IRQLOOPS_PER_JIFFY) {
1989                         printk(KERN_WARNING "%s: IRQ handler is looping too "
1990                                "much! Resetting.\n", dev->name);
1991                         /* Disable interrupts for now */
1992                         hermes_set_irqmask(hw, 0);
1993                         schedule_work(&priv->reset_work);
1994                         break;
1995                 }
1996
1997                 /* Check the card hasn't been removed */
1998                 if (! hermes_present(hw)) {
1999                         DEBUG(0, "orinoco_interrupt(): card removed\n");
2000                         break;
2001                 }
2002
2003                 if (events & HERMES_EV_TICK)
2004                         __orinoco_ev_tick(dev, hw);
2005                 if (events & HERMES_EV_WTERR)
2006                         __orinoco_ev_wterr(dev, hw);
2007                 if (events & HERMES_EV_INFDROP)
2008                         __orinoco_ev_infdrop(dev, hw);
2009                 if (events & HERMES_EV_INFO)
2010                         __orinoco_ev_info(dev, hw);
2011                 if (events & HERMES_EV_RX)
2012                         __orinoco_ev_rx(dev, hw);
2013                 if (events & HERMES_EV_TXEXC)
2014                         __orinoco_ev_txexc(dev, hw);
2015                 if (events & HERMES_EV_TX)
2016                         __orinoco_ev_tx(dev, hw);
2017                 if (events & HERMES_EV_ALLOC)
2018                         __orinoco_ev_alloc(dev, hw);
2019                 
2020                 hermes_write_regn(hw, EVACK, evstat);
2021
2022                 evstat = hermes_read_regn(hw, EVSTAT);
2023                 events = evstat & hw->inten;
2024         };
2025
2026         orinoco_unlock(priv, &flags);
2027         return IRQ_HANDLED;
2028 }
2029
2030 /********************************************************************/
2031 /* Initialization                                                   */
2032 /********************************************************************/
2033
2034 struct comp_id {
2035         u16 id, variant, major, minor;
2036 } __attribute__ ((packed));
2037
2038 static inline fwtype_t determine_firmware_type(struct comp_id *nic_id)
2039 {
2040         if (nic_id->id < 0x8000)
2041                 return FIRMWARE_TYPE_AGERE;
2042         else if (nic_id->id == 0x8000 && nic_id->major == 0)
2043                 return FIRMWARE_TYPE_SYMBOL;
2044         else
2045                 return FIRMWARE_TYPE_INTERSIL;
2046 }
2047
2048 /* Set priv->firmware type, determine firmware properties */
2049 static int determine_firmware(struct net_device *dev)
2050 {
2051         struct orinoco_private *priv = netdev_priv(dev);
2052         hermes_t *hw = &priv->hw;
2053         int err;
2054         struct comp_id nic_id, sta_id;
2055         unsigned int firmver;
2056         char tmp[SYMBOL_MAX_VER_LEN+1];
2057
2058         /* Get the hardware version */
2059         err = HERMES_READ_RECORD(hw, USER_BAP, HERMES_RID_NICID, &nic_id);
2060         if (err) {
2061                 printk(KERN_ERR "%s: Cannot read hardware identity: error %d\n",
2062                        dev->name, err);
2063                 return err;
2064         }
2065
2066         le16_to_cpus(&nic_id.id);
2067         le16_to_cpus(&nic_id.variant);
2068         le16_to_cpus(&nic_id.major);
2069         le16_to_cpus(&nic_id.minor);
2070         printk(KERN_DEBUG "%s: Hardware identity %04x:%04x:%04x:%04x\n",
2071                dev->name, nic_id.id, nic_id.variant,
2072                nic_id.major, nic_id.minor);
2073
2074         priv->firmware_type = determine_firmware_type(&nic_id);
2075
2076         /* Get the firmware version */
2077         err = HERMES_READ_RECORD(hw, USER_BAP, HERMES_RID_STAID, &sta_id);
2078         if (err) {
2079                 printk(KERN_ERR "%s: Cannot read station identity: error %d\n",
2080                        dev->name, err);
2081                 return err;
2082         }
2083
2084         le16_to_cpus(&sta_id.id);
2085         le16_to_cpus(&sta_id.variant);
2086         le16_to_cpus(&sta_id.major);
2087         le16_to_cpus(&sta_id.minor);
2088         printk(KERN_DEBUG "%s: Station identity  %04x:%04x:%04x:%04x\n",
2089                dev->name, sta_id.id, sta_id.variant,
2090                sta_id.major, sta_id.minor);
2091
2092         switch (sta_id.id) {
2093         case 0x15:
2094                 printk(KERN_ERR "%s: Primary firmware is active\n",
2095                        dev->name);
2096                 return -ENODEV;
2097         case 0x14b:
2098                 printk(KERN_ERR "%s: Tertiary firmware is active\n",
2099                        dev->name);
2100                 return -ENODEV;
2101         case 0x1f:      /* Intersil, Agere, Symbol Spectrum24 */
2102         case 0x21:      /* Symbol Spectrum24 Trilogy */
2103                 break;
2104         default:
2105                 printk(KERN_NOTICE "%s: Unknown station ID, please report\n",
2106                        dev->name);
2107                 break;
2108         }
2109
2110         /* Default capabilities */
2111         priv->has_sensitivity = 1;
2112         priv->has_mwo = 0;
2113         priv->has_preamble = 0;
2114         priv->has_port3 = 1;
2115         priv->has_ibss = 1;
2116         priv->has_wep = 0;
2117         priv->has_big_wep = 0;
2118
2119         /* Determine capabilities from the firmware version */
2120         switch (priv->firmware_type) {
2121         case FIRMWARE_TYPE_AGERE:
2122                 /* Lucent Wavelan IEEE, Lucent Orinoco, Cabletron RoamAbout,
2123                    ELSA, Melco, HP, IBM, Dell 1150, Compaq 110/210 */
2124                 snprintf(priv->fw_name, sizeof(priv->fw_name) - 1,
2125                          "Lucent/Agere %d.%02d", sta_id.major, sta_id.minor);
2126
2127                 firmver = ((unsigned long)sta_id.major << 16) | sta_id.minor;
2128
2129                 priv->has_ibss = (firmver >= 0x60006);
2130                 priv->has_wep = (firmver >= 0x40020);
2131                 priv->has_big_wep = 1; /* FIXME: this is wrong - how do we tell
2132                                           Gold cards from the others? */
2133                 priv->has_mwo = (firmver >= 0x60000);
2134                 priv->has_pm = (firmver >= 0x40020); /* Don't work in 7.52 ? */
2135                 priv->ibss_port = 1;
2136                 priv->has_hostscan = (firmver >= 0x8000a);
2137                 priv->broken_monitor = (firmver >= 0x80000);
2138
2139                 /* Tested with Agere firmware :
2140                  *      1.16 ; 4.08 ; 4.52 ; 6.04 ; 6.16 ; 7.28 => Jean II
2141                  * Tested CableTron firmware : 4.32 => Anton */
2142                 break;
2143         case FIRMWARE_TYPE_SYMBOL:
2144                 /* Symbol , 3Com AirConnect, Intel, Ericsson WLAN */
2145                 /* Intel MAC : 00:02:B3:* */
2146                 /* 3Com MAC : 00:50:DA:* */
2147                 memset(tmp, 0, sizeof(tmp));
2148                 /* Get the Symbol firmware version */
2149                 err = hermes_read_ltv(hw, USER_BAP,
2150                                       HERMES_RID_SECONDARYVERSION_SYMBOL,
2151                                       SYMBOL_MAX_VER_LEN, NULL, &tmp);
2152                 if (err) {
2153                         printk(KERN_WARNING
2154                                "%s: Error %d reading Symbol firmware info. Wildly guessing capabilities...\n",
2155                                dev->name, err);
2156                         firmver = 0;
2157                         tmp[0] = '\0';
2158                 } else {
2159                         /* The firmware revision is a string, the format is
2160                          * something like : "V2.20-01".
2161                          * Quick and dirty parsing... - Jean II
2162                          */
2163                         firmver = ((tmp[1] - '0') << 16) | ((tmp[3] - '0') << 12)
2164                                 | ((tmp[4] - '0') << 8) | ((tmp[6] - '0') << 4)
2165                                 | (tmp[7] - '0');
2166
2167                         tmp[SYMBOL_MAX_VER_LEN] = '\0';
2168                 }
2169
2170                 snprintf(priv->fw_name, sizeof(priv->fw_name) - 1,
2171                          "Symbol %s", tmp);
2172
2173                 priv->has_ibss = (firmver >= 0x20000);
2174                 priv->has_wep = (firmver >= 0x15012);
2175                 priv->has_big_wep = (firmver >= 0x20000);
2176                 priv->has_pm = (firmver >= 0x20000 && firmver < 0x22000) || 
2177                                (firmver >= 0x29000 && firmver < 0x30000) ||
2178                                firmver >= 0x31000;
2179                 priv->has_preamble = (firmver >= 0x20000);
2180                 priv->ibss_port = 4;
2181                 priv->broken_disableport = (firmver == 0x25013) ||
2182                                            (firmver >= 0x30000 && firmver <= 0x31000);
2183                 priv->has_hostscan = (firmver >= 0x31001) ||
2184                                      (firmver >= 0x29057 && firmver < 0x30000);
2185                 /* Tested with Intel firmware : 0x20015 => Jean II */
2186                 /* Tested with 3Com firmware : 0x15012 & 0x22001 => Jean II */
2187                 break;
2188         case FIRMWARE_TYPE_INTERSIL:
2189                 /* D-Link, Linksys, Adtron, ZoomAir, and many others...
2190                  * Samsung, Compaq 100/200 and Proxim are slightly
2191                  * different and less well tested */
2192                 /* D-Link MAC : 00:40:05:* */
2193                 /* Addtron MAC : 00:90:D1:* */
2194                 snprintf(priv->fw_name, sizeof(priv->fw_name) - 1,
2195                          "Intersil %d.%d.%d", sta_id.major, sta_id.minor,
2196                          sta_id.variant);
2197
2198                 firmver = ((unsigned long)sta_id.major << 16) |
2199                         ((unsigned long)sta_id.minor << 8) | sta_id.variant;
2200
2201                 priv->has_ibss = (firmver >= 0x000700); /* FIXME */
2202                 priv->has_big_wep = priv->has_wep = (firmver >= 0x000800);
2203                 priv->has_pm = (firmver >= 0x000700);
2204                 priv->has_hostscan = (firmver >= 0x010301);
2205
2206                 if (firmver >= 0x000800)
2207                         priv->ibss_port = 0;
2208                 else {
2209                         printk(KERN_NOTICE "%s: Intersil firmware earlier "
2210                                "than v0.8.x - several features not supported\n",
2211                                dev->name);
2212                         priv->ibss_port = 1;
2213                 }
2214                 break;
2215         }
2216         printk(KERN_DEBUG "%s: Firmware determined as %s\n", dev->name,
2217                priv->fw_name);
2218
2219         return 0;
2220 }
2221
2222 static int orinoco_init(struct net_device *dev)
2223 {
2224         struct orinoco_private *priv = netdev_priv(dev);
2225         hermes_t *hw = &priv->hw;
2226         int err = 0;
2227         struct hermes_idstring nickbuf;
2228         u16 reclen;
2229         int len;
2230
2231         /* No need to lock, the hw_unavailable flag is already set in
2232          * alloc_orinocodev() */
2233         priv->nicbuf_size = IEEE80211_FRAME_LEN + ETH_HLEN;
2234
2235         /* Initialize the firmware */
2236         err = hermes_init(hw);
2237         if (err != 0) {
2238                 printk(KERN_ERR "%s: failed to initialize firmware (err = %d)\n",
2239                        dev->name, err);
2240                 goto out;
2241         }
2242
2243         err = determine_firmware(dev);
2244         if (err != 0) {
2245                 printk(KERN_ERR "%s: Incompatible firmware, aborting\n",
2246                        dev->name);
2247                 goto out;
2248         }
2249
2250         if (priv->has_port3)
2251                 printk(KERN_DEBUG "%s: Ad-hoc demo mode supported\n", dev->name);
2252         if (priv->has_ibss)
2253                 printk(KERN_DEBUG "%s: IEEE standard IBSS ad-hoc mode supported\n",
2254                        dev->name);
2255         if (priv->has_wep) {
2256                 printk(KERN_DEBUG "%s: WEP supported, ", dev->name);
2257                 if (priv->has_big_wep)
2258                         printk("104-bit key\n");
2259                 else
2260                         printk("40-bit key\n");
2261         }
2262
2263         /* Get the MAC address */
2264         err = hermes_read_ltv(hw, USER_BAP, HERMES_RID_CNFOWNMACADDR,
2265                               ETH_ALEN, NULL, dev->dev_addr);
2266         if (err) {
2267                 printk(KERN_WARNING "%s: failed to read MAC address!\n",
2268                        dev->name);
2269                 goto out;
2270         }
2271
2272         printk(KERN_DEBUG "%s: MAC address %02X:%02X:%02X:%02X:%02X:%02X\n",
2273                dev->name, dev->dev_addr[0], dev->dev_addr[1],
2274                dev->dev_addr[2], dev->dev_addr[3], dev->dev_addr[4],
2275                dev->dev_addr[5]);
2276
2277         /* Get the station name */
2278         err = hermes_read_ltv(hw, USER_BAP, HERMES_RID_CNFOWNNAME,
2279                               sizeof(nickbuf), &reclen, &nickbuf);
2280         if (err) {
2281                 printk(KERN_ERR "%s: failed to read station name\n",
2282                        dev->name);
2283                 goto out;
2284         }
2285         if (nickbuf.len)
2286                 len = min(IW_ESSID_MAX_SIZE, (int)le16_to_cpu(nickbuf.len));
2287         else
2288                 len = min(IW_ESSID_MAX_SIZE, 2 * reclen);
2289         memcpy(priv->nick, &nickbuf.val, len);
2290         priv->nick[len] = '\0';
2291
2292         printk(KERN_DEBUG "%s: Station name \"%s\"\n", dev->name, priv->nick);
2293
2294         err = orinoco_allocate_fid(dev);
2295         if (err) {
2296                 printk(KERN_ERR "%s: failed to allocate NIC buffer!\n",
2297                        dev->name);
2298                 goto out;
2299         }
2300
2301         /* Get allowed channels */
2302         err = hermes_read_wordrec(hw, USER_BAP, HERMES_RID_CHANNELLIST,
2303                                   &priv->channel_mask);
2304         if (err) {
2305                 printk(KERN_ERR "%s: failed to read channel list!\n",
2306                        dev->name);
2307                 goto out;
2308         }
2309
2310         /* Get initial AP density */
2311         err = hermes_read_wordrec(hw, USER_BAP, HERMES_RID_CNFSYSTEMSCALE,
2312                                   &priv->ap_density);
2313         if (err || priv->ap_density < 1 || priv->ap_density > 3) {
2314                 priv->has_sensitivity = 0;
2315         }
2316
2317         /* Get initial RTS threshold */
2318         err = hermes_read_wordrec(hw, USER_BAP, HERMES_RID_CNFRTSTHRESHOLD,
2319                                   &priv->rts_thresh);
2320         if (err) {
2321                 printk(KERN_ERR "%s: failed to read RTS threshold!\n",
2322                        dev->name);
2323                 goto out;
2324         }
2325
2326         /* Get initial fragmentation settings */
2327         if (priv->has_mwo)
2328                 err = hermes_read_wordrec(hw, USER_BAP,
2329                                           HERMES_RID_CNFMWOROBUST_AGERE,
2330                                           &priv->mwo_robust);
2331         else
2332                 err = hermes_read_wordrec(hw, USER_BAP, HERMES_RID_CNFFRAGMENTATIONTHRESHOLD,
2333                                           &priv->frag_thresh);
2334         if (err) {
2335                 printk(KERN_ERR "%s: failed to read fragmentation settings!\n",
2336                        dev->name);
2337                 goto out;
2338         }
2339
2340         /* Power management setup */
2341         if (priv->has_pm) {
2342                 priv->pm_on = 0;
2343                 priv->pm_mcast = 1;
2344                 err = hermes_read_wordrec(hw, USER_BAP,
2345                                           HERMES_RID_CNFMAXSLEEPDURATION,
2346                                           &priv->pm_period);
2347                 if (err) {
2348                         printk(KERN_ERR "%s: failed to read power management period!\n",
2349                                dev->name);
2350                         goto out;
2351                 }
2352                 err = hermes_read_wordrec(hw, USER_BAP,
2353                                           HERMES_RID_CNFPMHOLDOVERDURATION,
2354                                           &priv->pm_timeout);
2355                 if (err) {
2356                         printk(KERN_ERR "%s: failed to read power management timeout!\n",
2357                                dev->name);
2358                         goto out;
2359                 }
2360         }
2361
2362         /* Preamble setup */
2363         if (priv->has_preamble) {
2364                 err = hermes_read_wordrec(hw, USER_BAP,
2365                                           HERMES_RID_CNFPREAMBLE_SYMBOL,
2366                                           &priv->preamble);
2367                 if (err)
2368                         goto out;
2369         }
2370                 
2371         /* Set up the default configuration */
2372         priv->iw_mode = IW_MODE_INFRA;
2373         /* By default use IEEE/IBSS ad-hoc mode if we have it */
2374         priv->prefer_port3 = priv->has_port3 && (! priv->has_ibss);
2375         set_port_type(priv);
2376         priv->channel = 0; /* use firmware default */
2377
2378         priv->promiscuous = 0;
2379         priv->wep_on = 0;
2380         priv->tx_key = 0;
2381
2382         /* Make the hardware available, as long as it hasn't been
2383          * removed elsewhere (e.g. by PCMCIA hot unplug) */
2384         spin_lock_irq(&priv->lock);
2385         priv->hw_unavailable--;
2386         spin_unlock_irq(&priv->lock);
2387
2388         printk(KERN_DEBUG "%s: ready\n", dev->name);
2389
2390  out:
2391         return err;
2392 }
2393
2394 struct net_device *alloc_orinocodev(int sizeof_card,
2395                                     int (*hard_reset)(struct orinoco_private *))
2396 {
2397         struct net_device *dev;
2398         struct orinoco_private *priv;
2399
2400         dev = alloc_etherdev(sizeof(struct orinoco_private) + sizeof_card);
2401         if (! dev)
2402                 return NULL;
2403         priv = netdev_priv(dev);
2404         priv->ndev = dev;
2405         if (sizeof_card)
2406                 priv->card = (void *)((unsigned long)priv
2407                                       + sizeof(struct orinoco_private));
2408         else
2409                 priv->card = NULL;
2410
2411         /* Setup / override net_device fields */
2412         dev->init = orinoco_init;
2413         dev->hard_start_xmit = orinoco_xmit;
2414         dev->tx_timeout = orinoco_tx_timeout;
2415         dev->watchdog_timeo = HZ; /* 1 second timeout */
2416         dev->get_stats = orinoco_get_stats;
2417         dev->ethtool_ops = &orinoco_ethtool_ops;
2418         dev->wireless_handlers = (struct iw_handler_def *)&orinoco_handler_def;
2419 #ifdef WIRELESS_SPY
2420         priv->wireless_data.spy_data = &priv->spy_data;
2421         dev->wireless_data = &priv->wireless_data;
2422 #endif
2423         dev->change_mtu = orinoco_change_mtu;
2424         dev->set_multicast_list = orinoco_set_multicast_list;
2425         /* we use the default eth_mac_addr for setting the MAC addr */
2426
2427         /* Set up default callbacks */
2428         dev->open = orinoco_open;
2429         dev->stop = orinoco_stop;
2430         priv->hard_reset = hard_reset;
2431
2432         spin_lock_init(&priv->lock);
2433         priv->open = 0;
2434         priv->hw_unavailable = 1; /* orinoco_init() must clear this
2435                                    * before anything else touches the
2436                                    * hardware */
2437         INIT_WORK(&priv->reset_work, (void (*)(void *))orinoco_reset, dev);
2438         INIT_WORK(&priv->join_work, (void (*)(void *))orinoco_join_ap, dev);
2439         INIT_WORK(&priv->wevent_work, (void (*)(void *))orinoco_send_wevents, dev);
2440
2441         netif_carrier_off(dev);
2442         priv->last_linkstatus = 0xffff;
2443
2444         return dev;
2445
2446 }
2447
2448 void free_orinocodev(struct net_device *dev)
2449 {
2450         struct orinoco_private *priv = netdev_priv(dev);
2451
2452         kfree(priv->scan_result);
2453         free_netdev(dev);
2454 }
2455
2456 /********************************************************************/
2457 /* Wireless extensions                                              */
2458 /********************************************************************/
2459
2460 static int orinoco_hw_get_essid(struct orinoco_private *priv, int *active,
2461                                 char buf[IW_ESSID_MAX_SIZE+1])
2462 {
2463         hermes_t *hw = &priv->hw;
2464         int err = 0;
2465         struct hermes_idstring essidbuf;
2466         char *p = (char *)(&essidbuf.val);
2467         int len;
2468         unsigned long flags;
2469
2470         if (orinoco_lock(priv, &flags) != 0)
2471                 return -EBUSY;
2472
2473         if (strlen(priv->desired_essid) > 0) {
2474                 /* We read the desired SSID from the hardware rather
2475                    than from priv->desired_essid, just in case the
2476                    firmware is allowed to change it on us. I'm not
2477                    sure about this */
2478                 /* My guess is that the OWNSSID should always be whatever
2479                  * we set to the card, whereas CURRENT_SSID is the one that
2480                  * may change... - Jean II */
2481                 u16 rid;
2482
2483                 *active = 1;
2484
2485                 rid = (priv->port_type == 3) ? HERMES_RID_CNFOWNSSID :
2486                         HERMES_RID_CNFDESIREDSSID;
2487                 
2488                 err = hermes_read_ltv(hw, USER_BAP, rid, sizeof(essidbuf),
2489                                       NULL, &essidbuf);
2490                 if (err)
2491                         goto fail_unlock;
2492         } else {
2493                 *active = 0;
2494
2495                 err = hermes_read_ltv(hw, USER_BAP, HERMES_RID_CURRENTSSID,
2496                                       sizeof(essidbuf), NULL, &essidbuf);
2497                 if (err)
2498                         goto fail_unlock;
2499         }
2500
2501         len = le16_to_cpu(essidbuf.len);
2502         BUG_ON(len > IW_ESSID_MAX_SIZE);
2503
2504         memset(buf, 0, IW_ESSID_MAX_SIZE+1);
2505         memcpy(buf, p, len);
2506         buf[len] = '\0';
2507
2508  fail_unlock:
2509         orinoco_unlock(priv, &flags);
2510
2511         return err;       
2512 }
2513
2514 static long orinoco_hw_get_freq(struct orinoco_private *priv)
2515 {
2516         
2517         hermes_t *hw = &priv->hw;
2518         int err = 0;
2519         u16 channel;
2520         long freq = 0;
2521         unsigned long flags;
2522
2523         if (orinoco_lock(priv, &flags) != 0)
2524                 return -EBUSY;
2525         
2526         err = hermes_read_wordrec(hw, USER_BAP, HERMES_RID_CURRENTCHANNEL, &channel);
2527         if (err)
2528                 goto out;
2529
2530         /* Intersil firmware 1.3.5 returns 0 when the interface is down */
2531         if (channel == 0) {
2532                 err = -EBUSY;
2533                 goto out;
2534         }
2535
2536         if ( (channel < 1) || (channel > NUM_CHANNELS) ) {
2537                 printk(KERN_WARNING "%s: Channel out of range (%d)!\n",
2538                        priv->ndev->name, channel);
2539                 err = -EBUSY;
2540                 goto out;
2541
2542         }
2543         freq = channel_frequency[channel-1] * 100000;
2544
2545  out:
2546         orinoco_unlock(priv, &flags);
2547
2548         if (err > 0)
2549                 err = -EBUSY;
2550         return err ? err : freq;
2551 }
2552
2553 static int orinoco_hw_get_bitratelist(struct orinoco_private *priv,
2554                                       int *numrates, s32 *rates, int max)
2555 {
2556         hermes_t *hw = &priv->hw;
2557         struct hermes_idstring list;
2558         unsigned char *p = (unsigned char *)&list.val;
2559         int err = 0;
2560         int num;
2561         int i;
2562         unsigned long flags;
2563
2564         if (orinoco_lock(priv, &flags) != 0)
2565                 return -EBUSY;
2566
2567         err = hermes_read_ltv(hw, USER_BAP, HERMES_RID_SUPPORTEDDATARATES,
2568                               sizeof(list), NULL, &list);
2569         orinoco_unlock(priv, &flags);
2570
2571         if (err)
2572                 return err;
2573         
2574         num = le16_to_cpu(list.len);
2575         *numrates = num;
2576         num = min(num, max);
2577
2578         for (i = 0; i < num; i++) {
2579                 rates[i] = (p[i] & 0x7f) * 500000; /* convert to bps */
2580         }
2581
2582         return 0;
2583 }
2584
2585 static int orinoco_ioctl_getname(struct net_device *dev,
2586                                  struct iw_request_info *info,
2587                                  char *name,
2588                                  char *extra)
2589 {
2590         struct orinoco_private *priv = netdev_priv(dev);
2591         int numrates;
2592         int err;
2593
2594         err = orinoco_hw_get_bitratelist(priv, &numrates, NULL, 0);
2595
2596         if (!err && (numrates > 2))
2597                 strcpy(name, "IEEE 802.11b");
2598         else
2599                 strcpy(name, "IEEE 802.11-DS");
2600
2601         return 0;
2602 }
2603
2604 static int orinoco_ioctl_setwap(struct net_device *dev,
2605                                 struct iw_request_info *info,
2606                                 struct sockaddr *ap_addr,
2607                                 char *extra)
2608 {
2609         struct orinoco_private *priv = netdev_priv(dev);
2610         int err = -EINPROGRESS;         /* Call commit handler */
2611         unsigned long flags;
2612         static const u8 off_addr[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
2613         static const u8 any_addr[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
2614
2615         if (orinoco_lock(priv, &flags) != 0)
2616                 return -EBUSY;
2617
2618         /* Enable automatic roaming - no sanity checks are needed */
2619         if (memcmp(&ap_addr->sa_data, off_addr, ETH_ALEN) == 0 ||
2620             memcmp(&ap_addr->sa_data, any_addr, ETH_ALEN) == 0) {
2621                 priv->bssid_fixed = 0;
2622                 memset(priv->desired_bssid, 0, ETH_ALEN);
2623
2624                 /* "off" means keep existing connection */
2625                 if (ap_addr->sa_data[0] == 0) {
2626                         __orinoco_hw_set_wap(priv);
2627                         err = 0;
2628                 }
2629                 goto out;
2630         }
2631
2632         if (priv->firmware_type == FIRMWARE_TYPE_AGERE) {
2633                 printk(KERN_WARNING "%s: Lucent/Agere firmware doesn't "
2634                        "support manual roaming\n",
2635                        dev->name);
2636                 err = -EOPNOTSUPP;
2637                 goto out;
2638         }
2639
2640         if (priv->iw_mode != IW_MODE_INFRA) {
2641                 printk(KERN_WARNING "%s: Manual roaming supported only in "
2642                        "managed mode\n", dev->name);
2643                 err = -EOPNOTSUPP;
2644                 goto out;
2645         }
2646
2647         /* Intersil firmware hangs without Desired ESSID */
2648         if (priv->firmware_type == FIRMWARE_TYPE_INTERSIL &&
2649             strlen(priv->desired_essid) == 0) {
2650                 printk(KERN_WARNING "%s: Desired ESSID must be set for "
2651                        "manual roaming\n", dev->name);
2652                 err = -EOPNOTSUPP;
2653                 goto out;
2654         }
2655
2656         /* Finally, enable manual roaming */
2657         priv->bssid_fixed = 1;
2658         memcpy(priv->desired_bssid, &ap_addr->sa_data, ETH_ALEN);
2659
2660  out:
2661         orinoco_unlock(priv, &flags);
2662         return err;
2663 }
2664
2665 static int orinoco_ioctl_getwap(struct net_device *dev,
2666                                 struct iw_request_info *info,
2667                                 struct sockaddr *ap_addr,
2668                                 char *extra)
2669 {
2670         struct orinoco_private *priv = netdev_priv(dev);
2671
2672         hermes_t *hw = &priv->hw;
2673         int err = 0;
2674         unsigned long flags;
2675
2676         if (orinoco_lock(priv, &flags) != 0)
2677                 return -EBUSY;
2678
2679         ap_addr->sa_family = ARPHRD_ETHER;
2680         err = hermes_read_ltv(hw, USER_BAP, HERMES_RID_CURRENTBSSID,
2681                               ETH_ALEN, NULL, ap_addr->sa_data);
2682
2683         orinoco_unlock(priv, &flags);
2684
2685         return err;
2686 }
2687
2688 static int orinoco_ioctl_setmode(struct net_device *dev,
2689                                  struct iw_request_info *info,
2690                                  u32 *mode,
2691                                  char *extra)
2692 {
2693         struct orinoco_private *priv = netdev_priv(dev);
2694         int err = -EINPROGRESS;         /* Call commit handler */
2695         unsigned long flags;
2696
2697         if (priv->iw_mode == *mode)
2698                 return 0;
2699
2700         if (orinoco_lock(priv, &flags) != 0)
2701                 return -EBUSY;
2702
2703         switch (*mode) {
2704         case IW_MODE_ADHOC:
2705                 if (!priv->has_ibss && !priv->has_port3)
2706                         err = -EOPNOTSUPP;
2707                 break;
2708
2709         case IW_MODE_INFRA:
2710                 break;
2711
2712         case IW_MODE_MONITOR:
2713                 if (priv->broken_monitor && !force_monitor) {
2714                         printk(KERN_WARNING "%s: Monitor mode support is "
2715                                "buggy in this firmware, not enabling\n",
2716                                dev->name);
2717                         err = -EOPNOTSUPP;
2718                 }
2719                 break;
2720
2721         default:
2722                 err = -EOPNOTSUPP;
2723                 break;
2724         }
2725
2726         if (err == -EINPROGRESS) {
2727                 priv->iw_mode = *mode;
2728                 set_port_type(priv);
2729         }
2730
2731         orinoco_unlock(priv, &flags);
2732
2733         return err;
2734 }
2735
2736 static int orinoco_ioctl_getmode(struct net_device *dev,
2737                                  struct iw_request_info *info,
2738                                  u32 *mode,
2739                                  char *extra)
2740 {
2741         struct orinoco_private *priv = netdev_priv(dev);
2742
2743         *mode = priv->iw_mode;
2744         return 0;
2745 }
2746
2747 static int orinoco_ioctl_getiwrange(struct net_device *dev,
2748                                     struct iw_request_info *info,
2749                                     struct iw_point *rrq,
2750                                     char *extra)
2751 {
2752         struct orinoco_private *priv = netdev_priv(dev);
2753         int err = 0;
2754         struct iw_range *range = (struct iw_range *) extra;
2755         int numrates;
2756         int i, k;
2757
2758         rrq->length = sizeof(struct iw_range);
2759         memset(range, 0, sizeof(struct iw_range));
2760
2761         range->we_version_compiled = WIRELESS_EXT;
2762         range->we_version_source = 14;
2763
2764         /* Set available channels/frequencies */
2765         range->num_channels = NUM_CHANNELS;
2766         k = 0;
2767         for (i = 0; i < NUM_CHANNELS; i++) {
2768                 if (priv->channel_mask & (1 << i)) {
2769                         range->freq[k].i = i + 1;
2770                         range->freq[k].m = channel_frequency[i] * 100000;
2771                         range->freq[k].e = 1;
2772                         k++;
2773                 }
2774                 
2775                 if (k >= IW_MAX_FREQUENCIES)
2776                         break;
2777         }
2778         range->num_frequency = k;
2779         range->sensitivity = 3;
2780
2781         if (priv->has_wep) {
2782                 range->max_encoding_tokens = ORINOCO_MAX_KEYS;
2783                 range->encoding_size[0] = SMALL_KEY_SIZE;
2784                 range->num_encoding_sizes = 1;
2785
2786                 if (priv->has_big_wep) {
2787                         range->encoding_size[1] = LARGE_KEY_SIZE;
2788                         range->num_encoding_sizes = 2;
2789                 }
2790         }
2791
2792         if ((priv->iw_mode == IW_MODE_ADHOC) && (!SPY_NUMBER(priv))){
2793                 /* Quality stats meaningless in ad-hoc mode */
2794         } else {
2795                 range->max_qual.qual = 0x8b - 0x2f;
2796                 range->max_qual.level = 0x2f - 0x95 - 1;
2797                 range->max_qual.noise = 0x2f - 0x95 - 1;
2798                 /* Need to get better values */
2799                 range->avg_qual.qual = 0x24;
2800                 range->avg_qual.level = 0xC2;
2801                 range->avg_qual.noise = 0x9E;
2802         }
2803
2804         err = orinoco_hw_get_bitratelist(priv, &numrates,
2805                                          range->bitrate, IW_MAX_BITRATES);
2806         if (err)
2807                 return err;
2808         range->num_bitrates = numrates;
2809
2810         /* Set an indication of the max TCP throughput in bit/s that we can
2811          * expect using this interface. May be use for QoS stuff...
2812          * Jean II */
2813         if (numrates > 2)
2814                 range->throughput = 5 * 1000 * 1000;    /* ~5 Mb/s */
2815         else
2816                 range->throughput = 1.5 * 1000 * 1000;  /* ~1.5 Mb/s */
2817
2818         range->min_rts = 0;
2819         range->max_rts = 2347;
2820         range->min_frag = 256;
2821         range->max_frag = 2346;
2822
2823         range->min_pmp = 0;
2824         range->max_pmp = 65535000;
2825         range->min_pmt = 0;
2826         range->max_pmt = 65535 * 1000;  /* ??? */
2827         range->pmp_flags = IW_POWER_PERIOD;
2828         range->pmt_flags = IW_POWER_TIMEOUT;
2829         range->pm_capa = IW_POWER_PERIOD | IW_POWER_TIMEOUT | IW_POWER_UNICAST_R;
2830
2831         range->retry_capa = IW_RETRY_LIMIT | IW_RETRY_LIFETIME;
2832         range->retry_flags = IW_RETRY_LIMIT;
2833         range->r_time_flags = IW_RETRY_LIFETIME;
2834         range->min_retry = 0;
2835         range->max_retry = 65535;       /* ??? */
2836         range->min_r_time = 0;
2837         range->max_r_time = 65535 * 1000;       /* ??? */
2838
2839         /* Event capability (kernel) */
2840         IW_EVENT_CAPA_SET_KERNEL(range->event_capa);
2841         /* Event capability (driver) */
2842         IW_EVENT_CAPA_SET(range->event_capa, SIOCGIWTHRSPY);
2843         IW_EVENT_CAPA_SET(range->event_capa, SIOCGIWAP);
2844         IW_EVENT_CAPA_SET(range->event_capa, SIOCGIWSCAN);
2845         IW_EVENT_CAPA_SET(range->event_capa, IWEVTXDROP);
2846
2847         return 0;
2848 }
2849
2850 static int orinoco_ioctl_setiwencode(struct net_device *dev,
2851                                      struct iw_request_info *info,
2852                                      struct iw_point *erq,
2853                                      char *keybuf)
2854 {
2855         struct orinoco_private *priv = netdev_priv(dev);
2856         int index = (erq->flags & IW_ENCODE_INDEX) - 1;
2857         int setindex = priv->tx_key;
2858         int enable = priv->wep_on;
2859         int restricted = priv->wep_restrict;
2860         u16 xlen = 0;
2861         int err = -EINPROGRESS;         /* Call commit handler */
2862         unsigned long flags;
2863
2864         if (! priv->has_wep)
2865                 return -EOPNOTSUPP;
2866
2867         if (erq->pointer) {
2868                 /* We actually have a key to set - check its length */
2869                 if (erq->length > LARGE_KEY_SIZE)
2870                         return -E2BIG;
2871
2872                 if ( (erq->length > SMALL_KEY_SIZE) && !priv->has_big_wep )
2873                         return -E2BIG;
2874         }
2875
2876         if (orinoco_lock(priv, &flags) != 0)
2877                 return -EBUSY;
2878
2879         if (erq->pointer) {
2880                 if ((index < 0) || (index >= ORINOCO_MAX_KEYS))
2881                         index = priv->tx_key;
2882
2883                 /* Adjust key length to a supported value */
2884                 if (erq->length > SMALL_KEY_SIZE) {
2885                         xlen = LARGE_KEY_SIZE;
2886                 } else if (erq->length > 0) {
2887                         xlen = SMALL_KEY_SIZE;
2888                 } else
2889                         xlen = 0;
2890
2891                 /* Switch on WEP if off */
2892                 if ((!enable) && (xlen > 0)) {
2893                         setindex = index;
2894                         enable = 1;
2895                 }
2896         } else {
2897                 /* Important note : if the user do "iwconfig eth0 enc off",
2898                  * we will arrive there with an index of -1. This is valid
2899                  * but need to be taken care off... Jean II */
2900                 if ((index < 0) || (index >= ORINOCO_MAX_KEYS)) {
2901                         if((index != -1) || (erq->flags == 0)) {
2902                                 err = -EINVAL;
2903                                 goto out;
2904                         }
2905                 } else {
2906                         /* Set the index : Check that the key is valid */
2907                         if(priv->keys[index].len == 0) {
2908                                 err = -EINVAL;
2909                                 goto out;
2910                         }
2911                         setindex = index;
2912                 }
2913         }
2914
2915         if (erq->flags & IW_ENCODE_DISABLED)
2916                 enable = 0;
2917         if (erq->flags & IW_ENCODE_OPEN)
2918                 restricted = 0;
2919         if (erq->flags & IW_ENCODE_RESTRICTED)
2920                 restricted = 1;
2921
2922         if (erq->pointer) {
2923                 priv->keys[index].len = cpu_to_le16(xlen);
2924                 memset(priv->keys[index].data, 0,
2925                        sizeof(priv->keys[index].data));
2926                 memcpy(priv->keys[index].data, keybuf, erq->length);
2927         }
2928         priv->tx_key = setindex;
2929
2930         /* Try fast key change if connected and only keys are changed */
2931         if (priv->wep_on && enable && (priv->wep_restrict == restricted) &&
2932             netif_carrier_ok(dev)) {
2933                 err = __orinoco_hw_setup_wepkeys(priv);
2934                 /* No need to commit if successful */
2935                 goto out;
2936         }
2937
2938         priv->wep_on = enable;
2939         priv->wep_restrict = restricted;
2940
2941  out:
2942         orinoco_unlock(priv, &flags);
2943
2944         return err;
2945 }
2946
2947 static int orinoco_ioctl_getiwencode(struct net_device *dev,
2948                                      struct iw_request_info *info,
2949                                      struct iw_point *erq,
2950                                      char *keybuf)
2951 {
2952         struct orinoco_private *priv = netdev_priv(dev);
2953         int index = (erq->flags & IW_ENCODE_INDEX) - 1;
2954         u16 xlen = 0;
2955         unsigned long flags;
2956
2957         if (! priv->has_wep)
2958                 return -EOPNOTSUPP;
2959
2960         if (orinoco_lock(priv, &flags) != 0)
2961                 return -EBUSY;
2962
2963         if ((index < 0) || (index >= ORINOCO_MAX_KEYS))
2964                 index = priv->tx_key;
2965
2966         erq->flags = 0;
2967         if (! priv->wep_on)
2968                 erq->flags |= IW_ENCODE_DISABLED;
2969         erq->flags |= index + 1;
2970
2971         if (priv->wep_restrict)
2972                 erq->flags |= IW_ENCODE_RESTRICTED;
2973         else
2974                 erq->flags |= IW_ENCODE_OPEN;
2975
2976         xlen = le16_to_cpu(priv->keys[index].len);
2977
2978         erq->length = xlen;
2979
2980         memcpy(keybuf, priv->keys[index].data, ORINOCO_MAX_KEY_SIZE);
2981
2982         orinoco_unlock(priv, &flags);
2983         return 0;
2984 }
2985
2986 static int orinoco_ioctl_setessid(struct net_device *dev,
2987                                   struct iw_request_info *info,
2988                                   struct iw_point *erq,
2989                                   char *essidbuf)
2990 {
2991         struct orinoco_private *priv = netdev_priv(dev);
2992         unsigned long flags;
2993
2994         /* Note : ESSID is ignored in Ad-Hoc demo mode, but we can set it
2995          * anyway... - Jean II */
2996
2997         /* Hum... Should not use Wireless Extension constant (may change),
2998          * should use our own... - Jean II */
2999         if (erq->length > IW_ESSID_MAX_SIZE)
3000                 return -E2BIG;
3001
3002         if (orinoco_lock(priv, &flags) != 0)
3003                 return -EBUSY;
3004
3005         /* NULL the string (for NULL termination & ESSID = ANY) - Jean II */
3006         memset(priv->desired_essid, 0, sizeof(priv->desired_essid));
3007
3008         /* If not ANY, get the new ESSID */
3009         if (erq->flags) {
3010                 memcpy(priv->desired_essid, essidbuf, erq->length);
3011         }
3012
3013         orinoco_unlock(priv, &flags);
3014
3015         return -EINPROGRESS;            /* Call commit handler */
3016 }
3017
3018 static int orinoco_ioctl_getessid(struct net_device *dev,
3019                                   struct iw_request_info *info,
3020                                   struct iw_point *erq,
3021                                   char *essidbuf)
3022 {
3023         struct orinoco_private *priv = netdev_priv(dev);
3024         int active;
3025         int err = 0;
3026         unsigned long flags;
3027
3028         if (netif_running(dev)) {
3029                 err = orinoco_hw_get_essid(priv, &active, essidbuf);
3030                 if (err)
3031                         return err;
3032         } else {
3033                 if (orinoco_lock(priv, &flags) != 0)
3034                         return -EBUSY;
3035                 memcpy(essidbuf, priv->desired_essid, IW_ESSID_MAX_SIZE + 1);
3036                 orinoco_unlock(priv, &flags);
3037         }
3038
3039         erq->flags = 1;
3040         erq->length = strlen(essidbuf) + 1;
3041
3042         return 0;
3043 }
3044
3045 static int orinoco_ioctl_setnick(struct net_device *dev,
3046                                  struct iw_request_info *info,
3047                                  struct iw_point *nrq,
3048                                  char *nickbuf)
3049 {
3050         struct orinoco_private *priv = netdev_priv(dev);
3051         unsigned long flags;
3052
3053         if (nrq->length > IW_ESSID_MAX_SIZE)
3054                 return -E2BIG;
3055
3056         if (orinoco_lock(priv, &flags) != 0)
3057                 return -EBUSY;
3058
3059         memset(priv->nick, 0, sizeof(priv->nick));
3060         memcpy(priv->nick, nickbuf, nrq->length);
3061
3062         orinoco_unlock(priv, &flags);
3063
3064         return -EINPROGRESS;            /* Call commit handler */
3065 }
3066
3067 static int orinoco_ioctl_getnick(struct net_device *dev,
3068                                  struct iw_request_info *info,
3069                                  struct iw_point *nrq,
3070                                  char *nickbuf)
3071 {
3072         struct orinoco_private *priv = netdev_priv(dev);
3073         unsigned long flags;
3074
3075         if (orinoco_lock(priv, &flags) != 0)
3076                 return -EBUSY;
3077
3078         memcpy(nickbuf, priv->nick, IW_ESSID_MAX_SIZE+1);
3079         orinoco_unlock(priv, &flags);
3080
3081         nrq->length = strlen(nickbuf)+1;
3082
3083         return 0;
3084 }
3085
3086 static int orinoco_ioctl_setfreq(struct net_device *dev,
3087                                  struct iw_request_info *info,
3088                                  struct iw_freq *frq,
3089                                  char *extra)
3090 {
3091         struct orinoco_private *priv = netdev_priv(dev);
3092         int chan = -1;
3093         unsigned long flags;
3094         int err = -EINPROGRESS;         /* Call commit handler */
3095
3096         /* In infrastructure mode the AP sets the channel */
3097         if (priv->iw_mode == IW_MODE_INFRA)
3098                 return -EBUSY;
3099
3100         if ( (frq->e == 0) && (frq->m <= 1000) ) {
3101                 /* Setting by channel number */
3102                 chan = frq->m;
3103         } else {
3104                 /* Setting by frequency - search the table */
3105                 int mult = 1;
3106                 int i;
3107
3108                 for (i = 0; i < (6 - frq->e); i++)
3109                         mult *= 10;
3110
3111                 for (i = 0; i < NUM_CHANNELS; i++)
3112                         if (frq->m == (channel_frequency[i] * mult))
3113                                 chan = i+1;
3114         }
3115
3116         if ( (chan < 1) || (chan > NUM_CHANNELS) ||
3117              ! (priv->channel_mask & (1 << (chan-1)) ) )
3118                 return -EINVAL;
3119
3120         if (orinoco_lock(priv, &flags) != 0)
3121                 return -EBUSY;
3122
3123         priv->channel = chan;
3124         if (priv->iw_mode == IW_MODE_MONITOR) {
3125                 /* Fast channel change - no commit if successful */
3126                 hermes_t *hw = &priv->hw;
3127                 err = hermes_docmd_wait(hw, HERMES_CMD_TEST |
3128                                             HERMES_TEST_SET_CHANNEL,
3129