1 /******************************************************************************
3 * Copyright(c) 2003 - 2010 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 struct iwl_rate_info
{
31 u8 plcp
; /* uCode API: IWL_RATE_6M_PLCP, etc. */
32 u8 plcp_siso
; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
33 u8 plcp_mimo2
; /* uCode API: IWL_RATE_MIMO2_6M_PLCP, etc. */
34 u8 plcp_mimo3
; /* uCode API: IWL_RATE_MIMO3_6M_PLCP, etc. */
35 u8 ieee
; /* MAC header: IWL_RATE_6M_IEEE, etc. */
36 u8 prev_ieee
; /* previous rate in IEEE speeds */
37 u8 next_ieee
; /* next rate in IEEE speeds */
38 u8 prev_rs
; /* previous rate used in rs algo */
39 u8 next_rs
; /* next rate used in rs algo */
40 u8 prev_rs_tgg
; /* previous rate used in TGG rs algo */
41 u8 next_rs_tgg
; /* next rate used in TGG rs algo */
44 struct iwl3945_rate_info
{
45 u8 plcp
; /* uCode API: IWL_RATE_6M_PLCP, etc. */
46 u8 ieee
; /* MAC header: IWL_RATE_6M_IEEE, etc. */
47 u8 prev_ieee
; /* previous rate in IEEE speeds */
48 u8 next_ieee
; /* next rate in IEEE speeds */
49 u8 prev_rs
; /* previous rate used in rs algo */
50 u8 next_rs
; /* next rate used in rs algo */
51 u8 prev_rs_tgg
; /* previous rate used in TGG rs algo */
52 u8 next_rs_tgg
; /* next rate used in TGG rs algo */
53 u8 table_rs_index
; /* index in rate scale table cmd */
54 u8 prev_table_rs
; /* prev in rate table cmd */
59 * These serve as indexes into
60 * struct iwl_rate_info iwl_rates[IWL_RATE_COUNT];
63 IWL_RATE_1M_INDEX
= 0,
76 IWL_RATE_COUNT
, /*FIXME:RS:change to IWL_RATE_INDEX_COUNT,*/
77 IWL_RATE_COUNT_LEGACY
= IWL_RATE_COUNT
- 1, /* Excluding 60M */
78 IWL_RATE_COUNT_3945
= IWL_RATE_COUNT
- 1,
79 IWL_RATE_INVM_INDEX
= IWL_RATE_COUNT
,
80 IWL_RATE_INVALID
= IWL_RATE_COUNT
,
84 IWL_RATE_6M_INDEX_TABLE
= 0,
85 IWL_RATE_9M_INDEX_TABLE
,
86 IWL_RATE_12M_INDEX_TABLE
,
87 IWL_RATE_18M_INDEX_TABLE
,
88 IWL_RATE_24M_INDEX_TABLE
,
89 IWL_RATE_36M_INDEX_TABLE
,
90 IWL_RATE_48M_INDEX_TABLE
,
91 IWL_RATE_54M_INDEX_TABLE
,
92 IWL_RATE_1M_INDEX_TABLE
,
93 IWL_RATE_2M_INDEX_TABLE
,
94 IWL_RATE_5M_INDEX_TABLE
,
95 IWL_RATE_11M_INDEX_TABLE
,
96 IWL_RATE_INVM_INDEX_TABLE
= IWL_RATE_INVM_INDEX
- 1,
100 IWL_FIRST_OFDM_RATE
= IWL_RATE_6M_INDEX
,
101 IWL39_LAST_OFDM_RATE
= IWL_RATE_54M_INDEX
,
102 IWL_LAST_OFDM_RATE
= IWL_RATE_60M_INDEX
,
103 IWL_FIRST_CCK_RATE
= IWL_RATE_1M_INDEX
,
104 IWL_LAST_CCK_RATE
= IWL_RATE_11M_INDEX
,
107 /* #define vs. enum to keep from defaulting to 'large integer' */
108 #define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
109 #define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
110 #define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
111 #define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
112 #define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
113 #define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
114 #define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
115 #define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
116 #define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
117 #define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
118 #define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
119 #define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
120 #define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
122 /* uCode API values for legacy bit rates, both OFDM and CCK */
124 IWL_RATE_6M_PLCP
= 13,
125 IWL_RATE_9M_PLCP
= 15,
126 IWL_RATE_12M_PLCP
= 5,
127 IWL_RATE_18M_PLCP
= 7,
128 IWL_RATE_24M_PLCP
= 9,
129 IWL_RATE_36M_PLCP
= 11,
130 IWL_RATE_48M_PLCP
= 1,
131 IWL_RATE_54M_PLCP
= 3,
132 IWL_RATE_60M_PLCP
= 3,/*FIXME:RS:should be removed*/
133 IWL_RATE_1M_PLCP
= 10,
134 IWL_RATE_2M_PLCP
= 20,
135 IWL_RATE_5M_PLCP
= 55,
136 IWL_RATE_11M_PLCP
= 110,
137 /*FIXME:RS:change to IWL_RATE_LEGACY_??M_PLCP */
138 /*FIXME:RS:add IWL_RATE_LEGACY_INVM_PLCP = 0,*/
141 /* uCode API values for OFDM high-throughput (HT) bit rates */
143 IWL_RATE_SISO_6M_PLCP
= 0,
144 IWL_RATE_SISO_12M_PLCP
= 1,
145 IWL_RATE_SISO_18M_PLCP
= 2,
146 IWL_RATE_SISO_24M_PLCP
= 3,
147 IWL_RATE_SISO_36M_PLCP
= 4,
148 IWL_RATE_SISO_48M_PLCP
= 5,
149 IWL_RATE_SISO_54M_PLCP
= 6,
150 IWL_RATE_SISO_60M_PLCP
= 7,
151 IWL_RATE_MIMO2_6M_PLCP
= 0x8,
152 IWL_RATE_MIMO2_12M_PLCP
= 0x9,
153 IWL_RATE_MIMO2_18M_PLCP
= 0xa,
154 IWL_RATE_MIMO2_24M_PLCP
= 0xb,
155 IWL_RATE_MIMO2_36M_PLCP
= 0xc,
156 IWL_RATE_MIMO2_48M_PLCP
= 0xd,
157 IWL_RATE_MIMO2_54M_PLCP
= 0xe,
158 IWL_RATE_MIMO2_60M_PLCP
= 0xf,
159 IWL_RATE_MIMO3_6M_PLCP
= 0x10,
160 IWL_RATE_MIMO3_12M_PLCP
= 0x11,
161 IWL_RATE_MIMO3_18M_PLCP
= 0x12,
162 IWL_RATE_MIMO3_24M_PLCP
= 0x13,
163 IWL_RATE_MIMO3_36M_PLCP
= 0x14,
164 IWL_RATE_MIMO3_48M_PLCP
= 0x15,
165 IWL_RATE_MIMO3_54M_PLCP
= 0x16,
166 IWL_RATE_MIMO3_60M_PLCP
= 0x17,
167 IWL_RATE_SISO_INVM_PLCP
,
168 IWL_RATE_MIMO2_INVM_PLCP
= IWL_RATE_SISO_INVM_PLCP
,
169 IWL_RATE_MIMO3_INVM_PLCP
= IWL_RATE_SISO_INVM_PLCP
,
172 /* MAC header values for bit rates */
174 IWL_RATE_6M_IEEE
= 12,
175 IWL_RATE_9M_IEEE
= 18,
176 IWL_RATE_12M_IEEE
= 24,
177 IWL_RATE_18M_IEEE
= 36,
178 IWL_RATE_24M_IEEE
= 48,
179 IWL_RATE_36M_IEEE
= 72,
180 IWL_RATE_48M_IEEE
= 96,
181 IWL_RATE_54M_IEEE
= 108,
182 IWL_RATE_60M_IEEE
= 120,
183 IWL_RATE_1M_IEEE
= 2,
184 IWL_RATE_2M_IEEE
= 4,
185 IWL_RATE_5M_IEEE
= 11,
186 IWL_RATE_11M_IEEE
= 22,
189 #define IWL_CCK_BASIC_RATES_MASK \
190 (IWL_RATE_1M_MASK | \
193 #define IWL_CCK_RATES_MASK \
194 (IWL_CCK_BASIC_RATES_MASK | \
198 #define IWL_OFDM_BASIC_RATES_MASK \
199 (IWL_RATE_6M_MASK | \
200 IWL_RATE_12M_MASK | \
203 #define IWL_OFDM_RATES_MASK \
204 (IWL_OFDM_BASIC_RATES_MASK | \
206 IWL_RATE_18M_MASK | \
207 IWL_RATE_36M_MASK | \
208 IWL_RATE_48M_MASK | \
211 #define IWL_BASIC_RATES_MASK \
212 (IWL_OFDM_BASIC_RATES_MASK | \
213 IWL_CCK_BASIC_RATES_MASK)
215 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
217 #define IWL_INVALID_VALUE -1
219 #define IWL_MIN_RSSI_VAL -100
220 #define IWL_MAX_RSSI_VAL 0
222 /* These values specify how many Tx frame attempts before
223 * searching for a new modulation mode */
224 #define IWL_LEGACY_FAILURE_LIMIT 160
225 #define IWL_LEGACY_SUCCESS_LIMIT 480
226 #define IWL_LEGACY_TABLE_COUNT 160
228 #define IWL_NONE_LEGACY_FAILURE_LIMIT 400
229 #define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
230 #define IWL_NONE_LEGACY_TABLE_COUNT 1500
232 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
233 #define IWL_RS_GOOD_RATIO 12800 /* 100% */
234 #define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
235 #define IWL_RATE_HIGH_TH 10880 /* 85% */
236 #define IWL_RATE_INCREASE_TH 6400 /* 50% */
237 #define IWL_RATE_DECREASE_TH 1920 /* 15% */
239 /* possible actions when in legacy mode */
240 #define IWL_LEGACY_SWITCH_ANTENNA1 0
241 #define IWL_LEGACY_SWITCH_ANTENNA2 1
242 #define IWL_LEGACY_SWITCH_SISO 2
243 #define IWL_LEGACY_SWITCH_MIMO2_AB 3
244 #define IWL_LEGACY_SWITCH_MIMO2_AC 4
245 #define IWL_LEGACY_SWITCH_MIMO2_BC 5
246 #define IWL_LEGACY_SWITCH_MIMO3_ABC 6
248 /* possible actions when in siso mode */
249 #define IWL_SISO_SWITCH_ANTENNA1 0
250 #define IWL_SISO_SWITCH_ANTENNA2 1
251 #define IWL_SISO_SWITCH_MIMO2_AB 2
252 #define IWL_SISO_SWITCH_MIMO2_AC 3
253 #define IWL_SISO_SWITCH_MIMO2_BC 4
254 #define IWL_SISO_SWITCH_GI 5
255 #define IWL_SISO_SWITCH_MIMO3_ABC 6
258 /* possible actions when in mimo mode */
259 #define IWL_MIMO2_SWITCH_ANTENNA1 0
260 #define IWL_MIMO2_SWITCH_ANTENNA2 1
261 #define IWL_MIMO2_SWITCH_SISO_A 2
262 #define IWL_MIMO2_SWITCH_SISO_B 3
263 #define IWL_MIMO2_SWITCH_SISO_C 4
264 #define IWL_MIMO2_SWITCH_GI 5
265 #define IWL_MIMO2_SWITCH_MIMO3_ABC 6
268 /* possible actions when in mimo3 mode */
269 #define IWL_MIMO3_SWITCH_ANTENNA1 0
270 #define IWL_MIMO3_SWITCH_ANTENNA2 1
271 #define IWL_MIMO3_SWITCH_SISO_A 2
272 #define IWL_MIMO3_SWITCH_SISO_B 3
273 #define IWL_MIMO3_SWITCH_SISO_C 4
274 #define IWL_MIMO3_SWITCH_MIMO2_AB 5
275 #define IWL_MIMO3_SWITCH_MIMO2_AC 6
276 #define IWL_MIMO3_SWITCH_MIMO2_BC 7
277 #define IWL_MIMO3_SWITCH_GI 8
280 #define IWL_MAX_11N_MIMO3_SEARCH IWL_MIMO3_SWITCH_GI
281 #define IWL_MAX_SEARCH IWL_MIMO2_SWITCH_MIMO3_ABC
283 /*FIXME:RS:add possible actions for MIMO3*/
285 #define IWL_ACTION_LIMIT 3 /* # possible actions */
287 #define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
289 /* load per tid defines for A-MPDU activation */
290 #define IWL_AGG_TPT_THREHOLD 0
291 #define IWL_AGG_LOAD_THRESHOLD 10
292 #define IWL_AGG_ALL_TID 0xff
293 #define TID_QUEUE_CELL_SPACING 50 /*mS */
294 #define TID_QUEUE_MAX_SIZE 20
295 #define TID_ROUND_VALUE 5 /* mS */
296 #define TID_MAX_LOAD_COUNT 8
298 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
299 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
301 extern const struct iwl_rate_info iwl_rates
[IWL_RATE_COUNT
];
303 enum iwl_table_type
{
305 LQ_G
, /* legacy types */
307 LQ_SISO
, /* high-throughput types */
313 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
314 #define is_siso(tbl) ((tbl) == LQ_SISO)
315 #define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
316 #define is_mimo3(tbl) ((tbl) == LQ_MIMO3)
317 #define is_mimo(tbl) (is_mimo2(tbl) || is_mimo3(tbl))
318 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
319 #define is_a_band(tbl) ((tbl) == LQ_A)
320 #define is_g_and(tbl) ((tbl) == LQ_G)
325 #define ANT_AB (ANT_A | ANT_B)
327 #define ANT_AC (ANT_A | ANT_C)
328 #define ANT_BC (ANT_B | ANT_C)
329 #define ANT_ABC (ANT_AB | ANT_C)
331 #define IWL_MAX_MCS_DISPLAY_SIZE 12
333 struct iwl_rate_mcs_info
{
334 char mbps
[IWL_MAX_MCS_DISPLAY_SIZE
];
335 char mcs
[IWL_MAX_MCS_DISPLAY_SIZE
];
339 * struct iwl_rate_scale_data -- tx success history for one rate
341 struct iwl_rate_scale_data
{
342 u64 data
; /* bitmap of successful frames */
343 s32 success_counter
; /* number of frames successful */
344 s32 success_ratio
; /* per-cent * 128 */
345 s32 counter
; /* number of frames attempted */
346 s32 average_tpt
; /* success ratio * expected throughput */
351 * struct iwl_scale_tbl_info -- tx params and success history for all rates
353 * There are two of these in struct iwl_lq_sta,
354 * one for "active", and one for "search".
356 struct iwl_scale_tbl_info
{
357 enum iwl_table_type lq_type
;
359 u8 is_SGI
; /* 1 = short guard interval */
360 u8 is_ht40
; /* 1 = 40 MHz channel width */
361 u8 is_dup
; /* 1 = duplicated data streams */
362 u8 action
; /* change modulation; IWL_[LEGACY/SISO/MIMO]_SWITCH_* */
363 u8 max_search
; /* maximun number of tables we can search */
364 s32
*expected_tpt
; /* throughput metrics; expected_tpt_G, etc. */
365 u32 current_rate
; /* rate_n_flags, uCode API format */
366 struct iwl_rate_scale_data win
[IWL_RATE_COUNT
]; /* rate histories */
369 struct iwl_traffic_load
{
370 unsigned long time_stamp
; /* age of the oldest statistics */
371 u32 packet_count
[TID_QUEUE_MAX_SIZE
]; /* packet count in this time
373 u32 total
; /* total num of packets during the
374 * last TID_MAX_TIME_DIFF */
375 u8 queue_count
; /* number of queues that has
376 * been used since the last cleanup */
377 u8 head
; /* start of the circular buffer */
381 * struct iwl_lq_sta -- driver's rate scaling private structure
383 * Pointer to this gets passed back and forth between driver and mac80211.
386 u8 active_tbl
; /* index of active table, range 0-1 */
387 u8 enable_counter
; /* indicates HT mode */
388 u8 stay_in_tbl
; /* 1: disallow, 0: allow search for new mode */
389 u8 search_better_tbl
; /* 1: currently trying alternate mode */
392 /* The following determine when to search for a new mode */
393 u32 table_count_limit
;
394 u32 max_failure_limit
; /* # failed frames before new search */
395 u32 max_success_limit
; /* # successful frames before new search */
397 u32 total_failed
; /* total failed frames, any/all rates */
398 u32 total_success
; /* total successful frames, any/all rates */
399 u64 flush_timer
; /* time staying in mode before new search */
401 u8 action_counter
; /* # mode-switch actions tried */
404 enum ieee80211_band band
;
406 /* The following are bitmaps of rates; IWL_RATE_6M_MASK, etc. */
408 u16 active_legacy_rate
;
409 u16 active_siso_rate
;
410 u16 active_mimo2_rate
;
411 u16 active_mimo3_rate
;
412 s8 max_rate_idx
; /* Max rate set by user */
413 u8 missed_rate_counter
;
415 struct iwl_link_quality_cmd lq
;
416 struct iwl_scale_tbl_info lq_info
[LQ_SIZE
]; /* "active", "search" */
417 struct iwl_traffic_load load
[TID_MAX_LOAD_COUNT
];
419 #ifdef CONFIG_MAC80211_DEBUGFS
420 struct dentry
*rs_sta_dbgfs_scale_table_file
;
421 struct dentry
*rs_sta_dbgfs_stats_table_file
;
422 struct dentry
*rs_sta_dbgfs_rate_scale_data_file
;
423 struct dentry
*rs_sta_dbgfs_tx_agg_tid_en_file
;
426 struct iwl_priv
*drv
;
428 /* used to be in sta_info */
430 /* last tx rate_n_flags */
431 u32 last_rate_n_flags
;
432 /* packets destined for this STA are aggregated */
434 /* BT traffic this sta was last updated in */
438 static inline u8
num_of_ant(u8 mask
)
440 return !!((mask
) & ANT_A
) +
445 static inline u8
first_antenna(u8 mask
)
456 * iwl3945_rate_scale_init - Initialize the rate scale table based on assoc info
458 * The specific throughput table used is based on the type of network
459 * the associated with, including A, B, G, and G w/ TGG protection
461 extern void iwl3945_rate_scale_init(struct ieee80211_hw
*hw
, s32 sta_id
);
463 /* Initialize station's rate scaling information after adding station */
464 extern void iwl_rs_rate_init(struct iwl_priv
*priv
,
465 struct ieee80211_sta
*sta
, u8 sta_id
);
466 extern void iwl3945_rs_rate_init(struct iwl_priv
*priv
,
467 struct ieee80211_sta
*sta
, u8 sta_id
);
470 * iwl_rate_control_register - Register the rate control algorithm callbacks
472 * Since the rate control algorithm is hardware specific, there is no need
473 * or reason to place it as a stand alone module. The driver can call
474 * iwl_rate_control_register in order to register the rate control callbacks
475 * with the mac80211 subsystem. This should be performed prior to calling
476 * ieee80211_register_hw
479 extern int iwlagn_rate_control_register(void);
480 extern int iwl3945_rate_control_register(void);
483 * iwl_rate_control_unregister - Unregister the rate control callbacks
485 * This should be called after calling ieee80211_unregister_hw, but before
486 * the driver is unloaded.
488 extern void iwlagn_rate_control_unregister(void);
489 extern void iwl3945_rate_control_unregister(void);
491 #endif /* __iwl_agn__rs__ */