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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2014 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 TPC_MAX_REDUCTION               15
 141 #define TPC_NO_REDUCTION                0
 142 #define TPC_INVALID                     0xff
 143
 144 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF   (63)
 145 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX   (63)
 146 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN   (0)
 147
 148 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 149
 150 /* load per tid defines for A-MPDU activation */
 151 #define IWL_AGG_TPT_THREHOLD    0
 152 #define IWL_AGG_ALL_TID         0xff
 153
 154 enum iwl_table_type {
 155         LQ_NONE,
 156         LQ_LEGACY_G,    /* legacy types */
 157         LQ_LEGACY_A,
 158         LQ_HT_SISO,     /* HT types */
 159         LQ_HT_MIMO2,
 160         LQ_VHT_SISO,    /* VHT types */
 161         LQ_VHT_MIMO2,
 162         LQ_MAX,
 163 };
 164
 165 struct rs_rate {
 166         int index;
 167         enum iwl_table_type type;
 168         u8 ant;
 169         u32 bw;
 170         bool sgi;
 171         bool ldpc;
 172         bool stbc;
 173         bool bfer;
 174 };
 175
 176
 177 #define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \
 178                               ((type) == LQ_LEGACY_A))
 179 #define is_type_ht_siso(type) ((type) == LQ_HT_SISO)
 180 #define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)
 181 #define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)
 182 #define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)
 183 #define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type))
 184 #define is_type_mimo2(type) (is_type_ht_mimo2(type) || is_type_vht_mimo2(type))
 185 #define is_type_mimo(type) (is_type_mimo2(type))
 186 #define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type))
 187 #define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type))
 188 #define is_type_a_band(type) ((type) == LQ_LEGACY_A)
 189 #define is_type_g_band(type) ((type) == LQ_LEGACY_G)
 190
 191 #define is_legacy(rate)       is_type_legacy((rate)->type)
 192 #define is_ht_siso(rate)      is_type_ht_siso((rate)->type)
 193 #define is_ht_mimo2(rate)     is_type_ht_mimo2((rate)->type)
 194 #define is_vht_siso(rate)     is_type_vht_siso((rate)->type)
 195 #define is_vht_mimo2(rate)    is_type_vht_mimo2((rate)->type)
 196 #define is_siso(rate)         is_type_siso((rate)->type)
 197 #define is_mimo2(rate)        is_type_mimo2((rate)->type)
 198 #define is_mimo(rate)         is_type_mimo((rate)->type)
 199 #define is_ht(rate)           is_type_ht((rate)->type)
 200 #define is_vht(rate)          is_type_vht((rate)->type)
 201 #define is_a_band(rate)       is_type_a_band((rate)->type)
 202 #define is_g_band(rate)       is_type_g_band((rate)->type)
 203
 204 #define is_ht20(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)
 205 #define is_ht40(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)
 206 #define is_ht80(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)
 207
 208 #define IWL_MAX_MCS_DISPLAY_SIZE        12
 209
 210 struct iwl_rate_mcs_info {
 211         char    mbps[IWL_MAX_MCS_DISPLAY_SIZE];
 212         char    mcs[IWL_MAX_MCS_DISPLAY_SIZE];
 213 };
 214
 215 /**
 216  * struct iwl_rate_scale_data -- tx success history for one rate
 217  */
 218 struct iwl_rate_scale_data {
 219         u64 data;               /* bitmap of successful frames */
 220         s32 success_counter;    /* number of frames successful */
 221         s32 success_ratio;      /* per-cent * 128  */
 222         s32 counter;            /* number of frames attempted */
 223         s32 average_tpt;        /* success ratio * expected throughput */
 224 };
 225
 226 /* Possible Tx columns
 227  * Tx Column = a combo of legacy/siso/mimo x antenna x SGI
 228  */
 229 enum rs_column {
 230         RS_COLUMN_LEGACY_ANT_A = 0,
 231         RS_COLUMN_LEGACY_ANT_B,
 232         RS_COLUMN_SISO_ANT_A,
 233         RS_COLUMN_SISO_ANT_B,
 234         RS_COLUMN_SISO_ANT_A_SGI,
 235         RS_COLUMN_SISO_ANT_B_SGI,
 236         RS_COLUMN_MIMO2,
 237         RS_COLUMN_MIMO2_SGI,
 238
 239         RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,
 240         RS_COLUMN_COUNT = RS_COLUMN_LAST + 1,
 241         RS_COLUMN_INVALID,
 242 };
 243
 244 enum rs_ss_force_opt {
 245         RS_SS_FORCE_NONE = 0,
 246         RS_SS_FORCE_STBC,
 247         RS_SS_FORCE_BFER,
 248         RS_SS_FORCE_SISO,
 249 };
 250
 251 /* Packet stats per rate */
 252 struct rs_rate_stats {
 253         u64 success;
 254         u64 total;
 255 };
 256
 257 /**
 258  * struct iwl_scale_tbl_info -- tx params and success history for all rates
 259  *
 260  * There are two of these in struct iwl_lq_sta,
 261  * one for "active", and one for "search".
 262  */
 263 struct iwl_scale_tbl_info {
 264         struct rs_rate rate;
 265         enum rs_column column;
 266         const u16 *expected_tpt;        /* throughput metrics; expected_tpt_G, etc. */
 267         struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
 268         /* per txpower-reduction history */
 269         struct iwl_rate_scale_data tpc_win[TPC_MAX_REDUCTION + 1];
 270 };
 271
 272 enum {
 273         RS_STATE_SEARCH_CYCLE_STARTED,
 274         RS_STATE_SEARCH_CYCLE_ENDED,
 275         RS_STATE_STAY_IN_COLUMN,
 276 };
 277
 278 /**
 279  * struct iwl_lq_sta -- driver's rate scaling private structure
 280  *
 281  * Pointer to this gets passed back and forth between driver and mac80211.
 282  */
 283 struct iwl_lq_sta {
 284         u8 active_tbl;          /* index of active table, range 0-1 */
 285         u8 rs_state;            /* RS_STATE_* */
 286         u8 search_better_tbl;   /* 1: currently trying alternate mode */
 287         s32 last_tpt;
 288
 289         /* The following determine when to search for a new mode */
 290         u32 table_count_limit;
 291         u32 max_failure_limit;  /* # failed frames before new search */
 292         u32 max_success_limit;  /* # successful frames before new search */
 293         u32 table_count;
 294         u32 total_failed;       /* total failed frames, any/all rates */
 295         u32 total_success;      /* total successful frames, any/all rates */
 296         u64 flush_timer;        /* time staying in mode before new search */
 297
 298         u32 visited_columns;    /* Bitmask marking which Tx columns were
 299                                  * explored during a search cycle
 300                                  */
 301         u64 last_tx;
 302         bool is_vht;
 303         bool ldpc;              /* LDPC Rx is supported by the STA */
 304         bool stbc_capable;      /* Tx STBC is supported by chip and Rx by STA */
 305         bool bfer_capable;      /* Remote supports beamformee and we BFer */
 306
 307         enum ieee80211_band band;
 308
 309         /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
 310         unsigned long active_legacy_rate;
 311         unsigned long active_siso_rate;
 312         unsigned long active_mimo2_rate;
 313
 314         /* Highest rate per Tx mode */
 315         u8 max_legacy_rate_idx;
 316         u8 max_siso_rate_idx;
 317         u8 max_mimo2_rate_idx;
 318
 319         u8 missed_rate_counter;
 320
 321         struct iwl_lq_cmd lq;
 322         struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
 323         u8 tx_agg_tid_en;
 324
 325         /* used to be in sta_info */
 326         int last_txrate_idx;
 327         /* last tx rate_n_flags */
 328         u32 last_rate_n_flags;
 329         /* packets destined for this STA are aggregated */
 330         u8 is_agg;
 331
 332         /* tx power reduce for this sta */
 333         int tpc_reduce;
 334
 335         /* persistent fields - initialized only once - keep last! */
 336         struct lq_sta_pers {
 337 #ifdef CONFIG_MAC80211_DEBUGFS
 338                 u32 dbg_fixed_rate;
 339                 u8 dbg_fixed_txp_reduction;
 340
 341                 /* force STBC/BFER/SISO for testing */
 342                 enum rs_ss_force_opt ss_force;
 343 #endif
 344                 u8 chains;
 345                 s8 chain_signal[IEEE80211_MAX_CHAINS];
 346                 struct rs_rate_stats tx_stats[RS_COLUMN_COUNT][IWL_RATE_COUNT];
 347                 struct iwl_mvm *drv;
 348         } pers;
 349 };
 350
 351 /* Initialize station's rate scaling information after adding station */
 352 void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
 353                           enum ieee80211_band band, bool init);
 354
 355 /* Notify RS about Tx status */
 356 void iwl_mvm_rs_tx_status(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
 357                           int tid, struct ieee80211_tx_info *info);
 358
 359 /**
 360  * iwl_rate_control_register - Register the rate control algorithm callbacks
 361  *
 362  * Since the rate control algorithm is hardware specific, there is no need
 363  * or reason to place it as a stand alone module.  The driver can call
 364  * iwl_rate_control_register in order to register the rate control callbacks
 365  * with the mac80211 subsystem.  This should be performed prior to calling
 366  * ieee80211_register_hw
 367  *
 368  */
 369 int iwl_mvm_rate_control_register(void);
 370
 371 /**
 372  * iwl_rate_control_unregister - Unregister the rate control callbacks
 373  *
 374  * This should be called after calling ieee80211_unregister_hw, but before
 375  * the driver is unloaded.
 376  */
 377 void iwl_mvm_rate_control_unregister(void);
 378
 379 struct iwl_mvm_sta;
 380
 381 int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
 382                           bool enable);
 383
 384 #endif /* __rs__ */