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  * <j@w1.fi>
10  * Copyright (c) 2002-2003, Jouni Malinen <j@w1.fi>
11  *
12  * Adaption to a generic IEEE 802.11 stack by James Ketrenos
13  * <jketreno@linux.intel.com>
14  * Copyright (c) 2004-2005, 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  * API Version History
22  * 1.0.x -- Initial version
23  * 1.1.x -- Added radiotap, QoS, TIM, libipw_geo APIs,
24  *          various structure changes, and crypto API init method
25  */
26 #ifndef LIBIPW_H
27 #define LIBIPW_H
28 #include <linux/if_ether.h>	/* ETH_ALEN */
29 #include <linux/kernel.h>	/* ARRAY_SIZE */
30 #include <linux/wireless.h>
31 #include <linux/ieee80211.h>
32 
33 #include <net/lib80211.h>
34 #include <net/cfg80211.h>
35 
36 #define LIBIPW_VERSION "git-1.1.13"
37 
38 #define LIBIPW_DATA_LEN		2304
39 /* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
40    6.2.1.1.2.
41 
42    The figure in section 7.1.2 suggests a body size of up to 2312
43    bytes is allowed, which is a bit confusing, I suspect this
44    represents the 2304 bytes of real data, plus a possible 8 bytes of
45    WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro) */
46 
47 #define LIBIPW_1ADDR_LEN 10
48 #define LIBIPW_2ADDR_LEN 16
49 #define LIBIPW_3ADDR_LEN 24
50 #define LIBIPW_4ADDR_LEN 30
51 #define LIBIPW_FCS_LEN    4
52 #define LIBIPW_HLEN			(LIBIPW_4ADDR_LEN)
53 #define LIBIPW_FRAME_LEN		(LIBIPW_DATA_LEN + LIBIPW_HLEN)
54 
55 #define MIN_FRAG_THRESHOLD     256U
56 #define	MAX_FRAG_THRESHOLD     2346U
57 
58 /* QOS control */
59 #define LIBIPW_QCTL_TID		0x000F
60 
61 /* debug macros */
62 
63 #ifdef CONFIG_LIBIPW_DEBUG
64 extern u32 libipw_debug_level;
65 #define LIBIPW_DEBUG(level, fmt, args...) \
66 do { if (libipw_debug_level & (level)) \
67   printk(KERN_DEBUG "libipw: %c %s " fmt, \
68          in_interrupt() ? 'I' : 'U', __func__ , ## args); } while (0)
69 #else
70 #define LIBIPW_DEBUG(level, fmt, args...) do {} while (0)
71 #endif				/* CONFIG_LIBIPW_DEBUG */
72 
73 /*
74  * To use the debug system:
75  *
76  * If you are defining a new debug classification, simply add it to the #define
77  * list here in the form of:
78  *
79  * #define LIBIPW_DL_xxxx VALUE
80  *
81  * shifting value to the left one bit from the previous entry.  xxxx should be
82  * the name of the classification (for example, WEP)
83  *
84  * You then need to either add a LIBIPW_xxxx_DEBUG() macro definition for your
85  * classification, or use LIBIPW_DEBUG(LIBIPW_DL_xxxx, ...) whenever you want
86  * to send output to that classification.
87  *
88  * To add your debug level to the list of levels seen when you perform
89  *
90  * % cat /proc/net/ieee80211/debug_level
91  *
92  * you simply need to add your entry to the libipw_debug_level array.
93  *
94  * If you do not see debug_level in /proc/net/ieee80211 then you do not have
95  * CONFIG_LIBIPW_DEBUG defined in your kernel configuration
96  *
97  */
98 
99 #define LIBIPW_DL_INFO          (1<<0)
100 #define LIBIPW_DL_WX            (1<<1)
101 #define LIBIPW_DL_SCAN          (1<<2)
102 #define LIBIPW_DL_STATE         (1<<3)
103 #define LIBIPW_DL_MGMT          (1<<4)
104 #define LIBIPW_DL_FRAG          (1<<5)
105 #define LIBIPW_DL_DROP          (1<<7)
106 
107 #define LIBIPW_DL_TX            (1<<8)
108 #define LIBIPW_DL_RX            (1<<9)
109 #define LIBIPW_DL_QOS           (1<<31)
110 
111 #define LIBIPW_ERROR(f, a...) printk(KERN_ERR "libipw: " f, ## a)
112 #define LIBIPW_WARNING(f, a...) printk(KERN_WARNING "libipw: " f, ## a)
113 #define LIBIPW_DEBUG_INFO(f, a...)   LIBIPW_DEBUG(LIBIPW_DL_INFO, f, ## a)
114 
115 #define LIBIPW_DEBUG_WX(f, a...)     LIBIPW_DEBUG(LIBIPW_DL_WX, f, ## a)
116 #define LIBIPW_DEBUG_SCAN(f, a...)   LIBIPW_DEBUG(LIBIPW_DL_SCAN, f, ## a)
117 #define LIBIPW_DEBUG_STATE(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_STATE, f, ## a)
118 #define LIBIPW_DEBUG_MGMT(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_MGMT, f, ## a)
119 #define LIBIPW_DEBUG_FRAG(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_FRAG, f, ## a)
120 #define LIBIPW_DEBUG_DROP(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_DROP, f, ## a)
121 #define LIBIPW_DEBUG_TX(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_TX, f, ## a)
122 #define LIBIPW_DEBUG_RX(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_RX, f, ## a)
123 #define LIBIPW_DEBUG_QOS(f, a...)  LIBIPW_DEBUG(LIBIPW_DL_QOS, f, ## a)
124 #include <linux/netdevice.h>
125 #include <linux/if_arp.h>	/* ARPHRD_ETHER */
126 
127 #ifndef WIRELESS_SPY
128 #define WIRELESS_SPY		/* enable iwspy support */
129 #endif
130 #include <net/iw_handler.h>	/* new driver API */
131 
132 #define ETH_P_PREAUTH 0x88C7	/* IEEE 802.11i pre-authentication */
133 
134 #ifndef ETH_P_80211_RAW
135 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
136 #endif
137 
138 /* IEEE 802.11 defines */
139 
140 #define P80211_OUI_LEN 3
141 
142 struct libipw_snap_hdr {
143 
144 	u8 dsap;		/* always 0xAA */
145 	u8 ssap;		/* always 0xAA */
146 	u8 ctrl;		/* always 0x03 */
147 	u8 oui[P80211_OUI_LEN];	/* organizational universal id */
148 
149 } __packed;
150 
151 #define SNAP_SIZE sizeof(struct libipw_snap_hdr)
152 
153 #define WLAN_FC_GET_VERS(fc) ((fc) & IEEE80211_FCTL_VERS)
154 #define WLAN_FC_GET_TYPE(fc) ((fc) & IEEE80211_FCTL_FTYPE)
155 #define WLAN_FC_GET_STYPE(fc) ((fc) & IEEE80211_FCTL_STYPE)
156 
157 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & IEEE80211_SCTL_FRAG)
158 #define WLAN_GET_SEQ_SEQ(seq)  (((seq) & IEEE80211_SCTL_SEQ) >> 4)
159 
160 #define LIBIPW_STATMASK_SIGNAL (1<<0)
161 #define LIBIPW_STATMASK_RSSI (1<<1)
162 #define LIBIPW_STATMASK_NOISE (1<<2)
163 #define LIBIPW_STATMASK_RATE (1<<3)
164 #define LIBIPW_STATMASK_WEMASK 0x7
165 
166 #define LIBIPW_CCK_MODULATION    (1<<0)
167 #define LIBIPW_OFDM_MODULATION   (1<<1)
168 
169 #define LIBIPW_24GHZ_BAND     (1<<0)
170 #define LIBIPW_52GHZ_BAND     (1<<1)
171 
172 #define LIBIPW_CCK_RATE_1MB		        0x02
173 #define LIBIPW_CCK_RATE_2MB		        0x04
174 #define LIBIPW_CCK_RATE_5MB		        0x0B
175 #define LIBIPW_CCK_RATE_11MB		        0x16
176 #define LIBIPW_OFDM_RATE_6MB		        0x0C
177 #define LIBIPW_OFDM_RATE_9MB		        0x12
178 #define LIBIPW_OFDM_RATE_12MB		0x18
179 #define LIBIPW_OFDM_RATE_18MB		0x24
180 #define LIBIPW_OFDM_RATE_24MB		0x30
181 #define LIBIPW_OFDM_RATE_36MB		0x48
182 #define LIBIPW_OFDM_RATE_48MB		0x60
183 #define LIBIPW_OFDM_RATE_54MB		0x6C
184 #define LIBIPW_BASIC_RATE_MASK		0x80
185 
186 #define LIBIPW_CCK_RATE_1MB_MASK		(1<<0)
187 #define LIBIPW_CCK_RATE_2MB_MASK		(1<<1)
188 #define LIBIPW_CCK_RATE_5MB_MASK		(1<<2)
189 #define LIBIPW_CCK_RATE_11MB_MASK		(1<<3)
190 #define LIBIPW_OFDM_RATE_6MB_MASK		(1<<4)
191 #define LIBIPW_OFDM_RATE_9MB_MASK		(1<<5)
192 #define LIBIPW_OFDM_RATE_12MB_MASK		(1<<6)
193 #define LIBIPW_OFDM_RATE_18MB_MASK		(1<<7)
194 #define LIBIPW_OFDM_RATE_24MB_MASK		(1<<8)
195 #define LIBIPW_OFDM_RATE_36MB_MASK		(1<<9)
196 #define LIBIPW_OFDM_RATE_48MB_MASK		(1<<10)
197 #define LIBIPW_OFDM_RATE_54MB_MASK		(1<<11)
198 
199 #define LIBIPW_CCK_RATES_MASK	        0x0000000F
200 #define LIBIPW_CCK_BASIC_RATES_MASK	(LIBIPW_CCK_RATE_1MB_MASK | \
201 	LIBIPW_CCK_RATE_2MB_MASK)
202 #define LIBIPW_CCK_DEFAULT_RATES_MASK	(LIBIPW_CCK_BASIC_RATES_MASK | \
203         LIBIPW_CCK_RATE_5MB_MASK | \
204         LIBIPW_CCK_RATE_11MB_MASK)
205 
206 #define LIBIPW_OFDM_RATES_MASK		0x00000FF0
207 #define LIBIPW_OFDM_BASIC_RATES_MASK	(LIBIPW_OFDM_RATE_6MB_MASK | \
208 	LIBIPW_OFDM_RATE_12MB_MASK | \
209 	LIBIPW_OFDM_RATE_24MB_MASK)
210 #define LIBIPW_OFDM_DEFAULT_RATES_MASK	(LIBIPW_OFDM_BASIC_RATES_MASK | \
211 	LIBIPW_OFDM_RATE_9MB_MASK  | \
212 	LIBIPW_OFDM_RATE_18MB_MASK | \
213 	LIBIPW_OFDM_RATE_36MB_MASK | \
214 	LIBIPW_OFDM_RATE_48MB_MASK | \
215 	LIBIPW_OFDM_RATE_54MB_MASK)
216 #define LIBIPW_DEFAULT_RATES_MASK (LIBIPW_OFDM_DEFAULT_RATES_MASK | \
217                                 LIBIPW_CCK_DEFAULT_RATES_MASK)
218 
219 #define LIBIPW_NUM_OFDM_RATES	    8
220 #define LIBIPW_NUM_CCK_RATES	            4
221 #define LIBIPW_OFDM_SHIFT_MASK_A         4
222 
223 /* NOTE: This data is for statistical purposes; not all hardware provides this
224  *       information for frames received.
225  *       For libipw_rx_mgt, you need to set at least the 'len' parameter.
226  */
227 struct libipw_rx_stats {
228 	u32 mac_time;
229 	s8 rssi;
230 	u8 signal;
231 	u8 noise;
232 	u16 rate;		/* in 100 kbps */
233 	u8 received_channel;
234 	u8 control;
235 	u8 mask;
236 	u8 freq;
237 	u16 len;
238 	u64 tsf;
239 	u32 beacon_time;
240 };
241 
242 /* IEEE 802.11 requires that STA supports concurrent reception of at least
243  * three fragmented frames. This define can be increased to support more
244  * concurrent frames, but it should be noted that each entry can consume about
245  * 2 kB of RAM and increasing cache size will slow down frame reassembly. */
246 #define LIBIPW_FRAG_CACHE_LEN 4
247 
248 struct libipw_frag_entry {
249 	unsigned long first_frag_time;
250 	unsigned int seq;
251 	unsigned int last_frag;
252 	struct sk_buff *skb;
253 	u8 src_addr[ETH_ALEN];
254 	u8 dst_addr[ETH_ALEN];
255 };
256 
257 struct libipw_stats {
258 	unsigned int tx_unicast_frames;
259 	unsigned int tx_multicast_frames;
260 	unsigned int tx_fragments;
261 	unsigned int tx_unicast_octets;
262 	unsigned int tx_multicast_octets;
263 	unsigned int tx_deferred_transmissions;
264 	unsigned int tx_single_retry_frames;
265 	unsigned int tx_multiple_retry_frames;
266 	unsigned int tx_retry_limit_exceeded;
267 	unsigned int tx_discards;
268 	unsigned int rx_unicast_frames;
269 	unsigned int rx_multicast_frames;
270 	unsigned int rx_fragments;
271 	unsigned int rx_unicast_octets;
272 	unsigned int rx_multicast_octets;
273 	unsigned int rx_fcs_errors;
274 	unsigned int rx_discards_no_buffer;
275 	unsigned int tx_discards_wrong_sa;
276 	unsigned int rx_discards_undecryptable;
277 	unsigned int rx_message_in_msg_fragments;
278 	unsigned int rx_message_in_bad_msg_fragments;
279 };
280 
281 struct libipw_device;
282 
283 #define SEC_KEY_1		(1<<0)
284 #define SEC_KEY_2		(1<<1)
285 #define SEC_KEY_3		(1<<2)
286 #define SEC_KEY_4		(1<<3)
287 #define SEC_ACTIVE_KEY		(1<<4)
288 #define SEC_AUTH_MODE		(1<<5)
289 #define SEC_UNICAST_GROUP	(1<<6)
290 #define SEC_LEVEL		(1<<7)
291 #define SEC_ENABLED		(1<<8)
292 #define SEC_ENCRYPT		(1<<9)
293 
294 #define SEC_LEVEL_0		0	/* None */
295 #define SEC_LEVEL_1		1	/* WEP 40 and 104 bit */
296 #define SEC_LEVEL_2		2	/* Level 1 + TKIP */
297 #define SEC_LEVEL_2_CKIP	3	/* Level 1 + CKIP */
298 #define SEC_LEVEL_3		4	/* Level 2 + CCMP */
299 
300 #define SEC_ALG_NONE		0
301 #define SEC_ALG_WEP		1
302 #define SEC_ALG_TKIP		2
303 #define SEC_ALG_CCMP		3
304 
305 #define WEP_KEYS		4
306 #define WEP_KEY_LEN		13
307 #define SCM_KEY_LEN		32
308 #define SCM_TEMPORAL_KEY_LENGTH	16
309 
310 struct libipw_security {
311 	u16 active_key:2, enabled:1, unicast_uses_group:1, encrypt:1;
312 	u8 auth_mode;
313 	u8 encode_alg[WEP_KEYS];
314 	u8 key_sizes[WEP_KEYS];
315 	u8 keys[WEP_KEYS][SCM_KEY_LEN];
316 	u8 level;
317 	u16 flags;
318 } __packed;
319 
320 /*
321 
322  802.11 data frame from AP
323 
324       ,-------------------------------------------------------------------.
325 Bytes |  2   |  2   |    6    |    6    |    6    |  2   | 0..2312 |   4  |
326       |------|------|---------|---------|---------|------|---------|------|
327 Desc. | ctrl | dura |  DA/RA  |   TA    |    SA   | Sequ |  frame  |  fcs |
328       |      | tion | (BSSID) |         |         | ence |  data   |      |
329       `-------------------------------------------------------------------'
330 
331 Total: 28-2340 bytes
332 
333 */
334 
335 #define BEACON_PROBE_SSID_ID_POSITION 12
336 
337 struct libipw_hdr_1addr {
338 	__le16 frame_ctl;
339 	__le16 duration_id;
340 	u8 addr1[ETH_ALEN];
341 	u8 payload[0];
342 } __packed;
343 
344 struct libipw_hdr_2addr {
345 	__le16 frame_ctl;
346 	__le16 duration_id;
347 	u8 addr1[ETH_ALEN];
348 	u8 addr2[ETH_ALEN];
349 	u8 payload[0];
350 } __packed;
351 
352 struct libipw_hdr_3addr {
353 	__le16 frame_ctl;
354 	__le16 duration_id;
355 	u8 addr1[ETH_ALEN];
356 	u8 addr2[ETH_ALEN];
357 	u8 addr3[ETH_ALEN];
358 	__le16 seq_ctl;
359 	u8 payload[0];
360 } __packed;
361 
362 struct libipw_hdr_4addr {
363 	__le16 frame_ctl;
364 	__le16 duration_id;
365 	u8 addr1[ETH_ALEN];
366 	u8 addr2[ETH_ALEN];
367 	u8 addr3[ETH_ALEN];
368 	__le16 seq_ctl;
369 	u8 addr4[ETH_ALEN];
370 	u8 payload[0];
371 } __packed;
372 
373 struct libipw_hdr_3addrqos {
374 	__le16 frame_ctl;
375 	__le16 duration_id;
376 	u8 addr1[ETH_ALEN];
377 	u8 addr2[ETH_ALEN];
378 	u8 addr3[ETH_ALEN];
379 	__le16 seq_ctl;
380 	u8 payload[0];
381 	__le16 qos_ctl;
382 } __packed;
383 
384 struct libipw_info_element {
385 	u8 id;
386 	u8 len;
387 	u8 data[0];
388 } __packed;
389 
390 /*
391  * These are the data types that can make up management packets
392  *
393 	u16 auth_algorithm;
394 	u16 auth_sequence;
395 	u16 beacon_interval;
396 	u16 capability;
397 	u8 current_ap[ETH_ALEN];
398 	u16 listen_interval;
399 	struct {
400 		u16 association_id:14, reserved:2;
401 	} __packed;
402 	u32 time_stamp[2];
403 	u16 reason;
404 	u16 status;
405 */
406 
407 struct libipw_auth {
408 	struct libipw_hdr_3addr header;
409 	__le16 algorithm;
410 	__le16 transaction;
411 	__le16 status;
412 	/* challenge */
413 	struct libipw_info_element info_element[0];
414 } __packed;
415 
416 struct libipw_channel_switch {
417 	u8 id;
418 	u8 len;
419 	u8 mode;
420 	u8 channel;
421 	u8 count;
422 } __packed;
423 
424 struct libipw_action {
425 	struct libipw_hdr_3addr header;
426 	u8 category;
427 	u8 action;
428 	union {
429 		struct libipw_action_exchange {
430 			u8 token;
431 			struct libipw_info_element info_element[0];
432 		} exchange;
433 		struct libipw_channel_switch channel_switch;
434 
435 	} format;
436 } __packed;
437 
438 struct libipw_disassoc {
439 	struct libipw_hdr_3addr header;
440 	__le16 reason;
441 } __packed;
442 
443 /* Alias deauth for disassoc */
444 #define libipw_deauth libipw_disassoc
445 
446 struct libipw_probe_request {
447 	struct libipw_hdr_3addr header;
448 	/* SSID, supported rates */
449 	struct libipw_info_element info_element[0];
450 } __packed;
451 
452 struct libipw_probe_response {
453 	struct libipw_hdr_3addr header;
454 	__le32 time_stamp[2];
455 	__le16 beacon_interval;
456 	__le16 capability;
457 	/* SSID, supported rates, FH params, DS params,
458 	 * CF params, IBSS params, TIM (if beacon), RSN */
459 	struct libipw_info_element info_element[0];
460 } __packed;
461 
462 /* Alias beacon for probe_response */
463 #define libipw_beacon libipw_probe_response
464 
465 struct libipw_assoc_request {
466 	struct libipw_hdr_3addr header;
467 	__le16 capability;
468 	__le16 listen_interval;
469 	/* SSID, supported rates, RSN */
470 	struct libipw_info_element info_element[0];
471 } __packed;
472 
473 struct libipw_reassoc_request {
474 	struct libipw_hdr_3addr header;
475 	__le16 capability;
476 	__le16 listen_interval;
477 	u8 current_ap[ETH_ALEN];
478 	struct libipw_info_element info_element[0];
479 } __packed;
480 
481 struct libipw_assoc_response {
482 	struct libipw_hdr_3addr header;
483 	__le16 capability;
484 	__le16 status;
485 	__le16 aid;
486 	/* supported rates */
487 	struct libipw_info_element info_element[0];
488 } __packed;
489 
490 struct libipw_txb {
491 	u8 nr_frags;
492 	u8 encrypted;
493 	u8 rts_included;
494 	u8 reserved;
495 	u16 frag_size;
496 	u16 payload_size;
497 	struct sk_buff *fragments[0];
498 };
499 
500 /* SWEEP TABLE ENTRIES NUMBER */
501 #define MAX_SWEEP_TAB_ENTRIES		  42
502 #define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
503 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
504  * only use 8, and then use extended rates for the remaining supported
505  * rates.  Other APs, however, stick all of their supported rates on the
506  * main rates information element... */
507 #define MAX_RATES_LENGTH                  ((u8)12)
508 #define MAX_RATES_EX_LENGTH               ((u8)16)
509 #define MAX_NETWORK_COUNT                  128
510 
511 #define CRC_LENGTH                 4U
512 
513 #define MAX_WPA_IE_LEN 64
514 
515 #define NETWORK_HAS_OFDM       (1<<1)
516 #define NETWORK_HAS_CCK        (1<<2)
517 
518 /* QoS structure */
519 #define NETWORK_HAS_QOS_PARAMETERS      (1<<3)
520 #define NETWORK_HAS_QOS_INFORMATION     (1<<4)
521 #define NETWORK_HAS_QOS_MASK            (NETWORK_HAS_QOS_PARAMETERS | \
522 					 NETWORK_HAS_QOS_INFORMATION)
523 
524 /* 802.11h */
525 #define NETWORK_HAS_POWER_CONSTRAINT    (1<<5)
526 #define NETWORK_HAS_CSA                 (1<<6)
527 #define NETWORK_HAS_QUIET               (1<<7)
528 #define NETWORK_HAS_IBSS_DFS            (1<<8)
529 #define NETWORK_HAS_TPC_REPORT          (1<<9)
530 
531 #define NETWORK_HAS_ERP_VALUE           (1<<10)
532 
533 #define QOS_QUEUE_NUM                   4
534 #define QOS_OUI_LEN                     3
535 #define QOS_OUI_TYPE                    2
536 #define QOS_ELEMENT_ID                  221
537 #define QOS_OUI_INFO_SUB_TYPE           0
538 #define QOS_OUI_PARAM_SUB_TYPE          1
539 #define QOS_VERSION_1                   1
540 #define QOS_AIFSN_MIN_VALUE             2
541 
542 struct libipw_qos_information_element {
543 	u8 elementID;
544 	u8 length;
545 	u8 qui[QOS_OUI_LEN];
546 	u8 qui_type;
547 	u8 qui_subtype;
548 	u8 version;
549 	u8 ac_info;
550 } __packed;
551 
552 struct libipw_qos_ac_parameter {
553 	u8 aci_aifsn;
554 	u8 ecw_min_max;
555 	__le16 tx_op_limit;
556 } __packed;
557 
558 struct libipw_qos_parameter_info {
559 	struct libipw_qos_information_element info_element;
560 	u8 reserved;
561 	struct libipw_qos_ac_parameter ac_params_record[QOS_QUEUE_NUM];
562 } __packed;
563 
564 struct libipw_qos_parameters {
565 	__le16 cw_min[QOS_QUEUE_NUM];
566 	__le16 cw_max[QOS_QUEUE_NUM];
567 	u8 aifs[QOS_QUEUE_NUM];
568 	u8 flag[QOS_QUEUE_NUM];
569 	__le16 tx_op_limit[QOS_QUEUE_NUM];
570 } __packed;
571 
572 struct libipw_qos_data {
573 	struct libipw_qos_parameters parameters;
574 	int active;
575 	int supported;
576 	u8 param_count;
577 	u8 old_param_count;
578 };
579 
580 struct libipw_tim_parameters {
581 	u8 tim_count;
582 	u8 tim_period;
583 } __packed;
584 
585 /*******************************************************/
586 
587 struct libipw_tpc_report {
588 	u8 transmit_power;
589 	u8 link_margin;
590 } __packed;
591 
592 struct libipw_channel_map {
593 	u8 channel;
594 	u8 map;
595 } __packed;
596 
597 struct libipw_ibss_dfs {
598 	struct libipw_info_element ie;
599 	u8 owner[ETH_ALEN];
600 	u8 recovery_interval;
601 	struct libipw_channel_map channel_map[0];
602 };
603 
604 struct libipw_csa {
605 	u8 mode;
606 	u8 channel;
607 	u8 count;
608 } __packed;
609 
610 struct libipw_quiet {
611 	u8 count;
612 	u8 period;
613 	u8 duration;
614 	u8 offset;
615 } __packed;
616 
617 struct libipw_network {
618 	/* These entries are used to identify a unique network */
619 	u8 bssid[ETH_ALEN];
620 	u8 channel;
621 	/* Ensure null-terminated for any debug msgs */
622 	u8 ssid[IW_ESSID_MAX_SIZE + 1];
623 	u8 ssid_len;
624 
625 	struct libipw_qos_data qos_data;
626 
627 	/* These are network statistics */
628 	struct libipw_rx_stats stats;
629 	u16 capability;
630 	u8 rates[MAX_RATES_LENGTH];
631 	u8 rates_len;
632 	u8 rates_ex[MAX_RATES_EX_LENGTH];
633 	u8 rates_ex_len;
634 	unsigned long last_scanned;
635 	u8 mode;
636 	u32 flags;
637 	u32 last_associate;
638 	u32 time_stamp[2];
639 	u16 beacon_interval;
640 	u16 listen_interval;
641 	u16 atim_window;
642 	u8 erp_value;
643 	u8 wpa_ie[MAX_WPA_IE_LEN];
644 	size_t wpa_ie_len;
645 	u8 rsn_ie[MAX_WPA_IE_LEN];
646 	size_t rsn_ie_len;
647 	struct libipw_tim_parameters tim;
648 
649 	/* 802.11h info */
650 
651 	/* Power Constraint - mandatory if spctrm mgmt required */
652 	u8 power_constraint;
653 
654 	/* TPC Report - mandatory if spctrm mgmt required */
655 	struct libipw_tpc_report tpc_report;
656 
657 	/* Channel Switch Announcement - optional if spctrm mgmt required */
658 	struct libipw_csa csa;
659 
660 	/* Quiet - optional if spctrm mgmt required */
661 	struct libipw_quiet quiet;
662 
663 	struct list_head list;
664 };
665 
666 enum libipw_state {
667 	LIBIPW_UNINITIALIZED = 0,
668 	LIBIPW_INITIALIZED,
669 	LIBIPW_ASSOCIATING,
670 	LIBIPW_ASSOCIATED,
671 	LIBIPW_AUTHENTICATING,
672 	LIBIPW_AUTHENTICATED,
673 	LIBIPW_SHUTDOWN
674 };
675 
676 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
677 #define DEFAULT_FTS 2346
678 
679 #define CFG_LIBIPW_RESERVE_FCS (1<<0)
680 #define CFG_LIBIPW_COMPUTE_FCS (1<<1)
681 #define CFG_LIBIPW_RTS (1<<2)
682 
683 #define LIBIPW_24GHZ_MIN_CHANNEL 1
684 #define LIBIPW_24GHZ_MAX_CHANNEL 14
685 #define LIBIPW_24GHZ_CHANNELS (LIBIPW_24GHZ_MAX_CHANNEL - \
686 				  LIBIPW_24GHZ_MIN_CHANNEL + 1)
687 
688 #define LIBIPW_52GHZ_MIN_CHANNEL 34
689 #define LIBIPW_52GHZ_MAX_CHANNEL 165
690 #define LIBIPW_52GHZ_CHANNELS (LIBIPW_52GHZ_MAX_CHANNEL - \
691 				  LIBIPW_52GHZ_MIN_CHANNEL + 1)
692 
693 enum {
694 	LIBIPW_CH_PASSIVE_ONLY = (1 << 0),
695 	LIBIPW_CH_80211H_RULES = (1 << 1),
696 	LIBIPW_CH_B_ONLY = (1 << 2),
697 	LIBIPW_CH_NO_IBSS = (1 << 3),
698 	LIBIPW_CH_UNIFORM_SPREADING = (1 << 4),
699 	LIBIPW_CH_RADAR_DETECT = (1 << 5),
700 	LIBIPW_CH_INVALID = (1 << 6),
701 };
702 
703 struct libipw_channel {
704 	u32 freq;	/* in MHz */
705 	u8 channel;
706 	u8 flags;
707 	u8 max_power;	/* in dBm */
708 };
709 
710 struct libipw_geo {
711 	u8 name[4];
712 	u8 bg_channels;
713 	u8 a_channels;
714 	struct libipw_channel bg[LIBIPW_24GHZ_CHANNELS];
715 	struct libipw_channel a[LIBIPW_52GHZ_CHANNELS];
716 };
717 
718 struct libipw_device {
719 	struct net_device *dev;
720 	struct wireless_dev wdev;
721 	struct libipw_security sec;
722 
723 	/* Bookkeeping structures */
724 	struct libipw_stats ieee_stats;
725 
726 	struct libipw_geo geo;
727 	struct ieee80211_supported_band bg_band;
728 	struct ieee80211_supported_band a_band;
729 
730 	/* Probe / Beacon management */
731 	struct list_head network_free_list;
732 	struct list_head network_list;
733 	struct libipw_network *networks[MAX_NETWORK_COUNT];
734 	int scans;
735 	int scan_age;
736 
737 	int iw_mode;		/* operating mode (IW_MODE_*) */
738 	struct iw_spy_data spy_data;	/* iwspy support */
739 
740 	spinlock_t lock;
741 
742 	int tx_headroom;	/* Set to size of any additional room needed at front
743 				 * of allocated Tx SKBs */
744 	u32 config;
745 
746 	/* WEP and other encryption related settings at the device level */
747 	int open_wep;		/* Set to 1 to allow unencrypted frames */
748 
749 	/* If the host performs {en,de}cryption, then set to 1 */
750 	int host_encrypt;
751 	int host_encrypt_msdu;
752 	int host_decrypt;
753 	/* host performs multicast decryption */
754 	int host_mc_decrypt;
755 
756 	/* host should strip IV and ICV from protected frames */
757 	/* meaningful only when hardware decryption is being used */
758 	int host_strip_iv_icv;
759 
760 	int host_open_frag;
761 	int ieee802_1x;		/* is IEEE 802.1X used */
762 
763 	/* WPA data */
764 	int wpa_enabled;
765 	int drop_unencrypted;
766 	int privacy_invoked;
767 	size_t wpa_ie_len;
768 	u8 *wpa_ie;
769 
770 	struct lib80211_crypt_info crypt_info;
771 
772 	int bcrx_sta_key;	/* use individual keys to override default keys even
773 				 * with RX of broad/multicast frames */
774 
775 	/* Fragmentation structures */
776 	struct libipw_frag_entry frag_cache[LIBIPW_FRAG_CACHE_LEN];
777 	unsigned int frag_next_idx;
778 	u16 fts;		/* Fragmentation Threshold */
779 	u16 rts;		/* RTS threshold */
780 
781 	/* Association info */
782 	u8 bssid[ETH_ALEN];
783 
784 	enum libipw_state state;
785 
786 	int mode;		/* A, B, G */
787 	int modulation;		/* CCK, OFDM */
788 	int freq_band;		/* 2.4Ghz, 5.2Ghz, Mixed */
789 	int abg_true;		/* ABG flag              */
790 
791 	int perfect_rssi;
792 	int worst_rssi;
793 
794 	u16 prev_seq_ctl;	/* used to drop duplicate frames */
795 
796 	/* Callback functions */
797 	void (*set_security) (struct net_device * dev,
798 			      struct libipw_security * sec);
799 	netdev_tx_t (*hard_start_xmit) (struct libipw_txb * txb,
800 					struct net_device * dev, int pri);
801 	int (*is_queue_full) (struct net_device * dev, int pri);
802 
803 	int (*handle_management) (struct net_device * dev,
804 				  struct libipw_network * network, u16 type);
805 	int (*is_qos_active) (struct net_device *dev, struct sk_buff *skb);
806 
807 	/* Typical STA methods */
808 	int (*handle_auth) (struct net_device * dev,
809 			    struct libipw_auth * auth);
810 	int (*handle_deauth) (struct net_device * dev,
811 			      struct libipw_deauth * auth);
812 	int (*handle_action) (struct net_device * dev,
813 			      struct libipw_action * action,
814 			      struct libipw_rx_stats * stats);
815 	int (*handle_disassoc) (struct net_device * dev,
816 				struct libipw_disassoc * assoc);
817 	int (*handle_beacon) (struct net_device * dev,
818 			      struct libipw_beacon * beacon,
819 			      struct libipw_network * network);
820 	int (*handle_probe_response) (struct net_device * dev,
821 				      struct libipw_probe_response * resp,
822 				      struct libipw_network * network);
823 	int (*handle_probe_request) (struct net_device * dev,
824 				     struct libipw_probe_request * req,
825 				     struct libipw_rx_stats * stats);
826 	int (*handle_assoc_response) (struct net_device * dev,
827 				      struct libipw_assoc_response * resp,
828 				      struct libipw_network * network);
829 
830 	/* Typical AP methods */
831 	int (*handle_assoc_request) (struct net_device * dev);
832 	int (*handle_reassoc_request) (struct net_device * dev,
833 				       struct libipw_reassoc_request * req);
834 
835 	/* This must be the last item so that it points to the data
836 	 * allocated beyond this structure by alloc_libipw */
837 	u8 priv[0];
838 };
839 
840 #define IEEE_A            (1<<0)
841 #define IEEE_B            (1<<1)
842 #define IEEE_G            (1<<2)
843 #define IEEE_MODE_MASK    (IEEE_A|IEEE_B|IEEE_G)
844 
845 static inline void *libipw_priv(struct net_device *dev)
846 {
847 	return ((struct libipw_device *)netdev_priv(dev))->priv;
848 }
849 
850 static inline int libipw_is_valid_mode(struct libipw_device *ieee,
851 					  int mode)
852 {
853 	/*
854 	 * It is possible for both access points and our device to support
855 	 * combinations of modes, so as long as there is one valid combination
856 	 * of ap/device supported modes, then return success
857 	 *
858 	 */
859 	if ((mode & IEEE_A) &&
860 	    (ieee->modulation & LIBIPW_OFDM_MODULATION) &&
861 	    (ieee->freq_band & LIBIPW_52GHZ_BAND))
862 		return 1;
863 
864 	if ((mode & IEEE_G) &&
865 	    (ieee->modulation & LIBIPW_OFDM_MODULATION) &&
866 	    (ieee->freq_band & LIBIPW_24GHZ_BAND))
867 		return 1;
868 
869 	if ((mode & IEEE_B) &&
870 	    (ieee->modulation & LIBIPW_CCK_MODULATION) &&
871 	    (ieee->freq_band & LIBIPW_24GHZ_BAND))
872 		return 1;
873 
874 	return 0;
875 }
876 
877 static inline int libipw_get_hdrlen(u16 fc)
878 {
879 	int hdrlen = LIBIPW_3ADDR_LEN;
880 	u16 stype = WLAN_FC_GET_STYPE(fc);
881 
882 	switch (WLAN_FC_GET_TYPE(fc)) {
883 	case IEEE80211_FTYPE_DATA:
884 		if ((fc & IEEE80211_FCTL_FROMDS) && (fc & IEEE80211_FCTL_TODS))
885 			hdrlen = LIBIPW_4ADDR_LEN;
886 		if (stype & IEEE80211_STYPE_QOS_DATA)
887 			hdrlen += 2;
888 		break;
889 	case IEEE80211_FTYPE_CTL:
890 		switch (WLAN_FC_GET_STYPE(fc)) {
891 		case IEEE80211_STYPE_CTS:
892 		case IEEE80211_STYPE_ACK:
893 			hdrlen = LIBIPW_1ADDR_LEN;
894 			break;
895 		default:
896 			hdrlen = LIBIPW_2ADDR_LEN;
897 			break;
898 		}
899 		break;
900 	}
901 
902 	return hdrlen;
903 }
904 
905 static inline u8 *libipw_get_payload(struct ieee80211_hdr *hdr)
906 {
907 	switch (libipw_get_hdrlen(le16_to_cpu(hdr->frame_control))) {
908 	case LIBIPW_1ADDR_LEN:
909 		return ((struct libipw_hdr_1addr *)hdr)->payload;
910 	case LIBIPW_2ADDR_LEN:
911 		return ((struct libipw_hdr_2addr *)hdr)->payload;
912 	case LIBIPW_3ADDR_LEN:
913 		return ((struct libipw_hdr_3addr *)hdr)->payload;
914 	case LIBIPW_4ADDR_LEN:
915 		return ((struct libipw_hdr_4addr *)hdr)->payload;
916 	}
917 	return NULL;
918 }
919 
920 static inline int libipw_is_ofdm_rate(u8 rate)
921 {
922 	switch (rate & ~LIBIPW_BASIC_RATE_MASK) {
923 	case LIBIPW_OFDM_RATE_6MB:
924 	case LIBIPW_OFDM_RATE_9MB:
925 	case LIBIPW_OFDM_RATE_12MB:
926 	case LIBIPW_OFDM_RATE_18MB:
927 	case LIBIPW_OFDM_RATE_24MB:
928 	case LIBIPW_OFDM_RATE_36MB:
929 	case LIBIPW_OFDM_RATE_48MB:
930 	case LIBIPW_OFDM_RATE_54MB:
931 		return 1;
932 	}
933 	return 0;
934 }
935 
936 static inline int libipw_is_cck_rate(u8 rate)
937 {
938 	switch (rate & ~LIBIPW_BASIC_RATE_MASK) {
939 	case LIBIPW_CCK_RATE_1MB:
940 	case LIBIPW_CCK_RATE_2MB:
941 	case LIBIPW_CCK_RATE_5MB:
942 	case LIBIPW_CCK_RATE_11MB:
943 		return 1;
944 	}
945 	return 0;
946 }
947 
948 /* libipw.c */
949 void free_libipw(struct net_device *dev, int monitor);
950 struct net_device *alloc_libipw(int sizeof_priv, int monitor);
951 
952 void libipw_networks_age(struct libipw_device *ieee, unsigned long age_secs);
953 
954 int libipw_set_encryption(struct libipw_device *ieee);
955 
956 /* libipw_tx.c */
957 netdev_tx_t libipw_xmit(struct sk_buff *skb, struct net_device *dev);
958 void libipw_txb_free(struct libipw_txb *);
959 
960 /* libipw_rx.c */
961 void libipw_rx_any(struct libipw_device *ieee, struct sk_buff *skb,
962 		   struct libipw_rx_stats *stats);
963 int libipw_rx(struct libipw_device *ieee, struct sk_buff *skb,
964 	      struct libipw_rx_stats *rx_stats);
965 /* make sure to set stats->len */
966 void libipw_rx_mgt(struct libipw_device *ieee, struct libipw_hdr_4addr *header,
967 		   struct libipw_rx_stats *stats);
968 
969 /* libipw_geo.c */
970 const struct libipw_geo *libipw_get_geo(struct libipw_device *ieee);
971 void libipw_set_geo(struct libipw_device *ieee, const struct libipw_geo *geo);
972 
973 int libipw_is_valid_channel(struct libipw_device *ieee, u8 channel);
974 int libipw_channel_to_index(struct libipw_device *ieee, u8 channel);
975 u8 libipw_freq_to_channel(struct libipw_device *ieee, u32 freq);
976 u8 libipw_get_channel_flags(struct libipw_device *ieee, u8 channel);
977 const struct libipw_channel *libipw_get_channel(struct libipw_device *ieee,
978 						u8 channel);
979 u32 libipw_channel_to_freq(struct libipw_device *ieee, u8 channel);
980 
981 /* libipw_wx.c */
982 int libipw_wx_get_scan(struct libipw_device *ieee, struct iw_request_info *info,
983 		       union iwreq_data *wrqu, char *key);
984 int libipw_wx_set_encode(struct libipw_device *ieee,
985 			 struct iw_request_info *info, union iwreq_data *wrqu,
986 			 char *key);
987 int libipw_wx_get_encode(struct libipw_device *ieee,
988 			 struct iw_request_info *info, union iwreq_data *wrqu,
989 			 char *key);
990 int libipw_wx_set_encodeext(struct libipw_device *ieee,
991 			    struct iw_request_info *info,
992 			    union iwreq_data *wrqu, char *extra);
993 int libipw_wx_get_encodeext(struct libipw_device *ieee,
994 			    struct iw_request_info *info,
995 			    union iwreq_data *wrqu, char *extra);
996 
997 static inline void libipw_increment_scans(struct libipw_device *ieee)
998 {
999 	ieee->scans++;
1000 }
1001 
1002 static inline int libipw_get_scans(struct libipw_device *ieee)
1003 {
1004 	return ieee->scans;
1005 }
1006 
1007 #endif				/* LIBIPW_H */
1008