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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2008 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  * James P. Ketrenos <ipw2100-admin@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26
  27 #ifndef __iwl_4965_rs_h__
  28 #define __iwl_4965_rs_h__
  29
  30 #include "iwl-dev.h"
  31
  32 struct iwl_rate_info {
  33         u8 plcp;        /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  34         u8 plcp_siso;   /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
  35         u8 plcp_mimo2;  /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
  36         u8 plcp_mimo3;  /* uCode API:  IWL_RATE_MIMO3_6M_PLCP, etc. */
  37         u8 ieee;        /* MAC header:  IWL_RATE_6M_IEEE, etc. */
  38         u8 prev_ieee;    /* previous rate in IEEE speeds */
  39         u8 next_ieee;    /* next rate in IEEE speeds */
  40         u8 prev_rs;      /* previous rate used in rs algo */
  41         u8 next_rs;      /* next rate used in rs algo */
  42         u8 prev_rs_tgg;  /* previous rate used in TGG rs algo */
  43         u8 next_rs_tgg;  /* next rate used in TGG rs algo */
  44 };
  45
  46 /*
  47  * These serve as indexes into
  48  * struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
  49  */
  50 enum {
  51         IWL_RATE_1M_INDEX = 0,
  52         IWL_RATE_2M_INDEX,
  53         IWL_RATE_5M_INDEX,
  54         IWL_RATE_11M_INDEX,
  55         IWL_RATE_6M_INDEX,
  56         IWL_RATE_9M_INDEX,
  57         IWL_RATE_12M_INDEX,
  58         IWL_RATE_18M_INDEX,
  59         IWL_RATE_24M_INDEX,
  60         IWL_RATE_36M_INDEX,
  61         IWL_RATE_48M_INDEX,
  62         IWL_RATE_54M_INDEX,
  63         IWL_RATE_60M_INDEX,
  64         IWL_RATE_COUNT, /*FIXME:RS:change to IWL_RATE_INDEX_COUNT,*/
  65         IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
  66         IWL_RATE_INVALID = IWL_RATE_COUNT,
  67 };
  68
  69 enum {
  70         IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
  71         IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
  72         IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
  73         IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
  74 };
  75
  76 /* #define vs. enum to keep from defaulting to 'large integer' */
  77 #define IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
  78 #define IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
  79 #define IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
  80 #define IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
  81 #define IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
  82 #define IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
  83 #define IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
  84 #define IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
  85 #define IWL_RATE_60M_MASK  (1 << IWL_RATE_60M_INDEX)
  86 #define IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
  87 #define IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
  88 #define IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
  89 #define IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)
  90
  91 /* 4965 uCode API values for legacy bit rates, both OFDM and CCK */
  92 enum {
  93         IWL_RATE_6M_PLCP  = 13,
  94         IWL_RATE_9M_PLCP  = 15,
  95         IWL_RATE_12M_PLCP = 5,
  96         IWL_RATE_18M_PLCP = 7,
  97         IWL_RATE_24M_PLCP = 9,
  98         IWL_RATE_36M_PLCP = 11,
  99         IWL_RATE_48M_PLCP = 1,
 100         IWL_RATE_54M_PLCP = 3,
 101         IWL_RATE_60M_PLCP = 3,/*FIXME:RS:should be removed*/
 102         IWL_RATE_1M_PLCP  = 10,
 103         IWL_RATE_2M_PLCP  = 20,
 104         IWL_RATE_5M_PLCP  = 55,
 105         IWL_RATE_11M_PLCP = 110,
 106         /*FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP */
 107         /*FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,*/
 108 };
 109
 110 /* 4965 uCode API values for OFDM high-throughput (HT) bit rates */
 111 enum {
 112         IWL_RATE_SISO_6M_PLCP = 0,
 113         IWL_RATE_SISO_12M_PLCP = 1,
 114         IWL_RATE_SISO_18M_PLCP = 2,
 115         IWL_RATE_SISO_24M_PLCP = 3,
 116         IWL_RATE_SISO_36M_PLCP = 4,
 117         IWL_RATE_SISO_48M_PLCP = 5,
 118         IWL_RATE_SISO_54M_PLCP = 6,
 119         IWL_RATE_SISO_60M_PLCP = 7,
 120         IWL_RATE_MIMO2_6M_PLCP  = 0x8,
 121         IWL_RATE_MIMO2_12M_PLCP = 0x9,
 122         IWL_RATE_MIMO2_18M_PLCP = 0xa,
 123         IWL_RATE_MIMO2_24M_PLCP = 0xb,
 124         IWL_RATE_MIMO2_36M_PLCP = 0xc,
 125         IWL_RATE_MIMO2_48M_PLCP = 0xd,
 126         IWL_RATE_MIMO2_54M_PLCP = 0xe,
 127         IWL_RATE_MIMO2_60M_PLCP = 0xf,
 128         IWL_RATE_MIMO3_6M_PLCP  = 0x10,
 129         IWL_RATE_MIMO3_12M_PLCP = 0x11,
 130         IWL_RATE_MIMO3_18M_PLCP = 0x12,
 131         IWL_RATE_MIMO3_24M_PLCP = 0x13,
 132         IWL_RATE_MIMO3_36M_PLCP = 0x14,
 133         IWL_RATE_MIMO3_48M_PLCP = 0x15,
 134         IWL_RATE_MIMO3_54M_PLCP = 0x16,
 135         IWL_RATE_MIMO3_60M_PLCP = 0x17,
 136         IWL_RATE_SISO_INVM_PLCP,
 137         IWL_RATE_MIMO2_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
 138         IWL_RATE_MIMO3_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
 139 };
 140
 141 /* MAC header values for bit rates */
 142 enum {
 143         IWL_RATE_6M_IEEE  = 12,
 144         IWL_RATE_9M_IEEE  = 18,
 145         IWL_RATE_12M_IEEE = 24,
 146         IWL_RATE_18M_IEEE = 36,
 147         IWL_RATE_24M_IEEE = 48,
 148         IWL_RATE_36M_IEEE = 72,
 149         IWL_RATE_48M_IEEE = 96,
 150         IWL_RATE_54M_IEEE = 108,
 151         IWL_RATE_60M_IEEE = 120,
 152         IWL_RATE_1M_IEEE  = 2,
 153         IWL_RATE_2M_IEEE  = 4,
 154         IWL_RATE_5M_IEEE  = 11,
 155         IWL_RATE_11M_IEEE = 22,
 156 };
 157
 158 #define IWL_CCK_BASIC_RATES_MASK    \
 159        (IWL_RATE_1M_MASK          | \
 160         IWL_RATE_2M_MASK)
 161
 162 #define IWL_CCK_RATES_MASK          \
 163        (IWL_BASIC_RATES_MASK      | \
 164         IWL_RATE_5M_MASK          | \
 165         IWL_RATE_11M_MASK)
 166
 167 #define IWL_OFDM_BASIC_RATES_MASK   \
 168         (IWL_RATE_6M_MASK         | \
 169         IWL_RATE_12M_MASK         | \
 170         IWL_RATE_24M_MASK)
 171
 172 #define IWL_OFDM_RATES_MASK         \
 173        (IWL_OFDM_BASIC_RATES_MASK | \
 174         IWL_RATE_9M_MASK          | \
 175         IWL_RATE_18M_MASK         | \
 176         IWL_RATE_36M_MASK         | \
 177         IWL_RATE_48M_MASK         | \
 178         IWL_RATE_54M_MASK)
 179
 180 #define IWL_BASIC_RATES_MASK         \
 181         (IWL_OFDM_BASIC_RATES_MASK | \
 182          IWL_CCK_BASIC_RATES_MASK)
 183
 184 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 185
 186 #define IWL_INVALID_VALUE    -1
 187
 188 #define IWL_MIN_RSSI_VAL                 -100
 189 #define IWL_MAX_RSSI_VAL                    0
 190
 191 /* These values specify how many Tx frame attempts before
 192  * searching for a new modulation mode */
 193 #define IWL_LEGACY_FAILURE_LIMIT        160
 194 #define IWL_LEGACY_SUCCESS_LIMIT        480
 195 #define IWL_LEGACY_TABLE_COUNT          160
 196
 197 #define IWL_NONE_LEGACY_FAILURE_LIMIT   400
 198 #define IWL_NONE_LEGACY_SUCCESS_LIMIT   4500
 199 #define IWL_NONE_LEGACY_TABLE_COUNT     1500
 200
 201 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
 202 #define IWL_RS_GOOD_RATIO               12800   /* 100% */
 203 #define IWL_RATE_SCALE_SWITCH           10880   /*  85% */
 204 #define IWL_RATE_HIGH_TH                10880   /*  85% */
 205 #define IWL_RATE_INCREASE_TH            8960    /*  70% */
 206 #define IWL_RATE_DECREASE_TH            1920    /*  15% */
 207
 208 /* possible actions when in legacy mode */
 209 #define IWL_LEGACY_SWITCH_ANTENNA       0
 210 #define IWL_LEGACY_SWITCH_SISO          1
 211 #define IWL_LEGACY_SWITCH_MIMO2         2
 212
 213 /* possible actions when in siso mode */
 214 #define IWL_SISO_SWITCH_ANTENNA         0
 215 #define IWL_SISO_SWITCH_MIMO2           1
 216 #define IWL_SISO_SWITCH_GI              2
 217
 218 /* possible actions when in mimo mode */
 219 #define IWL_MIMO_SWITCH_ANTENNA_A       0
 220 #define IWL_MIMO_SWITCH_ANTENNA_B       1
 221 #define IWL_MIMO_SWITCH_GI              2
 222
 223 /*FIXME:RS:separate MIMO2/3 transitions*/
 224
 225 /*FIXME:RS:add posible acctions for MIMO3*/
 226
 227 #define IWL_ACTION_LIMIT                3       /* # possible actions */
 228
 229 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 230
 231 /* load per tid defines for A-MPDU activation */
 232 #define IWL_AGG_TPT_THREHOLD    0
 233 #define IWL_AGG_LOAD_THRESHOLD  10
 234 #define IWL_AGG_ALL_TID         0xff
 235 #define TID_QUEUE_CELL_SPACING  50      /*mS */
 236 #define TID_QUEUE_MAX_SIZE      20
 237 #define TID_ROUND_VALUE         5       /* mS */
 238 #define TID_MAX_LOAD_COUNT      8
 239
 240 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
 241 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
 242
 243 extern const struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
 244
 245 enum iwl_table_type {
 246         LQ_NONE,
 247         LQ_G,           /* legacy types */
 248         LQ_A,
 249         LQ_SISO,        /* high-throughput types */
 250         LQ_MIMO2,
 251         LQ_MIMO3,
 252         LQ_MAX,
 253 };
 254
 255 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
 256 #define is_siso(tbl) ((tbl) == LQ_SISO)
 257 #define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
 258 #define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
 259 #define is_mimo(tbl) (is_mimo2(tbl) || is_mimo3(tbl))
 260 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
 261 #define is_a_band(tbl) ((tbl) == LQ_A)
 262 #define is_g_and(tbl) ((tbl) == LQ_G)
 263
 264 #define ANT_NONE        0x0
 265 #define ANT_A           BIT(0)
 266 #define ANT_B           BIT(1)
 267 #define ANT_AB          (ANT_A | ANT_B)
 268 #define ANT_C           BIT(2)
 269 #define ANT_AC          (ANT_A | ANT_C)
 270 #define ANT_BC          (ANT_B | ANT_C)
 271 #define ANT_ABC         (ANT_AB | ANT_C)
 272
 273 static inline u8 num_of_ant(u8 mask)
 274 {
 275         return  !!((mask) & ANT_A) +
 276                 !!((mask) & ANT_B) +
 277                 !!((mask) & ANT_C);
 278 }
 279
 280 static inline u8 iwl4965_get_prev_ieee_rate(u8 rate_index)
 281 {
 282         u8 rate = iwl_rates[rate_index].prev_ieee;
 283
 284         if (rate == IWL_RATE_INVALID)
 285                 rate = rate_index;
 286         return rate;
 287 }
 288
 289 /**
 290  * iwl4965_fill_rs_info - Fill an output text buffer with the rate representation
 291  *
 292  * NOTE:  This is provided as a quick mechanism for a user to visualize
 293  * the performance of the rate control algorithm and is not meant to be
 294  * parsed software.
 295  */
 296 extern int iwl4965_fill_rs_info(struct ieee80211_hw *, char *buf, u8 sta_id);
 297
 298 /**
 299  * iwl4965_rate_control_register - Register the rate control algorithm callbacks
 300  *
 301  * Since the rate control algorithm is hardware specific, there is no need
 302  * or reason to place it as a stand alone module.  The driver can call
 303  * iwl4965_rate_control_register in order to register the rate control callbacks
 304  * with the mac80211 subsystem.  This should be performed prior to calling
 305  * ieee80211_register_hw
 306  *
 307  */
 308 extern int iwl4965_rate_control_register(void);
 309
 310 /**
 311  * iwl4965_rate_control_unregister - Unregister the rate control callbacks
 312  *
 313  * This should be called after calling ieee80211_unregister_hw, but before
 314  * the driver is unloaded.
 315  */
 316 extern void iwl4965_rate_control_unregister(void);
 317
 318 #endif