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