1 /******************************************************************************
3 * Copyright(c) 2003 - 2012 Intel Corporation. All rights reserved.
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.
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
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
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
21 * Contact Information:
22 * Intel Linux Wireless <ilw@linux.intel.com>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 *****************************************************************************/
27 #ifndef __iwl_agn_rs_h__
28 #define __iwl_agn_rs_h__
30 #include <net/mac80211.h>
32 #include "iwl-commands.h"
34 struct iwl_rate_info
{
35 u8 plcp
; /* uCode API: IWL_RATE_6M_PLCP, etc. */
36 u8 plcp_siso
; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
37 u8 plcp_mimo2
; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */
38 u8 plcp_mimo3
; /* uCode API: IWL_RATE_MIMO3_6M_PLCP, etc. */
39 u8 ieee
; /* MAC header: IWL_RATE_6M_IEEE, etc. */
40 u8 prev_ieee
; /* previous rate in IEEE speeds */
41 u8 next_ieee
; /* next rate in IEEE speeds */
42 u8 prev_rs
; /* previous rate used in rs algo */
43 u8 next_rs
; /* next rate used in rs algo */
44 u8 prev_rs_tgg
; /* previous rate used in TGG rs algo */
45 u8 next_rs_tgg
; /* next rate used in TGG rs algo */
49 * These serve as indexes into
50 * struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
53 IWL_RATE_1M_INDEX
= 0,
66 IWL_RATE_COUNT
, /*FIXME:RS:change to IWL_RATE_INDEX_COUNT,*/
67 IWL_RATE_COUNT_LEGACY
= IWL_RATE_COUNT
- 1, /* Excluding 60M */
68 IWL_RATE_INVM_INDEX
= IWL_RATE_COUNT
,
69 IWL_RATE_INVALID
= IWL_RATE_COUNT
,
73 IWL_RATE_6M_INDEX_TABLE
= 0,
74 IWL_RATE_9M_INDEX_TABLE
,
75 IWL_RATE_12M_INDEX_TABLE
,
76 IWL_RATE_18M_INDEX_TABLE
,
77 IWL_RATE_24M_INDEX_TABLE
,
78 IWL_RATE_36M_INDEX_TABLE
,
79 IWL_RATE_48M_INDEX_TABLE
,
80 IWL_RATE_54M_INDEX_TABLE
,
81 IWL_RATE_1M_INDEX_TABLE
,
82 IWL_RATE_2M_INDEX_TABLE
,
83 IWL_RATE_5M_INDEX_TABLE
,
84 IWL_RATE_11M_INDEX_TABLE
,
85 IWL_RATE_INVM_INDEX_TABLE
= IWL_RATE_INVM_INDEX
- 1,
89 IWL_FIRST_OFDM_RATE
= IWL_RATE_6M_INDEX
,
90 IWL_LAST_OFDM_RATE
= IWL_RATE_60M_INDEX
,
91 IWL_FIRST_CCK_RATE
= IWL_RATE_1M_INDEX
,
92 IWL_LAST_CCK_RATE
= IWL_RATE_11M_INDEX
,
95 /* #define vs. enum to keep from defaulting to 'large integer' */
96 #define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
97 #define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
98 #define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
99 #define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
100 #define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
101 #define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
102 #define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
103 #define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
104 #define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
105 #define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
106 #define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
107 #define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
108 #define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
110 /* uCode API values for legacy bit rates, both OFDM and CCK */
112 IWL_RATE_6M_PLCP
= 13,
113 IWL_RATE_9M_PLCP
= 15,
114 IWL_RATE_12M_PLCP
= 5,
115 IWL_RATE_18M_PLCP
= 7,
116 IWL_RATE_24M_PLCP
= 9,
117 IWL_RATE_36M_PLCP
= 11,
118 IWL_RATE_48M_PLCP
= 1,
119 IWL_RATE_54M_PLCP
= 3,
120 IWL_RATE_60M_PLCP
= 3,/*FIXME:RS:should be removed*/
121 IWL_RATE_1M_PLCP
= 10,
122 IWL_RATE_2M_PLCP
= 20,
123 IWL_RATE_5M_PLCP
= 55,
124 IWL_RATE_11M_PLCP
= 110,
125 /*FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP */
126 /*FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,*/
129 /* uCode API values for OFDM high-throughput (HT) bit rates */
131 IWL_RATE_SISO_6M_PLCP
= 0,
132 IWL_RATE_SISO_12M_PLCP
= 1,
133 IWL_RATE_SISO_18M_PLCP
= 2,
134 IWL_RATE_SISO_24M_PLCP
= 3,
135 IWL_RATE_SISO_36M_PLCP
= 4,
136 IWL_RATE_SISO_48M_PLCP
= 5,
137 IWL_RATE_SISO_54M_PLCP
= 6,
138 IWL_RATE_SISO_60M_PLCP
= 7,
139 IWL_RATE_MIMO2_6M_PLCP
= 0x8,
140 IWL_RATE_MIMO2_12M_PLCP
= 0x9,
141 IWL_RATE_MIMO2_18M_PLCP
= 0xa,
142 IWL_RATE_MIMO2_24M_PLCP
= 0xb,
143 IWL_RATE_MIMO2_36M_PLCP
= 0xc,
144 IWL_RATE_MIMO2_48M_PLCP
= 0xd,
145 IWL_RATE_MIMO2_54M_PLCP
= 0xe,
146 IWL_RATE_MIMO2_60M_PLCP
= 0xf,
147 IWL_RATE_MIMO3_6M_PLCP
= 0x10,
148 IWL_RATE_MIMO3_12M_PLCP
= 0x11,
149 IWL_RATE_MIMO3_18M_PLCP
= 0x12,
150 IWL_RATE_MIMO3_24M_PLCP
= 0x13,
151 IWL_RATE_MIMO3_36M_PLCP
= 0x14,
152 IWL_RATE_MIMO3_48M_PLCP
= 0x15,
153 IWL_RATE_MIMO3_54M_PLCP
= 0x16,
154 IWL_RATE_MIMO3_60M_PLCP
= 0x17,
155 IWL_RATE_SISO_INVM_PLCP
,
156 IWL_RATE_MIMO2_INVM_PLCP
= IWL_RATE_SISO_INVM_PLCP
,
157 IWL_RATE_MIMO3_INVM_PLCP
= IWL_RATE_SISO_INVM_PLCP
,
160 /* MAC header values for bit rates */
162 IWL_RATE_6M_IEEE
= 12,
163 IWL_RATE_9M_IEEE
= 18,
164 IWL_RATE_12M_IEEE
= 24,
165 IWL_RATE_18M_IEEE
= 36,
166 IWL_RATE_24M_IEEE
= 48,
167 IWL_RATE_36M_IEEE
= 72,
168 IWL_RATE_48M_IEEE
= 96,
169 IWL_RATE_54M_IEEE
= 108,
170 IWL_RATE_60M_IEEE
= 120,
171 IWL_RATE_1M_IEEE
= 2,
172 IWL_RATE_2M_IEEE
= 4,
173 IWL_RATE_5M_IEEE
= 11,
174 IWL_RATE_11M_IEEE
= 22,
177 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
179 #define IWL_INVALID_VALUE -1
181 #define IWL_MIN_RSSI_VAL -100
182 #define IWL_MAX_RSSI_VAL 0
184 /* These values specify how many Tx frame attempts before
185 * searching for a new modulation mode */
186 #define IWL_LEGACY_FAILURE_LIMIT 160
187 #define IWL_LEGACY_SUCCESS_LIMIT 480
188 #define IWL_LEGACY_TABLE_COUNT 160
190 #define IWL_NONE_LEGACY_FAILURE_LIMIT 400
191 #define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
192 #define IWL_NONE_LEGACY_TABLE_COUNT 1500
194 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
195 #define IWL_RS_GOOD_RATIO 12800 /* 100% */
196 #define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
197 #define IWL_RATE_HIGH_TH 10880 /* 85% */
198 #define IWL_RATE_INCREASE_TH 6400 /* 50% */
199 #define IWL_RATE_DECREASE_TH 1920 /* 15% */
201 /* possible actions when in legacy mode */
202 #define IWL_LEGACY_SWITCH_ANTENNA1 0
203 #define IWL_LEGACY_SWITCH_ANTENNA2 1
204 #define IWL_LEGACY_SWITCH_SISO 2
205 #define IWL_LEGACY_SWITCH_MIMO2_AB 3
206 #define IWL_LEGACY_SWITCH_MIMO2_AC 4
207 #define IWL_LEGACY_SWITCH_MIMO2_BC 5
208 #define IWL_LEGACY_SWITCH_MIMO3_ABC 6
210 /* possible actions when in siso mode */
211 #define IWL_SISO_SWITCH_ANTENNA1 0
212 #define IWL_SISO_SWITCH_ANTENNA2 1
213 #define IWL_SISO_SWITCH_MIMO2_AB 2
214 #define IWL_SISO_SWITCH_MIMO2_AC 3
215 #define IWL_SISO_SWITCH_MIMO2_BC 4
216 #define IWL_SISO_SWITCH_GI 5
217 #define IWL_SISO_SWITCH_MIMO3_ABC 6
220 /* possible actions when in mimo mode */
221 #define IWL_MIMO2_SWITCH_ANTENNA1 0
222 #define IWL_MIMO2_SWITCH_ANTENNA2 1
223 #define IWL_MIMO2_SWITCH_SISO_A 2
224 #define IWL_MIMO2_SWITCH_SISO_B 3
225 #define IWL_MIMO2_SWITCH_SISO_C 4
226 #define IWL_MIMO2_SWITCH_GI 5
227 #define IWL_MIMO2_SWITCH_MIMO3_ABC 6
230 /* possible actions when in mimo3 mode */
231 #define IWL_MIMO3_SWITCH_ANTENNA1 0
232 #define IWL_MIMO3_SWITCH_ANTENNA2 1
233 #define IWL_MIMO3_SWITCH_SISO_A 2
234 #define IWL_MIMO3_SWITCH_SISO_B 3
235 #define IWL_MIMO3_SWITCH_SISO_C 4
236 #define IWL_MIMO3_SWITCH_MIMO2_AB 5
237 #define IWL_MIMO3_SWITCH_MIMO2_AC 6
238 #define IWL_MIMO3_SWITCH_MIMO2_BC 7
239 #define IWL_MIMO3_SWITCH_GI 8
242 #define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
243 #define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC
245 /*FIXME:RS:add possible actions for MIMO3*/
247 #define IWL_ACTION_LIMIT 3 /* # possible actions */
249 #define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
251 /* load per tid defines for A-MPDU activation */
252 #define IWL_AGG_TPT_THREHOLD 0
253 #define IWL_AGG_LOAD_THRESHOLD 10
254 #define IWL_AGG_ALL_TID 0xff
255 #define TID_QUEUE_CELL_SPACING 50 /*mS */
256 #define TID_QUEUE_MAX_SIZE 20
257 #define TID_ROUND_VALUE 5 /* mS */
259 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
260 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
262 extern const struct iwl_rate_info iwl_rates
[IWL_RATE_COUNT
];
264 enum iwl_table_type
{
266 LQ_G
, /* legacy types */
268 LQ_SISO
, /* high-throughput types */
274 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
275 #define is_siso(tbl) ((tbl) == LQ_SISO)
276 #define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
277 #define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
278 #define is_mimo(tbl) (is_mimo2(tbl) || is_mimo3(tbl))
279 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
280 #define is_a_band(tbl) ((tbl) == LQ_A)
281 #define is_g_and(tbl) ((tbl) == LQ_G)
286 #define ANT_AB (ANT_A | ANT_B)
288 #define ANT_AC (ANT_A | ANT_C)
289 #define ANT_BC (ANT_B | ANT_C)
290 #define ANT_ABC (ANT_AB | ANT_C)
292 #define IWL_MAX_MCS_DISPLAY_SIZE 12
294 struct iwl_rate_mcs_info
{
295 char mbps
[IWL_MAX_MCS_DISPLAY_SIZE
];
296 char mcs
[IWL_MAX_MCS_DISPLAY_SIZE
];
300 * struct iwl_rate_scale_data -- tx success history for one rate
302 struct iwl_rate_scale_data
{
303 u64 data
; /* bitmap of successful frames */
304 s32 success_counter
; /* number of frames successful */
305 s32 success_ratio
; /* per-cent * 128 */
306 s32 counter
; /* number of frames attempted */
307 s32 average_tpt
; /* success ratio * expected throughput */
312 * struct iwl_scale_tbl_info -- tx params and success history for all rates
314 * There are two of these in struct iwl_lq_sta,
315 * one for "active", and one for "search".
317 struct iwl_scale_tbl_info
{
318 enum iwl_table_type lq_type
;
320 u8 is_SGI
; /* 1 = short guard interval */
321 u8 is_ht40
; /* 1 = 40 MHz channel width */
322 u8 is_dup
; /* 1 = duplicated data streams */
323 u8 action
; /* change modulation; IWL_[LEGACY/SISO/MIMO]_SWITCH_* */
324 u8 max_search
; /* maximun number of tables we can search */
325 s32
*expected_tpt
; /* throughput metrics; expected_tpt_G, etc. */
326 u32 current_rate
; /* rate_n_flags, uCode API format */
327 struct iwl_rate_scale_data win
[IWL_RATE_COUNT
]; /* rate histories */
330 struct iwl_traffic_load
{
331 unsigned long time_stamp
; /* age of the oldest statistics */
332 u32 packet_count
[TID_QUEUE_MAX_SIZE
]; /* packet count in this time
334 u32 total
; /* total num of packets during the
335 * last TID_MAX_TIME_DIFF */
336 u8 queue_count
; /* number of queues that has
337 * been used since the last cleanup */
338 u8 head
; /* start of the circular buffer */
342 * struct iwl_lq_sta -- driver's rate scaling private structure
344 * Pointer to this gets passed back and forth between driver and mac80211.
347 u8 active_tbl
; /* index of active table, range 0-1 */
348 u8 enable_counter
; /* indicates HT mode */
349 u8 stay_in_tbl
; /* 1: disallow, 0: allow search for new mode */
350 u8 search_better_tbl
; /* 1: currently trying alternate mode */
353 /* The following determine when to search for a new mode */
354 u32 table_count_limit
;
355 u32 max_failure_limit
; /* # failed frames before new search */
356 u32 max_success_limit
; /* # successful frames before new search */
358 u32 total_failed
; /* total failed frames, any/all rates */
359 u32 total_success
; /* total successful frames, any/all rates */
360 u64 flush_timer
; /* time staying in mode before new search */
362 u8 action_counter
; /* # mode-switch actions tried */
365 enum ieee80211_band band
;
367 /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
369 u16 active_legacy_rate
;
370 u16 active_siso_rate
;
371 u16 active_mimo2_rate
;
372 u16 active_mimo3_rate
;
373 s8 max_rate_idx
; /* Max rate set by user */
374 u8 missed_rate_counter
;
376 struct iwl_link_quality_cmd lq
;
377 struct iwl_scale_tbl_info lq_info
[LQ_SIZE
]; /* "active", "search" */
378 struct iwl_traffic_load load
[IWL_MAX_TID_COUNT
];
380 #ifdef CONFIG_MAC80211_DEBUGFS
381 struct dentry
*rs_sta_dbgfs_scale_table_file
;
382 struct dentry
*rs_sta_dbgfs_stats_table_file
;
383 struct dentry
*rs_sta_dbgfs_rate_scale_data_file
;
384 struct dentry
*rs_sta_dbgfs_tx_agg_tid_en_file
;
387 struct iwl_priv
*drv
;
389 /* used to be in sta_info */
391 /* last tx rate_n_flags */
392 u32 last_rate_n_flags
;
393 /* packets destined for this STA are aggregated */
395 /* BT traffic this sta was last updated in */
399 static inline u8
num_of_ant(u8 mask
)
401 return !!((mask
) & ANT_A
) +
406 static inline u8
first_antenna(u8 mask
)
416 /* Initialize station's rate scaling information after adding station */
417 extern void iwl_rs_rate_init(struct iwl_priv
*priv
,
418 struct ieee80211_sta
*sta
, u8 sta_id
);
421 * iwl_rate_control_register - Register the rate control algorithm callbacks
423 * Since the rate control algorithm is hardware specific, there is no need
424 * or reason to place it as a stand alone module. The driver can call
425 * iwl_rate_control_register in order to register the rate control callbacks
426 * with the mac80211 subsystem. This should be performed prior to calling
427 * ieee80211_register_hw
430 extern int iwlagn_rate_control_register(void);
433 * iwl_rate_control_unregister - Unregister the rate control callbacks
435 * This should be called after calling ieee80211_unregister_hw, but before
436 * the driver is unloaded.
438 extern void iwlagn_rate_control_unregister(void);
440 #endif /* __iwl_agn__rs__ */