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