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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2014 Intel Corporation. All rights reserved.
   4  * Copyright(c) 2015 Intel Mobile Communications GmbH
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of version 2 of the GNU General Public License as
   8  * published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  18  *
  19  * The full GNU General Public License is included in this distribution in the
  20  * file called LICENSE.
  21  *
  22  * Contact Information:
  23  *  Intel Linux Wireless <linuxwifi@intel.com>
  24  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25  *
  26  *****************************************************************************/
  27
  28 #ifndef __rs_h__
  29 #define __rs_h__
  30
  31 #include <net/mac80211.h>
  32
  33 #include "iwl-config.h"
  34
  35 #include "fw-api.h"
  36 #include "iwl-trans.h"
  37
  38 struct iwl_rs_rate_info {
  39         u8 plcp;          /* uCode API:  IWL_RATE_6M_PLCP, etc. */
  40         u8 plcp_ht_siso;  /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
  41         u8 plcp_ht_mimo2; /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
  42         u8 plcp_vht_siso;
  43         u8 plcp_vht_mimo2;
  44         u8 prev_rs;      /* previous rate used in rs algo */
  45         u8 next_rs;      /* next rate used in rs algo */
  46 };
  47
  48 #define IWL_RATE_60M_PLCP 3
  49
  50 enum {
  51         IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
  52         IWL_RATE_INVALID = IWL_RATE_COUNT,
  53 };
  54
  55 #define LINK_QUAL_MAX_RETRY_NUM 16
  56
  57 enum {
  58         IWL_RATE_6M_INDEX_TABLE = 0,
  59         IWL_RATE_9M_INDEX_TABLE,
  60         IWL_RATE_12M_INDEX_TABLE,
  61         IWL_RATE_18M_INDEX_TABLE,
  62         IWL_RATE_24M_INDEX_TABLE,
  63         IWL_RATE_36M_INDEX_TABLE,
  64         IWL_RATE_48M_INDEX_TABLE,
  65         IWL_RATE_54M_INDEX_TABLE,
  66         IWL_RATE_1M_INDEX_TABLE,
  67         IWL_RATE_2M_INDEX_TABLE,
  68         IWL_RATE_5M_INDEX_TABLE,
  69         IWL_RATE_11M_INDEX_TABLE,
  70         IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1,
  71 };
  72
  73 /* #define vs. enum to keep from defaulting to 'large integer' */
  74 #define IWL_RATE_6M_MASK   (1 << IWL_RATE_6M_INDEX)
  75 #define IWL_RATE_9M_MASK   (1 << IWL_RATE_9M_INDEX)
  76 #define IWL_RATE_12M_MASK  (1 << IWL_RATE_12M_INDEX)
  77 #define IWL_RATE_18M_MASK  (1 << IWL_RATE_18M_INDEX)
  78 #define IWL_RATE_24M_MASK  (1 << IWL_RATE_24M_INDEX)
  79 #define IWL_RATE_36M_MASK  (1 << IWL_RATE_36M_INDEX)
  80 #define IWL_RATE_48M_MASK  (1 << IWL_RATE_48M_INDEX)
  81 #define IWL_RATE_54M_MASK  (1 << IWL_RATE_54M_INDEX)
  82 #define IWL_RATE_60M_MASK  (1 << IWL_RATE_60M_INDEX)
  83 #define IWL_RATE_1M_MASK   (1 << IWL_RATE_1M_INDEX)
  84 #define IWL_RATE_2M_MASK   (1 << IWL_RATE_2M_INDEX)
  85 #define IWL_RATE_5M_MASK   (1 << IWL_RATE_5M_INDEX)
  86 #define IWL_RATE_11M_MASK  (1 << IWL_RATE_11M_INDEX)
  87
  88
  89 /* uCode API values for HT/VHT bit rates */
  90 enum {
  91         IWL_RATE_HT_SISO_MCS_0_PLCP = 0,
  92         IWL_RATE_HT_SISO_MCS_1_PLCP = 1,
  93         IWL_RATE_HT_SISO_MCS_2_PLCP = 2,
  94         IWL_RATE_HT_SISO_MCS_3_PLCP = 3,
  95         IWL_RATE_HT_SISO_MCS_4_PLCP = 4,
  96         IWL_RATE_HT_SISO_MCS_5_PLCP = 5,
  97         IWL_RATE_HT_SISO_MCS_6_PLCP = 6,
  98         IWL_RATE_HT_SISO_MCS_7_PLCP = 7,
  99         IWL_RATE_HT_MIMO2_MCS_0_PLCP = 0x8,
 100         IWL_RATE_HT_MIMO2_MCS_1_PLCP = 0x9,
 101         IWL_RATE_HT_MIMO2_MCS_2_PLCP = 0xA,
 102         IWL_RATE_HT_MIMO2_MCS_3_PLCP = 0xB,
 103         IWL_RATE_HT_MIMO2_MCS_4_PLCP = 0xC,
 104         IWL_RATE_HT_MIMO2_MCS_5_PLCP = 0xD,
 105         IWL_RATE_HT_MIMO2_MCS_6_PLCP = 0xE,
 106         IWL_RATE_HT_MIMO2_MCS_7_PLCP = 0xF,
 107         IWL_RATE_VHT_SISO_MCS_0_PLCP = 0,
 108         IWL_RATE_VHT_SISO_MCS_1_PLCP = 1,
 109         IWL_RATE_VHT_SISO_MCS_2_PLCP = 2,
 110         IWL_RATE_VHT_SISO_MCS_3_PLCP = 3,
 111         IWL_RATE_VHT_SISO_MCS_4_PLCP = 4,
 112         IWL_RATE_VHT_SISO_MCS_5_PLCP = 5,
 113         IWL_RATE_VHT_SISO_MCS_6_PLCP = 6,
 114         IWL_RATE_VHT_SISO_MCS_7_PLCP = 7,
 115         IWL_RATE_VHT_SISO_MCS_8_PLCP = 8,
 116         IWL_RATE_VHT_SISO_MCS_9_PLCP = 9,
 117         IWL_RATE_VHT_MIMO2_MCS_0_PLCP = 0x10,
 118         IWL_RATE_VHT_MIMO2_MCS_1_PLCP = 0x11,
 119         IWL_RATE_VHT_MIMO2_MCS_2_PLCP = 0x12,
 120         IWL_RATE_VHT_MIMO2_MCS_3_PLCP = 0x13,
 121         IWL_RATE_VHT_MIMO2_MCS_4_PLCP = 0x14,
 122         IWL_RATE_VHT_MIMO2_MCS_5_PLCP = 0x15,
 123         IWL_RATE_VHT_MIMO2_MCS_6_PLCP = 0x16,
 124         IWL_RATE_VHT_MIMO2_MCS_7_PLCP = 0x17,
 125         IWL_RATE_VHT_MIMO2_MCS_8_PLCP = 0x18,
 126         IWL_RATE_VHT_MIMO2_MCS_9_PLCP = 0x19,
 127         IWL_RATE_HT_SISO_MCS_INV_PLCP,
 128         IWL_RATE_HT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 129         IWL_RATE_VHT_SISO_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 130         IWL_RATE_VHT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 131         IWL_RATE_HT_SISO_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 132         IWL_RATE_HT_SISO_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 133         IWL_RATE_HT_MIMO2_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 134         IWL_RATE_HT_MIMO2_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP,
 135 };
 136
 137 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
 138
 139 #define IWL_INVALID_VALUE    -1
 140
 141 #define TPC_MAX_REDUCTION               15
 142 #define TPC_NO_REDUCTION                0
 143 #define TPC_INVALID                     0xff
 144
 145 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF   (63)
 146 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX   (63)
 147 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN   (0)
 148
 149 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
 150
 151 /* load per tid defines for A-MPDU activation */
 152 #define IWL_AGG_TPT_THREHOLD    0
 153 #define IWL_AGG_ALL_TID         0xff
 154
 155 enum iwl_table_type {
 156         LQ_NONE,
 157         LQ_LEGACY_G,    /* legacy types */
 158         LQ_LEGACY_A,
 159         LQ_HT_SISO,     /* HT types */
 160         LQ_HT_MIMO2,
 161         LQ_VHT_SISO,    /* VHT types */
 162         LQ_VHT_MIMO2,
 163         LQ_MAX,
 164 };
 165
 166 struct rs_rate {
 167         int index;
 168         enum iwl_table_type type;
 169         u8 ant;
 170         u32 bw;
 171         bool sgi;
 172         bool ldpc;
 173         bool stbc;
 174         bool bfer;
 175 };
 176
 177
 178 #define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \
 179                               ((type) == LQ_LEGACY_A))
 180 #define is_type_ht_siso(type) ((type) == LQ_HT_SISO)
 181 #define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)
 182 #define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)
 183 #define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)
 184 #define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type))
 185 #define is_type_mimo2(type) (is_type_ht_mimo2(type) || is_type_vht_mimo2(type))
 186 #define is_type_mimo(type) (is_type_mimo2(type))
 187 #define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type))
 188 #define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type))
 189 #define is_type_a_band(type) ((type) == LQ_LEGACY_A)
 190 #define is_type_g_band(type) ((type) == LQ_LEGACY_G)
 191
 192 #define is_legacy(rate)       is_type_legacy((rate)->type)
 193 #define is_ht_siso(rate)      is_type_ht_siso((rate)->type)
 194 #define is_ht_mimo2(rate)     is_type_ht_mimo2((rate)->type)
 195 #define is_vht_siso(rate)     is_type_vht_siso((rate)->type)
 196 #define is_vht_mimo2(rate)    is_type_vht_mimo2((rate)->type)
 197 #define is_siso(rate)         is_type_siso((rate)->type)
 198 #define is_mimo2(rate)        is_type_mimo2((rate)->type)
 199 #define is_mimo(rate)         is_type_mimo((rate)->type)
 200 #define is_ht(rate)           is_type_ht((rate)->type)
 201 #define is_vht(rate)          is_type_vht((rate)->type)
 202 #define is_a_band(rate)       is_type_a_band((rate)->type)
 203 #define is_g_band(rate)       is_type_g_band((rate)->type)
 204
 205 #define is_ht20(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)
 206 #define is_ht40(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)
 207 #define is_ht80(rate)         ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)
 208 #define is_ht160(rate)        ((rate)->bw == RATE_MCS_CHAN_WIDTH_160)
 209
 210 #define IWL_MAX_MCS_DISPLAY_SIZE        12
 211
 212 struct iwl_rate_mcs_info {
 213         char    mbps[IWL_MAX_MCS_DISPLAY_SIZE];
 214         char    mcs[IWL_MAX_MCS_DISPLAY_SIZE];
 215 };
 216
 217 /**
 218  * struct iwl_rate_scale_data -- tx success history for one rate
 219  */
 220 struct iwl_rate_scale_data {
 221         u64 data;               /* bitmap of successful frames */
 222         s32 success_counter;    /* number of frames successful */
 223         s32 success_ratio;      /* per-cent * 128  */
 224         s32 counter;            /* number of frames attempted */
 225         s32 average_tpt;        /* success ratio * expected throughput */
 226 };
 227
 228 /* Possible Tx columns
 229  * Tx Column = a combo of legacy/siso/mimo x antenna x SGI
 230  */
 231 enum rs_column {
 232         RS_COLUMN_LEGACY_ANT_A = 0,
 233         RS_COLUMN_LEGACY_ANT_B,
 234         RS_COLUMN_SISO_ANT_A,
 235         RS_COLUMN_SISO_ANT_B,
 236         RS_COLUMN_SISO_ANT_A_SGI,
 237         RS_COLUMN_SISO_ANT_B_SGI,
 238         RS_COLUMN_MIMO2,
 239         RS_COLUMN_MIMO2_SGI,
 240
 241         RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,
 242         RS_COLUMN_COUNT = RS_COLUMN_LAST + 1,
 243         RS_COLUMN_INVALID,
 244 };
 245
 246 enum rs_ss_force_opt {
 247         RS_SS_FORCE_NONE = 0,
 248         RS_SS_FORCE_STBC,
 249         RS_SS_FORCE_BFER,
 250         RS_SS_FORCE_SISO,
 251 };
 252
 253 /* Packet stats per rate */
 254 struct rs_rate_stats {
 255         u64 success;
 256         u64 total;
 257 };
 258
 259 /**
 260  * struct iwl_scale_tbl_info -- tx params and success history for all rates
 261  *
 262  * There are two of these in struct iwl_lq_sta,
 263  * one for "active", and one for "search".
 264  */
 265 struct iwl_scale_tbl_info {
 266         struct rs_rate rate;
 267         enum rs_column column;
 268         const u16 *expected_tpt;        /* throughput metrics; expected_tpt_G, etc. */
 269         struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
 270         /* per txpower-reduction history */
 271         struct iwl_rate_scale_data tpc_win[TPC_MAX_REDUCTION + 1];
 272 };
 273
 274 enum {
 275         RS_STATE_SEARCH_CYCLE_STARTED,
 276         RS_STATE_SEARCH_CYCLE_ENDED,
 277         RS_STATE_STAY_IN_COLUMN,
 278 };
 279
 280 /**
 281  * struct iwl_lq_sta -- driver's rate scaling private structure
 282  *
 283  * Pointer to this gets passed back and forth between driver and mac80211.
 284  */
 285 struct iwl_lq_sta {
 286         u8 active_tbl;          /* index of active table, range 0-1 */
 287         u8 rs_state;            /* RS_STATE_* */
 288         u8 search_better_tbl;   /* 1: currently trying alternate mode */
 289         s32 last_tpt;
 290
 291         /* The following determine when to search for a new mode */
 292         u32 table_count_limit;
 293         u32 max_failure_limit;  /* # failed frames before new search */
 294         u32 max_success_limit;  /* # successful frames before new search */
 295         u32 table_count;
 296         u32 total_failed;       /* total failed frames, any/all rates */
 297         u32 total_success;      /* total successful frames, any/all rates */
 298         u64 flush_timer;        /* time staying in mode before new search */
 299
 300         u32 visited_columns;    /* Bitmask marking which Tx columns were
 301                                  * explored during a search cycle
 302                                  */
 303         u64 last_tx;
 304         bool is_vht;
 305         bool ldpc;              /* LDPC Rx is supported by the STA */
 306         bool stbc_capable;      /* Tx STBC is supported by chip and Rx by STA */
 307         bool bfer_capable;      /* Remote supports beamformee and we BFer */
 308
 309         enum nl80211_band band;
 310
 311         /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
 312         unsigned long active_legacy_rate;
 313         unsigned long active_siso_rate;
 314         unsigned long active_mimo2_rate;
 315
 316         /* Highest rate per Tx mode */
 317         u8 max_legacy_rate_idx;
 318         u8 max_siso_rate_idx;
 319         u8 max_mimo2_rate_idx;
 320
 321         /* Optimal rate based on RSSI and STA caps.
 322          * Used only to reflect link speed to userspace.
 323          */
 324         struct rs_rate optimal_rate;
 325         unsigned long optimal_rate_mask;
 326         const struct rs_init_rate_info *optimal_rates;
 327         int optimal_nentries;
 328
 329         u8 missed_rate_counter;
 330
 331         struct iwl_lq_cmd lq;
 332         struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
 333         u8 tx_agg_tid_en;
 334
 335         /* last tx rate_n_flags */
 336         u32 last_rate_n_flags;
 337         /* packets destined for this STA are aggregated */
 338         u8 is_agg;
 339
 340         /* tx power reduce for this sta */
 341         int tpc_reduce;
 342
 343         /* persistent fields - initialized only once - keep last! */
 344         struct lq_sta_pers {
 345 #ifdef CONFIG_MAC80211_DEBUGFS
 346                 u32 dbg_fixed_rate;
 347                 u8 dbg_fixed_txp_reduction;
 348
 349                 /* force STBC/BFER/SISO for testing */
 350                 enum rs_ss_force_opt ss_force;
 351 #endif
 352                 u8 chains;
 353                 s8 chain_signal[IEEE80211_MAX_CHAINS];
 354                 s8 last_rssi;
 355                 struct rs_rate_stats tx_stats[RS_COLUMN_COUNT][IWL_RATE_COUNT];
 356                 struct iwl_mvm *drv;
 357         } pers;
 358 };
 359
 360 /* Initialize station's rate scaling information after adding station */
 361 void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
 362                           enum nl80211_band band, bool init);
 363
 364 /* Notify RS about Tx status */
 365 void iwl_mvm_rs_tx_status(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
 366                           int tid, struct ieee80211_tx_info *info, bool ndp);
 367
 368 /**
 369  * iwl_rate_control_register - Register the rate control algorithm callbacks
 370  *
 371  * Since the rate control algorithm is hardware specific, there is no need
 372  * or reason to place it as a stand alone module.  The driver can call
 373  * iwl_rate_control_register in order to register the rate control callbacks
 374  * with the mac80211 subsystem.  This should be performed prior to calling
 375  * ieee80211_register_hw
 376  *
 377  */
 378 int iwl_mvm_rate_control_register(void);
 379
 380 /**
 381  * iwl_rate_control_unregister - Unregister the rate control callbacks
 382  *
 383  * This should be called after calling ieee80211_unregister_hw, but before
 384  * the driver is unloaded.
 385  */
 386 void iwl_mvm_rate_control_unregister(void);
 387
 388 struct iwl_mvm_sta;
 389
 390 int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
 391                           bool enable);
 392
 393 #endif /* __rs__ */