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