[802.11] Expose channel-changing functionality
[people/oremanj/gpxe.git] / src / net / net80211.c
1 /*
2  * The gPXE 802.11 MAC layer.
3  *
4  * Copyright (c) 2009 Joshua Oreman <oremanj@rwcr.net>.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation; either version 2 of the
9  * License, or any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 FILE_LICENCE ( GPL2_OR_LATER );
22
23 #include <stdio.h>
24 #include <string.h>
25 #include <byteswap.h>
26 #include <stdlib.h>
27 #include <gpxe/settings.h>
28 #include <gpxe/if_arp.h>
29 #include <gpxe/ethernet.h>
30 #include <gpxe/ieee80211.h>
31 #include <gpxe/netdevice.h>
32 #include <gpxe/net80211.h>
33 #include <gpxe/timer.h>
34 #include <gpxe/nap.h>
35 #include <unistd.h>
36 #include <errno.h>
37
38 /* Bring in IWMGMT_CMD here if enabled; the commands are useless if
39    nothing else requires wireless. */
40 #include <config/general.h>
41 #ifdef IWMGMT_CMD
42 REQUIRE_OBJECT ( iwmgmt_cmd );
43 #endif
44
45 /* Disambiguate the EINVAL's a bit */
46 #define EINVAL_PKT_TOO_SHORT    ( EINVAL | EUNIQ_01 )
47 #define EINVAL_PKT_VERSION      ( EINVAL | EUNIQ_02 )
48 #define EINVAL_PKT_NOT_DATA     ( EINVAL | EUNIQ_03 )
49 #define EINVAL_PKT_NOT_FROMDS   ( EINVAL | EUNIQ_04 )
50 #define EINVAL_PKT_LLC_HEADER   ( EINVAL | EUNIQ_05 )
51 #define EINVAL_CRYPTO_REQUEST   ( EINVAL | EUNIQ_06 )
52 #define EINVAL_ACTIVE_SCAN      ( EINVAL | EUNIQ_07 )
53
54 /*
55  * 802.11 error codes: The AP can give us a status code explaining why
56  * authentication failed, or a reason code explaining why we were
57  * deauthenticated/disassociated. These codes range from 0-63 (the
58  * field is 16 bits wide, but only up to 45 or so are defined yet; we
59  * allow up to 63 for extensibility). This is encoded into an error
60  * code as such:
61  *
62  *                                      status & 0x1f goes here --vv--
63  *   Status code 0-31:  ECONNREFUSED | EUNIQ_(status & 0x1f) (0e1a6038)
64  *   Status code 32-63: EHOSTUNREACH | EUNIQ_(status & 0x1f) (171a6011)
65  *   Reason code 0-31:  ECONNRESET | EUNIQ_(reason & 0x1f)   (0f1a6039)
66  *   Reason code 32-63: ENETRESET | EUNIQ_(reason & 0x1f)    (271a6001)
67  *
68  * The POSIX error codes more or less convey the appropriate message
69  * (status codes occur when we can't associate at all, reason codes
70  * when we lose association unexpectedly) and let us extract the
71  * complete 802.11 error code from the rc value.
72  */
73
74 #define E80211_STATUS( stat )  ( ((stat & 0x20)? EHOSTUNREACH : ECONNREFUSED) \
75                                         | ((stat & 0x1f) << 8) )
76 #define E80211_REASON( reas )  ( ((reas & 0x20)? ENETRESET : ECONNRESET) \
77                                         | ((reas & 0x1f) << 8) )
78
79
80 /** List of 802.11 devices */
81 static struct list_head net80211_devices = LIST_HEAD_INIT ( net80211_devices );
82
83 /** The network name to associate with
84  *
85  * If this is blank, we scan for all networks and use the one with the
86  * greatest signal strength.
87  */
88 struct setting net80211_ssid_setting __setting = {
89         .name = "ssid",
90         .description = "802.11 SSID (network name)",
91         .type = &setting_type_string,
92 };
93
94 /** Whether to use active scanning
95  *
96  * In order to associate with a hidden SSID, it's necessary to use an
97  * active scan (send probe packets). If this setting is nonzero, an
98  * active scan on the 2.4GHz band will be used to associate.
99  */
100 struct setting net80211_active_setting __setting = {
101         .name = "active-scan",
102         .description = "Use an active scan during 802.11 association",
103         .type = &setting_type_int8,
104 };
105
106 /** Set of device operations that does nothing */
107 static struct net80211_device_operations net80211_null_ops;
108
109 /** Information associated with a received management packet
110  *
111  * This is used to keep beacon signal strengths in a parallel queue to
112  * the beacons themselves.
113  */
114 struct net80211_rx_info {
115         int signal;
116         struct list_head list;
117 };
118
119 /** Context for a probe operation */
120 struct net80211_probe_ctx {
121         /** 802.11 device to probe on */
122         struct net80211_device *dev;
123
124         /** Value of keep_mgmt before probe was started */
125         int old_keep_mgmt;
126
127         /** If scanning actively, pointer to probe packet to send */
128         struct io_buffer *probe;
129
130         /** If non-"", the ESSID to limit ourselves to */
131         const char *essid;
132
133         /** Time probe was started */
134         u32 ticks_start;
135
136         /** Time last useful beacon was received */
137         u32 ticks_beacon;
138
139         /** Time channel was last changed */
140         u32 ticks_channel;
141
142         /** Time to stay on each channel */
143         u32 hop_time;
144
145         /** Channels to hop by when changing channel */
146         int hop_step;
147
148         /** List of best beacons for each network found so far */
149         struct list_head *beacons;
150 };
151
152 /** Context for the association task */
153 struct net80211_assoc_ctx {
154         /** Next authentication method to try using */
155         int method;
156
157         /** Time (in ticks) of the last sent association-related packet */
158         int last_packet;
159
160         /** Number of times we have tried sending it */
161         int times_tried;
162 };
163
164 static u16 net80211_duration ( struct net80211_device *dev, int bytes );
165 static int net80211_ll_push ( struct net_device *netdev,
166                               struct io_buffer *iobuf, const void *ll_dest,
167                               const void *ll_source, uint16_t net_proto );
168 static int net80211_ll_pull ( struct net_device *netdev,
169                               struct io_buffer *iobuf, const void **ll_dest,
170                               const void **ll_source, uint16_t * net_proto );
171 static int net80211_ll_mc_hash ( unsigned int af, const void *net_addr,
172                                  void *ll_addr );
173
174 static void net80211_add_channels ( struct net80211_device *dev, int start,
175                                     int len, int txpower );
176 static int net80211_process_capab ( struct net80211_device *dev,
177                                     u16 capab );
178 static int net80211_process_ie ( struct net80211_device *dev,
179                                  union ieee80211_ie *ie, void *ie_end );
180 static union ieee80211_ie *
181 net80211_marshal_request_info ( struct net80211_device *dev,
182                                 union ieee80211_ie *ie );
183
184 static void net80211_step_associate ( struct process *proc );
185 static void net80211_set_rtscts_rate ( struct net80211_device *dev );
186 static void net80211_set_rate_intelligently ( struct net80211_device *dev );
187 static void net80211_handle_auth ( struct net80211_device *dev,
188                                    struct io_buffer *iob );
189 static void net80211_handle_assoc_reply ( struct net80211_device *dev,
190                                           struct io_buffer *iob );
191 static int net80211_send_disassoc ( struct net80211_device *dev, int reason );
192 static void net80211_handle_mgmt ( struct net80211_device *dev,
193                                    struct io_buffer *iob, int signal );
194
195 static void net80211_free_frags ( struct net80211_device *dev, int fcid );
196 static struct io_buffer *net80211_accum_frags ( struct net80211_device *dev,
197                                                 int fcid, int nfrags, int size );
198 static void net80211_rx_frag ( struct net80211_device *dev,
199                                struct io_buffer *iob, int signal );
200
201 static int net80211_check_ssid_update ( void );
202
203 /** 802.11 settings applicator
204  *
205  * When the SSID is changed, this will cause any open devices to
206  * re-associate.
207  */
208 struct settings_applicator net80211_ssid_applicator __settings_applicator = {
209         .apply = net80211_check_ssid_update,
210 };
211
212 /* ---------- net_device wrapper ---------- */
213
214 /**
215  * Open 802.11 device and start association
216  *
217  * @v netdev    Wrapping network device
218  * @ret rc      Return status code
219  *
220  * This sets up a default conservative set of channels for probing,
221  * and starts the auto-association task unless the @c
222  * NET80211_NO_ASSOC flag is set in the wrapped 802.11 device's @c
223  * state field.
224  */
225 static int net80211_netdev_open ( struct net_device *netdev )
226 {
227         struct net80211_device *dev = netdev->priv;
228         int rc = 0;
229
230         /* In case someone tries to transmit before we set link-up, we
231            need to at least be in a consistent enough state not to
232            crash. */
233         net80211_prepare_probe ( dev, dev->hw->bands, 0 );
234
235         if ( dev->op->open )
236                 rc = dev->op->open ( dev );
237
238         if ( rc < 0 )
239                 return rc;
240
241         if ( ! ( dev->state & NET80211_NO_ASSOC ) )
242                 net80211_autoassociate ( dev );
243
244         return 0;
245 }
246
247 /**
248  * Close 802.11 device
249  *
250  * @v netdev    Wrapping network device.
251  *
252  * If the association task is running, this will stop it.
253  */
254 static void net80211_netdev_close ( struct net_device *netdev )
255 {
256         struct net80211_device *dev = netdev->priv;
257
258         if ( dev->state & NET80211_WORKING )
259                 process_del ( &dev->proc_assoc );
260
261         /* Send disassociation frame to AP, to be polite */
262         if ( dev->state & NET80211_ASSOCIATED )
263                 net80211_send_disassoc ( dev, IEEE80211_REASON_LEAVING );
264
265         netdev_link_down ( netdev );
266         dev->state = 0;
267
268         if ( dev->op->close )
269                 dev->op->close ( dev );
270 }
271
272 /**
273  * Transmit packet on 802.11 device
274  *
275  * @v netdev    Wrapping network device
276  * @v iobuf     I/O buffer
277  * @ret rc      Return status code
278  *
279  * If encryption is enabled for the currently associated network, the
280  * packet will be encrypted prior to transmission.
281  */
282 static int net80211_netdev_transmit ( struct net_device *netdev,
283                                       struct io_buffer *iobuf )
284 {
285         struct net80211_device *dev = netdev->priv;
286         int rc = -ENOSYS;
287
288         if ( dev->crypto ) {
289                 struct io_buffer *niob = dev->crypto->encrypt ( dev->crypto,
290                                                                 iobuf );
291                 if ( ! niob )
292                         return -ENOMEM; /* only reason encryption could fail */
293
294                 free_iob ( iobuf );
295                 iobuf = niob;
296         }
297
298         if ( dev->op->transmit )
299                 rc = dev->op->transmit ( dev, iobuf );
300
301         return rc;
302 }
303
304 /**
305  * Poll 802.11 device for received packets and completed transmissions
306  *
307  * @v netdev    Wrapping network device
308  */
309 static void net80211_netdev_poll ( struct net_device *netdev )
310 {
311         struct net80211_device *dev = netdev->priv;
312
313         if ( dev->op->poll )
314                 dev->op->poll ( dev );
315 }
316
317 /**
318  * Enable or disable interrupts for 802.11 device
319  *
320  * @v netdev    Wrapping network device
321  * @v enable    Whether to enable interrupts
322  */
323 static void net80211_netdev_irq ( struct net_device *netdev, int enable )
324 {
325         struct net80211_device *dev = netdev->priv;
326
327         if ( dev->op->irq )
328                 dev->op->irq ( dev, enable );
329 }
330
331 /** Network device operations for a wrapped 802.11 device */
332 static struct net_device_operations net80211_netdev_ops = {
333         .open = net80211_netdev_open,
334         .close = net80211_netdev_close,
335         .transmit = net80211_netdev_transmit,
336         .poll = net80211_netdev_poll,
337         .irq = net80211_netdev_irq,
338 };
339
340 /* ---------- 802.11 link-layer protocol ---------- */
341
342 /** 802.11 broadcast MAC address */
343 static u8 net80211_ll_broadcast[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
344
345 /**
346  * Determine whether a transmission rate uses ERP/OFDM
347  *
348  * @v rate      Rate in 100 kbps units
349  * @ret is_erp  TRUE if the rate is an ERP/OFDM rate
350  *
351  * 802.11b supports rates of 1.0, 2.0, 5.5, and 11.0 Mbps; any other
352  * rate than these on the 2.4GHz spectrum is an ERP (802.11g) rate.
353  */
354 static inline int net80211_rate_is_erp ( u16 rate ) 
355 {
356         if ( rate == 10 || rate == 20 || rate == 55 || rate == 110 )
357                 return 0;
358         return 1;
359 }
360
361
362 /**
363  * Calculate one frame's contribution to 802.11 duration field
364  *
365  * @v dev       802.11 device
366  * @v bytes     Amount of data to calculate duration for
367  * @ret dur     Duration field in microseconds
368  *
369  * To avoid multiple stations attempting to transmit at once, 802.11
370  * provides that every packet shall include a duration field
371  * specifying a length of time for which the wireless medium will be
372  * reserved after it is transmitted. The duration is measured in
373  * microseconds and is calculated with respect to the current
374  * physical-layer parameters of the 802.11 device.
375  *
376  * For an unfragmented data or management frame, or the last fragment
377  * of a fragmented frame, the duration captures only the 10 data bytes
378  * of one ACK; call once with bytes = 10.
379  *
380  * For a fragment of a data or management rame that will be followed
381  * by more fragments, the duration captures an ACK, the following
382  * fragment, and its ACK; add the results of three calls, two with
383  * bytes = 10 and one with bytes set to the next fragment's size.
384  *
385  * For an RTS control frame, the duration captures the responding CTS,
386  * the frame being sent, and its ACK; add the results of three calls,
387  * two with bytes = 10 and one with bytes set to the next frame's size
388  * (assuming unfragmented).
389  *
390  * For a CTS-to-self control frame, the duration captures the frame
391  * being protected and its ACK; add the results of two calls, one with
392  * bytes = 10 and one with bytes set to the next frame's size.
393  *
394  * No other frame types are currently supported by gPXE.
395  */
396 static u16 net80211_duration ( struct net80211_device *dev, int bytes )
397 {
398         struct net80211_channel *chan = &dev->channels[dev->channel];
399         u16 rate = NET80211_RATE_VALUE ( dev->rates[dev->rate] );
400         u32 kbps = rate * 100;
401
402         if ( chan->band == NET80211_BAND_5GHZ || net80211_rate_is_erp ( rate ) ) {
403                 /* OFDM encoding (802.11a/g) */
404                 int bits_per_symbol = ( kbps * 4 ) / 1000;      /* 4us/symbol */
405                 int bits = 22 + ( bytes << 3 ); /* 22-bit PLCP */
406                 int symbols = ( bits + bits_per_symbol - 1 ) / bits_per_symbol;
407
408                 return 16 + 20 + ( symbols * 4 ); /* 16us SIFS, 20us preamble */
409         } else {
410                 /* CCK encoding (802.11b) */
411                 int phy_time = 144 + 48;        /* preamble + PLCP */
412                 int bits = bytes << 3;
413                 int data_time = ( bits * 1000 + kbps - 1 ) / kbps;
414
415                 if ( dev->phy_flags & NET80211_PHY_USE_SHORT_PREAMBLE )
416                         phy_time >>= 1;
417
418                 return 10 + phy_time + data_time; /* 10us SIFS */
419         }
420 }
421
422 /**
423  * Add 802.11 link-layer header
424  *
425  * @v netdev            Wrapping network device
426  * @v iobuf             I/O buffer
427  * @v ll_dest           Link-layer destination address
428  * @v ll_source         Link-layer source address
429  * @v net_proto         Network-layer protocol, in network byte order
430  * @ret rc              Return status code
431  *
432  * This adds both the 802.11 frame header and the 802.2 LLC/SNAP
433  * header used on data packets.
434  *
435  * We also check here for state of the link that would make it invalid
436  * to send a data packet; every data packet must pass through here,
437  * and no non-data packet (e.g. management frame) should.
438  */
439 static int net80211_ll_push ( struct net_device *netdev,
440                               struct io_buffer *iobuf, const void *ll_dest,
441                               const void *ll_source, uint16_t net_proto )
442 {
443         struct net80211_device *dev = netdev->priv;
444         struct ieee80211_frame *hdr = iob_push ( iobuf,
445                                                  IEEE80211_LLC_HEADER_LEN +
446                                                  IEEE80211_TYP_FRAME_HEADER_LEN );
447         struct ieee80211_llc_snap_header *lhdr =
448                 ( void * ) hdr + IEEE80211_TYP_FRAME_HEADER_LEN;
449
450         /* We can't send data packets if we're not associated. */
451         if ( ! netdev_link_ok ( netdev ) ) {
452                 if ( dev->assoc_rc )
453                         return dev->assoc_rc;
454                 return -ENETUNREACH;
455         }
456
457         hdr->fc = IEEE80211_THIS_VERSION | IEEE80211_TYPE_DATA |
458             IEEE80211_STYPE_DATA | IEEE80211_FC_TODS;
459
460         /* We don't send fragmented frames, so duration is the time
461            for an SIFS + 10-byte ACK. */
462         hdr->duration = net80211_duration ( dev, 10 );
463
464         memcpy ( hdr->addr1, dev->bssid, ETH_ALEN );
465         memcpy ( hdr->addr2, ll_source, ETH_ALEN );
466         memcpy ( hdr->addr3, ll_dest, ETH_ALEN );
467
468         hdr->seq = IEEE80211_MAKESEQ ( ++dev->last_tx_seqnr, 0 );
469
470         lhdr->dsap = IEEE80211_LLC_DSAP;
471         lhdr->ssap = IEEE80211_LLC_SSAP;
472         lhdr->ctrl = IEEE80211_LLC_CTRL;
473         memset ( lhdr->oui, 0x00, 3 );
474         lhdr->ethertype = net_proto;
475
476         return 0;
477 }
478
479 /**
480  * Remove 802.11 link-layer header
481  *
482  * @v netdev            Wrapping network device
483  * @v iobuf             I/O buffer
484  * @ret ll_dest         Link-layer destination address
485  * @ret ll_source       Link-layer source 
486  * @ret net_proto       Network-layer protocol, in network byte order
487  * @ret rc              Return status code
488  *
489  * This expects and removes both the 802.11 frame header and the 802.2
490  * LLC/SNAP header that are used on data packets.
491  */
492 static int net80211_ll_pull ( struct net_device *netdev __unused,
493                               struct io_buffer *iobuf,
494                               const void **ll_dest, const void **ll_source,
495                               uint16_t * net_proto )
496 {
497         struct ieee80211_frame *hdr = iobuf->data;
498         struct ieee80211_llc_snap_header *lhdr =
499                 ( void * ) hdr + IEEE80211_TYP_FRAME_HEADER_LEN;
500
501         /* Bunch of sanity checks */
502         if ( iob_len ( iobuf ) < IEEE80211_TYP_FRAME_HEADER_LEN +
503              IEEE80211_LLC_HEADER_LEN ) {
504                 DBGC ( netdev->priv, "802.11 %p packet too short (%zd bytes)\n",
505                        netdev->priv, iob_len ( iobuf ) );
506                 return -EINVAL_PKT_TOO_SHORT;
507         }
508
509         if ( ( hdr->fc & IEEE80211_FC_VERSION ) != IEEE80211_THIS_VERSION ) {
510                 DBGC ( netdev->priv, "802.11 %p packet invalid version %04x\n",
511                        netdev->priv, hdr->fc & IEEE80211_FC_VERSION );
512                 return -EINVAL_PKT_VERSION;
513         }
514
515         if ( ( hdr->fc & IEEE80211_FC_TYPE ) != IEEE80211_TYPE_DATA ||
516              ( hdr->fc & IEEE80211_FC_SUBTYPE ) != IEEE80211_STYPE_DATA ) {
517                 DBGC ( netdev->priv, "802.11 %p packet not data/data (fc=%04x)\n",
518                        netdev->priv, hdr->fc );
519                 return -EINVAL_PKT_NOT_DATA;
520         }
521
522         if ( ( hdr->fc & ( IEEE80211_FC_TODS | IEEE80211_FC_FROMDS ) ) !=
523              IEEE80211_FC_FROMDS ) {
524                 DBGC ( netdev->priv, "802.11 %p packet not from DS (fc=%04x)\n",
525                        netdev->priv, hdr->fc );
526                 return -EINVAL_PKT_NOT_FROMDS;
527         }
528
529         if ( lhdr->dsap != IEEE80211_LLC_DSAP || lhdr->ssap != IEEE80211_LLC_SSAP ||
530              lhdr->ctrl != IEEE80211_LLC_CTRL || lhdr->oui[0] || lhdr->oui[1] ||
531              lhdr->oui[2] ) {
532                 DBGC ( netdev->priv, "802.11 %p LLC header is not plain EtherType "
533                        "encapsulator: %02x->%02x [%02x] %02x:%02x:%02x %04x\n",
534                        netdev->priv, lhdr->dsap, lhdr->ssap, lhdr->ctrl,
535                        lhdr->oui[0], lhdr->oui[1], lhdr->oui[2], lhdr->ethertype );
536                 return -EINVAL_PKT_LLC_HEADER;
537         }
538
539         iob_pull ( iobuf, sizeof ( *hdr ) + sizeof ( *lhdr ) );
540
541         *ll_dest = hdr->addr1;
542         *ll_source = hdr->addr3;
543         *net_proto = lhdr->ethertype;
544         return 0;
545 }
546
547 /**
548  * Hash 802.11 multicast address
549  *
550  * @v af        Address family
551  * @v net_addr  Network-layer address
552  * @ret ll_addr Filled link-layer address
553  * @ret rc      Return status code
554  *
555  * Currently unimplemented.
556  */
557 static int net80211_ll_mc_hash ( unsigned int af __unused,
558                                  const void *net_addr __unused,
559                                  void *ll_addr __unused )
560 {
561         return -ENOTSUP;
562 }
563
564 /** 802.11 link-layer protocol */
565 static struct ll_protocol net80211_ll_protocol __ll_protocol = {
566         .name = "802.11",
567         .push = net80211_ll_push,
568         .pull = net80211_ll_pull,
569         .ntoa = eth_ntoa,
570         .mc_hash = net80211_ll_mc_hash,
571         .ll_proto = htons ( ARPHRD_ETHER ),     /* "encapsulated Ethernet" */
572         .ll_addr_len = ETH_ALEN,
573         .ll_header_len = IEEE80211_TYP_FRAME_HEADER_LEN +
574                                 IEEE80211_LLC_HEADER_LEN,
575         .ll_broadcast = net80211_ll_broadcast,
576 };
577
578 /* ---------- 802.11 network management API ---------- */
579
580 /**
581  * Get 802.11 device from wrapping network device
582  *
583  * @v netdev    Wrapping network device
584  * @ret dev     802.11 device wrapped by network device, or NULL
585  *
586  * Returns NULL if the network device does not wrap an 802.11 device.
587  */
588 struct net80211_device * net80211_get ( struct net_device *netdev )
589 {
590         struct net80211_device *dev;
591
592         list_for_each_entry ( dev, &net80211_devices, list ) {
593                 if ( netdev->priv == dev )
594                         return netdev->priv;
595         }
596
597         return NULL;
598 }
599
600 /**
601  * Set state of 802.11 device keeping management frames
602  *
603  * @v dev       802.11 device
604  * @v enable    Whether to keep management frames
605  * @ret oldenab Whether management frames were enabled before this call
606  *
607  * If enable is TRUE, beacon, probe, and action frames will be kept
608  * and may be retrieved by calling net80211_mgmt_dequeue().
609  */
610 int net80211_keep_mgmt ( struct net80211_device *dev, int enable )
611 {
612         int oldenab = dev->keep_mgmt;
613
614         dev->keep_mgmt = enable;
615         return oldenab;
616 }
617
618 /**
619  * Get 802.11 management frame
620  *
621  * @v dev       802.11 device
622  * @ret signal  Signal strength of returned management frame
623  * @ret iob     I/O buffer
624  *
625  * Frames will only be returned by this function if
626  * net80211_keep_mgmt() has been previously called with enable set to
627  * TRUE.
628  *
629  * The calling function takes ownership of the returned I/O buffer.
630  */
631 struct io_buffer * net80211_mgmt_dequeue ( struct net80211_device *dev,
632                                            int *signal )
633 {
634         struct io_buffer *iobuf;
635         struct net80211_rx_info *rxi;
636
637         list_for_each_entry ( rxi, &dev->mgmt_info_queue, list ) {
638                 list_del ( &rxi->list );
639                 if ( signal )
640                         *signal = rxi->signal;
641                 break;
642         }
643
644         list_for_each_entry ( iobuf, &dev->mgmt_queue, list ) {
645                 list_del ( &iobuf->list );
646                 return iobuf;
647         }
648         return NULL;
649 }
650
651 /**
652  * Transmit 802.11 management frame
653  *
654  * @v dev       802.11 device
655  * @v fc        Frame Control flags for management frame
656  * @v dest      Destination access point
657  * @v iob       I/O buffer
658  * @ret rc      Return status code
659  *
660  * The fc argument must contain at least an IEEE 802.11 management
661  * subtype number (e.g. IEEE80211_STYPE_PROBE_REQ). If it contains
662  * IEEE80211_FC_PROTECTED, the frame will be encrypted prior to
663  * transmission.
664  *
665  * It is required that @a iob have at least 24 bytes of headroom
666  * reserved before its data start.
667  */
668 int net80211_tx_mgmt ( struct net80211_device *dev, u16 fc, u8 dest[6],
669                        struct io_buffer *iob )
670 {
671         struct ieee80211_frame *hdr = iob_push ( iob,
672                                                  IEEE80211_TYP_FRAME_HEADER_LEN );
673
674         hdr->fc = IEEE80211_THIS_VERSION | IEEE80211_TYPE_MGMT |
675             ( fc & ~IEEE80211_FC_PROTECTED );
676         hdr->duration = net80211_duration ( dev, 10 );
677         hdr->seq = IEEE80211_MAKESEQ ( ++dev->last_tx_seqnr, 0 );
678
679         memcpy ( hdr->addr1, dest, ETH_ALEN );  /* DA = RA */
680         memcpy ( hdr->addr2, dev->netdev->ll_addr, ETH_ALEN );  /* SA = TA */
681         memcpy ( hdr->addr3, dest, ETH_ALEN );  /* BSSID */
682
683         if ( fc & IEEE80211_FC_PROTECTED ) {
684                 if ( ! dev->crypto )
685                         return -EINVAL_CRYPTO_REQUEST;
686
687                 struct io_buffer *eiob = dev->crypto->encrypt ( dev->crypto,
688                                                                 iob );
689                 free_iob ( iob );
690                 iob = eiob;
691         }
692
693         return netdev_tx ( dev->netdev, iob );
694 }
695
696
697 /* ---------- driver API ---------- */
698
699 /**
700  * Allocate 802.11 device
701  *
702  * @v priv_size         Size of driver-private allocation area
703  * @ret dev             Newly allocated 802.11 device
704  *
705  * This function allocates a net_device with space in its private area
706  * for both the net80211_device it will wrap and the driver-private
707  * data space requested. It initializes the link-layer-specific parts
708  * of the net_device, and links the net80211_device to the net_device
709  * appropriately.
710  */
711 struct net80211_device * net80211_alloc ( size_t priv_size )
712 {
713         struct net80211_device *dev;
714         struct net_device *netdev =
715                 alloc_netdev ( sizeof ( *dev ) + priv_size );
716
717         if ( ! netdev )
718                 return NULL;
719
720         netdev->ll_protocol = &net80211_ll_protocol;
721         netdev->max_pkt_len = IEEE80211_MAX_DATA_LEN;
722         netdev_init ( netdev, &net80211_netdev_ops );
723
724         dev = netdev->priv;
725         dev->netdev = netdev;
726         dev->priv = ( u8 * ) dev + sizeof ( *dev );
727         dev->op = &net80211_null_ops;
728
729         dev->proc_assoc.step = net80211_step_associate;
730         INIT_LIST_HEAD ( &dev->mgmt_queue );
731         INIT_LIST_HEAD ( &dev->mgmt_info_queue );
732
733         return dev;
734 }
735
736 /**
737  * Register 802.11 device with network stack
738  *
739  * @v dev       802.11 device
740  * @v ops       802.11 device operations
741  * @v hw        802.11 hardware information
742  *
743  * This also registers the wrapping net_device with the higher network
744  * layers.
745  */
746 int net80211_register ( struct net80211_device *dev,
747                         struct net80211_device_operations *ops,
748                         struct net80211_hw_info *hw )
749 {
750         dev->op = ops;
751         dev->hw = malloc ( sizeof ( *hw ) );
752         if ( ! dev->hw )
753                 return -ENOMEM;
754
755         memcpy ( dev->hw, hw, sizeof ( *hw ) );
756         memcpy ( dev->netdev->ll_addr, hw->hwaddr, ETH_ALEN );
757
758         list_add_tail ( &dev->list, &net80211_devices );
759         return register_netdev ( dev->netdev );
760 }
761
762 /**
763  * Unregister 802.11 device from network stack
764  *
765  * @v dev       802.11 device
766  *
767  * After this call, the device operations are cleared so that they
768  * will not be called.
769  */
770 void net80211_unregister ( struct net80211_device *dev )
771 {
772         unregister_netdev ( dev->netdev );
773         list_del ( &dev->list );
774         dev->op = &net80211_null_ops;
775 }
776
777 /**
778  * Free 802.11 device
779  *
780  * @v dev       802.11 device
781  *
782  * The device should be unregistered before this function is called.
783  */
784 void net80211_free ( struct net80211_device *dev )
785 {
786         free ( dev->hw );
787         netdev_nullify ( dev->netdev );
788         netdev_put ( dev->netdev );
789 }
790
791
792 /* ---------- 802.11 network management workhorse code ---------- */
793
794 /**
795  * Set state of 802.11 device
796  *
797  * @v dev       802.11 device
798  * @v clear     Bitmask of flags to clear
799  * @v set       Bitmask of flags to set
800  * @v status    Status or reason code for most recent operation
801  *
802  * If @a status represents a reason code, it should be OR'ed with
803  * NET80211_IS_REASON.
804  *
805  * Clearing authentication also clears association; clearing
806  * association also clears security handshaking state. Clearing
807  * association removes the link-up flag from the wrapping net_device,
808  * but setting it does not automatically set the flag; that is left to
809  * the judgment of higher-level code.
810  */
811 static inline void net80211_set_state ( struct net80211_device *dev,
812                                         short clear, short set,
813                                         u16 status )
814 {
815         /* The conditions in this function are deliberately formulated
816            to be decidable at compile-time in most cases. */
817         const int statmsk = NET80211_STATUS_MASK | NET80211_IS_REASON;
818
819         if ( clear & NET80211_PROBED )
820                 clear |= NET80211_AUTHENTICATED;
821
822         if ( clear & NET80211_AUTHENTICATED )
823                 clear |= NET80211_ASSOCIATED;
824
825         if ( clear & NET80211_ASSOCIATED )
826                 clear |= NET80211_CRYPTO_SYNCED;
827
828         dev->state = ( dev->state & ~clear ) | set;
829         dev->state = ( dev->state & ~statmsk ) | ( status & statmsk );
830
831         if ( clear & NET80211_ASSOCIATED )
832                 netdev_link_down ( dev->netdev );
833
834         if ( ( clear | set ) & NET80211_ASSOCIATED )
835                 dev->op->config ( dev, NET80211_CFG_ASSOC );
836
837         if ( status != 0 ) {
838                 if ( status & NET80211_IS_REASON )
839                         dev->assoc_rc = -E80211_REASON ( status );
840                 else
841                         dev->assoc_rc = -E80211_STATUS ( status );
842                 netdev_link_err ( dev->netdev, dev->assoc_rc );
843         }
844 }
845
846 /**
847  * Add channels to 802.11 device
848  *
849  * @v dev       802.11 device
850  * @v start     First channel number to add
851  * @v len       Number of channels to add
852  * @v txpower   TX power (dBm) to allow on added channels
853  *
854  * To effectively replace the current list of channels, simply set the
855  * nr_channels field of the 802.11 device to 0 before calling this
856  * function.
857  */
858 static void net80211_add_channels ( struct net80211_device *dev, int start,
859                                     int len, int txpower )
860 {
861         int i, chan = start;
862
863         for ( i = dev->nr_channels; len-- && i < NET80211_MAX_CHANNELS;
864               i++ ) {
865                 dev->channels[i].channel_nr = chan;
866                 dev->channels[i].maxpower = txpower;
867
868                 if ( chan >= 1 && chan <= 14 ) {
869                         dev->channels[i].band = NET80211_BAND_2GHZ;
870                         if ( chan == 14 )
871                                 dev->channels[i].center_freq = 2484;
872                         else
873                                 dev->channels[i].center_freq = 2407 + 5 * chan;
874                         chan++;
875                 } else {
876                         dev->channels[i].band = NET80211_BAND_5GHZ;
877                         dev->channels[i].center_freq = 5000 + 5 * chan;
878                         chan += 4;
879                 }
880         }
881
882         dev->nr_channels = i;
883 }
884
885 /**
886  * Update 802.11 device state to reflect received capabilities field
887  *
888  * @v dev       802.11 device
889  * @v capab     Capabilities field in beacon, probe, or association frame
890  * @ret rc      Return status code
891  */
892 static int net80211_process_capab ( struct net80211_device *dev,
893                                     u16 capab )
894 {
895         u16 old_phy = dev->phy_flags;
896
897         if ( ( capab & ( IEEE80211_CAPAB_MANAGED | IEEE80211_CAPAB_ADHOC ) ) !=
898              IEEE80211_CAPAB_MANAGED ) {
899                 DBGC ( dev, "802.11 %p cannot handle IBSS network\n", dev );
900                 return -ENOSYS;
901         }
902
903         if ( capab & IEEE80211_CAPAB_SPECTRUM_MGMT ) {
904                 DBGC ( dev, "802.11 %p cannot handle spectrum managed "
905                        "network\n", dev );
906                 return -ENOSYS;
907         }
908
909         dev->phy_flags &= ~( NET80211_PHY_USE_SHORT_PREAMBLE |
910                              NET80211_PHY_USE_SHORT_SLOT );
911
912         if ( capab & IEEE80211_CAPAB_SHORT_PMBL )
913                 dev->phy_flags |= NET80211_PHY_USE_SHORT_PREAMBLE;
914
915         if ( capab & IEEE80211_CAPAB_SHORT_SLOT )
916                 dev->phy_flags |= NET80211_PHY_USE_SHORT_SLOT;
917
918         if ( old_phy != dev->phy_flags )
919                 dev->op->config ( dev, NET80211_CFG_PHY_PARAMS );
920
921         return 0;
922 }
923
924 /**
925  * Update 802.11 device state to reflect received information elements
926  *
927  * @v dev       802.11 device
928  * @v ie        Pointer to first information element
929  * @v ie_end    Pointer to tail of packet I/O buffer
930  * @ret rc      Return status code
931  */
932 static int net80211_process_ie ( struct net80211_device *dev,
933                                  union ieee80211_ie *ie, void *ie_end )
934 {
935         u16 old_rate = NET80211_RATE_VALUE ( dev->rates[dev->rate] );
936         u16 old_phy = dev->phy_flags;
937         int have_rates = 0, i;
938         int ds_channel = 0;
939         int changed = 0;
940
941         if ( ( void * ) ie >= ie_end )
942                 return 0;
943
944         for ( ; ie; ie = ieee80211_next_ie ( ie, ie_end ) ) {
945                 switch ( ie->id ) {
946                 case IEEE80211_IE_SSID:
947                         if ( ie->len <= 32 ) {
948                                 memcpy ( dev->essid, ie->ssid, ie->len );
949                                 dev->essid[ie->len] = 0;
950                         }
951                         break;
952
953                 case IEEE80211_IE_RATES:
954                 case IEEE80211_IE_EXT_RATES:
955                         if ( ! have_rates ) {
956                                 dev->nr_rates = 0;
957                                 dev->basic_rates = 0;
958                                 have_rates = 1;
959                         }
960                         for ( i = 0; i < ie->len &&
961                               dev->nr_rates < NET80211_MAX_RATES; i++ ) {
962                                 u8 rid = ie->rates[i];
963                                 u16 rate = ( rid & 0x7f ) * 5;
964
965                                 if ( rid & 0x80 )
966                                         dev->basic_rates |=
967                                                 ( 1 << dev->nr_rates );
968
969                                 dev->rates[dev->nr_rates++] = rate;
970                         }
971
972                         break;
973
974                 case IEEE80211_IE_DS_PARAM:
975                         if ( dev->channel < dev->nr_channels && ds_channel ==
976                              dev->channels[dev->channel].channel_nr )
977                                 break;
978                         ds_channel = ie->ds_param.current_channel;
979                         net80211_change_channel ( dev, ds_channel );
980                         break;
981
982                 case IEEE80211_IE_COUNTRY:
983                         dev->nr_channels = 0;
984
985                         DBGC ( dev, "802.11 %p setting country regulations "
986                                "for %c%c\n", dev, ie->country.name[0],
987                                ie->country.name[1] );
988                         for ( i = 0; i < ( ie->len - 3 ) / 3; i++ ) {
989                                 union ieee80211_ie_country_triplet *t =
990                                         &ie->country.triplet[i];
991                                 if ( t->first > 200 ) {
992                                         DBGC ( dev, "802.11 %p ignoring regulatory "
993                                                "extension information\n", dev );
994                                 } else {
995                                         net80211_add_channels ( dev,
996                                                         t->band.first_channel,
997                                                         t->band.nr_channels,
998                                                         t->band.max_txpower );
999                                 }
1000                         }
1001                         break;
1002
1003                 case IEEE80211_IE_ERP_INFO:
1004                         dev->phy_flags &= ~( NET80211_PHY_USE_PROTECTION |
1005                                              NET80211_PHY_USE_SHORT_PREAMBLE );
1006                         if ( ie->erp_info & IEEE80211_ERP_USE_PROTECTION )
1007                                 dev->phy_flags |= NET80211_PHY_USE_PROTECTION;
1008                         if ( ! ( ie->erp_info & IEEE80211_ERP_BARKER_LONG ) )
1009                                 dev->phy_flags |= NET80211_PHY_USE_SHORT_PREAMBLE;
1010                         break;
1011
1012                 case IEEE80211_IE_RSN:
1013                         /* XXX need to implement WPA stuff */
1014                         break;
1015                 }
1016         }
1017
1018         if ( have_rates ) {
1019                 /* Allow only those rates that are also supported by
1020                    the hardware. */
1021                 int delta = 0, j;
1022
1023                 dev->rate = 0;
1024                 for ( i = 0; i < dev->nr_rates; i++ ) {
1025                         int ok = 0;
1026                         for ( j = 0; j < dev->hw->nr_supported_rates; j++ ) {
1027                                 if ( dev->hw->supported_rates[j] ==
1028                                      NET80211_RATE_VALUE ( dev->rates[i] ) ) {
1029                                         ok = 1;
1030                                         break;
1031                                 }
1032                         }
1033
1034                         if ( ! ok )
1035                                 delta++;
1036                         else {
1037                                 dev->rates[i - delta] = dev->rates[i];
1038                                 if ( old_rate == dev->rates[i] )
1039                                         dev->rate = i - delta;
1040                         }
1041                 }
1042
1043                 dev->nr_rates -= delta;
1044
1045                 net80211_set_rtscts_rate ( dev );
1046
1047                 if ( dev->rates[dev->rate] != old_rate )
1048                         changed |= NET80211_CFG_RATE;
1049         }
1050
1051         if ( dev->hw->flags & NET80211_HW_NO_SHORT_PREAMBLE )
1052                 dev->phy_flags &= ~NET80211_PHY_USE_SHORT_PREAMBLE;
1053         if ( dev->hw->flags & NET80211_HW_NO_SHORT_SLOT )
1054                 dev->phy_flags &= ~NET80211_PHY_USE_SHORT_SLOT;
1055
1056         if ( old_phy != dev->phy_flags )
1057                 changed |= NET80211_CFG_PHY_PARAMS;
1058
1059         if ( changed )
1060                 dev->op->config ( dev, changed );
1061
1062         return 0;
1063 }
1064
1065 /**
1066  * Create information elements for outgoing probe or association packet
1067  *
1068  * @v dev               802.11 device
1069  * @v ie                Pointer to start of information element area
1070  * @ret next_ie         Pointer to first byte after added information elements
1071  */
1072 static union ieee80211_ie *
1073 net80211_marshal_request_info ( struct net80211_device *dev,
1074                                 union ieee80211_ie *ie )
1075 {
1076         int i;
1077
1078         ie->id = IEEE80211_IE_SSID;
1079         ie->len = strlen ( dev->essid );
1080         memcpy ( ie->ssid, dev->essid, ie->len );
1081
1082         ie = ieee80211_next_ie ( ie, NULL );
1083
1084         ie->id = IEEE80211_IE_RATES;
1085         ie->len = dev->nr_rates;
1086         for ( i = 0; i < ie->len; i++ ) {
1087                 ie->rates[i] = NET80211_RATE_VALUE ( dev->rates[i] ) / 5;
1088                 if ( dev->basic_rates & ( 1 << i ) )
1089                         ie->rates[i] |= 0x80;
1090         }
1091
1092         if ( ie->len > 8 ) {
1093                 /* 802.11 requires we use an Extended Basic Rates IE
1094                    for the rates beyond the eighth. */
1095                 int rates = ie->len;
1096
1097                 memmove ( ( void * ) ie + 2 + 8 + 2, ( void * ) ie + 2 + 8,
1098                           rates - 8 );
1099                 ie->len = 8;
1100
1101                 ie = ieee80211_next_ie ( ie, NULL );
1102
1103                 ie->id = IEEE80211_IE_EXT_RATES;
1104                 ie->len = rates - 8;
1105         }
1106
1107         ie = ieee80211_next_ie ( ie, NULL );
1108
1109         return ie;
1110 }
1111
1112 /** Seconds to wait after finding a network, to possibly find better APs
1113  *
1114  * This is used when a specific SSID to scan for is specified.
1115  */
1116 #define NET80211_PROBE_GATHER    1
1117
1118 /** Seconds to wait after finding a network, to possibly find others
1119  *
1120  * This is used when an empty SSID is specified, to scan for all
1121  * networks.
1122  */
1123 #define NET80211_PROBE_GATHER_ALL 2
1124
1125 /** Seconds to allow a probe to take if no network has been found */
1126 #define NET80211_PROBE_TIMEOUT   6
1127
1128 /**
1129  * Begin probe of 802.11 networks
1130  *
1131  * @v dev       802.11 device
1132  * @v essid     SSID to probe for, or "" to accept any (may not be NULL)
1133  * @v active    Whether to use active scanning
1134  * @ret ctx     Probe context
1135  *
1136  * Active scanning may only be used on channels 1-11 in the 2.4GHz
1137  * band, due to gPXE's lack of a complete regulatory database. If
1138  * active scanning is used, probe packets will be sent on each
1139  * channel; this can allow association with hidden-SSID networks if
1140  * the SSID is properly specified.
1141  *
1142  * A @c NULL return indicates an out-of-memory condition.
1143  *
1144  * The returned context must be periodically passed to
1145  * net80211_probe_step() until that function returns zero.
1146  */
1147 struct net80211_probe_ctx * net80211_probe_start ( struct net80211_device *dev,
1148                                                    const char *essid,
1149                                                    int active ) 
1150 {
1151         struct net80211_probe_ctx *ctx = zalloc ( sizeof ( *ctx ) );
1152
1153         if ( ! ctx )
1154                 return NULL;
1155
1156         ctx->dev = dev;
1157         ctx->old_keep_mgmt = net80211_keep_mgmt ( dev, 1 );
1158         ctx->essid = essid;
1159         if ( dev->essid != ctx->essid )
1160                 strcpy ( dev->essid, ctx->essid );
1161
1162         if ( active ) {
1163                 struct ieee80211_probe_req *probe_req;
1164                 union ieee80211_ie *ie;
1165
1166                 ctx->probe = alloc_iob ( 128 );
1167                 iob_reserve ( ctx->probe, IEEE80211_TYP_FRAME_HEADER_LEN );
1168                 probe_req = ctx->probe->data;
1169
1170                 ie = net80211_marshal_request_info ( dev,
1171                                                      probe_req->info_element );
1172                 ie->id = IEEE80211_IE_REQUEST;
1173                 ie->len = 3;
1174                 ie->request[0] = IEEE80211_IE_COUNTRY;
1175                 ie->request[1] = IEEE80211_IE_ERP_INFO;
1176                 ie->request[2] = IEEE80211_IE_RSN;
1177
1178                 ie = ieee80211_next_ie ( ie, NULL );
1179
1180                 iob_put ( ctx->probe, ( void * ) ie - ctx->probe->data );
1181         }
1182
1183         ctx->ticks_start = currticks();
1184         ctx->ticks_beacon = 0;
1185         ctx->ticks_channel = currticks();
1186         ctx->hop_time = ticks_per_sec() / ( active ? 2 : 6 );
1187
1188         /*
1189          * Channels on 2.4GHz overlap, and the most commonly used
1190          * are 1, 6, and 11. We'll get a result faster if we check
1191          * every 5 channels, but in order to hit all of them the
1192          * number of channels must be relatively prime to 5. If it's
1193          * not, tweak the hop.
1194          */
1195         ctx->hop_step = 5;
1196         while ( dev->nr_channels % ctx->hop_step == 0 && ctx->hop_step > 1 )
1197                 ctx->hop_step--;
1198
1199         ctx->beacons = malloc ( sizeof ( *ctx->beacons ) );
1200         INIT_LIST_HEAD ( ctx->beacons );
1201
1202         dev->channel = 0;
1203         dev->op->config ( dev, NET80211_CFG_CHANNEL );
1204
1205         return ctx;
1206 }
1207
1208 /**
1209  * Continue probe of 802.11 networks
1210  *
1211  * @v ctx       Probe context returned by net80211_probe_start()
1212  * @ret rc      Probe status
1213  *
1214  * The return code will be 0 if the probe is still going on (and this
1215  * function should be called again), a positive number if the probe
1216  * completed successfully, or a negative error code if the probe
1217  * failed for that reason.
1218  *
1219  * Whether the probe succeeded or failed, you must call
1220  * net80211_probe_finish_all() or net80211_probe_finish_best()
1221  * (depending on whether you want information on all networks or just
1222  * the best-signal one) in order to release the probe context. A
1223  * failed probe may still have acquired some valid data.
1224  */
1225 int net80211_probe_step ( struct net80211_probe_ctx *ctx ) 
1226 {
1227         struct net80211_device *dev = ctx->dev;
1228         u32 start_timeout = NET80211_PROBE_TIMEOUT * ticks_per_sec();
1229         u32 gather_timeout = ticks_per_sec();
1230         u32 now = currticks();
1231         struct io_buffer *iob;
1232         int signal;
1233         int rc;
1234         char ssid[IEEE80211_MAX_SSID_LEN + 1];
1235
1236         gather_timeout *= ( ctx->essid[0] ? NET80211_PROBE_GATHER :
1237                             NET80211_PROBE_GATHER_ALL );
1238
1239         /* Time out if necessary */
1240         if ( now >= ctx->ticks_start + start_timeout )
1241                 return list_empty ( ctx->beacons ) ? -ETIMEDOUT : +1;
1242
1243         if ( ctx->ticks_beacon > 0 && now >= ctx->ticks_start + gather_timeout )
1244                 return +1;
1245
1246         /* Change channels if necessary */
1247         if ( now >= ctx->ticks_channel + ctx->hop_time ) {
1248                 dev->channel = ( dev->channel + ctx->hop_step )
1249                         % dev->nr_channels;
1250                 dev->op->config ( dev, NET80211_CFG_CHANNEL );
1251                 udelay ( dev->hw->channel_change_time );
1252
1253                 ctx->ticks_channel = now;
1254
1255                 if ( ctx->probe ) {
1256                         struct io_buffer *siob = ctx->probe; /* to send */
1257
1258                         /* make a copy for future use */
1259                         iob = alloc_iob ( siob->tail - siob->head );
1260                         iob_reserve ( iob, iob_headroom ( siob ) );
1261                         memcpy ( iob_put ( iob, iob_len ( siob ) ),
1262                                  siob->data, iob_len ( siob ) );
1263
1264                         ctx->probe = iob;
1265                         rc = net80211_tx_mgmt ( dev, IEEE80211_STYPE_PROBE_REQ,
1266                                                 net80211_ll_broadcast,
1267                                                 iob_disown ( siob ) );
1268                         if ( rc ) {
1269                                 DBGC ( dev, "802.11 %p send probe failed: "
1270                                        "%s\n", dev, strerror ( rc ) );
1271                                 return rc;
1272                         }
1273                 }
1274         }
1275
1276         /* Check for new management packets */
1277         while ( ( iob = net80211_mgmt_dequeue ( dev, &signal ) ) != NULL ) {
1278                 struct ieee80211_frame *hdr;
1279                 struct ieee80211_beacon *beacon;
1280                 union ieee80211_ie *ie;
1281                 struct net80211_wlan *wlan;
1282                 u16 type;
1283
1284                 hdr = iob->data;
1285                 type = hdr->fc & IEEE80211_FC_SUBTYPE;
1286                 beacon = ( struct ieee80211_beacon * ) hdr->data;
1287
1288                 if ( type != IEEE80211_STYPE_BEACON &&
1289                      type != IEEE80211_STYPE_PROBE_RESP ) {
1290                         DBGC2 ( dev, "802.11 %p probe: non-beacon\n", dev );
1291                         goto drop;
1292                 }
1293
1294                 if ( ( void * ) beacon->info_element >= iob->tail ) {
1295                         DBGC ( dev, "802.11 %p probe: beacon with no IEs\n",
1296                                dev );
1297                         goto drop;
1298                 }
1299
1300                 ie = beacon->info_element;
1301                 while ( ie && ie->id != IEEE80211_IE_SSID )
1302                         ie = ieee80211_next_ie ( ie, iob->tail );
1303
1304                 if ( ! ie ) {
1305                         DBGC ( dev, "802.11 %p probe: beacon with no SSID\n",
1306                                dev );
1307                         goto drop;
1308                 }
1309
1310                 memcpy ( ssid, ie->ssid, ie->len );
1311                 ssid[ie->len] = 0;
1312
1313                 if ( ctx->essid[0] && strcmp ( ctx->essid, ssid ) != 0 ) {
1314                         DBGC2 ( dev, "802.11 %p probe: beacon with wrong SSID "
1315                                 "(%s)\n", dev, ssid );
1316                         goto drop;
1317                 }
1318
1319                 /* See if we've got an entry for this network */
1320                 list_for_each_entry ( wlan, ctx->beacons, list ) {
1321                         if ( strcmp ( wlan->essid, ssid ) != 0 )
1322                                 continue;
1323
1324                         if ( signal < wlan->signal ) {
1325                                 DBGC2 ( dev, "802.11 %p probe: beacon for %s "
1326                                         "(%s) with weaker signal %d\n", dev,
1327                                         ssid, eth_ntoa ( hdr->addr3 ), signal );
1328                                 goto drop;
1329                         }
1330
1331                         goto fill;
1332                 }
1333
1334                 /* No entry yet - make one */
1335                 wlan = zalloc ( sizeof ( *wlan ) );
1336                 strcpy ( wlan->essid, ssid );
1337                 list_add_tail ( &wlan->list, ctx->beacons );
1338
1339                 /* Whether we're using an old entry or a new one, fill
1340                    it with new data. */
1341         fill:
1342                 memcpy ( wlan->bssid, hdr->addr3, ETH_ALEN );
1343                 wlan->signal = signal;
1344                 wlan->channel = dev->channels[dev->channel].channel_nr;
1345
1346                 /* Copy this I/O buffer into a new wlan->beacon; the
1347                  * iob we've got probably came from the device driver
1348                  * and may have the full 2.4k allocation, which we
1349                  * don't want to keep around wasting memory.
1350                  */
1351                 free_iob ( wlan->beacon );
1352                 wlan->beacon = alloc_iob ( iob_len ( iob ) );
1353                 memcpy ( iob_put ( wlan->beacon, iob_len ( iob ) ),
1354                          iob->data, iob_len ( iob ) );
1355
1356                 /* XXX actually check capab and RSN ie to
1357                    figure this out */
1358                 wlan->handshaking = NET80211_SECPROT_NONE;
1359                 wlan->crypto = NET80211_CRYPT_NONE;
1360
1361                 ctx->ticks_beacon = now;
1362
1363                 DBGC2 ( dev, "802.11 %p probe: good beacon for %s (%s)\n",
1364                         dev, wlan->essid, eth_ntoa ( wlan->bssid ) );
1365
1366         drop:
1367                 free_iob ( iob );
1368         }
1369
1370         return 0;
1371 }
1372
1373
1374 /**
1375  * Finish probe of 802.11 networks, returning best-signal network found
1376  *
1377  * @v ctx       Probe context
1378  * @ret wlan    Best-signal network found, or @c NULL if none were found
1379  *
1380  * If net80211_probe_start() was called with a particular SSID
1381  * parameter as filter, only a network with that SSID (matching
1382  * case-sensitively) can be returned from this function.
1383  */
1384 struct net80211_wlan *
1385 net80211_probe_finish_best ( struct net80211_probe_ctx *ctx )
1386 {
1387         struct net80211_wlan *best = NULL, *wlan;
1388
1389         list_for_each_entry ( wlan, ctx->beacons, list ) {
1390                 if ( ! best || best->signal < wlan->signal )
1391                         best = wlan;
1392         }
1393
1394         if ( best )
1395                 list_del ( &best->list );
1396         else
1397                 DBGC ( ctx->dev, "802.11 %p probe: found nothing for '%s'\n",
1398                        ctx->dev, ctx->essid );
1399
1400         if ( ! list_empty ( ctx->beacons ) )
1401                 net80211_free_wlanlist ( ctx->beacons );
1402
1403         net80211_keep_mgmt ( ctx->dev, ctx->old_keep_mgmt );
1404
1405         if ( ctx->probe )
1406                 free_iob ( ctx->probe );
1407
1408         free ( ctx );
1409
1410         return best;
1411 }
1412
1413
1414 /**
1415  * Finish probe of 802.11 networks, returning all networks found
1416  *
1417  * @v ctx       Probe context
1418  * @ret list    List of net80211_wlan detailing networks found
1419  *
1420  * If net80211_probe_start() was called with a particular SSID
1421  * parameter as filter, this will always return either an empty or a
1422  * one-element list.
1423  */
1424 struct list_head *net80211_probe_finish_all ( struct net80211_probe_ctx *ctx )
1425 {
1426         struct list_head *beacons = ctx->beacons;
1427
1428         net80211_keep_mgmt ( ctx->dev, ctx->old_keep_mgmt );
1429
1430         if ( ctx->probe )
1431                 free_iob ( ctx->probe );
1432
1433         free ( ctx );
1434
1435         return beacons;
1436 }
1437
1438
1439 /**
1440  * Free WLAN structure
1441  *
1442  * @v wlan      WLAN structure to free
1443  */
1444 void net80211_free_wlan ( struct net80211_wlan *wlan )
1445 {
1446         if ( wlan ) {
1447                 free_iob ( wlan->beacon );
1448                 free ( wlan );
1449         }
1450 }
1451
1452
1453 /**
1454  * Free list of WLAN structures
1455  *
1456  * @v list      List of WLAN structures to free
1457  */
1458 void net80211_free_wlanlist ( struct list_head *list ) 
1459 {
1460         struct net80211_wlan *wlan, *tmp;
1461
1462         if ( ! list )
1463                 return;
1464
1465         list_for_each_entry_safe ( wlan, tmp, list, list ) {
1466                 list_del ( &wlan->list );
1467                 net80211_free_wlan ( wlan );
1468         }
1469
1470         free ( list );
1471 }
1472
1473
1474
1475 #define ASSOC_TIMEOUT   TICKS_PER_SEC
1476 #define ASSOC_RETRIES   2
1477
1478 /**
1479  * Step 802.11 association process
1480  *
1481  * @v proc      Association process
1482  */
1483 static void net80211_step_associate ( struct process *proc )
1484 {
1485         struct net80211_device *dev =
1486             container_of ( proc, struct net80211_device, proc_assoc );
1487         int rc = 0;
1488         int status = dev->state & NET80211_STATUS_MASK;
1489
1490         if ( dev->state & NET80211_WAITING ) {
1491                 if ( ! dev->associating )
1492                         return;
1493
1494                 if ( currticks() - dev->ctx.assoc->last_packet > ASSOC_TIMEOUT ) {
1495                         dev->ctx.assoc->times_tried++;
1496                         if ( ++dev->ctx.assoc->times_tried > ASSOC_RETRIES ) {
1497                                 rc = -ETIMEDOUT;
1498                                 goto fail;
1499                         }
1500                 } else {
1501                         return;
1502                 }
1503         } else {
1504                 if ( dev->state & NET80211_PROBED )
1505                         dev->ctx.assoc->times_tried = 0;
1506         }
1507
1508         if ( ! ( dev->state & NET80211_PROBED ) ) {
1509                 /* state: scan */
1510
1511                 if ( ! dev->ctx.probe ) {
1512                         /* start probe */
1513                         int active = fetch_intz_setting ( NULL,
1514                                                 &net80211_active_setting );
1515                         int band = dev->hw->bands;
1516
1517                         if ( active )
1518                                 band &= ~NET80211_BAND_5GHZ;
1519
1520                         rc = net80211_prepare_probe ( dev, band, active );
1521                         if ( rc )
1522                                 goto fail;
1523
1524                         dev->ctx.probe = net80211_probe_start ( dev, dev->essid,
1525                                                                 active );
1526                         if ( ! dev->ctx.probe ) {
1527                                 dev->assoc_rc = -ENOMEM;
1528                                 goto fail;
1529                         }
1530                 }
1531                 
1532                 rc = net80211_probe_step ( dev->ctx.probe );
1533                 if ( ! rc ) {
1534                         return; /* still going */
1535                 }
1536
1537                 dev->associating = net80211_probe_finish_best ( dev->ctx.probe );
1538                 dev->ctx.probe = NULL;
1539                 if ( ! dev->associating ) {
1540                         if ( rc > 0 ) /* "successful" probe found nothing */
1541                                 rc = -ETIMEDOUT;
1542                         goto fail;
1543                 }
1544
1545                 DBGC ( dev, "802.11 %p found network %s (%s)\n", dev,
1546                        dev->associating->essid,
1547                        eth_ntoa ( dev->associating->bssid ) );
1548
1549                 dev->ctx.assoc = zalloc ( sizeof ( *dev->ctx.assoc ) );
1550                 if ( ! dev->ctx.assoc ) {
1551                         rc = -ENOMEM;
1552                         goto fail;
1553                 }
1554
1555                 dev->state |= NET80211_PROBED;
1556                 dev->ctx.assoc->method = IEEE80211_AUTH_OPEN_SYSTEM;
1557
1558                 return;
1559         }
1560
1561         dev->ctx.assoc->last_packet = currticks();
1562
1563         if ( ! ( dev->state & NET80211_AUTHENTICATED ) ) {
1564                 /* state: prepare and authenticate */
1565
1566                 if ( status != IEEE80211_STATUS_SUCCESS ) {
1567                         /* we tried authenticating already, but failed */
1568                         int method = dev->ctx.assoc->method;
1569
1570                         if ( method == IEEE80211_AUTH_OPEN_SYSTEM &&
1571                              ( status == IEEE80211_STATUS_AUTH_CHALL_INVALID ||
1572                                status == IEEE80211_STATUS_AUTH_ALGO_UNSUPP ) ) {
1573                                 /* Maybe this network uses Shared Key? */
1574                                 dev->ctx.assoc->method =
1575                                         IEEE80211_AUTH_SHARED_KEY;
1576                         } else {
1577                                 goto fail;
1578                         }
1579                 }
1580
1581                 DBGC ( dev, "802.11 %p authenticating with method %d\n", dev,
1582                        dev->ctx.assoc->method );
1583
1584                 rc = net80211_prepare_assoc ( dev, dev->associating );
1585                 if ( rc )
1586                         goto fail;
1587
1588                 rc = net80211_send_auth ( dev, dev->associating,
1589                                           dev->ctx.assoc->method );
1590                 if ( rc )
1591                         goto fail;
1592
1593                 return;
1594         }
1595
1596         if ( ! ( dev->state & NET80211_ASSOCIATED ) ) {
1597                 /* state: associate */
1598                 DBGC ( dev, "802.11 %p associating\n", dev );
1599
1600                 if ( status != IEEE80211_STATUS_SUCCESS )
1601                         goto fail;
1602
1603                 rc = net80211_send_assoc ( dev, dev->associating );
1604                 if ( rc )
1605                         goto fail;
1606
1607                 return;
1608         }
1609
1610         if ( ! ( dev->state & NET80211_CRYPTO_SYNCED ) ) {
1611                 /* state: crypto sync */
1612                 DBGC ( dev, "802.11 %p security handshaking\n", dev );
1613
1614                 dev->state |= NET80211_CRYPTO_SYNCED;
1615                 /* XXX need to actually do something here once we
1616                    support WPA */
1617                 return;
1618         }
1619
1620         /* state: done! */
1621         netdev_link_up ( dev->netdev );
1622         dev->assoc_rc = 0;
1623         dev->state &= ~NET80211_WORKING;
1624
1625         free ( dev->ctx.assoc );
1626         net80211_free_wlan ( dev->associating );
1627         dev->associating = NULL;
1628
1629         process_del ( proc );
1630
1631         DBGC ( dev, "802.11 %p associated with %s (%s)\n", dev,
1632                dev->essid, eth_ntoa ( dev->bssid ) );
1633
1634         return;
1635
1636  fail:
1637         dev->state &= ~( NET80211_WORKING | NET80211_WAITING );
1638         if ( rc )
1639                 dev->assoc_rc = rc;
1640
1641         netdev_link_err ( dev->netdev, dev->assoc_rc );
1642
1643         net80211_free_wlan ( dev->associating );
1644         dev->associating = NULL;
1645
1646         process_del ( proc );
1647
1648         DBGC ( dev, "802.11 %p association failed (state=%04x): "
1649                "%s\n", dev, dev->state, strerror ( dev->assoc_rc ) );
1650 }
1651
1652 /**
1653  * Check for 802.11 SSID updates
1654  *
1655  * This acts as a settings applicator; if the user changes netX/ssid,
1656  * and netX is currently open, the association task will be invoked
1657  * again.
1658  */
1659 int net80211_check_ssid_update ( void )
1660 {
1661         struct net80211_device *dev;
1662         char ssid[IEEE80211_MAX_SSID_LEN + 1];
1663         int len;
1664
1665         list_for_each_entry ( dev, &net80211_devices, list ) {
1666                 if ( ! ( dev->netdev->state & NETDEV_OPEN ) )
1667                         continue;
1668
1669                 len = fetch_setting ( netdev_settings ( dev->netdev ),
1670                                       &net80211_ssid_setting, ssid,
1671                                       IEEE80211_MAX_SSID_LEN );
1672                 ssid[len] = 0;
1673
1674                 if ( strcmp ( ssid, dev->essid ) != 0 ) {
1675                         DBGC ( dev, "802.11 %p updating association: "
1676                                "%s -> %s\n", dev, dev->essid, ssid );
1677                         net80211_set_state ( dev, NET80211_PROBED, 0, 0 );
1678                         net80211_autoassociate ( dev );
1679                 }
1680         }
1681
1682         return 0;
1683 }
1684
1685 /**
1686  * Start 802.11 association process
1687  *
1688  * @v dev       802.11 device
1689  *
1690  * If the association process is running, it will be restarted.
1691  */
1692 void net80211_autoassociate ( struct net80211_device *dev )
1693 {
1694         int len;
1695
1696         if ( ! ( dev->state & NET80211_WORKING ) ) {
1697                 DBGC2 ( dev, "802.11 %p spawning association process\n", dev );
1698                 process_add ( &dev->proc_assoc );
1699         }
1700         
1701         if ( dev->associating )
1702                 net80211_free_wlan ( dev->associating );
1703
1704         len = fetch_setting ( netdev_settings ( dev->netdev ),
1705                               &net80211_ssid_setting, dev->essid,
1706                               IEEE80211_MAX_SSID_LEN );
1707         dev->essid[len] = 0;
1708         dev->ctx.probe = NULL;
1709         dev->associating = NULL;
1710         net80211_set_state ( dev, NET80211_ASSOCIATED, NET80211_WORKING, 0 );
1711 }
1712
1713 /**
1714  * Pick TX rate for RTS/CTS packets based on data rate
1715  *
1716  * @v dev       802.11 device
1717  *
1718  * The RTS/CTS rate is the fastest TX rate marked as "basic" that is
1719  * not faster than the data rate.
1720  */
1721 static void net80211_set_rtscts_rate ( struct net80211_device *dev )
1722 {
1723         u16 datarate = NET80211_RATE_VALUE ( dev->rates[dev->rate] );
1724         u16 rtsrate = 0;
1725         int rts_idx = -1;
1726         int i;
1727
1728         for ( i = 0; i < dev->nr_rates; i++ ) {
1729                 u16 rate = NET80211_RATE_VALUE ( dev->rates[i] );
1730
1731                 if ( ! ( dev->basic_rates & ( 1 << i ) ) || rate > datarate )
1732                         continue;
1733
1734                 if ( rate > rtsrate ) {
1735                         rtsrate = rate;
1736                         rts_idx = i;
1737                 }
1738         }
1739
1740         /* If this is in initialization, we might not have any basic
1741            rates; just use the first data rate in that case. */
1742         if ( rts_idx < 0 )
1743                 rts_idx = 0;
1744
1745         dev->rtscts_rate = rts_idx;
1746 }
1747
1748 /**
1749  * Pick TX rate from the rate list we have
1750  *
1751  * @v dev       802.11 device
1752  *
1753  * This needs to be expanded into an algorithm that adapts to large
1754  * numbers of dropped packets by lowering the rate, and tries raising
1755  * the rate if we've been running well for a while at a lower one.
1756  */
1757 static void net80211_set_rate_intelligently ( struct net80211_device *dev )
1758 {
1759         int i, oldrate = dev->rate;
1760
1761         if ( dev->nr_rates == 0 ) {
1762                 for ( i = 0; i < dev->hw->nr_supported_rates; i++ ) {
1763                         u16 rate = dev->hw->supported_rates[i];
1764                         dev->rates[dev->nr_rates++] = rate;
1765                 }
1766                 oldrate = -1;   /* always reconfigure */
1767         }
1768
1769         /* For now, stick with something safe: the last (probably
1770            fastest) 802.11b-compatible rate. */
1771
1772         dev->rate = dev->nr_rates;
1773         for ( i = 0; i < dev->nr_rates; i++ ) {
1774                 if ( net80211_rate_is_erp ( dev->rates[i] ) )
1775                         continue;
1776                 dev->rate = i;
1777                 break;
1778         }
1779
1780         if ( dev->rate == dev->nr_rates ) /* no non-ERP rates */
1781                 dev->rate = 0;  /* first ERP rate */
1782
1783         if ( dev->rate != oldrate )
1784                 dev->op->config ( dev, NET80211_CFG_RATE );
1785 }
1786
1787 /**
1788  * Configure 802.11 device to transmit on a certain channel
1789  *
1790  * @v dev       802.11 device
1791  * @v channel   Channel number (1-11 for 2.4GHz) to transmit on
1792  */
1793 int net80211_change_channel ( struct net80211_device *dev, int channel )
1794 {
1795         int i, oldchan = dev->channel;
1796
1797         for ( i = 0; i < dev->nr_channels; i++ ) {
1798                 if ( dev->channels[i].channel_nr == channel ) {
1799                         dev->channel = i;
1800                         break;
1801                 }
1802         }
1803
1804         if ( i == dev->nr_channels )
1805                 return -ENOENT;
1806
1807         if ( i != oldchan )
1808                 return dev->op->config ( dev, NET80211_CFG_CHANNEL );
1809
1810         return 0;
1811 }
1812
1813 /**
1814  * Prepare 802.11 device channel and rate set for scanning
1815  *
1816  * @v dev       802.11 device
1817  * @v band      RF band(s) on which to prepare for scanning
1818  * @v active    Whether the scanning will be active
1819  * @ret rc      Return status code
1820  */
1821 int net80211_prepare_probe ( struct net80211_device *dev, int band,
1822                              int active )
1823 {
1824         if ( active && band != NET80211_BAND_2GHZ ) {
1825                 DBGC ( dev, "802.11 %p cannot perform active scanning on "
1826                        "5GHz band\n", dev );
1827                 return -EINVAL_ACTIVE_SCAN;
1828         }
1829
1830         if ( band == 0 ) {
1831                 /* This can happen for a 5GHz-only card with 5GHz
1832                    scanning masked out by an active request. */
1833                 DBGC ( dev, "802.11 %p asked to prepare for scanning nothing\n",
1834                        dev );
1835                 return -EINVAL_ACTIVE_SCAN;
1836         }
1837
1838         dev->nr_channels = 0;
1839
1840         if ( active )
1841                 net80211_add_channels ( dev, 1, 11, NET80211_REG_TXPOWER );
1842         else {
1843                 if ( band & NET80211_BAND_2GHZ )
1844                         net80211_add_channels ( dev, 1, 14,
1845                                                 NET80211_REG_TXPOWER );
1846                 if ( band & NET80211_BAND_5GHZ )
1847                         net80211_add_channels ( dev, 36, 8,
1848                                                 NET80211_REG_TXPOWER );
1849         }
1850
1851         dev->channel = 0;
1852         dev->op->config ( dev, NET80211_CFG_CHANNEL );
1853
1854         dev->nr_rates = 0;
1855         net80211_set_rate_intelligently ( dev );
1856
1857         return 0;
1858 }
1859
1860 /**
1861  * Prepare 802.11 device channel and rate set for communication
1862  *
1863  * @v dev       802.11 device
1864  * @v wlan      WLAN to prepare for communication with
1865  * @ret rc      Return status code
1866  */
1867 int net80211_prepare_assoc ( struct net80211_device *dev,
1868                              struct net80211_wlan *wlan )
1869 {
1870         struct ieee80211_frame *hdr = wlan->beacon->data;
1871         struct ieee80211_beacon *beacon =
1872                 ( struct ieee80211_beacon * ) hdr->data;
1873         int rc;
1874
1875         net80211_set_state ( dev, NET80211_ASSOCIATED, 0, 0 );
1876         memcpy ( dev->bssid, wlan->bssid, ETH_ALEN );
1877         strcpy ( dev->essid, wlan->essid );
1878
1879         /* do crypto setup here */
1880
1881         /* Barring an IE that tells us the channel outright, assume
1882            the channel we heard this AP best on is the channel it's
1883            communicating on. */
1884         net80211_change_channel ( dev, wlan->channel );
1885
1886         rc = net80211_process_capab ( dev, beacon->capability );
1887         if ( rc )
1888                 return rc;
1889
1890         rc = net80211_process_ie ( dev, beacon->info_element,
1891                                    wlan->beacon->tail );
1892         if ( rc )
1893                 return rc;
1894
1895         net80211_set_rate_intelligently ( dev );
1896
1897         return 0;
1898 }
1899
1900 /**
1901  * Send 802.11 initial authentication frame
1902  *
1903  * @v dev       802.11 device
1904  * @v wlan      WLAN to authenticate with
1905  * @v method    Authentication method
1906  * @ret rc      Return status code
1907  *
1908  * @a method may be 0 for Open System authentication or 1 for Shared
1909  * Key authentication. Open System provides no security in association
1910  * whatsoever, relying on encryption for confidentiality, but Shared
1911  * Key actively introduces security problems and is very rarely used.
1912  */
1913 int net80211_send_auth ( struct net80211_device *dev,
1914                          struct net80211_wlan *wlan, int method )
1915 {
1916         struct io_buffer *iob = alloc_iob ( 64 );
1917         struct ieee80211_auth *auth;
1918
1919         net80211_set_state ( dev, 0, NET80211_WAITING, 0 );
1920         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
1921         auth = iob_put ( iob, sizeof ( *auth ) );
1922         auth->algorithm = method;
1923         auth->tx_seq = 1;
1924         auth->status = 0;
1925
1926         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_AUTH, wlan->bssid, iob );
1927 }
1928
1929 /**
1930  * Handle receipt of 802.11 authentication frame
1931  *
1932  * @v dev       802.11 device
1933  * @v iob       I/O buffer
1934  *
1935  * If the authentication method being used is Shared Key, and the
1936  * frame that was received included challenge text, the frame is
1937  * encrypted using the cryptographic algorithm currently in effect and
1938  * sent back to the AP to complete the authentication.
1939  */
1940 static void net80211_handle_auth ( struct net80211_device *dev,
1941                                    struct io_buffer *iob )
1942 {
1943         struct ieee80211_frame *hdr = iob->data;
1944         struct ieee80211_auth *auth =
1945             ( struct ieee80211_auth * ) hdr->data;
1946
1947         if ( auth->tx_seq & 1 ) {
1948                 DBGC ( dev, "802.11 %p authentication received improperly "
1949                        "directed frame (seq. %d)\n", dev, auth->tx_seq );
1950                 net80211_set_state ( dev, NET80211_WAITING, 0,
1951                                      IEEE80211_STATUS_FAILURE );
1952                 return;
1953         }
1954
1955         if ( auth->status != IEEE80211_STATUS_SUCCESS ) {
1956                 DBGC ( dev, "802.11 %p authentication failed: status %d\n",
1957                        dev, auth->status );
1958                 net80211_set_state ( dev, NET80211_WAITING, 0,
1959                                      auth->status );
1960                 return;
1961         }
1962
1963         if ( auth->algorithm == IEEE80211_AUTH_SHARED_KEY && ! dev->crypto ) {
1964                 DBGC ( dev, "802.11 %p can't perform shared-key authentication "
1965                        "without a cryptosystem\n", dev );
1966                 net80211_set_state ( dev, NET80211_WAITING, 0,
1967                                      IEEE80211_STATUS_FAILURE );
1968                 return;
1969         }
1970
1971         if ( auth->algorithm == IEEE80211_AUTH_SHARED_KEY &&
1972              auth->tx_seq == 2 ) {
1973                 /* Since the iob we got is going to be freed as soon
1974                    as we return, we can do some in-place
1975                    modification. */
1976                 auth->tx_seq = 3;
1977                 auth->status = 0;
1978
1979                 memcpy ( hdr->addr2, hdr->addr1, ETH_ALEN );
1980                 memcpy ( hdr->addr1, hdr->addr3, ETH_ALEN );
1981
1982                 netdev_tx ( dev->netdev,
1983                             dev->crypto->encrypt ( dev->crypto, iob ) );
1984                 return;
1985         }
1986
1987         net80211_set_state ( dev, NET80211_WAITING, NET80211_AUTHENTICATED,
1988                              IEEE80211_STATUS_SUCCESS );
1989
1990         return;
1991 }
1992
1993 /**
1994  * Send 802.11 association frame
1995  *
1996  * @v dev       802.11 device
1997  * @v wlan      WLAN to associate with
1998  * @ret rc      Return status code
1999  */
2000 int net80211_send_assoc ( struct net80211_device *dev,
2001                           struct net80211_wlan *wlan )
2002 {
2003         struct io_buffer *iob = alloc_iob ( 128 );
2004         struct ieee80211_assoc_req *assoc;
2005         union ieee80211_ie *ie;
2006
2007         net80211_set_state ( dev, 0, NET80211_WAITING, 0 );
2008
2009         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
2010         assoc = iob->data;
2011
2012         assoc->capability = IEEE80211_CAPAB_MANAGED;
2013         if ( ! ( dev->hw->flags & NET80211_HW_NO_SHORT_PREAMBLE ) )
2014                 assoc->capability |= IEEE80211_CAPAB_SHORT_PMBL;
2015         if ( ! ( dev->hw->flags & NET80211_HW_NO_SHORT_SLOT ) )
2016                 assoc->capability |= IEEE80211_CAPAB_SHORT_SLOT;
2017         if ( wlan->crypto )
2018                 assoc->capability |= IEEE80211_CAPAB_PRIVACY;
2019
2020         assoc->listen_interval = 1;
2021
2022         ie = net80211_marshal_request_info ( dev, assoc->info_element );
2023
2024         DBGP ( "802.11 %p about to send association request:\n", dev );
2025         DBGP_HD ( iob->data, ( void * ) ie - iob->data );
2026
2027         /* XXX add RSN ie for WPA support */
2028
2029         iob_put ( iob, ( void * ) ie - iob->data );
2030
2031         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_ASSOC_REQ,
2032                                   wlan->bssid, iob );
2033 }
2034
2035 /**
2036  * Handle receipt of 802.11 association reply frame
2037  *
2038  * @v dev       802.11 device
2039  * @v iob       I/O buffer
2040  */
2041 static void net80211_handle_assoc_reply ( struct net80211_device *dev,
2042                                           struct io_buffer *iob )
2043 {
2044         struct ieee80211_frame *hdr = iob->data;
2045         struct ieee80211_assoc_resp *assoc =
2046                 ( struct ieee80211_assoc_resp * ) hdr->data;
2047
2048         net80211_process_capab ( dev, assoc->capability );
2049         net80211_process_ie ( dev, assoc->info_element, iob->tail );
2050
2051         if ( assoc->status != IEEE80211_STATUS_SUCCESS ) {
2052                 DBGC ( dev, "802.11 %p association failed: status %d\n",
2053                        dev, assoc->status );
2054                 net80211_set_state ( dev, NET80211_WAITING, 0,
2055                                      assoc->status );
2056                 return;
2057         }
2058
2059         /* ESSID was filled before the association request was sent */
2060         memcpy ( dev->bssid, hdr->addr3, ETH_ALEN );
2061         dev->aid = assoc->aid;
2062
2063         net80211_set_state ( dev, NET80211_WAITING, NET80211_ASSOCIATED,
2064                              IEEE80211_STATUS_SUCCESS );
2065 }
2066
2067
2068 /**
2069  * Send 802.11 disassociation frame
2070  *
2071  * @v dev       802.11 device
2072  * @v reason    Reason for disassociation
2073  * @ret rc      Return status code
2074  */
2075 static int net80211_send_disassoc ( struct net80211_device *dev, int reason )
2076 {
2077         struct io_buffer *iob = alloc_iob ( 64 );
2078         struct ieee80211_disassoc *disassoc;
2079
2080         if ( ! ( dev->state & NET80211_ASSOCIATED ) )
2081                 return -EINVAL;
2082
2083         net80211_set_state ( dev, NET80211_ASSOCIATED, 0, 0 );
2084         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
2085         disassoc = iob_put ( iob, sizeof ( *disassoc ) );
2086         disassoc->reason = reason;
2087
2088         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_DISASSOC, dev->bssid,
2089                                   iob );
2090 }
2091
2092
2093 /**
2094  * Handle receipt of 802.11 management frame
2095  *
2096  * @v dev       802.11 device
2097  * @v iob       I/O buffer
2098  * @v signal    Signal strength of received frame
2099  */
2100 static void net80211_handle_mgmt ( struct net80211_device *dev,
2101                                    struct io_buffer *iob, int signal )
2102 {
2103         struct ieee80211_frame *hdr = iob->data;
2104         struct ieee80211_disassoc *disassoc;
2105         u16 stype = hdr->fc & IEEE80211_FC_SUBTYPE;
2106         int keep = 0;
2107         int is_deauth = ( stype == IEEE80211_STYPE_DEAUTH );
2108
2109         if ( ( hdr->fc & IEEE80211_FC_TYPE ) != IEEE80211_TYPE_MGMT ) {
2110                 free_iob ( iob );
2111                 return;         /* only handle management frames */
2112         }
2113
2114         switch ( stype ) {
2115                 /* These are usually indicative of a deeper problem,
2116                    so don't just reassociate right away. */
2117         case IEEE80211_STYPE_DEAUTH:
2118         case IEEE80211_STYPE_DISASSOC:
2119                 disassoc = ( struct ieee80211_disassoc * ) hdr->data;
2120                 net80211_set_state ( dev, is_deauth ? NET80211_ASSOCIATED :
2121                                      NET80211_AUTHENTICATED, 0,
2122                                      NET80211_IS_REASON | disassoc->reason );
2123                 DBGC ( dev, "802.11 %p %s: reason %d\n",
2124                        dev, is_deauth ? "deauthenticated" : "disassociated",
2125                        disassoc->reason );
2126                 break;
2127
2128                 /* We handle authentication and association. */
2129         case IEEE80211_STYPE_AUTH:
2130                 if ( ! ( dev->state & NET80211_AUTHENTICATED ) )
2131                         net80211_handle_auth ( dev, iob );
2132                 break;
2133
2134         case IEEE80211_STYPE_ASSOC_RESP:
2135         case IEEE80211_STYPE_REASSOC_RESP:
2136                 if ( ! ( dev->state & NET80211_ASSOCIATED ) )
2137                         net80211_handle_assoc_reply ( dev, iob );
2138                 break;
2139
2140                 /* We pass probes and beacons onto network scanning
2141                    code. Pass actions for future extensibility. */
2142         case IEEE80211_STYPE_PROBE_RESP:
2143         case IEEE80211_STYPE_BEACON:
2144         case IEEE80211_STYPE_ACTION:
2145                 if ( dev->keep_mgmt ) {
2146                         struct net80211_rx_info *rxinf;
2147                         rxinf = zalloc ( sizeof ( *rxinf ) );
2148                         if ( ! rxinf ) {
2149                                 DBGC ( dev, "802.11 %p out of memory\n", dev );
2150                                 break;
2151                         }
2152                         rxinf->signal = signal;
2153                         list_add_tail ( &iob->list, &dev->mgmt_queue );
2154                         list_add_tail ( &rxinf->list,
2155                                         &dev->mgmt_info_queue );
2156                         keep = 1;
2157                 }
2158                 break;
2159
2160         case IEEE80211_STYPE_PROBE_REQ:
2161                 /* Some nodes send these broadcast. Ignore them. */
2162                 break;
2163
2164         case IEEE80211_STYPE_ASSOC_REQ:
2165         case IEEE80211_STYPE_REASSOC_REQ:
2166                 /* We should never receive these, only send them. */
2167                 DBGC ( dev, "802.11 %p received strange management request "
2168                        "(%04x)\n", dev, stype );
2169                 break;
2170
2171         default:
2172                 DBGC ( dev, "802.11 %p received unimplemented management "
2173                        "packet (%04x)\n", dev, stype );
2174                 break;
2175         }
2176
2177         if ( ! keep )
2178                 free_iob ( iob );
2179 }
2180
2181 /* ---------- Packet handling functions ---------- */
2182
2183 /**
2184  * Free buffers used by 802.11 fragment cache entry
2185  *
2186  * @v dev       802.11 device
2187  * @v fcid      Fragment cache entry index
2188  *
2189  * After this function, the referenced entry will be marked unused.
2190  */
2191 static void net80211_free_frags ( struct net80211_device *dev, int fcid )
2192 {
2193         int j;
2194         struct net80211_frag_cache *frag = &dev->frags[fcid];
2195
2196         for ( j = 0; j < 16; j++ ) {
2197                 if ( frag->iob[j] ) {
2198                         free_iob ( frag->iob[j] );
2199                         frag->iob[j] = NULL;
2200                 }
2201         }
2202
2203         frag->seqnr = 0;
2204         frag->start_ticks = 0;
2205         frag->in_use = 0;
2206 }
2207
2208 /**
2209  * Accumulate 802.11 fragments into one I/O buffer
2210  *
2211  * @v dev       802.11 device
2212  * @v fcid      Fragment cache entry index
2213  * @v nfrags    Number of fragments received
2214  * @v size      Sum of sizes of all fragments, including headers
2215  * @ret iob     I/O buffer containing reassembled packet
2216  *
2217  * This function does not free the fragment buffers.
2218  */
2219 static struct io_buffer *net80211_accum_frags ( struct net80211_device *dev,
2220                                                 int fcid, int nfrags, int size )
2221 {
2222         struct net80211_frag_cache *frag = &dev->frags[fcid];
2223         int hdrsize = IEEE80211_TYP_FRAME_HEADER_LEN;
2224         int nsize = size - hdrsize * ( nfrags - 1 );
2225         int i;
2226
2227         struct io_buffer *niob = alloc_iob ( nsize );
2228         struct ieee80211_frame *hdr;
2229
2230         /* Add the header from the first one... */
2231         memcpy ( iob_put ( niob, hdrsize ), frag->iob[0]->data, hdrsize );
2232
2233         /* ... and all the data from all of them. */
2234         for ( i = 0; i < nfrags; i++ ) {
2235                 int len = iob_len ( frag->iob[i] ) - hdrsize;
2236                 memcpy ( iob_put ( niob, len ),
2237                          frag->iob[i]->data + hdrsize, len );
2238         }
2239
2240         /* Turn off the fragment bit. */
2241         hdr = niob->data;
2242         hdr->fc &= ~IEEE80211_FC_MORE_FRAG;
2243
2244         return niob;
2245 }
2246
2247 /**
2248  * Handle receipt of 802.11 fragment
2249  *
2250  * @v dev       802.11 device
2251  * @v iob       I/O buffer containing fragment
2252  * @v signal    Signal strength with which fragment was received
2253  */
2254 static void net80211_rx_frag ( struct net80211_device *dev,
2255                                struct io_buffer *iob, int signal )
2256 {
2257         struct ieee80211_frame *hdr = iob->data;
2258         int fragnr = IEEE80211_FRAG ( hdr->seq );
2259
2260         if ( fragnr == 0 && ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2261                 /* start a frag cache entry */
2262                 int i, newest = -1;
2263                 u32 curr_ticks = currticks(), newest_ticks = 0;
2264                 u32 timeout = ticks_per_sec() * NET80211_FRAG_TIMEOUT;
2265
2266                 for ( i = 0; i < NET80211_NR_CONCURRENT_FRAGS; i++ ) {
2267                         if ( dev->frags[i].in_use == 0 )
2268                                 break;
2269
2270                         if ( dev->frags[i].start_ticks + timeout >=
2271                              curr_ticks ) {
2272                                 net80211_free_frags ( dev, i );
2273                                 break;
2274                         }
2275
2276                         if ( dev->frags[i].start_ticks > newest_ticks ) {
2277                                 newest = i;
2278                                 newest_ticks = dev->frags[i].start_ticks;
2279                         }
2280                 }
2281
2282                 /* If we're being sent more concurrent fragmented
2283                    packets than we can handle, drop the newest so the
2284                    older ones have time to complete. */
2285                 if ( i == NET80211_NR_CONCURRENT_FRAGS ) {
2286                         i = newest;
2287                         net80211_free_frags ( dev, i );
2288                 }
2289
2290                 dev->frags[i].in_use = 1;
2291                 dev->frags[i].seqnr = IEEE80211_SEQNR ( hdr->seq );
2292                 dev->frags[i].start_ticks = currticks();
2293                 dev->frags[i].iob[0] = iob;
2294                 return;
2295         } else {
2296                 int i;
2297                 for ( i = 0; i < NET80211_NR_CONCURRENT_FRAGS; i++ ) {
2298                         if ( dev->frags[i].in_use && dev->frags[i].seqnr ==
2299                              IEEE80211_SEQNR ( hdr->seq ) )
2300                                 break;
2301                 }
2302                 if ( i == NET80211_NR_CONCURRENT_FRAGS ) {
2303                         /* drop non-first not-in-cache fragments */
2304                         DBGC ( dev, "802.11 %p dropped fragment fc=%04x "
2305                                "seq=%04x\n", dev, hdr->fc, hdr->seq );
2306                         free_iob ( iob );
2307                         return;
2308                 }
2309
2310                 dev->frags[i].iob[fragnr] = iob;
2311
2312                 if ( ! ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2313                         int j, size = 0;
2314                         for ( j = 0; j < fragnr; j++ ) {
2315                                 size += iob_len ( dev->frags[i].iob[j] );
2316                                 if ( dev->frags[i].iob[j] == NULL )
2317                                         break;
2318                         }
2319                         if ( j == fragnr ) {
2320                                 /* we've got everything! */
2321                                 struct io_buffer *niob =
2322                                     net80211_accum_frags ( dev, i, fragnr,
2323                                                            size );
2324                                 net80211_free_frags ( dev, i );
2325                                 net80211_rx ( dev, niob, signal );
2326                         } else {
2327                                 DBGC ( dev, "802.11 %p dropping fragmented "
2328                                        "packet due to out-of-order arrival, "
2329                                        "fc=%04x seq=%04x\n", dev, hdr->fc,
2330                                        hdr->seq );
2331                                 net80211_free_frags ( dev, i );
2332                         }
2333                 }
2334         }
2335 }
2336
2337 /**
2338  * Handle receipt of 802.11 frame
2339  *
2340  * @v dev       802.11 device
2341  * @v iob       I/O buffer
2342  * @v signal    Received signal strength
2343  */
2344 void net80211_rx ( struct net80211_device *dev, struct io_buffer *iob,
2345                    int signal )
2346 {
2347         struct ieee80211_frame *hdr = iob->data;
2348         u16 type = hdr->fc & IEEE80211_FC_TYPE;
2349         if ( ( hdr->fc & IEEE80211_FC_VERSION ) != IEEE80211_THIS_VERSION )
2350                 goto drop;      /* drop invalid-version packets */
2351
2352         if ( type == IEEE80211_TYPE_CTRL )
2353                 goto drop;      /* we don't handle control packets,
2354                                    the hardware does */
2355
2356         if ( dev->last_rx_seq == hdr->seq )
2357                 goto drop;      /* avoid duplicate packet */
2358         dev->last_rx_seq = hdr->seq;
2359
2360         if ( dev->hw->flags & NET80211_HW_RX_HAS_FCS ) {
2361                 /* discard the FCS */
2362                 iob_unput ( iob, 4 );
2363         }
2364
2365         if ( hdr->fc & IEEE80211_FC_PROTECTED ) {
2366                 struct io_buffer *niob;
2367                 if ( ! dev->crypto )
2368                         goto drop;      /* can't decrypt packets on an open network */
2369
2370                 niob = dev->crypto->decrypt ( dev->crypto, iob );
2371                 if ( ! niob )
2372                         goto drop;      /* drop failed decryption */
2373                 free_iob ( iob );
2374                 iob = niob;
2375         }
2376
2377         dev->last_signal = signal;
2378
2379         /* Fragments go into the frag cache or get dropped. */
2380         if ( IEEE80211_FRAG ( hdr->seq ) != 0
2381              || ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2382                 net80211_rx_frag ( dev, iob, signal );
2383                 return;
2384         }
2385
2386         /* Management frames get handled, enqueued, or dropped. */
2387         if ( type == IEEE80211_TYPE_MGMT ) {
2388                 net80211_handle_mgmt ( dev, iob, signal );
2389                 return;
2390         }
2391
2392         /* Data frames get dropped or sent to the net_device. */
2393         if ( ( hdr->fc & IEEE80211_FC_SUBTYPE ) != IEEE80211_STYPE_DATA )
2394                 goto drop;      /* drop QoS, CFP, or null data packets */
2395
2396         if ( hdr->fc & IEEE80211_FC_RETRY ) {
2397                 DBGCP ( dev, "802.11 %p rx RETX packet %04x\n",
2398                         dev, hdr->seq );
2399         } else {
2400                 DBGCP ( dev, "802.11 %p rx ok   packet %04x\n",
2401                         dev, hdr->seq );
2402         }
2403
2404         if ( netdev_link_ok ( dev->netdev ) ) {
2405                 netdev_rx ( dev->netdev, iob );
2406                 return;
2407         }
2408
2409  drop:
2410         DBGC2 ( dev, "802.11 %p dropped packet fc=%04x seq=%04x\n", dev,
2411                 hdr->fc, hdr->seq );
2412         free_iob ( iob );
2413         return;
2414 }
2415
2416 /** Indicate an error in receiving a packet
2417  *
2418  * @v dev       802.11 device
2419  * @v iob       I/O buffer with received packet, or NULL
2420  * @v rc        Error code
2421  *
2422  * This logs the error with the wrapping net_device, and frees iob if
2423  * it is passed.
2424  */
2425 void net80211_rx_err ( struct net80211_device *dev,
2426                        struct io_buffer *iob, int rc )
2427 {
2428         DBGCP ( dev, "802.11 %p rx FAIL\n", dev );
2429         netdev_rx_err ( dev->netdev, iob, rc );
2430 }
2431
2432 /** Indicate the completed transmission of a packet
2433  *
2434  * @v dev       802.11 device
2435  * @v iob       I/O buffer of transmitted packet
2436  * @v retries   Number of times this packet was retransmitted
2437  * @v rc        Error code, or 0 for success
2438  *
2439  * This logs an error with the wrapping net_device if one occurred,
2440  * and removes and frees the I/O buffer from its TX queue.
2441  *
2442  * If the packet did not need to be retransmitted because it was
2443  * properly ACKed the first time, @a retries should be 0.
2444  */
2445 void net80211_tx_complete ( struct net80211_device *dev,
2446                             struct io_buffer *iob, int retries, int rc )
2447 {
2448         if ( retries ) {
2449                 if ( rc ) {
2450                         DBGCP ( dev, "802.11 %p tx FAIL after %d retx\n", dev,
2451                                 retries );
2452                 } else {
2453                         DBGCP ( dev, "802.11 %p tx RETX %d times\n", dev,
2454                                 retries );
2455                 }
2456         } else {
2457                 if ( rc ) {
2458                         DBGCP ( dev, "802.11 %p tx FAIL outright\n", dev );
2459                 } else {
2460                         DBGCP ( dev, "802.11 %p tx ok\n", dev );
2461                 }
2462         }
2463         netdev_tx_complete_err ( dev->netdev, iob, rc );
2464 }