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