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