1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
4 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
6 * Modifications for inclusion into the Linux staging tree are
7 * Copyright(c) 2010 Larry Finger. All rights reserved.
10 * WLAN FAE <wlanfae@realtek.com>
11 * Larry Finger <Larry.Finger@lwfinger.net>
13 ******************************************************************************/
17 #include <linux/compiler.h>
19 #define WLAN_IEEE_OUI_LEN 3
20 #define WLAN_CRC_LEN 4
21 #define WLAN_BSSID_LEN 6
22 #define WLAN_BSS_TS_LEN 8
23 #define WLAN_HDR_A3_LEN 24
24 #define WLAN_HDR_A4_LEN 30
25 #define WLAN_HDR_A3_QOS_LEN 26
26 #define WLAN_HDR_A4_QOS_LEN 32
27 #define WLAN_SSID_MAXLEN 32
28 #define WLAN_DATA_MAXLEN 2312
30 #define WLAN_A3_PN_OFFSET 24
31 #define WLAN_A4_PN_OFFSET 30
33 #define WLAN_MIN_ETHFRM_LEN 60
34 #define WLAN_MAX_ETHFRM_LEN 1514
36 #define P80211CAPTURE_VERSION 0x80211001
38 enum WIFI_FRAME_TYPE
{
40 WIFI_CTRL_TYPE
= (BIT(2)),
41 WIFI_DATA_TYPE
= (BIT(3)),
42 WIFI_QOS_DATA_TYPE
= (BIT(7)|BIT(3)), /*!< QoS Data */
45 enum WIFI_FRAME_SUBTYPE
{
46 /* below is for mgt frame */
47 WIFI_ASSOCREQ
= (0 | WIFI_MGT_TYPE
),
48 WIFI_ASSOCRSP
= (BIT(4) | WIFI_MGT_TYPE
),
49 WIFI_REASSOCREQ
= (BIT(5) | WIFI_MGT_TYPE
),
50 WIFI_REASSOCRSP
= (BIT(5) | BIT(4) | WIFI_MGT_TYPE
),
51 WIFI_PROBEREQ
= (BIT(6) | WIFI_MGT_TYPE
),
52 WIFI_PROBERSP
= (BIT(6) | BIT(4) | WIFI_MGT_TYPE
),
53 WIFI_BEACON
= (BIT(7) | WIFI_MGT_TYPE
),
54 WIFI_ATIM
= (BIT(7) | BIT(4) | WIFI_MGT_TYPE
),
55 WIFI_DISASSOC
= (BIT(7) | BIT(5) | WIFI_MGT_TYPE
),
56 WIFI_AUTH
= (BIT(7) | BIT(5) | BIT(4) | WIFI_MGT_TYPE
),
57 WIFI_DEAUTH
= (BIT(7) | BIT(6) | WIFI_MGT_TYPE
),
58 WIFI_ACTION
= (BIT(7) | BIT(6) | BIT(4) | WIFI_MGT_TYPE
),
59 /* below is for control frame */
60 WIFI_PSPOLL
= (BIT(7) | BIT(5) | WIFI_CTRL_TYPE
),
61 WIFI_RTS
= (BIT(7) | BIT(5) | BIT(4) | WIFI_CTRL_TYPE
),
62 WIFI_CTS
= (BIT(7) | BIT(6) | WIFI_CTRL_TYPE
),
63 WIFI_ACK
= (BIT(7) | BIT(6) | BIT(4) | WIFI_CTRL_TYPE
),
64 WIFI_CFEND
= (BIT(7) | BIT(6) | BIT(5) | WIFI_CTRL_TYPE
),
65 WIFI_CFEND_CFACK
= (BIT(7) | BIT(6) | BIT(5) | BIT(4) | WIFI_CTRL_TYPE
),
66 /* below is for data frame */
67 WIFI_DATA
= (0 | WIFI_DATA_TYPE
),
68 WIFI_DATA_CFACK
= (BIT(4) | WIFI_DATA_TYPE
),
69 WIFI_DATA_CFPOLL
= (BIT(5) | WIFI_DATA_TYPE
),
70 WIFI_DATA_CFACKPOLL
= (BIT(5) | BIT(4) | WIFI_DATA_TYPE
),
71 WIFI_DATA_NULL
= (BIT(6) | WIFI_DATA_TYPE
),
72 WIFI_CF_ACK
= (BIT(6) | BIT(4) | WIFI_DATA_TYPE
),
73 WIFI_CF_POLL
= (BIT(6) | BIT(5) | WIFI_DATA_TYPE
),
74 WIFI_CF_ACKPOLL
= (BIT(6) | BIT(5) | BIT(4) | WIFI_DATA_TYPE
),
77 enum WIFI_REASON_CODE
{
79 _RSON_UNSPECIFIED_
= 1,
80 _RSON_AUTH_NO_LONGER_VALID_
= 2,
81 _RSON_DEAUTH_STA_LEAVING_
= 3,
82 _RSON_INACTIVITY_
= 4,
83 _RSON_UNABLE_HANDLE_
= 5,
86 _RSON_DISAOC_STA_LEAVING_
= 8,
87 _RSON_ASOC_NOT_AUTH_
= 9,
89 _RSON_INVALID_IE_
= 13,
90 _RSON_MIC_FAILURE_
= 14,
91 _RSON_4WAY_HNDSHK_TIMEOUT_
= 15,
92 _RSON_GROUP_KEY_UPDATE_TIMEOUT_
= 16,
94 _RSON_MLTCST_CIPHER_NOT_VALID_
= 18,
95 _RSON_UNICST_CIPHER_NOT_VALID_
= 19,
96 _RSON_AKMP_NOT_VALID_
= 20,
97 _RSON_UNSUPPORT_RSNE_VER_
= 21,
98 _RSON_INVALID_RSNE_CAP_
= 22,
99 _RSON_IEEE_802DOT1X_AUTH_FAIL_
= 23,
100 /* below are Realtek definitions */
101 _RSON_PMK_NOT_AVAILABLE_
= 24,
104 enum WIFI_STATUS_CODE
{
105 _STATS_SUCCESSFUL_
= 0,
107 _STATS_CAP_FAIL_
= 10,
108 _STATS_NO_ASOC_
= 11,
110 _STATS_NO_SUPP_ALG_
= 13,
111 _STATS_OUT_OF_AUTH_SEQ_
= 14,
112 _STATS_CHALLENGE_FAIL_
= 15,
113 _STATS_AUTH_TIMEOUT_
= 16,
114 _STATS_UNABLE_HANDLE_STA_
= 17,
115 _STATS_RATE_FAIL_
= 18,
118 enum WIFI_REG_DOMAIN
{
132 #define _TO_DS_ BIT(8)
133 #define _FROM_DS_ BIT(9)
134 #define _MORE_FRAG_ BIT(10)
135 #define _RETRY_ BIT(11)
136 #define _PWRMGT_ BIT(12)
137 #define _MORE_DATA_ BIT(13)
138 #define _PRIVACY_ BIT(14)
139 #define _ORDER_ BIT(15)
141 #define SetToDs(pbuf) ({ \
142 *(__le16 *)(pbuf) |= cpu_to_le16(_TO_DS_); \
145 #define GetToDs(pbuf) (((*(__le16 *)(pbuf)) & cpu_to_le16(_TO_DS_)) != 0)
147 #define ClearToDs(pbuf) ({ \
148 *(__le16 *)(pbuf) &= (~cpu_to_le16(_TO_DS_)); \
151 #define SetFrDs(pbuf) ({ \
152 *(__le16 *)(pbuf) |= cpu_to_le16(_FROM_DS_); \
155 #define GetFrDs(pbuf) (((*(__le16 *)(pbuf)) & cpu_to_le16(_FROM_DS_)) != 0)
157 #define ClearFrDs(pbuf) ({ \
158 *(__le16 *)(pbuf) &= (~cpu_to_le16(_FROM_DS_)); \
161 static inline unsigned char get_tofr_ds(unsigned char *pframe
)
163 return ((GetToDs(pframe
) << 1) | GetFrDs(pframe
));
166 #define SetMFrag(pbuf) ({ \
167 *(__le16 *)(pbuf) |= cpu_to_le16(_MORE_FRAG_); \
170 #define GetMFrag(pbuf) (((*(__le16 *)(pbuf)) & cpu_to_le16(_MORE_FRAG_)) != 0)
172 #define ClearMFrag(pbuf) ({ \
173 *(__le16 *)(pbuf) &= (~cpu_to_le16(_MORE_FRAG_)); \
176 #define SetRetry(pbuf) ({ \
177 *(__le16 *)(pbuf) |= cpu_to_le16(_RETRY_); \
180 #define GetRetry(pbuf) (((*(__le16 *)(pbuf)) & cpu_to_le16(_RETRY_)) != 0)
182 #define ClearRetry(pbuf) ({ \
183 *(__le16 *)(pbuf) &= (~cpu_to_le16(_RETRY_)); \
186 #define SetPwrMgt(pbuf) ({ \
187 *(__le16 *)(pbuf) |= cpu_to_le16(_PWRMGT_); \
190 #define GetPwrMgt(pbuf) (((*(__le16 *)(pbuf)) & \
191 cpu_to_le16(_PWRMGT_)) != 0)
193 #define ClearPwrMgt(pbuf) ({ \
194 *(__le16 *)(pbuf) &= (~cpu_to_le16(_PWRMGT_)); \
197 #define SetMData(pbuf) ({ \
198 *(__le16 *)(pbuf) |= cpu_to_le16(_MORE_DATA_); \
201 #define GetMData(pbuf) (((*(__le16 *)(pbuf)) & \
202 cpu_to_le16(_MORE_DATA_)) != 0)
204 #define ClearMData(pbuf) ({ \
205 *(__le16 *)(pbuf) &= (~cpu_to_le16(_MORE_DATA_)); \
208 #define SetPrivacy(pbuf) ({ \
209 *(__le16 *)(pbuf) |= cpu_to_le16(_PRIVACY_); \
212 #define GetPrivacy(pbuf) (((*(__le16 *)(pbuf)) & \
213 cpu_to_le16(_PRIVACY_)) != 0)
215 #define GetOrder(pbuf) (((*(__le16 *)(pbuf)) & \
216 cpu_to_le16(_ORDER_)) != 0)
218 #define GetFrameType(pbuf) (le16_to_cpu(*(__le16 *)(pbuf)) & \
221 #define SetFrameType(pbuf, type) \
223 *(__le16 *)(pbuf) &= cpu_to_le16(~(BIT(3) | \
225 *(__le16 *)(pbuf) |= cpu_to_le16(type); \
228 #define GetFrameSubType(pbuf) (le16_to_cpu(*(__le16 *)(pbuf)) & \
229 (BIT(7) | BIT(6) | BIT(5) | BIT(4) | BIT(3) | \
232 #define SetFrameSubType(pbuf, type) \
234 *(__le16 *)(pbuf) &= cpu_to_le16(~(BIT(7) | BIT(6) | \
235 BIT(5) | BIT(4) | BIT(3) | BIT(2))); \
236 *(__le16 *)(pbuf) |= cpu_to_le16(type); \
239 #define GetSequence(pbuf) (le16_to_cpu(*(__le16 *)\
240 ((addr_t)(pbuf) + 22)) >> 4)
242 #define GetFragNum(pbuf) (le16_to_cpu(*(__le16 *)((addr_t)\
243 (pbuf) + 22)) & 0x0f)
245 #define SetSeqNum(pbuf, num) ({ \
246 *(__le16 *)((addr_t)(pbuf) + 22) = \
247 cpu_to_le16((le16_to_cpu(*(__le16 *)((addr_t)(pbuf) + 22)) & \
248 0x000f) | (0xfff0 & (num << 4))); \
251 #define SetDuration(pbuf, dur) ({ \
252 *(__le16 *)((addr_t)(pbuf) + 2) |= \
253 cpu_to_le16(0xffff & (dur)); \
256 #define SetPriority(pbuf, tid) ({ \
257 *(__le16 *)(pbuf) |= cpu_to_le16(tid & 0xf); \
260 #define GetPriority(pbuf) ((le16_to_cpu(*(__le16 *)(pbuf))) & 0xf)
262 #define SetAckpolicy(pbuf, ack) ({ \
263 *(__le16 *)(pbuf) |= cpu_to_le16((ack & 3) << 5); \
266 #define GetAckpolicy(pbuf) (((le16_to_cpu(*(__le16 *)pbuf)) >> 5) & 0x3)
268 #define GetAMsdu(pbuf) (((le16_to_cpu(*(__le16 *)pbuf)) >> 7) & 0x1)
270 #define GetAid(pbuf) (cpu_to_le16(*(__le16 *)((addr_t)(pbuf) + 2)) \
273 #define GetAddr1Ptr(pbuf) ((unsigned char *)((addr_t)(pbuf) + 4))
275 #define GetAddr2Ptr(pbuf) ((unsigned char *)((addr_t)(pbuf) + 10))
277 #define GetAddr3Ptr(pbuf) ((unsigned char *)((addr_t)(pbuf) + 16))
279 #define GetAddr4Ptr(pbuf) ((unsigned char *)((addr_t)(pbuf) + 24))
281 static inline unsigned char *get_da(unsigned char *pframe
)
284 unsigned int to_fr_ds
= (GetToDs(pframe
) << 1) | GetFrDs(pframe
);
287 case 0x00: /* ToDs=0, FromDs=0 */
288 da
= GetAddr1Ptr(pframe
);
290 case 0x01: /* ToDs=0, FromDs=1 */
291 da
= GetAddr1Ptr(pframe
);
293 case 0x02: /* ToDs=1, FromDs=0 */
294 da
= GetAddr3Ptr(pframe
);
296 default: /* ToDs=1, FromDs=1 */
297 da
= GetAddr3Ptr(pframe
);
303 static inline unsigned char *get_sa(unsigned char *pframe
)
306 unsigned int to_fr_ds
= (GetToDs(pframe
) << 1) | GetFrDs(pframe
);
309 case 0x00: /* ToDs=0, FromDs=0 */
310 sa
= GetAddr2Ptr(pframe
);
312 case 0x01: /* ToDs=0, FromDs=1 */
313 sa
= GetAddr3Ptr(pframe
);
315 case 0x02: /* ToDs=1, FromDs=0 */
316 sa
= GetAddr2Ptr(pframe
);
318 default: /* ToDs=1, FromDs=1 */
319 sa
= GetAddr4Ptr(pframe
);
326 static inline unsigned char *get_hdr_bssid(unsigned char *pframe
)
329 unsigned int to_fr_ds
= (GetToDs(pframe
) << 1) | GetFrDs(pframe
);
332 case 0x00: /* ToDs=0, FromDs=0 */
333 sa
= GetAddr3Ptr(pframe
);
335 case 0x01: /* ToDs=0, FromDs=1 */
336 sa
= GetAddr2Ptr(pframe
);
338 case 0x02: /* ToDs=1, FromDs=0 */
339 sa
= GetAddr1Ptr(pframe
);
341 default: /* ToDs=1, FromDs=1 */
348 /*-----------------------------------------------------------------------------
349 * Below is for the security related definition
350 *-----------------------------------------------------------------------------
352 #define _RESERVED_FRAME_TYPE_ 0
353 #define _SKB_FRAME_TYPE_ 2
354 #define _PRE_ALLOCMEM_ 1
355 #define _PRE_ALLOCHDR_ 3
356 #define _PRE_ALLOCLLCHDR_ 4
357 #define _PRE_ALLOCICVHDR_ 5
358 #define _PRE_ALLOCMICHDR_ 6
360 #define _SIFSTIME_ ((priv->pmib->BssType.net_work_type & \
361 WIRELESS_11A) ? 16 : 10)
362 #define _ACKCTSLNG_ 14 /*14 bytes long, including crclng */
365 #define _ASOCREQ_IE_OFFSET_ 4 /* excluding wlan_hdr */
366 #define _ASOCRSP_IE_OFFSET_ 6
367 #define _REASOCREQ_IE_OFFSET_ 10
368 #define _REASOCRSP_IE_OFFSET_ 6
369 #define _PROBEREQ_IE_OFFSET_ 0
370 #define _PROBERSP_IE_OFFSET_ 12
371 #define _AUTH_IE_OFFSET_ 6
372 #define _DEAUTH_IE_OFFSET_ 0
373 #define _BEACON_IE_OFFSET_ 12
375 #define _FIXED_IE_LENGTH_ _BEACON_IE_OFFSET_
378 #define _SUPPORTEDRATES_IE_ 1
380 #define _IBSS_PARA_IE_ 6
381 #define _ERPINFO_IE_ 42
382 #define _EXT_SUPPORTEDRATES_IE_ 50
384 #define _HT_CAPABILITY_IE_ 45
385 #define _HT_EXTRA_INFO_IE_ 61
386 #define _HT_ADD_INFO_IE_ 61 /* _HT_EXTRA_INFO_IE_ */
388 #define _VENDOR_SPECIFIC_IE_ 221
390 #define _RESERVED47_ 47
392 /* ---------------------------------------------------------------------------
393 * Below is the fixed elements...
394 * ---------------------------------------------------------------------------
396 #define _AUTH_ALGM_NUM_ 2
397 #define _AUTH_SEQ_NUM_ 2
398 #define _BEACON_ITERVAL_ 2
399 #define _CAPABILITY_ 2
400 #define _CURRENT_APADDR_ 6
401 #define _LISTEN_INTERVAL_ 2
402 #define _RSON_CODE_ 2
404 #define _STATUS_CODE_ 2
405 #define _TIMESTAMP_ 8
407 #define AUTH_ODD_TO 0
408 #define AUTH_EVEN_TO 1
410 #define WLAN_ETHCONV_ENCAP 1
411 #define WLAN_ETHCONV_RFC1042 2
412 #define WLAN_ETHCONV_8021h 3
414 #define cap_ESS BIT(0)
415 #define cap_IBSS BIT(1)
416 #define cap_CFPollable BIT(2)
417 #define cap_CFRequest BIT(3)
418 #define cap_Privacy BIT(4)
419 #define cap_ShortPremble BIT(5)
421 /*-----------------------------------------------------------------------------
422 * Below is the definition for 802.11i / 802.1x
423 *------------------------------------------------------------------------------
425 #define _IEEE8021X_MGT_ 1 /*WPA */
426 #define _IEEE8021X_PSK_ 2 /* WPA with pre-shared key */
428 /*-----------------------------------------------------------------------------
429 * Below is the definition for WMM
430 *------------------------------------------------------------------------------
432 #define _WMM_IE_Length_ 7 /* for WMM STA */
433 #define _WMM_Para_Element_Length_ 24
435 /*-----------------------------------------------------------------------------
436 * Below is the definition for 802.11n
437 *------------------------------------------------------------------------------
440 /* block-ack parameters */
441 #define IEEE80211_ADDBA_PARAM_POLICY_MASK 0x0002
442 #define IEEE80211_ADDBA_PARAM_TID_MASK 0x003C
443 #define IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK 0xFFA0
444 #define IEEE80211_DELBA_PARAM_TID_MASK 0xF000
445 #define IEEE80211_DELBA_PARAM_INITIATOR_MASK 0x0800
447 #define SetOrderBit(pbuf) ({ \
448 *(__le16 *)(pbuf) |= cpu_to_le16(_ORDER_); \
451 #define GetOrderBit(pbuf) (((*(__le16 *)(pbuf)) & \
452 le16_to_cpu(_ORDER_)) != 0)
455 * struct ieee80211_bar - HT Block Ack Request
457 * This structure refers to "HT BlockAckReq" as
458 * described in 802.11n draft section 7.2.1.7.1
460 struct ieee80211_bar
{
461 __le16 frame_control
;
466 __le16 start_seq_num
;
469 /* 802.11 BAR control masks */
470 #define IEEE80211_BAR_CTRL_ACK_POLICY_NORMAL 0x0000
471 #define IEEE80211_BAR_CTRL_CBMTID_COMPRESSED_BA 0x0004
474 * struct ieee80211_ht_cap - HT capabilities
476 * This structure refers to "HT capabilities element" as
477 * described in 802.11n draft section 7.3.2.52
480 struct ieee80211_ht_cap
{
482 unsigned char ampdu_params_info
;
483 unsigned char supp_mcs_set
[16];
484 __le16 extended_ht_cap_info
;
485 __le32 tx_BF_cap_info
;
486 unsigned char antenna_selection_info
;
490 * struct ieee80211_ht_cap - HT additional information
492 * This structure refers to "HT information element" as
493 * described in 802.11n draft section 7.3.2.53
495 struct ieee80211_ht_addt_info
{
496 unsigned char control_chan
;
497 unsigned char ht_param
;
498 __le16 operation_mode
;
500 unsigned char basic_set
[16];
503 /* 802.11n HT capabilities masks */
504 #define IEEE80211_HT_CAP_SUP_WIDTH 0x0002
505 #define IEEE80211_HT_CAP_SM_PS 0x000C
506 #define IEEE80211_HT_CAP_GRN_FLD 0x0010
507 #define IEEE80211_HT_CAP_SGI_20 0x0020
508 #define IEEE80211_HT_CAP_SGI_40 0x0040
509 #define IEEE80211_HT_CAP_TX_STBC 0x0080
510 #define IEEE80211_HT_CAP_DELAY_BA 0x0400
511 #define IEEE80211_HT_CAP_MAX_AMSDU 0x0800
512 #define IEEE80211_HT_CAP_DSSSCCK40 0x1000
513 /* 802.11n HT capability AMPDU settings */
514 #define IEEE80211_HT_CAP_AMPDU_FACTOR 0x03
515 #define IEEE80211_HT_CAP_AMPDU_DENSITY 0x1C
516 /* 802.11n HT capability MSC set */
517 #define IEEE80211_SUPP_MCS_SET_UEQM 4
518 #define IEEE80211_HT_CAP_MAX_STREAMS 4
519 #define IEEE80211_SUPP_MCS_SET_LEN 10
520 /* maximum streams the spec allows */
521 #define IEEE80211_HT_CAP_MCS_TX_DEFINED 0x01
522 #define IEEE80211_HT_CAP_MCS_TX_RX_DIFF 0x02
523 #define IEEE80211_HT_CAP_MCS_TX_STREAMS 0x0C
524 #define IEEE80211_HT_CAP_MCS_TX_UEQM 0x10
525 /* 802.11n HT IE masks */
526 #define IEEE80211_HT_IE_CHA_SEC_OFFSET 0x03
527 #define IEEE80211_HT_IE_CHA_SEC_NONE 0x00
528 #define IEEE80211_HT_IE_CHA_SEC_ABOVE 0x01
529 #define IEEE80211_HT_IE_CHA_SEC_BELOW 0x03
530 #define IEEE80211_HT_IE_CHA_WIDTH 0x04
531 #define IEEE80211_HT_IE_HT_PROTECTION 0x0003
532 #define IEEE80211_HT_IE_NON_GF_STA_PRSNT 0x0004
533 #define IEEE80211_HT_IE_NON_HT_STA_PRSNT 0x0010
535 /* block-ack parameters */
536 #define IEEE80211_ADDBA_PARAM_POLICY_MASK 0x0002
537 #define IEEE80211_ADDBA_PARAM_TID_MASK 0x003C
538 #define IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK 0xFFA0
539 #define IEEE80211_DELBA_PARAM_TID_MASK 0xF000
540 #define IEEE80211_DELBA_PARAM_INITIATOR_MASK 0x0800
543 * A-PMDU buffer sizes
544 * According to IEEE802.11n spec size varies from 8K to 64K (in powers of 2)
546 #define IEEE80211_MIN_AMPDU_BUF 0x8
548 /* Spatial Multiplexing Power Save Modes */
549 #define WLAN_HT_CAP_SM_PS_STATIC 0
550 #define WLAN_HT_CAP_SM_PS_DYNAMIC 1
551 #define WLAN_HT_CAP_SM_PS_INVALID 2
552 #define WLAN_HT_CAP_SM_PS_DISABLED 3
554 #endif /* _WIFI_H_ */