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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2007 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-4965.h"
  31
  32 struct iwl4965_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_mimo;   /* uCode API:  IWL_RATE_MIMO_6M_PLCP, etc. */
  36         u8 ieee;        /* MAC header:  IWL_RATE_6M_IEEE, etc. */
  37         u8 prev_ieee;    /* previous rate in IEEE speeds */
  38         u8 next_ieee;    /* next rate in IEEE speeds */
  39         u8 prev_rs;      /* previous rate used in rs algo */
  40         u8 next_rs;      /* next rate used in rs algo */
  41         u8 prev_rs_tgg;  /* previous rate used in TGG rs algo */
  42         u8 next_rs_tgg;  /* next rate used in TGG rs algo */
  43 };
  44
  45 /*
  46  * These serve as indexes into
  47  * struct iwl4965_rate_info iwl4965_rates[IWL_RATE_COUNT];
  48  */
  49 enum {
  50         IWL_RATE_1M_INDEX = 0,
  51         IWL_RATE_2M_INDEX,
  52         IWL_RATE_5M_INDEX,
  53         IWL_RATE_11M_INDEX,
  54         IWL_RATE_6M_INDEX,
  55         IWL_RATE_9M_INDEX,
  56         IWL_RATE_12M_INDEX,
  57         IWL_RATE_18M_INDEX,
  58         IWL_RATE_24M_INDEX,
  59         IWL_RATE_36M_INDEX,
  60         IWL_RATE_48M_INDEX,
  61         IWL_RATE_54M_INDEX,
  62         IWL_RATE_60M_INDEX,
  63         IWL_RATE_COUNT,
  64         IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
  65         IWL_RATE_INVALID = IWL_RATE_INVM_INDEX
  66 };
  67
  68 enum {
  69         IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
  70         IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
  71         IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
  72         IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
  73 };
  74
  75 /* #define vs. enum to keep from defaulting to 'large integer' */
  76 #define IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
  77 #define IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
  78 #define IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
  79 #define IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
  80 #define IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
  81 #define IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
  82 #define IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
  83 #define IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
  84 #define IWL_RATE_60M_MASK  (1 << IWL_RATE_60M_INDEX)
  85 #define IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
  86 #define IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
  87 #define IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
  88 #define IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)
  89
  90 /* 4965 uCode API values for legacy bit rates, both OFDM and CCK */
  91 enum {
  92         IWL_RATE_6M_PLCP  = 13,
  93         IWL_RATE_9M_PLCP  = 15,
  94         IWL_RATE_12M_PLCP = 5,
  95         IWL_RATE_18M_PLCP = 7,
  96         IWL_RATE_24M_PLCP = 9,
  97         IWL_RATE_36M_PLCP = 11,
  98         IWL_RATE_48M_PLCP = 1,
  99         IWL_RATE_54M_PLCP = 3,
 100         IWL_RATE_60M_PLCP = 3,
 101         IWL_RATE_1M_PLCP  = 10,
 102         IWL_RATE_2M_PLCP  = 20,
 103         IWL_RATE_5M_PLCP  = 55,
 104         IWL_RATE_11M_PLCP = 110,
 105 };
 106
 107 /* 4965 uCode API values for OFDM high-throughput (HT) bit rates */
 108 enum {
 109         IWL_RATE_SISO_6M_PLCP = 0,
 110         IWL_RATE_SISO_12M_PLCP = 1,
 111         IWL_RATE_SISO_18M_PLCP = 2,
 112         IWL_RATE_SISO_24M_PLCP = 3,
 113         IWL_RATE_SISO_36M_PLCP = 4,
 114         IWL_RATE_SISO_48M_PLCP = 5,
 115         IWL_RATE_SISO_54M_PLCP = 6,
 116         IWL_RATE_SISO_60M_PLCP = 7,
 117         IWL_RATE_MIMO_6M_PLCP  = 0x8,
 118         IWL_RATE_MIMO_12M_PLCP = 0x9,
 119         IWL_RATE_MIMO_18M_PLCP = 0xa,
 120         IWL_RATE_MIMO_24M_PLCP = 0xb,
 121         IWL_RATE_MIMO_36M_PLCP = 0xc,
 122         IWL_RATE_MIMO_48M_PLCP = 0xd,
 123         IWL_RATE_MIMO_54M_PLCP = 0xe,
 124         IWL_RATE_MIMO_60M_PLCP = 0xf,
 125         IWL_RATE_SISO_INVM_PLCP,
 126         IWL_RATE_MIMO_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
 127 };
 128
 129 /* MAC header values for bit rates */
 130 enum {
 131         IWL_RATE_6M_IEEE  = 12,
 132         IWL_RATE_9M_IEEE  = 18,
 133         IWL_RATE_12M_IEEE = 24,
 134         IWL_RATE_18M_IEEE = 36,
 135         IWL_RATE_24M_IEEE = 48,
 136         IWL_RATE_36M_IEEE = 72,
 137         IWL_RATE_48M_IEEE = 96,
 138         IWL_RATE_54M_IEEE = 108,
 139         IWL_RATE_60M_IEEE = 120,
 140         IWL_RATE_1M_IEEE  = 2,
 141         IWL_RATE_2M_IEEE  = 4,
 142         IWL_RATE_5M_IEEE  = 11,
 143         IWL_RATE_11M_IEEE = 22,
 144 };
 145
 146 #define IWL_CCK_BASIC_RATES_MASK    \
 147        (IWL_RATE_1M_MASK          | \
 148         IWL_RATE_2M_MASK)
 149
 150 #define IWL_CCK_RATES_MASK          \
 151        (IWL_BASIC_RATES_MASK      | \
 152         IWL_RATE_5M_MASK          | \
 153         IWL_RATE_11M_MASK)
 154
 155 #define IWL_OFDM_BASIC_RATES_MASK   \
 156         (IWL_RATE_6M_MASK         | \
 157         IWL_RATE_12M_MASK         | \
 158         IWL_RATE_24M_MASK)
 159
 160 #define IWL_OFDM_RATES_MASK         \
 161        (IWL_OFDM_BASIC_RATES_MASK | \
 162         IWL_RATE_9M_MASK          | \
 163         IWL_RATE_18M_MASK         | \
 164         IWL_RATE_36M_MASK         | \
 165         IWL_RATE_48M_MASK         | \
 166         IWL_RATE_54M_MASK)
 167
 168 #define IWL_BASIC_RATES_MASK         \
 169         (IWL_OFDM_BASIC_RATES_MASK | \
 170          IWL_CCK_BASIC_RATES_MASK)
 171
 172 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 173
 174 #define IWL_INVALID_VALUE    -1
 175
 176 #define IWL_MIN_RSSI_VAL                 -100
 177 #define IWL_MAX_RSSI_VAL                    0
 178
 179 /* These values specify how many Tx frame attempts before
 180  * searching for a new modulation mode */
 181 #define IWL_LEGACY_FAILURE_LIMIT        160
 182 #define IWL_LEGACY_SUCCESS_LIMIT        480
 183 #define IWL_LEGACY_TABLE_COUNT          160
 184
 185 #define IWL_NONE_LEGACY_FAILURE_LIMIT   400
 186 #define IWL_NONE_LEGACY_SUCCESS_LIMIT   4500
 187 #define IWL_NONE_LEGACY_TABLE_COUNT     1500
 188
 189 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
 190 #define IWL_RS_GOOD_RATIO               12800   /* 100% */
 191 #define IWL_RATE_SCALE_SWITCH           10880   /*  85% */
 192 #define IWL_RATE_HIGH_TH                10880   /*  85% */
 193 #define IWL_RATE_INCREASE_TH            8960    /*  70% */
 194 #define IWL_RATE_DECREASE_TH            1920    /*  15% */
 195
 196 /* possible actions when in legacy mode */
 197 #define IWL_LEGACY_SWITCH_ANTENNA       0
 198 #define IWL_LEGACY_SWITCH_SISO          1
 199 #define IWL_LEGACY_SWITCH_MIMO          2
 200
 201 /* possible actions when in siso mode */
 202 #define IWL_SISO_SWITCH_ANTENNA         0
 203 #define IWL_SISO_SWITCH_MIMO            1
 204 #define IWL_SISO_SWITCH_GI              2
 205
 206 /* possible actions when in mimo mode */
 207 #define IWL_MIMO_SWITCH_ANTENNA_A       0
 208 #define IWL_MIMO_SWITCH_ANTENNA_B       1
 209 #define IWL_MIMO_SWITCH_GI              2
 210
 211 #define IWL_ACTION_LIMIT                3       /* # possible actions */
 212
 213 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 214
 215 extern const struct iwl4965_rate_info iwl4965_rates[IWL_RATE_COUNT];
 216
 217 enum iwl4965_table_type {
 218         LQ_NONE,
 219         LQ_G,           /* legacy types */
 220         LQ_A,
 221         LQ_SISO,        /* high-throughput types */
 222         LQ_MIMO,
 223         LQ_MAX,
 224 };
 225
 226 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
 227 #define is_siso(tbl) (((tbl) == LQ_SISO))
 228 #define is_mimo(tbl) (((tbl) == LQ_MIMO))
 229 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
 230 #define is_a_band(tbl) (((tbl) == LQ_A))
 231 #define is_g_and(tbl) (((tbl) == LQ_G))
 232
 233 /* 4965 has 2 antennas/chains for Tx (but 3 for Rx) */
 234 enum iwl4965_antenna_type {
 235         ANT_NONE,
 236         ANT_MAIN,
 237         ANT_AUX,
 238         ANT_BOTH,
 239 };
 240
 241 static inline u8 iwl4965_get_prev_ieee_rate(u8 rate_index)
 242 {
 243         u8 rate = iwl4965_rates[rate_index].prev_ieee;
 244
 245         if (rate == IWL_RATE_INVALID)
 246                 rate = rate_index;
 247         return rate;
 248 }
 249
 250 extern int iwl4965_rate_index_from_plcp(int plcp);
 251
 252 /**
 253  * iwl4965_fill_rs_info - Fill an output text buffer with the rate representation
 254  *
 255  * NOTE:  This is provided as a quick mechanism for a user to visualize
 256  * the performance of the rate control algorithm and is not meant to be
 257  * parsed software.
 258  */
 259 extern int iwl4965_fill_rs_info(struct ieee80211_hw *, char *buf, u8 sta_id);
 260
 261 /**
 262  * iwl4965_rate_scale_init - Initialize the rate scale table based on assoc info
 263  *
 264  * The specific throughput table used is based on the type of network
 265  * the associated with, including A, B, G, and G w/ TGG protection
 266  */
 267 extern void iwl4965_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
 268
 269 /**
 270  * iwl4965_rate_control_register - Register the rate control algorithm callbacks
 271  *
 272  * Since the rate control algorithm is hardware specific, there is no need
 273  * or reason to place it as a stand alone module.  The driver can call
 274  * iwl4965_rate_control_register in order to register the rate control callbacks
 275  * with the mac80211 subsystem.  This should be performed prior to calling
 276  * ieee80211_register_hw
 277  *
 278  */
 279 extern void iwl4965_rate_control_register(struct ieee80211_hw *hw);
 280
 281 /**
 282  * iwl4965_rate_control_unregister - Unregister the rate control callbacks
 283  *
 284  * This should be called after calling ieee80211_unregister_hw, but before
 285  * the driver is unloaded.
 286  */
 287 extern void iwl4965_rate_control_unregister(struct ieee80211_hw *hw);
 288
 289 #endif