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