1fc983a01c8b4180ee24aa8f387c0619fc35b46d
[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         .ll_proto = htons ( ARPHRD_ETHER ),     /* "encapsulated Ethernet" */
590         .hw_addr_len = ETH_ALEN,
591         .ll_addr_len = ETH_ALEN,
592         .ll_header_len = IEEE80211_TYP_FRAME_HEADER_LEN +
593                                 IEEE80211_LLC_HEADER_LEN,
594 };
595
596
597 /* ---------- 802.11 network management API ---------- */
598
599 /**
600  * Get 802.11 device from wrapping network device
601  *
602  * @v netdev    Wrapping network device
603  * @ret dev     802.11 device wrapped by network device, or NULL
604  *
605  * Returns NULL if the network device does not wrap an 802.11 device.
606  */
607 struct net80211_device * net80211_get ( struct net_device *netdev )
608 {
609         struct net80211_device *dev;
610
611         list_for_each_entry ( dev, &net80211_devices, list ) {
612                 if ( netdev->priv == dev )
613                         return netdev->priv;
614         }
615
616         return NULL;
617 }
618
619 /**
620  * Set state of 802.11 device keeping management frames
621  *
622  * @v dev       802.11 device
623  * @v enable    Whether to keep management frames
624  * @ret oldenab Whether management frames were enabled before this call
625  *
626  * If enable is TRUE, beacon, probe, and action frames will be kept
627  * and may be retrieved by calling net80211_mgmt_dequeue().
628  */
629 int net80211_keep_mgmt ( struct net80211_device *dev, int enable )
630 {
631         int oldenab = dev->keep_mgmt;
632
633         dev->keep_mgmt = enable;
634         return oldenab;
635 }
636
637 /**
638  * Get 802.11 management frame
639  *
640  * @v dev       802.11 device
641  * @ret signal  Signal strength of returned management frame
642  * @ret iob     I/O buffer, or NULL if no management frame is queued
643  *
644  * Frames will only be returned by this function if
645  * net80211_keep_mgmt() has been previously called with enable set to
646  * TRUE.
647  *
648  * The calling function takes ownership of the returned I/O buffer.
649  */
650 struct io_buffer * net80211_mgmt_dequeue ( struct net80211_device *dev,
651                                            int *signal )
652 {
653         struct io_buffer *iobuf;
654         struct net80211_rx_info *rxi;
655
656         list_for_each_entry ( rxi, &dev->mgmt_info_queue, list ) {
657                 list_del ( &rxi->list );
658                 if ( signal )
659                         *signal = rxi->signal;
660                 free ( rxi );
661
662                 list_for_each_entry ( iobuf, &dev->mgmt_queue, list ) {
663                         list_del ( &iobuf->list );
664                         return iobuf;
665                 }
666                 assert ( 0 );
667         }
668
669         return NULL;
670 }
671
672 /**
673  * Transmit 802.11 management frame
674  *
675  * @v dev       802.11 device
676  * @v fc        Frame Control flags for management frame
677  * @v dest      Destination access point
678  * @v iob       I/O buffer
679  * @ret rc      Return status code
680  *
681  * The @a fc argument must contain at least an IEEE 802.11 management
682  * subtype number (e.g. IEEE80211_STYPE_PROBE_REQ). If it contains
683  * IEEE80211_FC_PROTECTED, the frame will be encrypted prior to
684  * transmission.
685  *
686  * It is required that @a iob have at least 24 bytes of headroom
687  * reserved before its data start.
688  */
689 int net80211_tx_mgmt ( struct net80211_device *dev, u16 fc, u8 dest[6],
690                        struct io_buffer *iob )
691 {
692         struct ieee80211_frame *hdr = iob_push ( iob,
693                                                  IEEE80211_TYP_FRAME_HEADER_LEN );
694
695         hdr->fc = IEEE80211_THIS_VERSION | IEEE80211_TYPE_MGMT |
696             ( fc & ~IEEE80211_FC_PROTECTED );
697         hdr->duration = net80211_duration ( dev, 10, dev->rates[dev->rate] );
698         hdr->seq = IEEE80211_MAKESEQ ( ++dev->last_tx_seqnr, 0 );
699
700         memcpy ( hdr->addr1, dest, ETH_ALEN );  /* DA = RA */
701         memcpy ( hdr->addr2, dev->netdev->ll_addr, ETH_ALEN );  /* SA = TA */
702         memcpy ( hdr->addr3, dest, ETH_ALEN );  /* BSSID */
703
704         if ( fc & IEEE80211_FC_PROTECTED ) {
705                 if ( ! dev->crypto )
706                         return -EINVAL_CRYPTO_REQUEST;
707
708                 struct io_buffer *eiob = dev->crypto->encrypt ( dev->crypto,
709                                                                 iob );
710                 free_iob ( iob );
711                 iob = eiob;
712         }
713
714         return netdev_tx ( dev->netdev, iob );
715 }
716
717
718 /* ---------- Driver API ---------- */
719
720 /**
721  * Allocate 802.11 device
722  *
723  * @v priv_size         Size of driver-private allocation area
724  * @ret dev             Newly allocated 802.11 device
725  *
726  * This function allocates a net_device with space in its private area
727  * for both the net80211_device it will wrap and the driver-private
728  * data space requested. It initializes the link-layer-specific parts
729  * of the net_device, and links the net80211_device to the net_device
730  * appropriately.
731  */
732 struct net80211_device * net80211_alloc ( size_t priv_size )
733 {
734         struct net80211_device *dev;
735         struct net_device *netdev =
736                 alloc_netdev ( sizeof ( *dev ) + priv_size );
737
738         if ( ! netdev )
739                 return NULL;
740
741         netdev->ll_protocol = &net80211_ll_protocol;
742         netdev->ll_broadcast = net80211_ll_broadcast;
743         netdev->max_pkt_len = IEEE80211_MAX_DATA_LEN;
744         netdev_init ( netdev, &net80211_netdev_ops );
745
746         dev = netdev->priv;
747         dev->netdev = netdev;
748         dev->priv = ( u8 * ) dev + sizeof ( *dev );
749         dev->op = &net80211_null_ops;
750
751         process_init_stopped ( &dev->proc_assoc, net80211_step_associate,
752                                &netdev->refcnt );
753         INIT_LIST_HEAD ( &dev->mgmt_queue );
754         INIT_LIST_HEAD ( &dev->mgmt_info_queue );
755
756         return dev;
757 }
758
759 /**
760  * Register 802.11 device with network stack
761  *
762  * @v dev       802.11 device
763  * @v ops       802.11 device operations
764  * @v hw        802.11 hardware information
765  *
766  * This also registers the wrapping net_device with the higher network
767  * layers.
768  */
769 int net80211_register ( struct net80211_device *dev,
770                         struct net80211_device_operations *ops,
771                         struct net80211_hw_info *hw )
772 {
773         dev->op = ops;
774         dev->hw = malloc ( sizeof ( *hw ) );
775         if ( ! dev->hw )
776                 return -ENOMEM;
777
778         memcpy ( dev->hw, hw, sizeof ( *hw ) );
779         memcpy ( dev->netdev->hw_addr, hw->hwaddr, ETH_ALEN );
780
781         /* Set some sensible channel defaults for driver's open() function */
782         memcpy ( dev->channels, dev->hw->channels,
783                  NET80211_MAX_CHANNELS * sizeof ( dev->channels[0] ) );
784         dev->channel = 0;
785
786         list_add_tail ( &dev->list, &net80211_devices );
787         return register_netdev ( dev->netdev );
788 }
789
790 /**
791  * Unregister 802.11 device from network stack
792  *
793  * @v dev       802.11 device
794  *
795  * After this call, the device operations are cleared so that they
796  * will not be called.
797  */
798 void net80211_unregister ( struct net80211_device *dev )
799 {
800         unregister_netdev ( dev->netdev );
801         list_del ( &dev->list );
802         dev->op = &net80211_null_ops;
803 }
804
805 /**
806  * Free 802.11 device
807  *
808  * @v dev       802.11 device
809  *
810  * The device should be unregistered before this function is called.
811  */
812 void net80211_free ( struct net80211_device *dev )
813 {
814         free ( dev->hw );
815         rc80211_free ( dev->rctl );
816         netdev_nullify ( dev->netdev );
817         netdev_put ( dev->netdev );
818 }
819
820
821 /* ---------- 802.11 network management workhorse code ---------- */
822
823 /**
824  * Set state of 802.11 device
825  *
826  * @v dev       802.11 device
827  * @v clear     Bitmask of flags to clear
828  * @v set       Bitmask of flags to set
829  * @v status    Status or reason code for most recent operation
830  *
831  * If @a status represents a reason code, it should be OR'ed with
832  * NET80211_IS_REASON.
833  *
834  * Clearing authentication also clears association; clearing
835  * association also clears security handshaking state. Clearing
836  * association removes the link-up flag from the wrapping net_device,
837  * but setting it does not automatically set the flag; that is left to
838  * the judgment of higher-level code.
839  */
840 static inline void net80211_set_state ( struct net80211_device *dev,
841                                         short clear, short set,
842                                         u16 status )
843 {
844         /* The conditions in this function are deliberately formulated
845            to be decidable at compile-time in most cases. Since clear
846            and set are generally passed as constants, the body of this
847            function can be reduced down to a few statements by the
848            compiler. */
849
850         const int statmsk = NET80211_STATUS_MASK | NET80211_IS_REASON;
851
852         if ( clear & NET80211_PROBED )
853                 clear |= NET80211_AUTHENTICATED;
854
855         if ( clear & NET80211_AUTHENTICATED )
856                 clear |= NET80211_ASSOCIATED;
857
858         if ( clear & NET80211_ASSOCIATED )
859                 clear |= NET80211_CRYPTO_SYNCED;
860
861         dev->state = ( dev->state & ~clear ) | set;
862         dev->state = ( dev->state & ~statmsk ) | ( status & statmsk );
863
864         if ( clear & NET80211_ASSOCIATED )
865                 netdev_link_down ( dev->netdev );
866
867         if ( ( clear | set ) & NET80211_ASSOCIATED )
868                 dev->op->config ( dev, NET80211_CFG_ASSOC );
869
870         if ( status != 0 ) {
871                 if ( status & NET80211_IS_REASON )
872                         dev->assoc_rc = -E80211_REASON ( status );
873                 else
874                         dev->assoc_rc = -E80211_STATUS ( status );
875                 netdev_link_err ( dev->netdev, dev->assoc_rc );
876         }
877 }
878
879 /**
880  * Add channels to 802.11 device
881  *
882  * @v dev       802.11 device
883  * @v start     First channel number to add
884  * @v len       Number of channels to add
885  * @v txpower   TX power (dBm) to allow on added channels
886  *
887  * To replace the current list of channels instead of adding to it,
888  * set the nr_channels field of the 802.11 device to 0 before calling
889  * this function.
890  */
891 static void net80211_add_channels ( struct net80211_device *dev, int start,
892                                     int len, int txpower )
893 {
894         int i, chan = start;
895
896         for ( i = dev->nr_channels; len-- && i < NET80211_MAX_CHANNELS; i++ ) {
897                 dev->channels[i].channel_nr = chan;
898                 dev->channels[i].maxpower = txpower;
899                 dev->channels[i].hw_value = 0;
900
901                 if ( chan >= 1 && chan <= 14 ) {
902                         dev->channels[i].band = NET80211_BAND_2GHZ;
903                         if ( chan == 14 )
904                                 dev->channels[i].center_freq = 2484;
905                         else
906                                 dev->channels[i].center_freq = 2407 + 5 * chan;
907                         chan++;
908                 } else {
909                         dev->channels[i].band = NET80211_BAND_5GHZ;
910                         dev->channels[i].center_freq = 5000 + 5 * chan;
911                         chan += 4;
912                 }
913         }
914
915         dev->nr_channels = i;
916 }
917
918 /**
919  * Filter 802.11 device channels for hardware capabilities
920  *
921  * @v dev       802.11 device
922  *
923  * Hardware may support fewer channels than regulatory restrictions
924  * allow; this function filters out channels in dev->channels that are
925  * not supported by the hardware list in dev->hwinfo. It also copies
926  * over the net80211_channel::hw_value and limits maximum TX power
927  * appropriately.
928  *
929  * Channels are matched based on center frequency, ignoring band and
930  * channel number.
931  *
932  * If the driver specifies no supported channels, the effect will be
933  * as though all were supported.
934  */
935 static void net80211_filter_hw_channels ( struct net80211_device *dev )
936 {
937         int delta = 0, i = 0;
938         int old_freq = dev->channels[dev->channel].center_freq;
939         struct net80211_channel *chan, *hwchan;
940
941         if ( ! dev->hw->nr_channels )
942                 return;
943
944         dev->channel = 0;
945         for ( chan = dev->channels; chan < dev->channels + dev->nr_channels;
946               chan++, i++ ) {
947                 int ok = 0;
948                 for ( hwchan = dev->hw->channels;
949                       hwchan < dev->hw->channels + dev->hw->nr_channels;
950                       hwchan++ ) {
951                         if ( hwchan->center_freq == chan->center_freq ) {
952                                 ok = 1;
953                                 break;
954                         }
955                 }
956
957                 if ( ! ok )
958                         delta++;
959                 else {
960                         chan->hw_value = hwchan->hw_value;
961                         if ( hwchan->maxpower != 0 &&
962                              chan->maxpower > hwchan->maxpower )
963                                 chan->maxpower = hwchan->maxpower;
964                         if ( old_freq == chan->center_freq )
965                                 dev->channel = i - delta;
966                         if ( delta )
967                                 chan[-delta] = *chan;
968                 }
969         }
970
971         dev->nr_channels -= delta;
972
973         if ( dev->channels[dev->channel].center_freq != old_freq )
974                 dev->op->config ( dev, NET80211_CFG_CHANNEL );
975 }
976
977 /**
978  * Update 802.11 device state to reflect received capabilities field
979  *
980  * @v dev       802.11 device
981  * @v capab     Capabilities field in beacon, probe, or association frame
982  * @ret rc      Return status code
983  */
984 static int net80211_process_capab ( struct net80211_device *dev,
985                                     u16 capab )
986 {
987         u16 old_phy = dev->phy_flags;
988
989         if ( ( capab & ( IEEE80211_CAPAB_MANAGED | IEEE80211_CAPAB_ADHOC ) ) !=
990              IEEE80211_CAPAB_MANAGED ) {
991                 DBGC ( dev, "802.11 %p cannot handle IBSS network\n", dev );
992                 return -ENOSYS;
993         }
994
995         if ( capab & IEEE80211_CAPAB_SPECTRUM_MGMT ) {
996                 DBGC ( dev, "802.11 %p cannot handle spectrum managed "
997                        "network\n", dev );
998                 return -ENOSYS;
999         }
1000
1001         dev->phy_flags &= ~( NET80211_PHY_USE_SHORT_PREAMBLE |
1002                              NET80211_PHY_USE_SHORT_SLOT );
1003
1004         if ( capab & IEEE80211_CAPAB_SHORT_PMBL )
1005                 dev->phy_flags |= NET80211_PHY_USE_SHORT_PREAMBLE;
1006
1007         if ( capab & IEEE80211_CAPAB_SHORT_SLOT )
1008                 dev->phy_flags |= NET80211_PHY_USE_SHORT_SLOT;
1009
1010         if ( old_phy != dev->phy_flags )
1011                 dev->op->config ( dev, NET80211_CFG_PHY_PARAMS );
1012
1013         return 0;
1014 }
1015
1016 /**
1017  * Update 802.11 device state to reflect received information elements
1018  *
1019  * @v dev       802.11 device
1020  * @v ie        Pointer to first information element
1021  * @v ie_end    Pointer to tail of packet I/O buffer
1022  * @ret rc      Return status code
1023  */
1024 static int net80211_process_ie ( struct net80211_device *dev,
1025                                  union ieee80211_ie *ie, void *ie_end )
1026 {
1027         u16 old_rate = dev->rates[dev->rate];
1028         u16 old_phy = dev->phy_flags;
1029         int have_rates = 0, i;
1030         int ds_channel = 0;
1031         int changed = 0;
1032         int band = dev->channels[dev->channel].band;
1033
1034         if ( ( void * ) ie >= ie_end )
1035                 return 0;
1036
1037         for ( ; ie; ie = ieee80211_next_ie ( ie, ie_end ) ) {
1038                 switch ( ie->id ) {
1039                 case IEEE80211_IE_SSID:
1040                         if ( ie->len <= 32 ) {
1041                                 memcpy ( dev->essid, ie->ssid, ie->len );
1042                                 dev->essid[ie->len] = 0;
1043                         }
1044                         break;
1045
1046                 case IEEE80211_IE_RATES:
1047                 case IEEE80211_IE_EXT_RATES:
1048                         if ( ! have_rates ) {
1049                                 dev->nr_rates = 0;
1050                                 dev->basic_rates = 0;
1051                                 have_rates = 1;
1052                         }
1053                         for ( i = 0; i < ie->len &&
1054                               dev->nr_rates < NET80211_MAX_RATES; i++ ) {
1055                                 u8 rid = ie->rates[i];
1056                                 u16 rate = ( rid & 0x7f ) * 5;
1057
1058                                 if ( rid & 0x80 )
1059                                         dev->basic_rates |=
1060                                                 ( 1 << dev->nr_rates );
1061
1062                                 dev->rates[dev->nr_rates++] = rate;
1063                         }
1064
1065                         break;
1066
1067                 case IEEE80211_IE_DS_PARAM:
1068                         if ( dev->channel < dev->nr_channels && ds_channel ==
1069                              dev->channels[dev->channel].channel_nr )
1070                                 break;
1071                         ds_channel = ie->ds_param.current_channel;
1072                         net80211_change_channel ( dev, ds_channel );
1073                         break;
1074
1075                 case IEEE80211_IE_COUNTRY:
1076                         dev->nr_channels = 0;
1077
1078                         DBGC ( dev, "802.11 %p setting country regulations "
1079                                "for %c%c\n", dev, ie->country.name[0],
1080                                ie->country.name[1] );
1081                         for ( i = 0; i < ( ie->len - 3 ) / 3; i++ ) {
1082                                 union ieee80211_ie_country_triplet *t =
1083                                         &ie->country.triplet[i];
1084                                 if ( t->first > 200 ) {
1085                                         DBGC ( dev, "802.11 %p ignoring regulatory "
1086                                                "extension information\n", dev );
1087                                 } else {
1088                                         net80211_add_channels ( dev,
1089                                                         t->band.first_channel,
1090                                                         t->band.nr_channels,
1091                                                         t->band.max_txpower );
1092                                 }
1093                         }
1094                         net80211_filter_hw_channels ( dev );
1095                         break;
1096
1097                 case IEEE80211_IE_ERP_INFO:
1098                         dev->phy_flags &= ~( NET80211_PHY_USE_PROTECTION |
1099                                              NET80211_PHY_USE_SHORT_PREAMBLE );
1100                         if ( ie->erp_info & IEEE80211_ERP_USE_PROTECTION )
1101                                 dev->phy_flags |= NET80211_PHY_USE_PROTECTION;
1102                         if ( ! ( ie->erp_info & IEEE80211_ERP_BARKER_LONG ) )
1103                                 dev->phy_flags |= NET80211_PHY_USE_SHORT_PREAMBLE;
1104                         break;
1105
1106                 case IEEE80211_IE_RSN:
1107                         /* XXX need to implement WPA stuff */
1108                         break;
1109                 }
1110         }
1111
1112         if ( have_rates ) {
1113                 /* Allow only those rates that are also supported by
1114                    the hardware. */
1115                 int delta = 0, j;
1116
1117                 dev->rate = 0;
1118                 for ( i = 0; i < dev->nr_rates; i++ ) {
1119                         int ok = 0;
1120                         for ( j = 0; j < dev->hw->nr_rates[band]; j++ ) {
1121                                 if ( dev->hw->rates[band][j] == dev->rates[i] ){
1122                                         ok = 1;
1123                                         break;
1124                                 }
1125                         }
1126
1127                         if ( ! ok )
1128                                 delta++;
1129                         else {
1130                                 dev->rates[i - delta] = dev->rates[i];
1131                                 if ( old_rate == dev->rates[i] )
1132                                         dev->rate = i - delta;
1133                         }
1134                 }
1135
1136                 dev->nr_rates -= delta;
1137
1138                 /* Sort available rates - sorted subclumps tend to already
1139                    exist, so insertion sort works well. */
1140                 for ( i = 1; i < dev->nr_rates; i++ ) {
1141                         u16 rate = dev->rates[i];
1142
1143                         for ( j = i - 1; j >= 0 && dev->rates[j] >= rate; j-- )
1144                                 dev->rates[j + 1] = dev->rates[j];
1145                         dev->rates[j + 1] = rate;
1146                 }
1147
1148                 net80211_set_rtscts_rate ( dev );
1149
1150                 if ( dev->rates[dev->rate] != old_rate )
1151                         changed |= NET80211_CFG_RATE;
1152         }
1153
1154         if ( dev->hw->flags & NET80211_HW_NO_SHORT_PREAMBLE )
1155                 dev->phy_flags &= ~NET80211_PHY_USE_SHORT_PREAMBLE;
1156         if ( dev->hw->flags & NET80211_HW_NO_SHORT_SLOT )
1157                 dev->phy_flags &= ~NET80211_PHY_USE_SHORT_SLOT;
1158
1159         if ( old_phy != dev->phy_flags )
1160                 changed |= NET80211_CFG_PHY_PARAMS;
1161
1162         if ( changed )
1163                 dev->op->config ( dev, changed );
1164
1165         return 0;
1166 }
1167
1168 /**
1169  * Create information elements for outgoing probe or association packet
1170  *
1171  * @v dev               802.11 device
1172  * @v ie                Pointer to start of information element area
1173  * @ret next_ie         Pointer to first byte after added information elements
1174  */
1175 static union ieee80211_ie *
1176 net80211_marshal_request_info ( struct net80211_device *dev,
1177                                 union ieee80211_ie *ie )
1178 {
1179         int i;
1180
1181         ie->id = IEEE80211_IE_SSID;
1182         ie->len = strlen ( dev->essid );
1183         memcpy ( ie->ssid, dev->essid, ie->len );
1184
1185         ie = ieee80211_next_ie ( ie, NULL );
1186
1187         ie->id = IEEE80211_IE_RATES;
1188         ie->len = dev->nr_rates;
1189         for ( i = 0; i < ie->len; i++ ) {
1190                 ie->rates[i] = dev->rates[i] / 5;
1191                 if ( dev->basic_rates & ( 1 << i ) )
1192                         ie->rates[i] |= 0x80;
1193         }
1194
1195         if ( ie->len > 8 ) {
1196                 /* 802.11 requires we use an Extended Basic Rates IE
1197                    for the rates beyond the eighth. */
1198                 int rates = ie->len;
1199
1200                 memmove ( ( void * ) ie + 2 + 8 + 2, ( void * ) ie + 2 + 8,
1201                           rates - 8 );
1202                 ie->len = 8;
1203
1204                 ie = ieee80211_next_ie ( ie, NULL );
1205
1206                 ie->id = IEEE80211_IE_EXT_RATES;
1207                 ie->len = rates - 8;
1208         }
1209
1210         ie = ieee80211_next_ie ( ie, NULL );
1211
1212         return ie;
1213 }
1214
1215 /** Seconds to wait after finding a network, to possibly find better APs for it
1216  *
1217  * This is used when a specific SSID to scan for is specified.
1218  */
1219 #define NET80211_PROBE_GATHER    1
1220
1221 /** Seconds to wait after finding a network, to possibly find other networks
1222  *
1223  * This is used when an empty SSID is specified, to scan for all
1224  * networks.
1225  */
1226 #define NET80211_PROBE_GATHER_ALL 2
1227
1228 /** Seconds to allow a probe to take if no network has been found */
1229 #define NET80211_PROBE_TIMEOUT   6
1230
1231 /**
1232  * Begin probe of 802.11 networks
1233  *
1234  * @v dev       802.11 device
1235  * @v essid     SSID to probe for, or "" to accept any (may not be NULL)
1236  * @v active    Whether to use active scanning
1237  * @ret ctx     Probe context
1238  *
1239  * Active scanning may only be used on channels 1-11 in the 2.4GHz
1240  * band, due to gPXE's lack of a complete regulatory database. If
1241  * active scanning is used, probe packets will be sent on each
1242  * channel; this can allow association with hidden-SSID networks if
1243  * the SSID is properly specified.
1244  *
1245  * A @c NULL return indicates an out-of-memory condition.
1246  *
1247  * The returned context must be periodically passed to
1248  * net80211_probe_step() until that function returns zero.
1249  */
1250 struct net80211_probe_ctx * net80211_probe_start ( struct net80211_device *dev,
1251                                                    const char *essid,
1252                                                    int active )
1253 {
1254         struct net80211_probe_ctx *ctx = zalloc ( sizeof ( *ctx ) );
1255
1256         if ( ! ctx )
1257                 return NULL;
1258
1259         assert ( dev->netdev->state & NETDEV_OPEN );
1260
1261         ctx->dev = dev;
1262         ctx->old_keep_mgmt = net80211_keep_mgmt ( dev, 1 );
1263         ctx->essid = essid;
1264         if ( dev->essid != ctx->essid )
1265                 strcpy ( dev->essid, ctx->essid );
1266
1267         if ( active ) {
1268                 struct ieee80211_probe_req *probe_req;
1269                 union ieee80211_ie *ie;
1270
1271                 ctx->probe = alloc_iob ( 128 );
1272                 iob_reserve ( ctx->probe, IEEE80211_TYP_FRAME_HEADER_LEN );
1273                 probe_req = ctx->probe->data;
1274
1275                 ie = net80211_marshal_request_info ( dev,
1276                                                      probe_req->info_element );
1277                 ie->id = IEEE80211_IE_REQUEST;
1278                 ie->len = 3;
1279                 ie->request[0] = IEEE80211_IE_COUNTRY;
1280                 ie->request[1] = IEEE80211_IE_ERP_INFO;
1281                 ie->request[2] = IEEE80211_IE_RSN;
1282
1283                 ie = ieee80211_next_ie ( ie, NULL );
1284
1285                 iob_put ( ctx->probe, ( void * ) ie - ctx->probe->data );
1286         }
1287
1288         ctx->ticks_start = currticks();
1289         ctx->ticks_beacon = 0;
1290         ctx->ticks_channel = currticks();
1291         ctx->hop_time = ticks_per_sec() / ( active ? 2 : 6 );
1292
1293         /*
1294          * Channels on 2.4GHz overlap, and the most commonly used
1295          * are 1, 6, and 11. We'll get a result faster if we check
1296          * every 5 channels, but in order to hit all of them the
1297          * number of channels must be relatively prime to 5. If it's
1298          * not, tweak the hop.
1299          */
1300         ctx->hop_step = 5;
1301         while ( dev->nr_channels % ctx->hop_step == 0 && ctx->hop_step > 1 )
1302                 ctx->hop_step--;
1303
1304         ctx->beacons = malloc ( sizeof ( *ctx->beacons ) );
1305         INIT_LIST_HEAD ( ctx->beacons );
1306
1307         dev->channel = 0;
1308         dev->op->config ( dev, NET80211_CFG_CHANNEL );
1309
1310         return ctx;
1311 }
1312
1313 /**
1314  * Continue probe of 802.11 networks
1315  *
1316  * @v ctx       Probe context returned by net80211_probe_start()
1317  * @ret rc      Probe status
1318  *
1319  * The return code will be 0 if the probe is still going on (and this
1320  * function should be called again), a positive number if the probe
1321  * completed successfully, or a negative error code if the probe
1322  * failed for that reason.
1323  *
1324  * Whether the probe succeeded or failed, you must call
1325  * net80211_probe_finish_all() or net80211_probe_finish_best()
1326  * (depending on whether you want information on all networks or just
1327  * the best-signal one) in order to release the probe context. A
1328  * failed probe may still have acquired some valid data.
1329  */
1330 int net80211_probe_step ( struct net80211_probe_ctx *ctx )
1331 {
1332         struct net80211_device *dev = ctx->dev;
1333         u32 start_timeout = NET80211_PROBE_TIMEOUT * ticks_per_sec();
1334         u32 gather_timeout = ticks_per_sec();
1335         u32 now = currticks();
1336         struct io_buffer *iob;
1337         int signal;
1338         int rc;
1339         char ssid[IEEE80211_MAX_SSID_LEN + 1];
1340
1341         gather_timeout *= ( ctx->essid[0] ? NET80211_PROBE_GATHER :
1342                             NET80211_PROBE_GATHER_ALL );
1343
1344         /* Time out if necessary */
1345         if ( now >= ctx->ticks_start + start_timeout )
1346                 return list_empty ( ctx->beacons ) ? -ETIMEDOUT : +1;
1347
1348         if ( ctx->ticks_beacon > 0 && now >= ctx->ticks_start + gather_timeout )
1349                 return +1;
1350
1351         /* Change channels if necessary */
1352         if ( now >= ctx->ticks_channel + ctx->hop_time ) {
1353                 dev->channel = ( dev->channel + ctx->hop_step )
1354                         % dev->nr_channels;
1355                 dev->op->config ( dev, NET80211_CFG_CHANNEL );
1356                 udelay ( dev->hw->channel_change_time );
1357
1358                 ctx->ticks_channel = now;
1359
1360                 if ( ctx->probe ) {
1361                         struct io_buffer *siob = ctx->probe; /* to send */
1362
1363                         /* make a copy for future use */
1364                         iob = alloc_iob ( siob->tail - siob->head );
1365                         iob_reserve ( iob, iob_headroom ( siob ) );
1366                         memcpy ( iob_put ( iob, iob_len ( siob ) ),
1367                                  siob->data, iob_len ( siob ) );
1368
1369                         ctx->probe = iob;
1370                         rc = net80211_tx_mgmt ( dev, IEEE80211_STYPE_PROBE_REQ,
1371                                                 net80211_ll_broadcast,
1372                                                 iob_disown ( siob ) );
1373                         if ( rc ) {
1374                                 DBGC ( dev, "802.11 %p send probe failed: "
1375                                        "%s\n", dev, strerror ( rc ) );
1376                                 return rc;
1377                         }
1378                 }
1379         }
1380
1381         /* Check for new management packets */
1382         while ( ( iob = net80211_mgmt_dequeue ( dev, &signal ) ) != NULL ) {
1383                 struct ieee80211_frame *hdr;
1384                 struct ieee80211_beacon *beacon;
1385                 union ieee80211_ie *ie;
1386                 struct net80211_wlan *wlan;
1387                 u16 type;
1388
1389                 hdr = iob->data;
1390                 type = hdr->fc & IEEE80211_FC_SUBTYPE;
1391                 beacon = ( struct ieee80211_beacon * ) hdr->data;
1392
1393                 if ( type != IEEE80211_STYPE_BEACON &&
1394                      type != IEEE80211_STYPE_PROBE_RESP ) {
1395                         DBGC2 ( dev, "802.11 %p probe: non-beacon\n", dev );
1396                         goto drop;
1397                 }
1398
1399                 if ( ( void * ) beacon->info_element >= iob->tail ) {
1400                         DBGC ( dev, "802.11 %p probe: beacon with no IEs\n",
1401                                dev );
1402                         goto drop;
1403                 }
1404
1405                 ie = beacon->info_element;
1406                 while ( ie && ie->id != IEEE80211_IE_SSID )
1407                         ie = ieee80211_next_ie ( ie, iob->tail );
1408
1409                 if ( ! ie ) {
1410                         DBGC ( dev, "802.11 %p probe: beacon with no SSID\n",
1411                                dev );
1412                         goto drop;
1413                 }
1414
1415                 memcpy ( ssid, ie->ssid, ie->len );
1416                 ssid[ie->len] = 0;
1417
1418                 if ( ctx->essid[0] && strcmp ( ctx->essid, ssid ) != 0 ) {
1419                         DBGC2 ( dev, "802.11 %p probe: beacon with wrong SSID "
1420                                 "(%s)\n", dev, ssid );
1421                         goto drop;
1422                 }
1423
1424                 /* See if we've got an entry for this network */
1425                 list_for_each_entry ( wlan, ctx->beacons, list ) {
1426                         if ( strcmp ( wlan->essid, ssid ) != 0 )
1427                                 continue;
1428
1429                         if ( signal < wlan->signal ) {
1430                                 DBGC2 ( dev, "802.11 %p probe: beacon for %s "
1431                                         "(%s) with weaker signal %d\n", dev,
1432                                         ssid, eth_ntoa ( hdr->addr3 ), signal );
1433                                 goto drop;
1434                         }
1435
1436                         goto fill;
1437                 }
1438
1439                 /* No entry yet - make one */
1440                 wlan = zalloc ( sizeof ( *wlan ) );
1441                 strcpy ( wlan->essid, ssid );
1442                 list_add_tail ( &wlan->list, ctx->beacons );
1443
1444                 /* Whether we're using an old entry or a new one, fill
1445                    it with new data. */
1446         fill:
1447                 memcpy ( wlan->bssid, hdr->addr3, ETH_ALEN );
1448                 wlan->signal = signal;
1449                 wlan->channel = dev->channels[dev->channel].channel_nr;
1450
1451                 /* Copy this I/O buffer into a new wlan->beacon; the
1452                  * iob we've got probably came from the device driver
1453                  * and may have the full 2.4k allocation, which we
1454                  * don't want to keep around wasting memory.
1455                  */
1456                 free_iob ( wlan->beacon );
1457                 wlan->beacon = alloc_iob ( iob_len ( iob ) );
1458                 memcpy ( iob_put ( wlan->beacon, iob_len ( iob ) ),
1459                          iob->data, iob_len ( iob ) );
1460
1461                 /* XXX actually check capab and RSN ie to
1462                    figure this out */
1463                 wlan->handshaking = NET80211_SECPROT_NONE;
1464                 wlan->crypto = NET80211_CRYPT_NONE;
1465
1466                 ctx->ticks_beacon = now;
1467
1468                 DBGC2 ( dev, "802.11 %p probe: good beacon for %s (%s)\n",
1469                         dev, wlan->essid, eth_ntoa ( wlan->bssid ) );
1470
1471         drop:
1472                 free_iob ( iob );
1473         }
1474
1475         return 0;
1476 }
1477
1478
1479 /**
1480  * Finish probe of 802.11 networks, returning best-signal network found
1481  *
1482  * @v ctx       Probe context
1483  * @ret wlan    Best-signal network found, or @c NULL if none were found
1484  *
1485  * If net80211_probe_start() was called with a particular SSID
1486  * parameter as filter, only a network with that SSID (matching
1487  * case-sensitively) can be returned from this function.
1488  */
1489 struct net80211_wlan *
1490 net80211_probe_finish_best ( struct net80211_probe_ctx *ctx )
1491 {
1492         struct net80211_wlan *best = NULL, *wlan;
1493
1494         if ( ! ctx )
1495                 return NULL;
1496
1497         list_for_each_entry ( wlan, ctx->beacons, list ) {
1498                 if ( ! best || best->signal < wlan->signal )
1499                         best = wlan;
1500         }
1501
1502         if ( best )
1503                 list_del ( &best->list );
1504         else
1505                 DBGC ( ctx->dev, "802.11 %p probe: found nothing for '%s'\n",
1506                        ctx->dev, ctx->essid );
1507
1508         net80211_free_wlanlist ( ctx->beacons );
1509
1510         net80211_keep_mgmt ( ctx->dev, ctx->old_keep_mgmt );
1511
1512         if ( ctx->probe )
1513                 free_iob ( ctx->probe );
1514
1515         free ( ctx );
1516
1517         return best;
1518 }
1519
1520
1521 /**
1522  * Finish probe of 802.11 networks, returning all networks found
1523  *
1524  * @v ctx       Probe context
1525  * @ret list    List of net80211_wlan detailing networks found
1526  *
1527  * If net80211_probe_start() was called with a particular SSID
1528  * parameter as filter, this will always return either an empty or a
1529  * one-element list.
1530  */
1531 struct list_head *net80211_probe_finish_all ( struct net80211_probe_ctx *ctx )
1532 {
1533         struct list_head *beacons = ctx->beacons;
1534
1535         if ( ! ctx )
1536                 return NULL;
1537
1538         net80211_keep_mgmt ( ctx->dev, ctx->old_keep_mgmt );
1539
1540         if ( ctx->probe )
1541                 free_iob ( ctx->probe );
1542
1543         free ( ctx );
1544
1545         return beacons;
1546 }
1547
1548
1549 /**
1550  * Free WLAN structure
1551  *
1552  * @v wlan      WLAN structure to free
1553  */
1554 void net80211_free_wlan ( struct net80211_wlan *wlan )
1555 {
1556         if ( wlan ) {
1557                 free_iob ( wlan->beacon );
1558                 free ( wlan );
1559         }
1560 }
1561
1562
1563 /**
1564  * Free list of WLAN structures
1565  *
1566  * @v list      List of WLAN structures to free
1567  */
1568 void net80211_free_wlanlist ( struct list_head *list )
1569 {
1570         struct net80211_wlan *wlan, *tmp;
1571
1572         if ( ! list )
1573                 return;
1574
1575         list_for_each_entry_safe ( wlan, tmp, list, list ) {
1576                 list_del ( &wlan->list );
1577                 net80211_free_wlan ( wlan );
1578         }
1579
1580         free ( list );
1581 }
1582
1583
1584 /** Number of ticks to wait for replies to association management frames */
1585 #define ASSOC_TIMEOUT   TICKS_PER_SEC
1586
1587 /** Number of times to try sending a particular association management frame */
1588 #define ASSOC_RETRIES   2
1589
1590 /**
1591  * Step 802.11 association process
1592  *
1593  * @v proc      Association process
1594  */
1595 static void net80211_step_associate ( struct process *proc )
1596 {
1597         struct net80211_device *dev =
1598             container_of ( proc, struct net80211_device, proc_assoc );
1599         int rc = 0;
1600         int status = dev->state & NET80211_STATUS_MASK;
1601
1602         /*
1603          * We use a sort of state machine implemented using bits in
1604          * the dev->state variable. At each call, we take the
1605          * logically first step that has not yet succeeded; either it
1606          * has not been tried yet, it's being retried, or it failed.
1607          * If it failed, we return an error indication; otherwise we
1608          * perform the step. If it succeeds, RX handling code will set
1609          * the appropriate status bit for us.
1610          *
1611          * Probe works a bit differently, since we have to step it
1612          * on every call instead of waiting for a packet to arrive
1613          * that will set the completion bit for us.
1614          */
1615
1616         /* If we're waiting for a reply, check for timeout condition */
1617         if ( dev->state & NET80211_WAITING ) {
1618                 /* Sanity check */
1619                 if ( ! dev->associating )
1620                         return;
1621
1622                 if ( currticks() - dev->ctx.assoc->last_packet > ASSOC_TIMEOUT ) {
1623                         /* Timed out - fail if too many retries, or retry */
1624                         dev->ctx.assoc->times_tried++;
1625                         if ( ++dev->ctx.assoc->times_tried > ASSOC_RETRIES ) {
1626                                 rc = -ETIMEDOUT;
1627                                 goto fail;
1628                         }
1629                 } else {
1630                         /* Didn't time out - let it keep going */
1631                         return;
1632                 }
1633         } else {
1634                 if ( dev->state & NET80211_PROBED )
1635                         dev->ctx.assoc->times_tried = 0;
1636         }
1637
1638         if ( ! ( dev->state & NET80211_PROBED ) ) {
1639                 /* state: probe */
1640
1641                 if ( ! dev->ctx.probe ) {
1642                         /* start probe */
1643                         int active = fetch_intz_setting ( NULL,
1644                                                 &net80211_active_setting );
1645                         int band = dev->hw->bands;
1646
1647                         if ( active )
1648                                 band &= ~NET80211_BAND_BIT_5GHZ;
1649
1650                         rc = net80211_prepare_probe ( dev, band, active );
1651                         if ( rc )
1652                                 goto fail;
1653
1654                         dev->ctx.probe = net80211_probe_start ( dev, dev->essid,
1655                                                                 active );
1656                         if ( ! dev->ctx.probe ) {
1657                                 dev->assoc_rc = -ENOMEM;
1658                                 goto fail;
1659                         }
1660                 }
1661
1662                 rc = net80211_probe_step ( dev->ctx.probe );
1663                 if ( ! rc ) {
1664                         return; /* still going */
1665                 }
1666
1667                 dev->associating = net80211_probe_finish_best ( dev->ctx.probe );
1668                 dev->ctx.probe = NULL;
1669                 if ( ! dev->associating ) {
1670                         if ( rc > 0 ) /* "successful" probe found nothing */
1671                                 rc = -ETIMEDOUT;
1672                         goto fail;
1673                 }
1674
1675                 /* If we probed using a broadcast SSID, record that
1676                    fact for the settings applicator before we clobber
1677                    it with the specific SSID we've chosen. */
1678                 if ( ! dev->essid[0] )
1679                         dev->state |= NET80211_AUTO_SSID;
1680
1681                 DBGC ( dev, "802.11 %p found network %s (%s)\n", dev,
1682                        dev->associating->essid,
1683                        eth_ntoa ( dev->associating->bssid ) );
1684
1685                 dev->ctx.assoc = zalloc ( sizeof ( *dev->ctx.assoc ) );
1686                 if ( ! dev->ctx.assoc ) {
1687                         rc = -ENOMEM;
1688                         goto fail;
1689                 }
1690
1691                 dev->state |= NET80211_PROBED;
1692                 dev->ctx.assoc->method = IEEE80211_AUTH_OPEN_SYSTEM;
1693
1694                 return;
1695         }
1696
1697         /* Record time of sending the packet we're about to send, for timeout */
1698         dev->ctx.assoc->last_packet = currticks();
1699
1700         if ( ! ( dev->state & NET80211_AUTHENTICATED ) ) {
1701                 /* state: prepare and authenticate */
1702
1703                 if ( status != IEEE80211_STATUS_SUCCESS ) {
1704                         /* we tried authenticating already, but failed */
1705                         int method = dev->ctx.assoc->method;
1706
1707                         if ( method == IEEE80211_AUTH_OPEN_SYSTEM &&
1708                              ( status == IEEE80211_STATUS_AUTH_CHALL_INVALID ||
1709                                status == IEEE80211_STATUS_AUTH_ALGO_UNSUPP ) ) {
1710                                 /* Maybe this network uses Shared Key? */
1711                                 dev->ctx.assoc->method =
1712                                         IEEE80211_AUTH_SHARED_KEY;
1713                         } else {
1714                                 goto fail;
1715                         }
1716                 }
1717
1718                 DBGC ( dev, "802.11 %p authenticating with method %d\n", dev,
1719                        dev->ctx.assoc->method );
1720
1721                 rc = net80211_prepare_assoc ( dev, dev->associating );
1722                 if ( rc )
1723                         goto fail;
1724
1725                 rc = net80211_send_auth ( dev, dev->associating,
1726                                           dev->ctx.assoc->method );
1727                 if ( rc )
1728                         goto fail;
1729
1730                 return;
1731         }
1732
1733         if ( ! ( dev->state & NET80211_ASSOCIATED ) ) {
1734                 /* state: associate */
1735
1736                 if ( status != IEEE80211_STATUS_SUCCESS )
1737                         goto fail;
1738
1739                 DBGC ( dev, "802.11 %p associating\n", dev );
1740
1741                 rc = net80211_send_assoc ( dev, dev->associating );
1742                 if ( rc )
1743                         goto fail;
1744
1745                 return;
1746         }
1747
1748         if ( ! ( dev->state & NET80211_CRYPTO_SYNCED ) ) {
1749                 /* state: crypto sync */
1750                 DBGC ( dev, "802.11 %p security handshaking\n", dev );
1751
1752                 dev->state |= NET80211_CRYPTO_SYNCED;
1753                 /* XXX need to actually do something here once we
1754                    support WPA */
1755                 return;
1756         }
1757
1758         /* state: done! */
1759         netdev_link_up ( dev->netdev );
1760         dev->assoc_rc = 0;
1761         dev->state &= ~NET80211_WORKING;
1762
1763         free ( dev->ctx.assoc );
1764         dev->ctx.assoc = NULL;
1765
1766         net80211_free_wlan ( dev->associating );
1767         dev->associating = NULL;
1768
1769         dev->rctl = rc80211_init ( dev );
1770
1771         process_del ( proc );
1772
1773         DBGC ( dev, "802.11 %p associated with %s (%s)\n", dev,
1774                dev->essid, eth_ntoa ( dev->bssid ) );
1775
1776         return;
1777
1778  fail:
1779         dev->state &= ~( NET80211_WORKING | NET80211_WAITING );
1780         if ( rc )
1781                 dev->assoc_rc = rc;
1782
1783         netdev_link_err ( dev->netdev, dev->assoc_rc );
1784
1785         /* We never reach here from the middle of a probe, so we don't
1786            need to worry about freeing dev->ctx.probe. */
1787
1788         if ( dev->state & NET80211_PROBED ) {
1789                 free ( dev->ctx.assoc );
1790                 dev->ctx.assoc = NULL;
1791         }
1792
1793         net80211_free_wlan ( dev->associating );
1794         dev->associating = NULL;
1795
1796         process_del ( proc );
1797
1798         DBGC ( dev, "802.11 %p association failed (state=%04x): "
1799                "%s\n", dev, dev->state, strerror ( dev->assoc_rc ) );
1800
1801         /* Try it again: */
1802         net80211_autoassociate ( dev );
1803 }
1804
1805 /**
1806  * Check for 802.11 SSID updates
1807  *
1808  * This acts as a settings applicator; if the user changes netX/ssid,
1809  * and netX is currently open, the association task will be invoked
1810  * again.
1811  */
1812 static int net80211_check_ssid_update ( void )
1813 {
1814         struct net80211_device *dev;
1815         char ssid[IEEE80211_MAX_SSID_LEN + 1];
1816
1817         list_for_each_entry ( dev, &net80211_devices, list ) {
1818                 if ( ! ( dev->netdev->state & NETDEV_OPEN ) )
1819                         continue;
1820
1821                 fetch_string_setting ( netdev_settings ( dev->netdev ),
1822                                        &net80211_ssid_setting, ssid,
1823                                        IEEE80211_MAX_SSID_LEN + 1 );
1824
1825                 if ( strcmp ( ssid, dev->essid ) != 0 &&
1826                      ! ( ! ssid[0] && ( dev->state & NET80211_AUTO_SSID ) ) ) {
1827                         DBGC ( dev, "802.11 %p updating association: "
1828                                "%s -> %s\n", dev, dev->essid, ssid );
1829                         net80211_autoassociate ( dev );
1830                 }
1831         }
1832
1833         return 0;
1834 }
1835
1836 /**
1837  * Start 802.11 association process
1838  *
1839  * @v dev       802.11 device
1840  *
1841  * If the association process is running, it will be restarted.
1842  */
1843 void net80211_autoassociate ( struct net80211_device *dev )
1844 {
1845         if ( ! ( dev->state & NET80211_WORKING ) ) {
1846                 DBGC2 ( dev, "802.11 %p spawning association process\n", dev );
1847                 process_add ( &dev->proc_assoc );
1848         }
1849
1850         /* Clean up everything an earlier association process might
1851            have been in the middle of using */
1852         if ( dev->associating )
1853                 net80211_free_wlan ( dev->associating );
1854
1855         if ( ! ( dev->state & NET80211_PROBED ) )
1856                 net80211_free_wlan (
1857                         net80211_probe_finish_best ( dev->ctx.probe ) );
1858         else
1859                 free ( dev->ctx.assoc );
1860
1861         /* Reset to a clean state */
1862         fetch_string_setting ( netdev_settings ( dev->netdev ),
1863                                &net80211_ssid_setting, dev->essid,
1864                                IEEE80211_MAX_SSID_LEN + 1 );
1865         dev->ctx.probe = NULL;
1866         dev->associating = NULL;
1867         net80211_set_state ( dev, NET80211_PROBED, NET80211_WORKING, 0 );
1868 }
1869
1870 /**
1871  * Pick TX rate for RTS/CTS packets based on data rate
1872  *
1873  * @v dev       802.11 device
1874  *
1875  * The RTS/CTS rate is the fastest TX rate marked as "basic" that is
1876  * not faster than the data rate.
1877  */
1878 static void net80211_set_rtscts_rate ( struct net80211_device *dev )
1879 {
1880         u16 datarate = dev->rates[dev->rate];
1881         u16 rtsrate = 0;
1882         int rts_idx = -1;
1883         int i;
1884
1885         for ( i = 0; i < dev->nr_rates; i++ ) {
1886                 u16 rate = dev->rates[i];
1887
1888                 if ( ! ( dev->basic_rates & ( 1 << i ) ) || rate > datarate )
1889                         continue;
1890
1891                 if ( rate > rtsrate ) {
1892                         rtsrate = rate;
1893                         rts_idx = i;
1894                 }
1895         }
1896
1897         /* If this is in initialization, we might not have any basic
1898            rates; just use the first data rate in that case. */
1899         if ( rts_idx < 0 )
1900                 rts_idx = 0;
1901
1902         dev->rtscts_rate = rts_idx;
1903 }
1904
1905 /**
1906  * Set data transmission rate for 802.11 device
1907  *
1908  * @v dev       802.11 device
1909  * @v rate      Rate to set, as index into @c dev->rates array
1910  */
1911 void net80211_set_rate_idx ( struct net80211_device *dev, int rate )
1912 {
1913         assert ( dev->netdev->state & NETDEV_OPEN );
1914
1915         if ( rate >= 0 && rate < dev->nr_rates && rate != dev->rate ) {
1916                 DBGC2 ( dev, "802.11 %p changing rate from %d->%d Mbps\n",
1917                         dev, dev->rates[dev->rate] / 10,
1918                         dev->rates[rate] / 10 );
1919
1920                 dev->rate = rate;
1921                 net80211_set_rtscts_rate ( dev );
1922                 dev->op->config ( dev, NET80211_CFG_RATE );
1923         }
1924 }
1925
1926 /**
1927  * Configure 802.11 device to transmit on a certain channel
1928  *
1929  * @v dev       802.11 device
1930  * @v channel   Channel number (1-11 for 2.4GHz) to transmit on
1931  */
1932 int net80211_change_channel ( struct net80211_device *dev, int channel )
1933 {
1934         int i, oldchan = dev->channel;
1935
1936         assert ( dev->netdev->state & NETDEV_OPEN );
1937
1938         for ( i = 0; i < dev->nr_channels; i++ ) {
1939                 if ( dev->channels[i].channel_nr == channel ) {
1940                         dev->channel = i;
1941                         break;
1942                 }
1943         }
1944
1945         if ( i == dev->nr_channels )
1946                 return -ENOENT;
1947
1948         if ( i != oldchan )
1949                 return dev->op->config ( dev, NET80211_CFG_CHANNEL );
1950
1951         return 0;
1952 }
1953
1954 /**
1955  * Prepare 802.11 device channel and rate set for scanning
1956  *
1957  * @v dev       802.11 device
1958  * @v band      RF band(s) on which to prepare for scanning
1959  * @v active    Whether the scanning will be active
1960  * @ret rc      Return status code
1961  */
1962 int net80211_prepare_probe ( struct net80211_device *dev, int band,
1963                              int active )
1964 {
1965         assert ( dev->netdev->state & NETDEV_OPEN );
1966
1967         if ( active && ( band & NET80211_BAND_BIT_5GHZ ) ) {
1968                 DBGC ( dev, "802.11 %p cannot perform active scanning on "
1969                        "5GHz band\n", dev );
1970                 return -EINVAL_ACTIVE_SCAN;
1971         }
1972
1973         if ( band == 0 ) {
1974                 /* This can happen for a 5GHz-only card with 5GHz
1975                    scanning masked out by an active request. */
1976                 DBGC ( dev, "802.11 %p asked to prepare for scanning nothing\n",
1977                        dev );
1978                 return -EINVAL_ACTIVE_SCAN;
1979         }
1980
1981         dev->nr_channels = 0;
1982
1983         if ( active )
1984                 net80211_add_channels ( dev, 1, 11, NET80211_REG_TXPOWER );
1985         else {
1986                 if ( band & NET80211_BAND_BIT_2GHZ )
1987                         net80211_add_channels ( dev, 1, 14,
1988                                                 NET80211_REG_TXPOWER );
1989                 if ( band & NET80211_BAND_BIT_5GHZ )
1990                         net80211_add_channels ( dev, 36, 8,
1991                                                 NET80211_REG_TXPOWER );
1992         }
1993
1994         net80211_filter_hw_channels ( dev );
1995
1996         /* Use channel 1 for now */
1997         dev->channel = 0;
1998         dev->op->config ( dev, NET80211_CFG_CHANNEL );
1999
2000         /* Always do active probes at lowest (presumably first) speed */
2001         dev->rate = 0;
2002         dev->nr_rates = 1;
2003         dev->rates[0] = dev->hw->rates[dev->channels[0].band][0];
2004         dev->op->config ( dev, NET80211_CFG_RATE );
2005
2006         return 0;
2007 }
2008
2009 /**
2010  * Prepare 802.11 device channel and rate set for communication
2011  *
2012  * @v dev       802.11 device
2013  * @v wlan      WLAN to prepare for communication with
2014  * @ret rc      Return status code
2015  */
2016 int net80211_prepare_assoc ( struct net80211_device *dev,
2017                              struct net80211_wlan *wlan )
2018 {
2019         struct ieee80211_frame *hdr = wlan->beacon->data;
2020         struct ieee80211_beacon *beacon =
2021                 ( struct ieee80211_beacon * ) hdr->data;
2022         int rc;
2023
2024         assert ( dev->netdev->state & NETDEV_OPEN );
2025
2026         net80211_set_state ( dev, NET80211_ASSOCIATED, 0, 0 );
2027         memcpy ( dev->bssid, wlan->bssid, ETH_ALEN );
2028         strcpy ( dev->essid, wlan->essid );
2029
2030         dev->last_beacon_timestamp = beacon->timestamp;
2031         dev->tx_beacon_interval = 1024 * beacon->beacon_interval;
2032
2033         /* XXX do crypto setup here */
2034
2035         /* Barring an IE that tells us the channel outright, assume
2036            the channel we heard this AP best on is the channel it's
2037            communicating on. */
2038         net80211_change_channel ( dev, wlan->channel );
2039
2040         rc = net80211_process_capab ( dev, beacon->capability );
2041         if ( rc )
2042                 return rc;
2043
2044         rc = net80211_process_ie ( dev, beacon->info_element,
2045                                    wlan->beacon->tail );
2046         if ( rc )
2047                 return rc;
2048
2049         /* Associate at the lowest rate so we know it'll get through */
2050         dev->rate = 0;
2051         dev->op->config ( dev, NET80211_CFG_RATE );
2052
2053         return 0;
2054 }
2055
2056 /**
2057  * Send 802.11 initial authentication frame
2058  *
2059  * @v dev       802.11 device
2060  * @v wlan      WLAN to authenticate with
2061  * @v method    Authentication method
2062  * @ret rc      Return status code
2063  *
2064  * @a method may be 0 for Open System authentication or 1 for Shared
2065  * Key authentication. Open System provides no security in association
2066  * whatsoever, relying on encryption for confidentiality, but Shared
2067  * Key actively introduces security problems and is very rarely used.
2068  */
2069 int net80211_send_auth ( struct net80211_device *dev,
2070                          struct net80211_wlan *wlan, int method )
2071 {
2072         struct io_buffer *iob = alloc_iob ( 64 );
2073         struct ieee80211_auth *auth;
2074
2075         net80211_set_state ( dev, 0, NET80211_WAITING, 0 );
2076         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
2077         auth = iob_put ( iob, sizeof ( *auth ) );
2078         auth->algorithm = method;
2079         auth->tx_seq = 1;
2080         auth->status = 0;
2081
2082         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_AUTH, wlan->bssid, iob );
2083 }
2084
2085 /**
2086  * Handle receipt of 802.11 authentication frame
2087  *
2088  * @v dev       802.11 device
2089  * @v iob       I/O buffer
2090  *
2091  * If the authentication method being used is Shared Key, and the
2092  * frame that was received included challenge text, the frame is
2093  * encrypted using the cryptographic algorithm currently in effect and
2094  * sent back to the AP to complete the authentication.
2095  */
2096 static void net80211_handle_auth ( struct net80211_device *dev,
2097                                    struct io_buffer *iob )
2098 {
2099         struct ieee80211_frame *hdr = iob->data;
2100         struct ieee80211_auth *auth =
2101             ( struct ieee80211_auth * ) hdr->data;
2102
2103         if ( auth->tx_seq & 1 ) {
2104                 DBGC ( dev, "802.11 %p authentication received improperly "
2105                        "directed frame (seq. %d)\n", dev, auth->tx_seq );
2106                 net80211_set_state ( dev, NET80211_WAITING, 0,
2107                                      IEEE80211_STATUS_FAILURE );
2108                 return;
2109         }
2110
2111         if ( auth->status != IEEE80211_STATUS_SUCCESS ) {
2112                 DBGC ( dev, "802.11 %p authentication failed: status %d\n",
2113                        dev, auth->status );
2114                 net80211_set_state ( dev, NET80211_WAITING, 0,
2115                                      auth->status );
2116                 return;
2117         }
2118
2119         if ( auth->algorithm == IEEE80211_AUTH_SHARED_KEY && ! dev->crypto ) {
2120                 DBGC ( dev, "802.11 %p can't perform shared-key authentication "
2121                        "without a cryptosystem\n", dev );
2122                 net80211_set_state ( dev, NET80211_WAITING, 0,
2123                                      IEEE80211_STATUS_FAILURE );
2124                 return;
2125         }
2126
2127         if ( auth->algorithm == IEEE80211_AUTH_SHARED_KEY &&
2128              auth->tx_seq == 2 ) {
2129                 /* Since the iob we got is going to be freed as soon
2130                    as we return, we can do some in-place
2131                    modification. */
2132                 auth->tx_seq = 3;
2133                 auth->status = 0;
2134
2135                 memcpy ( hdr->addr2, hdr->addr1, ETH_ALEN );
2136                 memcpy ( hdr->addr1, hdr->addr3, ETH_ALEN );
2137
2138                 netdev_tx ( dev->netdev,
2139                             dev->crypto->encrypt ( dev->crypto, iob ) );
2140                 return;
2141         }
2142
2143         net80211_set_state ( dev, NET80211_WAITING, NET80211_AUTHENTICATED,
2144                              IEEE80211_STATUS_SUCCESS );
2145
2146         return;
2147 }
2148
2149 /**
2150  * Send 802.11 association frame
2151  *
2152  * @v dev       802.11 device
2153  * @v wlan      WLAN to associate with
2154  * @ret rc      Return status code
2155  */
2156 int net80211_send_assoc ( struct net80211_device *dev,
2157                           struct net80211_wlan *wlan )
2158 {
2159         struct io_buffer *iob = alloc_iob ( 128 );
2160         struct ieee80211_assoc_req *assoc;
2161         union ieee80211_ie *ie;
2162
2163         net80211_set_state ( dev, 0, NET80211_WAITING, 0 );
2164
2165         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
2166         assoc = iob->data;
2167
2168         assoc->capability = IEEE80211_CAPAB_MANAGED;
2169         if ( ! ( dev->hw->flags & NET80211_HW_NO_SHORT_PREAMBLE ) )
2170                 assoc->capability |= IEEE80211_CAPAB_SHORT_PMBL;
2171         if ( ! ( dev->hw->flags & NET80211_HW_NO_SHORT_SLOT ) )
2172                 assoc->capability |= IEEE80211_CAPAB_SHORT_SLOT;
2173         if ( wlan->crypto )
2174                 assoc->capability |= IEEE80211_CAPAB_PRIVACY;
2175
2176         assoc->listen_interval = 1;
2177
2178         ie = net80211_marshal_request_info ( dev, assoc->info_element );
2179
2180         DBGP ( "802.11 %p about to send association request:\n", dev );
2181         DBGP_HD ( iob->data, ( void * ) ie - iob->data );
2182
2183         /* XXX add RSN ie for WPA support */
2184
2185         iob_put ( iob, ( void * ) ie - iob->data );
2186
2187         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_ASSOC_REQ,
2188                                   wlan->bssid, iob );
2189 }
2190
2191 /**
2192  * Handle receipt of 802.11 association reply frame
2193  *
2194  * @v dev       802.11 device
2195  * @v iob       I/O buffer
2196  */
2197 static void net80211_handle_assoc_reply ( struct net80211_device *dev,
2198                                           struct io_buffer *iob )
2199 {
2200         struct ieee80211_frame *hdr = iob->data;
2201         struct ieee80211_assoc_resp *assoc =
2202                 ( struct ieee80211_assoc_resp * ) hdr->data;
2203
2204         net80211_process_capab ( dev, assoc->capability );
2205         net80211_process_ie ( dev, assoc->info_element, iob->tail );
2206
2207         if ( assoc->status != IEEE80211_STATUS_SUCCESS ) {
2208                 DBGC ( dev, "802.11 %p association failed: status %d\n",
2209                        dev, assoc->status );
2210                 net80211_set_state ( dev, NET80211_WAITING, 0,
2211                                      assoc->status );
2212                 return;
2213         }
2214
2215         /* ESSID was filled before the association request was sent */
2216         memcpy ( dev->bssid, hdr->addr3, ETH_ALEN );
2217         dev->aid = assoc->aid;
2218
2219         net80211_set_state ( dev, NET80211_WAITING, NET80211_ASSOCIATED,
2220                              IEEE80211_STATUS_SUCCESS );
2221 }
2222
2223
2224 /**
2225  * Send 802.11 disassociation frame
2226  *
2227  * @v dev       802.11 device
2228  * @v reason    Reason for disassociation
2229  * @ret rc      Return status code
2230  */
2231 static int net80211_send_disassoc ( struct net80211_device *dev, int reason )
2232 {
2233         struct io_buffer *iob = alloc_iob ( 64 );
2234         struct ieee80211_disassoc *disassoc;
2235
2236         if ( ! ( dev->state & NET80211_ASSOCIATED ) )
2237                 return -EINVAL;
2238
2239         net80211_set_state ( dev, NET80211_ASSOCIATED, 0, 0 );
2240         iob_reserve ( iob, IEEE80211_TYP_FRAME_HEADER_LEN );
2241         disassoc = iob_put ( iob, sizeof ( *disassoc ) );
2242         disassoc->reason = reason;
2243
2244         return net80211_tx_mgmt ( dev, IEEE80211_STYPE_DISASSOC, dev->bssid,
2245                                   iob );
2246 }
2247
2248
2249 /** Smoothing factor (1-7) for link quality calculation */
2250 #define LQ_SMOOTH       7
2251
2252 /**
2253  * Update link quality information based on received beacon
2254  *
2255  * @v dev       802.11 device
2256  * @v iob       I/O buffer containing beacon
2257  * @ret rc      Return status code
2258  */
2259 static void net80211_update_link_quality ( struct net80211_device *dev,
2260                                            struct io_buffer *iob )
2261 {
2262         struct ieee80211_frame *hdr = iob->data;
2263         struct ieee80211_beacon *beacon;
2264         u32 dt, rxi;
2265
2266         if ( ! ( dev->state & NET80211_ASSOCIATED ) )
2267                 return;
2268
2269         beacon = ( struct ieee80211_beacon * ) hdr->data;
2270         dt = ( u32 ) ( beacon->timestamp - dev->last_beacon_timestamp );
2271         rxi = dev->rx_beacon_interval;
2272
2273         rxi = ( LQ_SMOOTH * rxi ) + ( ( 8 - LQ_SMOOTH ) * dt );
2274         dev->rx_beacon_interval = rxi >> 3;
2275
2276         dev->last_beacon_timestamp = beacon->timestamp;
2277 }
2278
2279
2280 /**
2281  * Handle receipt of 802.11 management frame
2282  *
2283  * @v dev       802.11 device
2284  * @v iob       I/O buffer
2285  * @v signal    Signal strength of received frame
2286  */
2287 static void net80211_handle_mgmt ( struct net80211_device *dev,
2288                                    struct io_buffer *iob, int signal )
2289 {
2290         struct ieee80211_frame *hdr = iob->data;
2291         struct ieee80211_disassoc *disassoc;
2292         u16 stype = hdr->fc & IEEE80211_FC_SUBTYPE;
2293         int keep = 0;
2294         int is_deauth = ( stype == IEEE80211_STYPE_DEAUTH );
2295
2296         if ( ( hdr->fc & IEEE80211_FC_TYPE ) != IEEE80211_TYPE_MGMT ) {
2297                 free_iob ( iob );
2298                 return;         /* only handle management frames */
2299         }
2300
2301         switch ( stype ) {
2302                 /* We reconnect on deauthentication and disassociation. */
2303         case IEEE80211_STYPE_DEAUTH:
2304         case IEEE80211_STYPE_DISASSOC:
2305                 disassoc = ( struct ieee80211_disassoc * ) hdr->data;
2306                 net80211_set_state ( dev, is_deauth ? NET80211_AUTHENTICATED :
2307                                      NET80211_ASSOCIATED, 0,
2308                                      NET80211_IS_REASON | disassoc->reason );
2309                 DBGC ( dev, "802.11 %p %s: reason %d\n",
2310                        dev, is_deauth ? "deauthenticated" : "disassociated",
2311                        disassoc->reason );
2312
2313                 /* Try to reassociate, in case it's transient. */
2314                 net80211_autoassociate ( dev );
2315
2316                 break;
2317
2318                 /* We handle authentication and association. */
2319         case IEEE80211_STYPE_AUTH:
2320                 if ( ! ( dev->state & NET80211_AUTHENTICATED ) )
2321                         net80211_handle_auth ( dev, iob );
2322                 break;
2323
2324         case IEEE80211_STYPE_ASSOC_RESP:
2325         case IEEE80211_STYPE_REASSOC_RESP:
2326                 if ( ! ( dev->state & NET80211_ASSOCIATED ) )
2327                         net80211_handle_assoc_reply ( dev, iob );
2328                 break;
2329
2330                 /* We pass probes and beacons onto network scanning
2331                    code. Pass actions for future extensibility. */
2332         case IEEE80211_STYPE_BEACON:
2333                 net80211_update_link_quality ( dev, iob );
2334                 /* fall through */
2335         case IEEE80211_STYPE_PROBE_RESP:
2336         case IEEE80211_STYPE_ACTION:
2337                 if ( dev->keep_mgmt ) {
2338                         struct net80211_rx_info *rxinf;
2339                         rxinf = zalloc ( sizeof ( *rxinf ) );
2340                         if ( ! rxinf ) {
2341                                 DBGC ( dev, "802.11 %p out of memory\n", dev );
2342                                 break;
2343                         }
2344                         rxinf->signal = signal;
2345                         list_add_tail ( &iob->list, &dev->mgmt_queue );
2346                         list_add_tail ( &rxinf->list, &dev->mgmt_info_queue );
2347                         keep = 1;
2348                 }
2349                 break;
2350
2351         case IEEE80211_STYPE_PROBE_REQ:
2352                 /* Some nodes send these broadcast. Ignore them. */
2353                 break;
2354
2355         case IEEE80211_STYPE_ASSOC_REQ:
2356         case IEEE80211_STYPE_REASSOC_REQ:
2357                 /* We should never receive these, only send them. */
2358                 DBGC ( dev, "802.11 %p received strange management request "
2359                        "(%04x)\n", dev, stype );
2360                 break;
2361
2362         default:
2363                 DBGC ( dev, "802.11 %p received unimplemented management "
2364                        "packet (%04x)\n", dev, stype );
2365                 break;
2366         }
2367
2368         if ( ! keep )
2369                 free_iob ( iob );
2370 }
2371
2372 /* ---------- Packet handling functions ---------- */
2373
2374 /**
2375  * Free buffers used by 802.11 fragment cache entry
2376  *
2377  * @v dev       802.11 device
2378  * @v fcid      Fragment cache entry index
2379  *
2380  * After this function, the referenced entry will be marked unused.
2381  */
2382 static void net80211_free_frags ( struct net80211_device *dev, int fcid )
2383 {
2384         int j;
2385         struct net80211_frag_cache *frag = &dev->frags[fcid];
2386
2387         for ( j = 0; j < 16; j++ ) {
2388                 if ( frag->iob[j] ) {
2389                         free_iob ( frag->iob[j] );
2390                         frag->iob[j] = NULL;
2391                 }
2392         }
2393
2394         frag->seqnr = 0;
2395         frag->start_ticks = 0;
2396         frag->in_use = 0;
2397 }
2398
2399 /**
2400  * Accumulate 802.11 fragments into one I/O buffer
2401  *
2402  * @v dev       802.11 device
2403  * @v fcid      Fragment cache entry index
2404  * @v nfrags    Number of fragments received
2405  * @v size      Sum of sizes of all fragments, including headers
2406  * @ret iob     I/O buffer containing reassembled packet
2407  *
2408  * This function does not free the fragment buffers.
2409  */
2410 static struct io_buffer *net80211_accum_frags ( struct net80211_device *dev,
2411                                                 int fcid, int nfrags, int size )
2412 {
2413         struct net80211_frag_cache *frag = &dev->frags[fcid];
2414         int hdrsize = IEEE80211_TYP_FRAME_HEADER_LEN;
2415         int nsize = size - hdrsize * ( nfrags - 1 );
2416         int i;
2417
2418         struct io_buffer *niob = alloc_iob ( nsize );
2419         struct ieee80211_frame *hdr;
2420
2421         /* Add the header from the first one... */
2422         memcpy ( iob_put ( niob, hdrsize ), frag->iob[0]->data, hdrsize );
2423
2424         /* ... and all the data from all of them. */
2425         for ( i = 0; i < nfrags; i++ ) {
2426                 int len = iob_len ( frag->iob[i] ) - hdrsize;
2427                 memcpy ( iob_put ( niob, len ),
2428                          frag->iob[i]->data + hdrsize, len );
2429         }
2430
2431         /* Turn off the fragment bit. */
2432         hdr = niob->data;
2433         hdr->fc &= ~IEEE80211_FC_MORE_FRAG;
2434
2435         return niob;
2436 }
2437
2438 /**
2439  * Handle receipt of 802.11 fragment
2440  *
2441  * @v dev       802.11 device
2442  * @v iob       I/O buffer containing fragment
2443  * @v signal    Signal strength with which fragment was received
2444  */
2445 static void net80211_rx_frag ( struct net80211_device *dev,
2446                                struct io_buffer *iob, int signal )
2447 {
2448         struct ieee80211_frame *hdr = iob->data;
2449         int fragnr = IEEE80211_FRAG ( hdr->seq );
2450
2451         if ( fragnr == 0 && ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2452                 /* start a frag cache entry */
2453                 int i, newest = -1;
2454                 u32 curr_ticks = currticks(), newest_ticks = 0;
2455                 u32 timeout = ticks_per_sec() * NET80211_FRAG_TIMEOUT;
2456
2457                 for ( i = 0; i < NET80211_NR_CONCURRENT_FRAGS; i++ ) {
2458                         if ( dev->frags[i].in_use == 0 )
2459                                 break;
2460
2461                         if ( dev->frags[i].start_ticks + timeout >=
2462                              curr_ticks ) {
2463                                 net80211_free_frags ( dev, i );
2464                                 break;
2465                         }
2466
2467                         if ( dev->frags[i].start_ticks > newest_ticks ) {
2468                                 newest = i;
2469                                 newest_ticks = dev->frags[i].start_ticks;
2470                         }
2471                 }
2472
2473                 /* If we're being sent more concurrent fragmented
2474                    packets than we can handle, drop the newest so the
2475                    older ones have time to complete. */
2476                 if ( i == NET80211_NR_CONCURRENT_FRAGS ) {
2477                         i = newest;
2478                         net80211_free_frags ( dev, i );
2479                 }
2480
2481                 dev->frags[i].in_use = 1;
2482                 dev->frags[i].seqnr = IEEE80211_SEQNR ( hdr->seq );
2483                 dev->frags[i].start_ticks = currticks();
2484                 dev->frags[i].iob[0] = iob;
2485                 return;
2486         } else {
2487                 int i;
2488                 for ( i = 0; i < NET80211_NR_CONCURRENT_FRAGS; i++ ) {
2489                         if ( dev->frags[i].in_use && dev->frags[i].seqnr ==
2490                              IEEE80211_SEQNR ( hdr->seq ) )
2491                                 break;
2492                 }
2493                 if ( i == NET80211_NR_CONCURRENT_FRAGS ) {
2494                         /* Drop non-first not-in-cache fragments */
2495                         DBGC ( dev, "802.11 %p dropped fragment fc=%04x "
2496                                "seq=%04x\n", dev, hdr->fc, hdr->seq );
2497                         free_iob ( iob );
2498                         return;
2499                 }
2500
2501                 dev->frags[i].iob[fragnr] = iob;
2502
2503                 if ( ! ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2504                         int j, size = 0;
2505                         for ( j = 0; j < fragnr; j++ ) {
2506                                 size += iob_len ( dev->frags[i].iob[j] );
2507                                 if ( dev->frags[i].iob[j] == NULL )
2508                                         break;
2509                         }
2510                         if ( j == fragnr ) {
2511                                 /* We've got everything */
2512                                 struct io_buffer *niob =
2513                                     net80211_accum_frags ( dev, i, fragnr,
2514                                                            size );
2515                                 net80211_free_frags ( dev, i );
2516                                 net80211_rx ( dev, niob, signal, 0 );
2517                         } else {
2518                                 DBGC ( dev, "802.11 %p dropping fragmented "
2519                                        "packet due to out-of-order arrival, "
2520                                        "fc=%04x seq=%04x\n", dev, hdr->fc,
2521                                        hdr->seq );
2522                                 net80211_free_frags ( dev, i );
2523                         }
2524                 }
2525         }
2526 }
2527
2528 /**
2529  * Handle receipt of 802.11 frame
2530  *
2531  * @v dev       802.11 device
2532  * @v iob       I/O buffer
2533  * @v signal    Received signal strength
2534  * @v rate      Bitrate at which frame was received, in 100 kbps units
2535  *
2536  * If the rate or signal is unknown, 0 should be passed.
2537  */
2538 void net80211_rx ( struct net80211_device *dev, struct io_buffer *iob,
2539                    int signal, u16 rate )
2540 {
2541         struct ieee80211_frame *hdr = iob->data;
2542         u16 type = hdr->fc & IEEE80211_FC_TYPE;
2543         if ( ( hdr->fc & IEEE80211_FC_VERSION ) != IEEE80211_THIS_VERSION )
2544                 goto drop;      /* drop invalid-version packets */
2545
2546         if ( type == IEEE80211_TYPE_CTRL )
2547                 goto drop;      /* we don't handle control packets,
2548                                    the hardware does */
2549
2550         if ( dev->last_rx_seq == hdr->seq )
2551                 goto drop;      /* avoid duplicate packet */
2552         dev->last_rx_seq = hdr->seq;
2553
2554         if ( dev->hw->flags & NET80211_HW_RX_HAS_FCS ) {
2555                 /* discard the FCS */
2556                 iob_unput ( iob, 4 );
2557         }
2558
2559         if ( hdr->fc & IEEE80211_FC_PROTECTED ) {
2560                 struct io_buffer *niob;
2561                 if ( ! dev->crypto )
2562                         goto drop;      /* can't decrypt packets on an open network */
2563
2564                 niob = dev->crypto->decrypt ( dev->crypto, iob );
2565                 if ( ! niob )
2566                         goto drop;      /* drop failed decryption */
2567                 free_iob ( iob );
2568                 iob = niob;
2569         }
2570
2571         dev->last_signal = signal;
2572
2573         /* Fragments go into the frag cache or get dropped. */
2574         if ( IEEE80211_FRAG ( hdr->seq ) != 0
2575              || ( hdr->fc & IEEE80211_FC_MORE_FRAG ) ) {
2576                 net80211_rx_frag ( dev, iob, signal );
2577                 return;
2578         }
2579
2580         /* Management frames get handled, enqueued, or dropped. */
2581         if ( type == IEEE80211_TYPE_MGMT ) {
2582                 net80211_handle_mgmt ( dev, iob, signal );
2583                 return;
2584         }
2585
2586         /* Data frames get dropped or sent to the net_device. */
2587         if ( ( hdr->fc & IEEE80211_FC_SUBTYPE ) != IEEE80211_STYPE_DATA )
2588                 goto drop;      /* drop QoS, CFP, or null data packets */
2589
2590         /* Update rate-control algorithm */
2591         if ( dev->rctl )
2592                 rc80211_update_rx ( dev, hdr->fc & IEEE80211_FC_RETRY, rate );
2593
2594         /* Pass packet onward */
2595         if ( netdev_link_ok ( dev->netdev ) ) {
2596                 netdev_rx ( dev->netdev, iob );
2597                 return;
2598         }
2599
2600  drop:
2601         DBGC2 ( dev, "802.11 %p dropped packet fc=%04x seq=%04x\n", dev,
2602                 hdr->fc, hdr->seq );
2603         free_iob ( iob );
2604         return;
2605 }
2606
2607 /** Indicate an error in receiving a packet
2608  *
2609  * @v dev       802.11 device
2610  * @v iob       I/O buffer with received packet, or NULL
2611  * @v rc        Error code
2612  *
2613  * This logs the error with the wrapping net_device, and frees iob if
2614  * it is passed.
2615  */
2616 void net80211_rx_err ( struct net80211_device *dev,
2617                        struct io_buffer *iob, int rc )
2618 {
2619         netdev_rx_err ( dev->netdev, iob, rc );
2620 }
2621
2622 /** Indicate the completed transmission of a packet
2623  *
2624  * @v dev       802.11 device
2625  * @v iob       I/O buffer of transmitted packet
2626  * @v retries   Number of times this packet was retransmitted
2627  * @v rc        Error code, or 0 for success
2628  *
2629  * This logs an error with the wrapping net_device if one occurred,
2630  * and removes and frees the I/O buffer from its TX queue. The
2631  * provided retry information is used to tune our transmission rate.
2632  *
2633  * If the packet did not need to be retransmitted because it was
2634  * properly ACKed the first time, @a retries should be 0.
2635  */
2636 void net80211_tx_complete ( struct net80211_device *dev,
2637                             struct io_buffer *iob, int retries, int rc )
2638 {
2639         /* Update rate-control algorithm */
2640         if ( dev->rctl )
2641                 rc80211_update_tx ( dev, retries, rc );
2642
2643         /* Pass completion onward */
2644         netdev_tx_complete_err ( dev->netdev, iob, rc );
2645 }