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