[802.11] Clean up channel and rate handling
[people/oremanj/gpxe.git] / src / include / gpxe / net80211.h
1 #ifndef _GPXE_NET80211_H
2 #define _GPXE_NET80211_H
3
4 #include <gpxe/process.h>
5 #include <gpxe/ieee80211.h>
6 #include <gpxe/iobuf.h>
7 #include <gpxe/netdevice.h>
8
9 /** @file
10  * The gPXE 802.11 MAC layer.
11  */
12
13 /*
14  * Major things NOT YET supported:
15  * - any type of security (WEP, WPA, WPA2, WPA Enterprise)
16  * - CTS-to-self protection for ERPs
17  * - adaptive rate setting
18  * - 802.11n
19  *
20  * Major things that probably will NEVER be supported, barring a
21  * compelling use case and/or corporate sponsorship: 
22  * - QoS
23  * - Contention-free periods
24  * - "ad-hoc" networks (IBSS), monitor mode, host AP mode
25  * - hidden networks on the 5GHz band due to regulatory issues
26  * - spectrum management on the 5GHz band (TPC and DFS), as required
27  *   in some non-US regulatory domains
28  * - Clause 14 PHYs (Frequency-Hopping Spread Spectrum on 2.4GHz)
29  *   and Clause 16 PHYs (infrared) - I'm not aware of any real-world
30  *   use of these.
31  */
32
33 FILE_LICENCE ( GPL2_OR_LATER );
34
35 /* All 802.11 devices are handled using a generic "802.11 device"
36    net_device, with a link in its `priv' field to a net80211_device
37    which we use to handle 802.11-specific details. */
38
39
40 /** @defgroup net80211_band RF bands on which an 802.11 device can transmit */
41 /** @{ */
42
43 /** The 2.4 GHz ISM band, unlicensed in most countries */
44 #define NET80211_BAND_2GHZ      (1 << 0)
45 /** The band from 4.9 GHz to 5.7 GHz, which tends to be more restricted */
46 #define NET80211_BAND_5GHZ      (1 << 1)
47
48 /** @} */
49
50
51 /** @defgroup net80211_mode 802.11 operation modes supported by hardware */
52 /** @{ */
53
54 /** 802.11a: 54 Mbps operation using OFDM signaling on the 5GHz band */
55 #define NET80211_MODE_A         (1 << 0)
56
57 /** 802.11b: 1-11 Mbps operation using DSSS/CCK signaling on the 2.4GHz band */
58 #define NET80211_MODE_B         (1 << 1)
59
60 /** 802.11g: 54 Mbps operation using ERP/OFDM signaling on the 2.4GHz band */
61 #define NET80211_MODE_G         (1 << 2)
62
63 /** 802.11n: High-rate operation using MIMO technology on 2.4GHz or 5GHz */
64 #define NET80211_MODE_N         (1 << 3)
65
66 /** @} */
67
68
69 /** @defgroup net80211_cfg Constants for the net80211 config callback */
70 /** @{ */
71
72 /** Channel choice (@c dev->channel) or regulatory parameters have changed */
73 #define NET80211_CFG_CHANNEL    (1 << 0)
74
75 /** Requested transmission rate (@c dev->rate) has changed */
76 #define NET80211_CFG_RATE       (1 << 1)
77
78 /** Association has been established with a new BSS (@c dev->bssid) */
79 #define NET80211_CFG_ASSOC      (1 << 2)
80
81 /** Low-level link parameters (short preamble, protection, etc) have changed */
82 #define NET80211_CFG_PHY_PARAMS (1 << 3)
83
84 /** @} */
85
86
87 /** An 802.11 security handshaking protocol */
88 enum net80211_security_proto {
89         /** No security handshaking
90          *
91          * This might be used with an open network, or with WEP, as
92          * WEP does not have a cryptographic handshaking phase.
93          */
94         NET80211_SECPROT_NONE = 0,
95
96         /** Pre-shared key handshaking
97          *
98          * This implements the "WPA Personal" handshake. 802.1X
99          * authentication is not performed -- the user supplies a
100          * pre-shared key directly -- but there is a 4-way handshake
101          * between client and AP to verify that both have the same key
102          * without revealing the contents of that key.
103          */
104         NET80211_SECPROT_PSK = 1,
105
106         /** Full EAP 802.1X handshaking
107          *
108          * This implements the "WPA Enterprise" handshake, connecting
109          * to an 802.1X authentication server to provide credentials
110          * and receive a pairwise master key (PMK), which is then used
111          * in the same 4-way handshake as the PSK method.
112          */
113         NET80211_SECPROT_EAP = 2,
114 };
115
116
117 /** An 802.11 data encryption algorithm */
118 enum net80211_crypto_alg {
119         /** No security, an "Open" network */
120         NET80211_CRYPT_NONE = 0,
121
122         /** Network protected with WEP (awful RC4-based system)
123          *
124          * WEP uses a naive application of RC4, with a monotonically
125          * increasing initialization vector that is prepended to the
126          * key to initialize the RC4 keystream. It is highly insecure
127          * and can be completely cracked or subverted using automated,
128          * robust, freely available tools (aircrack-ng) in minutes.
129          *
130          * 40-bit and 104-bit WEP are differentiated only by the size
131          * of the key. They may be advertised as 64-bit and 128-bit,
132          * counting the non-random IV as part of the key bits.
133          */
134         NET80211_CRYPT_WEP = 1,
135
136         /** Network protected with TKIP (better RC4-based system)
137          *
138          * Usually known by its trade name of WPA (Wi-Fi Protected
139          * Access), TKIP implements a message integrity code (MIC)
140          * called Michael, a timestamp counter for replay prevention,
141          * and a key mixing function that together remove almost all
142          * the security problems with WEP. Countermeasures are
143          * implemented to prevent high data-rate attacks.
144          *
145          * There exists one known attack on TKIP, that allows one to
146          * send between 7 and 15 arbitrary short data packets on a
147          * QoS-enabled network given about an hour of data
148          * gathering. Since gPXE does not support QoS for 802.11
149          * networks, this is not a threat to us. The only other method
150          * is a brute-force passphrase attack.
151          */
152         NET80211_CRYPT_TKIP = 2,
153
154         /** Network protected with CCMP (AES-based system)
155          *
156          * Often called WPA2 in commerce, or RSNA (Robust Security
157          * Network Architecture) in the 802.11 standard, CCMP is
158          * highly secure and does not have any known attack vectors.
159          * Since it is based on a block cipher, the statistical
160          * correlation and "chopchop" attacks used with great success
161          * against WEP and minor success against TKIP fail.
162          */
163         NET80211_CRYPT_CCMP = 3,
164 };
165
166
167 /** @defgroup net80211_state Bits for the 802.11 association state field */
168 /** @{ */
169
170 /** An error code indicating the failure mode, or 0 if successful */
171 #define NET80211_STATUS_MASK    0x7F
172
173 /** Whether the error code provided is a "reason" code, not a "status" code */
174 #define NET80211_IS_REASON      0x80
175
176 /** Whether we have successfully authenticated with the network
177  *
178  * This usually has nothing to do with actual security; it is a
179  * holdover from older 802.11 implementation ideas.
180  */
181 #define NET80211_AUTHENTICATED  (1 << 8)
182
183 /** Whether we have successfully associated with the network */
184 #define NET80211_ASSOCIATED     (1 << 9)
185
186 /** Whether we have completed security handshaking with the network
187  *
188  * Once this is set, we can send data packets.
189  */
190 #define NET80211_CRYPTO_SYNCED  (1 << 10)
191
192 /** Whether the auto-association task is running */
193 #define NET80211_WORKING        (1 << 11)
194
195 /** Whether the auto-association task is waiting for a reply from the AP */
196 #define NET80211_WAITING        (1 << 12)
197
198 /** @} */
199
200
201 /** @defgroup net80211_phy 802.11 physical layer flags */
202 /** @{ */
203
204 /** Whether to use RTS/CTS or CTS-to-self protection for transmissions
205  *
206  * Since the RTS or CTS is transmitted using 802.11b signaling, and
207  * includes a field indicating the amount of time that will be used by
208  * transmission of the following packet, this serves as an effective
209  * protection mechanism to avoid 802.11b clients interfering with
210  * 802.11g clients on mixed networks.
211  */
212 #define NET80211_PHY_USE_PROTECTION      (1 << 1)
213
214 /** Whether to use 802.11b short preamble operation
215  *
216  * Short-preamble operation can moderately increase throughput on
217  * 802.11b networks operating between 2Mbps and 11Mbps. It is
218  * irrelevant for 802.11g data rates, since they use a different
219  * modulation scheme.
220  */
221 #define NET80211_PHY_USE_SHORT_PREAMBLE  (1 << 2)
222
223 /** Whether to use 802.11g short slot operation
224  *
225  * This affects a low-level timing parameter of 802.11g transmissions.
226  */
227 #define NET80211_PHY_USE_SHORT_SLOT      (1 << 3)
228
229 /** @} */
230
231
232 /** @defgroup net80211_ratedefs 802.11 layer rate flags */
233 /** @{ */
234
235 /** Get rate (in 100 kbps) from a ratecode */
236 #define NET80211_RATE_VALUE(r)  ((r) & 0x3fff)
237
238 /** Rate flag 1 (reserved) */
239 #define NET80211_RATE_FLAG1     0x8000
240
241 /** Rate flag 2 (reserved) */
242 #define NET80211_RATE_FLAG2     0x4000
243
244 /** @} */
245
246
247 /** The maximum number of TX rates we allow to be configured simultaneously */
248 #define NET80211_MAX_RATES      16
249
250 /** The maximum number of channels we allow to be configured simultaneously */
251 #define NET80211_MAX_CHANNELS   32
252
253 /** Seconds we'll wait to get all fragments of a packet */
254 #define NET80211_FRAG_TIMEOUT   2
255
256 /** The number of fragments we can receive at once
257  *
258  * The 802.11 standard requires that this be at least 3.
259  */
260 #define NET80211_NR_CONCURRENT_FRAGS 3
261
262 /** Maximum TX power to allow (dBm), if we don't get a regulatory hint */
263 #define NET80211_REG_TXPOWER    20
264
265
266 struct net80211_device;
267
268 /** Operations that must be implemented by an 802.11 driver */
269 struct net80211_device_operations {
270         /** Open 802.11 device
271          *
272          * @v dev       802.11 device
273          * @ret rc      Return status code
274          *
275          * This method should allocate RX I/O buffers and enable the
276          * hardware to start transmitting and receiving packets on the
277          * channels its net80211_register() call indicated it could
278          * handle. It does not need to tune the antenna to receive
279          * packets on any particular channel.
280          */
281         int ( * open ) ( struct net80211_device *dev );
282
283         /** Close 802.11 network device
284          *
285          * @v dev       802.11 device
286          *
287          * This method should stop the flow of packets, and call
288          * net80211_tx_complete() for any packets remaining in the
289          * device's TX queue.
290          */
291         void ( * close ) ( struct net80211_device *dev );
292
293         /** Transmit packet on 802.11 network device
294          *
295          * @v dev       802.11 device
296          * @v iobuf     I/O buffer
297          * @ret rc      Return status code
298          *
299          * This method should cause the hardware to initiate
300          * transmission of the I/O buffer, using the channel and rate
301          * most recently indicated by an appropriate call to the
302          * @c config callback. The 802.11 layer guarantees that said
303          * channel and rate will be the same as those currently
304          * reflected in the fields of @a dev.
305          *
306          * If this method returns success, the I/O buffer remains
307          * owned by the network layer's TX queue, and the driver must
308          * eventually call net80211_tx_complete() to free the buffer
309          * whether transmission succeeded or not. If this method
310          * returns failure, it will be interpreted as "failure to
311          * enqueue buffer" and the I/O buffer will be immediately
312          * released.
313          *
314          * This method is guaranteed to be called only when the device
315          * is open.
316          */
317         int ( * transmit ) ( struct net80211_device *dev,
318                              struct io_buffer *iobuf );
319
320         /** Poll for completed and received packets
321          *
322          * @v dev       802.11 device
323          *
324          * This method should cause the hardware to check for
325          * completed transmissions and received packets. Any received
326          * packets should be delivered via net80211_rx(), and
327          * completed transmissions should be indicated using
328          * net80211_tx_complete().
329          *
330          * This method is guaranteed to be called only when the device
331          * is open.
332          */
333         void ( * poll ) ( struct net80211_device *dev );
334
335         /** Enable or disable interrupts
336          *
337          * @v dev       802.11 device
338          * @v enable    If TRUE, interrupts should be enabled
339          */
340         void ( * irq ) ( struct net80211_device *dev, int enable );
341
342         /** Update hardware state to match 802.11 layer state
343          *
344          * @v dev       802.11 device
345          * @v changed   Set of flags indicating what may have changed
346          * @ret rc      Return status code
347          *
348          * This method should cause the hardware state to be
349          * reinitialized from the state indicated in fields of
350          * net80211_device, in the areas indicated by bits set in
351          * @a changed. If the hardware is unable to do so, this method
352          * may return an appropriate error indication.
353          *
354          * This method is guaranteed to be called only when the device
355          * is open.
356          */
357         int ( * config ) ( struct net80211_device *dev, int changed );
358 };
359
360 /** An 802.11 RF channel. */
361 struct net80211_channel
362 {
363         /** The band with which this channel is associated */
364         u8 band;
365
366         /** A channel number interpreted according to the band
367          *
368          * The 2.4GHz band uses channel numbers from 1-13 at 5MHz
369          * intervals such that channel 1 is 2407 MHz; channel 14,
370          * legal for use only in Japan, is defined separately as 2484
371          * MHz. Adjacent channels will overlap, since 802.11
372          * transmissions use a 20 MHz (4-channel) bandwidth. Most
373          * commonly, channels 1, 6, and 11 are used.
374          *
375          * The 5GHz band uses channel numbers derived directly from
376          * the frequency; channel 0 is 5000 MHz, and channels are
377          * always spaced 5 MHz apart. Channel numbers over 180 are
378          * relative to 4GHz instead of 5GHz, but these are rarely
379          * seen. Most channels are not legal for use.
380          */
381         u8 channel_nr;
382
383         /** The center frequency for this channel
384          *
385          * Currently a bandwidth of 20 MHz is assumed.
386          */
387         u16 center_freq;
388
389         /** Maximum allowable transmit power, in dBm
390          *
391          * This should be interpreted as EIRP, the power supplied to
392          * an ideal isotropic antenna in order to achieve the same
393          * average signal intensity as the real hardware at a
394          * particular distance.
395          *
396          * Currently no provision is made for directional antennas.
397          */
398         u8 maxpower;
399 };
400
401 /** Information on the capabilities of an 802.11 hardware device
402  *
403  * In its probe callback, an 802.11 driver must read hardware
404  * registers to determine the appropriate contents of this structure,
405  * fill it, and pass it to net80211_register() so that the 802.11
406  * layer knows how to treat the hardware and what to advertise as
407  * supported to access points.
408  */
409 struct net80211_hw_info
410 {
411         /** Default hardware MAC address.
412          *
413          * The user may change this by setting the @c netX/mac setting
414          * before the driver's open function is called; in that case
415          * the driver must set the hardware MAC address to the address
416          * contained in the wrapping net_device's ll_addr field, or if
417          * that is impossible, set that ll_addr field back to the
418          * unchangeable hardware MAC address.
419          */
420         u8 hwaddr[ETH_ALEN];
421
422         /** A bitwise OR of the 802.11x modes supported by this device */
423         int modes;
424
425         /** A bitwise OR of the bands on which this device can communicate */
426         int bands;
427
428         /** A set of flags indicating peculiarities of this device. */
429         enum {
430                 /** Received frames include a frame check sequence. */
431                 NET80211_HW_RX_HAS_FCS = (1 << 1),
432
433                 /** Hardware doesn't support 2.4GHz short preambles
434                  *
435                  * This is only relevant for 802.11b operation above
436                  * 2Mbps. All 802.11g devices support short preambles.
437                  */
438                 NET80211_HW_NO_SHORT_PREAMBLE = (1 << 2),
439
440                 /** Hardware doesn't support 802.11g short slot operation */
441                 NET80211_HW_NO_SHORT_SLOT = (1 << 3),
442         } flags;
443
444         /** Signal strength information that can be provided by the device
445          *
446          * Signal strength is passed to net80211_rx(), primarily to
447          * allow determination of the closest access point for a
448          * multi-AP network. The units are provided for completeness
449          * of status displays.
450          */
451         enum {
452                 /** No signal strength information supported */
453                 NET80211_SIGNAL_NONE = 0,
454                 /** Signal strength in arbitrary units */
455                 NET80211_SIGNAL_ARBITRARY,
456                 /** Signal strength in decibels relative to arbitrary base */
457                 NET80211_SIGNAL_DB,
458                 /** Signal strength in decibels relative to 1mW */
459                 NET80211_SIGNAL_DBM,
460         } signal_type;
461         
462         /** Maximum signal in arbitrary cases
463          *
464          * If signal_type is NET80211_SIGNAL_ARBITRARY or
465          * NET80211_SIGNAL_DB, the driver should report it on a scale
466          * from 0 to signal_max.
467          */
468         unsigned signal_max;
469
470         /** List of transmission rates supported by the card
471          *
472          * Rates should be in 100kbps increments (e.g. 11 Mbps would
473          * be represented as the number 110).
474          */
475         u16 supported_rates[NET80211_MAX_RATES];
476
477         /** Number of supported rates */
478         int nr_supported_rates;
479
480         /** Estimate of the time required to change channels, in microseconds
481          *
482          * If this is not known, a guess on the order of a few
483          * milliseconds (value of 1000-5000) is reasonable.
484          */
485         unsigned channel_change_time;
486 };
487
488 /** Keeps track of received fragments for a packet
489  *
490  * We set up a fragment cache entry when we receive a packet marked as
491  * fragment 0 with the "more fragments" bit set in its frame control
492  * header. We are required by the 802.11 standard to track 3
493  * fragmented packets arriving simultaneously; if we receive more we
494  * may drop some. Upon receipt of a new fragment-0 packet, if no entry
495  * is available or expired, we take over the most @i recent entry for
496  * the new packet, since we don't want to starve old entries from ever
497  * finishing at all. If we get a fragment after the zeroth with no
498  * cache entry for its packet, we drop it.
499  */
500 struct net80211_frag_cache
501 {
502         /** Whether this cache entry is in use */
503         u8 in_use;
504
505         /** Sequence number of this MSDU (packet) */
506         u16 seqnr;
507
508         /** Timestamp from point at which first fragment was collected */
509         u32 start_ticks;
510
511         /** Buffers for each fragment */
512         struct io_buffer *iob[16];
513 };
514
515 /** Interface to an 802.11 cryptographic algorithm
516  *
517  * Cryptographic algorithms define a net80211_crypto structure
518  * statically, using a gPXE linker table to make it available to the
519  * 802.11 layer. When the algorithm needs to be used, the 802.11 code
520  * will allocate a copy of the static definition plus whatever space
521  * the algorithm has requested for private state, and point
522  * net80211_device::crypto at it.
523  */
524 struct net80211_crypto
525 {
526         /** The cryptographic algorithm implemented */
527         enum net80211_crypto_alg algorithm;
528
529         /** Initialize cryptographic algorithm using a given key
530          *
531          * @v crypto    802.11 cryptographic algorithm
532          * @v key       Pointer to key bytes
533          * @v keylen    Number of key bytes
534          * @ret rc      Return status code
535          *
536          * This method is passed the communication key provided by the
537          * security handshake handler, which will already be in the
538          * low-level form required.
539          */
540         int ( * initialize ) ( struct net80211_crypto *crypto, u8 *key,
541                                int keylen );
542
543         /** Encrypt a frame using the cryptographic algorithm
544          *
545          * @v crypto    802.11 cryptographic algorithm
546          * @v iob       I/O buffer
547          * @ret eiob    Newly allocated I/O buffer with encrypted packet
548          *
549          * This method is called to encrypt a single frame. It is
550          * guaranteed that initialize() will have completed
551          * successfully before this method is called.
552          *
553          * The frame passed already has an 802.11 header prepended,
554          * but the PROTECTED bit in the frame control field will not
555          * be set; this method is responsible for setting it. The
556          * returned I/O buffer should contain a complete copy of @a
557          * iob, including the 802.11 header, but with the PROTECTED
558          * bit set, the data encrypted, and whatever encryption
559          * headers/trailers are necessary added.
560          *
561          * This method should never free the passed I/O buffer.
562          *
563          * Return NULL if the packet could not be encrypted, due to
564          * memory limitations or otherwise.
565          */
566         struct io_buffer * ( * encrypt ) ( struct net80211_crypto *crypto,
567                                            struct io_buffer *iob );
568         
569
570         /** Decrypt a frame using the cryptographic algorithm
571          *
572          * @v crypto    802.11 cryptographic algorithm
573          * @v eiob      Encrypted I/O buffer
574          * @ret iob     Newly allocated I/O buffer with decrypted packet
575          *
576          * This method is called to decrypt a single frame. It is
577          * guaranteed that initialize() will have completed
578          * successfully before this method is called.
579          *
580          * Decryption follows the reverse of the pattern used for
581          * encryption: this method must copy the 802.11 header into
582          * the returned packet, decrypt the data stream, remove any
583          * encryption header or trailer, and clear the PROTECTED bit
584          * in the frame control header.
585          *
586          * This method should never free the passed I/O buffer.
587          *
588          * Return NULL if memory was not available for decryption, if
589          * a consistency or integrity check on the decrypted frame
590          * failed, or if the decrypted frame should not be processed
591          * by the network stack for any other reason.
592          */
593         struct io_buffer * ( * decrypt ) ( struct net80211_crypto *crypto,
594                                            struct io_buffer *iob );
595
596         /** Length of private data requested to be allocated */
597         int priv_len;
598
599         /** Private data for the algorithm to store key and state info */
600         void *priv;
601 };
602
603 /** Structure encapsulating the complete state of an 802.11 device
604  *
605  * An 802.11 device is always wrapped by a network device, and this
606  * network device is always pointed to by the @a netdev field. In
607  * general, operations should never be performed by 802.11 code using
608  * netdev functions directly; for consistency, when such a direct call
609  * would be otherwise valid, an inline wrapper is provided in the
610  * net80211 namespace. It is generally the case that the 802.11 layer
611  * might need to do some processing or bookkeeping on top of what the
612  * netdevice code will do.
613  */
614 struct net80211_device
615 {
616         /** The net_device that wraps us. */
617         struct net_device *netdev;
618
619         /** List of 802.11 devices. */
620         struct list_head list;
621
622         /** 802.11 device operations */
623         struct net80211_device_operations *op;
624
625         /** Driver private data */
626         void *priv;
627
628         /** Information about the hardware, provided to net80211_register() */
629         struct net80211_hw_info *hw;
630
631         /** The asynchronous association process.
632          *
633          * When an 802.11 netdev is opened, or when the user changes
634          * the SSID setting on an open 802.11 device, an
635          * autoassociation task is started by net80211_autoassocate()
636          * to associate with the new best network. The association is
637          * generally asynchronous but may block for a few seconds
638          * during network probing. If it is successful, the wrapping
639          * net_device is set as "link up".
640          */
641         struct process proc_assoc;
642
643         /** Data structure for the association process. */
644         struct net80211_wlan *associating;
645
646         /** A list of all possible channels we might use */
647         struct net80211_channel channels[NET80211_MAX_CHANNELS];
648         /** The number of channels in the channels array */
649         u8 nr_channels;
650         /** The channel currently in use, as an index into the channels array */
651         u8 channel;
652
653         /** A list of all possible TX rates we might use
654          *
655          * Rates are in units of 100 kbps. We reserve two bits for
656          * future flags (e.g. for 802.11n), meaning we can represent
657          * rates up to 1.6 Gbps.
658          */
659         u16 rates[NET80211_MAX_RATES];
660
661         /** The number of transmission rates in the rates array */
662         u8 nr_rates;
663
664         /** The rate currently in use, as an index into the rates array */
665         u8 rate;
666
667         /** The rate to use for RTS/CTS transmissions
668          *
669          * This is always the fastest basic rate that is not faster
670          * than the data rate in use. Also an index into the rates array.
671          */
672         u8 rtscts_rate;
673
674         /** Bitmask of basic rates
675          *
676          * If bit N is set in this value, with the LSB bit 0, then
677          * rate N in the rates array is a "basic" rate.
678          *
679          * We don't decide which rates are "basic"; our AP does, and
680          * we respect its wishes. We need to be able to identify basic
681          * rates in order to calculate the duration of a CTS packet
682          * used for 802.11 g/b interoperability.
683          */
684         u32 basic_rates;
685
686         /** State of our association to the network
687          *
688          * Since the association process happens asynchronously, it's
689          * necessary to have some channel of communication so the
690          * driver can say "I got an association reply and we're OK" or
691          * similar. This variable provides that link. It is a bitmask
692          * of any of NET80211_AUTHENTICATED, NET80211_ASSOCIATED,
693          * NET80211_CRYPTO_SYNCED to indicate how far along in
694          * associating we are; NET80211_WORKING if the association
695          * task is running; and NET80211_WAITING if a packet has been
696          * sent that we're waiting for a reply to. We can only be
697          * crypto-synced if we're associated, and we can only be
698          * associated if we're authenticated.
699          *
700          * If an association process fails (that is, we receive a
701          * packet with an error indication), the error code is copied
702          * into bits 6-0 of this variable and bit 7 is set to specify
703          * what type of error code it is. An AP can provide either a
704          * "status code" (0-51 are defined) explaining why it refused
705          * an association immediately, or a "reason code" (0-45 are
706          * defined) explaining why it canceled an association after it
707          * had originally OK'ed it. Status and reason codes serve
708          * similar functions, but they use separate error message
709          * tables.
710          *
711          * If the failure to associate is indicated by a status code,
712          * the NET80211_IS_REASON bit will be clear; if it is
713          * indicated by a reason code, the bit will be set. If we were
714          * successful, both zero status and zero reason mean success,
715          * so there is no ambiguity.
716          */
717         short state;
718
719         /** 802.11 cryptographic algorithm for our current network
720          *
721          * For an open network, this will be set to NULL.
722          */
723         struct net80211_crypto *crypto;
724
725         /** MAC address of the access point most recently associated */
726         u8 bssid[ETH_ALEN];
727
728         /** SSID of the access point we are or will be associated with
729          *
730          * Although the SSID field in 802.11 packets is generally not
731          * NUL-terminated, here and in net80211_wlan we add a NUL for
732          * convenience.
733          */
734         char essid[IEEE80211_MAX_SSID_LEN+1];
735
736         /** Association ID given to us by the AP */
737         u16 aid;
738
739         /** Physical layer options
740          *
741          * These control the use of CTS protection, short preambles,
742          * and short-slot operation.
743          */
744         int phy_flags;
745
746         /** Signal strength of last received packet */
747         int last_signal;
748
749         /** Fragment reassembly state */
750         struct net80211_frag_cache frags[NET80211_NR_CONCURRENT_FRAGS];
751
752         /** The sequence number of the last packet we sent */
753         u16 last_tx_seqnr;
754
755         /** Packet deduping state
756          *
757          * We are only required to handle immediate duplicates for
758          * each direct sender, and since we can only have one direct
759          * sender (the AP), we need only keep the sequence control
760          * field from the most recent packet we've received. Thus,
761          * this field stores the last sequence control field we've
762          * received for a packet from the AP.
763          */
764         s16 last_rx_seq;
765
766         /** RX management packet queue
767          *
768          * Sometimes we want to keep probe, beacon, and action packets
769          * that we receive, such as when we're scanning for networks.
770          * Ordinarily we drop them because they are sent at a large
771          * volume (ten beacons per second per AP, broadcast) and we
772          * have no need of them except when we're scanning.
773          *
774          * When keep_mgmt is true, received probe, beacon, and action
775          * management packets will be stored in this queue.
776          */
777         struct list_head mgmt_queue;
778
779         /** RX management packet info queue
780          *
781          * We need to keep track of the signal strength for management
782          * packets we're keeping, because that provides the only way
783          * to distinguish between multiple APs for the same network.
784          * Since we can't extend io_buffer to store it, this heads a
785          * linked list of "RX packet info" structures that contain
786          * that signal strength field. Its entries always parallel the
787          * entries in mgmt_queue, because the two queues are always
788          * added to or removed from in parallel.
789          */
790         struct list_head mgmt_info_queue;
791
792         /** Whether to store management packets
793          *
794          * Received beacon, probe, and action packets will be added to
795          * mgmt_queue (and their signal strengths added to
796          * mgmt_info_queue) only when this variable is TRUE. It should
797          * be set by net80211_keep_mgmt() (which returns the old
798          * value) only when calling code is prepared to poll the
799          * management queue frequently, because packets will otherwise
800          * pile up and exhaust memory.
801          */
802         int keep_mgmt;
803 };
804
805 /** Structure representing a probed network.
806  *
807  * This is returned from net80211_probe() and passed to the low-level
808  * association functions. At least essid, bssid, channel, beacon, and
809  * security must be filled in if you want to build this structure
810  * manually.
811  *
812  * This structure is also used by the MAC layer in coordinating the
813  * association state machine for associating with the network it
814  * represents.
815  */
816 struct net80211_wlan
817 {
818         /** The human-readable ESSID (network name)
819          *
820          * Although the 802.11 SSID field is generally not
821          * NUL-terminated, the gPXE code adds an extra NUL (and
822          * expects one in this structure) for convenience.
823          */
824         char essid[IEEE80211_MAX_SSID_LEN+1];
825
826         /** MAC address of the strongest-signal access point for this ESSID */
827         u8 bssid[ETH_ALEN];
828
829         /** Signal strength of beacon frame from that access point */
830         int signal;
831
832         /** The channel on which that access point communicates
833          *
834          * This is a raw channel number (net80211_channel::channel_nr),
835          * so that it will not be affected by reconfiguration of the
836          * device channels array.
837          */
838         int channel;
839
840         /** The complete beacon or probe-response frame received */
841         struct io_buffer *beacon;
842
843         /** One of the NET80211_CRYPT_* constants indicating the
844             security mode of the network. */
845         int security;
846
847         /** Next authentication method to try using */
848         int method;
849
850         /** Time (in ticks) of the last sent association-related packet */
851         int last_packet;
852
853         /** Number of times we have tried sending it */
854         int times_tried;
855
856         /** Link to allow chaining multiple structures into a list to
857             be returned from net80211_scan(). */
858         struct list_head list;
859 };
860
861
862 /** Indicate an error in receiving a packet
863  *
864  * @v dev       802.11 device
865  * @v iob       I/O buffer with received packet, or NULL
866  * @v rc        Error code
867  *
868  * This logs the error with the wrapping net_device, and frees iob if
869  * it is passed.
870  */
871 static inline void net80211_rx_err ( struct net80211_device *dev,
872                                      struct io_buffer *iob, int rc )
873 {
874         netdev_rx_err ( dev->netdev, iob, rc );
875 }
876
877 /** Indicate the completed transmission of a packet
878  *
879  * @v dev       802.11 device
880  * @v iob       I/O buffer of transmitted packet
881  * @v rc        Error code, or 0 for success
882  *
883  * This logs an error with the wrapping net_device if one occurred,
884  * and removes and frees the I/O buffer from its TX queue.
885  */
886 static inline void net80211_tx_complete ( struct net80211_device *dev,
887                                           struct io_buffer *iob, int rc )
888 {
889         netdev_tx_complete_err ( dev->netdev, iob, rc );
890 }
891
892
893 /* Associate with the best or user-specified network: */
894 void net80211_autoassociate ( struct net80211_device *dev );
895
896 /* Find networks: */
897 struct net80211_wlan * net80211_probe ( struct net80211_device *dev,
898                                         const char *essid, int active );
899 void net80211_free_wlan ( struct net80211_wlan *wlan );
900
901 /* Get the 802.11 device from a wrapping net_device: */
902 struct net80211_device * net80211_get ( struct net_device *netdev );
903
904 /* Association steps: */
905 int net80211_prepare_default ( struct net80211_device *dev, int band,
906                                int active );
907 int net80211_prepare ( struct net80211_device *dev,
908                        struct net80211_wlan *wlan );
909 int net80211_send_auth ( struct net80211_device *dev,
910                          struct net80211_wlan *wlan, int method );
911 int net80211_send_assoc ( struct net80211_device *dev,
912                           struct net80211_wlan *wlan );
913
914 /* Management frame handling: */
915 int net80211_keep_mgmt ( struct net80211_device *dev, int enable );
916 struct io_buffer * net80211_mgmt_dequeue ( struct net80211_device *dev,
917                                            int *signal );
918 int net80211_tx_mgmt ( struct net80211_device *dev, u16 fc,
919                        u8 bssid[ETH_ALEN], struct io_buffer *iob );
920
921 /* Driver API: */
922 struct net80211_device *net80211_alloc ( size_t priv_size );
923 int net80211_register ( struct net80211_device *dev,
924                         struct net80211_device_operations *ops,
925                         struct net80211_hw_info *hw );
926 void net80211_rx ( struct net80211_device *dev, struct io_buffer *iob,
927                    int signal );
928 void net80211_unregister ( struct net80211_device *dev );
929 void net80211_free ( struct net80211_device *dev );
930
931 #endif