LXR linux/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: */
  34enum {
  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
 119extern u8 RTW_WPA_OUI_TYPE[];
 120extern u8 WPA_AUTH_KEY_MGMT_NONE[];
 121extern u8 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X[];
 122extern u8 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
 123extern u8 WPA_CIPHER_SUITE_NONE[];
 124extern u8 WPA_CIPHER_SUITE_WEP40[];
 125extern u8 WPA_CIPHER_SUITE_TKIP[];
 126extern u8 WPA_CIPHER_SUITE_WRAP[];
 127extern u8 WPA_CIPHER_SUITE_CCMP[];
 128extern u8 WPA_CIPHER_SUITE_WEP104[];
 129
 130
 131#define RSN_HEADER_LEN 4
 132#define RSN_SELECTOR_LEN 4
 133
 134extern u16 RSN_VERSION_BSD;
 135extern u8 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X[];
 136extern u8 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X[];
 137extern u8 RSN_CIPHER_SUITE_NONE[];
 138extern u8 RSN_CIPHER_SUITE_WEP40[];
 139extern u8 RSN_CIPHER_SUITE_TKIP[];
 140extern u8 RSN_CIPHER_SUITE_WRAP[];
 141extern u8 RSN_CIPHER_SUITE_CCMP[];
 142extern u8 RSN_CIPHER_SUITE_WEP104[];
 143
 144enum 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
 156enum 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
 210struct 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
 254struct ieee_param_ex {
 255        u32 cmd;
 256        u8 sta_addr[ETH_ALEN];
 257        u8 data[0];
 258};
 259
 260struct 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
 288#define IEEE80211_HLEN                  30
 289#define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
 290
 291
 292/* this is stolen from ipw2200 driver */
 293#define IEEE_IBSS_MAC_HASH_SIZE 31
 294
 295enum eap_type {
 296        EAP_PACKET = 0,
 297        EAPOL_START,
 298        EAPOL_LOGOFF,
 299        EAPOL_KEY,
 300        EAPOL_ENCAP_ASF_ALERT
 301};
 302
 303#define IEEE80211_3ADDR_LEN 24
 304#define IEEE80211_4ADDR_LEN 30
 305#define IEEE80211_FCS_LEN    4
 306
 307#define MIN_FRAG_THRESHOLD     256U
 308#define MAX_FRAG_THRESHOLD     2346U
 309
 310/* sequence control field */
 311#define RTW_IEEE80211_SCTL_FRAG 0x000F
 312#define RTW_IEEE80211_SCTL_SEQ  0xFFF0
 313
 314
 315#define RTW_ERP_INFO_NON_ERP_PRESENT BIT(0)
 316#define RTW_ERP_INFO_USE_PROTECTION BIT(1)
 317#define RTW_ERP_INFO_BARKER_PREAMBLE_MODE BIT(2)
 318
 319/* QoS, QOS */
 320#define NORMAL_ACK                      0
 321#define NO_ACK                          1
 322#define NON_EXPLICIT_ACK                2
 323#define BLOCK_ACK                       3
 324
 325#ifndef ETH_P_PAE
 326#define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
 327#endif /* ETH_P_PAE */
 328
 329#define ETH_P_PREAUTH 0x88C7 /* IEEE 802.11i pre-authentication */
 330
 331#define ETH_P_ECONET    0x0018
 332
 333#ifndef ETH_P_80211_RAW
 334#define ETH_P_80211_RAW (ETH_P_ECONET + 1)
 335#endif
 336
 337/* IEEE 802.11 defines */
 338
 339#define P80211_OUI_LEN 3
 340
 341struct ieee80211_snap_hdr {
 342        u8    dsap;   /* always 0xAA */
 343        u8    ssap;   /* always 0xAA */
 344        u8    ctrl;   /* always 0x03 */
 345        u8    oui[P80211_OUI_LEN];    /* organizational universal id */
 346} __packed;
 347
 348#define SNAP_SIZE sizeof(struct ieee80211_snap_hdr)
 349
 350#define WLAN_QC_GET_TID(qc) ((qc) & 0x0f)
 351
 352#define WLAN_GET_SEQ_FRAG(seq) ((seq) & RTW_IEEE80211_SCTL_FRAG)
 353#define WLAN_GET_SEQ_SEQ(seq)  ((seq) & RTW_IEEE80211_SCTL_SEQ)
 354
 355/* Non standard?  Not in <linux/ieee80211.h> */
 356#define WLAN_REASON_EXPIRATION_CHK 65535
 357
 358#define IEEE80211_MGMT_HDR_LEN 24
 359#define IEEE80211_DATA_HDR3_LEN 24
 360#define IEEE80211_DATA_HDR4_LEN 30
 361
 362#define IEEE80211_CCK_MODULATION        BIT(0)
 363#define IEEE80211_OFDM_MODULATION       BIT(1)
 364
 365#define IEEE80211_24GHZ_BAND    BIT(0)
 366#define IEEE80211_52GHZ_BAND    BIT(1)
 367
 368#define IEEE80211_CCK_RATE_LEN                  4
 369#define IEEE80211_NUM_OFDM_RATESLEN     8
 370
 371
 372#define IEEE80211_CCK_RATE_1MB                  0x02
 373#define IEEE80211_CCK_RATE_2MB                  0x04
 374#define IEEE80211_CCK_RATE_5MB                  0x0B
 375#define IEEE80211_CCK_RATE_11MB                 0x16
 376#define IEEE80211_OFDM_RATE_LEN                 8
 377#define IEEE80211_OFDM_RATE_6MB                 0x0C
 378#define IEEE80211_OFDM_RATE_9MB                 0x12
 379#define IEEE80211_OFDM_RATE_12MB                0x18
 380#define IEEE80211_OFDM_RATE_18MB                0x24
 381#define IEEE80211_OFDM_RATE_24MB                0x30
 382#define IEEE80211_OFDM_RATE_36MB                0x48
 383#define IEEE80211_OFDM_RATE_48MB                0x60
 384#define IEEE80211_OFDM_RATE_54MB                0x6C
 385#define IEEE80211_BASIC_RATE_MASK               0x80
 386
 387#define IEEE80211_CCK_RATE_1MB_MASK             BIT(0)
 388#define IEEE80211_CCK_RATE_2MB_MASK             BIT(1)
 389#define IEEE80211_CCK_RATE_5MB_MASK             BIT(2)
 390#define IEEE80211_CCK_RATE_11MB_MASK            BIT(3)
 391#define IEEE80211_OFDM_RATE_6MB_MASK            BIT(4)
 392#define IEEE80211_OFDM_RATE_9MB_MASK            BIT(5)
 393#define IEEE80211_OFDM_RATE_12MB_MASK           BIT(6)
 394#define IEEE80211_OFDM_RATE_18MB_MASK           BIT(7)
 395#define IEEE80211_OFDM_RATE_24MB_MASK           BIT(8)
 396#define IEEE80211_OFDM_RATE_36MB_MASK           BIT(9)
 397#define IEEE80211_OFDM_RATE_48MB_MASK           BIT(10)
 398#define IEEE80211_OFDM_RATE_54MB_MASK           BIT(11)
 399
 400#define IEEE80211_CCK_RATES_MASK                0x0000000F
 401#define IEEE80211_CCK_BASIC_RATES_MASK  (IEEE80211_CCK_RATE_1MB_MASK | \
 402        IEEE80211_CCK_RATE_2MB_MASK)
 403#define IEEE80211_CCK_DEFAULT_RATES_MASK                                \
 404        (IEEE80211_CCK_BASIC_RATES_MASK |                               \
 405        IEEE80211_CCK_RATE_5MB_MASK |                                   \
 406        IEEE80211_CCK_RATE_11MB_MASK)
 407
 408#define IEEE80211_OFDM_RATES_MASK               0x00000FF0
 409#define IEEE80211_OFDM_BASIC_RATES_MASK (IEEE80211_OFDM_RATE_6MB_MASK | \
 410        IEEE80211_OFDM_RATE_12MB_MASK |                                 \
 411        IEEE80211_OFDM_RATE_24MB_MASK)
 412#define IEEE80211_OFDM_DEFAULT_RATES_MASK                               \
 413        (IEEE80211_OFDM_BASIC_RATES_MASK |                              \
 414        IEEE80211_OFDM_RATE_9MB_MASK  |                                 \
 415        IEEE80211_OFDM_RATE_18MB_MASK |                                 \
 416        IEEE80211_OFDM_RATE_36MB_MASK |                                 \
 417        IEEE80211_OFDM_RATE_48MB_MASK |                                 \
 418        IEEE80211_OFDM_RATE_54MB_MASK)
 419
 420#define IEEE80211_NUM_OFDM_RATES        8
 421#define IEEE80211_NUM_CCK_RATES         4
 422#define IEEE80211_OFDM_SHIFT_MASK_A     4
 423
 424/* IEEE 802.11 requires that STA supports concurrent reception of at least
 425 * three fragmented frames. This define can be increased to support more
 426 * concurrent frames, but it should be noted that each entry can consume about
 427 * 2 kB of RAM and increasing cache size will slow down frame reassembly.
 428 */
 429#define IEEE80211_FRAG_CACHE_LEN 4
 430
 431#define SEC_KEY_1       BIT(0)
 432#define SEC_KEY_2       BIT(1)
 433#define SEC_KEY_3       BIT(2)
 434#define SEC_KEY_4       BIT(3)
 435#define SEC_ACTIVE_KEY  BIT(4)
 436#define SEC_AUTH_MODE   BIT(5)
 437#define SEC_UNICAST_GROUP BIT(6)
 438#define SEC_LEVEL       BIT(7)
 439#define SEC_ENABLED     BIT(8)
 440
 441#define SEC_LEVEL_0      0 /* None */
 442#define SEC_LEVEL_1      1 /* WEP 40 and 104 bit */
 443#define SEC_LEVEL_2      2 /* Level 1 + TKIP */
 444#define SEC_LEVEL_2_CKIP 3 /* Level 1 + CKIP */
 445#define SEC_LEVEL_3      4 /* Level 2 + CCMP */
 446
 447#define WEP_KEYS 4
 448#define WEP_KEY_LEN 13
 449
 450/* SWEEP TABLE ENTRIES NUMBER*/
 451#define MAX_SWEEP_TAB_ENTRIES             42
 452#define MAX_SWEEP_TAB_ENTRIES_PER_PACKET  7
 453/* MAX_RATES_LENGTH needs to be 12.  The spec says 8, and many APs
 454 * only use 8, and then use extended rates for the remaining supported
 455 * rates.  Other APs, however, stick all of their supported rates on the
 456 * main rates information element...
 457 */
 458#define MAX_RATES_LENGTH                ((u8)12)
 459#define MAX_RATES_EX_LENGTH             ((u8)16)
 460#define MAX_NETWORK_COUNT               128
 461#define MAX_CHANNEL_NUMBER              161
 462#define IEEE80211_SOFTMAC_SCAN_TIME     400
 463/* HZ / 2) */
 464#define IEEE80211_SOFTMAC_ASSOC_RETRY_TIME (HZ * 2)
 465
 466#define CRC_LENGTH               4U
 467
 468#define MAX_WPA_IE_LEN (256)
 469#define MAX_WPS_IE_LEN (512)
 470#define MAX_P2P_IE_LEN (256)
 471#define MAX_WFD_IE_LEN (128)
 472
 473#define NETWORK_EMPTY_ESSID     BIT(0)
 474#define NETWORK_HAS_OFDM        BIT(1)
 475#define NETWORK_HAS_CCK         BIT(2)
 476
 477#define IW_ESSID_MAX_SIZE 32
 478/*
 479 * join_res:
 480 * -1: authentication fail
 481 * -2: association fail
 482 * > 0: TID
 483 */
 484
 485enum ieee80211_state {
 486        /* the card is not linked at all */
 487        IEEE80211_NOLINK = 0,
 488
 489        /* IEEE80211_ASSOCIATING* are for BSS client mode
 490         * the driver shall not perform RX filtering unless
 491         * the state is LINKED.
 492         * The driver shall just check for the state LINKED and
 493         * defaults to NOLINK for ALL the other states (including
 494         * LINKED_SCANNING)
 495         */
 496
 497        /* the association procedure will start (wq scheduling)*/
 498        IEEE80211_ASSOCIATING,
 499        IEEE80211_ASSOCIATING_RETRY,
 500
 501        /* the association procedure is sending AUTH request*/
 502        IEEE80211_ASSOCIATING_AUTHENTICATING,
 503
 504        /* the association procedure has successfully authentcated
 505         * and is sending association request
 506         */
 507        IEEE80211_ASSOCIATING_AUTHENTICATED,
 508
 509        /* the link is ok. the card associated to a BSS or linked
 510         * to a ibss cell or acting as an AP and creating the bss
 511         */
 512        IEEE80211_LINKED,
 513
 514        /* same as LINKED, but the driver shall apply RX filter
 515         * rules as we are in NO_LINK mode. As the card is still
 516         * logically linked, but it is doing a syncro site survey
 517         * then it will be back to LINKED state.
 518         */
 519        IEEE80211_LINKED_SCANNING,
 520
 521};
 522
 523#define DEFAULT_MAX_SCAN_AGE (15 * HZ)
 524#define DEFAULT_FTS 2346
 525
 526static inline int is_multicast_mac_addr(const u8 *addr)
 527{
 528        return ((addr[0] != 0xff) && (0x01 & addr[0]));
 529}
 530
 531static inline int is_broadcast_mac_addr(const u8 *addr)
 532{
 533        return (addr[0] == 0xff) && (addr[1] == 0xff) && (addr[2] == 0xff) &&
 534               (addr[3] == 0xff) && (addr[4] == 0xff) && (addr[5] == 0xff);
 535}
 536
 537#define CFG_IEEE80211_RESERVE_FCS       BIT(0)
 538#define CFG_IEEE80211_COMPUTE_FCS       BIT(1)
 539
 540#define MAXTID  16
 541
 542#define IEEE_A      BIT(0)
 543#define IEEE_B      BIT(1)
 544#define IEEE_G      BIT(2)
 545#define IEEE_MODE_MASK    (IEEE_A | IEEE_B | IEEE_G)
 546
 547/* Action category code */
 548enum rtw_ieee80211_category {
 549        RTW_WLAN_CATEGORY_SPECTRUM_MGMT = 0,
 550        RTW_WLAN_CATEGORY_QOS = 1,
 551        RTW_WLAN_CATEGORY_DLS = 2,
 552        RTW_WLAN_CATEGORY_BACK = 3,
 553        RTW_WLAN_CATEGORY_PUBLIC = 4, /* IEEE 802.11 public action frames */
 554        RTW_WLAN_CATEGORY_RADIO_MEASUREMENT  = 5,
 555        RTW_WLAN_CATEGORY_FT = 6,
 556        RTW_WLAN_CATEGORY_HT = 7,
 557        RTW_WLAN_CATEGORY_SA_QUERY = 8,
 558        RTW_WLAN_CATEGORY_TDLS = 12,
 559        RTW_WLAN_CATEGORY_WMM = 17,
 560        RTW_WLAN_CATEGORY_P2P = 0x7f,/* P2P action frames */
 561};
 562
 563/* SPECTRUM_MGMT action code */
 564enum rtw_ieee80211_spectrum_mgmt_actioncode {
 565        RTW_WLAN_ACTION_SPCT_MSR_REQ = 0,
 566        RTW_WLAN_ACTION_SPCT_MSR_RPRT = 1,
 567        RTW_WLAN_ACTION_SPCT_TPC_REQ = 2,
 568        RTW_WLAN_ACTION_SPCT_TPC_RPRT = 3,
 569        RTW_WLAN_ACTION_SPCT_CHL_SWITCH = 4,
 570        RTW_WLAN_ACTION_SPCT_EXT_CHL_SWITCH = 5,
 571};
 572
 573enum _PUBLIC_ACTION {
 574        ACT_PUBLIC_BSSCOEXIST = 0, /*  20/40 BSS Coexistence */
 575        ACT_PUBLIC_DSE_ENABLE = 1,
 576        ACT_PUBLIC_DSE_DEENABLE = 2,
 577        ACT_PUBLIC_DSE_REG_LOCATION = 3,
 578        ACT_PUBLIC_EXT_CHL_SWITCH = 4,
 579        ACT_PUBLIC_DSE_MSR_REQ = 5,
 580        ACT_PUBLIC_DSE_MSR_RPRT = 6,
 581        ACT_PUBLIC_MP = 7, /*  Measurement Pilot */
 582        ACT_PUBLIC_DSE_PWR_CONSTRAINT = 8,
 583        ACT_PUBLIC_VENDOR = 9, /*  for WIFI_DIRECT */
 584        ACT_PUBLIC_GAS_INITIAL_REQ = 10,
 585        ACT_PUBLIC_GAS_INITIAL_RSP = 11,
 586        ACT_PUBLIC_GAS_COMEBACK_REQ = 12,
 587        ACT_PUBLIC_GAS_COMEBACK_RSP = 13,
 588        ACT_PUBLIC_TDLS_DISCOVERY_RSP = 14,
 589        ACT_PUBLIC_LOCATION_TRACK = 15,
 590        ACT_PUBLIC_MAX
 591};
 592
 593/* BACK action code */
 594enum rtw_ieee80211_back_actioncode {
 595        RTW_WLAN_ACTION_ADDBA_REQ = 0,
 596        RTW_WLAN_ACTION_ADDBA_RESP = 1,
 597        RTW_WLAN_ACTION_DELBA = 2,
 598};
 599
 600/* HT features action code */
 601enum rtw_ieee80211_ht_actioncode {
 602        RTW_WLAN_ACTION_NOTIFY_CH_WIDTH = 0,
 603        RTW_WLAN_ACTION_SM_PS = 1,
 604        RTW_WLAN_ACTION_PSPM = 2,
 605        RTW_WLAN_ACTION_PCO_PHASE = 3,
 606        RTW_WLAN_ACTION_MIMO_CSI_MX = 4,
 607        RTW_WLAN_ACTION_MIMO_NONCP_BF = 5,
 608        RTW_WLAN_ACTION_MIMP_CP_BF = 6,
 609        RTW_WLAN_ACTION_ASEL_INDICATES_FB = 7,
 610        RTW_WLAN_ACTION_HI_INFO_EXCHG = 8,
 611};
 612
 613/* BACK (block-ack) parties */
 614enum rtw_ieee80211_back_parties {
 615        RTW_WLAN_BACK_RECIPIENT = 0,
 616        RTW_WLAN_BACK_INITIATOR = 1,
 617        RTW_WLAN_BACK_TIMER = 2,
 618};
 619
 620#define OUI_MICROSOFT 0x0050f2 /* Microsoft (also used in Wi-Fi specs)
 621                                * 00:50:F2
 622                                */
 623#define WME_OUI_TYPE 2
 624#define WME_OUI_SUBTYPE_INFORMATION_ELEMENT 0
 625#define WME_OUI_SUBTYPE_PARAMETER_ELEMENT 1
 626#define WME_OUI_SUBTYPE_TSPEC_ELEMENT 2
 627#define WME_VERSION 1
 628
 629#define WME_ACTION_CODE_SETUP_REQUEST 0
 630#define WME_ACTION_CODE_SETUP_RESPONSE 1
 631#define WME_ACTION_CODE_TEARDOWN 2
 632
 633#define WME_SETUP_RESPONSE_STATUS_ADMISSION_ACCEPTED 0
 634#define WME_SETUP_RESPONSE_STATUS_INVALID_PARAMETERS 1
 635#define WME_SETUP_RESPONSE_STATUS_REFUSED 3
 636
 637#define WME_TSPEC_DIRECTION_UPLINK 0
 638#define WME_TSPEC_DIRECTION_DOWNLINK 1
 639#define WME_TSPEC_DIRECTION_BI_DIRECTIONAL 3
 640
 641
 642#define OUI_BROADCOM 0x00904c /* Broadcom (Epigram) */
 643
 644#define VENDOR_HT_CAPAB_OUI_TYPE 0x33 /* 00-90-4c:0x33 */
 645
 646/**
 647 * enum rtw_ieee80211_channel_flags - channel flags
 648 *
 649 * Channel flags set by the regulatory control code.
 650 *
 651 * @RTW_IEEE80211_CHAN_DISABLED: This channel is disabled.
 652 * @RTW_IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
 653 *      on this channel.
 654 * @RTW_IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
 655 * @RTW_IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
 656 * @RTW_IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
 657 *      is not permitted.
 658 * @RTW_IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
 659 *      is not permitted.
 660 */
 661enum rtw_ieee80211_channel_flags {
 662        RTW_IEEE80211_CHAN_DISABLED      = BIT(0),
 663        RTW_IEEE80211_CHAN_PASSIVE_SCAN     = BIT(1),
 664        RTW_IEEE80211_CHAN_NO_IBSS        = BIT(2),
 665        RTW_IEEE80211_CHAN_RADAR            = BIT(3),
 666        RTW_IEEE80211_CHAN_NO_HT40PLUS      = BIT(4),
 667        RTW_IEEE80211_CHAN_NO_HT40MINUS     = BIT(5),
 668};
 669
 670#define RTW_IEEE80211_CHAN_NO_HT40 \
 671          (RTW_IEEE80211_CHAN_NO_HT40PLUS | RTW_IEEE80211_CHAN_NO_HT40MINUS)
 672
 673/* Represent channel details, subset of ieee80211_channel */
 674struct rtw_ieee80211_channel {
 675        u16 hw_value;
 676        u32 flags;
 677};
 678
 679#define CHAN_FMT \
 680        "hw_value:%u, " \
 681        "flags:0x%08x" \
 682
 683#define CHAN_ARG(channel) \
 684        (channel)->hw_value \
 685        , (channel)->flags \
 686
 687/* Parsed Information Elements */
 688struct rtw_ieee802_11_elems {
 689        u8 *ssid;
 690        u8 ssid_len;
 691        u8 *supp_rates;
 692        u8 supp_rates_len;
 693        u8 *fh_params;
 694        u8 fh_params_len;
 695        u8 *ds_params;
 696        u8 ds_params_len;
 697        u8 *cf_params;
 698        u8 cf_params_len;
 699        u8 *tim;
 700        u8 tim_len;
 701        u8 *ibss_params;
 702        u8 ibss_params_len;
 703        u8 *challenge;
 704        u8 challenge_len;
 705        u8 *erp_info;
 706        u8 erp_info_len;
 707        u8 *ext_supp_rates;
 708        u8 ext_supp_rates_len;
 709        u8 *wpa_ie;
 710        u8 wpa_ie_len;
 711        u8 *rsn_ie;
 712        u8 rsn_ie_len;
 713        u8 *wme;
 714        u8 wme_len;
 715        u8 *wme_tspec;
 716        u8 wme_tspec_len;
 717        u8 *wps_ie;
 718        u8 wps_ie_len;
 719        u8 *power_cap;
 720        u8 power_cap_len;
 721        u8 *supp_channels;
 722        u8 supp_channels_len;
 723        u8 *mdie;
 724        u8 mdie_len;
 725        u8 *ftie;
 726        u8 ftie_len;
 727        u8 *timeout_int;
 728        u8 timeout_int_len;
 729        u8 *ht_capabilities;
 730        u8 ht_capabilities_len;
 731        u8 *ht_operation;
 732        u8 ht_operation_len;
 733        u8 *vendor_ht_cap;
 734        u8 vendor_ht_cap_len;
 735};
 736
 737enum parse_res {
 738        ParseOK = 0,
 739        ParseUnknown = 1,
 740        ParseFailed = -1
 741};
 742
 743enum parse_res rtw_ieee802_11_parse_elems(u8 *start, uint len,
 744                                          struct rtw_ieee802_11_elems *elems,
 745                                          int show_errors);
 746
 747u8 *rtw_set_fixed_ie(void *pbuf, unsigned int len,
 748                     void *source, unsigned int *frlen);
 749u8 *rtw_set_ie(u8 *pbuf, int index, uint len, u8 *source, uint *frlen);
 750
 751enum secondary_ch_offset {
 752        SCN = 0, /* no secondary channel */
 753        SCA = 1, /* secondary channel above */
 754        SCB = 3,  /* secondary channel below */
 755};
 756
 757u8 *rtw_get_ie(u8 *pbuf, int index, uint *len, int limit);
 758
 759void rtw_set_supported_rate(u8 *SupportedRates, uint mode);
 760
 761unsigned char *rtw_get_wpa_ie(unsigned char *pie, uint *wpa_ie_len, int limit);
 762unsigned char *rtw_get_wpa2_ie(unsigned char *pie, uint *rsn_ie_len, int limit);
 763int rtw_get_wpa_cipher_suite(u8 *s);
 764int rtw_get_wpa2_cipher_suite(u8 *s);
 765int rtw_get_wapi_ie(u8 *in_ie, uint in_len, u8 *wapi_ie, u16 *wapi_len);
 766int rtw_parse_wpa_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher,
 767                     int *pairwise_cipher, int *is_8021x);
 768int rtw_parse_wpa2_ie(u8 *wpa_ie, int wpa_ie_len, int *group_cipher,
 769                      int *pairwise_cipher, int *is_8021x);
 770
 771int rtw_get_sec_ie(u8 *in_ie, uint in_len, u8 *rsn_ie, u16 *rsn_len,
 772                   u8 *wpa_ie, u16 *wpa_len);
 773
 774u8 rtw_is_wps_ie(u8 *ie_ptr, uint *wps_ielen);
 775u8 *rtw_get_wps_ie(u8 *in_ie, uint in_len, u8 *wps_ie, uint *wps_ielen);
 776u8 *rtw_get_wps_attr(u8 *wps_ie, uint wps_ielen, u16 target_attr_id,
 777                     u8 *buf_attr, u32 *len_attr);
 778u8 *rtw_get_wps_attr_content(u8 *wps_ie, uint wps_ielen, u16 target_attr_id,
 779                             u8 *buf_content, uint *len_content);
 780
 781uint    rtw_get_rateset_len(u8  *rateset);
 782
 783struct registry_priv;
 784int rtw_generate_ie(struct registry_priv *pregistrypriv);
 785
 786
 787int rtw_get_bit_value_from_ieee_value(u8 val);
 788
 789uint    rtw_is_cckrates_included(u8 *rate);
 790
 791uint    rtw_is_cckratesonly_included(u8 *rate);
 792
 793int rtw_check_network_type(unsigned char *rate, int ratelen, int channel);
 794
 795void rtw_get_bcn_info(struct wlan_network *pnetwork);
 796
 797void rtw_macaddr_cfg(u8 *mac_addr);
 798
 799u16 rtw_mcs_rate(u8 rf_type, u8 bw_40MHz, u8 short_GI_20, u8 short_GI_40,
 800                 unsigned char *MCS_rate);
 801
 802#endif /* IEEE80211_H */
 803