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