]> git.karo-electronics.de Git - mv-sheeva.git/blob - drivers/staging/rt2860/mlme.h
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[mv-sheeva.git] / drivers / staging / rt2860 / 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 #include "rtmp_dot11.h"
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
55 /* The definition of Radar detection duration region */
56 #define CE              0
57 #define FCC             1
58 #define JAP             2
59 #define JAP_W53 3
60 #define JAP_W56 4
61 #define MAX_RD_REGION 5
62
63 #define BEACON_LOST_TIME            (4 * OS_HZ) /* 2048 msec = 2 sec */
64
65 #define DLS_TIMEOUT                 1200        /* unit: msec */
66 #define AUTH_TIMEOUT                300 /* unit: msec */
67 #define ASSOC_TIMEOUT               300 /* unit: msec */
68 #define JOIN_TIMEOUT                2000        /* unit: msec */
69 #define SHORT_CHANNEL_TIME          90  /* unit: msec */
70 #define MIN_CHANNEL_TIME            110 /* unit: msec, for dual band scan */
71 #define MAX_CHANNEL_TIME            140 /* unit: msec, for single band scan */
72 #define FAST_ACTIVE_SCAN_TIME       30  /* Active scan waiting for probe response time */
73 #define CW_MIN_IN_BITS              4   /* actual CwMin = 2^CW_MIN_IN_BITS - 1 */
74 #define LINK_DOWN_TIMEOUT           20000       /* unit: msec */
75 #define AUTO_WAKEUP_TIMEOUT                     70      /*unit: msec */
76
77 #define CW_MAX_IN_BITS              10  /* actual CwMax = 2^CW_MAX_IN_BITS - 1 */
78
79 /* Note: RSSI_TO_DBM_OFFSET has been changed to variable for new RF (2004-0720). */
80 /* SHould not refer to this constant anymore */
81 /*#define RSSI_TO_DBM_OFFSET          120 // for RT2530 RSSI-115 = dBm */
82 #define RSSI_FOR_MID_TX_POWER       -55 /* -55 db is considered mid-distance */
83 #define RSSI_FOR_LOW_TX_POWER       -45 /* -45 db is considered very short distance and */
84                                         /* eligible to use a lower TX power */
85 #define RSSI_FOR_LOWEST_TX_POWER    -30
86 /*#define MID_TX_POWER_DELTA          0   // 0 db from full TX power upon mid-distance to AP */
87 #define LOW_TX_POWER_DELTA          6   /* -3 db from full TX power upon very short distance. 1 grade is 0.5 db */
88 #define LOWEST_TX_POWER_DELTA       16  /* -8 db from full TX power upon shortest distance. 1 grade is 0.5 db */
89
90 #define RSSI_TRIGGERED_UPON_BELOW_THRESHOLD     0
91 #define RSSI_TRIGGERED_UPON_EXCCEED_THRESHOLD   1
92 #define RSSI_THRESHOLD_FOR_ROAMING              25
93 #define RSSI_DELTA                              5
94
95 /* Channel Quality Indication */
96 #define CQI_IS_GOOD(cqi)            ((cqi) >= 50)
97 /*#define CQI_IS_FAIR(cqi)          (((cqi) >= 20) && ((cqi) < 50)) */
98 #define CQI_IS_POOR(cqi)            (cqi < 50)  /*(((cqi) >= 5) && ((cqi) < 20)) */
99 #define CQI_IS_BAD(cqi)             (cqi < 5)
100 #define CQI_IS_DEAD(cqi)            (cqi == 0)
101
102 /* weighting factor to calculate Channel quality, total should be 100% */
103 #define RSSI_WEIGHTING                   50
104 #define TX_WEIGHTING                     30
105 #define RX_WEIGHTING                     20
106
107 #define BSS_NOT_FOUND                    0xFFFFFFFF
108
109 #define MAX_LEN_OF_MLME_QUEUE            40     /*10 */
110
111 #define SCAN_PASSIVE                     18     /* scan with no probe request, only wait beacon and probe response */
112 #define SCAN_ACTIVE                      19     /* scan with probe request, and wait beacon and probe response */
113 #define SCAN_CISCO_PASSIVE                               20     /* Single channel passive scan */
114 #define SCAN_CISCO_ACTIVE                                21     /* Single channel active scan */
115 #define SCAN_CISCO_NOISE                                 22     /* Single channel passive scan for noise histogram collection */
116 #define SCAN_CISCO_CHANNEL_LOAD                  23     /* Single channel passive scan for channel load collection */
117 #define FAST_SCAN_ACTIVE                 24     /* scan with probe request, and wait beacon and probe response */
118
119 #define MAC_ADDR_IS_GROUP(Addr)       (((Addr[0]) & 0x01))
120 #define MAC_ADDR_HASH(Addr)            (Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
121 #define MAC_ADDR_HASH_INDEX(Addr)      (MAC_ADDR_HASH(Addr) % HASH_TABLE_SIZE)
122 #define TID_MAC_HASH(Addr, TID)            (TID^Addr[0] ^ Addr[1] ^ Addr[2] ^ Addr[3] ^ Addr[4] ^ Addr[5])
123 #define TID_MAC_HASH_INDEX(Addr, TID)      (TID_MAC_HASH(Addr, TID) % HASH_TABLE_SIZE)
124
125 /* LED Control */
126 /* assoiation ON. one LED ON. another blinking when TX, OFF when idle */
127 /* no association, both LED off */
128 #define ASIC_LED_ACT_ON(pAd)        RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00031e46)
129 #define ASIC_LED_ACT_OFF(pAd)       RTMP_IO_WRITE32(pAd, MAC_CSR14, 0x00001e46)
130
131 /* bit definition of the 2-byte pBEACON->Capability field */
132 #define CAP_IS_ESS_ON(x)                 (((x) & 0x0001) != 0)
133 #define CAP_IS_IBSS_ON(x)                (((x) & 0x0002) != 0)
134 #define CAP_IS_CF_POLLABLE_ON(x)         (((x) & 0x0004) != 0)
135 #define CAP_IS_CF_POLL_REQ_ON(x)         (((x) & 0x0008) != 0)
136 #define CAP_IS_PRIVACY_ON(x)             (((x) & 0x0010) != 0)
137 #define CAP_IS_SHORT_PREAMBLE_ON(x)      (((x) & 0x0020) != 0)
138 #define CAP_IS_PBCC_ON(x)                (((x) & 0x0040) != 0)
139 #define CAP_IS_AGILITY_ON(x)             (((x) & 0x0080) != 0)
140 #define CAP_IS_SPECTRUM_MGMT(x)          (((x) & 0x0100) != 0)  /* 802.11e d9 */
141 #define CAP_IS_QOS(x)                    (((x) & 0x0200) != 0)  /* 802.11e d9 */
142 #define CAP_IS_SHORT_SLOT(x)             (((x) & 0x0400) != 0)
143 #define CAP_IS_APSD(x)                   (((x) & 0x0800) != 0)  /* 802.11e d9 */
144 #define CAP_IS_IMMED_BA(x)               (((x) & 0x1000) != 0)  /* 802.11e d9 */
145 #define CAP_IS_DSSS_OFDM(x)              (((x) & 0x2000) != 0)
146 #define CAP_IS_DELAY_BA(x)               (((x) & 0x4000) != 0)  /* 802.11e d9 */
147
148 #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))
149
150 #define ERP_IS_NON_ERP_PRESENT(x)        (((x) & 0x01) != 0)    /* 802.11g */
151 #define ERP_IS_USE_PROTECTION(x)         (((x) & 0x02) != 0)    /* 802.11g */
152 #define ERP_IS_USE_BARKER_PREAMBLE(x)    (((x) & 0x04) != 0)    /* 802.11g */
153
154 #define DRS_TX_QUALITY_WORST_BOUND       8      /* 3  // just test by gary */
155 #define DRS_PENALTY                      8
156
157 #define BA_NOTUSE       2
158 /*BA Policy subfiled value in ADDBA frame */
159 #define IMMED_BA        1
160 #define DELAY_BA        0
161
162 /* BA Initiator subfield in DELBA frame */
163 #define ORIGINATOR      1
164 #define RECIPIENT       0
165
166 /* ADDBA Status Code */
167 #define ADDBA_RESULTCODE_SUCCESS                                        0
168 #define ADDBA_RESULTCODE_REFUSED                                        37
169 #define ADDBA_RESULTCODE_INVALID_PARAMETERS                     38
170
171 /* DELBA Reason Code */
172 #define DELBA_REASONCODE_QSTA_LEAVING                           36
173 #define DELBA_REASONCODE_END_BA                                         37
174 #define DELBA_REASONCODE_UNKNOWN_BA                                     38
175 #define DELBA_REASONCODE_TIMEOUT                                        39
176
177 /* reset all OneSecTx counters */
178 #define RESET_ONE_SEC_TX_CNT(__pEntry) \
179 if (((__pEntry)) != NULL) { \
180         (__pEntry)->OneSecTxRetryOkCount = 0; \
181         (__pEntry)->OneSecTxFailCount = 0; \
182         (__pEntry)->OneSecTxNoRetryOkCount = 0; \
183 }
184
185 /* */
186 /* 802.11 frame formats */
187 /* */
188 /*  HT Capability INFO field in HT Cap IE . */
189 struct PACKED rt_ht_cap_info {
190         u16 AdvCoding:1;
191         u16 ChannelWidth:1;
192         u16 MimoPs:2;   /*momi power safe */
193         u16 GF:1;               /*green field */
194         u16 ShortGIfor20:1;
195         u16 ShortGIfor40:1;     /*for40MHz */
196         u16 TxSTBC:1;
197         u16 RxSTBC:2;
198         u16 DelayedBA:1;        /*rt2860c not support */
199         u16 AMsduSize:1;        /* only support as zero */
200         u16 CCKmodein40:1;
201         u16 PSMP:1;
202         u16 Forty_Mhz_Intolerant:1;
203         u16 LSIGTxopProSup:1;
204 };
205
206 /*  HT Capability INFO field in HT Cap IE . */
207 struct PACKED rt_ht_cap_parm {
208         u8 MaxRAmpduFactor:2;
209         u8 MpduDensity:3;
210         u8 rsv:3;               /*momi power safe */
211 };
212
213 /*  HT Capability INFO field in HT Cap IE . */
214 struct PACKED rt_ht_mcs_set {
215         u8 MCSSet[10];
216         u8 SupRate[2];  /* unit : 1Mbps */
217         u8 TxMCSSetDefined:1;
218         u8 TxRxNotEqual:1;
219         u8 TxStream:2;
220         u8 MpduDensity:1;
221         u8 rsv:3;
222         u8 rsv3[3];
223 };
224
225 /*  HT Capability INFO field in HT Cap IE . */
226 struct PACKED rt_ext_ht_cap_info {
227         u16 Pco:1;
228         u16 TranTime:2;
229         u16 rsv:5;              /*momi power safe */
230         u16 MCSFeedback:2;      /*0:no MCS feedback, 2:unsolicited MCS feedback, 3:Full MCS feedback,  1:rsv. */
231         u16 PlusHTC:1;  /*+HTC control field support */
232         u16 RDGSupport:1;       /*reverse Direction Grant  support */
233         u16 rsv2:4;
234 };
235
236 /*  HT Beamforming field in HT Cap IE . */
237 struct PACKED rt_ht_bf_cap {
238         unsigned long TxBFRecCapable:1;
239         unsigned long RxSoundCapable:1;
240         unsigned long TxSoundCapable:1;
241         unsigned long RxNDPCapable:1;
242         unsigned long TxNDPCapable:1;
243         unsigned long ImpTxBFCapable:1;
244         unsigned long Calibration:2;
245         unsigned long ExpCSICapable:1;
246         unsigned long ExpNoComSteerCapable:1;
247         unsigned long ExpComSteerCapable:1;
248         unsigned long ExpCSIFbk:2;
249         unsigned long ExpNoComBF:2;
250         unsigned long ExpComBF:2;
251         unsigned long MinGrouping:2;
252         unsigned long CSIBFAntSup:2;
253         unsigned long NoComSteerBFAntSup:2;
254         unsigned long ComSteerBFAntSup:2;
255         unsigned long CSIRowBFSup:2;
256         unsigned long ChanEstimation:2;
257         unsigned long rsv:3;
258 };
259
260 /*  HT antenna selection field in HT Cap IE . */
261 struct PACKED rt_ht_as_cap {
262         u8 AntSelect:1;
263         u8 ExpCSIFbkTxASEL:1;
264         u8 AntIndFbkTxASEL:1;
265         u8 ExpCSIFbk:1;
266         u8 AntIndFbk:1;
267         u8 RxASel:1;
268         u8 TxSoundPPDU:1;
269         u8 rsv:1;
270 };
271
272 /* Draft 1.0 set IE length 26, but is extensible.. */
273 #define SIZE_HT_CAP_IE          26
274 /* The structure for HT Capability IE. */
275 struct PACKED rt_ht_capability_ie {
276         struct rt_ht_cap_info HtCapInfo;
277         struct rt_ht_cap_parm HtCapParm;
278 /*      struct rt_ht_mcs_set              HtMCSSet; */
279         u8 MCSSet[16];
280         struct rt_ext_ht_cap_info ExtHtCapInfo;
281         struct rt_ht_bf_cap TxBFCap;    /* beamforming cap. rt2860c not support beamforming. */
282         struct rt_ht_as_cap ASCap;      /*antenna selection. */
283 };
284
285 /* 802.11n draft3 related structure definitions. */
286 /* 7.3.2.60 */
287 #define dot11OBSSScanPassiveDwell                                                       20      /* in TU. min amount of time that the STA continously scans each channel when performing an active OBSS scan. */
288 #define dot11OBSSScanActiveDwell                                                        10      /* in TU.min amount of time that the STA continously scans each channel when performing an passive OBSS scan. */
289 #define dot11BSSWidthTriggerScanInterval                                        300     /* in sec. max interval between scan operations to be performed to detect BSS channel width trigger events. */
290 #define dot11OBSSScanPassiveTotalPerChannel                                     200     /* in TU. min total amount of time that the STA scans each channel when performing a passive OBSS scan. */
291 #define dot11OBSSScanActiveTotalPerChannel                                      20      /*in TU. min total amount of time that the STA scans each channel when performing a active OBSS scan */
292 #define dot11BSSWidthChannelTransactionDelayFactor                      5       /* min ratio between the delay time in performing a switch from 20MHz BSS to 20/40 BSS operation and the maximum */
293                                                                                                                                 /*      interval between overlapping BSS scan operations. */
294 #define dot11BSSScanActivityThreshold                                           25      /* in %%, max total time that a STA may be active on the medium during a period of */
295                                                                                                                                 /*      (dot11BSSWidthChannelTransactionDelayFactor * dot11BSSWidthTriggerScanInterval) seconds without */
296                                                                                                                                 /*      being obligated to perform OBSS Scan operations. default is 25(== 0.25%) */
297
298 struct PACKED rt_overlap_bss_scan_ie {
299         u16 ScanPassiveDwell;
300         u16 ScanActiveDwell;
301         u16 TriggerScanInt;     /* Trigger scan interval */
302         u16 PassiveTalPerChannel;       /* passive total per channel */
303         u16 ActiveTalPerChannel;        /* active total per channel */
304         u16 DelayFactor;        /* BSS width channel transition delay factor */
305         u16 ScanActThre;        /* Scan Activity threshold */
306 };
307
308 /*  7.3.2.56. 20/40 Coexistence element used in  Element ID = 72 = IE_2040_BSS_COEXIST */
309 typedef union PACKED _BSS_2040_COEXIST_IE {
310         struct PACKED {
311                 u8 InfoReq:1;
312                 u8 Intolerant40:1;      /* Inter-BSS. set 1 when prohibits a receiving BSS from operating as a 20/40 Mhz BSS. */
313                 u8 BSS20WidthReq:1;     /* Intra-BSS set 1 when prohibits a receiving AP from operating its BSS as a 20/40MHz BSS. */
314                 u8 rsv:5;
315         } field;
316         u8 word;
317 } BSS_2040_COEXIST_IE, *PBSS_2040_COEXIST_IE;
318
319 struct rt_trigger_eventa {
320         BOOLEAN bValid;
321         u8 BSSID[6];
322         u8 RegClass;            /* Regulatory Class */
323         u16 Channel;
324         unsigned long CDCounter;        /* Maintain a separate count down counter for each Event A. */
325 };
326
327 /* 20/40 trigger event table */
328 /* If one Event A delete or created, or if Event B is detected or not detected, STA should send 2040BSSCoexistence to AP. */
329 #define MAX_TRIGGER_EVENT               64
330 struct rt_trigger_event_tab {
331         u8 EventANo;
332         struct rt_trigger_eventa EventA[MAX_TRIGGER_EVENT];
333         unsigned long EventBCountDown;  /* Count down counter for Event B. */
334 };
335
336 /* 7.3.27 20/40 Bss Coexistence Mgmt capability used in extended capabilities information IE( ID = 127 = IE_EXT_CAPABILITY). */
337 /*      This is the first octet and was defined in 802.11n D3.03 and 802.11yD9.0 */
338 struct PACKED rt_ext_cap_info_element {
339         u8 BssCoexistMgmtSupport:1;
340         u8 rsv:1;
341         u8 ExtendChannelSwitch:1;
342         u8 rsv2:5;
343 };
344
345 /* 802.11n 7.3.2.61 */
346 struct PACKED rt_bss_2040_coexist_element {
347         u8 ElementID;   /* ID = IE_2040_BSS_COEXIST = 72 */
348         u8 Len;
349         BSS_2040_COEXIST_IE BssCoexistIe;
350 };
351
352 /*802.11n 7.3.2.59 */
353 struct PACKED rt_bss_2040_intolerant_ch_report {
354         u8 ElementID;   /* ID = IE_2040_BSS_INTOLERANT_REPORT = 73 */
355         u8 Len;
356         u8 RegulatoryClass;
357         u8 ChList[0];
358 };
359
360 /* The structure for channel switch annoucement IE. This is in 802.11n D3.03 */
361 struct PACKED rt_cha_switch_announce_ie {
362         u8 SwitchMode;  /*channel switch mode */
363         u8 NewChannel;  /* */
364         u8 SwitchCount; /* */
365 };
366
367 /* The structure for channel switch annoucement IE. This is in 802.11n D3.03 */
368 struct PACKED rt_sec_cha_offset_ie {
369         u8 SecondaryChannelOffset;      /* 1: Secondary above, 3: Secondary below, 0: no Secondary */
370 };
371
372 /* This structure is extracted from struct struct rt_ht_capability */
373 struct rt_ht_phy_info {
374         BOOLEAN bHtEnable;      /* If we should use ht rate. */
375         BOOLEAN bPreNHt;        /* If we should use ht rate. */
376         /*Substract from HT Capability IE */
377         u8 MCSSet[16];
378 };
379
380 /*This structure substracts ralink supports from all 802.11n-related features. */
381 /*Features not listed here but contained in 802.11n spec are not supported in rt2860. */
382 struct rt_ht_capability {
383         u16 ChannelWidth:1;
384         u16 MimoPs:2;   /*mimo power safe MMPS_ */
385         u16 GF:1;               /*green field */
386         u16 ShortGIfor20:1;
387         u16 ShortGIfor40:1;     /*for40MHz */
388         u16 TxSTBC:1;
389         u16 RxSTBC:2;   /* 2 bits */
390         u16 AmsduEnable:1;      /* Enable to transmit A-MSDU. Suggest disable. We should use A-MPDU to gain best benifit of 802.11n */
391         u16 AmsduSize:1;        /* Max receiving A-MSDU size */
392         u16 rsv:5;
393
394         /*Substract from Addiont HT INFO IE */
395         u8 MaxRAmpduFactor:2;
396         u8 MpduDensity:3;
397         u8 ExtChanOffset:2;     /* Please not the difference with following     u8   NewExtChannelOffset; from 802.11n */
398         u8 RecomWidth:1;
399
400         u16 OperaionMode:2;
401         u16 NonGfPresent:1;
402         u16 rsv3:1;
403         u16 OBSS_NonHTExist:1;
404         u16 rsv2:11;
405
406         /* New Extension Channel Offset IE */
407         u8 NewExtChannelOffset;
408         /* Extension Capability IE = 127 */
409         u8 BSSCoexist2040;
410 };
411
412 /*   field in Addtional HT Information IE . */
413 struct PACKED rt_add_htinfo {
414         u8 ExtChanOffset:2;
415         u8 RecomWidth:1;
416         u8 RifsMode:1;
417         u8 S_PSMPSup:1; /*Indicate support for scheduled PSMP */
418         u8 SerInterGranu:3;     /*service interval granularity */
419 };
420
421 struct PACKED rt_add_htinfo2 {
422         u16 OperaionMode:2;
423         u16 NonGfPresent:1;
424         u16 rsv:1;
425         u16 OBSS_NonHTExist:1;
426         u16 rsv2:11;
427 };
428
429 /* TODO: Need sync with spec about the definition of StbcMcs. In Draft 3.03, it's reserved. */
430 struct PACKED rt_add_htinfo3 {
431         u16 StbcMcs:6;
432         u16 DualBeacon:1;
433         u16 DualCTSProtect:1;
434         u16 STBCBeacon:1;
435         u16 LsigTxopProt:1;     /* L-SIG TXOP protection full support */
436         u16 PcoActive:1;
437         u16 PcoPhase:1;
438         u16 rsv:4;
439 };
440
441 #define SIZE_ADD_HT_INFO_IE             22
442 struct PACKED rt_add_ht_info_ie {
443         u8 ControlChan;
444         struct rt_add_htinfo AddHtInfo;
445         struct rt_add_htinfo2 AddHtInfo2;
446         struct rt_add_htinfo3 AddHtInfo3;
447         u8 MCSSet[16];  /* Basic MCS set */
448 };
449
450 struct PACKED rt_new_ext_chan_ie {
451         u8 NewExtChanOffset;
452 };
453
454 struct PACKED rt_frame_802_11 {
455         struct rt_header_802_11 Hdr;
456         u8 Octet[1];
457 };
458
459 /* QoSNull embedding of management action. When HT Control MA field set to 1. */
460 struct PACKED rt_ma_body {
461         u8 Category;
462         u8 Action;
463         u8 Octet[1];
464 };
465
466 struct PACKED rt_header_802_3 {
467         u8 DAAddr1[MAC_ADDR_LEN];
468         u8 SAAddr2[MAC_ADDR_LEN];
469         u8 Octet[2];
470 };
471 /*//Block ACK related format */
472 /* 2-byte BA Parameter  field  in       DELBA frames to terminate an already set up bA */
473 struct PACKED rt_delba_parm {
474         u16 Rsv:11;             /* always set to 0 */
475         u16 Initiator:1;        /* 1: originator    0:recipient */
476         u16 TID:4;              /* value of TC os TS */
477 };
478
479 /* 2-byte BA Parameter Set field  in ADDBA frames to signal parm for setting up a BA */
480 struct PACKED rt_ba_parm {
481         u16 AMSDUSupported:1;   /* 0: not permitted             1: permitted */
482         u16 BAPolicy:1; /* 1: immediately BA    0:delayed BA */
483         u16 TID:4;              /* value of TC os TS */
484         u16 BufSize:10; /* number of buffe of size 2304 octetsr */
485 };
486
487 /* 2-byte BA Starting Seq CONTROL field */
488 typedef union PACKED _BASEQ_CONTROL {
489         struct PACKED {
490                 u16 FragNum:4;  /* always set to 0 */
491                 u16 StartSeq:12;        /* sequence number of the 1st MSDU for which this BAR is sent */
492         } field;
493         u16 word;
494 } BASEQ_CONTROL, *PBASEQ_CONTROL;
495
496 /*BAControl and BARControl are the same */
497 /* 2-byte BA CONTROL field in BA frame */
498 struct PACKED rt_ba_control {
499         u16 ACKPolicy:1;        /* only related to N-Delayed BA. But not support in RT2860b. 0:NormalACK  1:No ACK */
500         u16 MTID:1;             /*EWC V1.24 */
501         u16 Compressed:1;
502         u16 Rsv:9;
503         u16 TID:4;
504 };
505
506 /* 2-byte BAR CONTROL field in BAR frame */
507 struct PACKED rt_bar_control {
508         u16 ACKPolicy:1;        /* 0:normal ack,  1:no ack. */
509         u16 MTID:1;             /*if this bit1, use  struct rt_frame_mtba_req,  if 0, use struct rt_frame_ba_req */
510         u16 Compressed:1;
511         u16 Rsv1:9;
512         u16 TID:4;
513 };
514
515 /* BARControl in MTBAR frame */
516 struct PACKED rt_mtbar_control {
517         u16 ACKPolicy:1;
518         u16 MTID:1;
519         u16 Compressed:1;
520         u16 Rsv1:9;
521         u16 NumTID:4;
522 };
523
524 struct PACKED rt_per_tid_info {
525         u16 Rsv1:12;
526         u16 TID:4;
527 };
528
529 struct rt_each_tid {
530         struct rt_per_tid_info PerTID;
531         BASEQ_CONTROL BAStartingSeq;
532 };
533
534 /* BAREQ AND MTBAREQ have the same subtype BAR, 802.11n BAR use compressed bitmap. */
535 struct PACKED rt_frame_ba_req {
536         struct rt_frame_control FC;
537         u16 Duration;
538         u8 Addr1[MAC_ADDR_LEN];
539         u8 Addr2[MAC_ADDR_LEN];
540         struct rt_bar_control BARControl;
541         BASEQ_CONTROL BAStartingSeq;
542 };
543
544 struct PACKED rt_frame_mtba_req {
545         struct rt_frame_control FC;
546         u16 Duration;
547         u8 Addr1[MAC_ADDR_LEN];
548         u8 Addr2[MAC_ADDR_LEN];
549         struct rt_mtbar_control MTBARControl;
550         struct rt_per_tid_info PerTIDInfo;
551         BASEQ_CONTROL BAStartingSeq;
552 };
553
554 /* Compressed format is mandantory in HT STA */
555 struct PACKED rt_frame_mtba {
556         struct rt_frame_control FC;
557         u16 Duration;
558         u8 Addr1[MAC_ADDR_LEN];
559         u8 Addr2[MAC_ADDR_LEN];
560         struct rt_ba_control BAControl;
561         BASEQ_CONTROL BAStartingSeq;
562         u8 BitMap[8];
563 };
564
565 struct PACKED rt_frame_psmp_action {
566         struct rt_header_802_11 Hdr;
567         u8 Category;
568         u8 Action;
569         u8 Psmp;                /* 7.3.1.25 */
570 };
571
572 struct PACKED rt_frame_action_hdr {
573         struct rt_header_802_11 Hdr;
574         u8 Category;
575         u8 Action;
576 };
577
578 /*Action Frame */
579 /*Action Frame  Category:Spectrum,  Action:Channel Switch. 7.3.2.20 */
580 struct PACKED rt_chan_switch_announce {
581         u8 ElementID;   /* ID = IE_CHANNEL_SWITCH_ANNOUNCEMENT = 37 */
582         u8 Len;
583         struct rt_cha_switch_announce_ie CSAnnounceIe;
584 };
585
586 /*802.11n : 7.3.2.20a */
587 struct PACKED rt_second_chan_offset {
588         u8 ElementID;   /* ID = IE_SECONDARY_CH_OFFSET = 62 */
589         u8 Len;
590         struct rt_sec_cha_offset_ie SecChOffsetIe;
591 };
592
593 struct PACKED rt_frame_spetrum_cs {
594         struct rt_header_802_11 Hdr;
595         u8 Category;
596         u8 Action;
597         struct rt_chan_switch_announce CSAnnounce;
598         struct rt_second_chan_offset SecondChannel;
599 };
600
601 struct PACKED rt_frame_addba_req {
602         struct rt_header_802_11 Hdr;
603         u8 Category;
604         u8 Action;
605         u8 Token;               /* 1 */
606         struct rt_ba_parm BaParm;               /*  2 - 10 */
607         u16 TimeOutValue;       /* 0 - 0 */
608         BASEQ_CONTROL BaStartSeq;       /* 0-0 */
609 };
610
611 struct PACKED rt_frame_addba_rsp {
612         struct rt_header_802_11 Hdr;
613         u8 Category;
614         u8 Action;
615         u8 Token;
616         u16 StatusCode;
617         struct rt_ba_parm BaParm;               /*0 - 2 */
618         u16 TimeOutValue;
619 };
620
621 struct PACKED rt_frame_delba_req {
622         struct rt_header_802_11 Hdr;
623         u8 Category;
624         u8 Action;
625         struct rt_delba_parm DelbaParm;
626         u16 ReasonCode;
627 };
628
629 /*7.2.1.7 */
630 struct PACKED rt_frame_bar {
631         struct rt_frame_control FC;
632         u16 Duration;
633         u8 Addr1[MAC_ADDR_LEN];
634         u8 Addr2[MAC_ADDR_LEN];
635         struct rt_bar_control BarControl;
636         BASEQ_CONTROL StartingSeq;
637 };
638
639 /*7.2.1.7 */
640 struct PACKED rt_frame_ba {
641         struct rt_frame_control FC;
642         u16 Duration;
643         u8 Addr1[MAC_ADDR_LEN];
644         u8 Addr2[MAC_ADDR_LEN];
645         struct rt_bar_control BarControl;
646         BASEQ_CONTROL StartingSeq;
647         u8 bitmask[8];
648 };
649
650 /* Radio Measuement Request Frame Format */
651 struct PACKED rt_frame_rm_req_action {
652         struct rt_header_802_11 Hdr;
653         u8 Category;
654         u8 Action;
655         u8 Token;
656         u16 Repetition;
657         u8 data[0];
658 };
659
660 struct PACKED rt_ht_ext_channel_switch_announcement_ie {
661         u8 ID;
662         u8 Length;
663         u8 ChannelSwitchMode;
664         u8 NewRegClass;
665         u8 NewChannelNum;
666         u8 ChannelSwitchCount;
667 };
668
669 /* */
670 /* _Limit must be the 2**n - 1 */
671 /* _SEQ1 , _SEQ2 must be within 0 ~ _Limit */
672 /* */
673 #define SEQ_STEPONE(_SEQ1, _SEQ2, _Limit)       ((_SEQ1 == ((_SEQ2+1) & _Limit)))
674 #define SEQ_SMALLER(_SEQ1, _SEQ2, _Limit)       (((_SEQ1-_SEQ2) & ((_Limit+1)>>1)))
675 #define SEQ_LARGER(_SEQ1, _SEQ2, _Limit)        ((_SEQ1 != _SEQ2) && !(((_SEQ1-_SEQ2) & ((_Limit+1)>>1))))
676 #define SEQ_WITHIN_WIN(_SEQ1, _SEQ2, _WIN, _Limit) (SEQ_LARGER(_SEQ1, _SEQ2, _Limit) &&  \
677                                                                                                 SEQ_SMALLER(_SEQ1, ((_SEQ2+_WIN+1)&_Limit), _Limit))
678
679 /* */
680 /* Contention-free parameter (without ID and Length) */
681 /* */
682 struct PACKED rt_cf_parm {
683         BOOLEAN bValid;         /* 1: variable contains valid value */
684         u8 CfpCount;
685         u8 CfpPeriod;
686         u16 CfpMaxDuration;
687         u16 CfpDurRemaining;
688 };
689
690 struct rt_cipher_suite {
691         NDIS_802_11_ENCRYPTION_STATUS PairCipher;       /* Unicast cipher 1, this one has more secured cipher suite */
692         NDIS_802_11_ENCRYPTION_STATUS PairCipherAux;    /* Unicast cipher 2 if AP announce two unicast cipher suite */
693         NDIS_802_11_ENCRYPTION_STATUS GroupCipher;      /* Group cipher */
694         u16 RsnCapability;      /* RSN capability from beacon */
695         BOOLEAN bMixMode;       /* Indicate Pair & Group cipher might be different */
696 };
697
698 /* EDCA configuration from AP's BEACON/ProbeRsp */
699 struct rt_edca_parm {
700         BOOLEAN bValid;         /* 1: variable contains valid value */
701         BOOLEAN bAdd;           /* 1: variable contains valid value */
702         BOOLEAN bQAck;
703         BOOLEAN bQueueRequest;
704         BOOLEAN bTxopRequest;
705         BOOLEAN bAPSDCapable;
706 /*  BOOLEAN     bMoreDataAck; */
707         u8 EdcaUpdateCount;
708         u8 Aifsn[4];            /* 0:AC_BK, 1:AC_BE, 2:AC_VI, 3:AC_VO */
709         u8 Cwmin[4];
710         u8 Cwmax[4];
711         u16 Txop[4];            /* in unit of 32-us */
712         BOOLEAN bACM[4];        /* 1: Admission Control of AC_BK is mandattory */
713 };
714
715 /* QBSS LOAD information from QAP's BEACON/ProbeRsp */
716 struct rt_qbss_load_parm {
717         BOOLEAN bValid;         /* 1: variable contains valid value */
718         u16 StaNum;
719         u8 ChannelUtilization;
720         u16 RemainingAdmissionControl;  /* in unit of 32-us */
721 };
722
723 /* QBSS Info field in QSTA's assoc req */
724 struct PACKED rt_qbss_sta_info_parm {
725         u8 UAPSD_AC_VO:1;
726         u8 UAPSD_AC_VI:1;
727         u8 UAPSD_AC_BK:1;
728         u8 UAPSD_AC_BE:1;
729         u8 Rsv1:1;
730         u8 MaxSPLength:2;
731         u8 Rsv2:1;
732 };
733
734 /* QBSS Info field in QAP's Beacon/ProbeRsp */
735 struct PACKED rt_qbss_ap_info_parm {
736         u8 ParamSetCount:4;
737         u8 Rsv:3;
738         u8 UAPSD:1;
739 };
740
741 /* QOS Capability reported in QAP's BEACON/ProbeRsp */
742 /* QOS Capability sent out in QSTA's AssociateReq/ReAssociateReq */
743 struct rt_qos_capability_parm {
744         BOOLEAN bValid;         /* 1: variable contains valid value */
745         BOOLEAN bQAck;
746         BOOLEAN bQueueRequest;
747         BOOLEAN bTxopRequest;
748 /*  BOOLEAN     bMoreDataAck; */
749         u8 EdcaUpdateCount;
750 };
751
752 struct rt_wpa_ie {
753         u8 IELen;
754         u8 IE[MAX_CUSTOM_LEN];
755 };
756
757 struct rt_bss_entry {
758         u8 Bssid[MAC_ADDR_LEN];
759         u8 Channel;
760         u8 CentralChannel;      /*Store the wide-band central channel for 40MHz.  .used in 40MHz AP. Or this is the same as Channel. */
761         u8 BssType;
762         u16 AtimWin;
763         u16 BeaconPeriod;
764
765         u8 SupRate[MAX_LEN_OF_SUPPORTED_RATES];
766         u8 SupRateLen;
767         u8 ExtRate[MAX_LEN_OF_SUPPORTED_RATES];
768         u8 ExtRateLen;
769         struct rt_ht_capability_ie HtCapability;
770         u8 HtCapabilityLen;
771         struct rt_add_ht_info_ie AddHtInfo;     /* AP might use this additional ht info IE */
772         u8 AddHtInfoLen;
773         u8 NewExtChanOffset;
774         char Rssi;
775         u8 Privacy;             /* Indicate security function ON/OFF. Don't mess up with auth mode. */
776         u8 Hidden;
777
778         u16 DtimPeriod;
779         u16 CapabilityInfo;
780
781         u16 CfpCount;
782         u16 CfpPeriod;
783         u16 CfpMaxDuration;
784         u16 CfpDurRemaining;
785         u8 SsidLen;
786         char Ssid[MAX_LEN_OF_SSID];
787
788         unsigned long LastBeaconRxTime; /* OS's timestamp */
789
790         BOOLEAN bSES;
791
792         /* New for WPA2 */
793         struct rt_cipher_suite WPA;     /* AP announced WPA cipher suite */
794         struct rt_cipher_suite WPA2;    /* AP announced WPA2 cipher suite */
795
796         /* New for microsoft WPA support */
797         struct rt_ndis_802_11_fixed_ies FixIEs;
798         NDIS_802_11_AUTHENTICATION_MODE AuthModeAux;    /* Addition mode for WPA2 / WPA capable AP */
799         NDIS_802_11_AUTHENTICATION_MODE AuthMode;
800         NDIS_802_11_WEP_STATUS WepStatus;       /* Unicast Encryption Algorithm extract from VAR_IE */
801         u16 VarIELen;   /* Length of next VIE include EID & Length */
802         u8 VarIEs[MAX_VIE_LEN];
803
804         /* CCX Ckip information */
805         u8 CkipFlag;
806
807         /* CCX 2 TSF */
808         u8 PTSF[4];             /* Parent TSF */
809         u8 TTSF[8];             /* Target TSF */
810
811         /* 802.11e d9, and WMM */
812         struct rt_edca_parm EdcaParm;
813         struct rt_qos_capability_parm QosCapability;
814         struct rt_qbss_load_parm QbssLoad;
815         struct rt_wpa_ie WpaIE;
816         struct rt_wpa_ie RsnIE;
817 };
818
819 struct rt_bss_table {
820         u8 BssNr;
821         u8 BssOverlapNr;
822         struct rt_bss_entry BssEntry[MAX_LEN_OF_BSS_TABLE];
823 };
824
825 struct rt_mlme_queue_elem {
826         unsigned long Machine;
827         unsigned long MsgType;
828         unsigned long MsgLen;
829         u8 Msg[MGMT_DMA_BUFFER_SIZE];
830         LARGE_INTEGER TimeStamp;
831         u8 Rssi0;
832         u8 Rssi1;
833         u8 Rssi2;
834         u8 Signal;
835         u8 Channel;
836         u8 Wcid;
837         BOOLEAN Occupied;
838 };
839
840 struct rt_mlme_queue {
841         unsigned long Num;
842         unsigned long Head;
843         unsigned long Tail;
844         spinlock_t Lock;
845         struct rt_mlme_queue_elem Entry[MAX_LEN_OF_MLME_QUEUE];
846 };
847
848 typedef void(*STATE_MACHINE_FUNC) (void *Adaptor, struct rt_mlme_queue_elem *Elem);
849
850 struct rt_state_machine {
851         unsigned long Base;
852         unsigned long NrState;
853         unsigned long NrMsg;
854         unsigned long CurrState;
855         STATE_MACHINE_FUNC *TransFunc;
856 };
857
858 /* MLME AUX data structure that hold temporarliy settings during a connection attempt. */
859 /* Once this attemp succeeds, all settings will be copy to pAd->StaActive. */
860 /* A connection attempt (user set OID, roaming, CCX fast roaming,..) consists of */
861 /* several steps (JOIN, AUTH, ASSOC or REASSOC) and may fail at any step. We purposely */
862 /* separate this under-trial settings away from pAd->StaActive so that once */
863 /* this new attempt failed, driver can auto-recover back to the active settings. */
864 struct rt_mlme_aux {
865         u8 BssType;
866         u8 Ssid[MAX_LEN_OF_SSID];
867         u8 SsidLen;
868         u8 Bssid[MAC_ADDR_LEN];
869         u8 AutoReconnectSsid[MAX_LEN_OF_SSID];
870         u8 AutoReconnectSsidLen;
871         u16 Alg;
872         u8 ScanType;
873         u8 Channel;
874         u8 CentralChannel;
875         u16 Aid;
876         u16 CapabilityInfo;
877         u16 BeaconPeriod;
878         u16 CfpMaxDuration;
879         u16 CfpPeriod;
880         u16 AtimWin;
881
882         /* Copy supported rate from desired AP's beacon. We are trying to match */
883         /* AP's supported and extended rate settings. */
884         u8 SupRate[MAX_LEN_OF_SUPPORTED_RATES];
885         u8 ExtRate[MAX_LEN_OF_SUPPORTED_RATES];
886         u8 SupRateLen;
887         u8 ExtRateLen;
888         struct rt_ht_capability_ie HtCapability;
889         u8 HtCapabilityLen;
890         struct rt_add_ht_info_ie AddHtInfo;     /* AP might use this additional ht info IE */
891         u8 NewExtChannelOffset;
892         /*struct rt_ht_capability      SupportedHtPhy; */
893
894         /* new for QOS */
895         struct rt_qos_capability_parm APQosCapability;  /* QOS capability of the current associated AP */
896         struct rt_edca_parm APEdcaParm; /* EDCA parameters of the current associated AP */
897         struct rt_qbss_load_parm APQbssLoad;    /* QBSS load of the current associated AP */
898
899         /* new to keep Ralink specific feature */
900         unsigned long APRalinkIe;
901
902         struct rt_bss_table SsidBssTab; /* AP list for the same SSID */
903         struct rt_bss_table RoamTab;    /* AP list eligible for roaming */
904         unsigned long BssIdx;
905         unsigned long RoamIdx;
906
907         BOOLEAN CurrReqIsFromNdis;
908
909         struct rt_ralink_timer BeaconTimer, ScanTimer;
910         struct rt_ralink_timer AuthTimer;
911         struct rt_ralink_timer AssocTimer, ReassocTimer, DisassocTimer;
912 };
913
914 struct rt_mlme_addba_req {
915         u8 Wcid;                /* */
916         u8 pAddr[MAC_ADDR_LEN];
917         u8 BaBufSize;
918         u16 TimeOutValue;
919         u8 TID;
920         u8 Token;
921         u16 BaStartSeq;
922 };
923
924 struct rt_mlme_delba_req {
925         u8 Wcid;                /* */
926         u8 Addr[MAC_ADDR_LEN];
927         u8 TID;
928         u8 Initiator;
929 };
930
931 /* assoc struct is equal to reassoc */
932 struct rt_mlme_assoc_req {
933         u8 Addr[MAC_ADDR_LEN];
934         u16 CapabilityInfo;
935         u16 ListenIntv;
936         unsigned long Timeout;
937 };
938
939 struct rt_mlme_disassoc_req {
940         u8 Addr[MAC_ADDR_LEN];
941         u16 Reason;
942 };
943
944 struct rt_mlme_auth_req {
945         u8 Addr[MAC_ADDR_LEN];
946         u16 Alg;
947         unsigned long Timeout;
948 };
949
950 struct rt_mlme_deauth_req {
951         u8 Addr[MAC_ADDR_LEN];
952         u16 Reason;
953 };
954
955 struct rt_mlme_join_req {
956         unsigned long BssIdx;
957 };
958
959 struct rt_mlme_scan_req {
960         u8 Bssid[MAC_ADDR_LEN];
961         u8 BssType;
962         u8 ScanType;
963         u8 SsidLen;
964         char Ssid[MAX_LEN_OF_SSID];
965 };
966
967 struct rt_mlme_start_req {
968         char Ssid[MAX_LEN_OF_SSID];
969         u8 SsidLen;
970 };
971
972 struct PACKED rt_eid {
973         u8 Eid;
974         u8 Len;
975         u8 Octet[1];
976 };
977
978 struct PACKED rt_rtmp_tx_rate_switch {
979         u8 ItemNo;
980         u8 STBC:1;
981         u8 ShortGI:1;
982         u8 BW:1;
983         u8 Rsv1:1;
984         u8 Mode:2;
985         u8 Rsv2:2;
986         u8 CurrMCS;
987         u8 TrainUp;
988         u8 TrainDown;
989 };
990
991 /* ========================== AP mlme.h =============================== */
992 #define TBTT_PRELOAD_TIME       384     /* usec. LomgPreamble + 24-byte at 1Mbps */
993 #define DEFAULT_DTIM_PERIOD     1
994
995 #define MAC_TABLE_AGEOUT_TIME                   300     /* unit: sec */
996 #define MAC_TABLE_ASSOC_TIMEOUT                 5       /* unit: sec */
997 #define MAC_TABLE_FULL(Tab)                             ((Tab).size == MAX_LEN_OF_MAC_TABLE)
998
999 /* AP shall drop the sta if contine Tx fail count reach it. */
1000 #define MAC_ENTRY_LIFE_CHECK_CNT                20      /* packet cnt. */
1001
1002 /* Value domain of pMacEntry->Sst */
1003 typedef enum _Sst {
1004         SST_NOT_AUTH,           /* 0: equivalent to IEEE 802.11/1999 state 1 */
1005         SST_AUTH,               /* 1: equivalent to IEEE 802.11/1999 state 2 */
1006         SST_ASSOC               /* 2: equivalent to IEEE 802.11/1999 state 3 */
1007 } SST;
1008
1009 /* value domain of pMacEntry->AuthState */
1010 typedef enum _AuthState {
1011         AS_NOT_AUTH,
1012         AS_AUTH_OPEN,           /* STA has been authenticated using OPEN SYSTEM */
1013         AS_AUTH_KEY,            /* STA has been authenticated using SHARED KEY */
1014         AS_AUTHENTICATING       /* STA is waiting for AUTH seq#3 using SHARED KEY */
1015 } AUTH_STATE;
1016
1017 /*for-wpa value domain of pMacEntry->WpaState  802.1i D3   p.114 */
1018 typedef enum _ApWpaState {
1019         AS_NOTUSE,              /* 0 */
1020         AS_DISCONNECT,          /* 1 */
1021         AS_DISCONNECTED,        /* 2 */
1022         AS_INITIALIZE,          /* 3 */
1023         AS_AUTHENTICATION,      /* 4 */
1024         AS_AUTHENTICATION2,     /* 5 */
1025         AS_INITPMK,             /* 6 */
1026         AS_INITPSK,             /* 7 */
1027         AS_PTKSTART,            /* 8 */
1028         AS_PTKINIT_NEGOTIATING, /* 9 */
1029         AS_PTKINITDONE,         /* 10 */
1030         AS_UPDATEKEYS,          /* 11 */
1031         AS_INTEGRITY_FAILURE,   /* 12 */
1032         AS_KEYUPDATE,           /* 13 */
1033 } AP_WPA_STATE;
1034
1035 /* for-wpa value domain of pMacEntry->WpaState  802.1i D3   p.114 */
1036 typedef enum _GTKState {
1037         REKEY_NEGOTIATING,
1038         REKEY_ESTABLISHED,
1039         KEYERROR,
1040 } GTK_STATE;
1041
1042 /*  for-wpa  value domain of pMacEntry->WpaState  802.1i D3   p.114 */
1043 typedef enum _WpaGTKState {
1044         SETKEYS,
1045         SETKEYS_DONE,
1046 } WPA_GTK_STATE;
1047 /* ====================== end of AP mlme.h ============================ */
1048
1049 #endif /* MLME_H__ */