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