drivers/staging/rtl8188eu/include/wifi.h

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