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