git.oblomov.eu Git - linux-2.6/blob - drivers/staging/rt2870/mlme.h

   1 /*
   2  *************************************************************************
   3  * Ralink Tech Inc.
   4  * 5F., No.36, Taiyuan St., Jhubei City,
   5  * Hsinchu County 302,
   6  * Taiwan, R.O.C.
   7  *
   8  * (c) Copyright 2002-2007, Ralink Technology, Inc.
   9  *
  10  * This program is free software; you can redistribute it and/or modify  *
  11  * it under the terms of the GNU General Public License as published by  *
  12  * the Free Software Foundation; either version 2 of the License, or     *
  13  * (at your option) any later version.                                   *
  14  *                                                                       *
  15  * This program is distributed in the hope that it will be useful,       *
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  18  * GNU General Public License for more details.                          *
  19  *                                                                       *
  20  * You should have received a copy of the GNU General Public License     *
  21  * along with this program; if not, write to the                         *
  22  * Free Software Foundation, Inc.,                                       *
  23  * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  24  *                                                                       *
  25  *************************************************************************
  26
  27         Module Name:
  28         mlme.h
  29
  30         Abstract:
  31
  32         Revision History:
  33         Who                     When                    What
  34         --------        ----------              ----------------------------------------------
  35         John Chang      2003-08-28              Created
  36         John Chang  2004-09-06      modified for RT2600
  37
  38 */
  39 #ifndef __MLME_H__
  40 #define __MLME_H__
  41
  42 //extern UCHAR BROADCAST_ADDR[];
  43
  44 // maximum supported capability information -
  45 // ESS, IBSS, Privacy, Short Preamble, Spectrum mgmt, Short Slot
  46 #define SUPPORTED_CAPABILITY_INFO   0x0533
  47
  48 #define END_OF_ARGS                 -1
  49 #define LFSR_MASK                   0x80000057
  50 #define MLME_TASK_EXEC_INTV         100/*200*/       //
  51 #define LEAD_TIME                   5
  52 #define MLME_TASK_EXEC_MULTIPLE       10  /*5*/       // MLME_TASK_EXEC_MULTIPLE * MLME_TASK_EXEC_INTV = 1 sec
  53 #define REORDER_EXEC_INTV               100       // 0.1 sec
  54 //#define TBTT_PRELOAD_TIME         384        // usec. LomgPreamble + 24-byte at 1Mbps
  55
  56 // The definition of Radar detection duration region
  57 #define CE              0
  58 #define FCC             1
  59 #define JAP             2
  60 #define JAP_W53 3
  61 #define JAP_W56 4
  62 #define MAX_RD_REGION 5
  63
  64 #ifdef  NDIS51_MINIPORT
  65 #define BEACON_LOST_TIME            4000       // 2048 msec = 2 sec
  66 #else
  67 #define BEACON_LOST_TIME            4 * OS_HZ    // 2048 msec = 2 sec
  68 #endif
  69
  70 #define DLS_TIMEOUT                 1200      // unit: msec
  71 #define AUTH_TIMEOUT                300       // unit: msec
  72 #define ASSOC_TIMEOUT               300       // unit: msec
  73 #define JOIN_TIMEOUT                2 * OS_HZ      // unit: msec
  74 #define SHORT_CHANNEL_TIME          90        // unit: msec
  75 #define MIN_CHANNEL_TIME            110        // unit: msec, for dual band scan
  76 #define MAX_CHANNEL_TIME            140       // unit: msec, for single band scan
  77 #define FAST_ACTIVE_SCAN_TIME       30            // Active scan waiting for probe response time
  78 #define CW_MIN_IN_BITS              4         // actual CwMin = 2^CW_MIN_IN_BITS - 1
  79
  80
  81 #ifdef CONFIG_STA_SUPPORT
  82 #ifndef CONFIG_AP_SUPPORT
  83 #define CW_MAX_IN_BITS              10        // actual CwMax = 2^CW_MAX_IN_BITS - 1
  84 #endif
  85 #endif // CONFIG_STA_SUPPORT //
  86
  87 // Note: RSSI_TO_DBM_OFFSET has been changed to variable for new RF (2004-0720).
  88 // SHould not refer to this constant anymore
  89 //#define RSSI_TO_DBM_OFFSET          120 // for RT2530 RSSI-115 = dBm
  90 #define RSSI_FOR_MID_TX_POWER       -55  // -55 db is considered mid-distance
  91 #define RSSI_FOR_LOW_TX_POWER       -45  // -45 db is considered very short distance and
  92                                         // eligible to use a lower TX power
  93 #define RSSI_FOR_LOWEST_TX_POWER    -30
  94 //#define MID_TX_POWER_DELTA          0   // 0 db from full TX power upon mid-distance to AP
  95 #define LOW_TX_POWER_DELTA          6    // -3 db from full TX power upon very short distance. 1 grade is 0.5 db
  96 #define LOWEST_TX_POWER_DELTA       16   // -8 db from full TX power upon shortest distance. 1 grade is 0.5 db
  97
  98 #define RSSI_TRIGGERED_UPON_BELOW_THRESHOLD     0
  99 #define RSSI_TRIGGERED_UPON_EXCCEED_THRESHOLD   1
 100 #define RSSI_THRESHOLD_FOR_ROAMING              25
 101 #define RSSI_DELTA                              5
 102
 103 // Channel Quality Indication
 104 #define CQI_IS_GOOD(cqi)            ((cqi) >= 50)
 105 //#define CQI_IS_FAIR(cqi)          (((cqi) >= 20) && ((cqi) < 50))
 106 #define CQI_IS_POOR(cqi)            (cqi < 50)  //(((cqi) >= 5) && ((cqi) < 20))
 107 #define CQI_IS_BAD(cqi)             (cqi < 5)
 108 #define CQI_IS_DEAD(cqi)            (cqi == 0)
 109
 110 // weighting factor to calculate Channel quality, total should be 100%
 111 #define RSSI_WEIGHTING                   50
 112 #define TX_WEIGHTING                     30
 113 #define RX_WEIGHTING                     20
 114
 115 //#define PEER_KEY_NOT_USED                0
 116 //#define PEER_KEY_64_BIT                  64
 117 //#define PEER_KEY_128_BIT                 128
 118
 119 //#define PEER_KEY_64BIT_LEN               8
 120 //#define PEER_KEY_128BIT_LEN              16
 121
 122 #define BSS_NOT_FOUND                    0xFFFFFFFF
 123
 124
 125 #ifdef CONFIG_STA_SUPPORT
 126 #define MAX_LEN_OF_MLME_QUEUE            40 //10
 127 #endif // CONFIG_STA_SUPPORT //
 128
 129 #define SCAN_PASSIVE                     18             // scan with no probe request, only wait beacon and probe response
 130 #define SCAN_ACTIVE                      19             // scan with probe request, and wait beacon and probe response
 131 #define SCAN_CISCO_PASSIVE                               20             // Single channel passive scan
 132 #define SCAN_CISCO_ACTIVE                                21             // Single channel active scan
 133 #define SCAN_CISCO_NOISE                                 22             // Single channel passive scan for noise histogram collection
 134 #define SCAN_CISCO_CHANNEL_LOAD                  23             // Single channel passive scan for channel load collection
 135 #define FAST_SCAN_ACTIVE                 24             // scan with probe request, and wait beacon and probe response
 136
 137 #ifdef DOT11N_DRAFT3
 138 #define SCAN_2040_BSS_COEXIST                  26
 139 #endif // DOT11N_DRAFT3 //
 140
 141 //#define BSS_TABLE_EMPTY(x)             ((x).BssNr == 0)
 142 #define MAC_ADDR_IS_GROUP(Addr)       (((Addr[0]) & 0x01))
 143 #define MAC_ADDR_HASH(Addr)            (Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
 144 #define MAC_ADDR_HASH_INDEX(Addr)      (MAC_ADDR_HASH(Addr) % HASH_TABLE_SIZE)
 145 #define TID_MAC_HASH(Addr,TID)            (TID^Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
 146 #define TID_MAC_HASH_INDEX(Addr,TID)      (TID_MAC_HASH(Addr,TID) % HASH_TABLE_SIZE)
 147
 148 // LED Control
 149 // assoiation ON. one LED ON. another blinking when TX, OFF when idle
 150 // no association, both LED off
 151 #define ASIC_LED_ACT_ON(pAd)        RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00031e46)
 152 #define ASIC_LED_ACT_OFF(pAd)       RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00001e46)
 153
 154 // bit definition of the 2-byte pBEACON->Capability field
 155 #define CAP_IS_ESS_ON(x)                 (((x) & 0x0001) != 0)
 156 #define CAP_IS_IBSS_ON(x)                (((x) & 0x0002) != 0)
 157 #define CAP_IS_CF_POLLABLE_ON(x)         (((x) & 0x0004) != 0)
 158 #define CAP_IS_CF_POLL_REQ_ON(x)         (((x) & 0x0008) != 0)
 159 #define CAP_IS_PRIVACY_ON(x)             (((x) & 0x0010) != 0)
 160 #define CAP_IS_SHORT_PREAMBLE_ON(x)      (((x) & 0x0020) != 0)
 161 #define CAP_IS_PBCC_ON(x)                (((x) & 0x0040) != 0)
 162 #define CAP_IS_AGILITY_ON(x)             (((x) & 0x0080) != 0)
 163 #define CAP_IS_SPECTRUM_MGMT(x)          (((x) & 0x0100) != 0)  // 802.11e d9
 164 #define CAP_IS_QOS(x)                    (((x) & 0x0200) != 0)  // 802.11e d9
 165 #define CAP_IS_SHORT_SLOT(x)             (((x) & 0x0400) != 0)
 166 #define CAP_IS_APSD(x)                   (((x) & 0x0800) != 0)  // 802.11e d9
 167 #define CAP_IS_IMMED_BA(x)               (((x) & 0x1000) != 0)  // 802.11e d9
 168 #define CAP_IS_DSSS_OFDM(x)              (((x) & 0x2000) != 0)
 169 #define CAP_IS_DELAY_BA(x)               (((x) & 0x4000) != 0)  // 802.11e d9
 170
 171 #define CAP_GENERATE(ess,ibss,priv,s_pre,s_slot,spectrum)  (((ess) ? 0x0001 : 0x0000) | ((ibss) ? 0x0002 : 0x0000) | ((priv) ? 0x0010 : 0x0000) | ((s_pre) ? 0x0020 : 0x0000) | ((s_slot) ? 0x0400 : 0x0000) | ((spectrum) ? 0x0100 : 0x0000))
 172
 173 //#define STA_QOS_CAPABILITY               0 // 1-byte. see 802.11e d9.0 for bit definition
 174
 175 #define ERP_IS_NON_ERP_PRESENT(x)        (((x) & 0x01) != 0)    // 802.11g
 176 #define ERP_IS_USE_PROTECTION(x)         (((x) & 0x02) != 0)    // 802.11g
 177 #define ERP_IS_USE_BARKER_PREAMBLE(x)    (((x) & 0x04) != 0)    // 802.11g
 178
 179 #define DRS_TX_QUALITY_WORST_BOUND       8// 3  // just test by gary
 180 #define DRS_PENALTY                      8
 181
 182 #define BA_NOTUSE       2
 183 //BA Policy subfiled value in ADDBA frame
 184 #define IMMED_BA        1
 185 #define DELAY_BA        0
 186
 187 // BA Initiator subfield in DELBA frame
 188 #define ORIGINATOR      1
 189 #define RECIPIENT       0
 190
 191 // ADDBA Status Code
 192 #define ADDBA_RESULTCODE_SUCCESS                                        0
 193 #define ADDBA_RESULTCODE_REFUSED                                        37
 194 #define ADDBA_RESULTCODE_INVALID_PARAMETERS                     38
 195
 196 // DELBA Reason Code
 197 #define DELBA_REASONCODE_QSTA_LEAVING                           36
 198 #define DELBA_REASONCODE_END_BA                                         37
 199 #define DELBA_REASONCODE_UNKNOWN_BA                                     38
 200 #define DELBA_REASONCODE_TIMEOUT                                        39
 201
 202 // reset all OneSecTx counters
 203 #define RESET_ONE_SEC_TX_CNT(__pEntry) \
 204 if (((__pEntry)) != NULL) \
 205 { \
 206         (__pEntry)->OneSecTxRetryOkCount = 0; \
 207         (__pEntry)->OneSecTxFailCount = 0; \
 208         (__pEntry)->OneSecTxNoRetryOkCount = 0; \
 209 }
 210
 211 //
 212 // 802.11 frame formats
 213 //
 214 //  HT Capability INFO field in HT Cap IE .
 215 typedef struct PACKED {
 216 #ifdef RT_BIG_ENDIAN
 217         USHORT  LSIGTxopProSup:1;
 218         USHORT  Forty_Mhz_Intolerant:1;
 219         USHORT  PSMP:1;
 220         USHORT  CCKmodein40:1;
 221         USHORT  AMsduSize:1;
 222         USHORT  DelayedBA:1;    //rt2860c not support
 223         USHORT  RxSTBC:2;
 224         USHORT  TxSTBC:1;
 225         USHORT  ShortGIfor40:1; //for40MHz
 226         USHORT  ShortGIfor20:1;
 227         USHORT  GF:1;   //green field
 228         USHORT  MimoPs:2;//momi power safe
 229         USHORT  ChannelWidth:1;
 230         USHORT  AdvCoding:1;
 231 #else
 232         USHORT  AdvCoding:1;
 233         USHORT  ChannelWidth:1;
 234         USHORT  MimoPs:2;//momi power safe
 235         USHORT  GF:1;   //green field
 236         USHORT  ShortGIfor20:1;
 237         USHORT  ShortGIfor40:1; //for40MHz
 238         USHORT  TxSTBC:1;
 239         USHORT  RxSTBC:2;
 240         USHORT  DelayedBA:1;    //rt2860c not support
 241         USHORT  AMsduSize:1;    // only support as zero
 242         USHORT  CCKmodein40:1;
 243         USHORT  PSMP:1;
 244         USHORT  Forty_Mhz_Intolerant:1;
 245         USHORT  LSIGTxopProSup:1;
 246 #endif  /* !RT_BIG_ENDIAN */
 247 } HT_CAP_INFO, *PHT_CAP_INFO;
 248
 249 //  HT Capability INFO field in HT Cap IE .
 250 typedef struct PACKED {
 251 #ifdef RT_BIG_ENDIAN
 252         UCHAR   rsv:3;//momi power safe
 253         UCHAR   MpduDensity:3;
 254         UCHAR   MaxRAmpduFactor:2;
 255 #else
 256         UCHAR   MaxRAmpduFactor:2;
 257         UCHAR   MpduDensity:3;
 258         UCHAR   rsv:3;//momi power safe
 259 #endif /* !RT_BIG_ENDIAN */
 260 } HT_CAP_PARM, *PHT_CAP_PARM;
 261
 262 //  HT Capability INFO field in HT Cap IE .
 263 typedef struct PACKED {
 264         UCHAR   MCSSet[10];
 265         UCHAR   SupRate[2];  // unit : 1Mbps
 266 #ifdef RT_BIG_ENDIAN
 267         UCHAR   rsv:3;
 268         UCHAR   MpduDensity:1;
 269         UCHAR   TxStream:2;
 270         UCHAR   TxRxNotEqual:1;
 271         UCHAR   TxMCSSetDefined:1;
 272 #else
 273         UCHAR   TxMCSSetDefined:1;
 274         UCHAR   TxRxNotEqual:1;
 275         UCHAR   TxStream:2;
 276         UCHAR   MpduDensity:1;
 277         UCHAR   rsv:3;
 278 #endif // RT_BIG_ENDIAN //
 279         UCHAR   rsv3[3];
 280 } HT_MCS_SET, *PHT_MCS_SET;
 281
 282 //  HT Capability INFO field in HT Cap IE .
 283 typedef struct PACKED {
 284 #ifdef RT_BIG_ENDIAN
 285         USHORT  rsv2:4;
 286         USHORT  RDGSupport:1;   //reverse Direction Grant  support
 287         USHORT  PlusHTC:1;      //+HTC control field support
 288         USHORT  MCSFeedback:2;  //0:no MCS feedback, 2:unsolicited MCS feedback, 3:Full MCS feedback,  1:rsv.
 289         USHORT  rsv:5;//momi power safe
 290         USHORT  TranTime:2;
 291         USHORT  Pco:1;
 292 #else
 293         USHORT  Pco:1;
 294         USHORT  TranTime:2;
 295         USHORT  rsv:5;//momi power safe
 296         USHORT  MCSFeedback:2;  //0:no MCS feedback, 2:unsolicited MCS feedback, 3:Full MCS feedback,  1:rsv.
 297         USHORT  PlusHTC:1;      //+HTC control field support
 298         USHORT  RDGSupport:1;   //reverse Direction Grant  support
 299         USHORT  rsv2:4;
 300 #endif /* RT_BIG_ENDIAN */
 301 } EXT_HT_CAP_INFO, *PEXT_HT_CAP_INFO;
 302
 303 //  HT Beamforming field in HT Cap IE .
 304 typedef struct PACKED _HT_BF_CAP{
 305 #ifdef RT_BIG_ENDIAN
 306         ULONG   rsv:3;
 307         ULONG   ChanEstimation:2;
 308         ULONG   CSIRowBFSup:2;
 309         ULONG   ComSteerBFAntSup:2;
 310         ULONG   NoComSteerBFAntSup:2;
 311         ULONG   CSIBFAntSup:2;
 312         ULONG   MinGrouping:2;
 313         ULONG   ExpComBF:2;
 314         ULONG   ExpNoComBF:2;
 315         ULONG   ExpCSIFbk:2;
 316         ULONG   ExpComSteerCapable:1;
 317         ULONG   ExpNoComSteerCapable:1;
 318         ULONG   ExpCSICapable:1;
 319         ULONG   Calibration:2;
 320         ULONG   ImpTxBFCapable:1;
 321         ULONG   TxNDPCapable:1;
 322         ULONG   RxNDPCapable:1;
 323         ULONG   TxSoundCapable:1;
 324         ULONG   RxSoundCapable:1;
 325         ULONG   TxBFRecCapable:1;
 326 #else
 327         ULONG   TxBFRecCapable:1;
 328         ULONG   RxSoundCapable:1;
 329         ULONG   TxSoundCapable:1;
 330         ULONG   RxNDPCapable:1;
 331         ULONG   TxNDPCapable:1;
 332         ULONG   ImpTxBFCapable:1;
 333         ULONG   Calibration:2;
 334         ULONG   ExpCSICapable:1;
 335         ULONG   ExpNoComSteerCapable:1;
 336         ULONG   ExpComSteerCapable:1;
 337         ULONG   ExpCSIFbk:2;
 338         ULONG   ExpNoComBF:2;
 339         ULONG   ExpComBF:2;
 340         ULONG   MinGrouping:2;
 341         ULONG   CSIBFAntSup:2;
 342         ULONG   NoComSteerBFAntSup:2;
 343         ULONG   ComSteerBFAntSup:2;
 344         ULONG   CSIRowBFSup:2;
 345         ULONG   ChanEstimation:2;
 346         ULONG   rsv:3;
 347 #endif // RT_BIG_ENDIAN //
 348 } HT_BF_CAP, *PHT_BF_CAP;
 349
 350 //  HT antenna selection field in HT Cap IE .
 351 typedef struct PACKED _HT_AS_CAP{
 352 #ifdef RT_BIG_ENDIAN
 353         UCHAR   rsv:1;
 354         UCHAR   TxSoundPPDU:1;
 355         UCHAR   RxASel:1;
 356         UCHAR   AntIndFbk:1;
 357         UCHAR   ExpCSIFbk:1;
 358         UCHAR   AntIndFbkTxASEL:1;
 359         UCHAR   ExpCSIFbkTxASEL:1;
 360         UCHAR   AntSelect:1;
 361 #else
 362         UCHAR   AntSelect:1;
 363         UCHAR   ExpCSIFbkTxASEL:1;
 364         UCHAR   AntIndFbkTxASEL:1;
 365         UCHAR   ExpCSIFbk:1;
 366         UCHAR   AntIndFbk:1;
 367         UCHAR   RxASel:1;
 368         UCHAR   TxSoundPPDU:1;
 369         UCHAR   rsv:1;
 370 #endif // RT_BIG_ENDIAN //
 371 } HT_AS_CAP, *PHT_AS_CAP;
 372
 373 // Draft 1.0 set IE length 26, but is extensible..
 374 #define SIZE_HT_CAP_IE          26
 375 // The structure for HT Capability IE.
 376 typedef struct PACKED _HT_CAPABILITY_IE{
 377         HT_CAP_INFO             HtCapInfo;
 378         HT_CAP_PARM             HtCapParm;
 379 //      HT_MCS_SET              HtMCSSet;
 380         UCHAR                   MCSSet[16];
 381         EXT_HT_CAP_INFO ExtHtCapInfo;
 382         HT_BF_CAP               TxBFCap;        // beamforming cap. rt2860c not support beamforming.
 383         HT_AS_CAP               ASCap;  //antenna selection.
 384 } HT_CAPABILITY_IE, *PHT_CAPABILITY_IE;
 385
 386
 387 // 802.11n draft3 related structure definitions.
 388 // 7.3.2.60
 389 #define dot11OBSSScanPassiveDwell                                                       20      // in TU. min amount of time that the STA continously scans each channel when performing an active OBSS scan.
 390 #define dot11OBSSScanActiveDwell                                                        10      // in TU.min amount of time that the STA continously scans each channel when performing an passive OBSS scan.
 391 #define dot11BSSWidthTriggerScanInterval                                        300  // in sec. max interval between scan operations to be performed to detect BSS channel width trigger events.
 392 #define dot11OBSSScanPassiveTotalPerChannel                                     200     // in TU. min total amount of time that the STA scans each channel when performing a passive OBSS scan.
 393 #define dot11OBSSScanActiveTotalPerChannel                                      20      //in TU. min total amount of time that the STA scans each channel when performing a active OBSS scan
 394 #define dot11BSSWidthChannelTransactionDelayFactor                      5       // min ratio between the delay time in performing a switch from 20MHz BSS to 20/40 BSS operation and the maxima
 395                                                                                                                                 //      interval between overlapping BSS scan operations.
 396 #define dot11BSSScanActivityThreshold                                           25      // in %%, max total time that a STA may be active on the medium during a period of
 397                                                                                                                                 //      (dot11BSSWidthChannelTransactionDelayFactor * dot11BSSWidthTriggerScanInterval) seconds without
 398                                                                                                                                 //      being obligated to perform OBSS Scan operations. default is 25(== 0.25%)
 399
 400 typedef struct PACKED _OVERLAP_BSS_SCAN_IE{
 401         USHORT          ScanPassiveDwell;
 402         USHORT          ScanActiveDwell;
 403         USHORT          TriggerScanInt;                         // Trigger scan interval
 404         USHORT          PassiveTalPerChannel;           // passive total per channel
 405         USHORT          ActiveTalPerChannel;            // active total per channel
 406         USHORT          DelayFactor;                            // BSS width channel transition delay factor
 407         USHORT          ScanActThre;                            // Scan Activity threshold
 408 }OVERLAP_BSS_SCAN_IE, *POVERLAP_BSS_SCAN_IE;
 409
 410
 411 //  7.3.2.56. 20/40 Coexistence element used in  Element ID = 72 = IE_2040_BSS_COEXIST
 412 typedef union PACKED _BSS_2040_COEXIST_IE{
 413  struct PACKED {
 414  #ifdef RT_BIG_ENDIAN
 415         UCHAR   rsv:5;
 416         UCHAR   BSS20WidthReq:1;
 417         UCHAR   Intolerant40:1;
 418         UCHAR   InfoReq:1;
 419  #else
 420         UCHAR   InfoReq:1;
 421         UCHAR   Intolerant40:1;                 // Inter-BSS. set 1 when prohibits a receiving BSS from operating as a 20/40 Mhz BSS.
 422         UCHAR   BSS20WidthReq:1;                // Intra-BSS set 1 when prohibits a receiving AP from operating its BSS as a 20/40MHz BSS.
 423         UCHAR   rsv:5;
 424 #endif // RT_BIG_ENDIAN //
 425     } field;
 426  UCHAR   word;
 427 } BSS_2040_COEXIST_IE, *PBSS_2040_COEXIST_IE;
 428
 429
 430 typedef struct  _TRIGGER_EVENTA{
 431         BOOLEAN                 bValid;
 432         UCHAR   BSSID[6];
 433         UCHAR   RegClass;       // Regulatory Class
 434         USHORT  Channel;
 435         ULONG   CDCounter;   // Maintain a seperate count down counter for each Event A.
 436 } TRIGGER_EVENTA, *PTRIGGER_EVENTA;
 437
 438 // 20/40 trigger event table
 439 // If one Event A delete or created, or if Event B is detected or not detected, STA should send 2040BSSCoexistence to AP.
 440 #define MAX_TRIGGER_EVENT               64
 441 typedef struct  _TRIGGER_EVENT_TAB{
 442         UCHAR   EventANo;
 443         TRIGGER_EVENTA  EventA[MAX_TRIGGER_EVENT];
 444         ULONG                   EventBCountDown;        // Count down counter for Event B.
 445 } TRIGGER_EVENT_TAB, *PTRIGGER_EVENT_TAB;
 446
 447 // 7.3.27 20/40 Bss Coexistence Mgmt capability used in extended capabilities information IE( ID = 127 = IE_EXT_CAPABILITY).
 448 //      This is the first octet and was defined in 802.11n D3.03 and 802.11yD9.0
 449 typedef struct PACKED _EXT_CAP_INFO_ELEMENT{
 450 #ifdef RT_BIG_ENDIAN
 451         UCHAR   rsv2:5;
 452         UCHAR   ExtendChannelSwitch:1;
 453         UCHAR   rsv:1;
 454         UCHAR   BssCoexistMgmtSupport:1;
 455 #else
 456         UCHAR   BssCoexistMgmtSupport:1;
 457         UCHAR   rsv:1;
 458         UCHAR   ExtendChannelSwitch:1;
 459         UCHAR   rsv2:5;
 460 #endif // RT_BIG_ENDIAN //
 461 }EXT_CAP_INFO_ELEMENT, *PEXT_CAP_INFO_ELEMENT;
 462
 463
 464 // 802.11n 7.3.2.61
 465 typedef struct PACKED _BSS_2040_COEXIST_ELEMENT{
 466         UCHAR                                   ElementID;              // ID = IE_2040_BSS_COEXIST = 72
 467         UCHAR                                   Len;
 468         BSS_2040_COEXIST_IE             BssCoexistIe;
 469 }BSS_2040_COEXIST_ELEMENT, *PBSS_2040_COEXIST_ELEMENT;
 470
 471
 472 //802.11n 7.3.2.59
 473 typedef struct PACKED _BSS_2040_INTOLERANT_CH_REPORT{
 474         UCHAR                           ElementID;              // ID = IE_2040_BSS_INTOLERANT_REPORT = 73
 475         UCHAR                           Len;
 476         UCHAR                           RegulatoryClass;
 477         UCHAR                           ChList[0];
 478 }BSS_2040_INTOLERANT_CH_REPORT, *PBSS_2040_INTOLERANT_CH_REPORT;
 479
 480
 481 // The structure for channel switch annoucement IE. This is in 802.11n D3.03
 482 typedef struct PACKED _CHA_SWITCH_ANNOUNCE_IE{
 483         UCHAR                   SwitchMode;     //channel switch mode
 484         UCHAR                   NewChannel;     //
 485         UCHAR                   SwitchCount;    //
 486 } CHA_SWITCH_ANNOUNCE_IE, *PCHA_SWITCH_ANNOUNCE_IE;
 487
 488
 489 // The structure for channel switch annoucement IE. This is in 802.11n D3.03
 490 typedef struct PACKED _SEC_CHA_OFFSET_IE{
 491         UCHAR                   SecondaryChannelOffset;  // 1: Secondary above, 3: Secondary below, 0: no Secondary
 492 } SEC_CHA_OFFSET_IE, *PSEC_CHA_OFFSET_IE;
 493
 494
 495 // This structure is extracted from struct RT_HT_CAPABILITY
 496 typedef struct {
 497         BOOLEAN                 bHtEnable;       // If we should use ht rate.
 498         BOOLEAN                 bPreNHt;         // If we should use ht rate.
 499         //Substract from HT Capability IE
 500         UCHAR                   MCSSet[16];     //only supoort MCS=0-15,32 ,
 501 } RT_HT_PHY_INFO, *PRT_HT_PHY_INFO;
 502
 503 //This structure substracts ralink supports from all 802.11n-related features.
 504 //Features not listed here but contained in 802.11n spec are not supported in rt2860.
 505 typedef struct {
 506 #if 0   // move to
 507         BOOLEAN                 bHtEnable;       // If we should use ht rate.
 508         BOOLEAN                 bPreNHt;         // If we should use ht rate.
 509         //Substract from HT Capability IE
 510         UCHAR                   MCSSet[16];     //only supoort MCS=0-15,32 ,
 511 #endif
 512 #ifdef RT_BIG_ENDIAN
 513         USHORT  rsv:5;
 514         USHORT  AmsduSize:1;    // Max receiving A-MSDU size
 515         USHORT  AmsduEnable:1;  // Enable to transmit A-MSDU. Suggest disable. We should use A-MPDU to gain best benifit of 802.11n
 516         USHORT  RxSTBC:2;       // 2 bits
 517         USHORT  TxSTBC:1;
 518         USHORT  ShortGIfor40:1; //for40MHz
 519         USHORT  ShortGIfor20:1;
 520         USHORT  GF:1;   //green field
 521         USHORT  MimoPs:2;//mimo power safe MMPS_
 522         USHORT  ChannelWidth:1;
 523 #else
 524         USHORT  ChannelWidth:1;
 525         USHORT  MimoPs:2;//mimo power safe MMPS_
 526         USHORT  GF:1;   //green field
 527         USHORT  ShortGIfor20:1;
 528         USHORT  ShortGIfor40:1; //for40MHz
 529         USHORT  TxSTBC:1;
 530         USHORT  RxSTBC:2;       // 2 bits
 531         USHORT  AmsduEnable:1;  // Enable to transmit A-MSDU. Suggest disable. We should use A-MPDU to gain best benifit of 802.11n
 532         USHORT  AmsduSize:1;    // Max receiving A-MSDU size
 533         USHORT  rsv:5;
 534 #endif
 535
 536         //Substract from Addiont HT INFO IE
 537 #ifdef RT_BIG_ENDIAN
 538         UCHAR   RecomWidth:1;
 539         UCHAR   ExtChanOffset:2;        // Please not the difference with following     UCHAR   NewExtChannelOffset; from 802.11n
 540         UCHAR   MpduDensity:3;
 541         UCHAR   MaxRAmpduFactor:2;
 542 #else
 543         UCHAR   MaxRAmpduFactor:2;
 544         UCHAR   MpduDensity:3;
 545         UCHAR   ExtChanOffset:2;        // Please not the difference with following     UCHAR   NewExtChannelOffset; from 802.11n
 546         UCHAR   RecomWidth:1;
 547 #endif
 548
 549 #ifdef RT_BIG_ENDIAN
 550         USHORT  rsv2:11;
 551         USHORT  OBSS_NonHTExist:1;
 552         USHORT  rsv3:1;
 553         USHORT  NonGfPresent:1;
 554         USHORT  OperaionMode:2;
 555 #else
 556         USHORT  OperaionMode:2;
 557         USHORT  NonGfPresent:1;
 558         USHORT  rsv3:1;
 559         USHORT  OBSS_NonHTExist:1;
 560         USHORT  rsv2:11;
 561 #endif
 562
 563         // New Extension Channel Offset IE
 564         UCHAR   NewExtChannelOffset;
 565         // Extension Capability IE = 127
 566         UCHAR   BSSCoexist2040;
 567 } RT_HT_CAPABILITY, *PRT_HT_CAPABILITY;
 568
 569 //   field in Addtional HT Information IE .
 570 typedef struct PACKED {
 571 #ifdef RT_BIG_ENDIAN
 572         UCHAR   SerInterGranu:3;
 573         UCHAR   S_PSMPSup:1;
 574         UCHAR   RifsMode:1;
 575         UCHAR   RecomWidth:1;
 576         UCHAR   ExtChanOffset:2;
 577 #else
 578         UCHAR   ExtChanOffset:2;
 579         UCHAR   RecomWidth:1;
 580         UCHAR   RifsMode:1;
 581         UCHAR   S_PSMPSup:1;     //Indicate support for scheduled PSMP
 582         UCHAR   SerInterGranu:3;         //service interval granularity
 583 #endif
 584 } ADD_HTINFO, *PADD_HTINFO;
 585
 586 typedef struct PACKED{
 587 #ifdef RT_BIG_ENDIAN
 588         USHORT  rsv2:11;
 589         USHORT  OBSS_NonHTExist:1;
 590         USHORT  rsv:1;
 591         USHORT  NonGfPresent:1;
 592         USHORT  OperaionMode:2;
 593 #else
 594         USHORT  OperaionMode:2;
 595         USHORT  NonGfPresent:1;
 596         USHORT  rsv:1;
 597         USHORT  OBSS_NonHTExist:1;
 598         USHORT  rsv2:11;
 599 #endif
 600 } ADD_HTINFO2, *PADD_HTINFO2;
 601
 602
 603 // TODO: Need sync with spec about the definition of StbcMcs. In Draft 3.03, it's reserved.
 604 typedef struct PACKED{
 605 #ifdef RT_BIG_ENDIAN
 606         USHORT  rsv:4;
 607         USHORT  PcoPhase:1;
 608         USHORT  PcoActive:1;
 609         USHORT  LsigTxopProt:1;
 610         USHORT  STBCBeacon:1;
 611         USHORT  DualCTSProtect:1;
 612         USHORT  DualBeacon:1;
 613         USHORT  StbcMcs:6;
 614 #else
 615         USHORT  StbcMcs:6;
 616         USHORT  DualBeacon:1;
 617         USHORT  DualCTSProtect:1;
 618         USHORT  STBCBeacon:1;
 619         USHORT  LsigTxopProt:1; // L-SIG TXOP protection full support
 620         USHORT  PcoActive:1;
 621         USHORT  PcoPhase:1;
 622         USHORT  rsv:4;
 623 #endif // RT_BIG_ENDIAN //
 624 } ADD_HTINFO3, *PADD_HTINFO3;
 625
 626 #define SIZE_ADD_HT_INFO_IE             22
 627 typedef struct  PACKED{
 628         UCHAR                           ControlChan;
 629         ADD_HTINFO                      AddHtInfo;
 630         ADD_HTINFO2                     AddHtInfo2;
 631         ADD_HTINFO3                     AddHtInfo3;
 632         UCHAR                           MCSSet[16];             // Basic MCS set
 633 } ADD_HT_INFO_IE, *PADD_HT_INFO_IE;
 634
 635 typedef struct  PACKED{
 636         UCHAR                           NewExtChanOffset;
 637 } NEW_EXT_CHAN_IE, *PNEW_EXT_CHAN_IE;
 638
 639
 640 // 4-byte HTC field.  maybe included in any frame except non-QOS data frame.  The Order bit must set 1.
 641 typedef struct PACKED {
 642 #ifdef RT_BIG_ENDIAN
 643     UINT32              RDG:1;  //RDG / More PPDU
 644     UINT32              ACConstraint:1; //feedback request
 645     UINT32              rsv:5;  //calibration sequence
 646     UINT32              ZLFAnnouce:1;   // ZLF announcement
 647     UINT32              CSISTEERING:2;  //CSI/ STEERING
 648     UINT32              FBKReq:2;       //feedback request
 649     UINT32              CalSeq:2;  //calibration sequence
 650     UINT32              CalPos:2;       // calibration position
 651     UINT32              MFBorASC:7;     //Link adaptation feedback containing recommended MCS. 0x7f for no feedback or not available
 652     UINT32              MFS:3;  //SET to the received value of MRS. 0x111 for unsolicited MFB.
 653     UINT32              MRSorASI:3;     // MRQ Sequence identifier. unchanged during entire procedure. 0x000-0x110.
 654     UINT32              MRQ:1;  //MCS feedback. Request for a MCS feedback
 655     UINT32              TRQ:1;  //sounding request
 656     UINT32              MA:1;   //management action payload exist in (QoS Null+HTC)
 657 #else
 658     UINT32              MA:1;   //management action payload exist in (QoS Null+HTC)
 659     UINT32              TRQ:1;  //sounding request
 660     UINT32              MRQ:1;  //MCS feedback. Request for a MCS feedback
 661     UINT32              MRSorASI:3;     // MRQ Sequence identifier. unchanged during entire procedure. 0x000-0x110.
 662     UINT32              MFS:3;  //SET to the received value of MRS. 0x111 for unsolicited MFB.
 663     UINT32              MFBorASC:7;     //Link adaptation feedback containing recommended MCS. 0x7f for no feedback or not available
 664     UINT32              CalPos:2;       // calibration position
 665     UINT32              CalSeq:2;  //calibration sequence
 666     UINT32              FBKReq:2;       //feedback request
 667     UINT32              CSISTEERING:2;  //CSI/ STEERING
 668     UINT32              ZLFAnnouce:1;   // ZLF announcement
 669     UINT32              rsv:5;  //calibration sequence
 670     UINT32              ACConstraint:1; //feedback request
 671     UINT32              RDG:1;  //RDG / More PPDU
 672 #endif /* !RT_BIG_ENDIAN */
 673 } HT_CONTROL, *PHT_CONTROL;
 674
 675 // 2-byte QOS CONTROL field
 676 typedef struct PACKED {
 677 #ifdef RT_BIG_ENDIAN
 678     USHORT      Txop_QueueSize:8;
 679     USHORT      AMsduPresent:1;
 680     USHORT      AckPolicy:2;  //0: normal ACK 1:No ACK 2:scheduled under MTBA/PSMP  3: BA
 681     USHORT      EOSP:1;
 682     USHORT      TID:4;
 683 #else
 684     USHORT      TID:4;
 685     USHORT      EOSP:1;
 686     USHORT      AckPolicy:2;  //0: normal ACK 1:No ACK 2:scheduled under MTBA/PSMP  3: BA
 687     USHORT      AMsduPresent:1;
 688     USHORT      Txop_QueueSize:8;
 689 #endif /* !RT_BIG_ENDIAN */
 690 } QOS_CONTROL, *PQOS_CONTROL;
 691
 692 // 2-byte Frame control field
 693 typedef struct  PACKED {
 694 #ifdef RT_BIG_ENDIAN
 695         USHORT          Order:1;                        // Strict order expected
 696         USHORT          Wep:1;                          // Wep data
 697         USHORT          MoreData:1;                     // More data bit
 698         USHORT          PwrMgmt:1;                      // Power management bit
 699         USHORT          Retry:1;                        // Retry status bit
 700         USHORT          MoreFrag:1;                     // More fragment bit
 701         USHORT          FrDs:1;                         // From DS indication
 702         USHORT          ToDs:1;                         // To DS indication
 703         USHORT          SubType:4;                      // MSDU subtype
 704         USHORT          Type:2;                         // MSDU type
 705         USHORT          Ver:2;                          // Protocol version
 706 #else
 707         USHORT          Ver:2;                          // Protocol version
 708         USHORT          Type:2;                         // MSDU type
 709         USHORT          SubType:4;                      // MSDU subtype
 710         USHORT          ToDs:1;                         // To DS indication
 711         USHORT          FrDs:1;                         // From DS indication
 712         USHORT          MoreFrag:1;                     // More fragment bit
 713         USHORT          Retry:1;                        // Retry status bit
 714         USHORT          PwrMgmt:1;                      // Power management bit
 715         USHORT          MoreData:1;                     // More data bit
 716         USHORT          Wep:1;                          // Wep data
 717         USHORT          Order:1;                        // Strict order expected
 718 #endif /* !RT_BIG_ENDIAN */
 719 } FRAME_CONTROL, *PFRAME_CONTROL;
 720
 721 typedef struct  PACKED _HEADER_802_11   {
 722     FRAME_CONTROL   FC;
 723     USHORT          Duration;
 724     UCHAR           Addr1[MAC_ADDR_LEN];
 725     UCHAR           Addr2[MAC_ADDR_LEN];
 726         UCHAR                   Addr3[MAC_ADDR_LEN];
 727 #ifdef RT_BIG_ENDIAN
 728         USHORT                  Sequence:12;
 729         USHORT                  Frag:4;
 730 #else
 731         USHORT                  Frag:4;
 732         USHORT                  Sequence:12;
 733 #endif /* !RT_BIG_ENDIAN */
 734         UCHAR                   Octet[0];
 735 }       HEADER_802_11, *PHEADER_802_11;
 736
 737 typedef struct PACKED _FRAME_802_11 {
 738     HEADER_802_11   Hdr;
 739     UCHAR            Octet[1];
 740 }   FRAME_802_11, *PFRAME_802_11;
 741
 742 // QoSNull embedding of management action. When HT Control MA field set to 1.
 743 typedef struct PACKED _MA_BODY {
 744     UCHAR            Category;
 745     UCHAR            Action;
 746     UCHAR            Octet[1];
 747 }   MA_BODY, *PMA_BODY;
 748
 749 typedef struct  PACKED _HEADER_802_3    {
 750     UCHAR           DAAddr1[MAC_ADDR_LEN];
 751     UCHAR           SAAddr2[MAC_ADDR_LEN];
 752     UCHAR           Octet[2];
 753 }       HEADER_802_3, *PHEADER_802_3;
 754 ////Block ACK related format
 755 // 2-byte BA Parameter  field  in       DELBA frames to terminate an already set up bA
 756 typedef struct PACKED{
 757 #ifdef RT_BIG_ENDIAN
 758     USHORT      TID:4;  // value of TC os TS
 759     USHORT      Initiator:1;    // 1: originator    0:recipient
 760     USHORT      Rsv:11; // always set to 0
 761 #else
 762     USHORT      Rsv:11; // always set to 0
 763     USHORT      Initiator:1;    // 1: originator    0:recipient
 764     USHORT      TID:4;  // value of TC os TS
 765 #endif /* !RT_BIG_ENDIAN */
 766 } DELBA_PARM, *PDELBA_PARM;
 767
 768 // 2-byte BA Parameter Set field  in ADDBA frames to signal parm for setting up a BA
 769 typedef struct PACKED {
 770 #ifdef RT_BIG_ENDIAN
 771     USHORT      BufSize:10;     // number of buffe of size 2304 octetsr
 772     USHORT      TID:4;  // value of TC os TS
 773     USHORT      BAPolicy:1;     // 1: immediately BA    0:delayed BA
 774     USHORT      AMSDUSupported:1;       // 0: not permitted             1: permitted
 775 #else
 776     USHORT      AMSDUSupported:1;       // 0: not permitted             1: permitted
 777     USHORT      BAPolicy:1;     // 1: immediately BA    0:delayed BA
 778     USHORT      TID:4;  // value of TC os TS
 779     USHORT      BufSize:10;     // number of buffe of size 2304 octetsr
 780 #endif /* !RT_BIG_ENDIAN */
 781 } BA_PARM, *PBA_PARM;
 782
 783 // 2-byte BA Starting Seq CONTROL field
 784 typedef union PACKED {
 785     struct PACKED {
 786 #ifdef RT_BIG_ENDIAN
 787     USHORT      StartSeq:12;   // sequence number of the 1st MSDU for which this BAR is sent
 788         USHORT      FragNum:4;  // always set to 0
 789 #else
 790     USHORT      FragNum:4;      // always set to 0
 791         USHORT      StartSeq:12;   // sequence number of the 1st MSDU for which this BAR is sent
 792 #endif /* RT_BIG_ENDIAN */
 793     }   field;
 794     USHORT           word;
 795 } BASEQ_CONTROL, *PBASEQ_CONTROL;
 796
 797 //BAControl and BARControl are the same
 798 // 2-byte BA CONTROL field in BA frame
 799 typedef struct PACKED {
 800 #ifdef RT_BIG_ENDIAN
 801     USHORT      TID:4;
 802     USHORT      Rsv:9;
 803     USHORT      Compressed:1;
 804     USHORT      MTID:1;         //EWC V1.24
 805     USHORT      ACKPolicy:1; // only related to N-Delayed BA. But not support in RT2860b. 0:NormalACK  1:No ACK
 806 #else
 807     USHORT      ACKPolicy:1; // only related to N-Delayed BA. But not support in RT2860b. 0:NormalACK  1:No ACK
 808     USHORT      MTID:1;         //EWC V1.24
 809     USHORT      Compressed:1;
 810     USHORT      Rsv:9;
 811     USHORT      TID:4;
 812 #endif /* !RT_BIG_ENDIAN */
 813 } BA_CONTROL, *PBA_CONTROL;
 814
 815 // 2-byte BAR CONTROL field in BAR frame
 816 typedef struct PACKED {
 817 #ifdef RT_BIG_ENDIAN
 818     USHORT      TID:4;
 819     USHORT      Rsv1:9;
 820     USHORT      Compressed:1;
 821     USHORT      MTID:1;         //if this bit1, use  FRAME_MTBA_REQ,  if 0, use FRAME_BA_REQ
 822     USHORT      ACKPolicy:1;
 823 #else
 824     USHORT      ACKPolicy:1; // 0:normal ack,  1:no ack.
 825     USHORT      MTID:1;         //if this bit1, use  FRAME_MTBA_REQ,  if 0, use FRAME_BA_REQ
 826     USHORT      Compressed:1;
 827     USHORT      Rsv1:9;
 828     USHORT      TID:4;
 829 #endif /* !RT_BIG_ENDIAN */
 830 } BAR_CONTROL, *PBAR_CONTROL;
 831
 832 // BARControl in MTBAR frame
 833 typedef struct PACKED {
 834 #ifdef RT_BIG_ENDIAN
 835     USHORT      NumTID:4;
 836     USHORT      Rsv1:9;
 837     USHORT      Compressed:1;
 838     USHORT      MTID:1;
 839     USHORT      ACKPolicy:1;
 840 #else
 841     USHORT      ACKPolicy:1;
 842     USHORT      MTID:1;
 843     USHORT      Compressed:1;
 844     USHORT      Rsv1:9;
 845     USHORT      NumTID:4;
 846 #endif /* !RT_BIG_ENDIAN */
 847 } MTBAR_CONTROL, *PMTBAR_CONTROL;
 848
 849 typedef struct PACKED {
 850 #ifdef RT_BIG_ENDIAN
 851     USHORT      TID:4;
 852     USHORT      Rsv1:12;
 853 #else
 854     USHORT      Rsv1:12;
 855     USHORT      TID:4;
 856 #endif /* !RT_BIG_ENDIAN */
 857 } PER_TID_INFO, *PPER_TID_INFO;
 858
 859 typedef struct {
 860         PER_TID_INFO      PerTID;
 861         BASEQ_CONTROL    BAStartingSeq;
 862 } EACH_TID, *PEACH_TID;
 863
 864
 865 typedef struct PACKED _PSPOLL_FRAME {
 866     FRAME_CONTROL   FC;
 867     USHORT          Aid;
 868     UCHAR           Bssid[MAC_ADDR_LEN];
 869     UCHAR           Ta[MAC_ADDR_LEN];
 870 }   PSPOLL_FRAME, *PPSPOLL_FRAME;
 871
 872 typedef struct  PACKED _RTS_FRAME       {
 873     FRAME_CONTROL   FC;
 874     USHORT          Duration;
 875     UCHAR           Addr1[MAC_ADDR_LEN];
 876     UCHAR           Addr2[MAC_ADDR_LEN];
 877 }RTS_FRAME, *PRTS_FRAME;
 878
 879 // BAREQ AND MTBAREQ have the same subtype BAR, 802.11n BAR use compressed bitmap.
 880 typedef struct PACKED _FRAME_BA_REQ {
 881         FRAME_CONTROL   FC;
 882         USHORT          Duration;
 883         UCHAR           Addr1[MAC_ADDR_LEN];
 884         UCHAR           Addr2[MAC_ADDR_LEN];
 885         BAR_CONTROL  BARControl;
 886         BASEQ_CONTROL    BAStartingSeq;
 887 }   FRAME_BA_REQ, *PFRAME_BA_REQ;
 888
 889 typedef struct PACKED _FRAME_MTBA_REQ {
 890         FRAME_CONTROL   FC;
 891         USHORT          Duration;
 892         UCHAR           Addr1[MAC_ADDR_LEN];
 893         UCHAR           Addr2[MAC_ADDR_LEN];
 894         MTBAR_CONTROL  MTBARControl;
 895         PER_TID_INFO    PerTIDInfo;
 896         BASEQ_CONTROL    BAStartingSeq;
 897 }   FRAME_MTBA_REQ, *PFRAME_MTBA_REQ;
 898
 899 // Compressed format is mandantory in HT STA
 900 typedef struct PACKED _FRAME_MTBA {
 901         FRAME_CONTROL   FC;
 902         USHORT          Duration;
 903         UCHAR           Addr1[MAC_ADDR_LEN];
 904         UCHAR           Addr2[MAC_ADDR_LEN];
 905         BA_CONTROL  BAControl;
 906         BASEQ_CONTROL    BAStartingSeq;
 907         UCHAR           BitMap[8];
 908 }   FRAME_MTBA, *PFRAME_MTBA;
 909
 910 typedef struct PACKED _FRAME_PSMP_ACTION {
 911         HEADER_802_11   Hdr;
 912         UCHAR   Category;
 913         UCHAR   Action;
 914         UCHAR   Psmp;   // 7.3.1.25
 915 }   FRAME_PSMP_ACTION, *PFRAME_PSMP_ACTION;
 916
 917 typedef struct PACKED _FRAME_ACTION_HDR {
 918         HEADER_802_11   Hdr;
 919         UCHAR   Category;
 920         UCHAR   Action;
 921 }   FRAME_ACTION_HDR, *PFRAME_ACTION_HDR;
 922
 923 //Action Frame
 924 //Action Frame  Category:Spectrum,  Action:Channel Switch. 7.3.2.20
 925 typedef struct PACKED _CHAN_SWITCH_ANNOUNCE {
 926         UCHAR                                   ElementID;      // ID = IE_CHANNEL_SWITCH_ANNOUNCEMENT = 37
 927         UCHAR                                   Len;
 928         CHA_SWITCH_ANNOUNCE_IE  CSAnnounceIe;
 929 }   CHAN_SWITCH_ANNOUNCE, *PCHAN_SWITCH_ANNOUNCE;
 930
 931
 932 //802.11n : 7.3.2.20a
 933 typedef struct PACKED _SECOND_CHAN_OFFSET {
 934         UCHAR                           ElementID;              // ID = IE_SECONDARY_CH_OFFSET = 62
 935         UCHAR                           Len;
 936         SEC_CHA_OFFSET_IE       SecChOffsetIe;
 937 }   SECOND_CHAN_OFFSET, *PSECOND_CHAN_OFFSET;
 938
 939
 940 typedef struct PACKED _FRAME_SPETRUM_CS {
 941         HEADER_802_11   Hdr;
 942         UCHAR   Category;
 943         UCHAR   Action;
 944         CHAN_SWITCH_ANNOUNCE    CSAnnounce;
 945         SECOND_CHAN_OFFSET              SecondChannel;
 946 }   FRAME_SPETRUM_CS, *PFRAME_SPETRUM_CS;
 947
 948
 949 typedef struct PACKED _FRAME_ADDBA_REQ {
 950         HEADER_802_11   Hdr;
 951         UCHAR   Category;
 952         UCHAR   Action;
 953         UCHAR   Token;  // 1
 954         BA_PARM         BaParm;       //  2 - 10
 955         USHORT          TimeOutValue;   // 0 - 0
 956         BASEQ_CONTROL   BaStartSeq; // 0-0
 957 }   FRAME_ADDBA_REQ, *PFRAME_ADDBA_REQ;
 958
 959 typedef struct PACKED _FRAME_ADDBA_RSP {
 960         HEADER_802_11   Hdr;
 961         UCHAR   Category;
 962         UCHAR   Action;
 963         UCHAR   Token;
 964         USHORT  StatusCode;
 965         BA_PARM         BaParm; //0 - 2
 966         USHORT          TimeOutValue;
 967 }   FRAME_ADDBA_RSP, *PFRAME_ADDBA_RSP;
 968
 969 typedef struct PACKED _FRAME_DELBA_REQ {
 970         HEADER_802_11   Hdr;
 971         UCHAR   Category;
 972         UCHAR   Action;
 973         DELBA_PARM              DelbaParm;
 974         USHORT  ReasonCode;
 975 }   FRAME_DELBA_REQ, *PFRAME_DELBA_REQ;
 976
 977
 978 //7.2.1.7
 979 typedef struct PACKED _FRAME_BAR {
 980         FRAME_CONTROL   FC;
 981         USHORT          Duration;
 982         UCHAR           Addr1[MAC_ADDR_LEN];
 983         UCHAR           Addr2[MAC_ADDR_LEN];
 984         BAR_CONTROL             BarControl;
 985         BASEQ_CONTROL   StartingSeq;
 986 }   FRAME_BAR, *PFRAME_BAR;
 987
 988 //7.2.1.7
 989 typedef struct PACKED _FRAME_BA {
 990         FRAME_CONTROL   FC;
 991         USHORT          Duration;
 992         UCHAR           Addr1[MAC_ADDR_LEN];
 993         UCHAR           Addr2[MAC_ADDR_LEN];
 994         BAR_CONTROL             BarControl;
 995         BASEQ_CONTROL   StartingSeq;
 996         UCHAR           bitmask[8];
 997 }   FRAME_BA, *PFRAME_BA;
 998
 999
1000 // Radio Measuement Request Frame Format
1001 typedef struct PACKED _FRAME_RM_REQ_ACTION {
1002         HEADER_802_11   Hdr;
1003         UCHAR   Category;
1004         UCHAR   Action;
1005         UCHAR   Token;
1006         USHORT  Repetition;
1007         UCHAR   data[0];
1008 }   FRAME_RM_REQ_ACTION, *PFRAME_RM_REQ_ACTION;
1009
1010 typedef struct PACKED {
1011         UCHAR           ID;
1012         UCHAR           Length;
1013         UCHAR           ChannelSwitchMode;
1014         UCHAR           NewRegClass;
1015         UCHAR           NewChannelNum;
1016         UCHAR           ChannelSwitchCount;
1017 } HT_EXT_CHANNEL_SWITCH_ANNOUNCEMENT_IE, *PHT_EXT_CHANNEL_SWITCH_ANNOUNCEMENT_IE;
1018
1019
1020 //
1021 // _Limit must be the 2**n - 1
1022 // _SEQ1 , _SEQ2 must be within 0 ~ _Limit
1023 //
1024 #define SEQ_STEPONE(_SEQ1, _SEQ2, _Limit)       ((_SEQ1 == ((_SEQ2+1) & _Limit)))
1025 #define SEQ_SMALLER(_SEQ1, _SEQ2, _Limit)       (((_SEQ1-_SEQ2) & ((_Limit+1)>>1)))
1026 #define SEQ_LARGER(_SEQ1, _SEQ2, _Limit)        ((_SEQ1 != _SEQ2) && !(((_SEQ1-_SEQ2) & ((_Limit+1)>>1))))
1027 #define SEQ_WITHIN_WIN(_SEQ1, _SEQ2, _WIN, _Limit) (SEQ_LARGER(_SEQ1, _SEQ2, _Limit) &&  \
1028                                                                                                 SEQ_SMALLER(_SEQ1, ((_SEQ2+_WIN+1)&_Limit), _Limit))
1029
1030 //
1031 // Contention-free parameter (without ID and Length)
1032 //
1033 typedef struct PACKED {
1034     BOOLEAN     bValid;         // 1: variable contains valid value
1035     UCHAR       CfpCount;
1036     UCHAR       CfpPeriod;
1037     USHORT      CfpMaxDuration;
1038     USHORT      CfpDurRemaining;
1039 } CF_PARM, *PCF_PARM;
1040
1041 typedef struct  _CIPHER_SUITE   {
1042         NDIS_802_11_ENCRYPTION_STATUS   PairCipher;             // Unicast cipher 1, this one has more secured cipher suite
1043         NDIS_802_11_ENCRYPTION_STATUS   PairCipherAux;  // Unicast cipher 2 if AP announce two unicast cipher suite
1044         NDIS_802_11_ENCRYPTION_STATUS   GroupCipher;    // Group cipher
1045         USHORT                                                  RsnCapability;  // RSN capability from beacon
1046         BOOLEAN                                                 bMixMode;               // Indicate Pair & Group cipher might be different
1047 }       CIPHER_SUITE, *PCIPHER_SUITE;
1048
1049 // EDCA configuration from AP's BEACON/ProbeRsp
1050 typedef struct {
1051     BOOLEAN     bValid;         // 1: variable contains valid value
1052     BOOLEAN     bAdd;         // 1: variable contains valid value
1053     BOOLEAN     bQAck;
1054     BOOLEAN     bQueueRequest;
1055     BOOLEAN     bTxopRequest;
1056     BOOLEAN     bAPSDCapable;
1057 //  BOOLEAN     bMoreDataAck;
1058     UCHAR       EdcaUpdateCount;
1059     UCHAR       Aifsn[4];       // 0:AC_BK, 1:AC_BE, 2:AC_VI, 3:AC_VO
1060     UCHAR       Cwmin[4];
1061     UCHAR       Cwmax[4];
1062     USHORT      Txop[4];      // in unit of 32-us
1063     BOOLEAN     bACM[4];      // 1: Admission Control of AC_BK is mandattory
1064 } EDCA_PARM, *PEDCA_PARM;
1065
1066 // QBSS LOAD information from QAP's BEACON/ProbeRsp
1067 typedef struct {
1068     BOOLEAN     bValid;                     // 1: variable contains valid value
1069     USHORT      StaNum;
1070     UCHAR       ChannelUtilization;
1071     USHORT      RemainingAdmissionControl;  // in unit of 32-us
1072 } QBSS_LOAD_PARM, *PQBSS_LOAD_PARM;
1073
1074 // QBSS Info field in QSTA's assoc req
1075 typedef struct PACKED {
1076 #ifdef RT_BIG_ENDIAN
1077         UCHAR           Rsv2:1;
1078         UCHAR           MaxSPLength:2;
1079         UCHAR           Rsv1:1;
1080         UCHAR           UAPSD_AC_BE:1;
1081         UCHAR           UAPSD_AC_BK:1;
1082         UCHAR           UAPSD_AC_VI:1;
1083         UCHAR           UAPSD_AC_VO:1;
1084 #else
1085     UCHAR               UAPSD_AC_VO:1;
1086         UCHAR           UAPSD_AC_VI:1;
1087         UCHAR           UAPSD_AC_BK:1;
1088         UCHAR           UAPSD_AC_BE:1;
1089         UCHAR           Rsv1:1;
1090         UCHAR           MaxSPLength:2;
1091         UCHAR           Rsv2:1;
1092 #endif /* !RT_BIG_ENDIAN */
1093 } QBSS_STA_INFO_PARM, *PQBSS_STA_INFO_PARM;
1094
1095 // QBSS Info field in QAP's Beacon/ProbeRsp
1096 typedef struct PACKED {
1097 #ifdef RT_BIG_ENDIAN
1098         UCHAR           UAPSD:1;
1099         UCHAR           Rsv:3;
1100     UCHAR               ParamSetCount:4;
1101 #else
1102     UCHAR               ParamSetCount:4;
1103         UCHAR           Rsv:3;
1104         UCHAR           UAPSD:1;
1105 #endif /* !RT_BIG_ENDIAN */
1106 } QBSS_AP_INFO_PARM, *PQBSS_AP_INFO_PARM;
1107
1108 // QOS Capability reported in QAP's BEACON/ProbeRsp
1109 // QOS Capability sent out in QSTA's AssociateReq/ReAssociateReq
1110 typedef struct {
1111     BOOLEAN     bValid;                     // 1: variable contains valid value
1112     BOOLEAN     bQAck;
1113     BOOLEAN     bQueueRequest;
1114     BOOLEAN     bTxopRequest;
1115 //  BOOLEAN     bMoreDataAck;
1116     UCHAR       EdcaUpdateCount;
1117 } QOS_CAPABILITY_PARM, *PQOS_CAPABILITY_PARM;
1118
1119 #ifdef CONFIG_STA_SUPPORT
1120 typedef struct {
1121     UCHAR       IELen;
1122     UCHAR       IE[MAX_CUSTOM_LEN];
1123 } WPA_IE_;
1124 #endif // CONFIG_STA_SUPPORT //
1125
1126
1127 typedef struct {
1128     UCHAR   Bssid[MAC_ADDR_LEN];
1129     UCHAR   Channel;
1130         UCHAR   CentralChannel; //Store the wide-band central channel for 40MHz.  .used in 40MHz AP. Or this is the same as Channel.
1131     UCHAR   BssType;
1132     USHORT  AtimWin;
1133     USHORT  BeaconPeriod;
1134
1135     UCHAR   SupRate[MAX_LEN_OF_SUPPORTED_RATES];
1136     UCHAR   SupRateLen;
1137     UCHAR   ExtRate[MAX_LEN_OF_SUPPORTED_RATES];
1138     UCHAR   ExtRateLen;
1139         HT_CAPABILITY_IE HtCapability;
1140         UCHAR                   HtCapabilityLen;
1141         ADD_HT_INFO_IE AddHtInfo;       // AP might use this additional ht info IE
1142         UCHAR                   AddHtInfoLen;
1143         UCHAR                   NewExtChanOffset;
1144         CHAR    Rssi;
1145     UCHAR   Privacy;                    // Indicate security function ON/OFF. Don't mess up with auth mode.
1146         UCHAR   Hidden;
1147
1148     USHORT  DtimPeriod;
1149     USHORT  CapabilityInfo;
1150
1151     USHORT  CfpCount;
1152     USHORT  CfpPeriod;
1153     USHORT  CfpMaxDuration;
1154     USHORT  CfpDurRemaining;
1155     UCHAR   SsidLen;
1156     CHAR    Ssid[MAX_LEN_OF_SSID];
1157
1158     ULONG   LastBeaconRxTime; // OS's timestamp
1159
1160         BOOLEAN bSES;
1161
1162         // New for WPA2
1163         CIPHER_SUITE                                    WPA;                    // AP announced WPA cipher suite
1164         CIPHER_SUITE                                    WPA2;                   // AP announced WPA2 cipher suite
1165
1166         // New for microsoft WPA support
1167         NDIS_802_11_FIXED_IEs   FixIEs;
1168         NDIS_802_11_AUTHENTICATION_MODE AuthModeAux;    // Addition mode for WPA2 / WPA capable AP
1169         NDIS_802_11_AUTHENTICATION_MODE AuthMode;
1170         NDIS_802_11_WEP_STATUS  WepStatus;                              // Unicast Encryption Algorithm extract from VAR_IE
1171         USHORT                                  VarIELen;                               // Length of next VIE include EID & Length
1172         UCHAR                                   VarIEs[MAX_VIE_LEN];
1173
1174         // CCX Ckip information
1175     UCHAR   CkipFlag;
1176
1177         // CCX 2 TSF
1178         UCHAR   PTSF[4];                // Parent TSF
1179         UCHAR   TTSF[8];                // Target TSF
1180
1181     // 802.11e d9, and WMM
1182         EDCA_PARM           EdcaParm;
1183         QOS_CAPABILITY_PARM QosCapability;
1184         QBSS_LOAD_PARM      QbssLoad;
1185 #ifdef CONFIG_STA_SUPPORT
1186     WPA_IE_     WpaIE;
1187     WPA_IE_     RsnIE;
1188 #endif // CONFIG_STA_SUPPORT //
1189 } BSS_ENTRY, *PBSS_ENTRY;
1190
1191 typedef struct {
1192     UCHAR           BssNr;
1193     UCHAR           BssOverlapNr;
1194     BSS_ENTRY       BssEntry[MAX_LEN_OF_BSS_TABLE];
1195 } BSS_TABLE, *PBSS_TABLE;
1196
1197
1198 typedef struct _MLME_QUEUE_ELEM {
1199     ULONG             Machine;
1200     ULONG             MsgType;
1201     ULONG             MsgLen;
1202     UCHAR             Msg[MGMT_DMA_BUFFER_SIZE];
1203     LARGE_INTEGER     TimeStamp;
1204     UCHAR             Rssi0;
1205     UCHAR             Rssi1;
1206     UCHAR             Rssi2;
1207     UCHAR             Signal;
1208     UCHAR             Channel;
1209     UCHAR             Wcid;
1210     BOOLEAN           Occupied;
1211 } MLME_QUEUE_ELEM, *PMLME_QUEUE_ELEM;
1212
1213 typedef struct _MLME_QUEUE {
1214     ULONG             Num;
1215     ULONG             Head;
1216     ULONG             Tail;
1217     NDIS_SPIN_LOCK   Lock;
1218     MLME_QUEUE_ELEM  Entry[MAX_LEN_OF_MLME_QUEUE];
1219 } MLME_QUEUE, *PMLME_QUEUE;
1220
1221 typedef VOID (*STATE_MACHINE_FUNC)(VOID *Adaptor, MLME_QUEUE_ELEM *Elem);
1222
1223 typedef struct _STATE_MACHINE {
1224     ULONG                           Base;
1225     ULONG                           NrState;
1226     ULONG                           NrMsg;
1227     ULONG                           CurrState;
1228     STATE_MACHINE_FUNC             *TransFunc;
1229 } STATE_MACHINE, *PSTATE_MACHINE;
1230
1231
1232 // MLME AUX data structure that hold temporarliy settings during a connection attempt.
1233 // Once this attemp succeeds, all settings will be copy to pAd->StaActive.
1234 // A connection attempt (user set OID, roaming, CCX fast roaming,..) consists of
1235 // several steps (JOIN, AUTH, ASSOC or REASSOC) and may fail at any step. We purposely
1236 // separate this under-trial settings away from pAd->StaActive so that once
1237 // this new attempt failed, driver can auto-recover back to the active settings.
1238 typedef struct _MLME_AUX {
1239     UCHAR               BssType;
1240     UCHAR               Ssid[MAX_LEN_OF_SSID];
1241     UCHAR               SsidLen;
1242     UCHAR               Bssid[MAC_ADDR_LEN];
1243         UCHAR                           AutoReconnectSsid[MAX_LEN_OF_SSID];
1244         UCHAR                           AutoReconnectSsidLen;
1245     USHORT              Alg;
1246     UCHAR               ScanType;
1247     UCHAR               Channel;
1248         UCHAR               CentralChannel;
1249     USHORT              Aid;
1250     USHORT              CapabilityInfo;
1251     USHORT              BeaconPeriod;
1252     USHORT              CfpMaxDuration;
1253     USHORT              CfpPeriod;
1254     USHORT              AtimWin;
1255
1256         // Copy supported rate from desired AP's beacon. We are trying to match
1257         // AP's supported and extended rate settings.
1258         UCHAR                   SupRate[MAX_LEN_OF_SUPPORTED_RATES];
1259         UCHAR                   ExtRate[MAX_LEN_OF_SUPPORTED_RATES];
1260         UCHAR                   SupRateLen;
1261         UCHAR                   ExtRateLen;
1262         HT_CAPABILITY_IE                HtCapability;
1263         UCHAR                           HtCapabilityLen;
1264         ADD_HT_INFO_IE          AddHtInfo;      // AP might use this additional ht info IE
1265         UCHAR                   NewExtChannelOffset;
1266         //RT_HT_CAPABILITY      SupportedHtPhy;
1267
1268     // new for QOS
1269     QOS_CAPABILITY_PARM APQosCapability;    // QOS capability of the current associated AP
1270     EDCA_PARM           APEdcaParm;         // EDCA parameters of the current associated AP
1271     QBSS_LOAD_PARM      APQbssLoad;         // QBSS load of the current associated AP
1272
1273     // new to keep Ralink specific feature
1274     ULONG               APRalinkIe;
1275
1276     BSS_TABLE           SsidBssTab;     // AP list for the same SSID
1277     BSS_TABLE           RoamTab;        // AP list eligible for roaming
1278     ULONG               BssIdx;
1279     ULONG               RoamIdx;
1280
1281         BOOLEAN                         CurrReqIsFromNdis;
1282
1283     RALINK_TIMER_STRUCT BeaconTimer, ScanTimer;
1284     RALINK_TIMER_STRUCT AuthTimer;
1285     RALINK_TIMER_STRUCT AssocTimer, ReassocTimer, DisassocTimer;
1286 } MLME_AUX, *PMLME_AUX;
1287
1288 typedef struct _MLME_ADDBA_REQ_STRUCT{
1289         UCHAR   Wcid;   //
1290         UCHAR   pAddr[MAC_ADDR_LEN];
1291         UCHAR   BaBufSize;
1292         USHORT  TimeOutValue;
1293         UCHAR   TID;
1294         UCHAR   Token;
1295         USHORT  BaStartSeq;
1296 } MLME_ADDBA_REQ_STRUCT, *PMLME_ADDBA_REQ_STRUCT;
1297
1298
1299 typedef struct _MLME_DELBA_REQ_STRUCT{
1300         UCHAR   Wcid;   //
1301         UCHAR     Addr[MAC_ADDR_LEN];
1302         UCHAR   TID;
1303         UCHAR   Initiator;
1304 } MLME_DELBA_REQ_STRUCT, *PMLME_DELBA_REQ_STRUCT;
1305
1306 // assoc struct is equal to reassoc
1307 typedef struct _MLME_ASSOC_REQ_STRUCT{
1308     UCHAR     Addr[MAC_ADDR_LEN];
1309     USHORT    CapabilityInfo;
1310     USHORT    ListenIntv;
1311     ULONG     Timeout;
1312 } MLME_ASSOC_REQ_STRUCT, *PMLME_ASSOC_REQ_STRUCT, MLME_REASSOC_REQ_STRUCT, *PMLME_REASSOC_REQ_STRUCT;
1313
1314 typedef struct _MLME_DISASSOC_REQ_STRUCT{
1315     UCHAR     Addr[MAC_ADDR_LEN];
1316     USHORT    Reason;
1317 } MLME_DISASSOC_REQ_STRUCT, *PMLME_DISASSOC_REQ_STRUCT;
1318
1319 typedef struct _MLME_AUTH_REQ_STRUCT {
1320     UCHAR        Addr[MAC_ADDR_LEN];
1321     USHORT       Alg;
1322     ULONG        Timeout;
1323 } MLME_AUTH_REQ_STRUCT, *PMLME_AUTH_REQ_STRUCT;
1324
1325 typedef struct _MLME_DEAUTH_REQ_STRUCT {
1326     UCHAR        Addr[MAC_ADDR_LEN];
1327     USHORT       Reason;
1328 } MLME_DEAUTH_REQ_STRUCT, *PMLME_DEAUTH_REQ_STRUCT;
1329
1330 typedef struct {
1331     ULONG      BssIdx;
1332 } MLME_JOIN_REQ_STRUCT;
1333
1334 typedef struct _MLME_SCAN_REQ_STRUCT {
1335     UCHAR      Bssid[MAC_ADDR_LEN];
1336     UCHAR      BssType;
1337     UCHAR      ScanType;
1338     UCHAR      SsidLen;
1339     CHAR       Ssid[MAX_LEN_OF_SSID];
1340 } MLME_SCAN_REQ_STRUCT, *PMLME_SCAN_REQ_STRUCT;
1341
1342 typedef struct _MLME_START_REQ_STRUCT {
1343     CHAR        Ssid[MAX_LEN_OF_SSID];
1344     UCHAR       SsidLen;
1345 } MLME_START_REQ_STRUCT, *PMLME_START_REQ_STRUCT;
1346
1347 typedef struct PACKED {
1348     UCHAR   Eid;
1349     UCHAR   Len;
1350     CHAR   Octet[1];
1351 } EID_STRUCT,*PEID_STRUCT, BEACON_EID_STRUCT, *PBEACON_EID_STRUCT;
1352
1353 typedef struct PACKED _RTMP_TX_RATE_SWITCH
1354 {
1355         UCHAR   ItemNo;
1356 #ifdef RT_BIG_ENDIAN
1357         UCHAR   Rsv2:2;
1358         UCHAR   Mode:2;
1359         UCHAR   Rsv1:1;
1360         UCHAR   BW:1;
1361         UCHAR   ShortGI:1;
1362         UCHAR   STBC:1;
1363 #else
1364         UCHAR   STBC:1;
1365         UCHAR   ShortGI:1;
1366         UCHAR   BW:1;
1367         UCHAR   Rsv1:1;
1368         UCHAR   Mode:2;
1369         UCHAR   Rsv2:2;
1370 #endif
1371         UCHAR   CurrMCS;
1372         UCHAR   TrainUp;
1373         UCHAR   TrainDown;
1374 } RRTMP_TX_RATE_SWITCH, *PRTMP_TX_RATE_SWITCH;
1375
1376 // ========================== AP mlme.h ===============================
1377 #define TBTT_PRELOAD_TIME       384        // usec. LomgPreamble + 24-byte at 1Mbps
1378 #define DEFAULT_DTIM_PERIOD     1
1379
1380 // weighting factor to calculate Channel quality, total should be 100%
1381 //#define RSSI_WEIGHTING                   0
1382 //#define TX_WEIGHTING                     40
1383 //#define RX_WEIGHTING                     60
1384
1385 #define MAC_TABLE_AGEOUT_TIME                   300                     // unit: sec
1386 #define MAC_TABLE_ASSOC_TIMEOUT                 5                       // unit: sec
1387 #define MAC_TABLE_FULL(Tab)                             ((Tab).size == MAX_LEN_OF_MAC_TABLE)
1388
1389 // AP shall drop the sta if contine Tx fail count reach it.
1390 #define MAC_ENTRY_LIFE_CHECK_CNT                20                      // packet cnt.
1391
1392 // Value domain of pMacEntry->Sst
1393 typedef enum _Sst {
1394     SST_NOT_AUTH,   // 0: equivalent to IEEE 802.11/1999 state 1
1395     SST_AUTH,       // 1: equivalent to IEEE 802.11/1999 state 2
1396     SST_ASSOC       // 2: equivalent to IEEE 802.11/1999 state 3
1397 } SST;
1398
1399 // value domain of pMacEntry->AuthState
1400 typedef enum _AuthState {
1401     AS_NOT_AUTH,
1402     AS_AUTH_OPEN,       // STA has been authenticated using OPEN SYSTEM
1403     AS_AUTH_KEY,        // STA has been authenticated using SHARED KEY
1404     AS_AUTHENTICATING   // STA is waiting for AUTH seq#3 using SHARED KEY
1405 } AUTH_STATE;
1406
1407 //for-wpa value domain of pMacEntry->WpaState  802.1i D3   p.114
1408 typedef enum _ApWpaState {
1409     AS_NOTUSE,              // 0
1410     AS_DISCONNECT,          // 1
1411     AS_DISCONNECTED,        // 2
1412     AS_INITIALIZE,          // 3
1413     AS_AUTHENTICATION,      // 4
1414     AS_AUTHENTICATION2,     // 5
1415     AS_INITPMK,             // 6
1416     AS_INITPSK,             // 7
1417     AS_PTKSTART,            // 8
1418     AS_PTKINIT_NEGOTIATING, // 9
1419     AS_PTKINITDONE,         // 10
1420     AS_UPDATEKEYS,          // 11
1421     AS_INTEGRITY_FAILURE,   // 12
1422     AS_KEYUPDATE,           // 13
1423 } AP_WPA_STATE;
1424
1425 // for-wpa value domain of pMacEntry->WpaState  802.1i D3   p.114
1426 typedef enum _GTKState {
1427     REKEY_NEGOTIATING,
1428     REKEY_ESTABLISHED,
1429     KEYERROR,
1430 } GTK_STATE;
1431
1432 //  for-wpa  value domain of pMacEntry->WpaState  802.1i D3   p.114
1433 typedef enum _WpaGTKState {
1434     SETKEYS,
1435     SETKEYS_DONE,
1436 } WPA_GTK_STATE;
1437 // ====================== end of AP mlme.h ============================
1438
1439
1440 #endif  // MLME_H__