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