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