1 /******************************************************************************
3 * Copyright(c) 2003 - 2007 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 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 *****************************************************************************/
27 #ifndef __iwl_4965_rs_h__
28 #define __iwl_4965_rs_h__
32 struct iwl4965_rate_info {
33 u8 plcp; /* uCode API: IWL_RATE_6M_PLCP, etc. */
34 u8 plcp_siso; /* uCode API: IWL_RATE_SISO_6M_PLCP, etc. */
35 u8 plcp_mimo; /* uCode API: IWL_RATE_MIMO_6M_PLCP, etc. */
36 u8 ieee; /* MAC header: IWL_RATE_6M_IEEE, etc. */
37 u8 prev_ieee; /* previous rate in IEEE speeds */
38 u8 next_ieee; /* next rate in IEEE speeds */
39 u8 prev_rs; /* previous rate used in rs algo */
40 u8 next_rs; /* next rate used in rs algo */
41 u8 prev_rs_tgg; /* previous rate used in TGG rs algo */
42 u8 next_rs_tgg; /* next rate used in TGG rs algo */
46 * These serve as indexes into
47 * struct iwl4965_rate_info iwl4965_rates[IWL_RATE_COUNT];
50 IWL_RATE_1M_INDEX = 0,
64 IWL_RATE_INVM_INDEX = IWL_RATE_COUNT,
65 IWL_RATE_INVALID = IWL_RATE_INVM_INDEX
69 IWL_FIRST_OFDM_RATE = IWL_RATE_6M_INDEX,
70 IWL_LAST_OFDM_RATE = IWL_RATE_60M_INDEX,
71 IWL_FIRST_CCK_RATE = IWL_RATE_1M_INDEX,
72 IWL_LAST_CCK_RATE = IWL_RATE_11M_INDEX,
75 /* #define vs. enum to keep from defaulting to 'large integer' */
76 #define IWL_RATE_6M_MASK (1 << IWL_RATE_6M_INDEX)
77 #define IWL_RATE_9M_MASK (1 << IWL_RATE_9M_INDEX)
78 #define IWL_RATE_12M_MASK (1 << IWL_RATE_12M_INDEX)
79 #define IWL_RATE_18M_MASK (1 << IWL_RATE_18M_INDEX)
80 #define IWL_RATE_24M_MASK (1 << IWL_RATE_24M_INDEX)
81 #define IWL_RATE_36M_MASK (1 << IWL_RATE_36M_INDEX)
82 #define IWL_RATE_48M_MASK (1 << IWL_RATE_48M_INDEX)
83 #define IWL_RATE_54M_MASK (1 << IWL_RATE_54M_INDEX)
84 #define IWL_RATE_60M_MASK (1 << IWL_RATE_60M_INDEX)
85 #define IWL_RATE_1M_MASK (1 << IWL_RATE_1M_INDEX)
86 #define IWL_RATE_2M_MASK (1 << IWL_RATE_2M_INDEX)
87 #define IWL_RATE_5M_MASK (1 << IWL_RATE_5M_INDEX)
88 #define IWL_RATE_11M_MASK (1 << IWL_RATE_11M_INDEX)
90 /* 4965 uCode API values for legacy bit rates, both OFDM and CCK */
92 IWL_RATE_6M_PLCP = 13,
93 IWL_RATE_9M_PLCP = 15,
94 IWL_RATE_12M_PLCP = 5,
95 IWL_RATE_18M_PLCP = 7,
96 IWL_RATE_24M_PLCP = 9,
97 IWL_RATE_36M_PLCP = 11,
98 IWL_RATE_48M_PLCP = 1,
99 IWL_RATE_54M_PLCP = 3,
100 IWL_RATE_60M_PLCP = 3,
101 IWL_RATE_1M_PLCP = 10,
102 IWL_RATE_2M_PLCP = 20,
103 IWL_RATE_5M_PLCP = 55,
104 IWL_RATE_11M_PLCP = 110,
107 /* 4965 uCode API values for OFDM high-throughput (HT) bit rates */
109 IWL_RATE_SISO_6M_PLCP = 0,
110 IWL_RATE_SISO_12M_PLCP = 1,
111 IWL_RATE_SISO_18M_PLCP = 2,
112 IWL_RATE_SISO_24M_PLCP = 3,
113 IWL_RATE_SISO_36M_PLCP = 4,
114 IWL_RATE_SISO_48M_PLCP = 5,
115 IWL_RATE_SISO_54M_PLCP = 6,
116 IWL_RATE_SISO_60M_PLCP = 7,
117 IWL_RATE_MIMO_6M_PLCP = 0x8,
118 IWL_RATE_MIMO_12M_PLCP = 0x9,
119 IWL_RATE_MIMO_18M_PLCP = 0xa,
120 IWL_RATE_MIMO_24M_PLCP = 0xb,
121 IWL_RATE_MIMO_36M_PLCP = 0xc,
122 IWL_RATE_MIMO_48M_PLCP = 0xd,
123 IWL_RATE_MIMO_54M_PLCP = 0xe,
124 IWL_RATE_MIMO_60M_PLCP = 0xf,
125 IWL_RATE_SISO_INVM_PLCP,
126 IWL_RATE_MIMO_INVM_PLCP = IWL_RATE_SISO_INVM_PLCP,
129 /* MAC header values for bit rates */
131 IWL_RATE_6M_IEEE = 12,
132 IWL_RATE_9M_IEEE = 18,
133 IWL_RATE_12M_IEEE = 24,
134 IWL_RATE_18M_IEEE = 36,
135 IWL_RATE_24M_IEEE = 48,
136 IWL_RATE_36M_IEEE = 72,
137 IWL_RATE_48M_IEEE = 96,
138 IWL_RATE_54M_IEEE = 108,
139 IWL_RATE_60M_IEEE = 120,
140 IWL_RATE_1M_IEEE = 2,
141 IWL_RATE_2M_IEEE = 4,
142 IWL_RATE_5M_IEEE = 11,
143 IWL_RATE_11M_IEEE = 22,
146 #define IWL_CCK_BASIC_RATES_MASK \
147 (IWL_RATE_1M_MASK | \
150 #define IWL_CCK_RATES_MASK \
151 (IWL_BASIC_RATES_MASK | \
155 #define IWL_OFDM_BASIC_RATES_MASK \
156 (IWL_RATE_6M_MASK | \
157 IWL_RATE_12M_MASK | \
160 #define IWL_OFDM_RATES_MASK \
161 (IWL_OFDM_BASIC_RATES_MASK | \
163 IWL_RATE_18M_MASK | \
164 IWL_RATE_36M_MASK | \
165 IWL_RATE_48M_MASK | \
168 #define IWL_BASIC_RATES_MASK \
169 (IWL_OFDM_BASIC_RATES_MASK | \
170 IWL_CCK_BASIC_RATES_MASK)
172 #define IWL_RATES_MASK ((1 << IWL_RATE_COUNT) - 1)
174 #define IWL_INVALID_VALUE -1
176 #define IWL_MIN_RSSI_VAL -100
177 #define IWL_MAX_RSSI_VAL 0
179 /* These values specify how many Tx frame attempts before
180 * searching for a new modulation mode */
181 #define IWL_LEGACY_FAILURE_LIMIT 160
182 #define IWL_LEGACY_SUCCESS_LIMIT 480
183 #define IWL_LEGACY_TABLE_COUNT 160
185 #define IWL_NONE_LEGACY_FAILURE_LIMIT 400
186 #define IWL_NONE_LEGACY_SUCCESS_LIMIT 4500
187 #define IWL_NONE_LEGACY_TABLE_COUNT 1500
189 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
190 #define IWL_RS_GOOD_RATIO 12800 /* 100% */
191 #define IWL_RATE_SCALE_SWITCH 10880 /* 85% */
192 #define IWL_RATE_HIGH_TH 10880 /* 85% */
193 #define IWL_RATE_INCREASE_TH 8960 /* 70% */
194 #define IWL_RATE_DECREASE_TH 1920 /* 15% */
196 /* possible actions when in legacy mode */
197 #define IWL_LEGACY_SWITCH_ANTENNA 0
198 #define IWL_LEGACY_SWITCH_SISO 1
199 #define IWL_LEGACY_SWITCH_MIMO 2
201 /* possible actions when in siso mode */
202 #define IWL_SISO_SWITCH_ANTENNA 0
203 #define IWL_SISO_SWITCH_MIMO 1
204 #define IWL_SISO_SWITCH_GI 2
206 /* possible actions when in mimo mode */
207 #define IWL_MIMO_SWITCH_ANTENNA_A 0
208 #define IWL_MIMO_SWITCH_ANTENNA_B 1
209 #define IWL_MIMO_SWITCH_GI 2
211 #define IWL_ACTION_LIMIT 3 /* # possible actions */
213 #define LQ_SIZE 2 /* 2 mode tables: "Active" and "Search" */
215 /* load per tid defines for A-MPDU activation */
216 #define IWL_AGG_TPT_THREHOLD 0
217 #define IWL_AGG_LOAD_THRESHOLD 10
218 #define IWL_AGG_ALL_TID 0xff
219 #define TID_QUEUE_CELL_SPACING 50 /*mS */
220 #define TID_QUEUE_MAX_SIZE 20
221 #define TID_ROUND_VALUE 5 /* mS */
222 #define TID_MAX_LOAD_COUNT 8
224 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
225 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
227 extern const struct iwl4965_rate_info iwl4965_rates[IWL_RATE_COUNT];
229 enum iwl4965_table_type {
231 LQ_G, /* legacy types */
233 LQ_SISO, /* high-throughput types */
238 #define is_legacy(tbl) (((tbl) == LQ_G) || ((tbl) == LQ_A))
239 #define is_siso(tbl) (((tbl) == LQ_SISO))
240 #define is_mimo(tbl) (((tbl) == LQ_MIMO))
241 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
242 #define is_a_band(tbl) (((tbl) == LQ_A))
243 #define is_g_and(tbl) (((tbl) == LQ_G))
245 /* 4965 has 2 antennas/chains for Tx (but 3 for Rx) */
246 enum iwl4965_antenna_type {
253 static inline u8 iwl4965_get_prev_ieee_rate(u8 rate_index)
255 u8 rate = iwl4965_rates[rate_index].prev_ieee;
257 if (rate == IWL_RATE_INVALID)
262 extern int iwl4965_rate_index_from_plcp(int plcp);
265 * iwl4965_fill_rs_info - Fill an output text buffer with the rate representation
267 * NOTE: This is provided as a quick mechanism for a user to visualize
268 * the performance of the rate control algorithm and is not meant to be
271 extern int iwl4965_fill_rs_info(struct ieee80211_hw *, char *buf, u8 sta_id);
274 * iwl4965_rate_scale_init - Initialize the rate scale table based on assoc info
276 * The specific throughput table used is based on the type of network
277 * the associated with, including A, B, G, and G w/ TGG protection
279 extern void iwl4965_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
282 * iwl4965_rate_control_register - Register the rate control algorithm callbacks
284 * Since the rate control algorithm is hardware specific, there is no need
285 * or reason to place it as a stand alone module. The driver can call
286 * iwl4965_rate_control_register in order to register the rate control callbacks
287 * with the mac80211 subsystem. This should be performed prior to calling
288 * ieee80211_register_hw
291 extern void iwl4965_rate_control_register(struct ieee80211_hw *hw);
294 * iwl4965_rate_control_unregister - Unregister the rate control callbacks
296 * This should be called after calling ieee80211_unregister_hw, but before
297 * the driver is unloaded.
299 extern void iwl4965_rate_control_unregister(struct ieee80211_hw *hw);