• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12  * more details.
13  *
14  ******************************************************************************/
15 #ifndef _WIFI_H_
16 #define _WIFI_H_
17 
18 #define WLAN_IEEE_OUI_LEN	3
19 #define WLAN_CRC_LEN		4
20 #define WLAN_BSSID_LEN		6
21 #define WLAN_BSS_TS_LEN		8
22 #define WLAN_HDR_A3_LEN		24
23 #define WLAN_HDR_A4_LEN		30
24 #define WLAN_HDR_A3_QOS_LEN	26
25 #define WLAN_HDR_A4_QOS_LEN	32
26 #define WLAN_DATA_MAXLEN	2312
27 
28 #define WLAN_A3_PN_OFFSET	24
29 #define WLAN_A4_PN_OFFSET	30
30 
31 #define WLAN_MIN_ETHFRM_LEN	60
32 #define WLAN_MAX_ETHFRM_LEN	1514
33 
34 #define P80211CAPTURE_VERSION	0x80211001
35 
36 /*  This value is tested by WiFi 11n Test Plan 5.2.3. */
37 /*  This test verifies the WLAN NIC can update the NAV through sending
38  *  the CTS with large duration. */
39 #define	WiFiNavUpperUs				30000	/*  30 ms */
40 
41 enum WIFI_FRAME_TYPE {
42 	WIFI_MGT_TYPE  =	(0),
43 	WIFI_CTRL_TYPE =	(BIT(2)),
44 	WIFI_DATA_TYPE =	(BIT(3)),
45 	WIFI_QOS_DATA_TYPE	= (BIT(7)|BIT(3)),	/*  QoS Data */
46 };
47 
48 enum WIFI_FRAME_SUBTYPE {
49 	/*  below is for mgt frame */
50 	WIFI_ASSOCREQ       = (0 | WIFI_MGT_TYPE),
51 	WIFI_ASSOCRSP       = (BIT(4) | WIFI_MGT_TYPE),
52 	WIFI_REASSOCREQ     = (BIT(5) | WIFI_MGT_TYPE),
53 	WIFI_REASSOCRSP     = (BIT(5) | BIT(4) | WIFI_MGT_TYPE),
54 	WIFI_PROBEREQ       = (BIT(6) | WIFI_MGT_TYPE),
55 	WIFI_PROBERSP       = (BIT(6) | BIT(4) | WIFI_MGT_TYPE),
56 	WIFI_BEACON         = (BIT(7) | WIFI_MGT_TYPE),
57 	WIFI_ATIM           = (BIT(7) | BIT(4) | WIFI_MGT_TYPE),
58 	WIFI_DISASSOC       = (BIT(7) | BIT(5) | WIFI_MGT_TYPE),
59 	WIFI_AUTH           = (BIT(7) | BIT(5) | BIT(4) | WIFI_MGT_TYPE),
60 	WIFI_DEAUTH         = (BIT(7) | BIT(6) | WIFI_MGT_TYPE),
61 	WIFI_ACTION         = (BIT(7) | BIT(6) | BIT(4) | WIFI_MGT_TYPE),
62 
63 	/*  below is for control frame */
64 	WIFI_PSPOLL         = (BIT(7) | BIT(5) | WIFI_CTRL_TYPE),
65 	WIFI_RTS            = (BIT(7) | BIT(5) | BIT(4) | WIFI_CTRL_TYPE),
66 	WIFI_CTS            = (BIT(7) | BIT(6) | WIFI_CTRL_TYPE),
67 	WIFI_ACK            = (BIT(7) | BIT(6) | BIT(4) | WIFI_CTRL_TYPE),
68 	WIFI_CFEND          = (BIT(7) | BIT(6) | BIT(5) | WIFI_CTRL_TYPE),
69 	WIFI_CFEND_CFACK    = (BIT(7) | BIT(6) | BIT(5) | BIT(4) |
70 	WIFI_CTRL_TYPE),
71 
72 	/*  below is for data frame */
73 	WIFI_DATA           = (0 | WIFI_DATA_TYPE),
74 	WIFI_DATA_CFACK     = (BIT(4) | WIFI_DATA_TYPE),
75 	WIFI_DATA_CFPOLL    = (BIT(5) | WIFI_DATA_TYPE),
76 	WIFI_DATA_CFACKPOLL = (BIT(5) | BIT(4) | WIFI_DATA_TYPE),
77 	WIFI_DATA_NULL      = (BIT(6) | WIFI_DATA_TYPE),
78 	WIFI_CF_ACK         = (BIT(6) | BIT(4) | WIFI_DATA_TYPE),
79 	WIFI_CF_POLL        = (BIT(6) | BIT(5) | WIFI_DATA_TYPE),
80 	WIFI_CF_ACKPOLL     = (BIT(6) | BIT(5) | BIT(4) | WIFI_DATA_TYPE),
81 	WIFI_QOS_DATA_NULL	= (BIT(6) | WIFI_QOS_DATA_TYPE),
82 };
83 
84 enum WIFI_REASON_CODE	{
85 	_RSON_RESERVED_			= 0,
86 	_RSON_UNSPECIFIED_		= 1,
87 	_RSON_AUTH_NO_LONGER_VALID_	= 2,
88 	_RSON_DEAUTH_STA_LEAVING_	= 3,
89 	_RSON_INACTIVITY_		= 4,
90 	_RSON_UNABLE_HANDLE_		= 5,
91 	_RSON_CLS2_			= 6,
92 	_RSON_CLS3_			= 7,
93 	_RSON_DISAOC_STA_LEAVING_	= 8,
94 	_RSON_ASOC_NOT_AUTH_		= 9,
95 
96 	/*  WPA reason */
97 	_RSON_INVALID_IE_		= 13,
98 	_RSON_MIC_FAILURE_		= 14,
99 	_RSON_4WAY_HNDSHK_TIMEOUT_	= 15,
100 	_RSON_GROUP_KEY_UPDATE_TIMEOUT_	= 16,
101 	_RSON_DIFF_IE_			= 17,
102 	_RSON_MLTCST_CIPHER_NOT_VALID_	= 18,
103 	_RSON_UNICST_CIPHER_NOT_VALID_	= 19,
104 	_RSON_AKMP_NOT_VALID_		= 20,
105 	_RSON_UNSUPPORT_RSNE_VER_	= 21,
106 	_RSON_INVALID_RSNE_CAP_		= 22,
107 	_RSON_IEEE_802DOT1X_AUTH_FAIL_	= 23,
108 
109 	/* belowing are Realtek definition */
110 	_RSON_PMK_NOT_AVAILABLE_	= 24,
111 	_RSON_TDLS_TEAR_TOOFAR_		= 25,
112 	_RSON_TDLS_TEAR_UN_RSN_		= 26,
113 };
114 
115 enum WIFI_STATUS_CODE {
116 	_STATS_SUCCESSFUL_		= 0,
117 	_STATS_FAILURE_			= 1,
118 	_STATS_CAP_FAIL_		= 10,
119 	_STATS_NO_ASOC_			= 11,
120 	_STATS_OTHER_			= 12,
121 	_STATS_NO_SUPP_ALG_		= 13,
122 	_STATS_OUT_OF_AUTH_SEQ_		= 14,
123 	_STATS_CHALLENGE_FAIL_		= 15,
124 	_STATS_AUTH_TIMEOUT_		= 16,
125 	_STATS_UNABLE_HANDLE_STA_	= 17,
126 	_STATS_RATE_FAIL_		= 18,
127 };
128 
129 enum WIFI_REG_DOMAIN {
130 	DOMAIN_FCC	= 1,
131 	DOMAIN_IC	= 2,
132 	DOMAIN_ETSI	= 3,
133 	DOMAIN_SPA	= 4,
134 	DOMAIN_FRANCE	= 5,
135 	DOMAIN_MKK	= 6,
136 	DOMAIN_ISRAEL	= 7,
137 	DOMAIN_MKK1	= 8,
138 	DOMAIN_MKK2	= 9,
139 	DOMAIN_MKK3	= 10,
140 	DOMAIN_MAX
141 };
142 
143 #define _TO_DS_		BIT(8)
144 #define _FROM_DS_	BIT(9)
145 #define _MORE_FRAG_	BIT(10)
146 #define _RETRY_		BIT(11)
147 #define _PWRMGT_	BIT(12)
148 #define _MORE_DATA_	BIT(13)
149 #define _PRIVACY_	BIT(14)
150 #define _ORDER_		BIT(15)
151 
152 #define SetToDs(pbuf)	\
153 	*(__le16 *)(pbuf) |= cpu_to_le16(_TO_DS_)
154 
155 #define GetToDs(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_TO_DS_)) != 0)
156 
157 #define ClearToDs(pbuf)	\
158 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_TO_DS_))
159 
160 #define SetFrDs(pbuf)	\
161 	*(__le16 *)(pbuf) |= cpu_to_le16(_FROM_DS_)
162 
163 #define GetFrDs(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_FROM_DS_)) != 0)
164 
165 #define ClearFrDs(pbuf)	\
166 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_FROM_DS_))
167 
168 #define get_tofr_ds(pframe)	((GetToDs(pframe) << 1) | GetFrDs(pframe))
169 
170 
171 #define SetMFrag(pbuf)	\
172 	*(__le16 *)(pbuf) |= cpu_to_le16(_MORE_FRAG_)
173 
174 #define GetMFrag(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_MORE_FRAG_)) != 0)
175 
176 #define ClearMFrag(pbuf)	\
177 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_MORE_FRAG_))
178 
179 #define SetRetry(pbuf)	\
180 	*(__le16 *)(pbuf) |= cpu_to_le16(_RETRY_)
181 
182 #define GetRetry(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_RETRY_)) != 0)
183 
184 #define ClearRetry(pbuf)	\
185 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_RETRY_))
186 
187 #define SetPwrMgt(pbuf)	\
188 	*(__le16 *)(pbuf) |= cpu_to_le16(_PWRMGT_)
189 
190 #define GetPwrMgt(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_PWRMGT_)) != 0)
191 
192 #define ClearPwrMgt(pbuf)	\
193 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_PWRMGT_))
194 
195 #define SetMData(pbuf)	\
196 	*(__le16 *)(pbuf) |= cpu_to_le16(_MORE_DATA_)
197 
198 #define GetMData(pbuf)	(((*(__le16 *)(pbuf)) & cpu_to_le16(_MORE_DATA_)) != 0)
199 
200 #define ClearMData(pbuf)	\
201 	*(__le16 *)(pbuf) &= (~cpu_to_le16(_MORE_DATA_))
202 
203 #define SetPrivacy(pbuf)	\
204 	*(__le16 *)(pbuf) |= cpu_to_le16(_PRIVACY_)
205 
206 #define GetPrivacy(pbuf)					\
207 	(((*(__le16 *)(pbuf)) & cpu_to_le16(_PRIVACY_)) != 0)
208 
209 #define GetOrder(pbuf)					\
210 	(((*(__le16 *)(pbuf)) & cpu_to_le16(_ORDER_)) != 0)
211 
212 #define GetFrameType(pbuf)				\
213 	(le16_to_cpu(*(__le16 *)(pbuf)) & (BIT(3) | BIT(2)))
214 
215 #define GetFrameSubType(pbuf)	(le16_to_cpu(*(__le16 *)(pbuf)) & (BIT(7) |\
216 	 BIT(6) | BIT(5) | BIT(4) | BIT(3) | BIT(2)))
217 
218 #define SetFrameSubType(pbuf, type) \
219 	do {    \
220 		*(__le16 *)(pbuf) &= cpu_to_le16(~(BIT(7) | BIT(6) |	\
221 		 BIT(5) | BIT(4) | BIT(3) | BIT(2))); \
222 		*(__le16 *)(pbuf) |= cpu_to_le16(type); \
223 	} while (0)
224 
225 #define GetSequence(pbuf)			\
226 	(le16_to_cpu(*(__le16 *)((size_t)(pbuf) + 22)) >> 4)
227 
228 #define GetFragNum(pbuf)			\
229 	(le16_to_cpu(*(__le16 *)((size_t)(pbuf) + 22)) & 0x0f)
230 
231 #define SetSeqNum(pbuf, num) \
232 	do {    \
233 		*(__le16 *)((size_t)(pbuf) + 22) = \
234 			((*(__le16 *)((size_t)(pbuf) + 22)) & cpu_to_le16((unsigned short)0x000f)) | \
235 			cpu_to_le16((unsigned short)(0xfff0 & (num << 4))); \
236 	} while (0)
237 
238 #define SetDuration(pbuf, dur) \
239 	*(__le16 *)((size_t)(pbuf) + 2) = cpu_to_le16(0xffff & (dur))
240 
241 
242 #define SetPriority(pbuf, tid)	\
243 	*(__le16 *)(pbuf) |= cpu_to_le16(tid & 0xf)
244 
245 #define GetPriority(pbuf)	((le16_to_cpu(*(__le16 *)(pbuf))) & 0xf)
246 
247 #define SetEOSP(pbuf, eosp)	\
248 		*(__le16 *)(pbuf) |= cpu_to_le16((eosp & 1) << 4)
249 
250 #define SetAckpolicy(pbuf, ack)	\
251 	*(__le16 *)(pbuf) |= cpu_to_le16((ack & 3) << 5)
252 
253 #define GetAckpolicy(pbuf) (((le16_to_cpu(*(__le16 *)pbuf)) >> 5) & 0x3)
254 
255 #define GetAMsdu(pbuf) (((le16_to_cpu(*(__le16 *)pbuf)) >> 7) & 0x1)
256 
257 #define GetAid(pbuf)	(le16_to_cpu(*(__le16 *)((size_t)(pbuf) + 2)) & 0x3fff)
258 
259 #define GetAddr1Ptr(pbuf)	((unsigned char *)((size_t)(pbuf) + 4))
260 
261 #define GetAddr2Ptr(pbuf)	((unsigned char *)((size_t)(pbuf) + 10))
262 
263 #define GetAddr3Ptr(pbuf)	((unsigned char *)((size_t)(pbuf) + 16))
264 
265 #define GetAddr4Ptr(pbuf)	((unsigned char *)((size_t)(pbuf) + 24))
266 
267 #define MacAddr_isBcst(addr) \
268 	( \
269 	((addr[0] == 0xff) && (addr[1] == 0xff) && \
270 	(addr[2] == 0xff) && (addr[3] == 0xff) && \
271 	(addr[4] == 0xff) && (addr[5] == 0xff))  ? true : false \
272 )
273 
IS_MCAST(unsigned char * da)274 static inline int IS_MCAST(unsigned char *da)
275 {
276 	if ((*da) & 0x01)
277 		return true;
278 	else
279 		return false;
280 }
281 
get_da(unsigned char * pframe)282 static inline unsigned char *get_da(unsigned char *pframe)
283 {
284 	unsigned char	*da;
285 	unsigned int to_fr_ds = (GetToDs(pframe) << 1) | GetFrDs(pframe);
286 
287 	switch (to_fr_ds) {
288 	case 0x00:	/*  ToDs=0, FromDs=0 */
289 		da = GetAddr1Ptr(pframe);
290 		break;
291 	case 0x01:	/*  ToDs=0, FromDs=1 */
292 		da = GetAddr1Ptr(pframe);
293 		break;
294 	case 0x02:	/*  ToDs=1, FromDs=0 */
295 		da = GetAddr3Ptr(pframe);
296 		break;
297 	default:	/*  ToDs=1, FromDs=1 */
298 		da = GetAddr3Ptr(pframe);
299 		break;
300 	}
301 	return da;
302 }
303 
get_sa(unsigned char * pframe)304 static inline unsigned char *get_sa(unsigned char *pframe)
305 {
306 	unsigned char	*sa;
307 	unsigned int	to_fr_ds = (GetToDs(pframe) << 1) | GetFrDs(pframe);
308 
309 	switch (to_fr_ds) {
310 	case 0x00:	/*  ToDs=0, FromDs=0 */
311 		sa = GetAddr2Ptr(pframe);
312 		break;
313 	case 0x01:	/*  ToDs=0, FromDs=1 */
314 		sa = GetAddr3Ptr(pframe);
315 		break;
316 	case 0x02:	/*  ToDs=1, FromDs=0 */
317 		sa = GetAddr2Ptr(pframe);
318 		break;
319 	default:	/*  ToDs=1, FromDs=1 */
320 		sa = GetAddr4Ptr(pframe);
321 		break;
322 	}
323 	return sa;
324 }
325 
get_hdr_bssid(unsigned char * pframe)326 static inline unsigned char *get_hdr_bssid(unsigned char *pframe)
327 {
328 	unsigned char	*sa;
329 	unsigned int	to_fr_ds = (GetToDs(pframe) << 1) | GetFrDs(pframe);
330 
331 	switch (to_fr_ds) {
332 	case 0x00:	/*  ToDs=0, FromDs=0 */
333 		sa = GetAddr3Ptr(pframe);
334 		break;
335 	case 0x01:	/*  ToDs=0, FromDs=1 */
336 		sa = GetAddr2Ptr(pframe);
337 		break;
338 	case 0x02:	/*  ToDs=1, FromDs=0 */
339 		sa = GetAddr1Ptr(pframe);
340 		break;
341 	case 0x03:	/*  ToDs=1, FromDs=1 */
342 		sa = GetAddr1Ptr(pframe);
343 		break;
344 	default:
345 		sa = NULL; /*  */
346 		break;
347 	}
348 	return sa;
349 }
350 
IsFrameTypeCtrl(unsigned char * pframe)351 static inline int IsFrameTypeCtrl(unsigned char *pframe)
352 {
353 	if (WIFI_CTRL_TYPE == GetFrameType(pframe))
354 		return true;
355 	else
356 		return false;
357 }
358 /*-----------------------------------------------------------------------------
359 			Below is for the security related definition
360 ------------------------------------------------------------------------------*/
361 #define _RESERVED_FRAME_TYPE_		0
362 #define _SKB_FRAME_TYPE_		2
363 #define _PRE_ALLOCMEM_			1
364 #define _PRE_ALLOCHDR_			3
365 #define _PRE_ALLOCLLCHDR_		4
366 #define _PRE_ALLOCICVHDR_		5
367 #define _PRE_ALLOCMICHDR_		6
368 
369 #define _SIFSTIME_				\
370 	((priv->pmib->dot11BssType.net_work_type & WIRELESS_11A) ? 16 : 10)
371 #define _ACKCTSLNG_		14	/* 14 bytes long, including crclng */
372 #define _CRCLNG_		4
373 
374 #define _ASOCREQ_IE_OFFSET_	4	/*  excluding wlan_hdr */
375 #define	_ASOCRSP_IE_OFFSET_	6
376 #define _REASOCREQ_IE_OFFSET_	10
377 #define _REASOCRSP_IE_OFFSET_	6
378 #define _PROBEREQ_IE_OFFSET_	0
379 #define	_PROBERSP_IE_OFFSET_	12
380 #define _AUTH_IE_OFFSET_	6
381 #define _DEAUTH_IE_OFFSET_	0
382 #define _BEACON_IE_OFFSET_	12
383 #define _PUBLIC_ACTION_IE_OFFSET_	8
384 
385 #define _FIXED_IE_LENGTH_	_BEACON_IE_OFFSET_
386 
387 #define _SSID_IE_		0
388 #define _SUPPORTEDRATES_IE_	1
389 #define _DSSET_IE_		3
390 #define _TIM_IE_		5
391 #define _IBSS_PARA_IE_		6
392 #define _COUNTRY_IE_		7
393 #define _CHLGETXT_IE_		16
394 #define _SUPPORTED_CH_IE_	36
395 #define _CH_SWTICH_ANNOUNCE_	37	/* Secondary Channel Offset */
396 #define _RSN_IE_2_		48
397 #define _SSN_IE_1_		221
398 #define _ERPINFO_IE_		42
399 #define _EXT_SUPPORTEDRATES_IE_	50
400 
401 #define _HT_CAPABILITY_IE_	45
402 #define _FTIE_			55
403 #define _TIMEOUT_ITVL_IE_	56
404 #define _SRC_IE_		59
405 #define _HT_EXTRA_INFO_IE_	61
406 #define _HT_ADD_INFO_IE_	61 /* _HT_EXTRA_INFO_IE_ */
407 #define _WAPI_IE_		68
408 
409 
410 #define	EID_BSSCoexistence	72 /*  20/40 BSS Coexistence */
411 #define	EID_BSSIntolerantChlReport	73
412 #define _RIC_Descriptor_IE_	75
413 
414 #define _LINK_ID_IE_		101
415 #define _CH_SWITCH_TIMING_	104
416 #define _PTI_BUFFER_STATUS_	106
417 #define _EXT_CAP_IE_		127
418 #define _VENDOR_SPECIFIC_IE_	221
419 
420 #define	_RESERVED47_		47
421 
422 /* ---------------------------------------------------------------------------
423 					Below is the fixed elements...
424 -----------------------------------------------------------------------------*/
425 #define _AUTH_ALGM_NUM_		2
426 #define _AUTH_SEQ_NUM_		2
427 #define _BEACON_ITERVAL_	2
428 #define _CAPABILITY_		2
429 #define _CURRENT_APADDR_	6
430 #define _LISTEN_INTERVAL_	2
431 #define _RSON_CODE_		2
432 #define _ASOC_ID_		2
433 #define _STATUS_CODE_		2
434 #define _TIMESTAMP_		8
435 
436 #define AUTH_ODD_TO		0
437 #define AUTH_EVEN_TO		1
438 
439 #define WLAN_ETHCONV_ENCAP	1
440 #define WLAN_ETHCONV_RFC1042	2
441 #define WLAN_ETHCONV_8021h	3
442 
443 #define cap_ESS		BIT(0)
444 #define cap_IBSS	BIT(1)
445 #define cap_CFPollable	BIT(2)
446 #define cap_CFRequest	BIT(3)
447 #define cap_Privacy	BIT(4)
448 #define cap_ShortPremble BIT(5)
449 #define cap_PBCC	BIT(6)
450 #define cap_ChAgility	BIT(7)
451 #define cap_SpecMgmt	BIT(8)
452 #define cap_QoSi	BIT(9)
453 #define cap_ShortSlot	BIT(10)
454 
455 /*-----------------------------------------------------------------------------
456 				Below is the definition for 802.11i / 802.1x
457 ------------------------------------------------------------------------------*/
458 #define _IEEE8021X_MGT_			1	/*  WPA */
459 #define _IEEE8021X_PSK_			2	/*  WPA with pre-shared key */
460 
461 /*
462 #define _NO_PRIVACY_			0
463 #define _WEP_40_PRIVACY_		1
464 #define _TKIP_PRIVACY_			2
465 #define _WRAP_PRIVACY_			3
466 #define _CCMP_PRIVACY_			4
467 #define _WEP_104_PRIVACY_		5
468 #define _WEP_WPA_MIXED_PRIVACY_ 6	WEP + WPA
469 */
470 
471 /*-----------------------------------------------------------------------------
472 				Below is the definition for WMM
473 ------------------------------------------------------------------------------*/
474 #define _WMM_IE_Length_				7  /*  for WMM STA */
475 #define _WMM_Para_Element_Length_		24
476 
477 
478 /*-----------------------------------------------------------------------------
479 				Below is the definition for 802.11n
480 ------------------------------------------------------------------------------*/
481 
482 /* 802.11 BAR control masks */
483 #define IEEE80211_BAR_CTRL_ACK_POLICY_NORMAL     0x0000
484 #define IEEE80211_BAR_CTRL_CBMTID_COMPRESSED_BA  0x0004
485 
486 /**
487  * struct rtw_ieee80211_ht_cap - HT additional information
488  *
489  * This structure refers to "HT information element" as
490  * described in 802.11n draft section 7.3.2.53
491  */
492 struct ieee80211_ht_addt_info {
493 	unsigned char	control_chan;
494 	unsigned char	ht_param;
495 	unsigned short	operation_mode;
496 	unsigned short	stbc_param;
497 	unsigned char	basic_set[16];
498 } __packed;
499 
500 struct HT_info_element {
501 	unsigned char	primary_channel;
502 	unsigned char	infos[5];
503 	unsigned char	MCS_rate[16];
504 } __packed;
505 
506 struct AC_param {
507 	unsigned char		ACI_AIFSN;
508 	unsigned char		CW;
509 	__le16	TXOP_limit;
510 } __packed;
511 
512 struct WMM_para_element {
513 	unsigned char		QoS_info;
514 	unsigned char		reserved;
515 	struct AC_param	ac_param[4];
516 } __packed;
517 
518 struct ADDBA_request {
519 	unsigned char	dialog_token;
520 	__le16		BA_para_set;
521 	unsigned short	BA_timeout_value;
522 	unsigned short	BA_starting_seqctrl;
523 } __packed;
524 
525 enum ht_cap_ampdu_factor {
526 	MAX_AMPDU_FACTOR_8K	= 0,
527 	MAX_AMPDU_FACTOR_16K	= 1,
528 	MAX_AMPDU_FACTOR_32K	= 2,
529 	MAX_AMPDU_FACTOR_64K	= 3,
530 };
531 
532 /* 802.11n HT capabilities masks */
533 #define IEEE80211_HT_CAP_SUP_WIDTH		0x0002
534 #define IEEE80211_HT_CAP_SM_PS			0x000C
535 #define IEEE80211_HT_CAP_GRN_FLD		0x0010
536 #define IEEE80211_HT_CAP_SGI_20			0x0020
537 #define IEEE80211_HT_CAP_SGI_40			0x0040
538 #define IEEE80211_HT_CAP_TX_STBC		0x0080
539 #define IEEE80211_HT_CAP_RX_STBC		0x0300
540 #define IEEE80211_HT_CAP_DELAY_BA		0x0400
541 #define IEEE80211_HT_CAP_MAX_AMSDU		0x0800
542 #define IEEE80211_HT_CAP_DSSSCCK40		0x1000
543 /* 802.11n HT capability AMPDU settings */
544 #define IEEE80211_HT_CAP_AMPDU_FACTOR		0x03
545 #define IEEE80211_HT_CAP_AMPDU_DENSITY		0x1C
546 /* 802.11n HT capability MSC set */
547 #define IEEE80211_SUPP_MCS_SET_UEQM		4
548 #define IEEE80211_HT_CAP_MAX_STREAMS		4
549 #define IEEE80211_SUPP_MCS_SET_LEN		10
550 /* maximum streams the spec allows */
551 #define IEEE80211_HT_CAP_MCS_TX_DEFINED		0x01
552 #define IEEE80211_HT_CAP_MCS_TX_RX_DIFF		0x02
553 #define IEEE80211_HT_CAP_MCS_TX_STREAMS		0x0C
554 #define IEEE80211_HT_CAP_MCS_TX_UEQM		0x10
555 /* 802.11n HT IE masks */
556 #define IEEE80211_HT_IE_CHA_SEC_OFFSET		0x03
557 #define IEEE80211_HT_IE_CHA_SEC_NONE		0x00
558 #define IEEE80211_HT_IE_CHA_SEC_ABOVE		0x01
559 #define IEEE80211_HT_IE_CHA_SEC_BELOW		0x03
560 #define IEEE80211_HT_IE_CHA_WIDTH		0x04
561 #define IEEE80211_HT_IE_HT_PROTECTION		0x0003
562 #define IEEE80211_HT_IE_NON_GF_STA_PRSNT	0x0004
563 #define IEEE80211_HT_IE_NON_HT_STA_PRSNT	0x0010
564 
565 /* block-ack parameters */
566 #define IEEE80211_ADDBA_PARAM_POLICY_MASK 0x0002
567 #define IEEE80211_ADDBA_PARAM_TID_MASK 0x003C
568 #define RTW_IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK 0xFFC0
569 #define IEEE80211_DELBA_PARAM_TID_MASK 0xF000
570 #define IEEE80211_DELBA_PARAM_INITIATOR_MASK 0x0800
571 
572 /*
573  * A-PMDU buffer sizes
574  * According to IEEE802.11n spec size varies from 8K to 64K (in powers of 2)
575  */
576 #define IEEE80211_MIN_AMPDU_BUF 0x8
577 #define IEEE80211_MAX_AMPDU_BUF 0x40
578 
579 
580 #define OP_MODE_PURE                    0
581 #define OP_MODE_MAY_BE_LEGACY_STAS      1
582 #define OP_MODE_20MHZ_HT_STA_ASSOCED    2
583 #define OP_MODE_MIXED                   3
584 
585 #define HT_INFO_HT_PARAM_SECONDARY_CHNL_OFF_MASK	((u8)BIT(0) | BIT(1))
586 #define HT_INFO_HT_PARAM_SECONDARY_CHNL_ABOVE		((u8)BIT(0))
587 #define HT_INFO_HT_PARAM_SECONDARY_CHNL_BELOW		((u8)BIT(0) | BIT(1))
588 #define HT_INFO_HT_PARAM_REC_TRANS_CHNL_WIDTH		((u8)BIT(2))
589 #define HT_INFO_HT_PARAM_RIFS_MODE			((u8)BIT(3))
590 #define HT_INFO_HT_PARAM_CTRL_ACCESS_ONLY		((u8)BIT(4))
591 #define HT_INFO_HT_PARAM_SRV_INTERVAL_GRANULARITY	((u8)BIT(5))
592 
593 #define HT_INFO_OPERATION_MODE_OP_MODE_MASK	\
594 		((u16)(0x0001 | 0x0002))
595 #define HT_INFO_OPERATION_MODE_OP_MODE_OFFSET		0
596 #define HT_INFO_OPERATION_MODE_NON_GF_DEVS_PRESENT	((u8)BIT(2))
597 #define HT_INFO_OPERATION_MODE_TRANSMIT_BURST_LIMIT	((u8)BIT(3))
598 #define HT_INFO_OPERATION_MODE_NON_HT_STA_PRESENT	((u8)BIT(4))
599 
600 #define HT_INFO_STBC_PARAM_DUAL_BEACON		((u16)BIT(6))
601 #define HT_INFO_STBC_PARAM_DUAL_STBC_PROTECT	((u16)BIT(7))
602 #define HT_INFO_STBC_PARAM_SECONDARY_BC		((u16)BIT(8))
603 #define HT_INFO_STBC_PARAM_LSIG_TXOP_PROTECT_ALLOWED	((u16)BIT(9))
604 #define HT_INFO_STBC_PARAM_PCO_ACTIVE		((u16)BIT(10))
605 #define HT_INFO_STBC_PARAM_PCO_PHASE		((u16)BIT(11))
606 
607 /*	===============WPS Section=============== */
608 /*	For WPSv1.0 */
609 #define WPSOUI					0x0050f204
610 /*	WPS attribute ID */
611 #define WPS_ATTR_VER1				0x104A
612 #define WPS_ATTR_SIMPLE_CONF_STATE		0x1044
613 #define WPS_ATTR_RESP_TYPE			0x103B
614 #define WPS_ATTR_UUID_E				0x1047
615 #define WPS_ATTR_MANUFACTURER			0x1021
616 #define WPS_ATTR_MODEL_NAME			0x1023
617 #define WPS_ATTR_MODEL_NUMBER			0x1024
618 #define WPS_ATTR_SERIAL_NUMBER			0x1042
619 #define WPS_ATTR_PRIMARY_DEV_TYPE		0x1054
620 #define WPS_ATTR_SEC_DEV_TYPE_LIST		0x1055
621 #define WPS_ATTR_DEVICE_NAME			0x1011
622 #define WPS_ATTR_CONF_METHOD			0x1008
623 #define WPS_ATTR_RF_BANDS			0x103C
624 #define WPS_ATTR_DEVICE_PWID			0x1012
625 #define WPS_ATTR_REQUEST_TYPE			0x103A
626 #define WPS_ATTR_ASSOCIATION_STATE		0x1002
627 #define WPS_ATTR_CONFIG_ERROR			0x1009
628 #define WPS_ATTR_VENDOR_EXT			0x1049
629 #define WPS_ATTR_SELECTED_REGISTRAR		0x1041
630 
631 /*	Value of WPS Request Type Attribute */
632 #define WPS_REQ_TYPE_ENROLLEE_INFO_ONLY		0x00
633 #define WPS_REQ_TYPE_ENROLLEE_OPEN_8021X	0x01
634 #define WPS_REQ_TYPE_REGISTRAR			0x02
635 #define WPS_REQ_TYPE_WLAN_MANAGER_REGISTRAR	0x03
636 
637 /*	Value of WPS Response Type Attribute */
638 #define WPS_RESPONSE_TYPE_INFO_ONLY	0x00
639 #define WPS_RESPONSE_TYPE_8021X		0x01
640 #define WPS_RESPONSE_TYPE_REGISTRAR	0x02
641 #define WPS_RESPONSE_TYPE_AP		0x03
642 
643 /*	Value of WPS WiFi Simple Configuration State Attribute */
644 #define WPS_WSC_STATE_NOT_CONFIG	0x01
645 #define WPS_WSC_STATE_CONFIG		0x02
646 
647 /*	Value of WPS Version Attribute */
648 #define WPS_VERSION_1			0x10
649 
650 /*	Value of WPS Configuration Method Attribute */
651 #define WPS_CONFIG_METHOD_FLASH		0x0001
652 #define WPS_CONFIG_METHOD_ETHERNET	0x0002
653 #define WPS_CONFIG_METHOD_LABEL		0x0004
654 #define WPS_CONFIG_METHOD_DISPLAY	0x0008
655 #define WPS_CONFIG_METHOD_E_NFC		0x0010
656 #define WPS_CONFIG_METHOD_I_NFC		0x0020
657 #define WPS_CONFIG_METHOD_NFC		0x0040
658 #define WPS_CONFIG_METHOD_PBC		0x0080
659 #define WPS_CONFIG_METHOD_KEYPAD	0x0100
660 #define WPS_CONFIG_METHOD_VPBC		0x0280
661 #define WPS_CONFIG_METHOD_PPBC		0x0480
662 #define WPS_CONFIG_METHOD_VDISPLAY	0x2008
663 #define WPS_CONFIG_METHOD_PDISPLAY	0x4008
664 
665 /*	Value of Category ID of WPS Primary Device Type Attribute */
666 #define WPS_PDT_CID_DISPLAYS		0x0007
667 #define WPS_PDT_CID_MULIT_MEDIA		0x0008
668 #define WPS_PDT_CID_RTK_WIDI		WPS_PDT_CID_MULIT_MEDIA
669 
670 /*	Value of Sub Category ID of WPS Primary Device Type Attribute */
671 #define WPS_PDT_SCID_MEDIA_SERVER	0x0005
672 #define WPS_PDT_SCID_RTK_DMP		WPS_PDT_SCID_MEDIA_SERVER
673 
674 /*	Value of Device Password ID */
675 #define WPS_DPID_P			0x0000
676 #define WPS_DPID_USER_SPEC		0x0001
677 #define WPS_DPID_MACHINE_SPEC		0x0002
678 #define WPS_DPID_REKEY			0x0003
679 #define WPS_DPID_PBC			0x0004
680 #define WPS_DPID_REGISTRAR_SPEC		0x0005
681 
682 /*	Value of WPS RF Bands Attribute */
683 #define WPS_RF_BANDS_2_4_GHZ		0x01
684 #define WPS_RF_BANDS_5_GHZ		0x02
685 
686 /*	Value of WPS Association State Attribute */
687 #define WPS_ASSOC_STATE_NOT_ASSOCIATED		0x00
688 #define WPS_ASSOC_STATE_CONNECTION_SUCCESS	0x01
689 #define WPS_ASSOC_STATE_CONFIGURATION_FAILURE	0x02
690 #define WPS_ASSOC_STATE_ASSOCIATION_FAILURE	0x03
691 #define WPS_ASSOC_STATE_IP_FAILURE		0x04
692 
693 /*	=====================P2P Section===================== */
694 /*	For P2P */
695 #define	P2POUI					0x506F9A09
696 
697 /*	P2P Attribute ID */
698 #define	P2P_ATTR_STATUS				0x00
699 #define	P2P_ATTR_MINOR_REASON_CODE		0x01
700 #define	P2P_ATTR_CAPABILITY			0x02
701 #define	P2P_ATTR_DEVICE_ID			0x03
702 #define	P2P_ATTR_GO_INTENT			0x04
703 #define	P2P_ATTR_CONF_TIMEOUT			0x05
704 #define	P2P_ATTR_LISTEN_CH			0x06
705 #define	P2P_ATTR_GROUP_BSSID			0x07
706 #define	P2P_ATTR_EX_LISTEN_TIMING		0x08
707 #define	P2P_ATTR_INTENTED_IF_ADDR		0x09
708 #define	P2P_ATTR_MANAGEABILITY			0x0A
709 #define	P2P_ATTR_CH_LIST			0x0B
710 #define	P2P_ATTR_NOA				0x0C
711 #define	P2P_ATTR_DEVICE_INFO			0x0D
712 #define	P2P_ATTR_GROUP_INFO			0x0E
713 #define	P2P_ATTR_GROUP_ID			0x0F
714 #define	P2P_ATTR_INTERFACE			0x10
715 #define	P2P_ATTR_OPERATING_CH			0x11
716 #define	P2P_ATTR_INVITATION_FLAGS		0x12
717 
718 /*	Value of Status Attribute */
719 #define	P2P_STATUS_SUCCESS				0x00
720 #define	P2P_STATUS_FAIL_INFO_UNAVAILABLE		0x01
721 #define	P2P_STATUS_FAIL_INCOMPATIBLE_PARAM		0x02
722 #define	P2P_STATUS_FAIL_LIMIT_REACHED			0x03
723 #define	P2P_STATUS_FAIL_INVALID_PARAM			0x04
724 #define	P2P_STATUS_FAIL_REQUEST_UNABLE			0x05
725 #define	P2P_STATUS_FAIL_PREVOUS_PROTO_ERR		0x06
726 #define	P2P_STATUS_FAIL_NO_COMMON_CH			0x07
727 #define	P2P_STATUS_FAIL_UNKNOWN_P2PGROUP		0x08
728 #define	P2P_STATUS_FAIL_BOTH_GOINTENT_15		0x09
729 #define	P2P_STATUS_FAIL_INCOMPATIBLE_PROVSION		0x0A
730 #define	P2P_STATUS_FAIL_USER_REJECT			0x0B
731 
732 /*	Value of Invitation Flags Attribute */
733 
734 /*	Value of Device Capability Bitmap */
735 #define	P2P_DEVCAP_SERVICE_DISCOVERY		BIT(0)
736 #define	P2P_DEVCAP_CLIENT_DISCOVERABILITY	BIT(1)
737 #define	P2P_DEVCAP_CONCURRENT_OPERATION		BIT(2)
738 #define	P2P_DEVCAP_INFRA_MANAGED		BIT(3)
739 #define	P2P_DEVCAP_DEVICE_LIMIT			BIT(4)
740 #define	P2P_DEVCAP_INVITATION_PROC		BIT(5)
741 
742 /*	Value of Group Capability Bitmap */
743 #define	P2P_GRPCAP_GO				BIT(0)
744 #define	P2P_GRPCAP_PERSISTENT_GROUP		BIT(1)
745 #define	P2P_GRPCAP_GROUP_LIMIT			BIT(2)
746 #define	P2P_GRPCAP_INTRABSS			BIT(3)
747 #define	P2P_GRPCAP_CROSS_CONN			BIT(4)
748 #define	P2P_GRPCAP_PERSISTENT_RECONN		BIT(5)
749 #define	P2P_GRPCAP_GROUP_FORMATION		BIT(6)
750 
751 /*	P2P Public Action Frame (Management Frame) */
752 #define	P2P_PUB_ACTION_ACTION			0x09
753 
754 /*	P2P Public Action Frame Type */
755 #define	P2P_GO_NEGO_REQ				0
756 #define	P2P_GO_NEGO_RESP			1
757 #define	P2P_GO_NEGO_CONF			2
758 #define	P2P_INVIT_REQ				3
759 #define	P2P_INVIT_RESP				4
760 #define	P2P_DEVDISC_REQ				5
761 #define	P2P_DEVDISC_RESP			6
762 #define	P2P_PROVISION_DISC_REQ			7
763 #define	P2P_PROVISION_DISC_RESP			8
764 
765 /*	P2P Action Frame Type */
766 #define	P2P_NOTICE_OF_ABSENCE			0
767 #define	P2P_PRESENCE_REQUEST			1
768 #define	P2P_PRESENCE_RESPONSE			2
769 #define	P2P_GO_DISC_REQUEST			3
770 
771 #define	P2P_PROVISIONING_SCAN_CNT		3
772 
773 /* default value, used when: (1)p2p disabled or (2)p2p enabled
774  * but only do 1 scan phase */
775 #define	P2P_FINDPHASE_EX_NONE		0
776 /*  used when p2p enabled and want to do 1 scan phase and
777  *  P2P_FINDPHASE_EX_MAX-1 find phase */
778 #define	P2P_FINDPHASE_EX_FULL		1
779 #define	P2P_FINDPHASE_EX_SOCIAL_FIRST	(P2P_FINDPHASE_EX_FULL+1)
780 #define	P2P_FINDPHASE_EX_MAX		4
781 #define	P2P_FINDPHASE_EX_SOCIAL_LAST	P2P_FINDPHASE_EX_MAX
782 
783 /* 5 seconds timeout for sending the provision discovery request */
784 #define	P2P_PROVISION_TIMEOUT		5000
785 /* 3 seconds timeout for sending the prov disc request concurrent mode */
786 #define	P2P_CONCURRENT_PROVISION_TIME	3000
787 /* 5 seconds timeout for receiving the group negotiation response */
788 #define	P2P_GO_NEGO_TIMEOUT		5000
789 /* 3 seconds timeout for sending the negotiation request under concurrent mode */
790 #define	P2P_CONCURRENT_GO_NEGO_TIME	3000
791 /* 100ms */
792 #define	P2P_TX_PRESCAN_TIMEOUT		100
793 /* 5 seconds timeout for sending the invitation request */
794 #define	P2P_INVITE_TIMEOUT		5000
795 /* 3 seconds timeout for sending the invitation request under concurrent mode */
796 #define	P2P_CONCURRENT_INVITE_TIME	3000
797 /* 25 seconds timeout to reset the scan channel (based on channel plan) */
798 #define	P2P_RESET_SCAN_CH		25000
799 #define	P2P_MAX_INTENT			15
800 
801 /*	WPS Configuration Method */
802 #define	WPS_CM_NONE			0x0000
803 #define	WPS_CM_LABEL			0x0004
804 #define	WPS_CM_DISPLYA			0x0008
805 #define	WPS_CM_EXTERNAL_NFC_TOKEN	0x0010
806 #define	WPS_CM_INTEGRATED_NFC_TOKEN	0x0020
807 #define	WPS_CM_NFC_INTERFACE		0x0040
808 #define	WPS_CM_PUSH_BUTTON		0x0080
809 #define	WPS_CM_KEYPAD			0x0100
810 #define	WPS_CM_SW_PUHS_BUTTON		0x0280
811 #define	WPS_CM_HW_PUHS_BUTTON		0x0480
812 #define	WPS_CM_SW_DISPLAY_P		0x2008
813 #define	WPS_CM_LCD_DISPLAY_P		0x4008
814 
815 #define	P2P_PRIVATE_IOCTL_SET_LEN		64
816 
817 enum P2P_PROTO_WK_ID {
818 	P2P_FIND_PHASE_WK = 0,
819 	P2P_RESTORE_STATE_WK = 1,
820 	P2P_PRE_TX_PROVDISC_PROCESS_WK = 2,
821 	P2P_PRE_TX_NEGOREQ_PROCESS_WK = 3,
822 	P2P_PRE_TX_INVITEREQ_PROCESS_WK = 4,
823 	P2P_AP_P2P_CH_SWITCH_PROCESS_WK = 5,
824 	P2P_RO_CH_WK = 6,
825 };
826 
827 /*	=====================WFD Section===================== */
828 /*	For Wi-Fi Display */
829 #define	WFD_ATTR_DEVICE_INFO		0x00
830 #define	WFD_ATTR_ASSOC_BSSID		0x01
831 #define	WFD_ATTR_COUPLED_SINK_INFO	0x06
832 #define	WFD_ATTR_LOCAL_IP_ADDR		0x08
833 #define	WFD_ATTR_SESSION_INFO		0x09
834 #define	WFD_ATTR_ALTER_MAC		0x0a
835 
836 /*	For WFD Device Information Attribute */
837 #define	WFD_DEVINFO_SOURCE			0x0000
838 #define	WFD_DEVINFO_PSINK			0x0001
839 #define	WFD_DEVINFO_SSINK			0x0002
840 #define	WFD_DEVINFO_DUAL			0x0003
841 
842 #define	WFD_DEVINFO_SESSION_AVAIL		0x0010
843 #define	WFD_DEVINFO_WSD				0x0040
844 #define	WFD_DEVINFO_PC_TDLS			0x0080
845 #define	WFD_DEVINFO_HDCP_SUPPORT		0x0100
846 
847 #define IP_MCAST_MAC(mac)				\
848 	((mac[0] == 0x01) && (mac[1] == 0x00) && (mac[2] == 0x5e))
849 #define ICMPV6_MCAST_MAC(mac)				\
850 	((mac[0] == 0x33) && (mac[1] == 0x33) && (mac[2] != 0xff))
851 
852 #endif /*  _WIFI_H_ */
853