2 *************************************************************************
4 * 5F., No.36, Taiyuan St., Jhubei City,
8 * (c) Copyright 2002-2007, Ralink Technology, Inc.
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. *
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. *
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. *
25 *************************************************************************
34 -------- ---------- ------------------------------
35 John Chang 2003-08-28 Created
36 John Chang 2004-09-06 modified for RT2600
37 Justin P. Mattock 11/07/2010 Fix typos in comments
43 #include "rtmp_dot11.h"
45 /* maximum supported capability information */
46 /* ESS, IBSS, Privacy, Short Preamble, Spectrum mgmt, Short Slot */
47 #define SUPPORTED_CAPABILITY_INFO 0x0533
49 #define END_OF_ARGS -1
50 #define LFSR_MASK 0x80000057
51 #define MLME_TASK_EXEC_INTV 100/*200*/ /* */
53 #define MLME_TASK_EXEC_MULTIPLE 10 /*5*/ /* MLME_TASK_EXEC_MULTIPLE * MLME_TASK_EXEC_INTV = 1 sec */
54 #define REORDER_EXEC_INTV 100 /* 0.1 sec */
56 /* The definition of Radar detection duration region */
62 #define MAX_RD_REGION 5
64 #define BEACON_LOST_TIME (4 * OS_HZ) /* 2048 msec = 2 sec */
66 #define DLS_TIMEOUT 1200 /* unit: msec */
67 #define AUTH_TIMEOUT 300 /* unit: msec */
68 #define ASSOC_TIMEOUT 300 /* unit: msec */
69 #define JOIN_TIMEOUT 2000 /* unit: msec */
70 #define SHORT_CHANNEL_TIME 90 /* unit: msec */
71 #define MIN_CHANNEL_TIME 110 /* unit: msec, for dual band scan */
72 #define MAX_CHANNEL_TIME 140 /* unit: msec, for single band scan */
73 #define FAST_ACTIVE_SCAN_TIME 30 /* Active scan waiting for probe response time */
74 #define CW_MIN_IN_BITS 4 /* actual CwMin = 2^CW_MIN_IN_BITS - 1 */
75 #define LINK_DOWN_TIMEOUT 20000 /* unit: msec */
76 #define AUTO_WAKEUP_TIMEOUT 70 /*unit: msec */
78 #define CW_MAX_IN_BITS 10 /* actual CwMax = 2^CW_MAX_IN_BITS - 1 */
80 /* Note: RSSI_TO_DBM_OFFSET has been changed to variable for new RF (2004-0720). */
81 /* Should not refer to this constant anymore */
82 /*#define RSSI_TO_DBM_OFFSET 120 // for RT2530 RSSI-115 = dBm */
83 #define RSSI_FOR_MID_TX_POWER -55 /* -55 db is considered mid-distance */
84 #define RSSI_FOR_LOW_TX_POWER -45 /* -45 db is considered very short distance and */
85 /* eligible to use a lower TX power */
86 #define RSSI_FOR_LOWEST_TX_POWER -30
87 /*#define MID_TX_POWER_DELTA 0 // 0 db from full TX power upon mid-distance to AP */
88 #define LOW_TX_POWER_DELTA 6 /* -3 db from full TX power upon very short distance. 1 grade is 0.5 db */
89 #define LOWEST_TX_POWER_DELTA 16 /* -8 db from full TX power upon shortest distance. 1 grade is 0.5 db */
91 #define RSSI_TRIGGERED_UPON_BELOW_THRESHOLD 0
92 #define RSSI_TRIGGERED_UPON_EXCCEED_THRESHOLD 1
93 #define RSSI_THRESHOLD_FOR_ROAMING 25
96 /* Channel Quality Indication */
97 #define CQI_IS_GOOD(cqi) ((cqi) >= 50)
98 /*#define CQI_IS_FAIR(cqi) (((cqi) >= 20) && ((cqi) < 50)) */
99 #define CQI_IS_POOR(cqi) (cqi < 50) /*(((cqi) >= 5) && ((cqi) < 20)) */
100 #define CQI_IS_BAD(cqi) (cqi < 5)
101 #define CQI_IS_DEAD(cqi) (cqi == 0)
103 /* weighting factor to calculate Channel quality, total should be 100% */
104 #define RSSI_WEIGHTING 50
105 #define TX_WEIGHTING 30
106 #define RX_WEIGHTING 20
108 #define BSS_NOT_FOUND 0xFFFFFFFF
110 #define MAX_LEN_OF_MLME_QUEUE 40 /*10 */
112 #define SCAN_PASSIVE 18 /* scan with no probe request, only wait beacon and probe response */
113 #define SCAN_ACTIVE 19 /* scan with probe request, and wait beacon and probe response */
114 #define SCAN_CISCO_PASSIVE 20 /* Single channel passive scan */
115 #define SCAN_CISCO_ACTIVE 21 /* Single channel active scan */
116 #define SCAN_CISCO_NOISE 22 /* Single channel passive scan for noise histogram collection */
117 #define SCAN_CISCO_CHANNEL_LOAD 23 /* Single channel passive scan for channel load collection */
118 #define FAST_SCAN_ACTIVE 24 /* scan with probe request, and wait beacon and probe response */
120 #define MAC_ADDR_IS_GROUP(Addr) (((Addr[0]) & 0x01))
121 #define MAC_ADDR_HASH(Addr) (Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
122 #define MAC_ADDR_HASH_INDEX(Addr) (MAC_ADDR_HASH(Addr) % HASH_TABLE_SIZE)
123 #define TID_MAC_HASH(Addr, TID) (TID^Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
124 #define TID_MAC_HASH_INDEX(Addr, TID) (TID_MAC_HASH(Addr, TID) % HASH_TABLE_SIZE)
127 /* association ON. one LED ON. another blinking when TX, OFF when idle */
128 /* no association, both LED off */
129 #define ASIC_LED_ACT_ON(pAd) RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00031e46)
130 #define ASIC_LED_ACT_OFF(pAd) RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00001e46)
132 /* bit definition of the 2-byte pBEACON->Capability field */
133 #define CAP_IS_ESS_ON(x) (((x) & 0x0001) != 0)
134 #define CAP_IS_IBSS_ON(x) (((x) & 0x0002) != 0)
135 #define CAP_IS_CF_POLLABLE_ON(x) (((x) & 0x0004) != 0)
136 #define CAP_IS_CF_POLL_REQ_ON(x) (((x) & 0x0008) != 0)
137 #define CAP_IS_PRIVACY_ON(x) (((x) & 0x0010) != 0)
138 #define CAP_IS_SHORT_PREAMBLE_ON(x) (((x) & 0x0020) != 0)
139 #define CAP_IS_PBCC_ON(x) (((x) & 0x0040) != 0)
140 #define CAP_IS_AGILITY_ON(x) (((x) & 0x0080) != 0)
141 #define CAP_IS_SPECTRUM_MGMT(x) (((x) & 0x0100) != 0) /* 802.11e d9 */
142 #define CAP_IS_QOS(x) (((x) & 0x0200) != 0) /* 802.11e d9 */
143 #define CAP_IS_SHORT_SLOT(x) (((x) & 0x0400) != 0)
144 #define CAP_IS_APSD(x) (((x) & 0x0800) != 0) /* 802.11e d9 */
145 #define CAP_IS_IMMED_BA(x) (((x) & 0x1000) != 0) /* 802.11e d9 */
146 #define CAP_IS_DSSS_OFDM(x) (((x) & 0x2000) != 0)
147 #define CAP_IS_DELAY_BA(x) (((x) & 0x4000) != 0) /* 802.11e d9 */
149 #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))
151 #define ERP_IS_NON_ERP_PRESENT(x) (((x) & 0x01) != 0) /* 802.11g */
152 #define ERP_IS_USE_PROTECTION(x) (((x) & 0x02) != 0) /* 802.11g */
153 #define ERP_IS_USE_BARKER_PREAMBLE(x) (((x) & 0x04) != 0) /* 802.11g */
155 #define DRS_TX_QUALITY_WORST_BOUND 8 /* 3 // just test by gary */
156 #define DRS_PENALTY 8
159 /*BA Policy subfiled value in ADDBA frame */
163 /* BA Initiator subfield in DELBA frame */
167 /* ADDBA Status Code */
168 #define ADDBA_RESULTCODE_SUCCESS 0
169 #define ADDBA_RESULTCODE_REFUSED 37
170 #define ADDBA_RESULTCODE_INVALID_PARAMETERS 38
172 /* DELBA Reason Code */
173 #define DELBA_REASONCODE_QSTA_LEAVING 36
174 #define DELBA_REASONCODE_END_BA 37
175 #define DELBA_REASONCODE_UNKNOWN_BA 38
176 #define DELBA_REASONCODE_TIMEOUT 39
178 /* reset all OneSecTx counters */
179 #define RESET_ONE_SEC_TX_CNT(__pEntry) \
180 if (((__pEntry)) != NULL) { \
181 (__pEntry)->OneSecTxRetryOkCount = 0; \
182 (__pEntry)->OneSecTxFailCount = 0; \
183 (__pEntry)->OneSecTxNoRetryOkCount = 0; \
187 /* 802.11 frame formats */
189 /* HT Capability INFO field in HT Cap IE . */
190 struct PACKED rt_ht_cap_info
{
193 u16 MimoPs
:2; /*momi power safe */
194 u16 GF
:1; /*green field */
196 u16 ShortGIfor40
:1; /*for40MHz */
199 u16 DelayedBA
:1; /*rt2860c not support */
200 u16 AMsduSize
:1; /* only support as zero */
203 u16 Forty_Mhz_Intolerant
:1;
204 u16 LSIGTxopProSup
:1;
207 /* HT Capability INFO field in HT Cap IE . */
208 struct PACKED rt_ht_cap_parm
{
209 u8 MaxRAmpduFactor
:2;
211 u8 rsv
:3; /*momi power safe */
214 /* HT Capability INFO field in HT Cap IE . */
215 struct PACKED rt_ht_mcs_set
{
217 u8 SupRate
[2]; /* unit : 1Mbps */
218 u8 TxMCSSetDefined
:1;
226 /* HT Capability INFO field in HT Cap IE . */
227 struct PACKED rt_ext_ht_cap_info
{
230 u16 rsv
:5; /*momi power safe */
231 u16 MCSFeedback
:2; /*0:no MCS feedback, 2:unsolicited MCS feedback, 3:Full MCS feedback, 1:rsv. */
232 u16 PlusHTC
:1; /*+HTC control field support */
233 u16 RDGSupport
:1; /*reverse Direction Grant support */
237 /* HT Beamforming field in HT Cap IE . */
238 struct PACKED rt_ht_bf_cap
{
239 unsigned long TxBFRecCapable
:1;
240 unsigned long RxSoundCapable
:1;
241 unsigned long TxSoundCapable
:1;
242 unsigned long RxNDPCapable
:1;
243 unsigned long TxNDPCapable
:1;
244 unsigned long ImpTxBFCapable
:1;
245 unsigned long Calibration
:2;
246 unsigned long ExpCSICapable
:1;
247 unsigned long ExpNoComSteerCapable
:1;
248 unsigned long ExpComSteerCapable
:1;
249 unsigned long ExpCSIFbk
:2;
250 unsigned long ExpNoComBF
:2;
251 unsigned long ExpComBF
:2;
252 unsigned long MinGrouping
:2;
253 unsigned long CSIBFAntSup
:2;
254 unsigned long NoComSteerBFAntSup
:2;
255 unsigned long ComSteerBFAntSup
:2;
256 unsigned long CSIRowBFSup
:2;
257 unsigned long ChanEstimation
:2;
261 /* HT antenna selection field in HT Cap IE . */
262 struct PACKED rt_ht_as_cap
{
264 u8 ExpCSIFbkTxASEL
:1;
265 u8 AntIndFbkTxASEL
:1;
273 /* Draft 1.0 set IE length 26, but is extensible.. */
274 #define SIZE_HT_CAP_IE 26
275 /* The structure for HT Capability IE. */
276 struct PACKED rt_ht_capability_ie
{
277 struct rt_ht_cap_info HtCapInfo
;
278 struct rt_ht_cap_parm HtCapParm
;
279 /* struct rt_ht_mcs_set HtMCSSet; */
281 struct rt_ext_ht_cap_info ExtHtCapInfo
;
282 struct rt_ht_bf_cap TxBFCap
; /* beamforming cap. rt2860c not support beamforming. */
283 struct rt_ht_as_cap ASCap
; /*antenna selection. */
286 /* 802.11n draft3 related structure definitions. */
288 #define dot11OBSSScanPassiveDwell 20 /* in TU. min amount of time that the STA continuously scans each channel when performing an active OBSS scan. */
289 #define dot11OBSSScanActiveDwell 10 /* in TU.min amount of time that the STA continuously scans each channel when performing an passive OBSS scan. */
290 #define dot11BSSWidthTriggerScanInterval 300 /* in sec. max interval between scan operations to be performed to detect BSS channel width trigger events. */
291 #define dot11OBSSScanPassiveTotalPerChannel 200 /* in TU. min total amount of time that the STA scans each channel when performing a passive OBSS scan. */
292 #define dot11OBSSScanActiveTotalPerChannel 20 /*in TU. min total amount of time that the STA scans each channel when performing a active OBSS scan */
293 #define dot11BSSWidthChannelTransactionDelayFactor 5 /* min ratio between the delay time in performing a switch from 20MHz BSS to 20/40 BSS operation and the maximum */
294 /* interval between overlapping BSS scan operations. */
295 #define dot11BSSScanActivityThreshold 25 /* in %%, max total time that a STA may be active on the medium during a period of */
296 /* (dot11BSSWidthChannelTransactionDelayFactor * dot11BSSWidthTriggerScanInterval) seconds without */
297 /* being obligated to perform OBSS Scan operations. default is 25(== 0.25%) */
299 struct PACKED rt_overlap_bss_scan_ie
{
300 u16 ScanPassiveDwell
;
302 u16 TriggerScanInt
; /* Trigger scan interval */
303 u16 PassiveTalPerChannel
; /* passive total per channel */
304 u16 ActiveTalPerChannel
; /* active total per channel */
305 u16 DelayFactor
; /* BSS width channel transition delay factor */
306 u16 ScanActThre
; /* Scan Activity threshold */
309 /* 7.3.2.56. 20/40 Coexistence element used in Element ID = 72 = IE_2040_BSS_COEXIST */
310 typedef union PACKED _BSS_2040_COEXIST_IE
{
313 u8 Intolerant40
:1; /* Inter-BSS. set 1 when prohibits a receiving BSS from operating as a 20/40 Mhz BSS. */
314 u8 BSS20WidthReq
:1; /* Intra-BSS set 1 when prohibits a receiving AP from operating its BSS as a 20/40MHz BSS. */
318 } BSS_2040_COEXIST_IE
, *PBSS_2040_COEXIST_IE
;
320 struct rt_trigger_eventa
{
323 u8 RegClass
; /* Regulatory Class */
325 unsigned long CDCounter
; /* Maintain a separate count down counter for each Event A. */
328 /* 20/40 trigger event table */
329 /* If one Event (A) is deleted or created, or if Event (B) is detected or not detected, STA should send 2040BSSCoexistence to AP. */
330 #define MAX_TRIGGER_EVENT 64
331 struct rt_trigger_event_tab
{
333 struct rt_trigger_eventa EventA
[MAX_TRIGGER_EVENT
];
334 unsigned long EventBCountDown
; /* Count down counter for Event B. */
337 /* 7.3.27 20/40 Bss Coexistence Mgmt capability used in extended capabilities information IE( ID = 127 = IE_EXT_CAPABILITY). */
338 /* This is the first octet and was defined in 802.11n D3.03 and 802.11yD9.0 */
339 struct PACKED rt_ext_cap_info_element
{
340 u8 BssCoexistMgmtSupport
:1;
342 u8 ExtendChannelSwitch
:1;
346 /* 802.11n 7.3.2.61 */
347 struct PACKED rt_bss_2040_coexist_element
{
348 u8 ElementID
; /* ID = IE_2040_BSS_COEXIST = 72 */
350 BSS_2040_COEXIST_IE BssCoexistIe
;
353 /*802.11n 7.3.2.59 */
354 struct PACKED rt_bss_2040_intolerant_ch_report
{
355 u8 ElementID
; /* ID = IE_2040_BSS_INTOLERANT_REPORT = 73 */
361 /* The structure for channel switch announcement IE. This is in 802.11n D3.03 */
362 struct PACKED rt_cha_switch_announce_ie
{
363 u8 SwitchMode
; /*channel switch mode */
365 u8 SwitchCount
; /* */
368 /* The structure for channel switch announcement IE. This is in 802.11n D3.03 */
369 struct PACKED rt_sec_cha_offset_ie
{
370 u8 SecondaryChannelOffset
; /* 1: Secondary above, 3: Secondary below, 0: no Secondary */
373 /* This structure is extracted from struct struct rt_ht_capability */
374 struct rt_ht_phy_info
{
375 BOOLEAN bHtEnable
; /* If we should use ht rate. */
376 BOOLEAN bPreNHt
; /* If we should use ht rate. */
377 /*Subtract from HT Capability IE */
381 /*This structure subtracts ralink supports from all 802.11n-related features. */
382 /*Features not listed here but contained in 802.11n spec are not supported in rt2860. */
383 struct rt_ht_capability
{
385 u16 MimoPs
:2; /*mimo power safe MMPS_ */
386 u16 GF
:1; /*green field */
388 u16 ShortGIfor40
:1; /*for40MHz */
390 u16 RxSTBC
:2; /* 2 bits */
391 u16 AmsduEnable
:1; /* Enable to transmit A-MSDU. Suggest disable. We should use A-MPDU to gain best benefit of 802.11n */
392 u16 AmsduSize
:1; /* Max receiving A-MSDU size */
395 /*Subtract from Addiont HT INFO IE */
396 u8 MaxRAmpduFactor
:2;
398 u8 ExtChanOffset
:2; /* Please note the difference with following u8 NewExtChannelOffset; from 802.11n */
404 u16 OBSS_NonHTExist
:1;
407 /* New Extension Channel Offset IE */
408 u8 NewExtChannelOffset
;
409 /* Extension Capability IE = 127 */
413 /* field in Additional HT Information IE . */
414 struct PACKED rt_add_htinfo
{
418 u8 S_PSMPSup
:1; /*Indicate support for scheduled PSMP */
419 u8 SerInterGranu
:3; /*service interval granularity */
422 struct PACKED rt_add_htinfo2
{
426 u16 OBSS_NonHTExist
:1;
430 /* TODO: Need sync with spec about the definition of StbcMcs. In Draft 3.03, it's reserved. */
431 struct PACKED rt_add_htinfo3
{
434 u16 DualCTSProtect
:1;
436 u16 LsigTxopProt
:1; /* L-SIG TXOP protection full support */
442 #define SIZE_ADD_HT_INFO_IE 22
443 struct PACKED rt_add_ht_info_ie
{
445 struct rt_add_htinfo AddHtInfo
;
446 struct rt_add_htinfo2 AddHtInfo2
;
447 struct rt_add_htinfo3 AddHtInfo3
;
448 u8 MCSSet
[16]; /* Basic MCS set */
451 struct PACKED rt_new_ext_chan_ie
{
455 struct PACKED rt_frame_802_11
{
456 struct rt_header_802_11 Hdr
;
460 /* QoSNull embedding of management action. When HT Control MA field set to 1. */
461 struct PACKED rt_ma_body
{
467 struct PACKED rt_header_802_3
{
468 u8 DAAddr1
[MAC_ADDR_LEN
];
469 u8 SAAddr2
[MAC_ADDR_LEN
];
472 /*//Block ACK related format */
473 /* 2-byte BA Parameter field in DELBA frames to terminate an already set up bA */
474 struct PACKED rt_delba_parm
{
475 u16 Rsv
:11; /* always set to 0 */
476 u16 Initiator
:1; /* 1: originator 0:recipient */
477 u16 TID
:4; /* value of TC os TS */
480 /* 2-byte BA Parameter Set field in ADDBA frames to signal parm for setting up a BA */
481 struct PACKED rt_ba_parm
{
482 u16 AMSDUSupported
:1; /* 0: not permitted 1: permitted */
483 u16 BAPolicy
:1; /* 1: immediately BA 0:delayed BA */
484 u16 TID
:4; /* value of TC os TS */
485 u16 BufSize
:10; /* number of buffer of size 2304 octetsr */
488 /* 2-byte BA Starting Seq CONTROL field */
489 typedef union PACKED _BASEQ_CONTROL
{
491 u16 FragNum
:4; /* always set to 0 */
492 u16 StartSeq
:12; /* sequence number of the 1st MSDU for which this BAR is sent */
495 } BASEQ_CONTROL
, *PBASEQ_CONTROL
;
497 /*BAControl and BARControl are the same */
498 /* 2-byte BA CONTROL field in BA frame */
499 struct PACKED rt_ba_control
{
500 u16 ACKPolicy
:1; /* only related to N-Delayed BA. But not support in RT2860b. 0:NormalACK 1:No ACK */
501 u16 MTID
:1; /*EWC V1.24 */
507 /* 2-byte BAR CONTROL field in BAR frame */
508 struct PACKED rt_bar_control
{
509 u16 ACKPolicy
:1; /* 0:normal ack, 1:no ack. */
510 u16 MTID
:1; /*if this bit1, use struct rt_frame_mtba_req, if 0, use struct rt_frame_ba_req */
516 /* BARControl in MTBAR frame */
517 struct PACKED rt_mtbar_control
{
525 struct PACKED rt_per_tid_info
{
531 struct rt_per_tid_info PerTID
;
532 BASEQ_CONTROL BAStartingSeq
;
535 /* BAREQ AND MTBAREQ have the same subtype BAR, 802.11n BAR use compressed bitmap. */
536 struct PACKED rt_frame_ba_req
{
537 struct rt_frame_control FC
;
539 u8 Addr1
[MAC_ADDR_LEN
];
540 u8 Addr2
[MAC_ADDR_LEN
];
541 struct rt_bar_control BARControl
;
542 BASEQ_CONTROL BAStartingSeq
;
545 struct PACKED rt_frame_mtba_req
{
546 struct rt_frame_control FC
;
548 u8 Addr1
[MAC_ADDR_LEN
];
549 u8 Addr2
[MAC_ADDR_LEN
];
550 struct rt_mtbar_control MTBARControl
;
551 struct rt_per_tid_info PerTIDInfo
;
552 BASEQ_CONTROL BAStartingSeq
;
555 /* Compressed format is mandatory in HT STA */
556 struct PACKED rt_frame_mtba
{
557 struct rt_frame_control FC
;
559 u8 Addr1
[MAC_ADDR_LEN
];
560 u8 Addr2
[MAC_ADDR_LEN
];
561 struct rt_ba_control BAControl
;
562 BASEQ_CONTROL BAStartingSeq
;
566 struct PACKED rt_frame_psmp_action
{
567 struct rt_header_802_11 Hdr
;
570 u8 Psmp
; /* 7.3.1.25 */
573 struct PACKED rt_frame_action_hdr
{
574 struct rt_header_802_11 Hdr
;
580 /*Action Frame Category:Spectrum, Action:Channel Switch. 7.3.2.20 */
581 struct PACKED rt_chan_switch_announce
{
582 u8 ElementID
; /* ID = IE_CHANNEL_SWITCH_ANNOUNCEMENT = 37 */
584 struct rt_cha_switch_announce_ie CSAnnounceIe
;
587 /*802.11n : 7.3.2.20a */
588 struct PACKED rt_second_chan_offset
{
589 u8 ElementID
; /* ID = IE_SECONDARY_CH_OFFSET = 62 */
591 struct rt_sec_cha_offset_ie SecChOffsetIe
;
594 struct PACKED rt_frame_spetrum_cs
{
595 struct rt_header_802_11 Hdr
;
598 struct rt_chan_switch_announce CSAnnounce
;
599 struct rt_second_chan_offset SecondChannel
;
602 struct PACKED rt_frame_addba_req
{
603 struct rt_header_802_11 Hdr
;
607 struct rt_ba_parm BaParm
; /* 2 - 10 */
608 u16 TimeOutValue
; /* 0 - 0 */
609 BASEQ_CONTROL BaStartSeq
; /* 0-0 */
612 struct PACKED rt_frame_addba_rsp
{
613 struct rt_header_802_11 Hdr
;
618 struct rt_ba_parm BaParm
; /*0 - 2 */
622 struct PACKED rt_frame_delba_req
{
623 struct rt_header_802_11 Hdr
;
626 struct rt_delba_parm DelbaParm
;
631 struct PACKED rt_frame_bar
{
632 struct rt_frame_control FC
;
634 u8 Addr1
[MAC_ADDR_LEN
];
635 u8 Addr2
[MAC_ADDR_LEN
];
636 struct rt_bar_control BarControl
;
637 BASEQ_CONTROL StartingSeq
;
641 struct PACKED rt_frame_ba
{
642 struct rt_frame_control FC
;
644 u8 Addr1
[MAC_ADDR_LEN
];
645 u8 Addr2
[MAC_ADDR_LEN
];
646 struct rt_bar_control BarControl
;
647 BASEQ_CONTROL StartingSeq
;
651 /* Radio Measurement Request Frame Format */
652 struct PACKED rt_frame_rm_req_action
{
653 struct rt_header_802_11 Hdr
;
661 struct PACKED rt_ht_ext_channel_switch_announcement_ie
{
664 u8 ChannelSwitchMode
;
667 u8 ChannelSwitchCount
;
671 /* _Limit must be the 2**n - 1 */
672 /* _SEQ1 , _SEQ2 must be within 0 ~ _Limit */
674 #define SEQ_STEPONE(_SEQ1, _SEQ2, _Limit) ((_SEQ1 == ((_SEQ2+1) & _Limit)))
675 #define SEQ_SMALLER(_SEQ1, _SEQ2, _Limit) (((_SEQ1-_SEQ2) & ((_Limit+1)>>1)))
676 #define SEQ_LARGER(_SEQ1, _SEQ2, _Limit) ((_SEQ1 != _SEQ2) && !(((_SEQ1-_SEQ2) & ((_Limit+1)>>1))))
677 #define SEQ_WITHIN_WIN(_SEQ1, _SEQ2, _WIN, _Limit) (SEQ_LARGER(_SEQ1, _SEQ2, _Limit) && \
678 SEQ_SMALLER(_SEQ1, ((_SEQ2+_WIN+1)&_Limit), _Limit))
681 /* Contention-free parameter (without ID and Length) */
683 struct PACKED rt_cf_parm
{
684 BOOLEAN bValid
; /* 1: variable contains valid value */
691 struct rt_cipher_suite
{
692 NDIS_802_11_ENCRYPTION_STATUS PairCipher
; /* Unicast cipher 1, this one has more secured cipher suite */
693 NDIS_802_11_ENCRYPTION_STATUS PairCipherAux
; /* Unicast cipher 2 if AP announce two unicast cipher suite */
694 NDIS_802_11_ENCRYPTION_STATUS GroupCipher
; /* Group cipher */
695 u16 RsnCapability
; /* RSN capability from beacon */
696 BOOLEAN bMixMode
; /* Indicate Pair & Group cipher might be different */
699 /* EDCA configuration from AP's BEACON/ProbeRsp */
700 struct rt_edca_parm
{
701 BOOLEAN bValid
; /* 1: variable contains valid value */
702 BOOLEAN bAdd
; /* 1: variable contains valid value */
704 BOOLEAN bQueueRequest
;
705 BOOLEAN bTxopRequest
;
706 BOOLEAN bAPSDCapable
;
707 /* BOOLEAN bMoreDataAck; */
709 u8 Aifsn
[4]; /* 0:AC_BK, 1:AC_BE, 2:AC_VI, 3:AC_VO */
712 u16 Txop
[4]; /* in unit of 32-us */
713 BOOLEAN bACM
[4]; /* 1: Admission Control of AC_BK is mandatory */
716 /* QBSS LOAD information from QAP's BEACON/ProbeRsp */
717 struct rt_qbss_load_parm
{
718 BOOLEAN bValid
; /* 1: variable contains valid value */
720 u8 ChannelUtilization
;
721 u16 RemainingAdmissionControl
; /* in unit of 32-us */
724 /* QBSS Info field in QSTA's assoc req */
725 struct PACKED rt_qbss_sta_info_parm
{
735 /* QBSS Info field in QAP's Beacon/ProbeRsp */
736 struct PACKED rt_qbss_ap_info_parm
{
742 /* QOS Capability reported in QAP's BEACON/ProbeRsp */
743 /* QOS Capability sent out in QSTA's AssociateReq/ReAssociateReq */
744 struct rt_qos_capability_parm
{
745 BOOLEAN bValid
; /* 1: variable contains valid value */
747 BOOLEAN bQueueRequest
;
748 BOOLEAN bTxopRequest
;
749 /* BOOLEAN bMoreDataAck; */
755 u8 IE
[MAX_CUSTOM_LEN
];
758 struct rt_bss_entry
{
759 u8 Bssid
[MAC_ADDR_LEN
];
761 u8 CentralChannel
; /*Store the wide-band central channel for 40MHz. used in 40MHz AP. Or this is the same as Channel. */
766 u8 SupRate
[MAX_LEN_OF_SUPPORTED_RATES
];
768 u8 ExtRate
[MAX_LEN_OF_SUPPORTED_RATES
];
770 struct rt_ht_capability_ie HtCapability
;
772 struct rt_add_ht_info_ie AddHtInfo
; /* AP might use this additional ht info IE */
776 u8 Privacy
; /* Indicate security function ON/OFF. Don't mess up with auth mode. */
787 char Ssid
[MAX_LEN_OF_SSID
];
789 unsigned long LastBeaconRxTime
; /* OS's timestamp */
794 struct rt_cipher_suite WPA
; /* AP announced WPA cipher suite */
795 struct rt_cipher_suite WPA2
; /* AP announced WPA2 cipher suite */
797 /* New for microsoft WPA support */
798 struct rt_ndis_802_11_fixed_ies FixIEs
;
799 NDIS_802_11_AUTHENTICATION_MODE AuthModeAux
; /* Addition mode for WPA2 / WPA capable AP */
800 NDIS_802_11_AUTHENTICATION_MODE AuthMode
;
801 NDIS_802_11_WEP_STATUS WepStatus
; /* Unicast Encryption Algorithm extract from VAR_IE */
802 u16 VarIELen
; /* Length of next VIE include EID & Length */
803 u8 VarIEs
[MAX_VIE_LEN
];
805 /* CCX Ckip information */
809 u8 PTSF
[4]; /* Parent TSF */
810 u8 TTSF
[8]; /* Target TSF */
812 /* 802.11e d9, and WMM */
813 struct rt_edca_parm EdcaParm
;
814 struct rt_qos_capability_parm QosCapability
;
815 struct rt_qbss_load_parm QbssLoad
;
816 struct rt_wpa_ie WpaIE
;
817 struct rt_wpa_ie RsnIE
;
820 struct rt_bss_table
{
823 struct rt_bss_entry BssEntry
[MAX_LEN_OF_BSS_TABLE
];
826 struct rt_mlme_queue_elem
{
827 unsigned long Machine
;
828 unsigned long MsgType
;
829 unsigned long MsgLen
;
830 u8 Msg
[MGMT_DMA_BUFFER_SIZE
];
831 LARGE_INTEGER TimeStamp
;
841 struct rt_mlme_queue
{
846 struct rt_mlme_queue_elem Entry
[MAX_LEN_OF_MLME_QUEUE
];
849 typedef void(*STATE_MACHINE_FUNC
) (void *Adaptor
, struct rt_mlme_queue_elem
*Elem
);
851 struct rt_state_machine
{
853 unsigned long NrState
;
855 unsigned long CurrState
;
856 STATE_MACHINE_FUNC
*TransFunc
;
859 /* MLME AUX data structure that holds temporarliy settings during a connection attempt. */
860 /* Once this attempt succeeds, all settings will be copy to pAd->StaActive. */
861 /* A connection attempt (user set OID, roaming, CCX fast roaming,..) consists of */
862 /* several steps (JOIN, AUTH, ASSOC or REASSOC) and may fail at any step. We purposely */
863 /* separate this under-trial settings away from pAd->StaActive so that once */
864 /* this new attempt failed, driver can auto-recover back to the active settings. */
867 u8 Ssid
[MAX_LEN_OF_SSID
];
869 u8 Bssid
[MAC_ADDR_LEN
];
870 u8 AutoReconnectSsid
[MAX_LEN_OF_SSID
];
871 u8 AutoReconnectSsidLen
;
883 /* Copy supported rate from desired AP's beacon. We are trying to match */
884 /* AP's supported and extended rate settings. */
885 u8 SupRate
[MAX_LEN_OF_SUPPORTED_RATES
];
886 u8 ExtRate
[MAX_LEN_OF_SUPPORTED_RATES
];
889 struct rt_ht_capability_ie HtCapability
;
891 struct rt_add_ht_info_ie AddHtInfo
; /* AP might use this additional ht info IE */
892 u8 NewExtChannelOffset
;
893 /*struct rt_ht_capability SupportedHtPhy; */
896 struct rt_qos_capability_parm APQosCapability
; /* QOS capability of the current associated AP */
897 struct rt_edca_parm APEdcaParm
; /* EDCA parameters of the current associated AP */
898 struct rt_qbss_load_parm APQbssLoad
; /* QBSS load of the current associated AP */
900 /* new to keep Ralink specific feature */
901 unsigned long APRalinkIe
;
903 struct rt_bss_table SsidBssTab
; /* AP list for the same SSID */
904 struct rt_bss_table RoamTab
; /* AP list eligible for roaming */
905 unsigned long BssIdx
;
906 unsigned long RoamIdx
;
908 BOOLEAN CurrReqIsFromNdis
;
910 struct rt_ralink_timer BeaconTimer
, ScanTimer
;
911 struct rt_ralink_timer AuthTimer
;
912 struct rt_ralink_timer AssocTimer
, ReassocTimer
, DisassocTimer
;
915 struct rt_mlme_addba_req
{
917 u8 pAddr
[MAC_ADDR_LEN
];
925 struct rt_mlme_delba_req
{
927 u8 Addr
[MAC_ADDR_LEN
];
932 /* assoc struct is equal to reassoc */
933 struct rt_mlme_assoc_req
{
934 u8 Addr
[MAC_ADDR_LEN
];
937 unsigned long Timeout
;
940 struct rt_mlme_disassoc_req
{
941 u8 Addr
[MAC_ADDR_LEN
];
945 struct rt_mlme_auth_req
{
946 u8 Addr
[MAC_ADDR_LEN
];
948 unsigned long Timeout
;
951 struct rt_mlme_deauth_req
{
952 u8 Addr
[MAC_ADDR_LEN
];
956 struct rt_mlme_join_req
{
957 unsigned long BssIdx
;
960 struct rt_mlme_scan_req
{
961 u8 Bssid
[MAC_ADDR_LEN
];
965 char Ssid
[MAX_LEN_OF_SSID
];
968 struct rt_mlme_start_req
{
969 char Ssid
[MAX_LEN_OF_SSID
];
973 struct PACKED rt_eid
{
979 struct PACKED rt_rtmp_tx_rate_switch
{
992 /* ========================== AP mlme.h =============================== */
993 #define TBTT_PRELOAD_TIME 384 /* usec. LomgPreamble + 24-byte at 1Mbps */
994 #define DEFAULT_DTIM_PERIOD 1
996 #define MAC_TABLE_AGEOUT_TIME 300 /* unit: sec */
997 #define MAC_TABLE_ASSOC_TIMEOUT 5 /* unit: sec */
998 #define MAC_TABLE_FULL(Tab) ((Tab).size == MAX_LEN_OF_MAC_TABLE)
1000 /* AP shall drop the sta if continue Tx fail count reach it. */
1001 #define MAC_ENTRY_LIFE_CHECK_CNT 20 /* packet cnt. */
1003 /* Value domain of pMacEntry->Sst */
1005 SST_NOT_AUTH
, /* 0: equivalent to IEEE 802.11/1999 state 1 */
1006 SST_AUTH
, /* 1: equivalent to IEEE 802.11/1999 state 2 */
1007 SST_ASSOC
/* 2: equivalent to IEEE 802.11/1999 state 3 */
1010 /* value domain of pMacEntry->AuthState */
1011 typedef enum _AuthState
{
1013 AS_AUTH_OPEN
, /* STA has been authenticated using OPEN SYSTEM */
1014 AS_AUTH_KEY
, /* STA has been authenticated using SHARED KEY */
1015 AS_AUTHENTICATING
/* STA is waiting for AUTH seq#3 using SHARED KEY */
1018 /*for-wpa value domain of pMacEntry->WpaState 802.1i D3 p.114 */
1019 typedef enum _ApWpaState
{
1021 AS_DISCONNECT
, /* 1 */
1022 AS_DISCONNECTED
, /* 2 */
1023 AS_INITIALIZE
, /* 3 */
1024 AS_AUTHENTICATION
, /* 4 */
1025 AS_AUTHENTICATION2
, /* 5 */
1028 AS_PTKSTART
, /* 8 */
1029 AS_PTKINIT_NEGOTIATING
, /* 9 */
1030 AS_PTKINITDONE
, /* 10 */
1031 AS_UPDATEKEYS
, /* 11 */
1032 AS_INTEGRITY_FAILURE
, /* 12 */
1033 AS_KEYUPDATE
, /* 13 */
1036 /* for-wpa value domain of pMacEntry->WpaState 802.1i D3 p.114 */
1037 typedef enum _GTKState
{
1043 /* for-wpa value domain of pMacEntry->WpaState 802.1i D3 p.114 */
1044 typedef enum _WpaGTKState
{
1048 /* ====================== end of AP mlme.h ============================ */
1050 #endif /* MLME_H__ */