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