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