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