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