drivers/net/wireless/iwlwifi/iwl-agn-rs.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2009 Intel Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  *  Intel Linux Wireless <ilw@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26
  27 #ifndef __iwl_agn_rs_h__
  28 #define __iwl_agn_rs_h__
  29
  30 struct iwl_rate_info {
  31         u8 plcp;        /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  32         u8 plcp_siso;   /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
  33         u8 plcp_mimo2;  /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
  34         u8 plcp_mimo3;  /* uCode API:  IWL_RATE_MIMO3_6M_PLCP, etc. */
  35         u8 ieee;        /* MAC header:  IWL_RATE_6M_IEEE, etc. */
  36         u8 prev_ieee;    /* previous rate in IEEE speeds */
  37         u8 next_ieee;    /* next rate in IEEE speeds */
  38         u8 prev_rs;      /* previous rate used in rs algo */
  39         u8 next_rs;      /* next rate used in rs algo */
  40         u8 prev_rs_tgg;  /* previous rate used in TGG rs algo */
  41         u8 next_rs_tgg;  /* next rate used in TGG rs algo */
  42 };
  43
  44 struct iwl3945_rate_info {
  45         u8 plcp;                /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  46         u8 ieee;                /* MAC header:  IWL_RATE_6M_IEEE, etc. */
  47         u8 prev_ieee;           /* previous rate in IEEE speeds */
  48         u8 next_ieee;           /* next rate in IEEE speeds */
  49         u8 prev_rs;             /* previous rate used in rs algo */
  50         u8 next_rs;             /* next rate used in rs algo */
  51         u8 prev_rs_tgg;         /* previous rate used in TGG rs algo */
  52         u8 next_rs_tgg;         /* next rate used in TGG rs algo */
  53         u8 table_rs_index;      /* index in rate scale table cmd */
  54         u8 prev_table_rs;       /* prev in rate table cmd */
  55 };
  56
  57 /*
  58  * These serve as indexes into
  59  * struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
  60  */
  61 enum {
  62         IWL_RATE_1M_INDEX = 0,
  63         IWL_RATE_2M_INDEX,
  64         IWL_RATE_5M_INDEX,
  65         IWL_RATE_11M_INDEX,
  66         IWL_RATE_6M_INDEX,
  67         IWL_RATE_9M_INDEX,
  68         IWL_RATE_12M_INDEX,
  69         IWL_RATE_18M_INDEX,
  70         IWL_RATE_24M_INDEX,
  71         IWL_RATE_36M_INDEX,
  72         IWL_RATE_48M_INDEX,
  73         IWL_RATE_54M_INDEX,
  74         IWL_RATE_60M_INDEX,
  75         IWL_RATE_COUNT, /*FIXME:RS:change to IWL_RATE_INDEX_COUNT,*/
  76         IWL_RATE_COUNT_LEGACY = IWL_RATE_COUNT - 1,     /* Excluding 60M */
  77         IWL_RATE_COUNT_3945 = IWL_RATE_COUNT - 1,
  78         IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
  79         IWL_RATE_INVALID = IWL_RATE_COUNT,
  80 };
  81
  82 enum {
  83         IWL_RATE_6M_INDEX_TABLE = 0,
  84         IWL_RATE_9M_INDEX_TABLE,
  85         IWL_RATE_12M_INDEX_TABLE,
  86         IWL_RATE_18M_INDEX_TABLE,
  87         IWL_RATE_24M_INDEX_TABLE,
  88         IWL_RATE_36M_INDEX_TABLE,
  89         IWL_RATE_48M_INDEX_TABLE,
  90         IWL_RATE_54M_INDEX_TABLE,
  91         IWL_RATE_1M_INDEX_TABLE,
  92         IWL_RATE_2M_INDEX_TABLE,
  93         IWL_RATE_5M_INDEX_TABLE,
  94         IWL_RATE_11M_INDEX_TABLE,
  95         IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
  96 };
  97
  98 enum {
  99         IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
 100         IWL39_LAST_OFDM_RATE = IWL_RATE_54M_INDEX,
 101         IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
 102         IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
 103         IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
 104 };
 105
 106 /* #define vs. enum to keep from defaulting to 'large integer' */
 107 #define IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
 108 #define IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
 109 #define IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
 110 #define IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
 111 #define IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
 112 #define IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
 113 #define IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
 114 #define IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
 115 #define IWL_RATE_60M_MASK  (1 << IWL_RATE_60M_INDEX)
 116 #define IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
 117 #define IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
 118 #define IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
 119 #define IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)
 120
 121 /* uCode API values for legacy bit rates, both OFDM and CCK */
 122 enum {
 123         IWL_RATE_6M_PLCP  = 13,
 124         IWL_RATE_9M_PLCP  = 15,
 125         IWL_RATE_12M_PLCP = 5,
 126         IWL_RATE_18M_PLCP = 7,
 127         IWL_RATE_24M_PLCP = 9,
 128         IWL_RATE_36M_PLCP = 11,
 129         IWL_RATE_48M_PLCP = 1,
 130         IWL_RATE_54M_PLCP = 3,
 131         IWL_RATE_60M_PLCP = 3,/*FIXME:RS:should be removed*/
 132         IWL_RATE_1M_PLCP  = 10,
 133         IWL_RATE_2M_PLCP  = 20,
 134         IWL_RATE_5M_PLCP  = 55,
 135         IWL_RATE_11M_PLCP = 110,
 136         /*FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP */
 137         /*FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,*/
 138 };
 139
 140 /* uCode API values for OFDM high-throughput (HT) bit rates */
 141 enum {
 142         IWL_RATE_SISO_6M_PLCP = 0,
 143         IWL_RATE_SISO_12M_PLCP = 1,
 144         IWL_RATE_SISO_18M_PLCP = 2,
 145         IWL_RATE_SISO_24M_PLCP = 3,
 146         IWL_RATE_SISO_36M_PLCP = 4,
 147         IWL_RATE_SISO_48M_PLCP = 5,
 148         IWL_RATE_SISO_54M_PLCP = 6,
 149         IWL_RATE_SISO_60M_PLCP = 7,
 150         IWL_RATE_MIMO2_6M_PLCP  = 0x8,
 151         IWL_RATE_MIMO2_12M_PLCP = 0x9,
 152         IWL_RATE_MIMO2_18M_PLCP = 0xa,
 153         IWL_RATE_MIMO2_24M_PLCP = 0xb,
 154         IWL_RATE_MIMO2_36M_PLCP = 0xc,
 155         IWL_RATE_MIMO2_48M_PLCP = 0xd,
 156         IWL_RATE_MIMO2_54M_PLCP = 0xe,
 157         IWL_RATE_MIMO2_60M_PLCP = 0xf,
 158         IWL_RATE_MIMO3_6M_PLCP  = 0x10,
 159         IWL_RATE_MIMO3_12M_PLCP = 0x11,
 160         IWL_RATE_MIMO3_18M_PLCP = 0x12,
 161         IWL_RATE_MIMO3_24M_PLCP = 0x13,
 162         IWL_RATE_MIMO3_36M_PLCP = 0x14,
 163         IWL_RATE_MIMO3_48M_PLCP = 0x15,
 164         IWL_RATE_MIMO3_54M_PLCP = 0x16,
 165         IWL_RATE_MIMO3_60M_PLCP = 0x17,
 166         IWL_RATE_SISO_INVM_PLCP,
 167         IWL_RATE_MIMO2_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
 168         IWL_RATE_MIMO3_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
 169 };
 170
 171 /* MAC header values for bit rates */
 172 enum {
 173         IWL_RATE_6M_IEEE  = 12,
 174         IWL_RATE_9M_IEEE  = 18,
 175         IWL_RATE_12M_IEEE = 24,
 176         IWL_RATE_18M_IEEE = 36,
 177         IWL_RATE_24M_IEEE = 48,
 178         IWL_RATE_36M_IEEE = 72,
 179         IWL_RATE_48M_IEEE = 96,
 180         IWL_RATE_54M_IEEE = 108,
 181         IWL_RATE_60M_IEEE = 120,
 182         IWL_RATE_1M_IEEE  = 2,
 183         IWL_RATE_2M_IEEE  = 4,
 184         IWL_RATE_5M_IEEE  = 11,
 185         IWL_RATE_11M_IEEE = 22,
 186 };
 187
 188 #define IWL_CCK_BASIC_RATES_MASK    \
 189        (IWL_RATE_1M_MASK          | \
 190         IWL_RATE_2M_MASK)
 191
 192 #define IWL_CCK_RATES_MASK          \
 193        (IWL_BASIC_RATES_MASK      | \
 194         IWL_RATE_5M_MASK          | \
 195         IWL_RATE_11M_MASK)
 196
 197 #define IWL_OFDM_BASIC_RATES_MASK   \
 198         (IWL_RATE_6M_MASK         | \
 199         IWL_RATE_12M_MASK         | \
 200         IWL_RATE_24M_MASK)
 201
 202 #define IWL_OFDM_RATES_MASK         \
 203        (IWL_OFDM_BASIC_RATES_MASK | \
 204         IWL_RATE_9M_MASK          | \
 205         IWL_RATE_18M_MASK         | \
 206         IWL_RATE_36M_MASK         | \
 207         IWL_RATE_48M_MASK         | \
 208         IWL_RATE_54M_MASK)
 209
 210 #define IWL_BASIC_RATES_MASK         \
 211         (IWL_OFDM_BASIC_RATES_MASK | \
 212          IWL_CCK_BASIC_RATES_MASK)
 213
 214 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 215
 216 #define IWL_INVALID_VALUE    -1
 217
 218 #define IWL_MIN_RSSI_VAL                 -100
 219 #define IWL_MAX_RSSI_VAL                    0
 220
 221 /* These values specify how many Tx frame attempts before
 222  * searching for a new modulation mode */
 223 #define IWL_LEGACY_FAILURE_LIMIT        160
 224 #define IWL_LEGACY_SUCCESS_LIMIT        480
 225 #define IWL_LEGACY_TABLE_COUNT          160
 226
 227 #define IWL_NONE_LEGACY_FAILURE_LIMIT   400
 228 #define IWL_NONE_LEGACY_SUCCESS_LIMIT   4500
 229 #define IWL_NONE_LEGACY_TABLE_COUNT     1500
 230
 231 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
 232 #define IWL_RS_GOOD_RATIO               12800   /* 100% */
 233 #define IWL_RATE_SCALE_SWITCH           10880   /*  85% */
 234 #define IWL_RATE_HIGH_TH                10880   /*  85% */
 235 #define IWL_RATE_INCREASE_TH            6400    /*  50% */
 236 #define IWL_RATE_DECREASE_TH            1920    /*  15% */
 237
 238 /* possible actions when in legacy mode */
 239 #define IWL_LEGACY_SWITCH_ANTENNA1      0
 240 #define IWL_LEGACY_SWITCH_ANTENNA2      1
 241 #define IWL_LEGACY_SWITCH_SISO          2
 242 #define IWL_LEGACY_SWITCH_MIMO2_AB      3
 243 #define IWL_LEGACY_SWITCH_MIMO2_AC      4
 244 #define IWL_LEGACY_SWITCH_MIMO2_BC      5
 245 #define IWL_LEGACY_SWITCH_MIMO3_ABC     6
 246
 247 /* possible actions when in siso mode */
 248 #define IWL_SISO_SWITCH_ANTENNA1        0
 249 #define IWL_SISO_SWITCH_ANTENNA2        1
 250 #define IWL_SISO_SWITCH_MIMO2_AB        2
 251 #define IWL_SISO_SWITCH_MIMO2_AC        3
 252 #define IWL_SISO_SWITCH_MIMO2_BC        4
 253 #define IWL_SISO_SWITCH_GI              5
 254 #define IWL_SISO_SWITCH_MIMO3_ABC       6
 255
 256
 257 /* possible actions when in mimo mode */
 258 #define IWL_MIMO2_SWITCH_ANTENNA1       0
 259 #define IWL_MIMO2_SWITCH_ANTENNA2       1
 260 #define IWL_MIMO2_SWITCH_SISO_A         2
 261 #define IWL_MIMO2_SWITCH_SISO_B         3
 262 #define IWL_MIMO2_SWITCH_SISO_C         4
 263 #define IWL_MIMO2_SWITCH_GI             5
 264 #define IWL_MIMO2_SWITCH_MIMO3_ABC      6
 265
 266
 267 /* possible actions when in mimo3 mode */
 268 #define IWL_MIMO3_SWITCH_ANTENNA1       0
 269 #define IWL_MIMO3_SWITCH_ANTENNA2       1
 270 #define IWL_MIMO3_SWITCH_SISO_A         2
 271 #define IWL_MIMO3_SWITCH_SISO_B         3
 272 #define IWL_MIMO3_SWITCH_SISO_C         4
 273 #define IWL_MIMO3_SWITCH_MIMO2_AB       5
 274 #define IWL_MIMO3_SWITCH_MIMO2_AC       6
 275 #define IWL_MIMO3_SWITCH_MIMO2_BC       7
 276 #define IWL_MIMO3_SWITCH_GI             8
 277
 278
 279 #define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
 280 #define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC
 281
 282 /*FIXME:RS:add possible actions for MIMO3*/
 283
 284 #define IWL_ACTION_LIMIT                3       /* # possible actions */
 285
 286 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 287
 288 /* load per tid defines for A-MPDU activation */
 289 #define IWL_AGG_TPT_THREHOLD    0
 290 #define IWL_AGG_LOAD_THRESHOLD  10
 291 #define IWL_AGG_ALL_TID         0xff
 292 #define TID_QUEUE_CELL_SPACING  50      /*mS */
 293 #define TID_QUEUE_MAX_SIZE      20
 294 #define TID_ROUND_VALUE         5       /* mS */
 295 #define TID_MAX_LOAD_COUNT      8
 296
 297 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
 298 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
 299
 300 extern const struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
 301 extern const struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT_3945];
 302
 303 enum iwl_table_type {
 304         LQ_NONE,
 305         LQ_G,           /* legacy types */
 306         LQ_A,
 307         LQ_SISO,        /* high-throughput types */
 308         LQ_MIMO2,
 309         LQ_MIMO3,
 310         LQ_MAX,
 311 };
 312
 313 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
 314 #define is_siso(tbl) ((tbl) == LQ_SISO)
 315 #define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
 316 #define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
 317 #define is_mimo(tbl) (is_mimo2(tbl) || is_mimo3(tbl))
 318 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
 319 #define is_a_band(tbl) ((tbl) == LQ_A)
 320 #define is_g_and(tbl) ((tbl) == LQ_G)
 321
 322 #define ANT_NONE        0x0
 323 #define ANT_A           BIT(0)
 324 #define ANT_B           BIT(1)
 325 #define ANT_AB          (ANT_A | ANT_B)
 326 #define ANT_C           BIT(2)
 327 #define ANT_AC          (ANT_A | ANT_C)
 328 #define ANT_BC          (ANT_B | ANT_C)
 329 #define ANT_ABC         (ANT_AB | ANT_C)
 330
 331 #define IWL_MAX_MCS_DISPLAY_SIZE        12
 332
 333 struct iwl_rate_mcs_info {
 334         char    mbps[IWL_MAX_MCS_DISPLAY_SIZE];
 335         char    mcs[IWL_MAX_MCS_DISPLAY_SIZE];
 336 };
 337
 338 static inline u8 num_of_ant(u8 mask)
 339 {
 340         return  !!((mask) & ANT_A) +
 341                 !!((mask) & ANT_B) +
 342                 !!((mask) & ANT_C);
 343 }
 344
 345 static inline u8 first_antenna(u8 mask)
 346 {
 347         if (mask & ANT_A)
 348                 return ANT_A;
 349         if (mask & ANT_B)
 350                 return ANT_B;
 351         return ANT_C;
 352 }
 353
 354
 355 static inline u8 iwl_get_prev_ieee_rate(u8 rate_index)
 356 {
 357         u8 rate = iwl_rates[rate_index].prev_ieee;
 358
 359         if (rate == IWL_RATE_INVALID)
 360                 rate = rate_index;
 361         return rate;
 362 }
 363
 364 static inline u8 iwl3945_get_prev_ieee_rate(u8 rate_index)
 365 {
 366         u8 rate = iwl3945_rates[rate_index].prev_ieee;
 367
 368         if (rate == IWL_RATE_INVALID)
 369                 rate = rate_index;
 370         return rate;
 371 }
 372
 373 /**
 374  * iwl3945_rate_scale_init - Initialize the rate scale table based on assoc info
 375  *
 376  * The specific throughput table used is based on the type of network
 377  * the associated with, including A, B, G, and G w/ TGG protection
 378  */
 379 extern void iwl3945_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
 380
 381 /**
 382  * iwl_rate_control_register - Register the rate control algorithm callbacks
 383  *
 384  * Since the rate control algorithm is hardware specific, there is no need
 385  * or reason to place it as a stand alone module.  The driver can call
 386  * iwl_rate_control_register in order to register the rate control callbacks
 387  * with the mac80211 subsystem.  This should be performed prior to calling
 388  * ieee80211_register_hw
 389  *
 390  */
 391 extern int iwlagn_rate_control_register(void);
 392 extern int iwl3945_rate_control_register(void);
 393
 394 /**
 395  * iwl_rate_control_unregister - Unregister the rate control callbacks
 396  *
 397  * This should be called after calling ieee80211_unregister_hw, but before
 398  * the driver is unloaded.
 399  */
 400 extern void iwlagn_rate_control_unregister(void);
 401 extern void iwl3945_rate_control_unregister(void);
 402
 403 #endif /* __iwl_agn__rs__ */