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