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