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