drivers/staging/rtl8188eu/include/ieee80211.h

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