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