1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3  *
4  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
5  *
6  ******************************************************************************/
7 #ifndef __IEEE80211_H
8 #define __IEEE80211_H
9 
10 #include <osdep_service.h>
11 #include <drv_types.h>
12 #include "wifi.h"
13 #include <linux/wireless.h>
14 
15 #define MGMT_QUEUE_NUM 5
16 
17 #define ETH_ALEN	6
18 #define ETH_TYPE_LEN		2
19 #define PAYLOAD_TYPE_LEN	1
20 
21 #ifdef CONFIG_88EU_AP_MODE
22 
23 #define RTL_IOCTL_HOSTAPD (SIOCIWFIRSTPRIV + 28)
24 
25 /* RTL871X_IOCTL_HOSTAPD ioctl() cmd: */
26 enum {
27 	RTL871X_HOSTAPD_FLUSH = 1,
28 	RTL871X_HOSTAPD_ADD_STA = 2,
29 	RTL871X_HOSTAPD_REMOVE_STA = 3,
30 	RTL871X_HOSTAPD_GET_INFO_STA = 4,
31 	/* REMOVED: PRISM2_HOSTAPD_RESET_TXEXC_STA = 5, */
32 	RTL871X_HOSTAPD_GET_WPAIE_STA = 5,
33 	RTL871X_SET_ENCRYPTION = 6,
34 	RTL871X_GET_ENCRYPTION = 7,
35 	RTL871X_HOSTAPD_SET_FLAGS_STA = 8,
36 	RTL871X_HOSTAPD_GET_RID = 9,
37 	RTL871X_HOSTAPD_SET_RID = 10,
38 	RTL871X_HOSTAPD_SET_ASSOC_AP_ADDR = 11,
39 	RTL871X_HOSTAPD_SET_GENERIC_ELEMENT = 12,
40 	RTL871X_HOSTAPD_MLME = 13,
41 	RTL871X_HOSTAPD_SCAN_REQ = 14,
42 	RTL871X_HOSTAPD_STA_CLEAR_STATS = 15,
43 	RTL871X_HOSTAPD_SET_BEACON = 16,
44 	RTL871X_HOSTAPD_SET_WPS_BEACON = 17,
45 	RTL871X_HOSTAPD_SET_WPS_PROBE_RESP = 18,
46 	RTL871X_HOSTAPD_SET_WPS_ASSOC_RESP = 19,
47 	RTL871X_HOSTAPD_SET_HIDDEN_SSID = 20,
48 	RTL871X_HOSTAPD_SET_MACADDR_ACL = 21,
49 	RTL871X_HOSTAPD_ACL_ADD_STA = 22,
50 	RTL871X_HOSTAPD_ACL_REMOVE_STA = 23,
51 };
52 
53 /* STA flags */
54 #define WLAN_STA_AUTH BIT(0)
55 #define WLAN_STA_ASSOC BIT(1)
56 #define WLAN_STA_PS BIT(2)
57 #define WLAN_STA_TIM BIT(3)
58 #define WLAN_STA_PERM BIT(4)
59 #define WLAN_STA_AUTHORIZED BIT(5)
60 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
61 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
62 #define WLAN_STA_PREAUTH BIT(8)
63 #define WLAN_STA_WME BIT(9)
64 #define WLAN_STA_MFP BIT(10)
65 #define WLAN_STA_HT BIT(11)
66 #define WLAN_STA_WPS BIT(12)
67 #define WLAN_STA_MAYBE_WPS BIT(13)
68 #define WLAN_STA_NONERP BIT(31)
69 
70 #endif
71 
72 #define IEEE_CMD_SET_WPA_PARAM			1
73 #define IEEE_CMD_SET_WPA_IE				2
74 #define IEEE_CMD_SET_ENCRYPTION			3
75 #define IEEE_CMD_MLME						4
76 
77 #define IEEE_PARAM_WPA_ENABLED				1
78 #define IEEE_PARAM_TKIP_COUNTERMEASURES		2
79 #define IEEE_PARAM_DROP_UNENCRYPTED			3
80 #define IEEE_PARAM_PRIVACY_INVOKED			4
81 #define IEEE_PARAM_AUTH_ALGS					5
82 #define IEEE_PARAM_IEEE_802_1X				6
83 #define IEEE_PARAM_WPAX_SELECT				7
84 
85 #define AUTH_ALG_OPEN_SYSTEM			0x1
86 #define AUTH_ALG_SHARED_KEY			0x2
87 #define AUTH_ALG_LEAP				0x00000004
88 
89 #define IEEE_MLME_STA_DEAUTH				1
90 #define IEEE_MLME_STA_DISASSOC			2
91 
92 #define IEEE_CRYPT_ERR_UNKNOWN_ALG			2
93 #define IEEE_CRYPT_ERR_UNKNOWN_ADDR			3
94 #define IEEE_CRYPT_ERR_CRYPT_INIT_FAILED		4
95 #define IEEE_CRYPT_ERR_KEY_SET_FAILED			5
96 #define IEEE_CRYPT_ERR_TX_KEY_SET_FAILED		6
97 #define IEEE_CRYPT_ERR_CARD_CONF_FAILED		7
98 
99 
100 #define	IEEE_CRYPT_ALG_NAME_LEN			16
101 
102 #define WPA_CIPHER_NONE		BIT(0)
103 #define WPA_CIPHER_WEP40	BIT(1)
104 #define WPA_CIPHER_WEP104 BIT(2)
105 #define WPA_CIPHER_TKIP		BIT(3)
106 #define WPA_CIPHER_CCMP		BIT(4)
107 
108 
109 
110 #define WPA_SELECTOR_LEN 4
111 extern u8 RTW_WPA_OUI_TYPE[];
112 extern u8 WPA_AUTH_KEY_MGMT_NONE[];
113 extern u8 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X[];
114 extern u8 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
115 extern u8 WPA_CIPHER_SUITE_NONE[];
116 extern u8 WPA_CIPHER_SUITE_WEP40[];
117 extern u8 WPA_CIPHER_SUITE_TKIP[];
118 extern u8 WPA_CIPHER_SUITE_WRAP[];
119 extern u8 WPA_CIPHER_SUITE_CCMP[];
120 extern u8 WPA_CIPHER_SUITE_WEP104[];
121 
122 
123 #define RSN_HEADER_LEN 4
124 #define RSN_SELECTOR_LEN 4
125 
126 extern u16 RSN_VERSION_BSD;
127 extern u8 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X[];
128 extern u8 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
129 extern u8 RSN_CIPHER_SUITE_NONE[];
130 extern u8 RSN_CIPHER_SUITE_WEP40[];
131 extern u8 RSN_CIPHER_SUITE_TKIP[];
132 extern u8 RSN_CIPHER_SUITE_WRAP[];
133 extern u8 RSN_CIPHER_SUITE_CCMP[];
134 extern u8 RSN_CIPHER_SUITE_WEP104[];
135 
136 enum ratr_table_mode {
137 	RATR_INX_WIRELESS_NGB = 0,	/*  BGN 40 Mhz 2SS 1SS */
138 	RATR_INX_WIRELESS_NG = 1,	/*  GN or N */
139 	RATR_INX_WIRELESS_NB = 2,	/*  BGN 20 Mhz 2SS 1SS  or BN */
140 	RATR_INX_WIRELESS_N = 3,
141 	RATR_INX_WIRELESS_GB = 4,
142 	RATR_INX_WIRELESS_G = 5,
143 	RATR_INX_WIRELESS_B = 6,
144 	RATR_INX_WIRELESS_MC = 7,
145 	RATR_INX_WIRELESS_AC_N = 8,
146 };
147 
148 enum NETWORK_TYPE {
149 	WIRELESS_INVALID = 0,
150 	/* Sub-Element */
151 	WIRELESS_11B = BIT(0), /* tx:cck only, rx:cck only, hw: cck */
152 	WIRELESS_11G = BIT(1), /* tx:ofdm only, rx:ofdm & cck, hw:cck & ofdm*/
153 	WIRELESS_11A = BIT(2), /* tx:ofdm only, rx: ofdm only, hw:ofdm only */
154 	WIRELESS_11_24N = BIT(3), /* tx:MCS only, rx:MCS & cck, hw:MCS & cck */
155 	WIRELESS_11_5N = BIT(4), /* tx:MCS only, rx:MCS & ofdm, hw:ofdm only */
156 	WIRELESS_AC		= BIT(6),
157 
158 	/* Combination */
159 	/*  tx: cck & ofdm, rx: cck & ofdm & MCS, hw: cck & ofdm */
160 	WIRELESS_11BG = (WIRELESS_11B | WIRELESS_11G),
161 	/*  tx: ofdm & MCS, rx: ofdm & cck & MCS, hw: cck & ofdm */
162 	WIRELESS_11G_24N = (WIRELESS_11G | WIRELESS_11_24N),
163 	/*  tx: ofdm & MCS, rx: ofdm & MCS, hw: ofdm only */
164 	WIRELESS_11A_5N = (WIRELESS_11A | WIRELESS_11_5N),
165 	/*  tx: ofdm & cck & MCS, rx: ofdm & cck & MCS, hw: ofdm & cck */
166 	WIRELESS_11BG_24N = (WIRELESS_11B | WIRELESS_11G | WIRELESS_11_24N),
167 	/*  tx: ofdm & MCS, rx: ofdm & MCS, hw: ofdm only */
168 	WIRELESS_11AGN = (WIRELESS_11A | WIRELESS_11G | WIRELESS_11_24N |
169 			  WIRELESS_11_5N),
170 	WIRELESS_11ABGN = (WIRELESS_11A | WIRELESS_11B | WIRELESS_11G |
171 			   WIRELESS_11_24N | WIRELESS_11_5N),
172 };
173 
174 #define SUPPORTED_24G_NETTYPE_MSK				\
175 	 (WIRELESS_11B | WIRELESS_11G | WIRELESS_11_24N)
176 #define SUPPORTED_5G_NETTYPE_MSK				\
177 	 (WIRELESS_11A | WIRELESS_11_5N)
178 
179 #define IsSupported24G(NetType)					\
180 	((NetType) & SUPPORTED_24G_NETTYPE_MSK ? true : false)
181 #define IsSupported5G(NetType)					\
182 	((NetType) & SUPPORTED_5G_NETTYPE_MSK ? true : false)
183 
184 #define IsEnableHWCCK(NetType)					\
185 	IsSupported24G(NetType)
186 #define IsEnableHWOFDM(NetType)					\
187 	((NetType) & (WIRELESS_11G | WIRELESS_11_24N |		\
188 	 SUPPORTED_5G_NETTYPE_MSK) ? true : false)
189 
190 #define IsSupportedRxCCK(NetType) IsEnableHWCCK(NetType)
191 #define IsSupportedRxOFDM(NetType) IsEnableHWOFDM(NetType)
192 #define IsSupportedRxMCS(NetType) IsEnableHWOFDM(NetType)
193 
194 #define IsSupportedTxCCK(NetType)				\
195 	((NetType) & (WIRELESS_11B) ? true : false)
196 #define IsSupportedTxOFDM(NetType)				\
197 	((NetType) & (WIRELESS_11G | WIRELESS_11A) ? true : false)
198 #define IsSupportedTxMCS(NetType)				\
199 	((NetType) & (WIRELESS_11_24N | WIRELESS_11_5N) ? true : false)
200 
201 
202 struct ieee_param {
203 	u32 cmd;
204 	u8 sta_addr[ETH_ALEN];
205 	union {
206 		struct {
207 			u8 name;
208 			u32 value;
209 		} wpa_param;
210 		struct {
211 			u32 len;
212 			u8 reserved[32];
213 			u8 data[0];
214 		} wpa_ie;
215 		struct {
216 			int command;
217 			int reason_code;
218 		} mlme;
219 		struct {
220 			u8 alg[IEEE_CRYPT_ALG_NAME_LEN];
221 			u8 set_tx;
222 			u32 err;
223 			u8 idx;
224 			u8 seq[8]; /* sequence counter (set: RX, get: TX) */
225 			u16 key_len;
226 			u8 key[0];
227 		} crypt;
228 #ifdef CONFIG_88EU_AP_MODE
229 		struct {
230 			u16 aid;
231 			u16 capability;
232 			int flags;
233 			u8 tx_supp_rates[16];
234 			struct ieee80211_ht_cap ht_cap;
235 		} add_sta;
236 		struct {
237 			u8	reserved[2];/* for set max_num_sta */
238 			u8	buf[0];
239 		} bcn_ie;
240 #endif
241 
242 	} u;
243 };
244 
245 #ifdef CONFIG_88EU_AP_MODE
246 struct ieee_param_ex {
247 	u32 cmd;
248 	u8 sta_addr[ETH_ALEN];
249 	u8 data[0];
250 };
251 
252 struct sta_data {
253 	u16 aid;
254 	u16 capability;
255 	int flags;
256 	u32 sta_set;
257 	u8 tx_supp_rates[16];
258 	u32 tx_supp_rates_len;
259 	struct ieee80211_ht_cap ht_cap;
260 	u64	rx_pkts;
261 	u64	rx_bytes;
262 	u64	rx_drops;
263 	u64	tx_pkts;
264 	u64	tx_bytes;
265 	u64	tx_drops;
266 };
267 #endif
268 
269 #define IEEE80211_DATA_LEN		2304
270 /* Maximum size for the MA-UNITDATA primitive, 802.11 standard section
271  * 6.2.1.1.2.
272 
273  * The figure in section 7.1.2 suggests a body size of up to 2312
274  * bytes is allowed, which is a bit confusing, I suspect this
275  * represents the 2304 bytes of real data, plus a possible 8 bytes of
276  * WEP IV and ICV. (this interpretation suggested by Ramiro Barreiro)
277  */
278 
279 
280 #define IEEE80211_HLEN			30
281 #define IEEE80211_FRAME_LEN		(IEEE80211_DATA_LEN + IEEE80211_HLEN)
282 
283 
284 /* this is stolen from ipw2200 driver */
285 #define IEEE_IBSS_MAC_HASH_SIZE 31
286 
287 enum eap_type {
288 	EAP_PACKET = 0,
289 	EAPOL_START,
290 	EAPOL_LOGOFF,
291 	EAPOL_KEY,
292 	EAPOL_ENCAP_ASF_ALERT
293 };
294 
295 #define IEEE80211_3ADDR_LEN 24
296 #define IEEE80211_4ADDR_LEN 30
297 #define IEEE80211_FCS_LEN    4
298 
299 #define MIN_FRAG_THRESHOLD     256U
300 #define	MAX_FRAG_THRESHOLD     2346U
301 
302 /* sequence control field */
303 #define RTW_IEEE80211_SCTL_FRAG	0x000F
304 #define RTW_IEEE80211_SCTL_SEQ	0xFFF0
305 
306 
307 #define RTW_ERP_INFO_NON_ERP_PRESENT BIT(0)
308 #define RTW_ERP_INFO_USE_PROTECTION BIT(1)
309 #define RTW_ERP_INFO_BARKER_PREAMBLE_MODE BIT(2)
310 
311 /* QoS, QOS */
312 #define NORMAL_ACK			0
313 #define NO_ACK				1
314 #define NON_EXPLICIT_ACK		2
315 #define BLOCK_ACK			3
316 
317 #ifndef ETH_P_PAE
318 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
319 #endif /* ETH_P_PAE */
320 
321 #define ETH_P_PREAUTH 0x88C7 /* IEEE 802.11i pre-authentication */
322 
323 #define ETH_P_ECONET	0x0018
324 
325 #ifndef ETH_P_80211_RAW
326 #define ETH_P_80211_RAW (ETH_P_ECONET + 1)
327 #endif
328 
329 /* IEEE 802.11 defines */
330 
331 #define P80211_OUI_LEN 3
332 
333 struct ieee80211_snap_hdr {
334 	u8    dsap;   /* always 0xAA */
335 	u8    ssap;   /* always 0xAA */
336 	u8    ctrl;   /* always 0x03 */
337 	u8    oui[P80211_OUI_LEN];    /* organizational universal id */
338 } __packed;
339 
340 #define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
341 
342 #define WLAN_QC_GET_TID(qc) ((qc) & 0x0f)
343 
344 #define WLAN_GET_SEQ_FRAG(seq) ((seq) & RTW_IEEE80211_SCTL_FRAG)
345 #define WLAN_GET_SEQ_SEQ(seq)  ((seq) & RTW_IEEE80211_SCTL_SEQ)
346 
347 /* Non standard?  Not in <linux/ieee80211.h> */
348 #define WLAN_REASON_EXPIRATION_CHK 65535
349 
350 #define IEEE80211_MGMT_HDR_LEN 24
351 #define IEEE80211_DATA_HDR3_LEN 24
352 #define IEEE80211_DATA_HDR4_LEN 30
353 
354 #define IEEE80211_CCK_MODULATION	BIT(0)
355 #define IEEE80211_OFDM_MODULATION	BIT(1)
356 
357 #define IEEE80211_24GHZ_BAND	BIT(0)
358 #define IEEE80211_52GHZ_BAND	BIT(1)
359 
360 #define IEEE80211_CCK_RATE_LEN			4
361 #define IEEE80211_NUM_OFDM_RATESLEN	8
362 
363 
364 #define IEEE80211_CCK_RATE_1MB			0x02
365 #define IEEE80211_CCK_RATE_2MB			0x04
366 #define IEEE80211_CCK_RATE_5MB			0x0B
367 #define IEEE80211_CCK_RATE_11MB			0x16
368 #define IEEE80211_OFDM_RATE_LEN			8
369 #define IEEE80211_OFDM_RATE_6MB			0x0C
370 #define IEEE80211_OFDM_RATE_9MB			0x12
371 #define IEEE80211_OFDM_RATE_12MB		0x18
372 #define IEEE80211_OFDM_RATE_18MB		0x24
373 #define IEEE80211_OFDM_RATE_24MB		0x30
374 #define IEEE80211_OFDM_RATE_36MB		0x48
375 #define IEEE80211_OFDM_RATE_48MB		0x60
376 #define IEEE80211_OFDM_RATE_54MB		0x6C
377 #define IEEE80211_BASIC_RATE_MASK		0x80
378 
379 #define IEEE80211_CCK_RATE_1MB_MASK		BIT(0)
380 #define IEEE80211_CCK_RATE_2MB_MASK		BIT(1)
381 #define IEEE80211_CCK_RATE_5MB_MASK		BIT(2)
382 #define IEEE80211_CCK_RATE_11MB_MASK		BIT(3)
383 #define IEEE80211_OFDM_RATE_6MB_MASK		BIT(4)
384 #define IEEE80211_OFDM_RATE_9MB_MASK		BIT(5)
385 #define IEEE80211_OFDM_RATE_12MB_MASK		BIT(6)
386 #define IEEE80211_OFDM_RATE_18MB_MASK		BIT(7)
387 #define IEEE80211_OFDM_RATE_24MB_MASK		BIT(8)
388 #define IEEE80211_OFDM_RATE_36MB_MASK		BIT(9)
389 #define IEEE80211_OFDM_RATE_48MB_MASK		BIT(10)
390 #define IEEE80211_OFDM_RATE_54MB_MASK		BIT(11)
391 
392 #define IEEE80211_CCK_RATES_MASK		0x0000000F
393 #define IEEE80211_CCK_BASIC_RATES_MASK	(IEEE80211_CCK_RATE_1MB_MASK | \
394 	IEEE80211_CCK_RATE_2MB_MASK)
395 #define IEEE80211_CCK_DEFAULT_RATES_MASK				\
396 	(IEEE80211_CCK_BASIC_RATES_MASK |				\
397 	IEEE80211_CCK_RATE_5MB_MASK |					\
398 	IEEE80211_CCK_RATE_11MB_MASK)
399 
400 #define IEEE80211_OFDM_RATES_MASK		0x00000FF0
401 #define IEEE80211_OFDM_BASIC_RATES_MASK	(IEEE80211_OFDM_RATE_6MB_MASK | \
402 	IEEE80211_OFDM_RATE_12MB_MASK |					\
403 	IEEE80211_OFDM_RATE_24MB_MASK)
404 #define IEEE80211_OFDM_DEFAULT_RATES_MASK				\
405 	(IEEE80211_OFDM_BASIC_RATES_MASK |				\
406 	IEEE80211_OFDM_RATE_9MB_MASK  |					\
407 	IEEE80211_OFDM_RATE_18MB_MASK |					\
408 	IEEE80211_OFDM_RATE_36MB_MASK |					\
409 	IEEE80211_OFDM_RATE_48MB_MASK |					\
410 	IEEE80211_OFDM_RATE_54MB_MASK)
411 
412 #define IEEE80211_NUM_OFDM_RATES	8
413 #define IEEE80211_NUM_CCK_RATES		4
414 #define IEEE80211_OFDM_SHIFT_MASK_A	4
415 
416 /* IEEE 802.11 requires that STA supports concurrent reception of at least
417  * three fragmented frames. This define can be increased to support more
418  * concurrent frames, but it should be noted that each entry can consume about
419  * 2 kB of RAM and increasing cache size will slow down frame reassembly.
420  */
421 #define IEEE80211_FRAG_CACHE_LEN 4
422 
423 #define SEC_KEY_1	BIT(0)
424 #define SEC_KEY_2	BIT(1)
425 #define SEC_KEY_3	BIT(2)
426 #define SEC_KEY_4	BIT(3)
427 #define SEC_ACTIVE_KEY  BIT(4)
428 #define SEC_AUTH_MODE   BIT(5)
429 #define SEC_UNICAST_GROUP BIT(6)
430 #define SEC_LEVEL	BIT(7)
431 #define SEC_ENABLED     BIT(8)
432 
433 #define SEC_LEVEL_0      0 /* None */
434 #define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
435 #define SEC_LEVEL_2      2 /* Level 1 + TKIP */
436 #define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
437 #define SEC_LEVEL_3      4 /* Level 2 + CCMP */
438 
439 #define WEP_KEYS 4
440 #define WEP_KEY_LEN 13
441 
442 /* SWEEP TABLE ENTRIES NUMBER*/
443 #define MAX_SWEEP_TAB_ENTRIES		  42
444 #define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
445 /* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
446  * only use 8, and then use extended rates for the remaining supported
447  * rates.  Other APs, however, stick all of their supported rates on the
448  * main rates information element...
449  */
450 #define MAX_RATES_LENGTH		((u8)12)
451 #define MAX_RATES_EX_LENGTH		((u8)16)
452 #define MAX_NETWORK_COUNT		128
453 #define MAX_CHANNEL_NUMBER		161
454 #define IEEE80211_SOFTMAC_SCAN_TIME	400
455 /* HZ / 2) */
456 #define IEEE80211_SOFTMAC_ASSOC_RETRY_TIME (HZ * 2)
457 
458 #define CRC_LENGTH		 4U
459 
460 #define MAX_WPA_IE_LEN (256)
461 #define MAX_WPS_IE_LEN (512)
462 #define MAX_P2P_IE_LEN (256)
463 #define MAX_WFD_IE_LEN (128)
464 
465 #define NETWORK_EMPTY_ESSID	BIT(0)
466 #define NETWORK_HAS_OFDM	BIT(1)
467 #define NETWORK_HAS_CCK		BIT(2)
468 
469 #define IW_ESSID_MAX_SIZE 32
470 /*
471  * join_res:
472  * -1: authentication fail
473  * -2: association fail
474  * > 0: TID
475  */
476 
477 enum ieee80211_state {
478 	/* the card is not linked at all */
479 	IEEE80211_NOLINK = 0,
480 
481 	/* IEEE80211_ASSOCIATING* are for BSS client mode
482 	 * the driver shall not perform RX filtering unless
483 	 * the state is LINKED.
484 	 * The driver shall just check for the state LINKED and
485 	 * defaults to NOLINK for ALL the other states (including
486 	 * LINKED_SCANNING)
487 	 */
488 
489 	/* the association procedure will start (wq scheduling)*/
490 	IEEE80211_ASSOCIATING,
491 	IEEE80211_ASSOCIATING_RETRY,
492 
493 	/* the association procedure is sending AUTH request*/
494 	IEEE80211_ASSOCIATING_AUTHENTICATING,
495 
496 	/* the association procedure has successfully authentcated
497 	 * and is sending association request
498 	 */
499 	IEEE80211_ASSOCIATING_AUTHENTICATED,
500 
501 	/* the link is ok. the card associated to a BSS or linked
502 	 * to a ibss cell or acting as an AP and creating the bss
503 	 */
504 	IEEE80211_LINKED,
505 
506 	/* same as LINKED, but the driver shall apply RX filter
507 	 * rules as we are in NO_LINK mode. As the card is still
508 	 * logically linked, but it is doing a syncro site survey
509 	 * then it will be back to LINKED state.
510 	 */
511 	IEEE80211_LINKED_SCANNING,
512 
513 };
514 
515 #define DEFAULT_MAX_SCAN_AGE (15 * HZ)
516 #define DEFAULT_FTS 2346
517 
518 #define CFG_IEEE80211_RESERVE_FCS	BIT(0)
519 #define CFG_IEEE80211_COMPUTE_FCS	BIT(1)
520 
521 #define MAXTID	16
522 
523 #define IEEE_A	    BIT(0)
524 #define IEEE_B	    BIT(1)
525 #define IEEE_G	    BIT(2)
526 #define IEEE_MODE_MASK    (IEEE_A | IEEE_B | IEEE_G)
527 
528 /* Action category code */
529 enum rtw_ieee80211_category {
530 	RTW_WLAN_CATEGORY_SPECTRUM_MGMT = 0,
531 	RTW_WLAN_CATEGORY_QOS = 1,
532 	RTW_WLAN_CATEGORY_DLS = 2,
533 	RTW_WLAN_CATEGORY_BACK = 3,
534 	RTW_WLAN_CATEGORY_PUBLIC = 4, /* IEEE 802.11 public action frames */
535 	RTW_WLAN_CATEGORY_RADIO_MEASUREMENT  = 5,
536 	RTW_WLAN_CATEGORY_FT = 6,
537 	RTW_WLAN_CATEGORY_HT = 7,
538 	RTW_WLAN_CATEGORY_SA_QUERY = 8,
539 	RTW_WLAN_CATEGORY_TDLS = 12,
540 	RTW_WLAN_CATEGORY_WMM = 17,
541 	RTW_WLAN_CATEGORY_P2P = 0x7f,/* P2P action frames */
542 };
543 
544 /* SPECTRUM_MGMT action code */
545 enum rtw_ieee80211_spectrum_mgmt_actioncode {
546 	RTW_WLAN_ACTION_SPCT_MSR_REQ = 0,
547 	RTW_WLAN_ACTION_SPCT_MSR_RPRT = 1,
548 	RTW_WLAN_ACTION_SPCT_TPC_REQ = 2,
549 	RTW_WLAN_ACTION_SPCT_TPC_RPRT = 3,
550 	RTW_WLAN_ACTION_SPCT_CHL_SWITCH = 4,
551 	RTW_WLAN_ACTION_SPCT_EXT_CHL_SWITCH = 5,
552 };
553 
554 enum _PUBLIC_ACTION {
555 	ACT_PUBLIC_BSSCOEXIST = 0, /*  20/40 BSS Coexistence */
556 	ACT_PUBLIC_DSE_ENABLE = 1,
557 	ACT_PUBLIC_DSE_DEENABLE = 2,
558 	ACT_PUBLIC_DSE_REG_LOCATION = 3,
559 	ACT_PUBLIC_EXT_CHL_SWITCH = 4,
560 	ACT_PUBLIC_DSE_MSR_REQ = 5,
561 	ACT_PUBLIC_DSE_MSR_RPRT = 6,
562 	ACT_PUBLIC_MP = 7, /*  Measurement Pilot */
563 	ACT_PUBLIC_DSE_PWR_CONSTRAINT = 8,
564 	ACT_PUBLIC_VENDOR = 9, /*  for WIFI_DIRECT */
565 	ACT_PUBLIC_GAS_INITIAL_REQ = 10,
566 	ACT_PUBLIC_GAS_INITIAL_RSP = 11,
567 	ACT_PUBLIC_GAS_COMEBACK_REQ = 12,
568 	ACT_PUBLIC_GAS_COMEBACK_RSP = 13,
569 	ACT_PUBLIC_TDLS_DISCOVERY_RSP = 14,
570 	ACT_PUBLIC_LOCATION_TRACK = 15,
571 	ACT_PUBLIC_MAX
572 };
573 
574 /* BACK action code */
575 enum rtw_ieee80211_back_actioncode {
576 	RTW_WLAN_ACTION_ADDBA_REQ = 0,
577 	RTW_WLAN_ACTION_ADDBA_RESP = 1,
578 	RTW_WLAN_ACTION_DELBA = 2,
579 };
580 
581 /* HT features action code */
582 enum rtw_ieee80211_ht_actioncode {
583 	RTW_WLAN_ACTION_NOTIFY_CH_WIDTH = 0,
584 	RTW_WLAN_ACTION_SM_PS = 1,
585 	RTW_WLAN_ACTION_PSPM = 2,
586 	RTW_WLAN_ACTION_PCO_PHASE = 3,
587 	RTW_WLAN_ACTION_MIMO_CSI_MX = 4,
588 	RTW_WLAN_ACTION_MIMO_NONCP_BF = 5,
589 	RTW_WLAN_ACTION_MIMP_CP_BF = 6,
590 	RTW_WLAN_ACTION_ASEL_INDICATES_FB = 7,
591 	RTW_WLAN_ACTION_HI_INFO_EXCHG = 8,
592 };
593 
594 /* BACK (block-ack) parties */
595 enum rtw_ieee80211_back_parties {
596 	RTW_WLAN_BACK_RECIPIENT = 0,
597 	RTW_WLAN_BACK_INITIATOR = 1,
598 	RTW_WLAN_BACK_TIMER = 2,
599 };
600 
601 #define OUI_MICROSOFT 0x0050f2 /* Microsoft (also used in Wi-Fi specs)
602 				* 00:50:F2
603 				*/
604 #define WME_OUI_TYPE 2
605 #define WME_OUI_SUBTYPE_INFORMATION_ELEMENT 0
606 #define WME_OUI_SUBTYPE_PARAMETER_ELEMENT 1
607 #define WME_OUI_SUBTYPE_TSPEC_ELEMENT 2
608 #define WME_VERSION 1
609 
610 #define WME_ACTION_CODE_SETUP_REQUEST 0
611 #define WME_ACTION_CODE_SETUP_RESPONSE 1
612 #define WME_ACTION_CODE_TEARDOWN 2
613 
614 #define WME_SETUP_RESPONSE_STATUS_ADMISSION_ACCEPTED 0
615 #define WME_SETUP_RESPONSE_STATUS_INVALID_PARAMETERS 1
616 #define WME_SETUP_RESPONSE_STATUS_REFUSED 3
617 
618 #define WME_TSPEC_DIRECTION_UPLINK 0
619 #define WME_TSPEC_DIRECTION_DOWNLINK 1
620 #define WME_TSPEC_DIRECTION_BI_DIRECTIONAL 3
621 
622 
623 #define OUI_BROADCOM 0x00904c /* Broadcom (Epigram) */
624 
625 #define VENDOR_HT_CAPAB_OUI_TYPE 0x33 /* 00-90-4c:0x33 */
626 
627 /**
628  * enum rtw_ieee80211_channel_flags - channel flags
629  *
630  * Channel flags set by the regulatory control code.
631  *
632  * @RTW_IEEE80211_CHAN_DISABLED: This channel is disabled.
633  * @RTW_IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
634  *      on this channel.
635  * @RTW_IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
636  * @RTW_IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
637  * @RTW_IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
638  *      is not permitted.
639  * @RTW_IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
640  *      is not permitted.
641  */
642 enum rtw_ieee80211_channel_flags {
643 	RTW_IEEE80211_CHAN_DISABLED	 = BIT(0),
644 	RTW_IEEE80211_CHAN_PASSIVE_SCAN     = BIT(1),
645 	RTW_IEEE80211_CHAN_NO_IBSS	  = BIT(2),
646 	RTW_IEEE80211_CHAN_RADAR	    = BIT(3),
647 	RTW_IEEE80211_CHAN_NO_HT40PLUS      = BIT(4),
648 	RTW_IEEE80211_CHAN_NO_HT40MINUS     = BIT(5),
649 };
650 
651 #define RTW_IEEE80211_CHAN_NO_HT40 \
652 	  (RTW_IEEE80211_CHAN_NO_HT40PLUS | RTW_IEEE80211_CHAN_NO_HT40MINUS)
653 
654 /* Represent channel details, subset of ieee80211_channel */
655 struct rtw_ieee80211_channel {
656 	u16 hw_value;
657 	u32 flags;
658 };
659 
660 #define CHAN_FMT \
661 	"hw_value:%u, " \
662 	"flags:0x%08x" \
663 
664 #define CHAN_ARG(channel) \
665 	(channel)->hw_value \
666 	, (channel)->flags \
667 
668 /* Parsed Information Elements */
669 struct rtw_ieee802_11_elems {
670 	u8 *ssid;
671 	u8 ssid_len;
672 	u8 *supp_rates;
673 	u8 supp_rates_len;
674 	u8 *fh_params;
675 	u8 fh_params_len;
676 	u8 *ds_params;
677 	u8 ds_params_len;
678 	u8 *cf_params;
679 	u8 cf_params_len;
680 	u8 *tim;
681 	u8 tim_len;
682 	u8 *ibss_params;
683 	u8 ibss_params_len;
684 	u8 *challenge;
685 	u8 challenge_len;
686 	u8 *erp_info;
687 	u8 erp_info_len;
688 	u8 *ext_supp_rates;
689 	u8 ext_supp_rates_len;
690 	u8 *wpa_ie;
691 	u8 wpa_ie_len;
692 	u8 *rsn_ie;
693 	u8 rsn_ie_len;
694 	u8 *wme;
695 	u8 wme_len;
696 	u8 *wme_tspec;
697 	u8 wme_tspec_len;
698 	u8 *wps_ie;
699 	u8 wps_ie_len;
700 	u8 *power_cap;
701 	u8 power_cap_len;
702 	u8 *supp_channels;
703 	u8 supp_channels_len;
704 	u8 *mdie;
705 	u8 mdie_len;
706 	u8 *ftie;
707 	u8 ftie_len;
708 	u8 *timeout_int;
709 	u8 timeout_int_len;
710 	u8 *ht_capabilities;
711 	u8 ht_capabilities_len;
712 	u8 *ht_operation;
713 	u8 ht_operation_len;
714 	u8 *vendor_ht_cap;
715 	u8 vendor_ht_cap_len;
716 };
717 
718 enum parse_res {
719 	ParseOK = 0,
720 	ParseUnknown = 1,
721 	ParseFailed = -1
722 };
723 
724 enum parse_res rtw_ieee802_11_parse_elems(u8 *start, uint len,
725 					  struct rtw_ieee802_11_elems *elems,
726 					  int show_errors);
727 
728 u8 *rtw_set_fixed_ie(void *pbuf, unsigned int len,
729 		     void *source, unsigned int *frlen);
730 u8 *rtw_set_ie(u8 *pbuf, int index, uint len, u8 *source, uint *frlen);
731 
732 enum secondary_ch_offset {
733 	SCN = 0, /* no secondary channel */
734 	SCA = 1, /* secondary channel above */
735 	SCB = 3,  /* secondary channel below */
736 };
737 
738 u8 *rtw_get_ie(u8 *pbuf, int index, uint *len, int limit);
739 
740 void rtw_set_supported_rate(u8 *SupportedRates, uint mode);
741 
742 unsigned char *rtw_get_wpa_ie(unsigned char *pie, uint *wpa_ie_len, int limit);
743 unsigned char *rtw_get_wpa2_ie(unsigned char *pie, uint *rsn_ie_len, int limit);
744 int rtw_get_wpa_cipher_suite(u8 *s);
745 int rtw_get_wpa2_cipher_suite(u8 *s);
746 int rtw_get_wapi_ie(u8 *in_ie, uint in_len, u8 *wapi_ie, u16 *wapi_len);
747 int rtw_parse_wpa_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher,
748 		     int *pairwise_cipher, int *is_8021x);
749 int rtw_parse_wpa2_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher,
750 		      int *pairwise_cipher, int *is_8021x);
751 
752 int rtw_get_sec_ie(u8 *in_ie, uint in_len, u8 *rsn_ie, u16 *rsn_len,
753 		   u8 *wpa_ie, u16 *wpa_len);
754 
755 u8 rtw_is_wps_ie(u8 *ie_ptr, uint *wps_ielen);
756 u8 *rtw_get_wps_ie(u8 *in_ie, uint in_len, u8 *wps_ie, uint *wps_ielen);
757 u8 *rtw_get_wps_attr(u8 *wps_ie, uint wps_ielen, u16 target_attr_id,
758 		     u8 *buf_attr, u32 *len_attr);
759 u8 *rtw_get_wps_attr_content(u8 *wps_ie, uint wps_ielen, u16 target_attr_id,
760 			     u8 *buf_content, uint *len_content);
761 
762 uint	rtw_get_rateset_len(u8	*rateset);
763 
764 struct registry_priv;
765 int rtw_generate_ie(struct registry_priv *pregistrypriv);
766 
767 
768 int rtw_get_bit_value_from_ieee_value(u8 val);
769 
770 bool rtw_is_cckrates_included(u8 *rate);
771 
772 bool rtw_is_cckratesonly_included(u8 *rate);
773 
774 int rtw_check_network_type(unsigned char *rate, int ratelen, int channel);
775 
776 void rtw_get_bcn_info(struct wlan_network *pnetwork);
777 
778 void rtw_macaddr_cfg(u8 *mac_addr);
779 
780 u16 rtw_mcs_rate(u8 rf_type, u8 bw_40MHz, u8 short_GI_20, u8 short_GI_40,
781 		 unsigned char *MCS_rate);
782 
783 #endif /* IEEE80211_H */
784