455 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only */2/******************************************************************************3 *4 * Copyright(c) 2015 Intel Mobile Communications GmbH5 * Copyright(c) 2017 Intel Deutschland GmbH6 * Copyright (C) 2003 - 2014, 2018 - 2024 Intel Corporation7 *****************************************************************************/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 332 33#define LINK_QUAL_MAX_RETRY_NUM 1634 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 -1118 119#define TPC_MAX_REDUCTION 15120#define TPC_NO_REDUCTION 0121#define TPC_INVALID 0xff122 123#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63)124#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)125#define LINK_QUAL_AGG_FRAME_LIMIT_GEN2_DEF (64)126#define LINK_QUAL_AGG_FRAME_LIMIT_GEN2_MAX (64)127#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)128 129#define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */130 131/* load per tid defines for A-MPDU activation */132#define IWL_AGG_TPT_THREHOLD 0133#define IWL_AGG_ALL_TID 0xff134 135enum iwl_table_type {136 LQ_NONE,137 LQ_LEGACY_G, /* legacy types */138 LQ_LEGACY_A,139 LQ_HT_SISO, /* HT types */140 LQ_HT_MIMO2,141 LQ_VHT_SISO, /* VHT types */142 LQ_VHT_MIMO2,143 LQ_HE_SISO, /* HE types */144 LQ_HE_MIMO2,145 LQ_MAX,146};147 148struct rs_rate {149 int index;150 enum iwl_table_type type;151 u8 ant;152 u32 bw;153 bool sgi;154 bool ldpc;155 bool stbc;156 bool bfer;157};158 159 160#define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \161 ((type) == LQ_LEGACY_A))162#define is_type_ht_siso(type) ((type) == LQ_HT_SISO)163#define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)164#define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)165#define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)166#define is_type_he_siso(type) ((type) == LQ_HE_SISO)167#define is_type_he_mimo2(type) ((type) == LQ_HE_MIMO2)168#define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type) || \169 is_type_he_siso(type))170#define is_type_mimo2(type) (is_type_ht_mimo2(type) || \171 is_type_vht_mimo2(type) || is_type_he_mimo2(type))172#define is_type_mimo(type) (is_type_mimo2(type))173#define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type))174#define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type))175#define is_type_he(type) (is_type_he_siso(type) || is_type_he_mimo2(type))176#define is_type_a_band(type) ((type) == LQ_LEGACY_A)177#define is_type_g_band(type) ((type) == LQ_LEGACY_G)178 179#define is_legacy(rate) is_type_legacy((rate)->type)180#define is_ht_siso(rate) is_type_ht_siso((rate)->type)181#define is_ht_mimo2(rate) is_type_ht_mimo2((rate)->type)182#define is_vht_siso(rate) is_type_vht_siso((rate)->type)183#define is_vht_mimo2(rate) is_type_vht_mimo2((rate)->type)184#define is_siso(rate) is_type_siso((rate)->type)185#define is_mimo2(rate) is_type_mimo2((rate)->type)186#define is_mimo(rate) is_type_mimo((rate)->type)187#define is_ht(rate) is_type_ht((rate)->type)188#define is_vht(rate) is_type_vht((rate)->type)189#define is_he(rate) is_type_he((rate)->type)190#define is_a_band(rate) is_type_a_band((rate)->type)191#define is_g_band(rate) is_type_g_band((rate)->type)192 193#define is_ht20(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)194#define is_ht40(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)195#define is_ht80(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)196#define is_ht160(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_160)197 198/**199 * struct iwl_lq_sta_rs_fw - rate and related statistics for RS in FW200 * @last_rate_n_flags: last rate reported by FW201 * @pers: persistent fields202 * @pers.sta_id: the id of the station203 * @pers.chains: bitmask of chains reported in %chain_signal204 * @pers.chain_signal: per chain signal strength205 * @pers.last_rssi: last rssi reported206 * @pers.drv: pointer back to the driver data207 */208struct iwl_lq_sta_rs_fw {209 /* last tx rate_n_flags */210 u32 last_rate_n_flags;211 212 /* persistent fields - initialized only once - keep last! */213 struct lq_sta_pers_rs_fw {214 u32 sta_id;215#ifdef CONFIG_MAC80211_DEBUGFS216 /**217 * @pers.dbg_fixed_rate: for debug, use fixed rate if not 0218 */219 u32 dbg_fixed_rate;220 /**221 * @pers.dbg_agg_frame_count_lim: for debug, max number of222 * frames in A-MPDU223 */224 u16 dbg_agg_frame_count_lim;225#endif226 u8 chains;227 s8 chain_signal[IEEE80211_MAX_CHAINS];228 s8 last_rssi;229 struct iwl_mvm *drv;230 } pers;231};232 233/*234 * struct iwl_rate_scale_data -- tx success history for one rate235 */236struct iwl_rate_scale_data {237 u64 data; /* bitmap of successful frames */238 s32 success_counter; /* number of frames successful */239 s32 success_ratio; /* per-cent * 128 */240 s32 counter; /* number of frames attempted */241 s32 average_tpt; /* success ratio * expected throughput */242};243 244/* Possible Tx columns245 * Tx Column = a combo of legacy/siso/mimo x antenna x SGI246 */247enum rs_column {248 RS_COLUMN_LEGACY_ANT_A = 0,249 RS_COLUMN_LEGACY_ANT_B,250 RS_COLUMN_SISO_ANT_A,251 RS_COLUMN_SISO_ANT_B,252 RS_COLUMN_SISO_ANT_A_SGI,253 RS_COLUMN_SISO_ANT_B_SGI,254 RS_COLUMN_MIMO2,255 RS_COLUMN_MIMO2_SGI,256 257 RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,258 RS_COLUMN_COUNT = RS_COLUMN_LAST + 1,259 RS_COLUMN_INVALID,260};261 262enum rs_ss_force_opt {263 RS_SS_FORCE_NONE = 0,264 RS_SS_FORCE_STBC,265 RS_SS_FORCE_BFER,266 RS_SS_FORCE_SISO,267};268 269/* Packet stats per rate */270struct rs_rate_stats {271 u64 success;272 u64 total;273};274 275/*276 * struct iwl_scale_tbl_info -- tx params and success history for all rates277 *278 * There are two of these in struct iwl_lq_sta,279 * one for "active", and one for "search".280 */281struct iwl_scale_tbl_info {282 struct rs_rate rate;283 enum rs_column column;284 const u16 *expected_tpt; /* throughput metrics; expected_tpt_G, etc. */285 struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */286 /* per txpower-reduction history */287 struct iwl_rate_scale_data tpc_win[TPC_MAX_REDUCTION + 1];288};289 290enum {291 RS_STATE_SEARCH_CYCLE_STARTED,292 RS_STATE_SEARCH_CYCLE_ENDED,293 RS_STATE_STAY_IN_COLUMN,294};295 296/*297 * struct iwl_lq_sta -- driver's rate scaling private structure298 *299 * Pointer to this gets passed back and forth between driver and mac80211.300 */301struct iwl_lq_sta {302 u8 active_tbl; /* index of active table, range 0-1 */303 u8 rs_state; /* RS_STATE_* */304 u8 search_better_tbl; /* 1: currently trying alternate mode */305 s32 last_tpt;306 307 /* The following determine when to search for a new mode */308 u32 table_count_limit;309 u32 max_failure_limit; /* # failed frames before new search */310 u32 max_success_limit; /* # successful frames before new search */311 u32 table_count;312 u32 total_failed; /* total failed frames, any/all rates */313 u32 total_success; /* total successful frames, any/all rates */314 u64 flush_timer; /* time staying in mode before new search */315 316 u32 visited_columns; /* Bitmask marking which Tx columns were317 * explored during a search cycle318 */319 u64 last_tx;320 bool is_vht;321 bool ldpc; /* LDPC Rx is supported by the STA */322 bool stbc_capable; /* Tx STBC is supported by chip and Rx by STA */323 bool bfer_capable; /* Remote supports beamformee and we BFer */324 325 enum nl80211_band band;326 327 /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */328 unsigned long active_legacy_rate;329 unsigned long active_siso_rate;330 unsigned long active_mimo2_rate;331 332 /* Highest rate per Tx mode */333 u8 max_legacy_rate_idx;334 u8 max_siso_rate_idx;335 u8 max_mimo2_rate_idx;336 337 /* Optimal rate based on RSSI and STA caps.338 * Used only to reflect link speed to userspace.339 */340 struct rs_rate optimal_rate;341 unsigned long optimal_rate_mask;342 const struct rs_init_rate_info *optimal_rates;343 int optimal_nentries;344 345 u8 missed_rate_counter;346 347 struct iwl_lq_cmd lq;348 struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */349 u8 tx_agg_tid_en;350 351 /* last tx rate_n_flags */352 u32 last_rate_n_flags;353 354 /* packets destined for this STA are aggregated */355 u8 is_agg;356 357 /* tx power reduce for this sta */358 int tpc_reduce;359 360 /* persistent fields - initialized only once - keep last! */361 struct lq_sta_pers {362#ifdef CONFIG_MAC80211_DEBUGFS363 u32 dbg_fixed_rate;364 u8 dbg_fixed_txp_reduction;365 366 /* force STBC/BFER/SISO for testing */367 enum rs_ss_force_opt ss_force;368#endif369 u8 chains;370 s8 chain_signal[IEEE80211_MAX_CHAINS];371 s8 last_rssi;372 u16 max_agg_bufsize;373 struct rs_rate_stats tx_stats[RS_COLUMN_COUNT][IWL_RATE_COUNT];374 struct iwl_mvm *drv;375 spinlock_t lock; /* for races in reinit/update table */376 } pers;377};378 379/* ieee80211_tx_info's status_driver_data[0] is packed with lq color and txp380 * Note, it's iwlmvm <-> mac80211 interface.381 * bits 0-7: reduced tx power382 * bits 8-10: LQ command's color383 */384#define RS_DRV_DATA_TXP_MSK 0xff385#define RS_DRV_DATA_LQ_COLOR_POS 8386#define RS_DRV_DATA_LQ_COLOR_MSK (7 << RS_DRV_DATA_LQ_COLOR_POS)387#define RS_DRV_DATA_LQ_COLOR_GET(_f) (((_f) & RS_DRV_DATA_LQ_COLOR_MSK) >>\388 RS_DRV_DATA_LQ_COLOR_POS)389#define RS_DRV_DATA_PACK(_c, _p) ((void *)(uintptr_t)\390 (((uintptr_t)_p) |\391 ((_c) << RS_DRV_DATA_LQ_COLOR_POS)))392 393/* Initialize station's rate scaling information after adding station */394void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm,395 struct ieee80211_vif *vif,396 struct ieee80211_sta *sta,397 struct ieee80211_bss_conf *link_conf,398 struct ieee80211_link_sta *link_sta,399 enum nl80211_band band);400 401/* Notify RS about Tx status */402void iwl_mvm_rs_tx_status(struct iwl_mvm *mvm, struct ieee80211_sta *sta,403 int tid, struct ieee80211_tx_info *info, bool ndp);404 405/**406 * iwl_mvm_rate_control_register - Register the rate control algorithm callbacks407 *408 * Since the rate control algorithm is hardware specific, there is no need409 * or reason to place it as a stand alone module. The driver can call410 * iwl_rate_control_register in order to register the rate control callbacks411 * with the mac80211 subsystem. This should be performed prior to calling412 * ieee80211_register_hw413 *414 */415int iwl_mvm_rate_control_register(void);416 417/**418 * iwl_mvm_rate_control_unregister - Unregister the rate control callbacks419 *420 * This should be called after calling ieee80211_unregister_hw, but before421 * the driver is unloaded.422 */423void iwl_mvm_rate_control_unregister(void);424 425struct iwl_mvm_sta;426 427int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,428 bool enable);429 430#ifdef CONFIG_IWLWIFI_DEBUGFS431void iwl_mvm_reset_frame_stats(struct iwl_mvm *mvm);432#endif433 434struct iwl_mvm_link_sta;435 436void iwl_mvm_rs_add_sta(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta);437void iwl_mvm_rs_add_sta_link(struct iwl_mvm *mvm,438 struct iwl_mvm_link_sta *link_sta);439 440void iwl_mvm_rs_fw_rate_init(struct iwl_mvm *mvm,441 struct ieee80211_vif *vif,442 struct ieee80211_sta *sta,443 struct ieee80211_bss_conf *link_conf,444 struct ieee80211_link_sta *link_sta,445 enum nl80211_band band);446int rs_fw_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,447 bool enable);448void iwl_mvm_tlc_update_notif(struct iwl_mvm *mvm,449 struct iwl_rx_cmd_buffer *rxb);450 451u16 rs_fw_get_max_amsdu_len(struct ieee80211_sta *sta,452 struct ieee80211_bss_conf *link_conf,453 struct ieee80211_link_sta *link_sta);454#endif /* __rs__ */455