1 /******************************************************************************
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
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.
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
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
20 * The full GNU General Public License is included in this distribution in the
21 * file called LICENSE.
23 * Contact Information:
24 * Intel Linux Wireless <linuxwifi@intel.com>
25 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *****************************************************************************/
32 #include <net/mac80211.h>
34 #include "iwl-config.h"
37 #include "iwl-trans.h"
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. */
45 u8 prev_rs; /* previous rate used in rs algo */
46 u8 next_rs; /* next rate used in rs algo */
49 #define IWL_RATE_60M_PLCP 3
52 IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
53 IWL_RATE_INVALID = IWL_RATE_COUNT,
56 #define LINK_QUAL_MAX_RETRY_NUM 16
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,
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)
90 /* uCode API values for HT/VHT bit rates */
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,
138 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
140 #define IWL_INVALID_VALUE -1
142 #define TPC_MAX_REDUCTION 15
143 #define TPC_NO_REDUCTION 0
144 #define TPC_INVALID 0xff
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_MIN (0)
150 #define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
152 /* load per tid defines for A-MPDU activation */
153 #define IWL_AGG_TPT_THREHOLD 0
154 #define IWL_AGG_ALL_TID 0xff
156 enum iwl_table_type {
158 LQ_LEGACY_G, /* legacy types */
160 LQ_HT_SISO, /* HT types */
162 LQ_VHT_SISO, /* VHT types */
169 enum iwl_table_type type;
179 #define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \
180 ((type) == LQ_LEGACY_A))
181 #define is_type_ht_siso(type) ((type) == LQ_HT_SISO)
182 #define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2)
183 #define is_type_vht_siso(type) ((type) == LQ_VHT_SISO)
184 #define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2)
185 #define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type))
186 #define is_type_mimo2(type) (is_type_ht_mimo2(type) || is_type_vht_mimo2(type))
187 #define is_type_mimo(type) (is_type_mimo2(type))
188 #define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type))
189 #define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type))
190 #define is_type_a_band(type) ((type) == LQ_LEGACY_A)
191 #define is_type_g_band(type) ((type) == LQ_LEGACY_G)
193 #define is_legacy(rate) is_type_legacy((rate)->type)
194 #define is_ht_siso(rate) is_type_ht_siso((rate)->type)
195 #define is_ht_mimo2(rate) is_type_ht_mimo2((rate)->type)
196 #define is_vht_siso(rate) is_type_vht_siso((rate)->type)
197 #define is_vht_mimo2(rate) is_type_vht_mimo2((rate)->type)
198 #define is_siso(rate) is_type_siso((rate)->type)
199 #define is_mimo2(rate) is_type_mimo2((rate)->type)
200 #define is_mimo(rate) is_type_mimo((rate)->type)
201 #define is_ht(rate) is_type_ht((rate)->type)
202 #define is_vht(rate) is_type_vht((rate)->type)
203 #define is_a_band(rate) is_type_a_band((rate)->type)
204 #define is_g_band(rate) is_type_g_band((rate)->type)
206 #define is_ht20(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_20)
207 #define is_ht40(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_40)
208 #define is_ht80(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_80)
209 #define is_ht160(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_160)
211 #define IWL_MAX_MCS_DISPLAY_SIZE 12
213 struct iwl_rate_mcs_info {
214 char mbps[IWL_MAX_MCS_DISPLAY_SIZE];
215 char mcs[IWL_MAX_MCS_DISPLAY_SIZE];
219 * struct iwl_rate_scale_data -- tx success history for one rate
221 struct iwl_rate_scale_data {
222 u64 data; /* bitmap of successful frames */
223 s32 success_counter; /* number of frames successful */
224 s32 success_ratio; /* per-cent * 128 */
225 s32 counter; /* number of frames attempted */
226 s32 average_tpt; /* success ratio * expected throughput */
229 /* Possible Tx columns
230 * Tx Column = a combo of legacy/siso/mimo x antenna x SGI
233 RS_COLUMN_LEGACY_ANT_A = 0,
234 RS_COLUMN_LEGACY_ANT_B,
235 RS_COLUMN_SISO_ANT_A,
236 RS_COLUMN_SISO_ANT_B,
237 RS_COLUMN_SISO_ANT_A_SGI,
238 RS_COLUMN_SISO_ANT_B_SGI,
242 RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI,
243 RS_COLUMN_COUNT = RS_COLUMN_LAST + 1,
247 enum rs_ss_force_opt {
248 RS_SS_FORCE_NONE = 0,
254 /* Packet stats per rate */
255 struct rs_rate_stats {
261 * struct iwl_scale_tbl_info -- tx params and success history for all rates
263 * There are two of these in struct iwl_lq_sta,
264 * one for "active", and one for "search".
266 struct iwl_scale_tbl_info {
268 enum rs_column column;
269 const u16 *expected_tpt; /* throughput metrics; expected_tpt_G, etc. */
270 struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */
271 /* per txpower-reduction history */
272 struct iwl_rate_scale_data tpc_win[TPC_MAX_REDUCTION + 1];
276 RS_STATE_SEARCH_CYCLE_STARTED,
277 RS_STATE_SEARCH_CYCLE_ENDED,
278 RS_STATE_STAY_IN_COLUMN,
282 * struct iwl_lq_sta -- driver's rate scaling private structure
284 * Pointer to this gets passed back and forth between driver and mac80211.
287 u8 active_tbl; /* index of active table, range 0-1 */
288 u8 rs_state; /* RS_STATE_* */
289 u8 search_better_tbl; /* 1: currently trying alternate mode */
292 /* The following determine when to search for a new mode */
293 u32 table_count_limit;
294 u32 max_failure_limit; /* # failed frames before new search */
295 u32 max_success_limit; /* # successful frames before new search */
297 u32 total_failed; /* total failed frames, any/all rates */
298 u32 total_success; /* total successful frames, any/all rates */
299 u64 flush_timer; /* time staying in mode before new search */
301 u32 visited_columns; /* Bitmask marking which Tx columns were
302 * explored during a search cycle
306 bool ldpc; /* LDPC Rx is supported by the STA */
307 bool stbc_capable; /* Tx STBC is supported by chip and Rx by STA */
308 bool bfer_capable; /* Remote supports beamformee and we BFer */
310 enum nl80211_band band;
312 /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
313 unsigned long active_legacy_rate;
314 unsigned long active_siso_rate;
315 unsigned long active_mimo2_rate;
317 /* Highest rate per Tx mode */
318 u8 max_legacy_rate_idx;
319 u8 max_siso_rate_idx;
320 u8 max_mimo2_rate_idx;
322 /* Optimal rate based on RSSI and STA caps.
323 * Used only to reflect link speed to userspace.
325 struct rs_rate optimal_rate;
326 unsigned long optimal_rate_mask;
327 const struct rs_init_rate_info *optimal_rates;
328 int optimal_nentries;
330 u8 missed_rate_counter;
332 struct iwl_lq_cmd lq;
333 struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */
336 /* last tx rate_n_flags */
337 u32 last_rate_n_flags;
338 /* packets destined for this STA are aggregated */
341 /* tx power reduce for this sta */
344 /* persistent fields - initialized only once - keep last! */
346 #ifdef CONFIG_MAC80211_DEBUGFS
348 u8 dbg_fixed_txp_reduction;
350 /* force STBC/BFER/SISO for testing */
351 enum rs_ss_force_opt ss_force;
354 s8 chain_signal[IEEE80211_MAX_CHAINS];
356 struct rs_rate_stats tx_stats[RS_COLUMN_COUNT][IWL_RATE_COUNT];
361 /* ieee80211_tx_info's status_driver_data[0] is packed with lq color and txp
362 * Note, it's iwlmvm <-> mac80211 interface.
363 * bits 0-7: reduced tx power
364 * bits 8-10: LQ command's color
366 #define RS_DRV_DATA_TXP_MSK 0xff
367 #define RS_DRV_DATA_LQ_COLOR_POS 8
368 #define RS_DRV_DATA_LQ_COLOR_MSK (7 << RS_DRV_DATA_LQ_COLOR_POS)
369 #define RS_DRV_DATA_LQ_COLOR_GET(_f) (((_f) & RS_DRV_DATA_LQ_COLOR_MSK) >>\
370 RS_DRV_DATA_LQ_COLOR_POS)
371 #define RS_DRV_DATA_PACK(_c, _p) ((void *)(uintptr_t)\
373 ((_c) << RS_DRV_DATA_LQ_COLOR_POS)))
375 /* Initialize station's rate scaling information after adding station */
376 void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
377 enum nl80211_band band, bool init);
379 /* Notify RS about Tx status */
380 void iwl_mvm_rs_tx_status(struct iwl_mvm *mvm, struct ieee80211_sta *sta,
381 int tid, struct ieee80211_tx_info *info, bool ndp);
384 * iwl_rate_control_register - Register the rate control algorithm callbacks
386 * Since the rate control algorithm is hardware specific, there is no need
387 * or reason to place it as a stand alone module. The driver can call
388 * iwl_rate_control_register in order to register the rate control callbacks
389 * with the mac80211 subsystem. This should be performed prior to calling
390 * ieee80211_register_hw
393 int iwl_mvm_rate_control_register(void);
396 * iwl_rate_control_unregister - Unregister the rate control callbacks
398 * This should be called after calling ieee80211_unregister_hw, but before
399 * the driver is unloaded.
401 void iwl_mvm_rate_control_unregister(void);
405 int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,