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