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