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