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