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