]> err.no Git - linux-2.6/blob - include/net/ieee80211.h
[PATCH] ieee80211: cleanup
[linux-2.6] / include / net / ieee80211.h
1 /*
2  * Merged with mainline ieee80211.h in Aug 2004.  Original ieee802_11
3  * remains copyright by the original authors
4  *
5  * Portions of the merged code are based on Host AP (software wireless
6  * LAN access point) driver for Intersil Prism2/2.5/3.
7  *
8  * Copyright (c) 2001-2002, SSH Communications Security Corp and Jouni Malinen
9  * <jkmaline@cc.hut.fi>
10  * Copyright (c) 2002-2003, Jouni Malinen <jkmaline@cc.hut.fi>
11  *
12  * Adaption to a generic IEEE 802.11 stack by James Ketrenos
13  * <jketreno@linux.intel.com>
14  * Copyright (c) 2004, Intel Corporation
15  *
16  * This program is free software; you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License version 2 as
18  * published by the Free Software Foundation. See README and COPYING for
19  * more details.
20  */
21 #ifndef IEEE80211_H
22 #define IEEE80211_H
23 #include <linux/if_ether.h> /* ETH_ALEN */
24 #include <linux/kernel.h>   /* ARRAY_SIZE */
25
26 #if WIRELESS_EXT < 17
27 #define IW_QUAL_QUAL_INVALID   0x10
28 #define IW_QUAL_LEVEL_INVALID  0x20
29 #define IW_QUAL_NOISE_INVALID  0x40
30 #define IW_QUAL_QUAL_UPDATED   0x1
31 #define IW_QUAL_LEVEL_UPDATED  0x2
32 #define IW_QUAL_NOISE_UPDATED  0x4
33 #endif
34
35 #define IEEE80211_DATA_LEN              2304
36 /* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
37    6.2.1.1.2.
38
39    The figure in section 7.1.2 suggests a body size of up to 2312
40    bytes is allowed, which is a bit confusing, I suspect this
41    represents the 2304 bytes of real data, plus a possible 8 bytes of
42    WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro) */
43
44
45 #define IEEE80211_HLEN                  30
46 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
47
48 struct ieee80211_hdr {
49         u16 frame_ctl;
50         u16 duration_id;
51         u8 addr1[ETH_ALEN];
52         u8 addr2[ETH_ALEN];
53         u8 addr3[ETH_ALEN];
54         u16 seq_ctl;
55         u8 addr4[ETH_ALEN];
56 } __attribute__ ((packed));
57
58 struct ieee80211_hdr_3addr {
59         u16 frame_ctl;
60         u16 duration_id;
61         u8 addr1[ETH_ALEN];
62         u8 addr2[ETH_ALEN];
63         u8 addr3[ETH_ALEN];
64         u16 seq_ctl;
65 } __attribute__ ((packed));
66
67 enum eap_type {
68         EAP_PACKET = 0,
69         EAPOL_START,
70         EAPOL_LOGOFF,
71         EAPOL_KEY,
72         EAPOL_ENCAP_ASF_ALERT
73 };
74
75 static const char *eap_types[] = {
76         [EAP_PACKET]            = "EAP-Packet",
77         [EAPOL_START]           = "EAPOL-Start",
78         [EAPOL_LOGOFF]          = "EAPOL-Logoff",
79         [EAPOL_KEY]             = "EAPOL-Key",
80         [EAPOL_ENCAP_ASF_ALERT] = "EAPOL-Encap-ASF-Alert"
81 };
82
83 static inline const char *eap_get_type(int type)
84 {
85         return (type >= ARRAY_SIZE(eap_types)) ? "Unknown" : eap_types[type];
86 }
87
88 struct eapol {
89         u8 snap[6];
90         u16 ethertype;
91         u8 version;
92         u8 type;
93         u16 length;
94 } __attribute__ ((packed));
95
96 #define IEEE80211_1ADDR_LEN 10
97 #define IEEE80211_2ADDR_LEN 16
98 #define IEEE80211_3ADDR_LEN 24
99 #define IEEE80211_4ADDR_LEN 30
100 #define IEEE80211_FCS_LEN    4
101
102 #define MIN_FRAG_THRESHOLD     256U
103 #define MAX_FRAG_THRESHOLD     2346U
104
105 /* Frame control field constants */
106 #define IEEE80211_FCTL_VERS             0x0002
107 #define IEEE80211_FCTL_FTYPE            0x000c
108 #define IEEE80211_FCTL_STYPE            0x00f0
109 #define IEEE80211_FCTL_TODS             0x0100
110 #define IEEE80211_FCTL_FROMDS           0x0200
111 #define IEEE80211_FCTL_MOREFRAGS        0x0400
112 #define IEEE80211_FCTL_RETRY            0x0800
113 #define IEEE80211_FCTL_PM               0x1000
114 #define IEEE80211_FCTL_MOREDATA 0x2000
115 #define IEEE80211_FCTL_WEP              0x4000
116 #define IEEE80211_FCTL_ORDER            0x8000
117
118 #define IEEE80211_FTYPE_MGMT            0x0000
119 #define IEEE80211_FTYPE_CTL             0x0004
120 #define IEEE80211_FTYPE_DATA            0x0008
121
122 /* management */
123 #define IEEE80211_STYPE_ASSOC_REQ       0x0000
124 #define IEEE80211_STYPE_ASSOC_RESP      0x0010
125 #define IEEE80211_STYPE_REASSOC_REQ     0x0020
126 #define IEEE80211_STYPE_REASSOC_RESP    0x0030
127 #define IEEE80211_STYPE_PROBE_REQ       0x0040
128 #define IEEE80211_STYPE_PROBE_RESP      0x0050
129 #define IEEE80211_STYPE_BEACON          0x0080
130 #define IEEE80211_STYPE_ATIM            0x0090
131 #define IEEE80211_STYPE_DISASSOC        0x00A0
132 #define IEEE80211_STYPE_AUTH            0x00B0
133 #define IEEE80211_STYPE_DEAUTH          0x00C0
134
135 /* control */
136 #define IEEE80211_STYPE_PSPOLL          0x00A0
137 #define IEEE80211_STYPE_RTS             0x00B0
138 #define IEEE80211_STYPE_CTS             0x00C0
139 #define IEEE80211_STYPE_ACK             0x00D0
140 #define IEEE80211_STYPE_CFEND           0x00E0
141 #define IEEE80211_STYPE_CFENDACK        0x00F0
142
143 /* data */
144 #define IEEE80211_STYPE_DATA            0x0000
145 #define IEEE80211_STYPE_DATA_CFACK      0x0010
146 #define IEEE80211_STYPE_DATA_CFPOLL     0x0020
147 #define IEEE80211_STYPE_DATA_CFACKPOLL  0x0030
148 #define IEEE80211_STYPE_NULLFUNC        0x0040
149 #define IEEE80211_STYPE_CFACK           0x0050
150 #define IEEE80211_STYPE_CFPOLL          0x0060
151 #define IEEE80211_STYPE_CFACKPOLL       0x0070
152
153 #define IEEE80211_SCTL_FRAG             0x000F
154 #define IEEE80211_SCTL_SEQ              0xFFF0
155
156
157 /* debug macros */
158
159 #ifdef CONFIG_IEEE80211_DEBUG
160 extern u32 ieee80211_debug_level;
161 #define IEEE80211_DEBUG(level, fmt, args...) \
162 do { if (ieee80211_debug_level & (level)) \
163   printk(KERN_DEBUG "ieee80211: %c %s " fmt, \
164          in_interrupt() ? 'I' : 'U', __FUNCTION__ , ## args); } while (0)
165 #else
166 #define IEEE80211_DEBUG(level, fmt, args...) do {} while (0)
167 #endif  /* CONFIG_IEEE80211_DEBUG */
168
169 /*
170  * To use the debug system;
171  *
172  * If you are defining a new debug classification, simply add it to the #define
173  * list here in the form of:
174  *
175  * #define IEEE80211_DL_xxxx VALUE
176  *
177  * shifting value to the left one bit from the previous entry.  xxxx should be
178  * the name of the classification (for example, WEP)
179  *
180  * You then need to either add a IEEE80211_xxxx_DEBUG() macro definition for your
181  * classification, or use IEEE80211_DEBUG(IEEE80211_DL_xxxx, ...) whenever you want
182  * to send output to that classification.
183  *
184  * To add your debug level to the list of levels seen when you perform
185  *
186  * % cat /proc/net/ipw/debug_level
187  *
188  * you simply need to add your entry to the ipw_debug_levels array.
189  *
190  * If you do not see debug_level in /proc/net/ipw then you do not have
191  * CONFIG_IEEE80211_DEBUG defined in your kernel configuration
192  *
193  */
194
195 #define IEEE80211_DL_INFO          (1<<0)
196 #define IEEE80211_DL_WX            (1<<1)
197 #define IEEE80211_DL_SCAN          (1<<2)
198 #define IEEE80211_DL_STATE         (1<<3)
199 #define IEEE80211_DL_MGMT          (1<<4)
200 #define IEEE80211_DL_FRAG          (1<<5)
201 #define IEEE80211_DL_EAP           (1<<6)
202 #define IEEE80211_DL_DROP          (1<<7)
203
204 #define IEEE80211_DL_TX            (1<<8)
205 #define IEEE80211_DL_RX            (1<<9)
206
207 #define IEEE80211_ERROR(f, a...) printk(KERN_ERR "ieee80211: " f, ## a)
208 #define IEEE80211_WARNING(f, a...) printk(KERN_WARNING "ieee80211: " f, ## a)
209 #define IEEE80211_DEBUG_INFO(f, a...)   IEEE80211_DEBUG(IEEE80211_DL_INFO, f, ## a)
210
211 #define IEEE80211_DEBUG_WX(f, a...)     IEEE80211_DEBUG(IEEE80211_DL_WX, f, ## a)
212 #define IEEE80211_DEBUG_SCAN(f, a...)   IEEE80211_DEBUG(IEEE80211_DL_SCAN, f, ## a)
213 #define IEEE80211_DEBUG_STATE(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_STATE, f, ## a)
214 #define IEEE80211_DEBUG_MGMT(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_MGMT, f, ## a)
215 #define IEEE80211_DEBUG_FRAG(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_FRAG, f, ## a)
216 #define IEEE80211_DEBUG_EAP(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_EAP, f, ## a)
217 #define IEEE80211_DEBUG_DROP(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_DROP, f, ## a)
218 #define IEEE80211_DEBUG_TX(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_TX, f, ## a)
219 #define IEEE80211_DEBUG_RX(f, a...)  IEEE80211_DEBUG(IEEE80211_DL_RX, f, ## a)
220 #include <linux/netdevice.h>
221 #include <linux/wireless.h>
222 #include <linux/if_arp.h> /* ARPHRD_ETHER */
223
224 #ifndef WIRELESS_SPY
225 #define WIRELESS_SPY            // enable iwspy support
226 #endif
227 #include <net/iw_handler.h>     // new driver API
228
229 #ifndef ETH_P_PAE
230 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
231 #endif /* ETH_P_PAE */
232
233 #define ETH_P_PREAUTH 0x88C7 /* IEEE 802.11i pre-authentication */
234
235 #ifndef ETH_P_80211_RAW
236 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
237 #endif
238
239 /* IEEE 802.11 defines */
240
241 #define P80211_OUI_LEN 3
242
243 struct ieee80211_snap_hdr {
244
245         u8    dsap;   /* always 0xAA */
246         u8    ssap;   /* always 0xAA */
247         u8    ctrl;   /* always 0x03 */
248         u8    oui[P80211_OUI_LEN];    /* organizational universal id */
249
250 } __attribute__ ((packed));
251
252 #define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
253
254 #define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)
255 #define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)
256
257 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & IEEE80211_SCTL_FRAG)
258 #define WLAN_GET_SEQ_SEQ(seq)  ((seq) & IEEE80211_SCTL_SEQ)
259
260 /* Authentication algorithms */
261 #define WLAN_AUTH_OPEN 0
262 #define WLAN_AUTH_SHARED_KEY 1
263
264 #define WLAN_AUTH_CHALLENGE_LEN 128
265
266 #define WLAN_CAPABILITY_BSS (1<<0)
267 #define WLAN_CAPABILITY_IBSS (1<<1)
268 #define WLAN_CAPABILITY_CF_POLLABLE (1<<2)
269 #define WLAN_CAPABILITY_CF_POLL_REQUEST (1<<3)
270 #define WLAN_CAPABILITY_PRIVACY (1<<4)
271 #define WLAN_CAPABILITY_SHORT_PREAMBLE (1<<5)
272 #define WLAN_CAPABILITY_PBCC (1<<6)
273 #define WLAN_CAPABILITY_CHANNEL_AGILITY (1<<7)
274
275 /* Status codes */
276 #define WLAN_STATUS_SUCCESS 0
277 #define WLAN_STATUS_UNSPECIFIED_FAILURE 1
278 #define WLAN_STATUS_CAPS_UNSUPPORTED 10
279 #define WLAN_STATUS_REASSOC_NO_ASSOC 11
280 #define WLAN_STATUS_ASSOC_DENIED_UNSPEC 12
281 #define WLAN_STATUS_NOT_SUPPORTED_AUTH_ALG 13
282 #define WLAN_STATUS_UNKNOWN_AUTH_TRANSACTION 14
283 #define WLAN_STATUS_CHALLENGE_FAIL 15
284 #define WLAN_STATUS_AUTH_TIMEOUT 16
285 #define WLAN_STATUS_AP_UNABLE_TO_HANDLE_NEW_STA 17
286 #define WLAN_STATUS_ASSOC_DENIED_RATES 18
287 /* 802.11b */
288 #define WLAN_STATUS_ASSOC_DENIED_NOSHORT 19
289 #define WLAN_STATUS_ASSOC_DENIED_NOPBCC 20
290 #define WLAN_STATUS_ASSOC_DENIED_NOAGILITY 21
291
292 /* Reason codes */
293 #define WLAN_REASON_UNSPECIFIED 1
294 #define WLAN_REASON_PREV_AUTH_NOT_VALID 2
295 #define WLAN_REASON_DEAUTH_LEAVING 3
296 #define WLAN_REASON_DISASSOC_DUE_TO_INACTIVITY 4
297 #define WLAN_REASON_DISASSOC_AP_BUSY 5
298 #define WLAN_REASON_CLASS2_FRAME_FROM_NONAUTH_STA 6
299 #define WLAN_REASON_CLASS3_FRAME_FROM_NONASSOC_STA 7
300 #define WLAN_REASON_DISASSOC_STA_HAS_LEFT 8
301 #define WLAN_REASON_STA_REQ_ASSOC_WITHOUT_AUTH 9
302
303
304 #define IEEE80211_STATMASK_SIGNAL (1<<0)
305 #define IEEE80211_STATMASK_RSSI (1<<1)
306 #define IEEE80211_STATMASK_NOISE (1<<2)
307 #define IEEE80211_STATMASK_RATE (1<<3)
308 #define IEEE80211_STATMASK_WEMASK 0x7
309
310
311 #define IEEE80211_CCK_MODULATION    (1<<0)
312 #define IEEE80211_OFDM_MODULATION   (1<<1)
313
314 #define IEEE80211_24GHZ_BAND     (1<<0)
315 #define IEEE80211_52GHZ_BAND     (1<<1)
316
317 #define IEEE80211_CCK_RATE_1MB                  0x02
318 #define IEEE80211_CCK_RATE_2MB                  0x04
319 #define IEEE80211_CCK_RATE_5MB                  0x0B
320 #define IEEE80211_CCK_RATE_11MB                 0x16
321 #define IEEE80211_OFDM_RATE_6MB                 0x0C
322 #define IEEE80211_OFDM_RATE_9MB                 0x12
323 #define IEEE80211_OFDM_RATE_12MB                0x18
324 #define IEEE80211_OFDM_RATE_18MB                0x24
325 #define IEEE80211_OFDM_RATE_24MB                0x30
326 #define IEEE80211_OFDM_RATE_36MB                0x48
327 #define IEEE80211_OFDM_RATE_48MB                0x60
328 #define IEEE80211_OFDM_RATE_54MB                0x6C
329 #define IEEE80211_BASIC_RATE_MASK               0x80
330
331 #define IEEE80211_CCK_RATE_1MB_MASK             (1<<0)
332 #define IEEE80211_CCK_RATE_2MB_MASK             (1<<1)
333 #define IEEE80211_CCK_RATE_5MB_MASK             (1<<2)
334 #define IEEE80211_CCK_RATE_11MB_MASK            (1<<3)
335 #define IEEE80211_OFDM_RATE_6MB_MASK            (1<<4)
336 #define IEEE80211_OFDM_RATE_9MB_MASK            (1<<5)
337 #define IEEE80211_OFDM_RATE_12MB_MASK           (1<<6)
338 #define IEEE80211_OFDM_RATE_18MB_MASK           (1<<7)
339 #define IEEE80211_OFDM_RATE_24MB_MASK           (1<<8)
340 #define IEEE80211_OFDM_RATE_36MB_MASK           (1<<9)
341 #define IEEE80211_OFDM_RATE_48MB_MASK           (1<<10)
342 #define IEEE80211_OFDM_RATE_54MB_MASK           (1<<11)
343
344 #define IEEE80211_CCK_RATES_MASK                0x0000000F
345 #define IEEE80211_CCK_BASIC_RATES_MASK  (IEEE80211_CCK_RATE_1MB_MASK | \
346         IEEE80211_CCK_RATE_2MB_MASK)
347 #define IEEE80211_CCK_DEFAULT_RATES_MASK        (IEEE80211_CCK_BASIC_RATES_MASK | \
348         IEEE80211_CCK_RATE_5MB_MASK | \
349         IEEE80211_CCK_RATE_11MB_MASK)
350
351 #define IEEE80211_OFDM_RATES_MASK               0x00000FF0
352 #define IEEE80211_OFDM_BASIC_RATES_MASK (IEEE80211_OFDM_RATE_6MB_MASK | \
353         IEEE80211_OFDM_RATE_12MB_MASK | \
354         IEEE80211_OFDM_RATE_24MB_MASK)
355 #define IEEE80211_OFDM_DEFAULT_RATES_MASK       (IEEE80211_OFDM_BASIC_RATES_MASK | \
356         IEEE80211_OFDM_RATE_9MB_MASK  | \
357         IEEE80211_OFDM_RATE_18MB_MASK | \
358         IEEE80211_OFDM_RATE_36MB_MASK | \
359         IEEE80211_OFDM_RATE_48MB_MASK | \
360         IEEE80211_OFDM_RATE_54MB_MASK)
361 #define IEEE80211_DEFAULT_RATES_MASK (IEEE80211_OFDM_DEFAULT_RATES_MASK | \
362                                 IEEE80211_CCK_DEFAULT_RATES_MASK)
363
364 #define IEEE80211_NUM_OFDM_RATES            8
365 #define IEEE80211_NUM_CCK_RATES             4
366 #define IEEE80211_OFDM_SHIFT_MASK_A         4
367
368
369
370
371 /* NOTE: This data is for statistical purposes; not all hardware provides this
372  *       information for frames received.  Not setting these will not cause
373  *       any adverse affects. */
374 struct ieee80211_rx_stats {
375         u32 mac_time;
376         s8 rssi;
377         u8 signal;
378         u8 noise;
379         u16 rate; /* in 100 kbps */
380         u8 received_channel;
381         u8 control;
382         u8 mask;
383         u8 freq;
384         u16 len;
385 };
386
387 /* IEEE 802.11 requires that STA supports concurrent reception of at least
388  * three fragmented frames. This define can be increased to support more
389  * concurrent frames, but it should be noted that each entry can consume about
390  * 2 kB of RAM and increasing cache size will slow down frame reassembly. */
391 #define IEEE80211_FRAG_CACHE_LEN 4
392
393 struct ieee80211_frag_entry {
394         unsigned long first_frag_time;
395         unsigned int seq;
396         unsigned int last_frag;
397         struct sk_buff *skb;
398         u8 src_addr[ETH_ALEN];
399         u8 dst_addr[ETH_ALEN];
400 };
401
402 struct ieee80211_stats {
403         unsigned int tx_unicast_frames;
404         unsigned int tx_multicast_frames;
405         unsigned int tx_fragments;
406         unsigned int tx_unicast_octets;
407         unsigned int tx_multicast_octets;
408         unsigned int tx_deferred_transmissions;
409         unsigned int tx_single_retry_frames;
410         unsigned int tx_multiple_retry_frames;
411         unsigned int tx_retry_limit_exceeded;
412         unsigned int tx_discards;
413         unsigned int rx_unicast_frames;
414         unsigned int rx_multicast_frames;
415         unsigned int rx_fragments;
416         unsigned int rx_unicast_octets;
417         unsigned int rx_multicast_octets;
418         unsigned int rx_fcs_errors;
419         unsigned int rx_discards_no_buffer;
420         unsigned int tx_discards_wrong_sa;
421         unsigned int rx_discards_undecryptable;
422         unsigned int rx_message_in_msg_fragments;
423         unsigned int rx_message_in_bad_msg_fragments;
424 };
425
426 struct ieee80211_device;
427
428 #include "ieee80211_crypt.h"
429
430 #define SEC_KEY_1         (1<<0)
431 #define SEC_KEY_2         (1<<1)
432 #define SEC_KEY_3         (1<<2)
433 #define SEC_KEY_4         (1<<3)
434 #define SEC_ACTIVE_KEY    (1<<4)
435 #define SEC_AUTH_MODE     (1<<5)
436 #define SEC_UNICAST_GROUP (1<<6)
437 #define SEC_LEVEL         (1<<7)
438 #define SEC_ENABLED       (1<<8)
439
440 #define SEC_LEVEL_0      0 /* None */
441 #define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
442 #define SEC_LEVEL_2      2 /* Level 1 + TKIP */
443 #define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
444 #define SEC_LEVEL_3      4 /* Level 2 + CCMP */
445
446 #define WEP_KEYS 4
447 #define WEP_KEY_LEN 13
448
449 struct ieee80211_security {
450         u16 active_key:2,
451             enabled:1,
452             auth_mode:2,
453             auth_algo:4,
454             unicast_uses_group:1;
455         u8 key_sizes[WEP_KEYS];
456         u8 keys[WEP_KEYS][WEP_KEY_LEN];
457         u8 level;
458         u16 flags;
459 } __attribute__ ((packed));
460
461
462 /*
463
464  802.11 data frame from AP
465
466       ,-------------------------------------------------------------------.
467 Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
468       |------|------|---------|---------|---------|------|---------|------|
469 Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
470       |      | tion | (BSSID) |         |         | ence |  data   |      |
471       `-------------------------------------------------------------------'
472
473 Total: 28-2340 bytes
474
475 */
476
477 #define BEACON_PROBE_SSID_ID_POSITION 12
478
479 /* Management Frame Information Element Types */
480 #define MFIE_TYPE_SSID       0
481 #define MFIE_TYPE_RATES      1
482 #define MFIE_TYPE_FH_SET     2
483 #define MFIE_TYPE_DS_SET     3
484 #define MFIE_TYPE_CF_SET     4
485 #define MFIE_TYPE_TIM        5
486 #define MFIE_TYPE_IBSS_SET   6
487 #define MFIE_TYPE_CHALLENGE  16
488 #define MFIE_TYPE_RSN        48
489 #define MFIE_TYPE_RATES_EX   50
490 #define MFIE_TYPE_GENERIC    221
491
492 struct ieee80211_info_element_hdr {
493         u8 id;
494         u8 len;
495 } __attribute__ ((packed));
496
497 struct ieee80211_info_element {
498         u8 id;
499         u8 len;
500         u8 data[0];
501 } __attribute__ ((packed));
502
503 /*
504  * These are the data types that can make up management packets
505  *
506         u16 auth_algorithm;
507         u16 auth_sequence;
508         u16 beacon_interval;
509         u16 capability;
510         u8 current_ap[ETH_ALEN];
511         u16 listen_interval;
512         struct {
513                 u16 association_id:14, reserved:2;
514         } __attribute__ ((packed));
515         u32 time_stamp[2];
516         u16 reason;
517         u16 status;
518 */
519
520 struct ieee80211_authentication {
521         struct ieee80211_hdr_3addr header;
522         u16 algorithm;
523         u16 transaction;
524         u16 status;
525         struct ieee80211_info_element info_element;
526 } __attribute__ ((packed));
527
528
529 struct ieee80211_probe_response {
530         struct ieee80211_hdr_3addr header;
531         u32 time_stamp[2];
532         u16 beacon_interval;
533         u16 capability;
534         struct ieee80211_info_element info_element;
535 } __attribute__ ((packed));
536
537 struct ieee80211_assoc_request_frame {
538         u16 capability;
539         u16 listen_interval;
540         u8 current_ap[ETH_ALEN];
541         struct ieee80211_info_element info_element;
542 } __attribute__ ((packed));
543
544 struct ieee80211_assoc_response_frame {
545         struct ieee80211_hdr_3addr header;
546         u16 capability;
547         u16 status;
548         u16 aid;
549         struct ieee80211_info_element info_element; /* supported rates */
550 } __attribute__ ((packed));
551
552
553 struct ieee80211_txb {
554         u8 nr_frags;
555         u8 encrypted;
556         u16 reserved;
557         u16 frag_size;
558         u16 payload_size;
559         struct sk_buff *fragments[0];
560 };
561
562
563 /* SWEEP TABLE ENTRIES NUMBER*/
564 #define MAX_SWEEP_TAB_ENTRIES             42
565 #define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
566 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
567  * only use 8, and then use extended rates for the remaining supported
568  * rates.  Other APs, however, stick all of their supported rates on the
569  * main rates information element... */
570 #define MAX_RATES_LENGTH                  ((u8)12)
571 #define MAX_RATES_EX_LENGTH               ((u8)16)
572 #define MAX_NETWORK_COUNT                  128
573
574 #define CRC_LENGTH                 4U
575
576 #define MAX_WPA_IE_LEN 64
577
578 #define NETWORK_EMPTY_ESSID (1<<0)
579 #define NETWORK_HAS_OFDM    (1<<1)
580 #define NETWORK_HAS_CCK     (1<<2)
581
582 struct ieee80211_network {
583         /* These entries are used to identify a unique network */
584         u8 bssid[ETH_ALEN];
585         u8 channel;
586         /* Ensure null-terminated for any debug msgs */
587         u8 ssid[IW_ESSID_MAX_SIZE + 1];
588         u8 ssid_len;
589
590         /* These are network statistics */
591         struct ieee80211_rx_stats stats;
592         u16 capability;
593         u8 rates[MAX_RATES_LENGTH];
594         u8 rates_len;
595         u8 rates_ex[MAX_RATES_EX_LENGTH];
596         u8 rates_ex_len;
597         unsigned long last_scanned;
598         u8 mode;
599         u8 flags;
600         u32 last_associate;
601         u32 time_stamp[2];
602         u16 beacon_interval;
603         u16 listen_interval;
604         u16 atim_window;
605         u8 wpa_ie[MAX_WPA_IE_LEN];
606         size_t wpa_ie_len;
607         u8 rsn_ie[MAX_WPA_IE_LEN];
608         size_t rsn_ie_len;
609         struct list_head list;
610 };
611
612 enum ieee80211_state {
613         IEEE80211_UNINITIALIZED = 0,
614         IEEE80211_INITIALIZED,
615         IEEE80211_ASSOCIATING,
616         IEEE80211_ASSOCIATED,
617         IEEE80211_AUTHENTICATING,
618         IEEE80211_AUTHENTICATED,
619         IEEE80211_SHUTDOWN
620 };
621
622 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
623 #define DEFAULT_FTS 2346
624 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
625 #define MAC_ARG(x) ((u8*)(x))[0],((u8*)(x))[1],((u8*)(x))[2],((u8*)(x))[3],((u8*)(x))[4],((u8*)(x))[5]
626
627
628 extern inline int is_multicast_ether_addr(const u8 *addr)
629 {
630         return ((addr[0] != 0xff) && (0x01 & addr[0]));
631 }
632
633 extern inline int is_broadcast_ether_addr(const u8 *addr)
634 {
635         return ((addr[0] == 0xff) && (addr[1] == 0xff) && (addr[2] == 0xff) &&   \
636                 (addr[3] == 0xff) && (addr[4] == 0xff) && (addr[5] == 0xff));
637 }
638
639 #define CFG_IEEE80211_RESERVE_FCS (1<<0)
640 #define CFG_IEEE80211_COMPUTE_FCS (1<<1)
641
642 struct ieee80211_device {
643         struct net_device *dev;
644
645         /* Bookkeeping structures */
646         struct net_device_stats stats;
647         struct ieee80211_stats ieee_stats;
648
649         /* Probe / Beacon management */
650         struct list_head network_free_list;
651         struct list_head network_list;
652         struct ieee80211_network *networks;
653         int scans;
654         int scan_age;
655
656         int iw_mode; /* operating mode (IW_MODE_*) */
657
658         spinlock_t lock;
659
660         int tx_headroom; /* Set to size of any additional room needed at front
661                           * of allocated Tx SKBs */
662         u32 config;
663
664         /* WEP and other encryption related settings at the device level */
665         int open_wep; /* Set to 1 to allow unencrypted frames */
666
667         int reset_on_keychange; /* Set to 1 if the HW needs to be reset on
668                                  * WEP key changes */
669
670         /* If the host performs {en,de}cryption, then set to 1 */
671         int host_encrypt;
672         int host_decrypt;
673         int ieee802_1x; /* is IEEE 802.1X used */
674
675         /* WPA data */
676         int wpa_enabled;
677         int drop_unencrypted;
678         int tkip_countermeasures;
679         int privacy_invoked;
680         size_t wpa_ie_len;
681         u8 *wpa_ie;
682
683         struct list_head crypt_deinit_list;
684         struct ieee80211_crypt_data *crypt[WEP_KEYS];
685         int tx_keyidx; /* default TX key index (crypt[tx_keyidx]) */
686         struct timer_list crypt_deinit_timer;
687
688         int bcrx_sta_key; /* use individual keys to override default keys even
689                            * with RX of broad/multicast frames */
690
691         /* Fragmentation structures */
692         struct ieee80211_frag_entry frag_cache[IEEE80211_FRAG_CACHE_LEN];
693         unsigned int frag_next_idx;
694         u16 fts; /* Fragmentation Threshold */
695
696         /* Association info */
697         u8 bssid[ETH_ALEN];
698
699         enum ieee80211_state state;
700
701         int mode;       /* A, B, G */
702         int modulation; /* CCK, OFDM */
703         int freq_band;  /* 2.4Ghz, 5.2Ghz, Mixed */
704         int abg_ture;   /* ABG flag              */
705
706         /* Callback functions */
707         void (*set_security)(struct net_device *dev,
708                              struct ieee80211_security *sec);
709         int (*hard_start_xmit)(struct ieee80211_txb *txb,
710                                struct net_device *dev);
711         int (*reset_port)(struct net_device *dev);
712
713         /* This must be the last item so that it points to the data
714          * allocated beyond this structure by alloc_ieee80211 */
715         u8 priv[0];
716 };
717
718 #define IEEE_A            (1<<0)
719 #define IEEE_B            (1<<1)
720 #define IEEE_G            (1<<2)
721 #define IEEE_MODE_MASK    (IEEE_A|IEEE_B|IEEE_G)
722
723 extern inline void *ieee80211_priv(struct net_device *dev)
724 {
725         return ((struct ieee80211_device *)netdev_priv(dev))->priv;
726 }
727
728 extern inline int ieee80211_is_empty_essid(const char *essid, int essid_len)
729 {
730         /* Single white space is for Linksys APs */
731         if (essid_len == 1 && essid[0] == ' ')
732                 return 1;
733
734         /* Otherwise, if the entire essid is 0, we assume it is hidden */
735         while (essid_len) {
736                 essid_len--;
737                 if (essid[essid_len] != '\0')
738                         return 0;
739         }
740
741         return 1;
742 }
743
744 extern inline int ieee80211_is_valid_mode(struct ieee80211_device *ieee, int mode)
745 {
746         /*
747          * It is possible for both access points and our device to support
748          * combinations of modes, so as long as there is one valid combination
749          * of ap/device supported modes, then return success
750          *
751          */
752         if ((mode & IEEE_A) &&
753             (ieee->modulation & IEEE80211_OFDM_MODULATION) &&
754             (ieee->freq_band & IEEE80211_52GHZ_BAND))
755                 return 1;
756
757         if ((mode & IEEE_G) &&
758             (ieee->modulation & IEEE80211_OFDM_MODULATION) &&
759             (ieee->freq_band & IEEE80211_24GHZ_BAND))
760                 return 1;
761
762         if ((mode & IEEE_B) &&
763             (ieee->modulation & IEEE80211_CCK_MODULATION) &&
764             (ieee->freq_band & IEEE80211_24GHZ_BAND))
765                 return 1;
766
767         return 0;
768 }
769
770 extern inline int ieee80211_get_hdrlen(u16 fc)
771 {
772         int hdrlen = IEEE80211_3ADDR_LEN;
773
774         switch (WLAN_FC_GET_TYPE(fc)) {
775         case IEEE80211_FTYPE_DATA:
776                 if ((fc & IEEE80211_FCTL_FROMDS) && (fc & IEEE80211_FCTL_TODS))
777                         hdrlen = IEEE80211_4ADDR_LEN;
778                 break;
779         case IEEE80211_FTYPE_CTL:
780                 switch (WLAN_FC_GET_STYPE(fc)) {
781                 case IEEE80211_STYPE_CTS:
782                 case IEEE80211_STYPE_ACK:
783                         hdrlen = IEEE80211_1ADDR_LEN;
784                         break;
785                 default:
786                         hdrlen = IEEE80211_2ADDR_LEN;
787                         break;
788                 }
789                 break;
790         }
791
792         return hdrlen;
793 }
794
795
796
797 /* ieee80211.c */
798 extern void free_ieee80211(struct net_device *dev);
799 extern struct net_device *alloc_ieee80211(int sizeof_priv);
800
801 extern int ieee80211_set_encryption(struct ieee80211_device *ieee);
802
803 /* ieee80211_tx.c */
804
805
806 extern int ieee80211_xmit(struct sk_buff *skb,
807                           struct net_device *dev);
808 extern void ieee80211_txb_free(struct ieee80211_txb *);
809
810
811 /* ieee80211_rx.c */
812 extern int ieee80211_rx(struct ieee80211_device *ieee, struct sk_buff *skb,
813                         struct ieee80211_rx_stats *rx_stats);
814 extern void ieee80211_rx_mgt(struct ieee80211_device *ieee,
815                              struct ieee80211_hdr *header,
816                              struct ieee80211_rx_stats *stats);
817
818 /* iee80211_wx.c */
819 extern int ieee80211_wx_get_scan(struct ieee80211_device *ieee,
820                                  struct iw_request_info *info,
821                                  union iwreq_data *wrqu, char *key);
822 extern int ieee80211_wx_set_encode(struct ieee80211_device *ieee,
823                                    struct iw_request_info *info,
824                                    union iwreq_data *wrqu, char *key);
825 extern int ieee80211_wx_get_encode(struct ieee80211_device *ieee,
826                                    struct iw_request_info *info,
827                                    union iwreq_data *wrqu, char *key);
828
829
830 extern inline void ieee80211_increment_scans(struct ieee80211_device *ieee)
831 {
832         ieee->scans++;
833 }
834
835 extern inline int ieee80211_get_scans(struct ieee80211_device *ieee)
836 {
837         return ieee->scans;
838 }
839
840 static inline const char *escape_essid(const char *essid, u8 essid_len) {
841         static char escaped[IW_ESSID_MAX_SIZE * 2 + 1];
842         const char *s = essid;
843         char *d = escaped;
844
845         if (ieee80211_is_empty_essid(essid, essid_len)) {
846                 memcpy(escaped, "<hidden>", sizeof("<hidden>"));
847                 return escaped;
848         }
849
850         essid_len = min(essid_len, (u8)IW_ESSID_MAX_SIZE);
851         while (essid_len--) {
852                 if (*s == '\0') {
853                         *d++ = '\\';
854                         *d++ = '0';
855                         s++;
856                 } else {
857                         *d++ = *s++;
858                 }
859         }
860         *d = '\0';
861         return escaped;
862 }
863 #endif /* IEEE80211_H */