Commit | Line | Data |
---|---|---|
b481de9c ZY |
1 | /****************************************************************************** |
2 | * | |
3 | * This file is provided under a dual BSD/GPLv2 license. When using or | |
4 | * redistributing this file, you may do so under either license. | |
5 | * | |
6 | * GPL LICENSE SUMMARY | |
7 | * | |
01f8162a | 8 | * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved. |
b481de9c ZY |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify | |
01ebd063 | 11 | * it under the terms of version 2 of the GNU General Public License as |
b481de9c ZY |
12 | * published by the Free Software Foundation. |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, but | |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, | |
22 | * USA | |
23 | * | |
24 | * The full GNU General Public License is included in this distribution | |
25 | * in the file called LICENSE.GPL. | |
26 | * | |
27 | * Contact Information: | |
759ef89f | 28 | * Intel Linux Wireless <ilw@linux.intel.com> |
b481de9c ZY |
29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 |
30 | * | |
31 | * BSD LICENSE | |
32 | * | |
01f8162a | 33 | * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved. |
b481de9c ZY |
34 | * All rights reserved. |
35 | * | |
36 | * Redistribution and use in source and binary forms, with or without | |
37 | * modification, are permitted provided that the following conditions | |
38 | * are met: | |
39 | * | |
40 | * * Redistributions of source code must retain the above copyright | |
41 | * notice, this list of conditions and the following disclaimer. | |
42 | * * Redistributions in binary form must reproduce the above copyright | |
43 | * notice, this list of conditions and the following disclaimer in | |
44 | * the documentation and/or other materials provided with the | |
45 | * distribution. | |
46 | * * Neither the name Intel Corporation nor the names of its | |
47 | * contributors may be used to endorse or promote products derived | |
48 | * from this software without specific prior written permission. | |
49 | * | |
50 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
51 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
52 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
53 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
54 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
55 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
56 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
57 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
58 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
59 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
60 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
61 | * | |
62 | *****************************************************************************/ | |
fcd427bb | 63 | /* |
5a36ba0e | 64 | * Please use this file (iwl-commands.h) only for uCode API definitions. |
fcd427bb | 65 | * Please use iwl-4965-hw.h for hardware-related definitions. |
3e0d4cb1 | 66 | * Please use iwl-dev.h for driver implementation definitions. |
fcd427bb | 67 | */ |
b481de9c | 68 | |
6a63578d EG |
69 | #ifndef __iwl_commands_h__ |
70 | #define __iwl_commands_h__ | |
b481de9c | 71 | |
a3139c59 SO |
72 | struct iwl_priv; |
73 | ||
c02b3acd CR |
74 | /* uCode version contains 4 values: Major/Minor/API/Serial */ |
75 | #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) | |
76 | #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) | |
77 | #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) | |
78 | #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) | |
79 | ||
4c897253 TW |
80 | |
81 | /* Tx rates */ | |
82 | #define IWL_CCK_RATES 4 | |
83 | #define IWL_OFDM_RATES 8 | |
84 | #define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES) | |
85 | ||
b481de9c ZY |
86 | enum { |
87 | REPLY_ALIVE = 0x1, | |
88 | REPLY_ERROR = 0x2, | |
89 | ||
90 | /* RXON and QOS commands */ | |
91 | REPLY_RXON = 0x10, | |
92 | REPLY_RXON_ASSOC = 0x11, | |
93 | REPLY_QOS_PARAM = 0x13, | |
94 | REPLY_RXON_TIMING = 0x14, | |
95 | ||
96 | /* Multi-Station support */ | |
97 | REPLY_ADD_STA = 0x18, | |
98 | REPLY_REMOVE_STA = 0x19, /* not used */ | |
99 | REPLY_REMOVE_ALL_STA = 0x1a, /* not used */ | |
100 | ||
0a0bed1d EG |
101 | /* Security */ |
102 | REPLY_WEPKEY = 0x20, | |
103 | ||
b481de9c | 104 | /* RX, TX, LEDs */ |
2aa6ab86 | 105 | REPLY_3945_RX = 0x1b, /* 3945 only */ |
b481de9c ZY |
106 | REPLY_TX = 0x1c, |
107 | REPLY_RATE_SCALE = 0x47, /* 3945 only */ | |
108 | REPLY_LEDS_CMD = 0x48, | |
109 | REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */ | |
110 | ||
9636e583 | 111 | /* WiMAX coexistence */ |
d23000cd | 112 | COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */ |
9636e583 RR |
113 | COEX_MEDIUM_NOTIFICATION = 0x5b, |
114 | COEX_EVENT_CMD = 0x5c, | |
115 | ||
be5d56ed | 116 | /* Calibration */ |
1a5c3d61 | 117 | TEMPERATURE_NOTIFICATION = 0x62, |
be5d56ed TW |
118 | CALIBRATION_CFG_CMD = 0x65, |
119 | CALIBRATION_RES_NOTIFICATION = 0x66, | |
120 | CALIBRATION_COMPLETE_NOTIFICATION = 0x67, | |
121 | ||
b481de9c ZY |
122 | /* 802.11h related */ |
123 | RADAR_NOTIFICATION = 0x70, /* not used */ | |
124 | REPLY_QUIET_CMD = 0x71, /* not used */ | |
125 | REPLY_CHANNEL_SWITCH = 0x72, | |
126 | CHANNEL_SWITCH_NOTIFICATION = 0x73, | |
127 | REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74, | |
128 | SPECTRUM_MEASURE_NOTIFICATION = 0x75, | |
129 | ||
130 | /* Power Management */ | |
131 | POWER_TABLE_CMD = 0x77, | |
132 | PM_SLEEP_NOTIFICATION = 0x7A, | |
133 | PM_DEBUG_STATISTIC_NOTIFIC = 0x7B, | |
134 | ||
135 | /* Scan commands and notifications */ | |
136 | REPLY_SCAN_CMD = 0x80, | |
137 | REPLY_SCAN_ABORT_CMD = 0x81, | |
138 | SCAN_START_NOTIFICATION = 0x82, | |
139 | SCAN_RESULTS_NOTIFICATION = 0x83, | |
140 | SCAN_COMPLETE_NOTIFICATION = 0x84, | |
141 | ||
142 | /* IBSS/AP commands */ | |
143 | BEACON_NOTIFICATION = 0x90, | |
144 | REPLY_TX_BEACON = 0x91, | |
145 | WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */ | |
146 | ||
147 | /* Miscellaneous commands */ | |
76a2407a | 148 | REPLY_TX_POWER_DBM_CMD = 0x95, |
b481de9c ZY |
149 | QUIET_NOTIFICATION = 0x96, /* not used */ |
150 | REPLY_TX_PWR_TABLE_CMD = 0x97, | |
76a2407a | 151 | REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */ |
2f748dec | 152 | TX_ANT_CONFIGURATION_CMD = 0x98, |
b481de9c ZY |
153 | MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */ |
154 | ||
a96a27f9 | 155 | /* Bluetooth device coexistence config command */ |
b481de9c ZY |
156 | REPLY_BT_CONFIG = 0x9b, |
157 | ||
80cc0c38 | 158 | /* Statistics */ |
b481de9c ZY |
159 | REPLY_STATISTICS_CMD = 0x9c, |
160 | STATISTICS_NOTIFICATION = 0x9d, | |
161 | ||
162 | /* RF-KILL commands and notifications */ | |
163 | REPLY_CARD_STATE_CMD = 0xa0, | |
164 | CARD_STATE_NOTIFICATION = 0xa1, | |
165 | ||
166 | /* Missed beacons notification */ | |
167 | MISSED_BEACONS_NOTIFICATION = 0xa2, | |
168 | ||
b481de9c ZY |
169 | REPLY_CT_KILL_CONFIG_CMD = 0xa4, |
170 | SENSITIVITY_CMD = 0xa8, | |
171 | REPLY_PHY_CALIBRATION_CMD = 0xb0, | |
172 | REPLY_RX_PHY_CMD = 0xc0, | |
173 | REPLY_RX_MPDU_CMD = 0xc1, | |
857485c0 | 174 | REPLY_RX = 0xc3, |
b481de9c | 175 | REPLY_COMPRESSED_BA = 0xc5, |
b481de9c ZY |
176 | REPLY_MAX = 0xff |
177 | }; | |
178 | ||
179 | /****************************************************************************** | |
180 | * (0) | |
abceddb4 | 181 | * Commonly used structures and definitions: |
80cc0c38 | 182 | * Command header, rate_n_flags, txpower |
b481de9c ZY |
183 | * |
184 | *****************************************************************************/ | |
185 | ||
857485c0 | 186 | /* iwl_cmd_header flags value */ |
b481de9c ZY |
187 | #define IWL_CMD_FAILED_MSK 0x40 |
188 | ||
9734cb23 TW |
189 | #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f) |
190 | #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8) | |
191 | #define SEQ_TO_INDEX(s) ((s) & 0xff) | |
192 | #define INDEX_TO_SEQ(i) ((i) & 0xff) | |
51e9bf5d HH |
193 | #define SEQ_HUGE_FRAME cpu_to_le16(0x4000) |
194 | #define SEQ_RX_FRAME cpu_to_le16(0x8000) | |
9734cb23 | 195 | |
075416cd | 196 | /** |
857485c0 | 197 | * struct iwl_cmd_header |
075416cd BC |
198 | * |
199 | * This header format appears in the beginning of each command sent from the | |
200 | * driver, and each response/notification received from uCode. | |
201 | */ | |
857485c0 | 202 | struct iwl_cmd_header { |
075416cd | 203 | u8 cmd; /* Command ID: REPLY_RXON, etc. */ |
9734cb23 | 204 | u8 flags; /* 0:5 reserved, 6 abort, 7 internal */ |
075416cd | 205 | /* |
a96a27f9 | 206 | * The driver sets up the sequence number to values of its choosing. |
075416cd BC |
207 | * uCode does not use this value, but passes it back to the driver |
208 | * when sending the response to each driver-originated command, so | |
209 | * the driver can match the response to the command. Since the values | |
210 | * don't get used by uCode, the driver may set up an arbitrary format. | |
b481de9c | 211 | * |
075416cd BC |
212 | * There is one exception: uCode sets bit 15 when it originates |
213 | * the response/notification, i.e. when the response/notification | |
214 | * is not a direct response to a command sent by the driver. For | |
215 | * example, uCode issues REPLY_3945_RX when it sends a received frame | |
216 | * to the driver; it is not a direct response to any driver command. | |
b481de9c | 217 | * |
075416cd BC |
218 | * The Linux driver uses the following format: |
219 | * | |
9734cb23 TW |
220 | * 0:7 tfd index - position within TX queue |
221 | * 8:12 TX queue id | |
222 | * 13 reserved | |
223 | * 14 huge - driver sets this to indicate command is in the | |
224 | * 'huge' storage at the end of the command buffers | |
225 | * 15 unsolicited RX or uCode-originated notification | |
b481de9c ZY |
226 | */ |
227 | __le16 sequence; | |
228 | ||
075416cd | 229 | /* command or response/notification data follows immediately */ |
b481de9c ZY |
230 | u8 data[0]; |
231 | } __attribute__ ((packed)); | |
232 | ||
3d24a9f7 TW |
233 | |
234 | /** | |
235 | * struct iwl3945_tx_power | |
236 | * | |
237 | * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH | |
238 | * | |
239 | * Each entry contains two values: | |
240 | * 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained | |
241 | * linear value that multiplies the output of the digital signal processor, | |
242 | * before being sent to the analog radio. | |
243 | * 2) Radio gain. This sets the analog gain of the radio Tx path. | |
244 | * It is a coarser setting, and behaves in a logarithmic (dB) fashion. | |
245 | * | |
246 | * Driver obtains values from struct iwl3945_tx_power power_gain_table[][]. | |
247 | */ | |
248 | struct iwl3945_tx_power { | |
249 | u8 tx_gain; /* gain for analog radio */ | |
250 | u8 dsp_atten; /* gain for DSP */ | |
251 | } __attribute__ ((packed)); | |
252 | ||
253 | /** | |
254 | * struct iwl3945_power_per_rate | |
255 | * | |
256 | * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
257 | */ | |
258 | struct iwl3945_power_per_rate { | |
259 | u8 rate; /* plcp */ | |
260 | struct iwl3945_tx_power tpc; | |
261 | u8 reserved; | |
262 | } __attribute__ ((packed)); | |
263 | ||
abceddb4 | 264 | /** |
5c5aa3f1 | 265 | * iwlagn rate_n_flags bit fields |
abceddb4 | 266 | * |
5c5aa3f1 | 267 | * rate_n_flags format is used in following iwlagn commands: |
857485c0 | 268 | * REPLY_RX (response only) |
5c5aa3f1 | 269 | * REPLY_RX_MPDU (response only) |
abceddb4 BC |
270 | * REPLY_TX (both command and response) |
271 | * REPLY_TX_LINK_QUALITY_CMD | |
272 | * | |
273 | * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"): | |
274 | * 2-0: 0) 6 Mbps | |
275 | * 1) 12 Mbps | |
276 | * 2) 18 Mbps | |
277 | * 3) 24 Mbps | |
278 | * 4) 36 Mbps | |
279 | * 5) 48 Mbps | |
280 | * 6) 54 Mbps | |
281 | * 7) 60 Mbps | |
282 | * | |
5c5aa3f1 | 283 | * 4-3: 0) Single stream (SISO) |
abceddb4 | 284 | * 1) Dual stream (MIMO) |
5c5aa3f1 | 285 | * 2) Triple stream (MIMO) |
abceddb4 | 286 | * |
7aafef1c | 287 | * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data |
abceddb4 BC |
288 | * |
289 | * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"): | |
290 | * 3-0: 0xD) 6 Mbps | |
291 | * 0xF) 9 Mbps | |
292 | * 0x5) 12 Mbps | |
293 | * 0x7) 18 Mbps | |
294 | * 0x9) 24 Mbps | |
295 | * 0xB) 36 Mbps | |
296 | * 0x1) 48 Mbps | |
297 | * 0x3) 54 Mbps | |
298 | * | |
299 | * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"): | |
10617879 | 300 | * 6-0: 10) 1 Mbps |
abceddb4 BC |
301 | * 20) 2 Mbps |
302 | * 55) 5.5 Mbps | |
303 | * 110) 11 Mbps | |
304 | */ | |
305 | #define RATE_MCS_CODE_MSK 0x7 | |
5c5aa3f1 HD |
306 | #define RATE_MCS_SPATIAL_POS 3 |
307 | #define RATE_MCS_SPATIAL_MSK 0x18 | |
abceddb4 BC |
308 | #define RATE_MCS_HT_DUP_POS 5 |
309 | #define RATE_MCS_HT_DUP_MSK 0x20 | |
310 | ||
075416cd | 311 | /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */ |
abceddb4 BC |
312 | #define RATE_MCS_FLAGS_POS 8 |
313 | #define RATE_MCS_HT_POS 8 | |
314 | #define RATE_MCS_HT_MSK 0x100 | |
315 | ||
075416cd | 316 | /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ |
abceddb4 BC |
317 | #define RATE_MCS_CCK_POS 9 |
318 | #define RATE_MCS_CCK_MSK 0x200 | |
319 | ||
075416cd | 320 | /* Bit 10: (1) Use Green Field preamble */ |
abceddb4 BC |
321 | #define RATE_MCS_GF_POS 10 |
322 | #define RATE_MCS_GF_MSK 0x400 | |
323 | ||
7aafef1c WYG |
324 | /* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */ |
325 | #define RATE_MCS_HT40_POS 11 | |
326 | #define RATE_MCS_HT40_MSK 0x800 | |
abceddb4 | 327 | |
7aafef1c | 328 | /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */ |
abceddb4 BC |
329 | #define RATE_MCS_DUP_POS 12 |
330 | #define RATE_MCS_DUP_MSK 0x1000 | |
331 | ||
075416cd | 332 | /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ |
abceddb4 BC |
333 | #define RATE_MCS_SGI_POS 13 |
334 | #define RATE_MCS_SGI_MSK 0x2000 | |
335 | ||
336 | /** | |
76eff18b TW |
337 | * rate_n_flags Tx antenna masks |
338 | * 4965 has 2 transmitters | |
339 | * 5100 has 1 transmitter B | |
340 | * 5150 has 1 transmitter A | |
341 | * 5300 has 3 transmitters | |
342 | * 5350 has 3 transmitters | |
343 | * bit14:16 | |
abceddb4 | 344 | */ |
600c0e11 TW |
345 | #define RATE_MCS_ANT_POS 14 |
346 | #define RATE_MCS_ANT_A_MSK 0x04000 | |
347 | #define RATE_MCS_ANT_B_MSK 0x08000 | |
348 | #define RATE_MCS_ANT_C_MSK 0x10000 | |
349 | #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK) | |
350 | #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK) | |
76eff18b | 351 | #define RATE_ANT_NUM 3 |
80cc0c38 BC |
352 | |
353 | #define POWER_TABLE_NUM_ENTRIES 33 | |
354 | #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32 | |
355 | #define POWER_TABLE_CCK_ENTRY 32 | |
356 | ||
e57f1489 WYG |
357 | #define IWL_PWR_NUM_HT_OFDM_ENTRIES 24 |
358 | #define IWL_PWR_CCK_ENTRIES 2 | |
359 | ||
80cc0c38 BC |
360 | /** |
361 | * union iwl4965_tx_power_dual_stream | |
362 | * | |
363 | * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
364 | * Use __le32 version (struct tx_power_dual_stream) when building command. | |
365 | * | |
366 | * Driver provides radio gain and DSP attenuation settings to device in pairs, | |
367 | * one value for each transmitter chain. The first value is for transmitter A, | |
368 | * second for transmitter B. | |
369 | * | |
370 | * For SISO bit rates, both values in a pair should be identical. | |
371 | * For MIMO rates, one value may be different from the other, | |
372 | * in order to balance the Tx output between the two transmitters. | |
373 | * | |
374 | * See more details in doc for TXPOWER in iwl-4965-hw.h. | |
375 | */ | |
376 | union iwl4965_tx_power_dual_stream { | |
377 | struct { | |
378 | u8 radio_tx_gain[2]; | |
379 | u8 dsp_predis_atten[2]; | |
380 | } s; | |
381 | u32 dw; | |
382 | }; | |
383 | ||
384 | /** | |
385 | * struct tx_power_dual_stream | |
386 | * | |
387 | * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
388 | * | |
389 | * Same format as iwl_tx_power_dual_stream, but __le32 | |
390 | */ | |
391 | struct tx_power_dual_stream { | |
392 | __le32 dw; | |
393 | } __attribute__ ((packed)); | |
394 | ||
395 | /** | |
396 | * struct iwl4965_tx_power_db | |
397 | * | |
398 | * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
399 | */ | |
400 | struct iwl4965_tx_power_db { | |
401 | struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES]; | |
402 | } __attribute__ ((packed)); | |
403 | ||
630fe9b6 | 404 | /** |
a96a27f9 | 405 | * Command REPLY_TX_POWER_DBM_CMD = 0x98 |
630fe9b6 TW |
406 | * struct iwl5000_tx_power_dbm_cmd |
407 | */ | |
408 | #define IWL50_TX_POWER_AUTO 0x7f | |
853554ac GG |
409 | #define IWL50_TX_POWER_NO_CLOSED (0x1 << 6) |
410 | ||
630fe9b6 TW |
411 | struct iwl5000_tx_power_dbm_cmd { |
412 | s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */ | |
413 | u8 flags; | |
414 | s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */ | |
415 | u8 reserved; | |
416 | } __attribute__ ((packed)); | |
80cc0c38 | 417 | |
2f748dec WYG |
418 | /** |
419 | * Command TX_ANT_CONFIGURATION_CMD = 0x98 | |
420 | * This command is used to configure valid Tx antenna. | |
421 | * By default uCode concludes the valid antenna according to the radio flavor. | |
422 | * This command enables the driver to override/modify this conclusion. | |
423 | */ | |
424 | struct iwl_tx_ant_config_cmd { | |
425 | __le32 valid; | |
426 | } __attribute__ ((packed)); | |
427 | ||
b481de9c ZY |
428 | /****************************************************************************** |
429 | * (0a) | |
430 | * Alive and Error Commands & Responses: | |
431 | * | |
432 | *****************************************************************************/ | |
433 | ||
51e9bf5d | 434 | #define UCODE_VALID_OK cpu_to_le32(0x1) |
b481de9c ZY |
435 | #define INITIALIZE_SUBTYPE (9) |
436 | ||
437 | /* | |
075416cd BC |
438 | * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command) |
439 | * | |
440 | * uCode issues this "initialize alive" notification once the initialization | |
441 | * uCode image has completed its work, and is ready to load the runtime image. | |
442 | * This is the *first* "alive" notification that the driver will receive after | |
443 | * rebooting uCode; the "initialize" alive is indicated by subtype field == 9. | |
444 | * | |
445 | * See comments documenting "BSM" (bootstrap state machine). | |
446 | * | |
447 | * For 4965, this notification contains important calibration data for | |
448 | * calculating txpower settings: | |
449 | * | |
450 | * 1) Power supply voltage indication. The voltage sensor outputs higher | |
a96a27f9 | 451 | * values for lower voltage, and vice verse. |
075416cd BC |
452 | * |
453 | * 2) Temperature measurement parameters, for each of two channel widths | |
454 | * (20 MHz and 40 MHz) supported by the radios. Temperature sensing | |
455 | * is done via one of the receiver chains, and channel width influences | |
456 | * the results. | |
457 | * | |
458 | * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation, | |
459 | * for each of 5 frequency ranges. | |
b481de9c | 460 | */ |
885ba202 | 461 | struct iwl_init_alive_resp { |
b481de9c ZY |
462 | u8 ucode_minor; |
463 | u8 ucode_major; | |
464 | __le16 reserved1; | |
465 | u8 sw_rev[8]; | |
466 | u8 ver_type; | |
075416cd | 467 | u8 ver_subtype; /* "9" for initialize alive */ |
b481de9c ZY |
468 | __le16 reserved2; |
469 | __le32 log_event_table_ptr; | |
470 | __le32 error_event_table_ptr; | |
471 | __le32 timestamp; | |
472 | __le32 is_valid; | |
075416cd BC |
473 | |
474 | /* calibration values from "initialize" uCode */ | |
475 | __le32 voltage; /* signed, higher value is lower voltage */ | |
7aafef1c | 476 | __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */ |
075416cd BC |
477 | __le32 therm_r2[2]; /* signed */ |
478 | __le32 therm_r3[2]; /* signed */ | |
479 | __le32 therm_r4[2]; /* signed */ | |
480 | __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups, | |
481 | * 2 Tx chains */ | |
b481de9c ZY |
482 | } __attribute__ ((packed)); |
483 | ||
075416cd BC |
484 | |
485 | /** | |
486 | * REPLY_ALIVE = 0x1 (response only, not a command) | |
487 | * | |
488 | * uCode issues this "alive" notification once the runtime image is ready | |
489 | * to receive commands from the driver. This is the *second* "alive" | |
490 | * notification that the driver will receive after rebooting uCode; | |
491 | * this "alive" is indicated by subtype field != 9. | |
492 | * | |
493 | * See comments documenting "BSM" (bootstrap state machine). | |
494 | * | |
495 | * This response includes two pointers to structures within the device's | |
496 | * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging: | |
497 | * | |
498 | * 1) log_event_table_ptr indicates base of the event log. This traces | |
499 | * a 256-entry history of uCode execution within a circular buffer. | |
500 | * Its header format is: | |
501 | * | |
502 | * __le32 log_size; log capacity (in number of entries) | |
503 | * __le32 type; (1) timestamp with each entry, (0) no timestamp | |
504 | * __le32 wraps; # times uCode has wrapped to top of circular buffer | |
505 | * __le32 write_index; next circular buffer entry that uCode would fill | |
506 | * | |
507 | * The header is followed by the circular buffer of log entries. Entries | |
508 | * with timestamps have the following format: | |
509 | * | |
510 | * __le32 event_id; range 0 - 1500 | |
511 | * __le32 timestamp; low 32 bits of TSF (of network, if associated) | |
512 | * __le32 data; event_id-specific data value | |
513 | * | |
514 | * Entries without timestamps contain only event_id and data. | |
515 | * | |
516 | * 2) error_event_table_ptr indicates base of the error log. This contains | |
517 | * information about any uCode error that occurs. For 4965, the format | |
518 | * of the error log is: | |
519 | * | |
520 | * __le32 valid; (nonzero) valid, (0) log is empty | |
521 | * __le32 error_id; type of error | |
522 | * __le32 pc; program counter | |
523 | * __le32 blink1; branch link | |
524 | * __le32 blink2; branch link | |
525 | * __le32 ilink1; interrupt link | |
526 | * __le32 ilink2; interrupt link | |
527 | * __le32 data1; error-specific data | |
528 | * __le32 data2; error-specific data | |
529 | * __le32 line; source code line of error | |
530 | * __le32 bcon_time; beacon timer | |
531 | * __le32 tsf_low; network timestamp function timer | |
532 | * __le32 tsf_hi; network timestamp function timer | |
533 | * | |
534 | * The Linux driver can print both logs to the system log when a uCode error | |
535 | * occurs. | |
536 | */ | |
885ba202 | 537 | struct iwl_alive_resp { |
b481de9c ZY |
538 | u8 ucode_minor; |
539 | u8 ucode_major; | |
540 | __le16 reserved1; | |
541 | u8 sw_rev[8]; | |
542 | u8 ver_type; | |
075416cd | 543 | u8 ver_subtype; /* not "9" for runtime alive */ |
b481de9c | 544 | __le16 reserved2; |
075416cd BC |
545 | __le32 log_event_table_ptr; /* SRAM address for event log */ |
546 | __le32 error_event_table_ptr; /* SRAM address for error log */ | |
b481de9c ZY |
547 | __le32 timestamp; |
548 | __le32 is_valid; | |
b481de9c ZY |
549 | } __attribute__ ((packed)); |
550 | ||
b481de9c ZY |
551 | /* |
552 | * REPLY_ERROR = 0x2 (response only, not a command) | |
553 | */ | |
885ba202 | 554 | struct iwl_error_resp { |
b481de9c ZY |
555 | __le32 error_type; |
556 | u8 cmd_id; | |
557 | u8 reserved1; | |
558 | __le16 bad_cmd_seq_num; | |
b481de9c | 559 | __le32 error_info; |
3195c1f3 | 560 | __le64 timestamp; |
b481de9c ZY |
561 | } __attribute__ ((packed)); |
562 | ||
563 | /****************************************************************************** | |
564 | * (1) | |
565 | * RXON Commands & Responses: | |
566 | * | |
567 | *****************************************************************************/ | |
568 | ||
569 | /* | |
570 | * Rx config defines & structure | |
571 | */ | |
572 | /* rx_config device types */ | |
573 | enum { | |
574 | RXON_DEV_TYPE_AP = 1, | |
575 | RXON_DEV_TYPE_ESS = 3, | |
576 | RXON_DEV_TYPE_IBSS = 4, | |
577 | RXON_DEV_TYPE_SNIFFER = 6, | |
578 | }; | |
579 | ||
14519a0b | 580 | |
51e9bf5d | 581 | #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0) |
7b841727 | 582 | #define RXON_RX_CHAIN_DRIVER_FORCE_POS (0) |
51e9bf5d | 583 | #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1) |
14519a0b | 584 | #define RXON_RX_CHAIN_VALID_POS (1) |
51e9bf5d | 585 | #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4) |
14519a0b | 586 | #define RXON_RX_CHAIN_FORCE_SEL_POS (4) |
51e9bf5d | 587 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7) |
14519a0b | 588 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7) |
51e9bf5d | 589 | #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10) |
14519a0b | 590 | #define RXON_RX_CHAIN_CNT_POS (10) |
51e9bf5d | 591 | #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12) |
14519a0b | 592 | #define RXON_RX_CHAIN_MIMO_CNT_POS (12) |
51e9bf5d | 593 | #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14) |
14519a0b BC |
594 | #define RXON_RX_CHAIN_MIMO_FORCE_POS (14) |
595 | ||
b481de9c ZY |
596 | /* rx_config flags */ |
597 | /* band & modulation selection */ | |
51e9bf5d HH |
598 | #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0) |
599 | #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1) | |
b481de9c | 600 | /* auto detection enable */ |
51e9bf5d | 601 | #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2) |
b481de9c | 602 | /* TGg protection when tx */ |
51e9bf5d | 603 | #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3) |
b481de9c | 604 | /* cck short slot & preamble */ |
51e9bf5d HH |
605 | #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4) |
606 | #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5) | |
b481de9c | 607 | /* antenna selection */ |
51e9bf5d HH |
608 | #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7) |
609 | #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00) | |
610 | #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8) | |
611 | #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9) | |
b481de9c | 612 | /* radar detection enable */ |
51e9bf5d HH |
613 | #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12) |
614 | #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13) | |
b481de9c ZY |
615 | /* rx response to host with 8-byte TSF |
616 | * (according to ON_AIR deassertion) */ | |
51e9bf5d | 617 | #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15) |
b481de9c | 618 | |
14519a0b BC |
619 | |
620 | /* HT flags */ | |
621 | #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22) | |
51e9bf5d | 622 | #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22) |
14519a0b BC |
623 | |
624 | #define RXON_FLG_HT_OPERATING_MODE_POS (23) | |
625 | ||
51e9bf5d | 626 | #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23) |
7aafef1c | 627 | #define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23) |
14519a0b BC |
628 | |
629 | #define RXON_FLG_CHANNEL_MODE_POS (25) | |
51e9bf5d | 630 | #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25) |
a2b0f02e WYG |
631 | |
632 | /* channel mode */ | |
633 | enum { | |
634 | CHANNEL_MODE_LEGACY = 0, | |
635 | CHANNEL_MODE_PURE_40 = 1, | |
636 | CHANNEL_MODE_MIXED = 2, | |
637 | CHANNEL_MODE_RESERVED = 3, | |
638 | }; | |
639 | #define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS) | |
640 | #define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS) | |
641 | #define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS) | |
642 | ||
a326a5d0 | 643 | /* CTS to self (if spec allows) flag */ |
51e9bf5d | 644 | #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30) |
14519a0b | 645 | |
b481de9c ZY |
646 | /* rx_config filter flags */ |
647 | /* accept all data frames */ | |
51e9bf5d | 648 | #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0) |
b481de9c | 649 | /* pass control & management to host */ |
51e9bf5d | 650 | #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1) |
b481de9c | 651 | /* accept multi-cast */ |
51e9bf5d | 652 | #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2) |
b481de9c | 653 | /* don't decrypt uni-cast frames */ |
51e9bf5d | 654 | #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3) |
b481de9c | 655 | /* don't decrypt multi-cast frames */ |
51e9bf5d | 656 | #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4) |
b481de9c | 657 | /* STA is associated */ |
51e9bf5d | 658 | #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5) |
b481de9c | 659 | /* transfer to host non bssid beacons in associated state */ |
51e9bf5d | 660 | #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6) |
b481de9c | 661 | |
80cc0c38 | 662 | /** |
b481de9c | 663 | * REPLY_RXON = 0x10 (command, has simple generic response) |
80cc0c38 BC |
664 | * |
665 | * RXON tunes the radio tuner to a service channel, and sets up a number | |
666 | * of parameters that are used primarily for Rx, but also for Tx operations. | |
667 | * | |
668 | * NOTE: When tuning to a new channel, driver must set the | |
669 | * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent | |
670 | * info within the device, including the station tables, tx retry | |
671 | * rate tables, and txpower tables. Driver must build a new station | |
672 | * table and txpower table before transmitting anything on the RXON | |
673 | * channel. | |
674 | * | |
675 | * NOTE: All RXONs wipe clean the internal txpower table. Driver must | |
676 | * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10), | |
677 | * regardless of whether RXON_FILTER_ASSOC_MSK is set. | |
b481de9c | 678 | */ |
3d24a9f7 TW |
679 | |
680 | struct iwl3945_rxon_cmd { | |
681 | u8 node_addr[6]; | |
682 | __le16 reserved1; | |
683 | u8 bssid_addr[6]; | |
684 | __le16 reserved2; | |
685 | u8 wlap_bssid_addr[6]; | |
686 | __le16 reserved3; | |
687 | u8 dev_type; | |
688 | u8 air_propagation; | |
689 | __le16 reserved4; | |
690 | u8 ofdm_basic_rates; | |
691 | u8 cck_basic_rates; | |
692 | __le16 assoc_id; | |
693 | __le32 flags; | |
694 | __le32 filter_flags; | |
695 | __le16 channel; | |
696 | __le16 reserved5; | |
697 | } __attribute__ ((packed)); | |
698 | ||
bb8c093b | 699 | struct iwl4965_rxon_cmd { |
b481de9c ZY |
700 | u8 node_addr[6]; |
701 | __le16 reserved1; | |
702 | u8 bssid_addr[6]; | |
703 | __le16 reserved2; | |
704 | u8 wlap_bssid_addr[6]; | |
705 | __le16 reserved3; | |
706 | u8 dev_type; | |
707 | u8 air_propagation; | |
b481de9c | 708 | __le16 rx_chain; |
b481de9c ZY |
709 | u8 ofdm_basic_rates; |
710 | u8 cck_basic_rates; | |
711 | __le16 assoc_id; | |
712 | __le32 flags; | |
713 | __le32 filter_flags; | |
714 | __le16 channel; | |
b481de9c ZY |
715 | u8 ofdm_ht_single_stream_basic_rates; |
716 | u8 ofdm_ht_dual_stream_basic_rates; | |
b481de9c ZY |
717 | } __attribute__ ((packed)); |
718 | ||
a96a27f9 | 719 | /* 5000 HW just extend this command */ |
c1adf9fb GG |
720 | struct iwl_rxon_cmd { |
721 | u8 node_addr[6]; | |
722 | __le16 reserved1; | |
723 | u8 bssid_addr[6]; | |
724 | __le16 reserved2; | |
725 | u8 wlap_bssid_addr[6]; | |
726 | __le16 reserved3; | |
727 | u8 dev_type; | |
728 | u8 air_propagation; | |
729 | __le16 rx_chain; | |
730 | u8 ofdm_basic_rates; | |
731 | u8 cck_basic_rates; | |
732 | __le16 assoc_id; | |
733 | __le32 flags; | |
734 | __le32 filter_flags; | |
735 | __le16 channel; | |
736 | u8 ofdm_ht_single_stream_basic_rates; | |
737 | u8 ofdm_ht_dual_stream_basic_rates; | |
738 | u8 ofdm_ht_triple_stream_basic_rates; | |
739 | u8 reserved5; | |
740 | __le16 acquisition_data; | |
741 | __le16 reserved6; | |
742 | } __attribute__ ((packed)); | |
743 | ||
3d24a9f7 TW |
744 | /* |
745 | * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response) | |
746 | */ | |
747 | struct iwl3945_rxon_assoc_cmd { | |
748 | __le32 flags; | |
749 | __le32 filter_flags; | |
750 | u8 ofdm_basic_rates; | |
751 | u8 cck_basic_rates; | |
752 | __le16 reserved; | |
753 | } __attribute__ ((packed)); | |
754 | ||
755 | struct iwl4965_rxon_assoc_cmd { | |
fe7a90c2 RR |
756 | __le32 flags; |
757 | __le32 filter_flags; | |
758 | u8 ofdm_basic_rates; | |
759 | u8 cck_basic_rates; | |
fe7a90c2 RR |
760 | u8 ofdm_ht_single_stream_basic_rates; |
761 | u8 ofdm_ht_dual_stream_basic_rates; | |
fe7a90c2 | 762 | __le16 rx_chain_select_flags; |
3d24a9f7 | 763 | __le16 reserved; |
fe7a90c2 | 764 | } __attribute__ ((packed)); |
c1adf9fb | 765 | |
3d24a9f7 | 766 | struct iwl5000_rxon_assoc_cmd { |
b481de9c ZY |
767 | __le32 flags; |
768 | __le32 filter_flags; | |
769 | u8 ofdm_basic_rates; | |
770 | u8 cck_basic_rates; | |
3d24a9f7 | 771 | __le16 reserved1; |
b481de9c ZY |
772 | u8 ofdm_ht_single_stream_basic_rates; |
773 | u8 ofdm_ht_dual_stream_basic_rates; | |
3d24a9f7 TW |
774 | u8 ofdm_ht_triple_stream_basic_rates; |
775 | u8 reserved2; | |
b481de9c | 776 | __le16 rx_chain_select_flags; |
3d24a9f7 TW |
777 | __le16 acquisition_data; |
778 | __le32 reserved3; | |
b481de9c ZY |
779 | } __attribute__ ((packed)); |
780 | ||
b5d7be5e | 781 | #define IWL_CONN_MAX_LISTEN_INTERVAL 10 |
2c2f3b33 TW |
782 | #define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */ |
783 | #define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */ | |
fe7a90c2 | 784 | |
b481de9c ZY |
785 | /* |
786 | * REPLY_RXON_TIMING = 0x14 (command, has simple generic response) | |
787 | */ | |
3195c1f3 TW |
788 | struct iwl_rxon_time_cmd { |
789 | __le64 timestamp; | |
b481de9c ZY |
790 | __le16 beacon_interval; |
791 | __le16 atim_window; | |
792 | __le32 beacon_init_val; | |
793 | __le16 listen_interval; | |
794 | __le16 reserved; | |
795 | } __attribute__ ((packed)); | |
796 | ||
b481de9c ZY |
797 | /* |
798 | * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response) | |
799 | */ | |
3d24a9f7 TW |
800 | struct iwl3945_channel_switch_cmd { |
801 | u8 band; | |
802 | u8 expect_beacon; | |
803 | __le16 channel; | |
804 | __le32 rxon_flags; | |
805 | __le32 rxon_filter_flags; | |
806 | __le32 switch_time; | |
807 | struct iwl3945_power_per_rate power[IWL_MAX_RATES]; | |
808 | } __attribute__ ((packed)); | |
809 | ||
e57f1489 | 810 | struct iwl4965_channel_switch_cmd { |
b481de9c ZY |
811 | u8 band; |
812 | u8 expect_beacon; | |
813 | __le16 channel; | |
814 | __le32 rxon_flags; | |
815 | __le32 rxon_filter_flags; | |
816 | __le32 switch_time; | |
bb8c093b | 817 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
818 | } __attribute__ ((packed)); |
819 | ||
e57f1489 WYG |
820 | /** |
821 | * struct iwl5000_channel_switch_cmd | |
822 | * @band: 0- 5.2GHz, 1- 2.4GHz | |
823 | * @expect_beacon: 0- resume transmits after channel switch | |
824 | * 1- wait for beacon to resume transmits | |
825 | * @channel: new channel number | |
826 | * @rxon_flags: Rx on flags | |
827 | * @rxon_filter_flags: filtering parameters | |
828 | * @switch_time: switch time in extended beacon format | |
829 | * @reserved: reserved bytes | |
830 | */ | |
831 | struct iwl5000_channel_switch_cmd { | |
832 | u8 band; | |
833 | u8 expect_beacon; | |
834 | __le16 channel; | |
835 | __le32 rxon_flags; | |
836 | __le32 rxon_filter_flags; | |
837 | __le32 switch_time; | |
838 | __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES]; | |
839 | } __attribute__ ((packed)); | |
840 | ||
841 | /** | |
842 | * struct iwl6000_channel_switch_cmd | |
843 | * @band: 0- 5.2GHz, 1- 2.4GHz | |
844 | * @expect_beacon: 0- resume transmits after channel switch | |
845 | * 1- wait for beacon to resume transmits | |
846 | * @channel: new channel number | |
847 | * @rxon_flags: Rx on flags | |
848 | * @rxon_filter_flags: filtering parameters | |
849 | * @switch_time: switch time in extended beacon format | |
850 | * @reserved: reserved bytes | |
851 | */ | |
852 | struct iwl6000_channel_switch_cmd { | |
853 | u8 band; | |
854 | u8 expect_beacon; | |
855 | __le16 channel; | |
856 | __le32 rxon_flags; | |
857 | __le32 rxon_filter_flags; | |
858 | __le32 switch_time; | |
859 | __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES]; | |
860 | } __attribute__ ((packed)); | |
861 | ||
b481de9c ZY |
862 | /* |
863 | * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command) | |
864 | */ | |
2aa6ab86 | 865 | struct iwl_csa_notification { |
b481de9c ZY |
866 | __le16 band; |
867 | __le16 channel; | |
868 | __le32 status; /* 0 - OK, 1 - fail */ | |
869 | } __attribute__ ((packed)); | |
870 | ||
871 | /****************************************************************************** | |
872 | * (2) | |
873 | * Quality-of-Service (QOS) Commands & Responses: | |
874 | * | |
875 | *****************************************************************************/ | |
2054a00b BC |
876 | |
877 | /** | |
878 | * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM | |
879 | * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd | |
880 | * | |
881 | * @cw_min: Contention window, start value in numbers of slots. | |
882 | * Should be a power-of-2, minus 1. Device's default is 0x0f. | |
883 | * @cw_max: Contention window, max value in numbers of slots. | |
884 | * Should be a power-of-2, minus 1. Device's default is 0x3f. | |
885 | * @aifsn: Number of slots in Arbitration Interframe Space (before | |
886 | * performing random backoff timing prior to Tx). Device default 1. | |
887 | * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0. | |
888 | * | |
889 | * Device will automatically increase contention window by (2*CW) + 1 for each | |
890 | * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW | |
891 | * value, to cap the CW value. | |
892 | */ | |
1ff50bda | 893 | struct iwl_ac_qos { |
b481de9c ZY |
894 | __le16 cw_min; |
895 | __le16 cw_max; | |
896 | u8 aifsn; | |
897 | u8 reserved1; | |
898 | __le16 edca_txop; | |
899 | } __attribute__ ((packed)); | |
900 | ||
901 | /* QoS flags defines */ | |
51e9bf5d HH |
902 | #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01) |
903 | #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02) | |
904 | #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10) | |
b481de9c | 905 | |
2054a00b | 906 | /* Number of Access Categories (AC) (EDCA), queues 0..3 */ |
b481de9c ZY |
907 | #define AC_NUM 4 |
908 | ||
909 | /* | |
910 | * REPLY_QOS_PARAM = 0x13 (command, has simple generic response) | |
2054a00b BC |
911 | * |
912 | * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs | |
913 | * 0: Background, 1: Best Effort, 2: Video, 3: Voice. | |
b481de9c | 914 | */ |
1ff50bda | 915 | struct iwl_qosparam_cmd { |
b481de9c | 916 | __le32 qos_flags; |
1ff50bda | 917 | struct iwl_ac_qos ac[AC_NUM]; |
b481de9c ZY |
918 | } __attribute__ ((packed)); |
919 | ||
920 | /****************************************************************************** | |
921 | * (3) | |
922 | * Add/Modify Stations Commands & Responses: | |
923 | * | |
924 | *****************************************************************************/ | |
925 | /* | |
926 | * Multi station support | |
927 | */ | |
2054a00b BC |
928 | |
929 | /* Special, dedicated locations within device's station table */ | |
b481de9c ZY |
930 | #define IWL_AP_ID 0 |
931 | #define IWL_MULTICAST_ID 1 | |
932 | #define IWL_STA_ID 2 | |
4c897253 TW |
933 | #define IWL3945_BROADCAST_ID 24 |
934 | #define IWL3945_STATION_COUNT 25 | |
b481de9c ZY |
935 | #define IWL4965_BROADCAST_ID 31 |
936 | #define IWL4965_STATION_COUNT 32 | |
fdd3e8a4 TW |
937 | #define IWL5000_BROADCAST_ID 15 |
938 | #define IWL5000_STATION_COUNT 16 | |
b481de9c ZY |
939 | |
940 | #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/ | |
941 | #define IWL_INVALID_STATION 255 | |
942 | ||
4c897253 TW |
943 | #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2); |
944 | #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8); | |
51e9bf5d HH |
945 | #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17) |
946 | #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18) | |
74093ddf | 947 | #define STA_FLG_MAX_AGG_SIZE_POS (19) |
51e9bf5d | 948 | #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19) |
7aafef1c | 949 | #define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21) |
51e9bf5d | 950 | #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22) |
74093ddf | 951 | #define STA_FLG_AGG_MPDU_DENSITY_POS (23) |
51e9bf5d | 952 | #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23) |
b481de9c | 953 | |
2054a00b | 954 | /* Use in mode field. 1: modify existing entry, 0: add new station entry */ |
b481de9c ZY |
955 | #define STA_CONTROL_MODIFY_MSK 0x01 |
956 | ||
957 | /* key flags __le16*/ | |
51e9bf5d HH |
958 | #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007) |
959 | #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000) | |
960 | #define STA_KEY_FLG_WEP cpu_to_le16(0x0001) | |
961 | #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002) | |
962 | #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003) | |
b481de9c ZY |
963 | |
964 | #define STA_KEY_FLG_KEYID_POS 8 | |
51e9bf5d | 965 | #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800) |
eaaf7894 | 966 | /* wep key is either from global key (0) or from station info array (1) */ |
51e9bf5d | 967 | #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008) |
eaaf7894 EG |
968 | |
969 | /* wep key in STA: 5-bytes (0) or 13-bytes (1) */ | |
51e9bf5d HH |
970 | #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000) |
971 | #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000) | |
deb09c43 | 972 | #define STA_KEY_MAX_NUM 8 |
b481de9c | 973 | |
2054a00b | 974 | /* Flags indicate whether to modify vs. don't change various station params */ |
b481de9c ZY |
975 | #define STA_MODIFY_KEY_MASK 0x01 |
976 | #define STA_MODIFY_TID_DISABLE_TX 0x02 | |
977 | #define STA_MODIFY_TX_RATE_MSK 0x04 | |
978 | #define STA_MODIFY_ADDBA_TID_MSK 0x08 | |
979 | #define STA_MODIFY_DELBA_TID_MSK 0x10 | |
2054a00b BC |
980 | |
981 | /* Receiver address (actually, Rx station's index into station table), | |
982 | * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */ | |
b481de9c ZY |
983 | #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid)) |
984 | ||
bb8c093b | 985 | struct iwl4965_keyinfo { |
b481de9c ZY |
986 | __le16 key_flags; |
987 | u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */ | |
988 | u8 reserved1; | |
989 | __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */ | |
eaaf7894 EG |
990 | u8 key_offset; |
991 | u8 reserved2; | |
b481de9c ZY |
992 | u8 key[16]; /* 16-byte unicast decryption key */ |
993 | } __attribute__ ((packed)); | |
994 | ||
133636de TW |
995 | /* 5000 */ |
996 | struct iwl_keyinfo { | |
997 | __le16 key_flags; | |
998 | u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */ | |
999 | u8 reserved1; | |
1000 | __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */ | |
1001 | u8 key_offset; | |
1002 | u8 reserved2; | |
1003 | u8 key[16]; /* 16-byte unicast decryption key */ | |
1004 | __le64 tx_secur_seq_cnt; | |
1005 | __le64 hw_tkip_mic_rx_key; | |
1006 | __le64 hw_tkip_mic_tx_key; | |
1007 | } __attribute__ ((packed)); | |
1008 | ||
2054a00b BC |
1009 | /** |
1010 | * struct sta_id_modify | |
1011 | * @addr[ETH_ALEN]: station's MAC address | |
1012 | * @sta_id: index of station in uCode's station table | |
1013 | * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change | |
1014 | * | |
1015 | * Driver selects unused table index when adding new station, | |
1016 | * or the index to a pre-existing station entry when modifying that station. | |
1017 | * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP). | |
1018 | * | |
1019 | * modify_mask flags select which parameters to modify vs. leave alone. | |
1020 | */ | |
b481de9c ZY |
1021 | struct sta_id_modify { |
1022 | u8 addr[ETH_ALEN]; | |
1023 | __le16 reserved1; | |
1024 | u8 sta_id; | |
1025 | u8 modify_mask; | |
1026 | __le16 reserved2; | |
1027 | } __attribute__ ((packed)); | |
1028 | ||
1029 | /* | |
1030 | * REPLY_ADD_STA = 0x18 (command) | |
2054a00b BC |
1031 | * |
1032 | * The device contains an internal table of per-station information, | |
1033 | * with info on security keys, aggregation parameters, and Tx rates for | |
1034 | * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD, | |
1035 | * 3945 uses REPLY_RATE_SCALE to set up rate tables). | |
1036 | * | |
1037 | * REPLY_ADD_STA sets up the table entry for one station, either creating | |
1038 | * a new entry, or modifying a pre-existing one. | |
1039 | * | |
1040 | * NOTE: RXON command (without "associated" bit set) wipes the station table | |
1041 | * clean. Moving into RF_KILL state does this also. Driver must set up | |
1042 | * new station table before transmitting anything on the RXON channel | |
1043 | * (except active scans or active measurements; those commands carry | |
1044 | * their own txpower/rate setup data). | |
1045 | * | |
1046 | * When getting started on a new channel, driver must set up the | |
1047 | * IWL_BROADCAST_ID entry (last entry in the table). For a client | |
1048 | * station in a BSS, once an AP is selected, driver sets up the AP STA | |
1049 | * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP | |
1050 | * are all that are needed for a BSS client station. If the device is | |
1051 | * used as AP, or in an IBSS network, driver must set up station table | |
1052 | * entries for all STAs in network, starting with index IWL_STA_ID. | |
b481de9c | 1053 | */ |
3d24a9f7 TW |
1054 | |
1055 | struct iwl3945_addsta_cmd { | |
1056 | u8 mode; /* 1: modify existing, 0: add new station */ | |
1057 | u8 reserved[3]; | |
1058 | struct sta_id_modify sta; | |
1059 | struct iwl4965_keyinfo key; | |
1060 | __le32 station_flags; /* STA_FLG_* */ | |
1061 | __le32 station_flags_msk; /* STA_FLG_* */ | |
1062 | ||
1063 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) | |
1064 | * corresponding to bit (e.g. bit 5 controls TID 5). | |
1065 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ | |
1066 | __le16 tid_disable_tx; | |
1067 | ||
1068 | __le16 rate_n_flags; | |
1069 | ||
1070 | /* TID for which to add block-ack support. | |
1071 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
1072 | u8 add_immediate_ba_tid; | |
1073 | ||
1074 | /* TID for which to remove block-ack support. | |
1075 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ | |
1076 | u8 remove_immediate_ba_tid; | |
1077 | ||
1078 | /* Starting Sequence Number for added block-ack support. | |
1079 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
1080 | __le16 add_immediate_ba_ssn; | |
1081 | } __attribute__ ((packed)); | |
1082 | ||
bb8c093b | 1083 | struct iwl4965_addsta_cmd { |
2054a00b | 1084 | u8 mode; /* 1: modify existing, 0: add new station */ |
b481de9c ZY |
1085 | u8 reserved[3]; |
1086 | struct sta_id_modify sta; | |
bb8c093b | 1087 | struct iwl4965_keyinfo key; |
2054a00b BC |
1088 | __le32 station_flags; /* STA_FLG_* */ |
1089 | __le32 station_flags_msk; /* STA_FLG_* */ | |
1090 | ||
1091 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) | |
1092 | * corresponding to bit (e.g. bit 5 controls TID 5). | |
1093 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ | |
b481de9c | 1094 | __le16 tid_disable_tx; |
2054a00b | 1095 | |
b481de9c | 1096 | __le16 reserved1; |
2054a00b BC |
1097 | |
1098 | /* TID for which to add block-ack support. | |
1099 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
b481de9c | 1100 | u8 add_immediate_ba_tid; |
2054a00b BC |
1101 | |
1102 | /* TID for which to remove block-ack support. | |
1103 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ | |
b481de9c | 1104 | u8 remove_immediate_ba_tid; |
2054a00b BC |
1105 | |
1106 | /* Starting Sequence Number for added block-ack support. | |
1107 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
b481de9c | 1108 | __le16 add_immediate_ba_ssn; |
2054a00b | 1109 | |
b481de9c | 1110 | __le32 reserved2; |
b481de9c ZY |
1111 | } __attribute__ ((packed)); |
1112 | ||
133636de TW |
1113 | /* 5000 */ |
1114 | struct iwl_addsta_cmd { | |
1115 | u8 mode; /* 1: modify existing, 0: add new station */ | |
1116 | u8 reserved[3]; | |
1117 | struct sta_id_modify sta; | |
1118 | struct iwl_keyinfo key; | |
1119 | __le32 station_flags; /* STA_FLG_* */ | |
1120 | __le32 station_flags_msk; /* STA_FLG_* */ | |
1121 | ||
1122 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) | |
1123 | * corresponding to bit (e.g. bit 5 controls TID 5). | |
1124 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ | |
1125 | __le16 tid_disable_tx; | |
1126 | ||
c587de0b | 1127 | __le16 rate_n_flags; /* 3945 only */ |
133636de TW |
1128 | |
1129 | /* TID for which to add block-ack support. | |
1130 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
1131 | u8 add_immediate_ba_tid; | |
1132 | ||
1133 | /* TID for which to remove block-ack support. | |
1134 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ | |
1135 | u8 remove_immediate_ba_tid; | |
1136 | ||
1137 | /* Starting Sequence Number for added block-ack support. | |
1138 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
1139 | __le16 add_immediate_ba_ssn; | |
1140 | ||
1141 | __le32 reserved2; | |
1142 | } __attribute__ ((packed)); | |
1143 | ||
1144 | ||
2054a00b BC |
1145 | #define ADD_STA_SUCCESS_MSK 0x1 |
1146 | #define ADD_STA_NO_ROOM_IN_TABLE 0x2 | |
1147 | #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4 | |
1148 | #define ADD_STA_MODIFY_NON_EXIST_STA 0x8 | |
b481de9c ZY |
1149 | /* |
1150 | * REPLY_ADD_STA = 0x18 (response) | |
1151 | */ | |
7a999bf0 | 1152 | struct iwl_add_sta_resp { |
2054a00b | 1153 | u8 status; /* ADD_STA_* */ |
b481de9c ZY |
1154 | } __attribute__ ((packed)); |
1155 | ||
7a999bf0 TW |
1156 | #define REM_STA_SUCCESS_MSK 0x1 |
1157 | /* | |
1158 | * REPLY_REM_STA = 0x19 (response) | |
1159 | */ | |
1160 | struct iwl_rem_sta_resp { | |
1161 | u8 status; | |
1162 | } __attribute__ ((packed)); | |
1163 | ||
1164 | /* | |
1165 | * REPLY_REM_STA = 0x19 (command) | |
1166 | */ | |
1167 | struct iwl_rem_sta_cmd { | |
1168 | u8 num_sta; /* number of removed stations */ | |
1169 | u8 reserved[3]; | |
1170 | u8 addr[ETH_ALEN]; /* MAC addr of the first station */ | |
1171 | u8 reserved2[2]; | |
1172 | } __attribute__ ((packed)); | |
1173 | ||
0a0bed1d EG |
1174 | /* |
1175 | * REPLY_WEP_KEY = 0x20 | |
1176 | */ | |
1177 | struct iwl_wep_key { | |
1178 | u8 key_index; | |
1179 | u8 key_offset; | |
1180 | u8 reserved1[2]; | |
1181 | u8 key_size; | |
1182 | u8 reserved2[3]; | |
1183 | u8 key[16]; | |
1184 | } __attribute__ ((packed)); | |
1185 | ||
1186 | struct iwl_wep_cmd { | |
1187 | u8 num_keys; | |
1188 | u8 global_key_type; | |
1189 | u8 flags; | |
1190 | u8 reserved; | |
1191 | struct iwl_wep_key key[0]; | |
1192 | } __attribute__ ((packed)); | |
1193 | ||
1194 | #define WEP_KEY_WEP_TYPE 1 | |
1195 | #define WEP_KEYS_MAX 4 | |
1196 | #define WEP_INVALID_OFFSET 0xff | |
4564ce8b | 1197 | #define WEP_KEY_LEN_64 5 |
0a0bed1d | 1198 | #define WEP_KEY_LEN_128 13 |
b481de9c ZY |
1199 | |
1200 | /****************************************************************************** | |
1201 | * (4) | |
1202 | * Rx Responses: | |
1203 | * | |
1204 | *****************************************************************************/ | |
1205 | ||
51e9bf5d HH |
1206 | #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0) |
1207 | #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1) | |
8211ef78 | 1208 | |
51e9bf5d HH |
1209 | #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0) |
1210 | #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1) | |
1211 | #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2) | |
1212 | #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3) | |
9024adf5 | 1213 | #define RX_RES_PHY_FLAGS_ANTENNA_MSK 0xf0 |
9f30e04e | 1214 | #define RX_RES_PHY_FLAGS_ANTENNA_POS 4 |
8211ef78 TW |
1215 | |
1216 | #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8) | |
1217 | #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8) | |
1218 | #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8) | |
1219 | #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8) | |
1220 | #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8) | |
17e476b8 EG |
1221 | #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8) |
1222 | ||
1223 | #define RX_RES_STATUS_STATION_FOUND (1<<6) | |
1224 | #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7) | |
8211ef78 TW |
1225 | |
1226 | #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11) | |
1227 | #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11) | |
1228 | #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11) | |
1229 | #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11) | |
1230 | #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11) | |
b481de9c | 1231 | |
17e476b8 EG |
1232 | #define RX_MPDU_RES_STATUS_ICV_OK (0x20) |
1233 | #define RX_MPDU_RES_STATUS_MIC_OK (0x40) | |
1234 | #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7) | |
1235 | #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800) | |
1236 | ||
3d24a9f7 TW |
1237 | |
1238 | struct iwl3945_rx_frame_stats { | |
1239 | u8 phy_count; | |
1240 | u8 id; | |
1241 | u8 rssi; | |
1242 | u8 agc; | |
1243 | __le16 sig_avg; | |
1244 | __le16 noise_diff; | |
1245 | u8 payload[0]; | |
1246 | } __attribute__ ((packed)); | |
1247 | ||
1248 | struct iwl3945_rx_frame_hdr { | |
1249 | __le16 channel; | |
1250 | __le16 phy_flags; | |
1251 | u8 reserved1; | |
1252 | u8 rate; | |
1253 | __le16 len; | |
1254 | u8 payload[0]; | |
1255 | } __attribute__ ((packed)); | |
1256 | ||
1257 | struct iwl3945_rx_frame_end { | |
1258 | __le32 status; | |
1259 | __le64 timestamp; | |
1260 | __le32 beacon_timestamp; | |
1261 | } __attribute__ ((packed)); | |
1262 | ||
1263 | /* | |
1264 | * REPLY_3945_RX = 0x1b (response only, not a command) | |
1265 | * | |
1266 | * NOTE: DO NOT dereference from casts to this structure | |
1267 | * It is provided only for calculating minimum data set size. | |
1268 | * The actual offsets of the hdr and end are dynamic based on | |
1269 | * stats.phy_count | |
1270 | */ | |
1271 | struct iwl3945_rx_frame { | |
1272 | struct iwl3945_rx_frame_stats stats; | |
1273 | struct iwl3945_rx_frame_hdr hdr; | |
1274 | struct iwl3945_rx_frame_end end; | |
1275 | } __attribute__ ((packed)); | |
1276 | ||
1277 | #define IWL39_RX_FRAME_SIZE (4 + sizeof(struct iwl3945_rx_frame)) | |
1278 | ||
b481de9c | 1279 | /* Fixed (non-configurable) rx data from phy */ |
caab8f1a TW |
1280 | |
1281 | #define IWL49_RX_RES_PHY_CNT 14 | |
1282 | #define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4) | |
1283 | #define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70) | |
1284 | #define IWL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */ | |
1285 | #define IWL49_AGC_DB_POS (7) | |
b481de9c ZY |
1286 | struct iwl4965_rx_non_cfg_phy { |
1287 | __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */ | |
1288 | __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */ | |
1289 | u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */ | |
1290 | u8 pad[0]; | |
1291 | } __attribute__ ((packed)); | |
1292 | ||
caab8f1a TW |
1293 | |
1294 | #define IWL50_RX_RES_PHY_CNT 8 | |
1295 | #define IWL50_RX_RES_AGC_IDX 1 | |
1296 | #define IWL50_RX_RES_RSSI_AB_IDX 2 | |
1297 | #define IWL50_RX_RES_RSSI_C_IDX 3 | |
1298 | #define IWL50_OFDM_AGC_MSK 0xfe00 | |
1299 | #define IWL50_OFDM_AGC_BIT_POS 9 | |
1300 | #define IWL50_OFDM_RSSI_A_MSK 0x00ff | |
1301 | #define IWL50_OFDM_RSSI_A_BIT_POS 0 | |
1302 | #define IWL50_OFDM_RSSI_B_MSK 0xff0000 | |
1303 | #define IWL50_OFDM_RSSI_B_BIT_POS 16 | |
1304 | #define IWL50_OFDM_RSSI_C_MSK 0x00ff | |
1305 | #define IWL50_OFDM_RSSI_C_BIT_POS 0 | |
1306 | ||
1307 | struct iwl5000_non_cfg_phy { | |
a96a27f9 | 1308 | __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT]; /* up to 8 phy entries */ |
caab8f1a TW |
1309 | } __attribute__ ((packed)); |
1310 | ||
1311 | ||
b481de9c | 1312 | /* |
857485c0 | 1313 | * REPLY_RX = 0xc3 (response only, not a command) |
b481de9c ZY |
1314 | * Used only for legacy (non 11n) frames. |
1315 | */ | |
caab8f1a | 1316 | struct iwl_rx_phy_res { |
b481de9c ZY |
1317 | u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */ |
1318 | u8 cfg_phy_cnt; /* configurable DSP phy data byte count */ | |
1319 | u8 stat_id; /* configurable DSP phy data set ID */ | |
1320 | u8 reserved1; | |
1321 | __le64 timestamp; /* TSF at on air rise */ | |
1322 | __le32 beacon_time_stamp; /* beacon at on-air rise */ | |
1323 | __le16 phy_flags; /* general phy flags: band, modulation, ... */ | |
1324 | __le16 channel; /* channel number */ | |
caab8f1a | 1325 | u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */ |
52969981 BC |
1326 | __le32 rate_n_flags; /* RATE_MCS_* */ |
1327 | __le16 byte_count; /* frame's byte-count */ | |
b481de9c ZY |
1328 | __le16 reserved3; |
1329 | } __attribute__ ((packed)); | |
1330 | ||
1331 | struct iwl4965_rx_mpdu_res_start { | |
1332 | __le16 byte_count; | |
1333 | __le16 reserved; | |
1334 | } __attribute__ ((packed)); | |
1335 | ||
1336 | ||
1337 | /****************************************************************************** | |
1338 | * (5) | |
1339 | * Tx Commands & Responses: | |
1340 | * | |
52969981 BC |
1341 | * Driver must place each REPLY_TX command into one of the prioritized Tx |
1342 | * queues in host DRAM, shared between driver and device (see comments for | |
1343 | * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode | |
1344 | * are preparing to transmit, the device pulls the Tx command over the PCI | |
1345 | * bus via one of the device's Tx DMA channels, to fill an internal FIFO | |
1346 | * from which data will be transmitted. | |
1347 | * | |
1348 | * uCode handles all timing and protocol related to control frames | |
1349 | * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler | |
1350 | * handle reception of block-acks; uCode updates the host driver via | |
1351 | * REPLY_COMPRESSED_BA (4965). | |
1352 | * | |
1353 | * uCode handles retrying Tx when an ACK is expected but not received. | |
1354 | * This includes trying lower data rates than the one requested in the Tx | |
1355 | * command, as set up by the REPLY_RATE_SCALE (for 3945) or | |
1356 | * REPLY_TX_LINK_QUALITY_CMD (4965). | |
1357 | * | |
1358 | * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD. | |
1359 | * This command must be executed after every RXON command, before Tx can occur. | |
b481de9c ZY |
1360 | *****************************************************************************/ |
1361 | ||
52969981 BC |
1362 | /* REPLY_TX Tx flags field */ |
1363 | ||
a96a27f9 | 1364 | /* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it |
a326a5d0 EG |
1365 | * before this frame. if CTS-to-self required check |
1366 | * RXON_FLG_SELF_CTS_EN status. */ | |
51e9bf5d | 1367 | #define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0) |
a326a5d0 | 1368 | |
52969981 BC |
1369 | /* 1: Use Request-To-Send protocol before this frame. |
1370 | * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */ | |
51e9bf5d | 1371 | #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1) |
52969981 BC |
1372 | |
1373 | /* 1: Transmit Clear-To-Send to self before this frame. | |
1374 | * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames. | |
1375 | * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */ | |
51e9bf5d | 1376 | #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2) |
52969981 BC |
1377 | |
1378 | /* 1: Expect ACK from receiving station | |
1379 | * 0: Don't expect ACK (MAC header's duration field s/b 0) | |
1380 | * Set this for unicast frames, but not broadcast/multicast. */ | |
51e9bf5d | 1381 | #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3) |
52969981 BC |
1382 | |
1383 | /* For 4965: | |
1384 | * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD). | |
1385 | * Tx command's initial_rate_index indicates first rate to try; | |
1386 | * uCode walks through table for additional Tx attempts. | |
1387 | * 0: Use Tx rate/MCS from Tx command's rate_n_flags field. | |
1388 | * This rate will be used for all Tx attempts; it will not be scaled. */ | |
51e9bf5d | 1389 | #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4) |
52969981 BC |
1390 | |
1391 | /* 1: Expect immediate block-ack. | |
1392 | * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */ | |
51e9bf5d | 1393 | #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6) |
52969981 BC |
1394 | |
1395 | /* 1: Frame requires full Tx-Op protection. | |
1396 | * Set this if either RTS or CTS Tx Flag gets set. */ | |
51e9bf5d | 1397 | #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7) |
52969981 BC |
1398 | |
1399 | /* Tx antenna selection field; used only for 3945, reserved (0) for 4965. | |
1400 | * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */ | |
51e9bf5d HH |
1401 | #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00) |
1402 | #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8) | |
1403 | #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9) | |
b481de9c | 1404 | |
52969981 BC |
1405 | /* 1: Ignore Bluetooth priority for this frame. |
1406 | * 0: Delay Tx until Bluetooth device is done (normal usage). */ | |
51e9bf5d | 1407 | #define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12) |
b481de9c | 1408 | |
52969981 BC |
1409 | /* 1: uCode overrides sequence control field in MAC header. |
1410 | * 0: Driver provides sequence control field in MAC header. | |
1411 | * Set this for management frames, non-QOS data frames, non-unicast frames, | |
1412 | * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */ | |
51e9bf5d | 1413 | #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13) |
b481de9c | 1414 | |
52969981 BC |
1415 | /* 1: This frame is non-last MPDU; more fragments are coming. |
1416 | * 0: Last fragment, or not using fragmentation. */ | |
51e9bf5d | 1417 | #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14) |
b481de9c | 1418 | |
52969981 BC |
1419 | /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame. |
1420 | * 0: No TSF required in outgoing frame. | |
1421 | * Set this for transmitting beacons and probe responses. */ | |
51e9bf5d | 1422 | #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16) |
b481de9c | 1423 | |
52969981 BC |
1424 | /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword |
1425 | * alignment of frame's payload data field. | |
1426 | * 0: No pad | |
1427 | * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4 | |
1428 | * field (but not both). Driver must align frame data (i.e. data following | |
1429 | * MAC header) to DWORD boundary. */ | |
51e9bf5d | 1430 | #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20) |
b481de9c | 1431 | |
8236e183 MS |
1432 | /* accelerate aggregation support |
1433 | * 0 - no CCMP encryption; 1 - CCMP encryption */ | |
51e9bf5d | 1434 | #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22) |
8236e183 | 1435 | |
b481de9c | 1436 | /* HCCA-AP - disable duration overwriting. */ |
51e9bf5d | 1437 | #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25) |
b481de9c | 1438 | |
52969981 | 1439 | |
b481de9c ZY |
1440 | /* |
1441 | * TX command security control | |
1442 | */ | |
1443 | #define TX_CMD_SEC_WEP 0x01 | |
1444 | #define TX_CMD_SEC_CCM 0x02 | |
1445 | #define TX_CMD_SEC_TKIP 0x03 | |
1446 | #define TX_CMD_SEC_MSK 0x03 | |
1447 | #define TX_CMD_SEC_SHIFT 6 | |
1448 | #define TX_CMD_SEC_KEY128 0x08 | |
1449 | ||
3195cdb7 TW |
1450 | /* |
1451 | * security overhead sizes | |
1452 | */ | |
1453 | #define WEP_IV_LEN 4 | |
1454 | #define WEP_ICV_LEN 4 | |
1455 | #define CCMP_MIC_LEN 8 | |
1456 | #define TKIP_ICV_LEN 4 | |
1457 | ||
3d24a9f7 TW |
1458 | /* |
1459 | * REPLY_TX = 0x1c (command) | |
1460 | */ | |
1461 | ||
1462 | struct iwl3945_tx_cmd { | |
1463 | /* | |
1464 | * MPDU byte count: | |
1465 | * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size, | |
1466 | * + 8 byte IV for CCM or TKIP (not used for WEP) | |
1467 | * + Data payload | |
1468 | * + 8-byte MIC (not used for CCM/WEP) | |
1469 | * NOTE: Does not include Tx command bytes, post-MAC pad bytes, | |
1470 | * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i | |
1471 | * Range: 14-2342 bytes. | |
1472 | */ | |
1473 | __le16 len; | |
1474 | ||
1475 | /* | |
1476 | * MPDU or MSDU byte count for next frame. | |
1477 | * Used for fragmentation and bursting, but not 11n aggregation. | |
1478 | * Same as "len", but for next frame. Set to 0 if not applicable. | |
1479 | */ | |
1480 | __le16 next_frame_len; | |
1481 | ||
1482 | __le32 tx_flags; /* TX_CMD_FLG_* */ | |
1483 | ||
1484 | u8 rate; | |
1485 | ||
1486 | /* Index of recipient station in uCode's station table */ | |
1487 | u8 sta_id; | |
1488 | u8 tid_tspec; | |
1489 | u8 sec_ctl; | |
1490 | u8 key[16]; | |
1491 | union { | |
1492 | u8 byte[8]; | |
1493 | __le16 word[4]; | |
1494 | __le32 dw[2]; | |
1495 | } tkip_mic; | |
1496 | __le32 next_frame_info; | |
1497 | union { | |
1498 | __le32 life_time; | |
1499 | __le32 attempt; | |
1500 | } stop_time; | |
1501 | u8 supp_rates[2]; | |
1502 | u8 rts_retry_limit; /*byte 50 */ | |
1503 | u8 data_retry_limit; /*byte 51 */ | |
1504 | union { | |
1505 | __le16 pm_frame_timeout; | |
1506 | __le16 attempt_duration; | |
1507 | } timeout; | |
1508 | ||
1509 | /* | |
1510 | * Duration of EDCA burst Tx Opportunity, in 32-usec units. | |
1511 | * Set this if txop time is not specified by HCCA protocol (e.g. by AP). | |
1512 | */ | |
1513 | __le16 driver_txop; | |
1514 | ||
1515 | /* | |
1516 | * MAC header goes here, followed by 2 bytes padding if MAC header | |
1517 | * length is 26 or 30 bytes, followed by payload data | |
1518 | */ | |
1519 | u8 payload[0]; | |
1520 | struct ieee80211_hdr hdr[0]; | |
1521 | } __attribute__ ((packed)); | |
1522 | ||
1523 | /* | |
1524 | * REPLY_TX = 0x1c (response) | |
1525 | */ | |
1526 | struct iwl3945_tx_resp { | |
1527 | u8 failure_rts; | |
1528 | u8 failure_frame; | |
1529 | u8 bt_kill_count; | |
1530 | u8 rate; | |
1531 | __le32 wireless_media_time; | |
1532 | __le32 status; /* TX status */ | |
1533 | } __attribute__ ((packed)); | |
1534 | ||
1535 | ||
b481de9c | 1536 | /* |
52969981 BC |
1537 | * 4965 uCode updates these Tx attempt count values in host DRAM. |
1538 | * Used for managing Tx retries when expecting block-acks. | |
1539 | * Driver should set these fields to 0. | |
b481de9c | 1540 | */ |
2aa6ab86 | 1541 | struct iwl_dram_scratch { |
52969981 BC |
1542 | u8 try_cnt; /* Tx attempts */ |
1543 | u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */ | |
b481de9c ZY |
1544 | __le16 reserved; |
1545 | } __attribute__ ((packed)); | |
1546 | ||
83d527d9 | 1547 | struct iwl_tx_cmd { |
52969981 BC |
1548 | /* |
1549 | * MPDU byte count: | |
1550 | * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size, | |
1551 | * + 8 byte IV for CCM or TKIP (not used for WEP) | |
1552 | * + Data payload | |
1553 | * + 8-byte MIC (not used for CCM/WEP) | |
1554 | * NOTE: Does not include Tx command bytes, post-MAC pad bytes, | |
1555 | * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i | |
1556 | * Range: 14-2342 bytes. | |
1557 | */ | |
b481de9c | 1558 | __le16 len; |
52969981 BC |
1559 | |
1560 | /* | |
1561 | * MPDU or MSDU byte count for next frame. | |
1562 | * Used for fragmentation and bursting, but not 11n aggregation. | |
1563 | * Same as "len", but for next frame. Set to 0 if not applicable. | |
1564 | */ | |
b481de9c | 1565 | __le16 next_frame_len; |
52969981 BC |
1566 | |
1567 | __le32 tx_flags; /* TX_CMD_FLG_* */ | |
1568 | ||
2aa6ab86 | 1569 | /* uCode may modify this field of the Tx command (in host DRAM!). |
52969981 | 1570 | * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */ |
2aa6ab86 | 1571 | struct iwl_dram_scratch scratch; |
52969981 BC |
1572 | |
1573 | /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */ | |
1574 | __le32 rate_n_flags; /* RATE_MCS_* */ | |
1575 | ||
1576 | /* Index of destination station in uCode's station table */ | |
b481de9c | 1577 | u8 sta_id; |
52969981 BC |
1578 | |
1579 | /* Type of security encryption: CCM or TKIP */ | |
1580 | u8 sec_ctl; /* TX_CMD_SEC_* */ | |
1581 | ||
1582 | /* | |
1583 | * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial | |
1584 | * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for | |
1585 | * data frames, this field may be used to selectively reduce initial | |
1586 | * rate (via non-0 value) for special frames (e.g. management), while | |
1587 | * still supporting rate scaling for all frames. | |
1588 | */ | |
b481de9c ZY |
1589 | u8 initial_rate_index; |
1590 | u8 reserved; | |
b481de9c | 1591 | u8 key[16]; |
b481de9c ZY |
1592 | __le16 next_frame_flags; |
1593 | __le16 reserved2; | |
b481de9c ZY |
1594 | union { |
1595 | __le32 life_time; | |
1596 | __le32 attempt; | |
1597 | } stop_time; | |
52969981 BC |
1598 | |
1599 | /* Host DRAM physical address pointer to "scratch" in this command. | |
1600 | * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */ | |
b481de9c ZY |
1601 | __le32 dram_lsb_ptr; |
1602 | u8 dram_msb_ptr; | |
52969981 | 1603 | |
b481de9c ZY |
1604 | u8 rts_retry_limit; /*byte 50 */ |
1605 | u8 data_retry_limit; /*byte 51 */ | |
b481de9c | 1606 | u8 tid_tspec; |
b481de9c ZY |
1607 | union { |
1608 | __le16 pm_frame_timeout; | |
1609 | __le16 attempt_duration; | |
1610 | } timeout; | |
52969981 BC |
1611 | |
1612 | /* | |
1613 | * Duration of EDCA burst Tx Opportunity, in 32-usec units. | |
1614 | * Set this if txop time is not specified by HCCA protocol (e.g. by AP). | |
1615 | */ | |
b481de9c | 1616 | __le16 driver_txop; |
52969981 BC |
1617 | |
1618 | /* | |
1619 | * MAC header goes here, followed by 2 bytes padding if MAC header | |
1620 | * length is 26 or 30 bytes, followed by payload data | |
1621 | */ | |
b481de9c ZY |
1622 | u8 payload[0]; |
1623 | struct ieee80211_hdr hdr[0]; | |
1624 | } __attribute__ ((packed)); | |
1625 | ||
1626 | /* TX command response is sent after *all* transmission attempts. | |
1627 | * | |
1628 | * NOTES: | |
1629 | * | |
1630 | * TX_STATUS_FAIL_NEXT_FRAG | |
1631 | * | |
1632 | * If the fragment flag in the MAC header for the frame being transmitted | |
1633 | * is set and there is insufficient time to transmit the next frame, the | |
1634 | * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'. | |
1635 | * | |
1636 | * TX_STATUS_FIFO_UNDERRUN | |
1637 | * | |
1638 | * Indicates the host did not provide bytes to the FIFO fast enough while | |
1639 | * a TX was in progress. | |
1640 | * | |
1641 | * TX_STATUS_FAIL_MGMNT_ABORT | |
1642 | * | |
1643 | * This status is only possible if the ABORT ON MGMT RX parameter was | |
1644 | * set to true with the TX command. | |
1645 | * | |
1646 | * If the MSB of the status parameter is set then an abort sequence is | |
1647 | * required. This sequence consists of the host activating the TX Abort | |
1648 | * control line, and then waiting for the TX Abort command response. This | |
1649 | * indicates that a the device is no longer in a transmit state, and that the | |
1650 | * command FIFO has been cleared. The host must then deactivate the TX Abort | |
1651 | * control line. Receiving is still allowed in this case. | |
1652 | */ | |
1653 | enum { | |
1654 | TX_STATUS_SUCCESS = 0x01, | |
1655 | TX_STATUS_DIRECT_DONE = 0x02, | |
1656 | TX_STATUS_FAIL_SHORT_LIMIT = 0x82, | |
1657 | TX_STATUS_FAIL_LONG_LIMIT = 0x83, | |
1658 | TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84, | |
1659 | TX_STATUS_FAIL_MGMNT_ABORT = 0x85, | |
1660 | TX_STATUS_FAIL_NEXT_FRAG = 0x86, | |
1661 | TX_STATUS_FAIL_LIFE_EXPIRE = 0x87, | |
1662 | TX_STATUS_FAIL_DEST_PS = 0x88, | |
1663 | TX_STATUS_FAIL_ABORTED = 0x89, | |
1664 | TX_STATUS_FAIL_BT_RETRY = 0x8a, | |
1665 | TX_STATUS_FAIL_STA_INVALID = 0x8b, | |
1666 | TX_STATUS_FAIL_FRAG_DROPPED = 0x8c, | |
1667 | TX_STATUS_FAIL_TID_DISABLE = 0x8d, | |
1668 | TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e, | |
1669 | TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f, | |
1670 | TX_STATUS_FAIL_TX_LOCKED = 0x90, | |
1671 | TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91, | |
1672 | }; | |
1673 | ||
1674 | #define TX_PACKET_MODE_REGULAR 0x0000 | |
1675 | #define TX_PACKET_MODE_BURST_SEQ 0x0100 | |
1676 | #define TX_PACKET_MODE_BURST_FIRST 0x0200 | |
1677 | ||
1678 | enum { | |
1679 | TX_POWER_PA_NOT_ACTIVE = 0x0, | |
1680 | }; | |
1681 | ||
1682 | enum { | |
3fd07a1e | 1683 | TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */ |
b481de9c ZY |
1684 | TX_STATUS_DELAY_MSK = 0x00000040, |
1685 | TX_STATUS_ABORT_MSK = 0x00000080, | |
1686 | TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */ | |
1687 | TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */ | |
3fd07a1e | 1688 | TX_RESERVED = 0x00780000, /* bits 19:22 */ |
b481de9c ZY |
1689 | TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */ |
1690 | TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */ | |
1691 | }; | |
1692 | ||
3fd07a1e | 1693 | static inline bool iwl_is_tx_success(u32 status) |
a332f8d6 TW |
1694 | { |
1695 | status &= TX_STATUS_MSK; | |
3fd07a1e TW |
1696 | return (status == TX_STATUS_SUCCESS) || |
1697 | (status == TX_STATUS_DIRECT_DONE); | |
a332f8d6 TW |
1698 | } |
1699 | ||
1700 | ||
1701 | ||
b481de9c | 1702 | /* ******************************* |
52969981 | 1703 | * TX aggregation status |
b481de9c ZY |
1704 | ******************************* */ |
1705 | ||
1706 | enum { | |
1707 | AGG_TX_STATE_TRANSMITTED = 0x00, | |
1708 | AGG_TX_STATE_UNDERRUN_MSK = 0x01, | |
1709 | AGG_TX_STATE_BT_PRIO_MSK = 0x02, | |
1710 | AGG_TX_STATE_FEW_BYTES_MSK = 0x04, | |
1711 | AGG_TX_STATE_ABORT_MSK = 0x08, | |
1712 | AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10, | |
1713 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20, | |
1714 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40, | |
1715 | AGG_TX_STATE_SCD_QUERY_MSK = 0x80, | |
1716 | AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100, | |
1717 | AGG_TX_STATE_RESPONSE_MSK = 0x1ff, | |
1718 | AGG_TX_STATE_DUMP_TX_MSK = 0x200, | |
1719 | AGG_TX_STATE_DELAY_TX_MSK = 0x400 | |
1720 | }; | |
1721 | ||
3fd07a1e TW |
1722 | #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \ |
1723 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \ | |
1724 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK) | |
b481de9c | 1725 | |
52969981 | 1726 | /* # tx attempts for first frame in aggregation */ |
b481de9c ZY |
1727 | #define AGG_TX_STATE_TRY_CNT_POS 12 |
1728 | #define AGG_TX_STATE_TRY_CNT_MSK 0xf000 | |
1729 | ||
52969981 | 1730 | /* Command ID and sequence number of Tx command for this frame */ |
b481de9c ZY |
1731 | #define AGG_TX_STATE_SEQ_NUM_POS 16 |
1732 | #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000 | |
1733 | ||
1734 | /* | |
1735 | * REPLY_TX = 0x1c (response) | |
52969981 BC |
1736 | * |
1737 | * This response may be in one of two slightly different formats, indicated | |
1738 | * by the frame_count field: | |
1739 | * | |
1740 | * 1) No aggregation (frame_count == 1). This reports Tx results for | |
1741 | * a single frame. Multiple attempts, at various bit rates, may have | |
1742 | * been made for this frame. | |
1743 | * | |
1744 | * 2) Aggregation (frame_count > 1). This reports Tx results for | |
1745 | * 2 or more frames that used block-acknowledge. All frames were | |
1746 | * transmitted at same rate. Rate scaling may have been used if first | |
1747 | * frame in this new agg block failed in previous agg block(s). | |
1748 | * | |
1749 | * Note that, for aggregation, ACK (block-ack) status is not delivered here; | |
1750 | * block-ack has not been received by the time the 4965 records this status. | |
1751 | * This status relates to reasons the tx might have been blocked or aborted | |
1752 | * within the sending station (this 4965), rather than whether it was | |
1753 | * received successfully by the destination station. | |
b481de9c | 1754 | */ |
001caff0 RR |
1755 | struct agg_tx_status { |
1756 | __le16 status; | |
1757 | __le16 sequence; | |
1758 | } __attribute__ ((packed)); | |
1759 | ||
bb8c093b | 1760 | struct iwl4965_tx_resp { |
b481de9c | 1761 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ |
52969981 BC |
1762 | u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */ |
1763 | u8 failure_rts; /* # failures due to unsuccessful RTS */ | |
1764 | u8 failure_frame; /* # failures due to no ACK (unused for agg) */ | |
1765 | ||
1766 | /* For non-agg: Rate at which frame was successful. | |
1767 | * For agg: Rate at which all frames were transmitted. */ | |
1768 | __le32 rate_n_flags; /* RATE_MCS_* */ | |
1769 | ||
1770 | /* For non-agg: RTS + CTS + frame tx attempts time + ACK. | |
1771 | * For agg: RTS + CTS + aggregation tx time + block-ack time. */ | |
1772 | __le16 wireless_media_time; /* uSecs */ | |
1773 | ||
b481de9c | 1774 | __le16 reserved; |
52969981 | 1775 | __le32 pa_power1; /* RF power amplifier measurement (not used) */ |
b481de9c | 1776 | __le32 pa_power2; |
52969981 BC |
1777 | |
1778 | /* | |
1779 | * For non-agg: frame status TX_STATUS_* | |
1780 | * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status | |
1781 | * fields follow this one, up to frame_count. | |
1782 | * Bit fields: | |
1783 | * 11- 0: AGG_TX_STATE_* status code | |
1784 | * 15-12: Retry count for 1st frame in aggregation (retries | |
1785 | * occur if tx failed for this frame when it was a | |
1786 | * member of a previous aggregation block). If rate | |
1787 | * scaling is used, retry count indicates the rate | |
1788 | * table entry used for all frames in the new agg. | |
1789 | * 31-16: Sequence # for this frame's Tx cmd (not SSN!) | |
1790 | */ | |
25a6572c TW |
1791 | union { |
1792 | __le32 status; | |
1793 | struct agg_tx_status agg_status[0]; /* for each agg frame */ | |
1794 | } u; | |
fe01b477 RR |
1795 | } __attribute__ ((packed)); |
1796 | ||
3fd07a1e TW |
1797 | /* |
1798 | * definitions for initial rate index field | |
a96a27f9 | 1799 | * bits [3:0] initial rate index |
3fd07a1e TW |
1800 | * bits [6:4] rate table color, used for the initial rate |
1801 | * bit-7 invalid rate indication | |
1802 | * i.e. rate was not chosen from rate table | |
1803 | * or rate table color was changed during frame retries | |
1804 | * refer tlc rate info | |
1805 | */ | |
1806 | ||
1807 | #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0 | |
1808 | #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f | |
1809 | #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4 | |
1810 | #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70 | |
1811 | #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80 | |
1812 | ||
1813 | /* refer to ra_tid */ | |
1814 | #define IWL50_TX_RES_TID_POS 0 | |
1815 | #define IWL50_TX_RES_TID_MSK 0x0f | |
1816 | #define IWL50_TX_RES_RA_POS 4 | |
1817 | #define IWL50_TX_RES_RA_MSK 0xf0 | |
1818 | ||
001caff0 RR |
1819 | struct iwl5000_tx_resp { |
1820 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ | |
1821 | u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */ | |
1822 | u8 failure_rts; /* # failures due to unsuccessful RTS */ | |
1823 | u8 failure_frame; /* # failures due to no ACK (unused for agg) */ | |
1824 | ||
1825 | /* For non-agg: Rate at which frame was successful. | |
1826 | * For agg: Rate at which all frames were transmitted. */ | |
1827 | __le32 rate_n_flags; /* RATE_MCS_* */ | |
1828 | ||
1829 | /* For non-agg: RTS + CTS + frame tx attempts time + ACK. | |
1830 | * For agg: RTS + CTS + aggregation tx time + block-ack time. */ | |
1831 | __le16 wireless_media_time; /* uSecs */ | |
1832 | ||
3fd07a1e TW |
1833 | u8 pa_status; /* RF power amplifier measurement (not used) */ |
1834 | u8 pa_integ_res_a[3]; | |
1835 | u8 pa_integ_res_b[3]; | |
1836 | u8 pa_integ_res_C[3]; | |
001caff0 RR |
1837 | |
1838 | __le32 tfd_info; | |
1839 | __le16 seq_ctl; | |
1840 | __le16 byte_cnt; | |
3fd07a1e TW |
1841 | u8 tlc_info; |
1842 | u8 ra_tid; /* tid (0:3), sta_id (4:7) */ | |
1843 | __le16 frame_ctrl; | |
001caff0 RR |
1844 | /* |
1845 | * For non-agg: frame status TX_STATUS_* | |
1846 | * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status | |
1847 | * fields follow this one, up to frame_count. | |
1848 | * Bit fields: | |
1849 | * 11- 0: AGG_TX_STATE_* status code | |
1850 | * 15-12: Retry count for 1st frame in aggregation (retries | |
1851 | * occur if tx failed for this frame when it was a | |
1852 | * member of a previous aggregation block). If rate | |
1853 | * scaling is used, retry count indicates the rate | |
1854 | * table entry used for all frames in the new agg. | |
1855 | * 31-16: Sequence # for this frame's Tx cmd (not SSN!) | |
1856 | */ | |
1857 | struct agg_tx_status status; /* TX status (in aggregation - | |
1858 | * status of 1st frame) */ | |
1859 | } __attribute__ ((packed)); | |
b481de9c ZY |
1860 | /* |
1861 | * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command) | |
52969981 BC |
1862 | * |
1863 | * Reports Block-Acknowledge from recipient station | |
b481de9c | 1864 | */ |
653fa4a0 | 1865 | struct iwl_compressed_ba_resp { |
b481de9c ZY |
1866 | __le32 sta_addr_lo32; |
1867 | __le16 sta_addr_hi16; | |
1868 | __le16 reserved; | |
52969981 BC |
1869 | |
1870 | /* Index of recipient (BA-sending) station in uCode's station table */ | |
b481de9c ZY |
1871 | u8 sta_id; |
1872 | u8 tid; | |
fe01b477 RR |
1873 | __le16 seq_ctl; |
1874 | __le64 bitmap; | |
b481de9c ZY |
1875 | __le16 scd_flow; |
1876 | __le16 scd_ssn; | |
1877 | } __attribute__ ((packed)); | |
1878 | ||
1879 | /* | |
1880 | * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response) | |
2bdc7031 BC |
1881 | * |
1882 | * See details under "TXPOWER" in iwl-4965-hw.h. | |
b481de9c | 1883 | */ |
3d24a9f7 TW |
1884 | |
1885 | struct iwl3945_txpowertable_cmd { | |
1886 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ | |
1887 | u8 reserved; | |
1888 | __le16 channel; | |
1889 | struct iwl3945_power_per_rate power[IWL_MAX_RATES]; | |
1890 | } __attribute__ ((packed)); | |
1891 | ||
bb8c093b | 1892 | struct iwl4965_txpowertable_cmd { |
b481de9c ZY |
1893 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ |
1894 | u8 reserved; | |
1895 | __le16 channel; | |
bb8c093b | 1896 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
1897 | } __attribute__ ((packed)); |
1898 | ||
3d24a9f7 TW |
1899 | |
1900 | /** | |
1901 | * struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response | |
1902 | * | |
1903 | * REPLY_RATE_SCALE = 0x47 (command, has simple generic response) | |
1904 | * | |
1905 | * NOTE: The table of rates passed to the uCode via the | |
1906 | * RATE_SCALE command sets up the corresponding order of | |
1907 | * rates used for all related commands, including rate | |
1908 | * masks, etc. | |
1909 | * | |
1910 | * For example, if you set 9MB (PLCP 0x0f) as the first | |
1911 | * rate in the rate table, the bit mask for that rate | |
1912 | * when passed through ofdm_basic_rates on the REPLY_RXON | |
1913 | * command would be bit 0 (1 << 0) | |
1914 | */ | |
1915 | struct iwl3945_rate_scaling_info { | |
1916 | __le16 rate_n_flags; | |
1917 | u8 try_cnt; | |
1918 | u8 next_rate_index; | |
1919 | } __attribute__ ((packed)); | |
1920 | ||
1921 | struct iwl3945_rate_scaling_cmd { | |
1922 | u8 table_id; | |
1923 | u8 reserved[3]; | |
1924 | struct iwl3945_rate_scaling_info table[IWL_MAX_RATES]; | |
1925 | } __attribute__ ((packed)); | |
1926 | ||
1927 | ||
b481de9c | 1928 | /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */ |
8a1b0245 | 1929 | #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0) |
b481de9c | 1930 | |
2bdc7031 | 1931 | /* # of EDCA prioritized tx fifos */ |
b481de9c | 1932 | #define LINK_QUAL_AC_NUM AC_NUM |
2bdc7031 BC |
1933 | |
1934 | /* # entries in rate scale table to support Tx retries */ | |
b481de9c ZY |
1935 | #define LINK_QUAL_MAX_RETRY_NUM 16 |
1936 | ||
2bdc7031 | 1937 | /* Tx antenna selection values */ |
8a1b0245 RC |
1938 | #define LINK_QUAL_ANT_A_MSK (1 << 0) |
1939 | #define LINK_QUAL_ANT_B_MSK (1 << 1) | |
b481de9c ZY |
1940 | #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK) |
1941 | ||
2bdc7031 BC |
1942 | |
1943 | /** | |
66c73db7 | 1944 | * struct iwl_link_qual_general_params |
2bdc7031 BC |
1945 | * |
1946 | * Used in REPLY_TX_LINK_QUALITY_CMD | |
1947 | */ | |
66c73db7 | 1948 | struct iwl_link_qual_general_params { |
b481de9c | 1949 | u8 flags; |
2bdc7031 BC |
1950 | |
1951 | /* No entries at or above this (driver chosen) index contain MIMO */ | |
b481de9c | 1952 | u8 mimo_delimiter; |
2bdc7031 BC |
1953 | |
1954 | /* Best single antenna to use for single stream (legacy, SISO). */ | |
1955 | u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */ | |
1956 | ||
1957 | /* Best antennas to use for MIMO (unused for 4965, assumes both). */ | |
1958 | u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */ | |
1959 | ||
1960 | /* | |
1961 | * If driver needs to use different initial rates for different | |
1962 | * EDCA QOS access categories (as implemented by tx fifos 0-3), | |
1963 | * this table will set that up, by indicating the indexes in the | |
1964 | * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start. | |
1965 | * Otherwise, driver should set all entries to 0. | |
1966 | * | |
1967 | * Entry usage: | |
1968 | * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice | |
1969 | * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3. | |
1970 | */ | |
b481de9c ZY |
1971 | u8 start_rate_index[LINK_QUAL_AC_NUM]; |
1972 | } __attribute__ ((packed)); | |
1973 | ||
13c33a09 WYG |
1974 | #define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */ |
1975 | #define LINK_QUAL_AGG_TIME_LIMIT_MAX (65535) | |
1976 | #define LINK_QUAL_AGG_TIME_LIMIT_MIN (0) | |
1977 | ||
1978 | #define LINK_QUAL_AGG_DISABLE_START_DEF (3) | |
1979 | #define LINK_QUAL_AGG_DISABLE_START_MAX (255) | |
1980 | #define LINK_QUAL_AGG_DISABLE_START_MIN (0) | |
1981 | ||
1982 | #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31) | |
b623a9f7 | 1983 | #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63) |
13c33a09 WYG |
1984 | #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0) |
1985 | ||
2bdc7031 | 1986 | /** |
66c73db7 | 1987 | * struct iwl_link_qual_agg_params |
2bdc7031 BC |
1988 | * |
1989 | * Used in REPLY_TX_LINK_QUALITY_CMD | |
1990 | */ | |
66c73db7 | 1991 | struct iwl_link_qual_agg_params { |
2bdc7031 BC |
1992 | |
1993 | /* Maximum number of uSec in aggregation. | |
1994 | * Driver should set this to 4000 (4 milliseconds). */ | |
b481de9c | 1995 | __le16 agg_time_limit; |
2bdc7031 BC |
1996 | |
1997 | /* | |
1998 | * Number of Tx retries allowed for a frame, before that frame will | |
1999 | * no longer be considered for the start of an aggregation sequence | |
2000 | * (scheduler will then try to tx it as single frame). | |
2001 | * Driver should set this to 3. | |
2002 | */ | |
b481de9c | 2003 | u8 agg_dis_start_th; |
2bdc7031 BC |
2004 | |
2005 | /* | |
2006 | * Maximum number of frames in aggregation. | |
2007 | * 0 = no limit (default). 1 = no aggregation. | |
2008 | * Other values = max # frames in aggregation. | |
2009 | */ | |
b481de9c | 2010 | u8 agg_frame_cnt_limit; |
2bdc7031 | 2011 | |
b481de9c ZY |
2012 | __le32 reserved; |
2013 | } __attribute__ ((packed)); | |
2014 | ||
2015 | /* | |
2016 | * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response) | |
2bdc7031 BC |
2017 | * |
2018 | * For 4965 only; 3945 uses REPLY_RATE_SCALE. | |
2019 | * | |
2020 | * Each station in the 4965's internal station table has its own table of 16 | |
2021 | * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when | |
2022 | * an ACK is not received. This command replaces the entire table for | |
2023 | * one station. | |
2024 | * | |
2025 | * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA. | |
2026 | * | |
2027 | * The rate scaling procedures described below work well. Of course, other | |
2028 | * procedures are possible, and may work better for particular environments. | |
2029 | * | |
2030 | * | |
2031 | * FILLING THE RATE TABLE | |
2032 | * | |
2033 | * Given a particular initial rate and mode, as determined by the rate | |
2034 | * scaling algorithm described below, the Linux driver uses the following | |
2035 | * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the | |
2036 | * Link Quality command: | |
2037 | * | |
2038 | * | |
2039 | * 1) If using High-throughput (HT) (SISO or MIMO) initial rate: | |
2040 | * a) Use this same initial rate for first 3 entries. | |
2041 | * b) Find next lower available rate using same mode (SISO or MIMO), | |
2042 | * use for next 3 entries. If no lower rate available, switch to | |
7aafef1c | 2043 | * legacy mode (no HT40 channel, no MIMO, no short guard interval). |
2bdc7031 BC |
2044 | * c) If using MIMO, set command's mimo_delimiter to number of entries |
2045 | * using MIMO (3 or 6). | |
7aafef1c | 2046 | * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel, |
2bdc7031 BC |
2047 | * no MIMO, no short guard interval), at the next lower bit rate |
2048 | * (e.g. if second HT bit rate was 54, try 48 legacy), and follow | |
2049 | * legacy procedure for remaining table entries. | |
2050 | * | |
2051 | * 2) If using legacy initial rate: | |
2052 | * a) Use the initial rate for only one entry. | |
2053 | * b) For each following entry, reduce the rate to next lower available | |
2054 | * rate, until reaching the lowest available rate. | |
2055 | * c) When reducing rate, also switch antenna selection. | |
2056 | * d) Once lowest available rate is reached, repeat this rate until | |
2057 | * rate table is filled (16 entries), switching antenna each entry. | |
2058 | * | |
2059 | * | |
2060 | * ACCUMULATING HISTORY | |
2061 | * | |
2062 | * The rate scaling algorithm for 4965, as implemented in Linux driver, uses | |
2063 | * two sets of frame Tx success history: One for the current/active modulation | |
2064 | * mode, and one for a speculative/search mode that is being attempted. If the | |
2065 | * speculative mode turns out to be more effective (i.e. actual transfer | |
2066 | * rate is better), then the driver continues to use the speculative mode | |
2067 | * as the new current active mode. | |
2068 | * | |
2069 | * Each history set contains, separately for each possible rate, data for a | |
2070 | * sliding window of the 62 most recent tx attempts at that rate. The data | |
2071 | * includes a shifting bitmap of success(1)/failure(0), and sums of successful | |
2072 | * and attempted frames, from which the driver can additionally calculate a | |
2073 | * success ratio (success / attempted) and number of failures | |
2074 | * (attempted - success), and control the size of the window (attempted). | |
2075 | * The driver uses the bit map to remove successes from the success sum, as | |
2076 | * the oldest tx attempts fall out of the window. | |
2077 | * | |
2078 | * When the 4965 makes multiple tx attempts for a given frame, each attempt | |
2079 | * might be at a different rate, and have different modulation characteristics | |
2080 | * (e.g. antenna, fat channel, short guard interval), as set up in the rate | |
2081 | * scaling table in the Link Quality command. The driver must determine | |
2082 | * which rate table entry was used for each tx attempt, to determine which | |
2083 | * rate-specific history to update, and record only those attempts that | |
2084 | * match the modulation characteristics of the history set. | |
2085 | * | |
2086 | * When using block-ack (aggregation), all frames are transmitted at the same | |
a96a27f9 | 2087 | * rate, since there is no per-attempt acknowledgment from the destination |
2bdc7031 BC |
2088 | * station. The Tx response struct iwl_tx_resp indicates the Tx rate in |
2089 | * rate_n_flags field. After receiving a block-ack, the driver can update | |
2090 | * history for the entire block all at once. | |
2091 | * | |
2092 | * | |
2093 | * FINDING BEST STARTING RATE: | |
2094 | * | |
2095 | * When working with a selected initial modulation mode (see below), the | |
2096 | * driver attempts to find a best initial rate. The initial rate is the | |
2097 | * first entry in the Link Quality command's rate table. | |
2098 | * | |
2099 | * 1) Calculate actual throughput (success ratio * expected throughput, see | |
2100 | * table below) for current initial rate. Do this only if enough frames | |
2101 | * have been attempted to make the value meaningful: at least 6 failed | |
2102 | * tx attempts, or at least 8 successes. If not enough, don't try rate | |
2103 | * scaling yet. | |
2104 | * | |
2105 | * 2) Find available rates adjacent to current initial rate. Available means: | |
2106 | * a) supported by hardware && | |
2107 | * b) supported by association && | |
2108 | * c) within any constraints selected by user | |
2109 | * | |
2110 | * 3) Gather measured throughputs for adjacent rates. These might not have | |
2111 | * enough history to calculate a throughput. That's okay, we might try | |
2112 | * using one of them anyway! | |
2113 | * | |
2114 | * 4) Try decreasing rate if, for current rate: | |
2115 | * a) success ratio is < 15% || | |
2116 | * b) lower adjacent rate has better measured throughput || | |
2117 | * c) higher adjacent rate has worse throughput, and lower is unmeasured | |
2118 | * | |
2119 | * As a sanity check, if decrease was determined above, leave rate | |
2120 | * unchanged if: | |
2121 | * a) lower rate unavailable | |
2122 | * b) success ratio at current rate > 85% (very good) | |
2123 | * c) current measured throughput is better than expected throughput | |
2124 | * of lower rate (under perfect 100% tx conditions, see table below) | |
2125 | * | |
2126 | * 5) Try increasing rate if, for current rate: | |
2127 | * a) success ratio is < 15% || | |
2128 | * b) both adjacent rates' throughputs are unmeasured (try it!) || | |
2129 | * b) higher adjacent rate has better measured throughput || | |
2130 | * c) lower adjacent rate has worse throughput, and higher is unmeasured | |
2131 | * | |
2132 | * As a sanity check, if increase was determined above, leave rate | |
2133 | * unchanged if: | |
2134 | * a) success ratio at current rate < 70%. This is not particularly | |
2135 | * good performance; higher rate is sure to have poorer success. | |
2136 | * | |
2137 | * 6) Re-evaluate the rate after each tx frame. If working with block- | |
2138 | * acknowledge, history and statistics may be calculated for the entire | |
2139 | * block (including prior history that fits within the history windows), | |
2140 | * before re-evaluation. | |
2141 | * | |
2142 | * FINDING BEST STARTING MODULATION MODE: | |
2143 | * | |
2144 | * After working with a modulation mode for a "while" (and doing rate scaling), | |
2145 | * the driver searches for a new initial mode in an attempt to improve | |
2146 | * throughput. The "while" is measured by numbers of attempted frames: | |
2147 | * | |
2148 | * For legacy mode, search for new mode after: | |
2149 | * 480 successful frames, or 160 failed frames | |
2150 | * For high-throughput modes (SISO or MIMO), search for new mode after: | |
2151 | * 4500 successful frames, or 400 failed frames | |
2152 | * | |
2153 | * Mode switch possibilities are (3 for each mode): | |
2154 | * | |
2155 | * For legacy: | |
2156 | * Change antenna, try SISO (if HT association), try MIMO (if HT association) | |
2157 | * For SISO: | |
2158 | * Change antenna, try MIMO, try shortened guard interval (SGI) | |
2159 | * For MIMO: | |
2160 | * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI) | |
2161 | * | |
2162 | * When trying a new mode, use the same bit rate as the old/current mode when | |
2163 | * trying antenna switches and shortened guard interval. When switching to | |
2164 | * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate | |
2165 | * for which the expected throughput (under perfect conditions) is about the | |
2166 | * same or slightly better than the actual measured throughput delivered by | |
2167 | * the old/current mode. | |
2168 | * | |
2169 | * Actual throughput can be estimated by multiplying the expected throughput | |
2170 | * by the success ratio (successful / attempted tx frames). Frame size is | |
2171 | * not considered in this calculation; it assumes that frame size will average | |
2172 | * out to be fairly consistent over several samples. The following are | |
2173 | * metric values for expected throughput assuming 100% success ratio. | |
2174 | * Only G band has support for CCK rates: | |
2175 | * | |
2176 | * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60 | |
2177 | * | |
2178 | * G: 7 13 35 58 40 57 72 98 121 154 177 186 186 | |
2179 | * A: 0 0 0 0 40 57 72 98 121 154 177 186 186 | |
2180 | * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202 | |
2181 | * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211 | |
2182 | * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251 | |
2183 | * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257 | |
2184 | * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257 | |
2185 | * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264 | |
2186 | * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289 | |
2187 | * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293 | |
2188 | * | |
2189 | * After the new mode has been tried for a short while (minimum of 6 failed | |
2190 | * frames or 8 successful frames), compare success ratio and actual throughput | |
2191 | * estimate of the new mode with the old. If either is better with the new | |
2192 | * mode, continue to use the new mode. | |
2193 | * | |
2194 | * Continue comparing modes until all 3 possibilities have been tried. | |
2195 | * If moving from legacy to HT, try all 3 possibilities from the new HT | |
2196 | * mode. After trying all 3, a best mode is found. Continue to use this mode | |
2197 | * for the longer "while" described above (e.g. 480 successful frames for | |
2198 | * legacy), and then repeat the search process. | |
2199 | * | |
b481de9c | 2200 | */ |
66c73db7 | 2201 | struct iwl_link_quality_cmd { |
2bdc7031 BC |
2202 | |
2203 | /* Index of destination/recipient station in uCode's station table */ | |
b481de9c ZY |
2204 | u8 sta_id; |
2205 | u8 reserved1; | |
2bdc7031 | 2206 | __le16 control; /* not used */ |
66c73db7 TW |
2207 | struct iwl_link_qual_general_params general_params; |
2208 | struct iwl_link_qual_agg_params agg_params; | |
2bdc7031 BC |
2209 | |
2210 | /* | |
2211 | * Rate info; when using rate-scaling, Tx command's initial_rate_index | |
2212 | * specifies 1st Tx rate attempted, via index into this table. | |
2213 | * 4965 works its way through table when retrying Tx. | |
2214 | */ | |
b481de9c | 2215 | struct { |
2bdc7031 | 2216 | __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */ |
b481de9c ZY |
2217 | } rs_table[LINK_QUAL_MAX_RETRY_NUM]; |
2218 | __le32 reserved2; | |
2219 | } __attribute__ ((packed)); | |
b481de9c | 2220 | |
456d0f76 WYG |
2221 | #define BT_COEX_DISABLE (0x0) |
2222 | #define BT_COEX_MODE_2W (0x1) | |
2223 | #define BT_COEX_MODE_3W (0x2) | |
2224 | #define BT_COEX_MODE_4W (0x3) | |
2225 | ||
2226 | #define BT_LEAD_TIME_MIN (0x0) | |
2227 | #define BT_LEAD_TIME_DEF (0x1E) | |
2228 | #define BT_LEAD_TIME_MAX (0xFF) | |
2229 | ||
2230 | #define BT_MAX_KILL_MIN (0x1) | |
2231 | #define BT_MAX_KILL_DEF (0x5) | |
2232 | #define BT_MAX_KILL_MAX (0xFF) | |
2233 | ||
b481de9c ZY |
2234 | /* |
2235 | * REPLY_BT_CONFIG = 0x9b (command, has simple generic response) | |
3058f021 BC |
2236 | * |
2237 | * 3945 and 4965 support hardware handshake with Bluetooth device on | |
2238 | * same platform. Bluetooth device alerts wireless device when it will Tx; | |
a96a27f9 | 2239 | * wireless device can delay or kill its own Tx to accommodate. |
b481de9c | 2240 | */ |
2aa6ab86 | 2241 | struct iwl_bt_cmd { |
b481de9c ZY |
2242 | u8 flags; |
2243 | u8 lead_time; | |
2244 | u8 max_kill; | |
2245 | u8 reserved; | |
2246 | __le32 kill_ack_mask; | |
2247 | __le32 kill_cts_mask; | |
2248 | } __attribute__ ((packed)); | |
2249 | ||
2250 | /****************************************************************************** | |
2251 | * (6) | |
2252 | * Spectrum Management (802.11h) Commands, Responses, Notifications: | |
2253 | * | |
2254 | *****************************************************************************/ | |
2255 | ||
2256 | /* | |
2257 | * Spectrum Management | |
2258 | */ | |
2259 | #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \ | |
2260 | RXON_FILTER_CTL2HOST_MSK | \ | |
2261 | RXON_FILTER_ACCEPT_GRP_MSK | \ | |
2262 | RXON_FILTER_DIS_DECRYPT_MSK | \ | |
2263 | RXON_FILTER_DIS_GRP_DECRYPT_MSK | \ | |
2264 | RXON_FILTER_ASSOC_MSK | \ | |
2265 | RXON_FILTER_BCON_AWARE_MSK) | |
2266 | ||
2aa6ab86 | 2267 | struct iwl_measure_channel { |
b481de9c ZY |
2268 | __le32 duration; /* measurement duration in extended beacon |
2269 | * format */ | |
2270 | u8 channel; /* channel to measure */ | |
2aa6ab86 | 2271 | u8 type; /* see enum iwl_measure_type */ |
b481de9c ZY |
2272 | __le16 reserved; |
2273 | } __attribute__ ((packed)); | |
2274 | ||
2275 | /* | |
2276 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command) | |
2277 | */ | |
2aa6ab86 | 2278 | struct iwl_spectrum_cmd { |
b481de9c ZY |
2279 | __le16 len; /* number of bytes starting from token */ |
2280 | u8 token; /* token id */ | |
2281 | u8 id; /* measurement id -- 0 or 1 */ | |
2282 | u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */ | |
2283 | u8 periodic; /* 1 = periodic */ | |
2284 | __le16 path_loss_timeout; | |
2285 | __le32 start_time; /* start time in extended beacon format */ | |
2286 | __le32 reserved2; | |
2287 | __le32 flags; /* rxon flags */ | |
2288 | __le32 filter_flags; /* rxon filter flags */ | |
2289 | __le16 channel_count; /* minimum 1, maximum 10 */ | |
2290 | __le16 reserved3; | |
2aa6ab86 | 2291 | struct iwl_measure_channel channels[10]; |
b481de9c ZY |
2292 | } __attribute__ ((packed)); |
2293 | ||
2294 | /* | |
2295 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response) | |
2296 | */ | |
2aa6ab86 | 2297 | struct iwl_spectrum_resp { |
b481de9c ZY |
2298 | u8 token; |
2299 | u8 id; /* id of the prior command replaced, or 0xff */ | |
2300 | __le16 status; /* 0 - command will be handled | |
2301 | * 1 - cannot handle (conflicts with another | |
2302 | * measurement) */ | |
2303 | } __attribute__ ((packed)); | |
2304 | ||
2aa6ab86 | 2305 | enum iwl_measurement_state { |
b481de9c ZY |
2306 | IWL_MEASUREMENT_START = 0, |
2307 | IWL_MEASUREMENT_STOP = 1, | |
2308 | }; | |
2309 | ||
2aa6ab86 | 2310 | enum iwl_measurement_status { |
b481de9c ZY |
2311 | IWL_MEASUREMENT_OK = 0, |
2312 | IWL_MEASUREMENT_CONCURRENT = 1, | |
2313 | IWL_MEASUREMENT_CSA_CONFLICT = 2, | |
2314 | IWL_MEASUREMENT_TGH_CONFLICT = 3, | |
2315 | /* 4-5 reserved */ | |
2316 | IWL_MEASUREMENT_STOPPED = 6, | |
2317 | IWL_MEASUREMENT_TIMEOUT = 7, | |
2318 | IWL_MEASUREMENT_PERIODIC_FAILED = 8, | |
2319 | }; | |
2320 | ||
2321 | #define NUM_ELEMENTS_IN_HISTOGRAM 8 | |
2322 | ||
2aa6ab86 | 2323 | struct iwl_measurement_histogram { |
b481de9c ZY |
2324 | __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */ |
2325 | __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */ | |
2326 | } __attribute__ ((packed)); | |
2327 | ||
2328 | /* clear channel availability counters */ | |
2aa6ab86 | 2329 | struct iwl_measurement_cca_counters { |
b481de9c ZY |
2330 | __le32 ofdm; |
2331 | __le32 cck; | |
2332 | } __attribute__ ((packed)); | |
2333 | ||
2aa6ab86 | 2334 | enum iwl_measure_type { |
b481de9c ZY |
2335 | IWL_MEASURE_BASIC = (1 << 0), |
2336 | IWL_MEASURE_CHANNEL_LOAD = (1 << 1), | |
2337 | IWL_MEASURE_HISTOGRAM_RPI = (1 << 2), | |
2338 | IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3), | |
2339 | IWL_MEASURE_FRAME = (1 << 4), | |
2340 | /* bits 5:6 are reserved */ | |
2341 | IWL_MEASURE_IDLE = (1 << 7), | |
2342 | }; | |
2343 | ||
2344 | /* | |
2345 | * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command) | |
2346 | */ | |
2aa6ab86 | 2347 | struct iwl_spectrum_notification { |
b481de9c ZY |
2348 | u8 id; /* measurement id -- 0 or 1 */ |
2349 | u8 token; | |
2350 | u8 channel_index; /* index in measurement channel list */ | |
2351 | u8 state; /* 0 - start, 1 - stop */ | |
2352 | __le32 start_time; /* lower 32-bits of TSF */ | |
2353 | u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */ | |
2354 | u8 channel; | |
2aa6ab86 | 2355 | u8 type; /* see enum iwl_measurement_type */ |
b481de9c ZY |
2356 | u8 reserved1; |
2357 | /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only | |
2358 | * valid if applicable for measurement type requested. */ | |
2359 | __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */ | |
2360 | __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */ | |
2361 | __le32 cca_time; /* channel load time in usecs */ | |
2362 | u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 - | |
2363 | * unidentified */ | |
2364 | u8 reserved2[3]; | |
2aa6ab86 | 2365 | struct iwl_measurement_histogram histogram; |
b481de9c | 2366 | __le32 stop_time; /* lower 32-bits of TSF */ |
2aa6ab86 | 2367 | __le32 status; /* see iwl_measurement_status */ |
b481de9c ZY |
2368 | } __attribute__ ((packed)); |
2369 | ||
2370 | /****************************************************************************** | |
2371 | * (7) | |
2372 | * Power Management Commands, Responses, Notifications: | |
2373 | * | |
2374 | *****************************************************************************/ | |
2375 | ||
2376 | /** | |
ca579617 | 2377 | * struct iwl_powertable_cmd - Power Table Command |
b481de9c ZY |
2378 | * @flags: See below: |
2379 | * | |
2380 | * POWER_TABLE_CMD = 0x77 (command, has simple generic response) | |
2381 | * | |
2382 | * PM allow: | |
2383 | * bit 0 - '0' Driver not allow power management | |
2384 | * '1' Driver allow PM (use rest of parameters) | |
e312c24c | 2385 | * |
b481de9c ZY |
2386 | * uCode send sleep notifications: |
2387 | * bit 1 - '0' Don't send sleep notification | |
2388 | * '1' send sleep notification (SEND_PM_NOTIFICATION) | |
e312c24c | 2389 | * |
b481de9c ZY |
2390 | * Sleep over DTIM |
2391 | * bit 2 - '0' PM have to walk up every DTIM | |
2392 | * '1' PM could sleep over DTIM till listen Interval. | |
e312c24c | 2393 | * |
b481de9c | 2394 | * PCI power managed |
e7b63581 TW |
2395 | * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1) |
2396 | * '1' !(PCI_CFG_LINK_CTRL & 0x1) | |
e312c24c JB |
2397 | * |
2398 | * Fast PD | |
2399 | * bit 4 - '1' Put radio to sleep when receiving frame for others | |
2400 | * | |
b481de9c ZY |
2401 | * Force sleep Modes |
2402 | * bit 31/30- '00' use both mac/xtal sleeps | |
2403 | * '01' force Mac sleep | |
2404 | * '10' force xtal sleep | |
2405 | * '11' Illegal set | |
2406 | * | |
2407 | * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then | |
a96a27f9 | 2408 | * ucode assume sleep over DTIM is allowed and we don't need to wake up |
b481de9c ZY |
2409 | * for every DTIM. |
2410 | */ | |
2411 | #define IWL_POWER_VEC_SIZE 5 | |
2412 | ||
600c0e11 TW |
2413 | #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0)) |
2414 | #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2)) | |
2415 | #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3)) | |
2416 | #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4)) | |
2417 | ||
2418 | struct iwl3945_powertable_cmd { | |
2419 | __le16 flags; | |
2420 | u8 reserved[2]; | |
2421 | __le32 rx_data_timeout; | |
2422 | __le32 tx_data_timeout; | |
2423 | __le32 sleep_interval[IWL_POWER_VEC_SIZE]; | |
2424 | } __attribute__ ((packed)); | |
b481de9c | 2425 | |
ca579617 | 2426 | struct iwl_powertable_cmd { |
b481de9c | 2427 | __le16 flags; |
600c0e11 TW |
2428 | u8 keep_alive_seconds; /* 3945 reserved */ |
2429 | u8 debug_flags; /* 3945 reserved */ | |
b481de9c ZY |
2430 | __le32 rx_data_timeout; |
2431 | __le32 tx_data_timeout; | |
2432 | __le32 sleep_interval[IWL_POWER_VEC_SIZE]; | |
2433 | __le32 keep_alive_beacons; | |
2434 | } __attribute__ ((packed)); | |
b481de9c ZY |
2435 | |
2436 | /* | |
2437 | * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command) | |
2438 | * 3945 and 4965 identical. | |
2439 | */ | |
2aa6ab86 | 2440 | struct iwl_sleep_notification { |
b481de9c ZY |
2441 | u8 pm_sleep_mode; |
2442 | u8 pm_wakeup_src; | |
2443 | __le16 reserved; | |
2444 | __le32 sleep_time; | |
2445 | __le32 tsf_low; | |
2446 | __le32 bcon_timer; | |
2447 | } __attribute__ ((packed)); | |
2448 | ||
2449 | /* Sleep states. 3945 and 4965 identical. */ | |
2450 | enum { | |
2451 | IWL_PM_NO_SLEEP = 0, | |
2452 | IWL_PM_SLP_MAC = 1, | |
2453 | IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2, | |
2454 | IWL_PM_SLP_FULL_MAC_CARD_STATE = 3, | |
2455 | IWL_PM_SLP_PHY = 4, | |
2456 | IWL_PM_SLP_REPENT = 5, | |
2457 | IWL_PM_WAKEUP_BY_TIMER = 6, | |
2458 | IWL_PM_WAKEUP_BY_DRIVER = 7, | |
2459 | IWL_PM_WAKEUP_BY_RFKILL = 8, | |
2460 | /* 3 reserved */ | |
2461 | IWL_PM_NUM_OF_MODES = 12, | |
2462 | }; | |
2463 | ||
2464 | /* | |
2465 | * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response) | |
2466 | */ | |
2467 | #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */ | |
2468 | #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */ | |
2469 | #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */ | |
2aa6ab86 | 2470 | struct iwl_card_state_cmd { |
b481de9c ZY |
2471 | __le32 status; /* CARD_STATE_CMD_* request new power state */ |
2472 | } __attribute__ ((packed)); | |
2473 | ||
2474 | /* | |
2475 | * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command) | |
2476 | */ | |
2aa6ab86 | 2477 | struct iwl_card_state_notif { |
b481de9c ZY |
2478 | __le32 flags; |
2479 | } __attribute__ ((packed)); | |
2480 | ||
2481 | #define HW_CARD_DISABLED 0x01 | |
2482 | #define SW_CARD_DISABLED 0x02 | |
2483 | #define RF_CARD_DISABLED 0x04 | |
2484 | #define RXON_CARD_DISABLED 0x10 | |
2485 | ||
47f4a587 | 2486 | struct iwl_ct_kill_config { |
b481de9c ZY |
2487 | __le32 reserved; |
2488 | __le32 critical_temperature_M; | |
2489 | __le32 critical_temperature_R; | |
2490 | } __attribute__ ((packed)); | |
2491 | ||
672639de WYG |
2492 | /* 1000, and 6x00 */ |
2493 | struct iwl_ct_kill_throttling_config { | |
2494 | __le32 critical_temperature_exit; | |
2495 | __le32 reserved; | |
2496 | __le32 critical_temperature_enter; | |
2497 | } __attribute__ ((packed)); | |
2498 | ||
b481de9c ZY |
2499 | /****************************************************************************** |
2500 | * (8) | |
2501 | * Scan Commands, Responses, Notifications: | |
2502 | * | |
2503 | *****************************************************************************/ | |
2504 | ||
51e9bf5d HH |
2505 | #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0) |
2506 | #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1) | |
d16dc48a | 2507 | |
3058f021 | 2508 | /** |
2a421b91 | 2509 | * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table |
3058f021 BC |
2510 | * |
2511 | * One for each channel in the scan list. | |
2512 | * Each channel can independently select: | |
2513 | * 1) SSID for directed active scans | |
2514 | * 2) Txpower setting (for rate specified within Tx command) | |
2515 | * 3) How long to stay on-channel (behavior may be modified by quiet_time, | |
2516 | * quiet_plcp_th, good_CRC_th) | |
2517 | * | |
2518 | * To avoid uCode errors, make sure the following are true (see comments | |
2a421b91 | 2519 | * under struct iwl_scan_cmd about max_out_time and quiet_time): |
3058f021 BC |
2520 | * 1) If using passive_dwell (i.e. passive_dwell != 0): |
2521 | * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0) | |
2522 | * 2) quiet_time <= active_dwell | |
2523 | * 3) If restricting off-channel time (i.e. max_out_time !=0): | |
2524 | * passive_dwell < max_out_time | |
2525 | * active_dwell < max_out_time | |
2526 | */ | |
3d24a9f7 TW |
2527 | |
2528 | /* FIXME: rename to AP1, remove tpc */ | |
2529 | struct iwl3945_scan_channel { | |
2530 | /* | |
2531 | * type is defined as: | |
2532 | * 0:0 1 = active, 0 = passive | |
2533 | * 1:4 SSID direct bit map; if a bit is set, then corresponding | |
2534 | * SSID IE is transmitted in probe request. | |
2535 | * 5:7 reserved | |
2536 | */ | |
2537 | u8 type; | |
2538 | u8 channel; /* band is selected by iwl3945_scan_cmd "flags" field */ | |
2539 | struct iwl3945_tx_power tpc; | |
2540 | __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */ | |
2541 | __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */ | |
2542 | } __attribute__ ((packed)); | |
2543 | ||
0d21044e WT |
2544 | /* set number of direct probes u8 type */ |
2545 | #define IWL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1)))) | |
2546 | ||
2a421b91 | 2547 | struct iwl_scan_channel { |
3058f021 BC |
2548 | /* |
2549 | * type is defined as: | |
2550 | * 0:0 1 = active, 0 = passive | |
d16dc48a | 2551 | * 1:20 SSID direct bit map; if a bit is set, then corresponding |
3058f021 | 2552 | * SSID IE is transmitted in probe request. |
d16dc48a | 2553 | * 21:31 reserved |
b481de9c | 2554 | */ |
d16dc48a TW |
2555 | __le32 type; |
2556 | __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */ | |
f53696de TW |
2557 | u8 tx_gain; /* gain for analog radio */ |
2558 | u8 dsp_atten; /* gain for DSP */ | |
3058f021 BC |
2559 | __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */ |
2560 | __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */ | |
b481de9c ZY |
2561 | } __attribute__ ((packed)); |
2562 | ||
0d21044e WT |
2563 | /* set number of direct probes __le32 type */ |
2564 | #define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1)))) | |
2565 | ||
3058f021 | 2566 | /** |
2a421b91 | 2567 | * struct iwl_ssid_ie - directed scan network information element |
3058f021 BC |
2568 | * |
2569 | * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field | |
2aa6ab86 | 2570 | * in struct iwl_scan_channel; each channel may select different ssids from |
3058f021 BC |
2571 | * among the 4 entries. SSID IEs get transmitted in reverse order of entry. |
2572 | */ | |
2a421b91 | 2573 | struct iwl_ssid_ie { |
b481de9c ZY |
2574 | u8 id; |
2575 | u8 len; | |
2576 | u8 ssid[32]; | |
2577 | } __attribute__ ((packed)); | |
2578 | ||
9b3bf06a JB |
2579 | #define PROBE_OPTION_MAX_3945 4 |
2580 | #define PROBE_OPTION_MAX 20 | |
51e9bf5d HH |
2581 | #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF) |
2582 | #define IWL_GOOD_CRC_TH cpu_to_le16(1) | |
b481de9c | 2583 | #define IWL_MAX_SCAN_SIZE 1024 |
1ecf9fc1 | 2584 | #define IWL_MAX_PROBE_REQUEST 200 |
b481de9c ZY |
2585 | |
2586 | /* | |
2587 | * REPLY_SCAN_CMD = 0x80 (command) | |
3058f021 BC |
2588 | * |
2589 | * The hardware scan command is very powerful; the driver can set it up to | |
2590 | * maintain (relatively) normal network traffic while doing a scan in the | |
2591 | * background. The max_out_time and suspend_time control the ratio of how | |
2592 | * long the device stays on an associated network channel ("service channel") | |
2593 | * vs. how long it's away from the service channel, i.e. tuned to other channels | |
2594 | * for scanning. | |
2595 | * | |
2596 | * max_out_time is the max time off-channel (in usec), and suspend_time | |
2597 | * is how long (in "extended beacon" format) that the scan is "suspended" | |
2598 | * after returning to the service channel. That is, suspend_time is the | |
2599 | * time that we stay on the service channel, doing normal work, between | |
2600 | * scan segments. The driver may set these parameters differently to support | |
2601 | * scanning when associated vs. not associated, and light vs. heavy traffic | |
2602 | * loads when associated. | |
2603 | * | |
2604 | * After receiving this command, the device's scan engine does the following; | |
2605 | * | |
2606 | * 1) Sends SCAN_START notification to driver | |
2607 | * 2) Checks to see if it has time to do scan for one channel | |
2608 | * 3) Sends NULL packet, with power-save (PS) bit set to 1, | |
2609 | * to tell AP that we're going off-channel | |
2610 | * 4) Tunes to first channel in scan list, does active or passive scan | |
2611 | * 5) Sends SCAN_RESULT notification to driver | |
2612 | * 6) Checks to see if it has time to do scan on *next* channel in list | |
2613 | * 7) Repeats 4-6 until it no longer has time to scan the next channel | |
2614 | * before max_out_time expires | |
2615 | * 8) Returns to service channel | |
2616 | * 9) Sends NULL packet with PS=0 to tell AP that we're back | |
2617 | * 10) Stays on service channel until suspend_time expires | |
2618 | * 11) Repeats entire process 2-10 until list is complete | |
2619 | * 12) Sends SCAN_COMPLETE notification | |
2620 | * | |
2621 | * For fast, efficient scans, the scan command also has support for staying on | |
2622 | * a channel for just a short time, if doing active scanning and getting no | |
2623 | * responses to the transmitted probe request. This time is controlled by | |
2624 | * quiet_time, and the number of received packets below which a channel is | |
2625 | * considered "quiet" is controlled by quiet_plcp_threshold. | |
2626 | * | |
2627 | * For active scanning on channels that have regulatory restrictions against | |
2628 | * blindly transmitting, the scan can listen before transmitting, to make sure | |
2629 | * that there is already legitimate activity on the channel. If enough | |
2630 | * packets are cleanly received on the channel (controlled by good_CRC_th, | |
2631 | * typical value 1), the scan engine starts transmitting probe requests. | |
2632 | * | |
2633 | * Driver must use separate scan commands for 2.4 vs. 5 GHz bands. | |
2634 | * | |
2635 | * To avoid uCode errors, see timing restrictions described under | |
2a421b91 | 2636 | * struct iwl_scan_channel. |
b481de9c | 2637 | */ |
3d24a9f7 TW |
2638 | |
2639 | struct iwl3945_scan_cmd { | |
2640 | __le16 len; | |
2641 | u8 reserved0; | |
2642 | u8 channel_count; /* # channels in channel list */ | |
2643 | __le16 quiet_time; /* dwell only this # millisecs on quiet channel | |
2644 | * (only for active scan) */ | |
2645 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ | |
2646 | __le16 good_CRC_th; /* passive -> active promotion threshold */ | |
2647 | __le16 reserved1; | |
2648 | __le32 max_out_time; /* max usec to be away from associated (service) | |
2649 | * channel */ | |
2650 | __le32 suspend_time; /* pause scan this long (in "extended beacon | |
2651 | * format") when returning to service channel: | |
2652 | * 3945; 31:24 # beacons, 19:0 additional usec, | |
2653 | * 4965; 31:22 # beacons, 21:0 additional usec. | |
2654 | */ | |
2655 | __le32 flags; /* RXON_FLG_* */ | |
2656 | __le32 filter_flags; /* RXON_FILTER_* */ | |
2657 | ||
2658 | /* For active scans (set to all-0s for passive scans). | |
2659 | * Does not include payload. Must specify Tx rate; no rate scaling. */ | |
2660 | struct iwl3945_tx_cmd tx_cmd; | |
2661 | ||
2662 | /* For directed active scans (set to all-0s otherwise) */ | |
9b3bf06a | 2663 | struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX_3945]; |
3d24a9f7 TW |
2664 | |
2665 | /* | |
2666 | * Probe request frame, followed by channel list. | |
2667 | * | |
2668 | * Size of probe request frame is specified by byte count in tx_cmd. | |
2669 | * Channel list follows immediately after probe request frame. | |
2670 | * Number of channels in list is specified by channel_count. | |
2671 | * Each channel in list is of type: | |
2672 | * | |
2673 | * struct iwl3945_scan_channel channels[0]; | |
2674 | * | |
2675 | * NOTE: Only one band of channels can be scanned per pass. You | |
2676 | * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait | |
2677 | * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION) | |
2678 | * before requesting another scan. | |
2679 | */ | |
2680 | u8 data[0]; | |
2681 | } __attribute__ ((packed)); | |
2682 | ||
2a421b91 | 2683 | struct iwl_scan_cmd { |
b481de9c ZY |
2684 | __le16 len; |
2685 | u8 reserved0; | |
3058f021 BC |
2686 | u8 channel_count; /* # channels in channel list */ |
2687 | __le16 quiet_time; /* dwell only this # millisecs on quiet channel | |
2688 | * (only for active scan) */ | |
2689 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ | |
2690 | __le16 good_CRC_th; /* passive -> active promotion threshold */ | |
2691 | __le16 rx_chain; /* RXON_RX_CHAIN_* */ | |
2692 | __le32 max_out_time; /* max usec to be away from associated (service) | |
2693 | * channel */ | |
2694 | __le32 suspend_time; /* pause scan this long (in "extended beacon | |
2695 | * format") when returning to service chnl: | |
2696 | * 3945; 31:24 # beacons, 19:0 additional usec, | |
2697 | * 4965; 31:22 # beacons, 21:0 additional usec. | |
2698 | */ | |
2699 | __le32 flags; /* RXON_FLG_* */ | |
2700 | __le32 filter_flags; /* RXON_FILTER_* */ | |
2701 | ||
2702 | /* For active scans (set to all-0s for passive scans). | |
2703 | * Does not include payload. Must specify Tx rate; no rate scaling. */ | |
83d527d9 | 2704 | struct iwl_tx_cmd tx_cmd; |
3058f021 BC |
2705 | |
2706 | /* For directed active scans (set to all-0s otherwise) */ | |
2a421b91 | 2707 | struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX]; |
b481de9c | 2708 | |
b481de9c | 2709 | /* |
3058f021 BC |
2710 | * Probe request frame, followed by channel list. |
2711 | * | |
2712 | * Size of probe request frame is specified by byte count in tx_cmd. | |
2713 | * Channel list follows immediately after probe request frame. | |
2714 | * Number of channels in list is specified by channel_count. | |
2715 | * Each channel in list is of type: | |
b481de9c | 2716 | * |
2aa6ab86 | 2717 | * struct iwl_scan_channel channels[0]; |
b481de9c ZY |
2718 | * |
2719 | * NOTE: Only one band of channels can be scanned per pass. You | |
3058f021 BC |
2720 | * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait |
2721 | * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION) | |
2722 | * before requesting another scan. | |
b481de9c | 2723 | */ |
3058f021 | 2724 | u8 data[0]; |
b481de9c ZY |
2725 | } __attribute__ ((packed)); |
2726 | ||
2727 | /* Can abort will notify by complete notification with abort status. */ | |
51e9bf5d | 2728 | #define CAN_ABORT_STATUS cpu_to_le32(0x1) |
b481de9c ZY |
2729 | /* complete notification statuses */ |
2730 | #define ABORT_STATUS 0x2 | |
2731 | ||
2732 | /* | |
2733 | * REPLY_SCAN_CMD = 0x80 (response) | |
2734 | */ | |
2a421b91 | 2735 | struct iwl_scanreq_notification { |
b481de9c ZY |
2736 | __le32 status; /* 1: okay, 2: cannot fulfill request */ |
2737 | } __attribute__ ((packed)); | |
2738 | ||
2739 | /* | |
2740 | * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command) | |
2741 | */ | |
2a421b91 | 2742 | struct iwl_scanstart_notification { |
b481de9c ZY |
2743 | __le32 tsf_low; |
2744 | __le32 tsf_high; | |
2745 | __le32 beacon_timer; | |
2746 | u8 channel; | |
2747 | u8 band; | |
2748 | u8 reserved[2]; | |
2749 | __le32 status; | |
2750 | } __attribute__ ((packed)); | |
2751 | ||
2752 | #define SCAN_OWNER_STATUS 0x1; | |
2753 | #define MEASURE_OWNER_STATUS 0x2; | |
2754 | ||
2755 | #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */ | |
2756 | /* | |
2757 | * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command) | |
2758 | */ | |
2a421b91 | 2759 | struct iwl_scanresults_notification { |
b481de9c ZY |
2760 | u8 channel; |
2761 | u8 band; | |
2762 | u8 reserved[2]; | |
2763 | __le32 tsf_low; | |
2764 | __le32 tsf_high; | |
2765 | __le32 statistics[NUMBER_OF_STATISTICS]; | |
2766 | } __attribute__ ((packed)); | |
2767 | ||
2768 | /* | |
2769 | * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command) | |
2770 | */ | |
2a421b91 | 2771 | struct iwl_scancomplete_notification { |
b481de9c ZY |
2772 | u8 scanned_channels; |
2773 | u8 status; | |
2774 | u8 reserved; | |
2775 | u8 last_channel; | |
2776 | __le32 tsf_low; | |
2777 | __le32 tsf_high; | |
2778 | } __attribute__ ((packed)); | |
2779 | ||
2780 | ||
2781 | /****************************************************************************** | |
2782 | * (9) | |
2783 | * IBSS/AP Commands and Notifications: | |
2784 | * | |
2785 | *****************************************************************************/ | |
2786 | ||
2787 | /* | |
2788 | * BEACON_NOTIFICATION = 0x90 (notification only, not a command) | |
2789 | */ | |
3d24a9f7 TW |
2790 | |
2791 | struct iwl3945_beacon_notif { | |
2792 | struct iwl3945_tx_resp beacon_notify_hdr; | |
2793 | __le32 low_tsf; | |
2794 | __le32 high_tsf; | |
2795 | __le32 ibss_mgr_status; | |
2796 | } __attribute__ ((packed)); | |
2797 | ||
bb8c093b CH |
2798 | struct iwl4965_beacon_notif { |
2799 | struct iwl4965_tx_resp beacon_notify_hdr; | |
b481de9c ZY |
2800 | __le32 low_tsf; |
2801 | __le32 high_tsf; | |
2802 | __le32 ibss_mgr_status; | |
2803 | } __attribute__ ((packed)); | |
2804 | ||
2805 | /* | |
2806 | * REPLY_TX_BEACON = 0x91 (command, has simple generic response) | |
2807 | */ | |
3d24a9f7 TW |
2808 | |
2809 | struct iwl3945_tx_beacon_cmd { | |
2810 | struct iwl3945_tx_cmd tx; | |
2811 | __le16 tim_idx; | |
2812 | u8 tim_size; | |
2813 | u8 reserved1; | |
2814 | struct ieee80211_hdr frame[0]; /* beacon frame */ | |
2815 | } __attribute__ ((packed)); | |
2816 | ||
4bf64efd | 2817 | struct iwl_tx_beacon_cmd { |
83d527d9 | 2818 | struct iwl_tx_cmd tx; |
b481de9c ZY |
2819 | __le16 tim_idx; |
2820 | u8 tim_size; | |
2821 | u8 reserved1; | |
2822 | struct ieee80211_hdr frame[0]; /* beacon frame */ | |
2823 | } __attribute__ ((packed)); | |
2824 | ||
2825 | /****************************************************************************** | |
2826 | * (10) | |
2827 | * Statistics Commands and Notifications: | |
2828 | * | |
2829 | *****************************************************************************/ | |
2830 | ||
2831 | #define IWL_TEMP_CONVERT 260 | |
2832 | ||
2833 | #define SUP_RATE_11A_MAX_NUM_CHANNELS 8 | |
2834 | #define SUP_RATE_11B_MAX_NUM_CHANNELS 4 | |
2835 | #define SUP_RATE_11G_MAX_NUM_CHANNELS 12 | |
2836 | ||
2837 | /* Used for passing to driver number of successes and failures per rate */ | |
2838 | struct rate_histogram { | |
2839 | union { | |
2840 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
2841 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
2842 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
2843 | } success; | |
2844 | union { | |
2845 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
2846 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
2847 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
2848 | } failed; | |
2849 | } __attribute__ ((packed)); | |
2850 | ||
2851 | /* statistics command response */ | |
2852 | ||
3d24a9f7 TW |
2853 | struct iwl39_statistics_rx_phy { |
2854 | __le32 ina_cnt; | |
2855 | __le32 fina_cnt; | |
2856 | __le32 plcp_err; | |
2857 | __le32 crc32_err; | |
2858 | __le32 overrun_err; | |
2859 | __le32 early_overrun_err; | |
2860 | __le32 crc32_good; | |
2861 | __le32 false_alarm_cnt; | |
2862 | __le32 fina_sync_err_cnt; | |
2863 | __le32 sfd_timeout; | |
2864 | __le32 fina_timeout; | |
2865 | __le32 unresponded_rts; | |
2866 | __le32 rxe_frame_limit_overrun; | |
2867 | __le32 sent_ack_cnt; | |
2868 | __le32 sent_cts_cnt; | |
2869 | } __attribute__ ((packed)); | |
2870 | ||
2871 | struct iwl39_statistics_rx_non_phy { | |
2872 | __le32 bogus_cts; /* CTS received when not expecting CTS */ | |
2873 | __le32 bogus_ack; /* ACK received when not expecting ACK */ | |
2874 | __le32 non_bssid_frames; /* number of frames with BSSID that | |
2875 | * doesn't belong to the STA BSSID */ | |
2876 | __le32 filtered_frames; /* count frames that were dumped in the | |
2877 | * filtering process */ | |
2878 | __le32 non_channel_beacons; /* beacons with our bss id but not on | |
2879 | * our serving channel */ | |
2880 | } __attribute__ ((packed)); | |
2881 | ||
2882 | struct iwl39_statistics_rx { | |
2883 | struct iwl39_statistics_rx_phy ofdm; | |
2884 | struct iwl39_statistics_rx_phy cck; | |
2885 | struct iwl39_statistics_rx_non_phy general; | |
2886 | } __attribute__ ((packed)); | |
2887 | ||
2888 | struct iwl39_statistics_tx { | |
2889 | __le32 preamble_cnt; | |
2890 | __le32 rx_detected_cnt; | |
2891 | __le32 bt_prio_defer_cnt; | |
2892 | __le32 bt_prio_kill_cnt; | |
2893 | __le32 few_bytes_cnt; | |
2894 | __le32 cts_timeout; | |
2895 | __le32 ack_timeout; | |
2896 | __le32 expected_ack_cnt; | |
2897 | __le32 actual_ack_cnt; | |
2898 | } __attribute__ ((packed)); | |
2899 | ||
2900 | struct statistics_dbg { | |
2901 | __le32 burst_check; | |
2902 | __le32 burst_count; | |
2903 | __le32 reserved[4]; | |
2904 | } __attribute__ ((packed)); | |
2905 | ||
2906 | struct iwl39_statistics_div { | |
2907 | __le32 tx_on_a; | |
2908 | __le32 tx_on_b; | |
2909 | __le32 exec_time; | |
2910 | __le32 probe_time; | |
2911 | } __attribute__ ((packed)); | |
2912 | ||
2913 | struct iwl39_statistics_general { | |
2914 | __le32 temperature; | |
2915 | struct statistics_dbg dbg; | |
2916 | __le32 sleep_time; | |
2917 | __le32 slots_out; | |
2918 | __le32 slots_idle; | |
2919 | __le32 ttl_timestamp; | |
2920 | struct iwl39_statistics_div div; | |
2921 | } __attribute__ ((packed)); | |
2922 | ||
b481de9c ZY |
2923 | struct statistics_rx_phy { |
2924 | __le32 ina_cnt; | |
2925 | __le32 fina_cnt; | |
2926 | __le32 plcp_err; | |
2927 | __le32 crc32_err; | |
2928 | __le32 overrun_err; | |
2929 | __le32 early_overrun_err; | |
2930 | __le32 crc32_good; | |
2931 | __le32 false_alarm_cnt; | |
2932 | __le32 fina_sync_err_cnt; | |
2933 | __le32 sfd_timeout; | |
2934 | __le32 fina_timeout; | |
2935 | __le32 unresponded_rts; | |
2936 | __le32 rxe_frame_limit_overrun; | |
2937 | __le32 sent_ack_cnt; | |
2938 | __le32 sent_cts_cnt; | |
b481de9c ZY |
2939 | __le32 sent_ba_rsp_cnt; |
2940 | __le32 dsp_self_kill; | |
2941 | __le32 mh_format_err; | |
2942 | __le32 re_acq_main_rssi_sum; | |
2943 | __le32 reserved3; | |
b481de9c ZY |
2944 | } __attribute__ ((packed)); |
2945 | ||
b481de9c ZY |
2946 | struct statistics_rx_ht_phy { |
2947 | __le32 plcp_err; | |
2948 | __le32 overrun_err; | |
2949 | __le32 early_overrun_err; | |
2950 | __le32 crc32_good; | |
2951 | __le32 crc32_err; | |
2952 | __le32 mh_format_err; | |
2953 | __le32 agg_crc32_good; | |
2954 | __le32 agg_mpdu_cnt; | |
2955 | __le32 agg_cnt; | |
2956 | __le32 reserved2; | |
2957 | } __attribute__ ((packed)); | |
b481de9c | 2958 | |
c1b4aa3f | 2959 | #define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1) |
34c22cf9 | 2960 | |
b481de9c ZY |
2961 | struct statistics_rx_non_phy { |
2962 | __le32 bogus_cts; /* CTS received when not expecting CTS */ | |
2963 | __le32 bogus_ack; /* ACK received when not expecting ACK */ | |
2964 | __le32 non_bssid_frames; /* number of frames with BSSID that | |
2965 | * doesn't belong to the STA BSSID */ | |
2966 | __le32 filtered_frames; /* count frames that were dumped in the | |
2967 | * filtering process */ | |
2968 | __le32 non_channel_beacons; /* beacons with our bss id but not on | |
2969 | * our serving channel */ | |
b481de9c ZY |
2970 | __le32 channel_beacons; /* beacons with our bss id and in our |
2971 | * serving channel */ | |
2972 | __le32 num_missed_bcon; /* number of missed beacons */ | |
2973 | __le32 adc_rx_saturation_time; /* count in 0.8us units the time the | |
2974 | * ADC was in saturation */ | |
2975 | __le32 ina_detection_search_time;/* total time (in 0.8us) searched | |
2976 | * for INA */ | |
2977 | __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */ | |
2978 | __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */ | |
2979 | __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */ | |
2980 | __le32 interference_data_flag; /* flag for interference data | |
2981 | * availability. 1 when data is | |
2982 | * available. */ | |
3058f021 | 2983 | __le32 channel_load; /* counts RX Enable time in uSec */ |
b481de9c ZY |
2984 | __le32 dsp_false_alarms; /* DSP false alarm (both OFDM |
2985 | * and CCK) counter */ | |
2986 | __le32 beacon_rssi_a; | |
2987 | __le32 beacon_rssi_b; | |
2988 | __le32 beacon_rssi_c; | |
2989 | __le32 beacon_energy_a; | |
2990 | __le32 beacon_energy_b; | |
2991 | __le32 beacon_energy_c; | |
b481de9c ZY |
2992 | } __attribute__ ((packed)); |
2993 | ||
2994 | struct statistics_rx { | |
2995 | struct statistics_rx_phy ofdm; | |
2996 | struct statistics_rx_phy cck; | |
2997 | struct statistics_rx_non_phy general; | |
b481de9c | 2998 | struct statistics_rx_ht_phy ofdm_ht; |
b481de9c ZY |
2999 | } __attribute__ ((packed)); |
3000 | ||
fcbaf8b0 WYG |
3001 | /** |
3002 | * struct statistics_tx_power - current tx power | |
3003 | * | |
3004 | * @ant_a: current tx power on chain a in 1/2 dB step | |
3005 | * @ant_b: current tx power on chain b in 1/2 dB step | |
3006 | * @ant_c: current tx power on chain c in 1/2 dB step | |
3007 | */ | |
3008 | struct statistics_tx_power { | |
3009 | u8 ant_a; | |
3010 | u8 ant_b; | |
3011 | u8 ant_c; | |
3012 | u8 reserved; | |
3013 | } __attribute__ ((packed)); | |
3014 | ||
b481de9c ZY |
3015 | struct statistics_tx_non_phy_agg { |
3016 | __le32 ba_timeout; | |
3017 | __le32 ba_reschedule_frames; | |
3018 | __le32 scd_query_agg_frame_cnt; | |
3019 | __le32 scd_query_no_agg; | |
3020 | __le32 scd_query_agg; | |
3021 | __le32 scd_query_mismatch; | |
3022 | __le32 frame_not_ready; | |
3023 | __le32 underrun; | |
3024 | __le32 bt_prio_kill; | |
3025 | __le32 rx_ba_rsp_cnt; | |
b481de9c | 3026 | } __attribute__ ((packed)); |
b481de9c ZY |
3027 | |
3028 | struct statistics_tx { | |
3029 | __le32 preamble_cnt; | |
3030 | __le32 rx_detected_cnt; | |
3031 | __le32 bt_prio_defer_cnt; | |
3032 | __le32 bt_prio_kill_cnt; | |
3033 | __le32 few_bytes_cnt; | |
3034 | __le32 cts_timeout; | |
3035 | __le32 ack_timeout; | |
3036 | __le32 expected_ack_cnt; | |
3037 | __le32 actual_ack_cnt; | |
b481de9c ZY |
3038 | __le32 dump_msdu_cnt; |
3039 | __le32 burst_abort_next_frame_mismatch_cnt; | |
3040 | __le32 burst_abort_missing_next_frame_cnt; | |
3041 | __le32 cts_timeout_collision; | |
3042 | __le32 ack_or_ba_timeout_collision; | |
3043 | struct statistics_tx_non_phy_agg agg; | |
fcbaf8b0 WYG |
3044 | struct statistics_tx_power tx_power; |
3045 | __le32 reserved1; | |
b481de9c ZY |
3046 | } __attribute__ ((packed)); |
3047 | ||
b481de9c ZY |
3048 | |
3049 | struct statistics_div { | |
3050 | __le32 tx_on_a; | |
3051 | __le32 tx_on_b; | |
3052 | __le32 exec_time; | |
3053 | __le32 probe_time; | |
b481de9c ZY |
3054 | __le32 reserved1; |
3055 | __le32 reserved2; | |
b481de9c ZY |
3056 | } __attribute__ ((packed)); |
3057 | ||
3058 | struct statistics_general { | |
3059 | __le32 temperature; | |
b481de9c | 3060 | __le32 temperature_m; |
b481de9c ZY |
3061 | struct statistics_dbg dbg; |
3062 | __le32 sleep_time; | |
3063 | __le32 slots_out; | |
3064 | __le32 slots_idle; | |
3065 | __le32 ttl_timestamp; | |
3066 | struct statistics_div div; | |
b481de9c ZY |
3067 | __le32 rx_enable_counter; |
3068 | __le32 reserved1; | |
3069 | __le32 reserved2; | |
3070 | __le32 reserved3; | |
b481de9c ZY |
3071 | } __attribute__ ((packed)); |
3072 | ||
3073 | /* | |
3074 | * REPLY_STATISTICS_CMD = 0x9c, | |
3075 | * 3945 and 4965 identical. | |
3076 | * | |
3077 | * This command triggers an immediate response containing uCode statistics. | |
3078 | * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below. | |
3079 | * | |
3080 | * If the CLEAR_STATS configuration flag is set, uCode will clear its | |
3081 | * internal copy of the statistics (counters) after issuing the response. | |
3082 | * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below). | |
3083 | * | |
3084 | * If the DISABLE_NOTIF configuration flag is set, uCode will not issue | |
3085 | * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag | |
3086 | * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself. | |
3087 | */ | |
51e9bf5d HH |
3088 | #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */ |
3089 | #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */ | |
8f91aecb | 3090 | struct iwl_statistics_cmd { |
b481de9c ZY |
3091 | __le32 configuration_flags; /* IWL_STATS_CONF_* */ |
3092 | } __attribute__ ((packed)); | |
3093 | ||
3094 | /* | |
3095 | * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command) | |
3096 | * | |
3097 | * By default, uCode issues this notification after receiving a beacon | |
3098 | * while associated. To disable this behavior, set DISABLE_NOTIF flag in the | |
3099 | * REPLY_STATISTICS_CMD 0x9c, above. | |
3100 | * | |
3101 | * Statistics counters continue to increment beacon after beacon, but are | |
3102 | * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD | |
3103 | * 0x9c with CLEAR_STATS bit set (see above). | |
3104 | * | |
3105 | * uCode also issues this notification during scans. uCode clears statistics | |
3106 | * appropriately so that each notification contains statistics for only the | |
3107 | * one channel that has just been scanned. | |
3108 | */ | |
51e9bf5d | 3109 | #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2) |
7aafef1c | 3110 | #define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8) |
3d24a9f7 TW |
3111 | |
3112 | struct iwl3945_notif_statistics { | |
3113 | __le32 flag; | |
3114 | struct iwl39_statistics_rx rx; | |
3115 | struct iwl39_statistics_tx tx; | |
3116 | struct iwl39_statistics_general general; | |
3117 | } __attribute__ ((packed)); | |
3118 | ||
8f91aecb | 3119 | struct iwl_notif_statistics { |
b481de9c ZY |
3120 | __le32 flag; |
3121 | struct statistics_rx rx; | |
3122 | struct statistics_tx tx; | |
3123 | struct statistics_general general; | |
3124 | } __attribute__ ((packed)); | |
3125 | ||
3126 | ||
3127 | /* | |
3128 | * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command) | |
3129 | */ | |
3130 | /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row, | |
3131 | * then this notification will be sent. */ | |
3132 | #define CONSECUTIVE_MISSED_BCONS_TH 20 | |
3133 | ||
2aa6ab86 | 3134 | struct iwl_missed_beacon_notif { |
b481de9c ZY |
3135 | __le32 consequtive_missed_beacons; |
3136 | __le32 total_missed_becons; | |
3137 | __le32 num_expected_beacons; | |
3138 | __le32 num_recvd_beacons; | |
3139 | } __attribute__ ((packed)); | |
3140 | ||
f7d09d7c | 3141 | |
b481de9c ZY |
3142 | /****************************************************************************** |
3143 | * (11) | |
3144 | * Rx Calibration Commands: | |
3145 | * | |
f7d09d7c BC |
3146 | * With the uCode used for open source drivers, most Tx calibration (except |
3147 | * for Tx Power) and most Rx calibration is done by uCode during the | |
3148 | * "initialize" phase of uCode boot. Driver must calibrate only: | |
3149 | * | |
3150 | * 1) Tx power (depends on temperature), described elsewhere | |
3151 | * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas) | |
3152 | * 3) Receiver sensitivity (to optimize signal detection) | |
3153 | * | |
b481de9c ZY |
3154 | *****************************************************************************/ |
3155 | ||
f7d09d7c BC |
3156 | /** |
3157 | * SENSITIVITY_CMD = 0xa8 (command, has simple generic response) | |
3158 | * | |
3159 | * This command sets up the Rx signal detector for a sensitivity level that | |
3160 | * is high enough to lock onto all signals within the associated network, | |
3161 | * but low enough to ignore signals that are below a certain threshold, so as | |
3162 | * not to have too many "false alarms". False alarms are signals that the | |
3163 | * Rx DSP tries to lock onto, but then discards after determining that they | |
3164 | * are noise. | |
3165 | * | |
3166 | * The optimum number of false alarms is between 5 and 50 per 200 TUs | |
3167 | * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e. | |
3168 | * time listening, not transmitting). Driver must adjust sensitivity so that | |
3169 | * the ratio of actual false alarms to actual Rx time falls within this range. | |
3170 | * | |
3171 | * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each | |
3172 | * received beacon. These provide information to the driver to analyze the | |
3173 | * sensitivity. Don't analyze statistics that come in from scanning, or any | |
3174 | * other non-associated-network source. Pertinent statistics include: | |
3175 | * | |
3176 | * From "general" statistics (struct statistics_rx_non_phy): | |
3177 | * | |
3178 | * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level) | |
3179 | * Measure of energy of desired signal. Used for establishing a level | |
3180 | * below which the device does not detect signals. | |
3181 | * | |
3182 | * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB) | |
3183 | * Measure of background noise in silent period after beacon. | |
3184 | * | |
3185 | * channel_load | |
3186 | * uSecs of actual Rx time during beacon period (varies according to | |
3187 | * how much time was spent transmitting). | |
3188 | * | |
3189 | * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately: | |
3190 | * | |
3191 | * false_alarm_cnt | |
3192 | * Signal locks abandoned early (before phy-level header). | |
3193 | * | |
3194 | * plcp_err | |
3195 | * Signal locks abandoned late (during phy-level header). | |
3196 | * | |
3197 | * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from | |
3198 | * beacon to beacon, i.e. each value is an accumulation of all errors | |
3199 | * before and including the latest beacon. Values will wrap around to 0 | |
3200 | * after counting up to 2^32 - 1. Driver must differentiate vs. | |
3201 | * previous beacon's values to determine # false alarms in the current | |
3202 | * beacon period. | |
3203 | * | |
3204 | * Total number of false alarms = false_alarms + plcp_errs | |
3205 | * | |
3206 | * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd | |
3207 | * (notice that the start points for OFDM are at or close to settings for | |
3208 | * maximum sensitivity): | |
3209 | * | |
3210 | * START / MIN / MAX | |
3211 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120 | |
3212 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210 | |
3213 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140 | |
3214 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270 | |
3215 | * | |
3216 | * If actual rate of OFDM false alarms (+ plcp_errors) is too high | |
3217 | * (greater than 50 for each 204.8 msecs listening), reduce sensitivity | |
3218 | * by *adding* 1 to all 4 of the table entries above, up to the max for | |
3219 | * each entry. Conversely, if false alarm rate is too low (less than 5 | |
3220 | * for each 204.8 msecs listening), *subtract* 1 from each entry to | |
3221 | * increase sensitivity. | |
3222 | * | |
3223 | * For CCK sensitivity, keep track of the following: | |
3224 | * | |
3225 | * 1). 20-beacon history of maximum background noise, indicated by | |
3226 | * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the | |
3227 | * 3 receivers. For any given beacon, the "silence reference" is | |
3228 | * the maximum of last 60 samples (20 beacons * 3 receivers). | |
3229 | * | |
3230 | * 2). 10-beacon history of strongest signal level, as indicated | |
3231 | * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers, | |
3232 | * i.e. the strength of the signal through the best receiver at the | |
3233 | * moment. These measurements are "upside down", with lower values | |
3234 | * for stronger signals, so max energy will be *minimum* value. | |
3235 | * | |
3236 | * Then for any given beacon, the driver must determine the *weakest* | |
3237 | * of the strongest signals; this is the minimum level that needs to be | |
3238 | * successfully detected, when using the best receiver at the moment. | |
3239 | * "Max cck energy" is the maximum (higher value means lower energy!) | |
3240 | * of the last 10 minima. Once this is determined, driver must add | |
3241 | * a little margin by adding "6" to it. | |
3242 | * | |
3243 | * 3). Number of consecutive beacon periods with too few false alarms. | |
3244 | * Reset this to 0 at the first beacon period that falls within the | |
3245 | * "good" range (5 to 50 false alarms per 204.8 milliseconds rx). | |
3246 | * | |
3247 | * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd | |
3248 | * (notice that the start points for CCK are at maximum sensitivity): | |
3249 | * | |
3250 | * START / MIN / MAX | |
3251 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200 | |
3252 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400 | |
3253 | * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100 | |
3254 | * | |
3255 | * If actual rate of CCK false alarms (+ plcp_errors) is too high | |
3256 | * (greater than 50 for each 204.8 msecs listening), method for reducing | |
3257 | * sensitivity is: | |
3258 | * | |
3259 | * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
3260 | * up to max 400. | |
3261 | * | |
3262 | * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160, | |
3263 | * sensitivity has been reduced a significant amount; bring it up to | |
3264 | * a moderate 161. Otherwise, *add* 3, up to max 200. | |
3265 | * | |
3266 | * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160, | |
3267 | * sensitivity has been reduced only a moderate or small amount; | |
3268 | * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX, | |
3269 | * down to min 0. Otherwise (if gain has been significantly reduced), | |
3270 | * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value. | |
3271 | * | |
3272 | * b) Save a snapshot of the "silence reference". | |
3273 | * | |
3274 | * If actual rate of CCK false alarms (+ plcp_errors) is too low | |
3275 | * (less than 5 for each 204.8 msecs listening), method for increasing | |
3276 | * sensitivity is used only if: | |
3277 | * | |
3278 | * 1a) Previous beacon did not have too many false alarms | |
3279 | * 1b) AND difference between previous "silence reference" and current | |
3280 | * "silence reference" (prev - current) is 2 or more, | |
3281 | * OR 2) 100 or more consecutive beacon periods have had rate of | |
3282 | * less than 5 false alarms per 204.8 milliseconds rx time. | |
3283 | * | |
3284 | * Method for increasing sensitivity: | |
3285 | * | |
3286 | * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX, | |
3287 | * down to min 125. | |
3288 | * | |
3289 | * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
3290 | * down to min 200. | |
3291 | * | |
3292 | * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100. | |
3293 | * | |
3294 | * If actual rate of CCK false alarms (+ plcp_errors) is within good range | |
3295 | * (between 5 and 50 for each 204.8 msecs listening): | |
3296 | * | |
3297 | * 1) Save a snapshot of the silence reference. | |
3298 | * | |
3299 | * 2) If previous beacon had too many CCK false alarms (+ plcp_errors), | |
3300 | * give some extra margin to energy threshold by *subtracting* 8 | |
3301 | * from value in HD_MIN_ENERGY_CCK_DET_INDEX. | |
3302 | * | |
3303 | * For all cases (too few, too many, good range), make sure that the CCK | |
3304 | * detection threshold (energy) is below the energy level for robust | |
3305 | * detection over the past 10 beacon periods, the "Max cck energy". | |
3306 | * Lower values mean higher energy; this means making sure that the value | |
3307 | * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy". | |
3308 | * | |
f7d09d7c BC |
3309 | */ |
3310 | ||
3311 | /* | |
f0832f13 | 3312 | * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd) |
f7d09d7c BC |
3313 | */ |
3314 | #define HD_TABLE_SIZE (11) /* number of entries */ | |
3315 | #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */ | |
3316 | #define HD_MIN_ENERGY_OFDM_DET_INDEX (1) | |
3317 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2) | |
3318 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3) | |
3319 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4) | |
3320 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5) | |
3321 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6) | |
3322 | #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7) | |
3323 | #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8) | |
3324 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9) | |
3325 | #define HD_OFDM_ENERGY_TH_IN_INDEX (10) | |
3326 | ||
f0832f13 | 3327 | /* Control field in struct iwl_sensitivity_cmd */ |
51e9bf5d HH |
3328 | #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0) |
3329 | #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1) | |
b481de9c | 3330 | |
f7d09d7c | 3331 | /** |
f0832f13 | 3332 | * struct iwl_sensitivity_cmd |
f7d09d7c BC |
3333 | * @control: (1) updates working table, (0) updates default table |
3334 | * @table: energy threshold values, use HD_* as index into table | |
3335 | * | |
3336 | * Always use "1" in "control" to update uCode's working table and DSP. | |
3337 | */ | |
f0832f13 | 3338 | struct iwl_sensitivity_cmd { |
f7d09d7c BC |
3339 | __le16 control; /* always use "1" */ |
3340 | __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */ | |
b481de9c ZY |
3341 | } __attribute__ ((packed)); |
3342 | ||
f7d09d7c BC |
3343 | |
3344 | /** | |
3345 | * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response) | |
3346 | * | |
3347 | * This command sets the relative gains of 4965's 3 radio receiver chains. | |
3348 | * | |
3349 | * After the first association, driver should accumulate signal and noise | |
3350 | * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20 | |
3351 | * beacons from the associated network (don't collect statistics that come | |
3352 | * in from scanning, or any other non-network source). | |
3353 | * | |
3354 | * DISCONNECTED ANTENNA: | |
3355 | * | |
3356 | * Driver should determine which antennas are actually connected, by comparing | |
3357 | * average beacon signal levels for the 3 Rx chains. Accumulate (add) the | |
3358 | * following values over 20 beacons, one accumulator for each of the chains | |
3359 | * a/b/c, from struct statistics_rx_non_phy: | |
3360 | * | |
3361 | * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
3362 | * | |
3363 | * Find the strongest signal from among a/b/c. Compare the other two to the | |
3364 | * strongest. If any signal is more than 15 dB (times 20, unless you | |
3365 | * divide the accumulated values by 20) below the strongest, the driver | |
3366 | * considers that antenna to be disconnected, and should not try to use that | |
3367 | * antenna/chain for Rx or Tx. If both A and B seem to be disconnected, | |
3368 | * driver should declare the stronger one as connected, and attempt to use it | |
3369 | * (A and B are the only 2 Tx chains!). | |
3370 | * | |
3371 | * | |
3372 | * RX BALANCE: | |
3373 | * | |
3374 | * Driver should balance the 3 receivers (but just the ones that are connected | |
3375 | * to antennas, see above) for gain, by comparing the average signal levels | |
3376 | * detected during the silence after each beacon (background noise). | |
3377 | * Accumulate (add) the following values over 20 beacons, one accumulator for | |
3378 | * each of the chains a/b/c, from struct statistics_rx_non_phy: | |
3379 | * | |
3380 | * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
3381 | * | |
3382 | * Find the weakest background noise level from among a/b/c. This Rx chain | |
3383 | * will be the reference, with 0 gain adjustment. Attenuate other channels by | |
3384 | * finding noise difference: | |
3385 | * | |
3386 | * (accum_noise[i] - accum_noise[reference]) / 30 | |
3387 | * | |
3388 | * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB. | |
3389 | * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the | |
3390 | * driver should limit the difference results to a range of 0-3 (0-4.5 dB), | |
3391 | * and set bit 2 to indicate "reduce gain". The value for the reference | |
3392 | * (weakest) chain should be "0". | |
3393 | * | |
3394 | * diff_gain_[abc] bit fields: | |
3395 | * 2: (1) reduce gain, (0) increase gain | |
3396 | * 1-0: amount of gain, units of 1.5 dB | |
3397 | */ | |
3398 | ||
f69f42a6 | 3399 | /* Phy calibration command for series */ |
33fd5033 EG |
3400 | |
3401 | enum { | |
f69f42a6 TW |
3402 | IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7, |
3403 | IWL_PHY_CALIBRATE_DC_CMD = 8, | |
3404 | IWL_PHY_CALIBRATE_LO_CMD = 9, | |
3405 | IWL_PHY_CALIBRATE_RX_BB_CMD = 10, | |
3406 | IWL_PHY_CALIBRATE_TX_IQ_CMD = 11, | |
3407 | IWL_PHY_CALIBRATE_RX_IQ_CMD = 12, | |
3408 | IWL_PHY_CALIBRATION_NOISE_CMD = 13, | |
3409 | IWL_PHY_CALIBRATE_AGC_TABLE_CMD = 14, | |
3410 | IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15, | |
3411 | IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16, | |
3412 | IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17, | |
3413 | IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18, | |
3414 | IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19, | |
33fd5033 EG |
3415 | }; |
3416 | ||
f69f42a6 | 3417 | |
51e9bf5d | 3418 | #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff) |
7c616cba TW |
3419 | |
3420 | struct iwl_calib_cfg_elmnt_s { | |
3421 | __le32 is_enable; | |
3422 | __le32 start; | |
3423 | __le32 send_res; | |
3424 | __le32 apply_res; | |
3425 | __le32 reserved; | |
3426 | } __attribute__ ((packed)); | |
3427 | ||
3428 | struct iwl_calib_cfg_status_s { | |
3429 | struct iwl_calib_cfg_elmnt_s once; | |
3430 | struct iwl_calib_cfg_elmnt_s perd; | |
3431 | __le32 flags; | |
3432 | } __attribute__ ((packed)); | |
3433 | ||
f69f42a6 | 3434 | struct iwl_calib_cfg_cmd { |
7c616cba TW |
3435 | struct iwl_calib_cfg_status_s ucd_calib_cfg; |
3436 | struct iwl_calib_cfg_status_s drv_calib_cfg; | |
3437 | __le32 reserved1; | |
3438 | } __attribute__ ((packed)); | |
3439 | ||
f69f42a6 | 3440 | struct iwl_calib_hdr { |
7c616cba TW |
3441 | u8 op_code; |
3442 | u8 first_group; | |
3443 | u8 groups_num; | |
3444 | u8 data_valid; | |
3445 | } __attribute__ ((packed)); | |
3446 | ||
f69f42a6 TW |
3447 | struct iwl_calib_cmd { |
3448 | struct iwl_calib_hdr hdr; | |
be5d56ed TW |
3449 | u8 data[0]; |
3450 | } __attribute__ ((packed)); | |
3451 | ||
0d950d84 | 3452 | /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */ |
f69f42a6 | 3453 | struct iwl_calib_diff_gain_cmd { |
0d950d84 | 3454 | struct iwl_calib_hdr hdr; |
f69f42a6 TW |
3455 | s8 diff_gain_a; /* see above */ |
3456 | s8 diff_gain_b; | |
3457 | s8 diff_gain_c; | |
3458 | u8 reserved1; | |
3459 | } __attribute__ ((packed)); | |
3460 | ||
0d950d84 TW |
3461 | struct iwl_calib_xtal_freq_cmd { |
3462 | struct iwl_calib_hdr hdr; | |
3463 | u8 cap_pin1; | |
3464 | u8 cap_pin2; | |
3465 | u8 pad[2]; | |
33fd5033 EG |
3466 | } __attribute__ ((packed)); |
3467 | ||
0d950d84 TW |
3468 | /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */ |
3469 | struct iwl_calib_chain_noise_reset_cmd { | |
3470 | struct iwl_calib_hdr hdr; | |
3471 | u8 data[0]; | |
3472 | }; | |
3473 | ||
3474 | /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */ | |
f69f42a6 | 3475 | struct iwl_calib_chain_noise_gain_cmd { |
0d950d84 | 3476 | struct iwl_calib_hdr hdr; |
33fd5033 EG |
3477 | u8 delta_gain_1; |
3478 | u8 delta_gain_2; | |
0d950d84 | 3479 | u8 pad[2]; |
33fd5033 EG |
3480 | } __attribute__ ((packed)); |
3481 | ||
b481de9c ZY |
3482 | /****************************************************************************** |
3483 | * (12) | |
3484 | * Miscellaneous Commands: | |
3485 | * | |
3486 | *****************************************************************************/ | |
3487 | ||
3488 | /* | |
3489 | * LEDs Command & Response | |
3490 | * REPLY_LEDS_CMD = 0x48 (command, has simple generic response) | |
3491 | * | |
3492 | * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field), | |
3493 | * this command turns it on or off, or sets up a periodic blinking cycle. | |
3494 | */ | |
ec1a7460 | 3495 | struct iwl_led_cmd { |
b481de9c ZY |
3496 | __le32 interval; /* "interval" in uSec */ |
3497 | u8 id; /* 1: Activity, 2: Link, 3: Tech */ | |
3498 | u8 off; /* # intervals off while blinking; | |
3499 | * "0", with >0 "on" value, turns LED on */ | |
3500 | u8 on; /* # intervals on while blinking; | |
3501 | * "0", regardless of "off", turns LED off */ | |
3502 | u8 reserved; | |
3503 | } __attribute__ ((packed)); | |
3504 | ||
9636e583 | 3505 | /* |
fe1bcbfd WYG |
3506 | * station priority table entries |
3507 | * also used as potential "events" value for both | |
3508 | * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD | |
9636e583 | 3509 | */ |
1933ac4d WYG |
3510 | |
3511 | /* | |
3512 | * COEX events entry flag masks | |
3513 | * RP - Requested Priority | |
3514 | * WP - Win Medium Priority: priority assigned when the contention has been won | |
3515 | */ | |
3516 | #define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG (0x1) | |
3517 | #define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG (0x2) | |
3518 | #define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG (0x4) | |
3519 | ||
3520 | #define COEX_CU_UNASSOC_IDLE_RP 4 | |
3521 | #define COEX_CU_UNASSOC_MANUAL_SCAN_RP 4 | |
3522 | #define COEX_CU_UNASSOC_AUTO_SCAN_RP 4 | |
3523 | #define COEX_CU_CALIBRATION_RP 4 | |
3524 | #define COEX_CU_PERIODIC_CALIBRATION_RP 4 | |
3525 | #define COEX_CU_CONNECTION_ESTAB_RP 4 | |
3526 | #define COEX_CU_ASSOCIATED_IDLE_RP 4 | |
3527 | #define COEX_CU_ASSOC_MANUAL_SCAN_RP 4 | |
3528 | #define COEX_CU_ASSOC_AUTO_SCAN_RP 4 | |
3529 | #define COEX_CU_ASSOC_ACTIVE_LEVEL_RP 4 | |
3530 | #define COEX_CU_RF_ON_RP 6 | |
3531 | #define COEX_CU_RF_OFF_RP 4 | |
3532 | #define COEX_CU_STAND_ALONE_DEBUG_RP 6 | |
3533 | #define COEX_CU_IPAN_ASSOC_LEVEL_RP 4 | |
3534 | #define COEX_CU_RSRVD1_RP 4 | |
3535 | #define COEX_CU_RSRVD2_RP 4 | |
3536 | ||
3537 | #define COEX_CU_UNASSOC_IDLE_WP 3 | |
3538 | #define COEX_CU_UNASSOC_MANUAL_SCAN_WP 3 | |
3539 | #define COEX_CU_UNASSOC_AUTO_SCAN_WP 3 | |
3540 | #define COEX_CU_CALIBRATION_WP 3 | |
3541 | #define COEX_CU_PERIODIC_CALIBRATION_WP 3 | |
3542 | #define COEX_CU_CONNECTION_ESTAB_WP 3 | |
3543 | #define COEX_CU_ASSOCIATED_IDLE_WP 3 | |
3544 | #define COEX_CU_ASSOC_MANUAL_SCAN_WP 3 | |
3545 | #define COEX_CU_ASSOC_AUTO_SCAN_WP 3 | |
3546 | #define COEX_CU_ASSOC_ACTIVE_LEVEL_WP 3 | |
3547 | #define COEX_CU_RF_ON_WP 3 | |
3548 | #define COEX_CU_RF_OFF_WP 3 | |
3549 | #define COEX_CU_STAND_ALONE_DEBUG_WP 6 | |
3550 | #define COEX_CU_IPAN_ASSOC_LEVEL_WP 3 | |
3551 | #define COEX_CU_RSRVD1_WP 3 | |
3552 | #define COEX_CU_RSRVD2_WP 3 | |
3553 | ||
3554 | #define COEX_UNASSOC_IDLE_FLAGS 0 | |
3555 | #define COEX_UNASSOC_MANUAL_SCAN_FLAGS \ | |
3556 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3557 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3558 | #define COEX_UNASSOC_AUTO_SCAN_FLAGS \ | |
3559 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3560 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3561 | #define COEX_CALIBRATION_FLAGS \ | |
3562 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3563 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3564 | #define COEX_PERIODIC_CALIBRATION_FLAGS 0 | |
3565 | /* | |
3566 | * COEX_CONNECTION_ESTAB: | |
3567 | * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network. | |
3568 | */ | |
3569 | #define COEX_CONNECTION_ESTAB_FLAGS \ | |
3570 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3571 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \ | |
3572 | COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG) | |
3573 | #define COEX_ASSOCIATED_IDLE_FLAGS 0 | |
3574 | #define COEX_ASSOC_MANUAL_SCAN_FLAGS \ | |
3575 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3576 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3577 | #define COEX_ASSOC_AUTO_SCAN_FLAGS \ | |
3578 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3579 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3580 | #define COEX_ASSOC_ACTIVE_LEVEL_FLAGS 0 | |
3581 | #define COEX_RF_ON_FLAGS 0 | |
3582 | #define COEX_RF_OFF_FLAGS 0 | |
3583 | #define COEX_STAND_ALONE_DEBUG_FLAGS \ | |
3584 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3585 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG) | |
3586 | #define COEX_IPAN_ASSOC_LEVEL_FLAGS \ | |
3587 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3588 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \ | |
3589 | COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG) | |
3590 | #define COEX_RSRVD1_FLAGS 0 | |
3591 | #define COEX_RSRVD2_FLAGS 0 | |
3592 | /* | |
3593 | * COEX_CU_RF_ON is the event wrapping all radio ownership. | |
3594 | * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network. | |
3595 | */ | |
3596 | #define COEX_CU_RF_ON_FLAGS \ | |
3597 | (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \ | |
3598 | COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \ | |
3599 | COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG) | |
3600 | ||
3601 | ||
9636e583 | 3602 | enum { |
fe1bcbfd | 3603 | /* un-association part */ |
9636e583 RR |
3604 | COEX_UNASSOC_IDLE = 0, |
3605 | COEX_UNASSOC_MANUAL_SCAN = 1, | |
3606 | COEX_UNASSOC_AUTO_SCAN = 2, | |
fe1bcbfd | 3607 | /* calibration */ |
9636e583 RR |
3608 | COEX_CALIBRATION = 3, |
3609 | COEX_PERIODIC_CALIBRATION = 4, | |
fe1bcbfd | 3610 | /* connection */ |
9636e583 | 3611 | COEX_CONNECTION_ESTAB = 5, |
fe1bcbfd | 3612 | /* association part */ |
9636e583 RR |
3613 | COEX_ASSOCIATED_IDLE = 6, |
3614 | COEX_ASSOC_MANUAL_SCAN = 7, | |
3615 | COEX_ASSOC_AUTO_SCAN = 8, | |
3616 | COEX_ASSOC_ACTIVE_LEVEL = 9, | |
fe1bcbfd | 3617 | /* RF ON/OFF */ |
9636e583 RR |
3618 | COEX_RF_ON = 10, |
3619 | COEX_RF_OFF = 11, | |
3620 | COEX_STAND_ALONE_DEBUG = 12, | |
fe1bcbfd | 3621 | /* IPAN */ |
9636e583 | 3622 | COEX_IPAN_ASSOC_LEVEL = 13, |
fe1bcbfd | 3623 | /* reserved */ |
9636e583 RR |
3624 | COEX_RSRVD1 = 14, |
3625 | COEX_RSRVD2 = 15, | |
3626 | COEX_NUM_OF_EVENTS = 16 | |
3627 | }; | |
3628 | ||
fe1bcbfd WYG |
3629 | /* |
3630 | * Coexistence WIFI/WIMAX Command | |
3631 | * COEX_PRIORITY_TABLE_CMD = 0x5a | |
3632 | * | |
3633 | */ | |
9636e583 RR |
3634 | struct iwl_wimax_coex_event_entry { |
3635 | u8 request_prio; | |
3636 | u8 win_medium_prio; | |
3637 | u8 reserved; | |
3638 | u8 flags; | |
3639 | } __attribute__ ((packed)); | |
3640 | ||
3641 | /* COEX flag masks */ | |
3642 | ||
a96a27f9 | 3643 | /* Station table is valid */ |
9636e583 | 3644 | #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1) |
a96a27f9 | 3645 | /* UnMask wake up src at unassociated sleep */ |
9636e583 | 3646 | #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4) |
a96a27f9 | 3647 | /* UnMask wake up src at associated sleep */ |
9636e583 RR |
3648 | #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8) |
3649 | /* Enable CoEx feature. */ | |
3650 | #define COEX_FLAGS_COEX_ENABLE_MSK (0x80) | |
3651 | ||
3652 | struct iwl_wimax_coex_cmd { | |
3653 | u8 flags; | |
3654 | u8 reserved[3]; | |
3655 | struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS]; | |
3656 | } __attribute__ ((packed)); | |
3657 | ||
fe1bcbfd WYG |
3658 | /* |
3659 | * Coexistence MEDIUM NOTIFICATION | |
3660 | * COEX_MEDIUM_NOTIFICATION = 0x5b | |
3661 | * | |
3662 | * notification from uCode to host to indicate medium changes | |
3663 | * | |
3664 | */ | |
3665 | /* | |
3666 | * status field | |
3667 | * bit 0 - 2: medium status | |
3668 | * bit 3: medium change indication | |
3669 | * bit 4 - 31: reserved | |
3670 | */ | |
3671 | /* status option values, (0 - 2 bits) */ | |
3672 | #define COEX_MEDIUM_BUSY (0x0) /* radio belongs to WiMAX */ | |
3673 | #define COEX_MEDIUM_ACTIVE (0x1) /* radio belongs to WiFi */ | |
3674 | #define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */ | |
3675 | #define COEX_MEDIUM_MSK (0x7) | |
3676 | ||
3677 | /* send notification status (1 bit) */ | |
3678 | #define COEX_MEDIUM_CHANGED (0x8) | |
3679 | #define COEX_MEDIUM_CHANGED_MSK (0x8) | |
3680 | #define COEX_MEDIUM_SHIFT (3) | |
3681 | ||
3682 | struct iwl_coex_medium_notification { | |
3683 | __le32 status; | |
3684 | __le32 events; | |
3685 | } __attribute__ ((packed)); | |
3686 | ||
3687 | /* | |
3688 | * Coexistence EVENT Command | |
3689 | * COEX_EVENT_CMD = 0x5c | |
3690 | * | |
3691 | * send from host to uCode for coex event request. | |
3692 | */ | |
3693 | /* flags options */ | |
3694 | #define COEX_EVENT_REQUEST_MSK (0x1) | |
3695 | ||
3696 | struct iwl_coex_event_cmd { | |
3697 | u8 flags; | |
3698 | u8 event; | |
3699 | __le16 reserved; | |
3700 | } __attribute__ ((packed)); | |
3701 | ||
3702 | struct iwl_coex_event_resp { | |
3703 | __le32 status; | |
3704 | } __attribute__ ((packed)); | |
3705 | ||
3706 | ||
b481de9c ZY |
3707 | /****************************************************************************** |
3708 | * (13) | |
3709 | * Union of all expected notifications/responses: | |
3710 | * | |
3711 | *****************************************************************************/ | |
3712 | ||
db11d634 | 3713 | struct iwl_rx_packet { |
2f301227 ZY |
3714 | /* |
3715 | * The first 4 bytes of the RX frame header contain both the RX frame | |
3716 | * size and some flags. | |
3717 | * Bit fields: | |
3718 | * 31: flag flush RB request | |
3719 | * 30: flag ignore TC (terminal counter) request | |
3720 | * 29: flag fast IRQ request | |
3721 | * 28-14: Reserved | |
3722 | * 13-00: RX frame size | |
3723 | */ | |
396887a2 | 3724 | __le32 len_n_flags; |
857485c0 | 3725 | struct iwl_cmd_header hdr; |
b481de9c | 3726 | union { |
3d24a9f7 TW |
3727 | struct iwl3945_rx_frame rx_frame; |
3728 | struct iwl3945_tx_resp tx_resp; | |
3729 | struct iwl3945_beacon_notif beacon_status; | |
3730 | ||
885ba202 | 3731 | struct iwl_alive_resp alive_frame; |
2aa6ab86 TW |
3732 | struct iwl_spectrum_notification spectrum_notif; |
3733 | struct iwl_csa_notification csa_notif; | |
885ba202 | 3734 | struct iwl_error_resp err_resp; |
2aa6ab86 | 3735 | struct iwl_card_state_notif card_state_notif; |
7a999bf0 TW |
3736 | struct iwl_add_sta_resp add_sta; |
3737 | struct iwl_rem_sta_resp rem_sta; | |
2aa6ab86 TW |
3738 | struct iwl_sleep_notification sleep_notif; |
3739 | struct iwl_spectrum_resp spectrum; | |
8f91aecb | 3740 | struct iwl_notif_statistics stats; |
653fa4a0 | 3741 | struct iwl_compressed_ba_resp compressed_ba; |
2aa6ab86 | 3742 | struct iwl_missed_beacon_notif missed_beacon; |
fe1bcbfd WYG |
3743 | struct iwl_coex_medium_notification coex_medium_notif; |
3744 | struct iwl_coex_event_resp coex_event; | |
b481de9c ZY |
3745 | __le32 status; |
3746 | u8 raw[0]; | |
3747 | } u; | |
3748 | } __attribute__ ((packed)); | |
3749 | ||
a3139c59 | 3750 | int iwl_agn_check_rxon_cmd(struct iwl_priv *priv); |
8f5c87dc | 3751 | |
6a63578d | 3752 | #endif /* __iwl_commands_h__ */ |