drivers/net/wireless/iwlwifi/mvm/rs.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2013 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 __rs_h__
  28 #define __rs_h__
  29
  30 #include <net/mac80211.h>
  31
  32 #include "iwl-config.h"
  33
  34 #include "fw-api.h"
  35 #include "iwl-trans.h"
  36
  37 struct iwl_rs_rate_info {
  38         u8 plcp;          /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  39         u8 plcp_ht_siso;  /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
  40         u8 plcp_ht_mimo2; /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
  41         u8 plcp_vht_siso;
  42         u8 plcp_vht_mimo2;
  43         u8 prev_rs;      /* previous rate used in rs algo */
  44         u8 next_rs;      /* next rate used in rs algo */
  45 };
  46
  47 #define IWL_RATE_60M_PLCP 3
  48
  49 enum {
  50         IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
  51         IWL_RATE_INVALID = IWL_RATE_COUNT,
  52 };
  53
  54 #define LINK_QUAL_MAX_RETRY_NUM 16
  55
  56 enum {
  57         IWL_RATE_6M_INDEX_TABLE = 0,
  58         IWL_RATE_9M_INDEX_TABLE,
  59         IWL_RATE_12M_INDEX_TABLE,
  60         IWL_RATE_18M_INDEX_TABLE,
  61         IWL_RATE_24M_INDEX_TABLE,
  62         IWL_RATE_36M_INDEX_TABLE,
  63         IWL_RATE_48M_INDEX_TABLE,
  64         IWL_RATE_54M_INDEX_TABLE,
  65         IWL_RATE_1M_INDEX_TABLE,
  66         IWL_RATE_2M_INDEX_TABLE,
  67         IWL_RATE_5M_INDEX_TABLE,
  68         IWL_RATE_11M_INDEX_TABLE,
  69         IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
  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
  88 /* uCode API values for HT/VHT bit rates */
  89 enum {
  90         IWL_RATE_HT_SISO_MCS_0_PLCP = 0,
  91         IWL_RATE_HT_SISO_MCS_1_PLCP = 1,
  92         IWL_RATE_HT_SISO_MCS_2_PLCP = 2,
  93         IWL_RATE_HT_SISO_MCS_3_PLCP = 3,
  94         IWL_RATE_HT_SISO_MCS_4_PLCP = 4,
  95         IWL_RATE_HT_SISO_MCS_5_PLCP = 5,
  96         IWL_RATE_HT_SISO_MCS_6_PLCP = 6,
  97         IWL_RATE_HT_SISO_MCS_7_PLCP = 7,
  98         IWL_RATE_HT_MIMO2_MCS_0_PLCP = 0x8,
  99         IWL_RATE_HT_MIMO2_MCS_1_PLCP = 0x9,
 100         IWL_RATE_HT_MIMO2_MCS_2_PLCP = 0xA,
 101         IWL_RATE_HT_MIMO2_MCS_3_PLCP = 0xB,
 102         IWL_RATE_HT_MIMO2_MCS_4_PLCP = 0xC,
 103         IWL_RATE_HT_MIMO2_MCS_5_PLCP = 0xD,
 104         IWL_RATE_HT_MIMO2_MCS_6_PLCP = 0xE,
 105         IWL_RATE_HT_MIMO2_MCS_7_PLCP = 0xF,
 106         IWL_RATE_VHT_SISO_MCS_0_PLCP = 0,
 107         IWL_RATE_VHT_SISO_MCS_1_PLCP = 1,
 108         IWL_RATE_VHT_SISO_MCS_2_PLCP = 2,
 109         IWL_RATE_VHT_SISO_MCS_3_PLCP = 3,
 110         IWL_RATE_VHT_SISO_MCS_4_PLCP = 4,
 111         IWL_RATE_VHT_SISO_MCS_5_PLCP = 5,
 112         IWL_RATE_VHT_SISO_MCS_6_PLCP = 6,
 113         IWL_RATE_VHT_SISO_MCS_7_PLCP = 7,
 114         IWL_RATE_VHT_SISO_MCS_8_PLCP = 8,
 115         IWL_RATE_VHT_SISO_MCS_9_PLCP = 9,
 116         IWL_RATE_VHT_MIMO2_MCS_0_PLCP = 0x10,
 117         IWL_RATE_VHT_MIMO2_MCS_1_PLCP = 0x11,
 118         IWL_RATE_VHT_MIMO2_MCS_2_PLCP = 0x12,
 119         IWL_RATE_VHT_MIMO2_MCS_3_PLCP = 0x13,
 120         IWL_RATE_VHT_MIMO2_MCS_4_PLCP = 0x14,
 121         IWL_RATE_VHT_MIMO2_MCS_5_PLCP = 0x15,
 122         IWL_RATE_VHT_MIMO2_MCS_6_PLCP = 0x16,
 123         IWL_RATE_VHT_MIMO2_MCS_7_PLCP = 0x17,
 124         IWL_RATE_VHT_MIMO2_MCS_8_PLCP = 0x18,
 125         IWL_RATE_VHT_MIMO2_MCS_9_PLCP = 0x19,
 126         IWL_RATE_HT_SISO_MCS_INV_PLCP,
 127         IWL_RATE_HT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 128         IWL_RATE_VHT_SISO_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 129         IWL_RATE_VHT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 130         IWL_RATE_HT_SISO_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 131         IWL_RATE_HT_SISO_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 132         IWL_RATE_HT_MIMO2_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 133         IWL_RATE_HT_MIMO2_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 134 };
 135
 136 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 137
 138 #define IWL_INVALID_VALUE    -1
 139
 140 #define IWL_MIN_RSSI_VAL                 -100
 141 #define IWL_MAX_RSSI_VAL                    0
 142
 143 /* These values specify how many Tx frame attempts before
 144  * searching for a new modulation mode */
 145 #define IWL_LEGACY_FAILURE_LIMIT        160
 146 #define IWL_LEGACY_SUCCESS_LIMIT        480
 147 #define IWL_LEGACY_TABLE_COUNT          160
 148
 149 #define IWL_NONE_LEGACY_FAILURE_LIMIT   400
 150 #define IWL_NONE_LEGACY_SUCCESS_LIMIT   4500
 151 #define IWL_NONE_LEGACY_TABLE_COUNT     1500
 152
 153 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
 154 #define IWL_RS_GOOD_RATIO               12800   /* 100% */
 155 #define IWL_RATE_SCALE_SWITCH           10880   /*  85% */
 156 #define IWL_RATE_HIGH_TH                10880   /*  85% */
 157 #define IWL_RATE_INCREASE_TH            6400    /*  50% */
 158 #define IWL_RATE_DECREASE_TH            1920    /*  15% */
 159
 160 /* possible actions when in legacy mode */
 161 enum {
 162         IWL_LEGACY_SWITCH_ANTENNA,
 163         IWL_LEGACY_SWITCH_SISO,
 164         IWL_LEGACY_SWITCH_MIMO2,
 165         IWL_LEGACY_FIRST_ACTION = IWL_LEGACY_SWITCH_ANTENNA,
 166         IWL_LEGACY_LAST_ACTION = IWL_LEGACY_SWITCH_MIMO2,
 167 };
 168
 169 /* possible actions when in siso mode */
 170 enum {
 171         IWL_SISO_SWITCH_ANTENNA,
 172         IWL_SISO_SWITCH_MIMO2,
 173         IWL_SISO_SWITCH_GI,
 174         IWL_SISO_FIRST_ACTION = IWL_SISO_SWITCH_ANTENNA,
 175         IWL_SISO_LAST_ACTION = IWL_SISO_SWITCH_GI,
 176 };
 177
 178 /* possible actions when in mimo mode */
 179 enum {
 180         IWL_MIMO2_SWITCH_SISO_A,
 181         IWL_MIMO2_SWITCH_SISO_B,
 182         IWL_MIMO2_SWITCH_GI,
 183         IWL_MIMO2_FIRST_ACTION = IWL_MIMO2_SWITCH_SISO_A,
 184         IWL_MIMO2_LAST_ACTION = IWL_MIMO2_SWITCH_GI,
 185 };
 186
 187 #define IWL_MAX_SEARCH IWL_MIMO2_LAST_ACTION
 188
 189 #define IWL_ACTION_LIMIT                3       /* # possible actions */
 190
 191 #define LINK_QUAL_AGG_TIME_LIMIT_DEF    (4000) /* 4 milliseconds */
 192 #define LINK_QUAL_AGG_TIME_LIMIT_MAX    (8000)
 193 #define LINK_QUAL_AGG_TIME_LIMIT_MIN    (100)
 194
 195 #define LINK_QUAL_AGG_DISABLE_START_DEF (3)
 196 #define LINK_QUAL_AGG_DISABLE_START_MAX (255)
 197 #define LINK_QUAL_AGG_DISABLE_START_MIN (0)
 198
 199 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF   (63)
 200 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX   (63)
 201 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN   (0)
 202
 203 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 204
 205 /* load per tid defines for A-MPDU activation */
 206 #define IWL_AGG_TPT_THREHOLD    0
 207 #define IWL_AGG_LOAD_THRESHOLD  10
 208 #define IWL_AGG_ALL_TID         0xff
 209 #define TID_QUEUE_CELL_SPACING  50      /*mS */
 210 #define TID_QUEUE_MAX_SIZE      20
 211 #define TID_ROUND_VALUE         5       /* mS */
 212
 213 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
 214 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
 215
 216 enum iwl_table_type {
 217         LQ_NONE,
 218         LQ_LEGACY_G,    /* legacy types */
 219         LQ_LEGACY_A,
 220         LQ_HT_SISO,     /* HT types */
 221         LQ_HT_MIMO2,
 222         LQ_VHT_SISO,    /* VHT types */
 223         LQ_VHT_MIMO2,
 224         LQ_MAX,
 225 };
 226
 227 #define is_legacy(tbl) (((tbl) == LQ_LEGACY_G) || ((tbl) == LQ_LEGACY_A))
 228 #define is_ht_siso(tbl) ((tbl) == LQ_HT_SISO)
 229 #define is_ht_mimo2(tbl) ((tbl) == LQ_HT_MIMO2)
 230 #define is_vht_siso(tbl) ((tbl) == LQ_VHT_SISO)
 231 #define is_vht_mimo2(tbl) ((tbl) == LQ_VHT_MIMO2)
 232 #define is_siso(tbl) (is_ht_siso(tbl) || is_vht_siso(tbl))
 233 #define is_mimo2(tbl) (is_ht_mimo2(tbl) || is_vht_mimo2(tbl))
 234 #define is_mimo(tbl) (is_mimo2(tbl))
 235 #define is_ht(tbl) (is_ht_siso(tbl) || is_ht_mimo2(tbl))
 236 #define is_vht(tbl) (is_vht_siso(tbl) || is_vht_mimo2(tbl))
 237 #define is_a_band(tbl) ((tbl) == LQ_LEGACY_A)
 238 #define is_g_band(tbl) ((tbl) == LQ_LEGACY_G)
 239
 240 #define is_ht20(tbl) (tbl->bw == RATE_MCS_CHAN_WIDTH_20)
 241 #define is_ht40(tbl) (tbl->bw == RATE_MCS_CHAN_WIDTH_40)
 242 #define is_ht80(tbl) (tbl->bw == RATE_MCS_CHAN_WIDTH_80)
 243
 244 #define IWL_MAX_MCS_DISPLAY_SIZE        12
 245
 246 struct iwl_rate_mcs_info {
 247         char    mbps[IWL_MAX_MCS_DISPLAY_SIZE];
 248         char    mcs[IWL_MAX_MCS_DISPLAY_SIZE];
 249 };
 250
 251 /**
 252  * struct iwl_rate_scale_data -- tx success history for one rate
 253  */
 254 struct iwl_rate_scale_data {
 255         u64 data;               /* bitmap of successful frames */
 256         s32 success_counter;    /* number of frames successful */
 257         s32 success_ratio;      /* per-cent * 128  */
 258         s32 counter;            /* number of frames attempted */
 259         s32 average_tpt;        /* success ratio * expected throughput */
 260         unsigned long stamp;
 261 };
 262
 263 /**
 264  * struct iwl_scale_tbl_info -- tx params and success history for all rates
 265  *
 266  * There are two of these in struct iwl_lq_sta,
 267  * one for "active", and one for "search".
 268  */
 269 struct iwl_scale_tbl_info {
 270         enum iwl_table_type lq_type;
 271         u8 ant_type;
 272         u8 is_SGI;      /* 1 = short guard interval */
 273         u32 bw;         /* channel bandwidth; RATE_MCS_CHAN_WIDTH_XX */
 274         u8 action;      /* change modulation; IWL_[LEGACY/SISO/MIMO]_SWITCH_* */
 275         u8 max_search;  /* maximun number of tables we can search */
 276         s32 *expected_tpt;      /* throughput metrics; expected_tpt_G, etc. */
 277         u32 current_rate;  /* rate_n_flags, uCode API format */
 278         struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
 279 };
 280
 281 /**
 282  * struct iwl_lq_sta -- driver's rate scaling private structure
 283  *
 284  * Pointer to this gets passed back and forth between driver and mac80211.
 285  */
 286 struct iwl_lq_sta {
 287         u8 active_tbl;          /* index of active table, range 0-1 */
 288         u8 enable_counter;      /* indicates HT mode */
 289         u8 stay_in_tbl;         /* 1: disallow, 0: allow search for new mode */
 290         u8 search_better_tbl;   /* 1: currently trying alternate mode */
 291         s32 last_tpt;
 292
 293         /* The following determine when to search for a new mode */
 294         u32 table_count_limit;
 295         u32 max_failure_limit;  /* # failed frames before new search */
 296         u32 max_success_limit;  /* # successful frames before new search */
 297         u32 table_count;
 298         u32 total_failed;       /* total failed frames, any/all rates */
 299         u32 total_success;      /* total successful frames, any/all rates */
 300         u64 flush_timer;        /* time staying in mode before new search */
 301
 302         u8 action_counter;      /* # mode-switch actions tried */
 303         u8 is_green;
 304         bool is_vht;
 305         enum ieee80211_band band;
 306
 307         /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
 308         u32 supp_rates;
 309         u16 active_legacy_rate;
 310         u16 active_siso_rate;
 311         u16 active_mimo2_rate;
 312         s8 max_rate_idx;     /* Max rate set by user */
 313         u8 missed_rate_counter;
 314
 315         struct iwl_lq_cmd lq;
 316         struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
 317         u8 tx_agg_tid_en;
 318 #ifdef CONFIG_MAC80211_DEBUGFS
 319         struct dentry *rs_sta_dbgfs_scale_table_file;
 320         struct dentry *rs_sta_dbgfs_stats_table_file;
 321         struct dentry *rs_sta_dbgfs_tx_agg_tid_en_file;
 322         u32 dbg_fixed_rate;
 323 #endif
 324         struct iwl_mvm *drv;
 325
 326         /* used to be in sta_info */
 327         int last_txrate_idx;
 328         /* last tx rate_n_flags */
 329         u32 last_rate_n_flags;
 330         /* packets destined for this STA are aggregated */
 331         u8 is_agg;
 332         /* BT traffic this sta was last updated in */
 333         u8 last_bt_traffic;
 334 };
 335
 336 enum iwl_bt_coex_profile_traffic_load {
 337         IWL_BT_COEX_TRAFFIC_LOAD_NONE           = 0,
 338         IWL_BT_COEX_TRAFFIC_LOAD_LOW            = 1,
 339         IWL_BT_COEX_TRAFFIC_LOAD_HIGH           = 2,
 340         IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS     = 3,
 341 /*
 342  * There are no more even though below is a u8, the
 343  * indication from the BT device only has two bits.
 344  */
 345 };
 346
 347
 348 static inline u8 num_of_ant(u8 mask)
 349 {
 350         return  !!((mask) & ANT_A) +
 351                 !!((mask) & ANT_B) +
 352                 !!((mask) & ANT_C);
 353 }
 354
 355 /* Initialize station's rate scaling information after adding station */
 356 extern void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm,
 357                                  struct ieee80211_sta *sta,
 358                                  enum ieee80211_band band);
 359
 360 /**
 361  * iwl_rate_control_register - Register the rate control algorithm callbacks
 362  *
 363  * Since the rate control algorithm is hardware specific, there is no need
 364  * or reason to place it as a stand alone module.  The driver can call
 365  * iwl_rate_control_register in order to register the rate control callbacks
 366  * with the mac80211 subsystem.  This should be performed prior to calling
 367  * ieee80211_register_hw
 368  *
 369  */
 370 extern int iwl_mvm_rate_control_register(void);
 371
 372 /**
 373  * iwl_rate_control_unregister - Unregister the rate control callbacks
 374  *
 375  * This should be called after calling ieee80211_unregister_hw, but before
 376  * the driver is unloaded.
 377  */
 378 extern void iwl_mvm_rate_control_unregister(void);
 379
 380 struct iwl_mvm_sta;
 381
 382 int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
 383                           bool enable);
 384
 385 #endif /* __rs__ */