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