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

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