Commit | Line | Data |
---|---|---|
8ca151b5 JB |
1 | /****************************************************************************** |
2 | * | |
51368bf7 | 3 | * Copyright(c) 2003 - 2014 Intel Corporation. All rights reserved. |
8ca151b5 JB |
4 | * |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms of version 2 of the GNU General Public License as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
12 | * more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License along with | |
15 | * this program; if not, write to the Free Software Foundation, Inc., | |
16 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA | |
17 | * | |
18 | * The full GNU General Public License is included in this distribution in the | |
19 | * file called LICENSE. | |
20 | * | |
21 | * Contact Information: | |
22 | * Intel Linux Wireless <ilw@linux.intel.com> | |
23 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 | |
24 | * | |
25 | *****************************************************************************/ | |
26 | ||
27 | #ifndef __rs_h__ | |
28 | #define __rs_h__ | |
29 | ||
30 | #include <net/mac80211.h> | |
31 | ||
32 | #include "iwl-config.h" | |
33 | ||
34 | #include "fw-api.h" | |
35 | #include "iwl-trans.h" | |
36 | ||
37 | struct iwl_rs_rate_info { | |
d310e405 ES |
38 | u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */ |
39 | u8 plcp_ht_siso; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */ | |
40 | u8 plcp_ht_mimo2; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */ | |
41 | u8 plcp_vht_siso; | |
42 | u8 plcp_vht_mimo2; | |
8ca151b5 JB |
43 | u8 prev_rs; /* previous rate used in rs algo */ |
44 | u8 next_rs; /* next rate used in rs algo */ | |
8ca151b5 JB |
45 | }; |
46 | ||
47 | #define IWL_RATE_60M_PLCP 3 | |
48 | ||
49 | enum { | |
50 | IWL_RATE_INVM_INDEX = IWL_RATE_COUNT, | |
51 | IWL_RATE_INVALID = IWL_RATE_COUNT, | |
52 | }; | |
53 | ||
54 | #define LINK_QUAL_MAX_RETRY_NUM 16 | |
55 | ||
56 | enum { | |
57 | IWL_RATE_6M_INDEX_TABLE = 0, | |
58 | IWL_RATE_9M_INDEX_TABLE, | |
59 | IWL_RATE_12M_INDEX_TABLE, | |
60 | IWL_RATE_18M_INDEX_TABLE, | |
61 | IWL_RATE_24M_INDEX_TABLE, | |
62 | IWL_RATE_36M_INDEX_TABLE, | |
63 | IWL_RATE_48M_INDEX_TABLE, | |
64 | IWL_RATE_54M_INDEX_TABLE, | |
65 | IWL_RATE_1M_INDEX_TABLE, | |
66 | IWL_RATE_2M_INDEX_TABLE, | |
67 | IWL_RATE_5M_INDEX_TABLE, | |
68 | IWL_RATE_11M_INDEX_TABLE, | |
69 | IWL_RATE_INVM_INDEX_TABLE = IWL_RATE_INVM_INDEX - 1, | |
70 | }; | |
71 | ||
72 | /* #define vs. enum to keep from defaulting to 'large integer' */ | |
73 | #define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX) | |
74 | #define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX) | |
75 | #define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX) | |
76 | #define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX) | |
77 | #define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX) | |
78 | #define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX) | |
79 | #define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX) | |
80 | #define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX) | |
81 | #define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX) | |
82 | #define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX) | |
83 | #define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX) | |
84 | #define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX) | |
85 | #define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX) | |
86 | ||
87 | ||
d310e405 | 88 | /* uCode API values for HT/VHT bit rates */ |
8ca151b5 | 89 | enum { |
d310e405 ES |
90 | IWL_RATE_HT_SISO_MCS_0_PLCP = 0, |
91 | IWL_RATE_HT_SISO_MCS_1_PLCP = 1, | |
92 | IWL_RATE_HT_SISO_MCS_2_PLCP = 2, | |
93 | IWL_RATE_HT_SISO_MCS_3_PLCP = 3, | |
94 | IWL_RATE_HT_SISO_MCS_4_PLCP = 4, | |
95 | IWL_RATE_HT_SISO_MCS_5_PLCP = 5, | |
96 | IWL_RATE_HT_SISO_MCS_6_PLCP = 6, | |
97 | IWL_RATE_HT_SISO_MCS_7_PLCP = 7, | |
98 | IWL_RATE_HT_MIMO2_MCS_0_PLCP = 0x8, | |
99 | IWL_RATE_HT_MIMO2_MCS_1_PLCP = 0x9, | |
100 | IWL_RATE_HT_MIMO2_MCS_2_PLCP = 0xA, | |
101 | IWL_RATE_HT_MIMO2_MCS_3_PLCP = 0xB, | |
102 | IWL_RATE_HT_MIMO2_MCS_4_PLCP = 0xC, | |
103 | IWL_RATE_HT_MIMO2_MCS_5_PLCP = 0xD, | |
104 | IWL_RATE_HT_MIMO2_MCS_6_PLCP = 0xE, | |
105 | IWL_RATE_HT_MIMO2_MCS_7_PLCP = 0xF, | |
106 | IWL_RATE_VHT_SISO_MCS_0_PLCP = 0, | |
107 | IWL_RATE_VHT_SISO_MCS_1_PLCP = 1, | |
108 | IWL_RATE_VHT_SISO_MCS_2_PLCP = 2, | |
109 | IWL_RATE_VHT_SISO_MCS_3_PLCP = 3, | |
110 | IWL_RATE_VHT_SISO_MCS_4_PLCP = 4, | |
111 | IWL_RATE_VHT_SISO_MCS_5_PLCP = 5, | |
112 | IWL_RATE_VHT_SISO_MCS_6_PLCP = 6, | |
113 | IWL_RATE_VHT_SISO_MCS_7_PLCP = 7, | |
114 | IWL_RATE_VHT_SISO_MCS_8_PLCP = 8, | |
115 | IWL_RATE_VHT_SISO_MCS_9_PLCP = 9, | |
116 | IWL_RATE_VHT_MIMO2_MCS_0_PLCP = 0x10, | |
117 | IWL_RATE_VHT_MIMO2_MCS_1_PLCP = 0x11, | |
118 | IWL_RATE_VHT_MIMO2_MCS_2_PLCP = 0x12, | |
119 | IWL_RATE_VHT_MIMO2_MCS_3_PLCP = 0x13, | |
120 | IWL_RATE_VHT_MIMO2_MCS_4_PLCP = 0x14, | |
121 | IWL_RATE_VHT_MIMO2_MCS_5_PLCP = 0x15, | |
122 | IWL_RATE_VHT_MIMO2_MCS_6_PLCP = 0x16, | |
123 | IWL_RATE_VHT_MIMO2_MCS_7_PLCP = 0x17, | |
124 | IWL_RATE_VHT_MIMO2_MCS_8_PLCP = 0x18, | |
125 | IWL_RATE_VHT_MIMO2_MCS_9_PLCP = 0x19, | |
126 | IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
127 | IWL_RATE_HT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
128 | IWL_RATE_VHT_SISO_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
129 | IWL_RATE_VHT_MIMO2_MCS_INV_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
130 | IWL_RATE_HT_SISO_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
131 | IWL_RATE_HT_SISO_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
132 | IWL_RATE_HT_MIMO2_MCS_8_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
133 | IWL_RATE_HT_MIMO2_MCS_9_PLCP = IWL_RATE_HT_SISO_MCS_INV_PLCP, | |
8ca151b5 JB |
134 | }; |
135 | ||
8ca151b5 JB |
136 | #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1) |
137 | ||
138 | #define IWL_INVALID_VALUE -1 | |
139 | ||
2fd647f8 EP |
140 | #define TPC_MAX_REDUCTION 15 |
141 | #define TPC_NO_REDUCTION 0 | |
142 | #define TPC_INVALID 0xff | |
143 | ||
8ca151b5 JB |
144 | #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63) |
145 | #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63) | |
146 | #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0) | |
147 | ||
148 | #define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */ | |
149 | ||
150 | /* load per tid defines for A-MPDU activation */ | |
151 | #define IWL_AGG_TPT_THREHOLD 0 | |
8ca151b5 | 152 | #define IWL_AGG_ALL_TID 0xff |
8ca151b5 JB |
153 | |
154 | enum iwl_table_type { | |
155 | LQ_NONE, | |
d310e405 ES |
156 | LQ_LEGACY_G, /* legacy types */ |
157 | LQ_LEGACY_A, | |
158 | LQ_HT_SISO, /* HT types */ | |
159 | LQ_HT_MIMO2, | |
160 | LQ_VHT_SISO, /* VHT types */ | |
161 | LQ_VHT_MIMO2, | |
8ca151b5 JB |
162 | LQ_MAX, |
163 | }; | |
164 | ||
5aa33553 ES |
165 | struct rs_rate { |
166 | int index; | |
167 | enum iwl_table_type type; | |
168 | u8 ant; | |
169 | u32 bw; | |
170 | bool sgi; | |
a3576ff2 | 171 | bool ldpc; |
d8bafeaf | 172 | bool stbc; |
5aa33553 ES |
173 | }; |
174 | ||
175 | ||
176 | #define is_type_legacy(type) (((type) == LQ_LEGACY_G) || \ | |
177 | ((type) == LQ_LEGACY_A)) | |
178 | #define is_type_ht_siso(type) ((type) == LQ_HT_SISO) | |
179 | #define is_type_ht_mimo2(type) ((type) == LQ_HT_MIMO2) | |
180 | #define is_type_vht_siso(type) ((type) == LQ_VHT_SISO) | |
181 | #define is_type_vht_mimo2(type) ((type) == LQ_VHT_MIMO2) | |
182 | #define is_type_siso(type) (is_type_ht_siso(type) || is_type_vht_siso(type)) | |
183 | #define is_type_mimo2(type) (is_type_ht_mimo2(type) || is_type_vht_mimo2(type)) | |
184 | #define is_type_mimo(type) (is_type_mimo2(type)) | |
185 | #define is_type_ht(type) (is_type_ht_siso(type) || is_type_ht_mimo2(type)) | |
186 | #define is_type_vht(type) (is_type_vht_siso(type) || is_type_vht_mimo2(type)) | |
187 | #define is_type_a_band(type) ((type) == LQ_LEGACY_A) | |
188 | #define is_type_g_band(type) ((type) == LQ_LEGACY_G) | |
189 | ||
190 | #define is_legacy(rate) is_type_legacy((rate)->type) | |
191 | #define is_ht_siso(rate) is_type_ht_siso((rate)->type) | |
192 | #define is_ht_mimo2(rate) is_type_ht_mimo2((rate)->type) | |
193 | #define is_vht_siso(rate) is_type_vht_siso((rate)->type) | |
194 | #define is_vht_mimo2(rate) is_type_vht_mimo2((rate)->type) | |
195 | #define is_siso(rate) is_type_siso((rate)->type) | |
196 | #define is_mimo2(rate) is_type_mimo2((rate)->type) | |
197 | #define is_mimo(rate) is_type_mimo((rate)->type) | |
198 | #define is_ht(rate) is_type_ht((rate)->type) | |
199 | #define is_vht(rate) is_type_vht((rate)->type) | |
200 | #define is_a_band(rate) is_type_a_band((rate)->type) | |
201 | #define is_g_band(rate) is_type_g_band((rate)->type) | |
202 | ||
203 | #define is_ht20(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_20) | |
204 | #define is_ht40(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_40) | |
205 | #define is_ht80(rate) ((rate)->bw == RATE_MCS_CHAN_WIDTH_80) | |
8ca151b5 JB |
206 | |
207 | #define IWL_MAX_MCS_DISPLAY_SIZE 12 | |
208 | ||
209 | struct iwl_rate_mcs_info { | |
210 | char mbps[IWL_MAX_MCS_DISPLAY_SIZE]; | |
211 | char mcs[IWL_MAX_MCS_DISPLAY_SIZE]; | |
212 | }; | |
213 | ||
214 | /** | |
215 | * struct iwl_rate_scale_data -- tx success history for one rate | |
216 | */ | |
217 | struct iwl_rate_scale_data { | |
218 | u64 data; /* bitmap of successful frames */ | |
219 | s32 success_counter; /* number of frames successful */ | |
220 | s32 success_ratio; /* per-cent * 128 */ | |
221 | s32 counter; /* number of frames attempted */ | |
222 | s32 average_tpt; /* success ratio * expected throughput */ | |
8ca151b5 JB |
223 | }; |
224 | ||
b3b06a32 ES |
225 | /* Possible Tx columns |
226 | * Tx Column = a combo of legacy/siso/mimo x antenna x SGI | |
227 | */ | |
228 | enum rs_column { | |
229 | RS_COLUMN_LEGACY_ANT_A = 0, | |
230 | RS_COLUMN_LEGACY_ANT_B, | |
231 | RS_COLUMN_SISO_ANT_A, | |
232 | RS_COLUMN_SISO_ANT_B, | |
233 | RS_COLUMN_SISO_ANT_A_SGI, | |
234 | RS_COLUMN_SISO_ANT_B_SGI, | |
235 | RS_COLUMN_MIMO2, | |
236 | RS_COLUMN_MIMO2_SGI, | |
237 | ||
238 | RS_COLUMN_LAST = RS_COLUMN_MIMO2_SGI, | |
757cf23b | 239 | RS_COLUMN_COUNT = RS_COLUMN_LAST + 1, |
b3b06a32 ES |
240 | RS_COLUMN_INVALID, |
241 | }; | |
242 | ||
757cf23b ES |
243 | /* Packet stats per rate */ |
244 | struct rs_rate_stats { | |
245 | u64 success; | |
246 | u64 total; | |
247 | }; | |
248 | ||
8ca151b5 JB |
249 | /** |
250 | * struct iwl_scale_tbl_info -- tx params and success history for all rates | |
251 | * | |
252 | * There are two of these in struct iwl_lq_sta, | |
253 | * one for "active", and one for "search". | |
254 | */ | |
255 | struct iwl_scale_tbl_info { | |
5aa33553 | 256 | struct rs_rate rate; |
b3b06a32 | 257 | enum rs_column column; |
a34529e8 | 258 | const u16 *expected_tpt; /* throughput metrics; expected_tpt_G, etc. */ |
8ca151b5 | 259 | struct iwl_rate_scale_data win[IWL_RATE_COUNT]; /* rate histories */ |
2fd647f8 EP |
260 | /* per txpower-reduction history */ |
261 | struct iwl_rate_scale_data tpc_win[TPC_MAX_REDUCTION + 1]; | |
8ca151b5 JB |
262 | }; |
263 | ||
b3b06a32 ES |
264 | enum { |
265 | RS_STATE_SEARCH_CYCLE_STARTED, | |
266 | RS_STATE_SEARCH_CYCLE_ENDED, | |
267 | RS_STATE_STAY_IN_COLUMN, | |
268 | }; | |
269 | ||
8ca151b5 JB |
270 | /** |
271 | * struct iwl_lq_sta -- driver's rate scaling private structure | |
272 | * | |
273 | * Pointer to this gets passed back and forth between driver and mac80211. | |
274 | */ | |
275 | struct iwl_lq_sta { | |
276 | u8 active_tbl; /* index of active table, range 0-1 */ | |
b3b06a32 | 277 | u8 rs_state; /* RS_STATE_* */ |
8ca151b5 JB |
278 | u8 search_better_tbl; /* 1: currently trying alternate mode */ |
279 | s32 last_tpt; | |
280 | ||
281 | /* The following determine when to search for a new mode */ | |
282 | u32 table_count_limit; | |
283 | u32 max_failure_limit; /* # failed frames before new search */ | |
284 | u32 max_success_limit; /* # successful frames before new search */ | |
285 | u32 table_count; | |
286 | u32 total_failed; /* total failed frames, any/all rates */ | |
287 | u32 total_success; /* total successful frames, any/all rates */ | |
288 | u64 flush_timer; /* time staying in mode before new search */ | |
289 | ||
b3b06a32 ES |
290 | u32 visited_columns; /* Bitmask marking which Tx columns were |
291 | * explored during a search cycle | |
292 | */ | |
87d5e415 | 293 | u64 last_tx; |
d310e405 | 294 | bool is_vht; |
a3576ff2 | 295 | bool ldpc; /* LDPC Rx is supported by the STA */ |
d8bafeaf | 296 | bool stbc; /* Tx STBC is supported by chip and Rx by STA */ |
8ca151b5 JB |
297 | enum ieee80211_band band; |
298 | ||
299 | /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */ | |
198266a3 ES |
300 | unsigned long active_legacy_rate; |
301 | unsigned long active_siso_rate; | |
302 | unsigned long active_mimo2_rate; | |
303 | ||
304 | /* Highest rate per Tx mode */ | |
305 | u8 max_legacy_rate_idx; | |
306 | u8 max_siso_rate_idx; | |
307 | u8 max_mimo2_rate_idx; | |
308 | ||
8ca151b5 JB |
309 | u8 missed_rate_counter; |
310 | ||
311 | struct iwl_lq_cmd lq; | |
312 | struct iwl_scale_tbl_info lq_info[LQ_SIZE]; /* "active", "search" */ | |
8ca151b5 | 313 | u8 tx_agg_tid_en; |
8ca151b5 JB |
314 | |
315 | /* used to be in sta_info */ | |
316 | int last_txrate_idx; | |
317 | /* last tx rate_n_flags */ | |
318 | u32 last_rate_n_flags; | |
319 | /* packets destined for this STA are aggregated */ | |
320 | u8 is_agg; | |
2fd647f8 EP |
321 | |
322 | /* tx power reduce for this sta */ | |
323 | int tpc_reduce; | |
ae969afe EP |
324 | |
325 | /* persistent fields - initialized only once - keep last! */ | |
f58220f6 | 326 | struct lq_sta_pers { |
ae969afe | 327 | #ifdef CONFIG_MAC80211_DEBUGFS |
ae969afe EP |
328 | u32 dbg_fixed_rate; |
329 | u8 dbg_fixed_txp_reduction; | |
330 | #endif | |
f58220f6 ES |
331 | u8 chains; |
332 | s8 chain_signal[IEEE80211_MAX_CHAINS]; | |
333 | struct rs_rate_stats tx_stats[RS_COLUMN_COUNT][IWL_RATE_COUNT]; | |
ae969afe EP |
334 | struct iwl_mvm *drv; |
335 | } pers; | |
36946ce6 EG |
336 | }; |
337 | ||
8ca151b5 | 338 | /* Initialize station's rate scaling information after adding station */ |
b3818394 | 339 | void iwl_mvm_rs_rate_init(struct iwl_mvm *mvm, struct ieee80211_sta *sta, |
b87c2179 | 340 | enum ieee80211_band band, bool init); |
8ca151b5 | 341 | |
1ebc8f2e ES |
342 | /* Notify RS about Tx status */ |
343 | void iwl_mvm_rs_tx_status(struct iwl_mvm *mvm, struct ieee80211_sta *sta, | |
344 | int tid, struct ieee80211_tx_info *info); | |
345 | ||
8ca151b5 JB |
346 | /** |
347 | * iwl_rate_control_register - Register the rate control algorithm callbacks | |
348 | * | |
349 | * Since the rate control algorithm is hardware specific, there is no need | |
350 | * or reason to place it as a stand alone module. The driver can call | |
351 | * iwl_rate_control_register in order to register the rate control callbacks | |
352 | * with the mac80211 subsystem. This should be performed prior to calling | |
353 | * ieee80211_register_hw | |
354 | * | |
355 | */ | |
b3818394 | 356 | int iwl_mvm_rate_control_register(void); |
8ca151b5 JB |
357 | |
358 | /** | |
359 | * iwl_rate_control_unregister - Unregister the rate control callbacks | |
360 | * | |
361 | * This should be called after calling ieee80211_unregister_hw, but before | |
362 | * the driver is unloaded. | |
363 | */ | |
b3818394 | 364 | void iwl_mvm_rate_control_unregister(void); |
8ca151b5 | 365 | |
9ee718aa EL |
366 | struct iwl_mvm_sta; |
367 | ||
e126b5d9 JB |
368 | int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta, |
369 | bool enable); | |
9ee718aa | 370 | |
8ca151b5 | 371 | #endif /* __rs__ */ |