2 ** $Id: //Department/DaVinci/BRANCHES/MT6620_WIFI_DRIVER_V2_3/mgmt/rate.c#1 $
6 \brief This file contains the transmission rate handling routines.
8 This file contains the transmission rate handling routines for setting up
9 ACK/CTS Rate, Highest Tx Rate, Lowest Tx Rate, Initial Tx Rate and do
10 conversion between Rate Set and Data Rates.
20 * [WPD00003833] [MT6620 and MT5931] Driver migration - move to new repository.
23 * [WPD00003833][MT6620 and MT5931] Driver migration
26 * 03 16 2010 kevin.huang
27 * [BORA00000663][WIFISYS][New Feature] AdHoc Mode Support
31 * [BORA00000018]Integrate WIFI part into BORA for the 1st time
34 * Nov 23 2009 mtk01461
35 * [BORA00000018] Integrate WIFI part into BORA for the 1st time
38 * Nov 16 2009 mtk01461
39 * [BORA00000018] Integrate WIFI part into BORA for the 1st time
43 * [BORA00000018] Integrate WIFI part into BORA for the 1st time
45 ** \main\maintrunk.MT5921\12 2008-12-19 17:19:32 GMT mtk01461
46 ** Fix the problem that do not ASSERT the length of Supported Rate IE == 8
47 ** \main\maintrunk.MT5921\11 2008-12-01 18:17:42 GMT mtk01088
48 ** fixed the lint "possible using null pointer" warning
49 ** \main\maintrunk.MT5921\10 2008-08-20 00:16:36 GMT mtk01461
50 ** Update for Driver Review
51 ** \main\maintrunk.MT5921\9 2008-04-13 21:17:13 GMT mtk01461
52 ** Revise GEN Link Speed OID
53 ** \main\maintrunk.MT5921\8 2008-03-28 10:40:13 GMT mtk01461
54 ** Add rateGetRateSetFromDataRates() for set desired rate OID
55 ** \main\maintrunk.MT5921\7 2008-03-26 09:16:20 GMT mtk01461
56 ** Add adopt operational rate as ACK rate if BasicRateSet was not found
58 ** \main\maintrunk.MT5921\6 2008-02-21 15:01:39 GMT mtk01461
59 ** Add initial rate according rx signal quality support
60 ** \main\maintrunk.MT5921\5 2008-01-07 15:06:44 GMT mtk01461
61 ** Fix typo of rate adaptation of CtrlResp Frame
62 ** \main\maintrunk.MT5921\4 2007-10-25 18:05:12 GMT mtk01461
63 ** Add VOIP SCAN Support & Refine Roaming
66 /*******************************************************************************
67 * C O M P I L E R F L A G S
68 ********************************************************************************
71 /*******************************************************************************
72 * E X T E R N A L R E F E R E N C E S
73 ********************************************************************************
77 /*******************************************************************************
79 ********************************************************************************
81 /* The list of valid data rates. */
82 const UINT_8 aucDataRate[] = {
83 RATE_1M, /* RATE_1M_INDEX = 0 */
84 RATE_2M, /* RATE_2M_INDEX */
85 RATE_5_5M, /* RATE_5_5M_INDEX */
86 RATE_11M, /* RATE_11M_INDEX */
87 RATE_22M, /* RATE_22M_INDEX */
88 RATE_33M, /* RATE_33M_INDEX */
89 RATE_6M, /* RATE_6M_INDEX */
90 RATE_9M, /* RATE_9M_INDEX */
91 RATE_12M, /* RATE_12M_INDEX */
92 RATE_18M, /* RATE_18M_INDEX */
93 RATE_24M, /* RATE_24M_INDEX */
94 RATE_36M, /* RATE_36M_INDEX */
95 RATE_48M, /* RATE_48M_INDEX */
96 RATE_54M, /* RATE_54M_INDEX */
97 RATE_HT_PHY /* RATE_HT_PHY_INDEX */
100 static const UINT_8 aucDefaultAckCtsRateIndex[RATE_NUM] = {
101 RATE_1M_INDEX, /* RATE_1M_INDEX = 0 */
102 RATE_2M_INDEX, /* RATE_2M_INDEX */
103 RATE_5_5M_INDEX, /* RATE_5_5M_INDEX */
104 RATE_11M_INDEX, /* RATE_11M_INDEX */
105 RATE_1M_INDEX, /* RATE_22M_INDEX - Not supported */
106 RATE_1M_INDEX, /* RATE_33M_INDEX - Not supported */
107 RATE_6M_INDEX, /* RATE_6M_INDEX */
108 RATE_6M_INDEX, /* RATE_9M_INDEX */
109 RATE_12M_INDEX, /* RATE_12M_INDEX */
110 RATE_12M_INDEX, /* RATE_18M_INDEX */
111 RATE_24M_INDEX, /* RATE_24M_INDEX */
112 RATE_24M_INDEX, /* RATE_36M_INDEX */
113 RATE_24M_INDEX, /* RATE_48M_INDEX */
114 RATE_24M_INDEX /* RATE_54M_INDEX */
117 const BOOLEAN afgIsOFDMRate[RATE_NUM] = {
118 FALSE, /* RATE_1M_INDEX = 0 */
119 FALSE, /* RATE_2M_INDEX */
120 FALSE, /* RATE_5_5M_INDEX */
121 FALSE, /* RATE_11M_INDEX */
122 FALSE, /* RATE_22M_INDEX - Not supported */
123 FALSE, /* RATE_33M_INDEX - Not supported */
124 TRUE, /* RATE_6M_INDEX */
125 TRUE, /* RATE_9M_INDEX */
126 TRUE, /* RATE_12M_INDEX */
127 TRUE, /* RATE_18M_INDEX */
128 TRUE, /* RATE_24M_INDEX */
129 TRUE, /* RATE_36M_INDEX */
130 TRUE, /* RATE_48M_INDEX */
131 TRUE /* RATE_54M_INDEX */
134 /*******************************************************************************
136 ********************************************************************************
139 /*******************************************************************************
140 * P U B L I C D A T A
141 ********************************************************************************
144 /*******************************************************************************
145 * P R I V A T E D A T A
146 ********************************************************************************
149 /*******************************************************************************
151 ********************************************************************************
154 /*******************************************************************************
155 * F U N C T I O N D E C L A R A T I O N S
156 ********************************************************************************
159 /*******************************************************************************
161 ********************************************************************************
163 /*----------------------------------------------------------------------------*/
165 * @brief Convert the given Supported Rate & Extended Supported Rate IE to the
166 * Operational Rate Set and Basic Rate Set, and also check if any Basic
167 * Rate Code is unknown by driver.
169 * @param[in] prIeSupportedRate Pointer to the Supported Rate IE
170 * @param[in] prIeExtSupportedRate Pointer to the Ext Supported Rate IE
171 * @param[out] pu2OperationalRateSet Pointer to the Operational Rate Set
172 * @param[out] pu2BSSBasicRateSet Pointer to the Basic Rate Set
173 * @param[out] pfgIsUnknownBSSBasicRate Pointer to a Flag to indicate that Basic
174 * Rate Set has unknown Rate Code
178 /*----------------------------------------------------------------------------*/
180 rateGetRateSetFromIEs (
181 IN P_IE_SUPPORTED_RATE_T prIeSupportedRate,
182 IN P_IE_EXT_SUPPORTED_RATE_T prIeExtSupportedRate,
183 OUT PUINT_16 pu2OperationalRateSet,
184 OUT PUINT_16 pu2BSSBasicRateSet,
185 OUT PBOOLEAN pfgIsUnknownBSSBasicRate
188 UINT_16 u2OperationalRateSet = 0;
189 UINT_16 u2BSSBasicRateSet = 0;
190 BOOLEAN fgIsUnknownBSSBasicRate = FALSE;
195 ASSERT(pu2OperationalRateSet);
196 ASSERT(pu2BSSBasicRateSet);
197 ASSERT(pfgIsUnknownBSSBasicRate);
199 if (prIeSupportedRate) {
200 /* NOTE(Kevin): Buffalo WHR-G54S's supported rate set IE exceed 8.
201 * IE_LEN(pucIE) == 12, "1(B), 2(B), 5.5(B), 6(B), 9(B), 11(B),
202 * 12(B), 18(B), 24(B), 36(B), 48(B), 54(B)"
204 //ASSERT(prIeSupportedRate->ucLength <= ELEM_MAX_LEN_SUP_RATES);
205 ASSERT(prIeSupportedRate->ucLength <= RATE_NUM);
207 for (i = 0; i < prIeSupportedRate->ucLength; i++) {
208 ucRate = prIeSupportedRate->aucSupportedRates[i] & RATE_MASK;
210 /* Search all valid data rates */
211 for (j = 0; j < sizeof(aucDataRate)/sizeof(UINT_8); j++) {
212 if (ucRate == aucDataRate[j]) {
213 u2OperationalRateSet |= BIT(j);
215 if (prIeSupportedRate->aucSupportedRates[i] & RATE_BASIC_BIT) {
216 u2BSSBasicRateSet |= BIT(j);
223 if ((j == sizeof(aucDataRate)/sizeof(UINT_8)) &&
224 (prIeSupportedRate->aucSupportedRates[i] & RATE_BASIC_BIT)) {
225 fgIsUnknownBSSBasicRate = TRUE; /* A data rate not list in the aucDataRate[] */
231 if (prIeExtSupportedRate) {
232 //ASSERT(prIeExtSupportedRate->ucLength <= ELEM_MAX_LEN_EXTENDED_SUP_RATES);
234 for (i = 0; i < prIeExtSupportedRate->ucLength; i++) {
235 ucRate = prIeExtSupportedRate->aucExtSupportedRates[i] & RATE_MASK;
237 /* Search all valid data rates */
238 for (j = 0; j < sizeof(aucDataRate)/sizeof(UINT_8); j++) {
239 if (ucRate == aucDataRate[j]) {
240 u2OperationalRateSet |= BIT(j);
242 if (prIeExtSupportedRate->aucExtSupportedRates[i] & RATE_BASIC_BIT) {
243 u2BSSBasicRateSet |= BIT(j);
250 if ((j == sizeof(aucDataRate)/sizeof(UINT_8)) &&
251 (prIeExtSupportedRate->aucExtSupportedRates[i] & RATE_BASIC_BIT)) {
252 fgIsUnknownBSSBasicRate = TRUE; /* A data rate not list in the aucDataRate[] */
257 *pu2OperationalRateSet = u2OperationalRateSet;
258 *pu2BSSBasicRateSet = u2BSSBasicRateSet;
259 *pfgIsUnknownBSSBasicRate = fgIsUnknownBSSBasicRate;
263 } /* end of rateGetRateSetFromIEs() */
266 /*----------------------------------------------------------------------------*/
268 * @brief Convert the given Operational Rate Set & Basic Rate Set to the Rate Code
269 * Format for used in (Ext)Supportec Rate IE.
271 * @param[in] u2OperationalRateSet Operational Rate Set
272 * @param[in] u2BSSBasicRateSet Basic Rate Set
273 * @param[out] pucDataRates Pointer to the Data Rate Buffer
274 * @param[out] pucDataRatesLen Pointer to the Data Rate Buffer Length
278 /*----------------------------------------------------------------------------*/
280 rateGetDataRatesFromRateSet (
281 IN UINT_16 u2OperationalRateSet,
282 IN UINT_16 u2BSSBasicRateSet,
283 OUT PUINT_8 pucDataRates,
284 OUT PUINT_8 pucDataRatesLen
290 ASSERT(pucDataRates);
291 ASSERT(pucDataRatesLen);
293 ASSERT(u2BSSBasicRateSet == (u2OperationalRateSet & u2BSSBasicRateSet));
295 for (i = RATE_1M_INDEX, j = 0; i < RATE_NUM; i++) {
296 if (u2OperationalRateSet & BIT(i)) {
298 *(pucDataRates + j) = aucDataRate[i];
300 if (u2BSSBasicRateSet & BIT(i)) {
301 *(pucDataRates + j) |= RATE_BASIC_BIT;
308 *pucDataRatesLen = (UINT_8)j;
312 } /* end of rateGetDataRatesFromRateSet() */
315 /*----------------------------------------------------------------------------*/
317 * \brief Get the highest rate from given Rate Set.
319 * \param[in] u2RateSet Rate Set
320 * \param[out] pucHighestRateIndex Pointer to buffer of the Highest Rate Index
322 * \retval TRUE Highest Rate Index was found
323 * \retval FALSE Highest Rate Index was not found
325 /*----------------------------------------------------------------------------*/
327 rateGetHighestRateIndexFromRateSet (
328 IN UINT_16 u2RateSet,
329 OUT PUINT_8 pucHighestRateIndex
335 ASSERT(pucHighestRateIndex);
337 for (i = RATE_54M_INDEX; i >= RATE_1M_INDEX; i--) {
338 if (u2RateSet & BIT(i)) {
339 *pucHighestRateIndex = (UINT_8)i;
346 } /* end of rateGetHighestRateIndexFromRateSet() */
349 /*----------------------------------------------------------------------------*/
351 * \brief Get the lowest rate from given Rate Set.
353 * \param[in] u2RateSet Rate Set
354 * \param[out] pucLowestRateIndex Pointer to buffer of the Lowest Rate Index
356 * \retval TRUE Lowest Rate Index was found
357 * \retval FALSE Lowest Rate Index was not found
359 /*----------------------------------------------------------------------------*/
361 rateGetLowestRateIndexFromRateSet (
362 IN UINT_16 u2RateSet,
363 OUT PUINT_8 pucLowestRateIndex
368 ASSERT(pucLowestRateIndex);
370 for (i = RATE_1M_INDEX; i <= RATE_54M_INDEX; i++) {
371 if (u2RateSet & BIT(i)) {
372 *pucLowestRateIndex = (UINT_8)i;
379 } /* end of rateGetLowestRateIndexFromRateSet() */
382 #if 0 // NOTE(Kevin): For reference
383 /*----------------------------------------------------------------------------*/
385 * \brief Convert the given Data Rates to the Rate Set.
387 * \param[in] pucDataRates Pointer to the Data Rates
388 * \param[in] ucDataRatesLen Length of given Data Rates
389 * \param[out] pu2RateSet Pointer to the Rate Set
393 /*----------------------------------------------------------------------------*/
395 rateGetRateSetFromDataRates (
396 IN PUINT_8 pucDataRates,
397 IN UINT_8 ucDataRatesLen,
398 OUT PUINT_16 pu2RateSet
401 UINT_16 u2RateSet = 0;
406 ASSERT(pucDataRates);
410 for (i = 0; i < ucDataRatesLen; i++) {
411 ucRate = pucDataRates[i] & RATE_MASK;
413 /* Search all valid data rates */
414 for (j = 0; j < sizeof(aucDataRate)/sizeof(UINT_8); j++) {
415 if (ucRate == aucDataRate[j]) {
423 *pu2RateSet = u2RateSet;
427 } /* end of rateGetRateSetFromDataRates() */
430 /*----------------------------------------------------------------------------*/
432 * \brief Parse the Operational Rate Set and Basic Rate Set to get the corresponding
433 * ACK/CTS(Respnose) TX Rates.
435 * \param[in] u2OperationalRateSet Operational Rate Set
436 * \param[in] u2BSSBasicRateSet Basic Rate Set
437 * \param[out] aucAckCtsRateIndex Pointer to the Ack/Cts Data Rate Buffer
441 /*----------------------------------------------------------------------------*/
443 rateSetAckCtsDataRatesFromRateSet (
444 IN UINT_16 u2OperationalRateSet,
445 IN UINT_16 u2BSSBasicRateSet,
446 IN OUT UINT_8 aucAckCtsRateIndex[]
452 ASSERT(aucAckCtsRateIndex);
453 ASSERT(u2BSSBasicRateSet == (u2OperationalRateSet & u2BSSBasicRateSet));
455 /* Setup default ACK/CTS response rate */
456 kalMemCopy(aucAckCtsRateIndex, (PVOID)aucDefaultAckCtsRateIndex, sizeof(aucDefaultAckCtsRateIndex));
459 for (i = RATE_54M_INDEX; i >= RATE_1M_INDEX; i--) {
460 if (u2OperationalRateSet & BIT(i)) {
461 for (j = i; j >= RATE_1M_INDEX; j--) {
462 if (u2BSSBasicRateSet & BIT(j)) {
463 if ((afgIsOFDMRate[i] && afgIsOFDMRate[j]) || (!afgIsOFDMRate[i] && !afgIsOFDMRate[j])) // Reply ACK Frame at the same Modulation Scheme.
464 aucAckCtsRateIndex[i] = (UINT_8)j;
469 /* NOTE(Kevin 2008/03/25): Following code is used for those AP which has
471 * e.g. If input Operational Rate Set = [18M 12M 9M], Basic Rate Set = NULL.
472 * Originally we'll get Ack Rate for [18M 12M 9M] is [12M 12M "6M"].
473 * Now we'll get Ack Rate for [18M 12M 9M] is [12M 12M 9M],
474 * The Ack Rate for Tx Rates which are not list in Operational Rate Set is still
475 * use highest mandatory rate as default.
477 if (j < RATE_1M_INDEX) { /* The ACK/CTS rate was not found in BasicRateSet */
478 if (!(BIT(aucAckCtsRateIndex[i]) & u2OperationalRateSet)) {
479 aucAckCtsRateIndex[i] = (UINT_8)i;
487 } /* end of rateSetAckCtsDataRatesFromRateSet() */
490 /*----------------------------------------------------------------------------*/
492 * \brief Get the proper initial rate from Rate Set according to given RCPI value
494 * \param[in] u2RateSet Rate Set
495 * \param[in] rRcpi RCPI value from AP or Peer STA
496 * \param[out] pucInitialRateIndex Pointer to buffer of the initial Rate Index
498 * \retval TRUE Initial Rate Index was found
499 * \retval FALSE Initial Rate Index was not found
501 /*----------------------------------------------------------------------------*/
503 rateGetBestInitialRateIndex (
504 IN UINT_16 u2RateSet,
506 OUT PUINT_8 pucInitialRateIndex
509 UINT_16 u2InitRateSet;
513 ASSERT(pucInitialRateIndex);
515 DBGLOG(MGT, TRACE, ("rRcpi = %d\n", rRcpi));
517 if (rRcpi >= RCPI_100) { /* Best Signal */
518 u2InitRateSet = INITIAL_RATE_SET(RCPI_100);
520 else if (rRcpi >= RCPI_80) { /* Better Signal */
521 u2InitRateSet = INITIAL_RATE_SET(RCPI_80);
523 else if (rRcpi >= RCPI_60) { /* Good Signal */
524 u2InitRateSet = INITIAL_RATE_SET(RCPI_60);
526 else { /* Worse Signal */
527 /* NOTE(Kevin): If return FALSE, we should assign the BSS Basic Rate Index
528 * (prBssInfo->ucBasicRateIndex) to the initial rate. It was determined in
529 * function - bssUpdateTxRateForControlFrame().
534 u2RateSet &= u2InitRateSet;
536 for (i = RATE_54M_INDEX; i >= RATE_1M_INDEX; i--) {
537 if (u2RateSet & BIT(i)) {
538 *pucInitialRateIndex = (UINT_8)i;
545 } /* end of rateGetBestInitialRateIndex() */