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