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 | * | |
eb7ae89c | 8 | * Copyright(c) 2005 - 2008 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: | |
28 | * James P. Ketrenos <ipw2100-admin@linux.intel.com> | |
29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 | |
30 | * | |
31 | * BSD LICENSE | |
32 | * | |
eb7ae89c | 33 | * Copyright(c) 2005 - 2008 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 BC |
63 | /* |
64 | * Please use this file (iwl-4965-commands.h) only for uCode API definitions. | |
65 | * Please use iwl-4965-hw.h for hardware-related definitions. | |
66 | * Please use iwl-4965.h for driver implementation definitions. | |
67 | */ | |
b481de9c | 68 | |
bb8c093b CH |
69 | #ifndef __iwl4965_commands_h__ |
70 | #define __iwl4965_commands_h__ | |
b481de9c ZY |
71 | |
72 | enum { | |
73 | REPLY_ALIVE = 0x1, | |
74 | REPLY_ERROR = 0x2, | |
75 | ||
76 | /* RXON and QOS commands */ | |
77 | REPLY_RXON = 0x10, | |
78 | REPLY_RXON_ASSOC = 0x11, | |
79 | REPLY_QOS_PARAM = 0x13, | |
80 | REPLY_RXON_TIMING = 0x14, | |
81 | ||
82 | /* Multi-Station support */ | |
83 | REPLY_ADD_STA = 0x18, | |
84 | REPLY_REMOVE_STA = 0x19, /* not used */ | |
85 | REPLY_REMOVE_ALL_STA = 0x1a, /* not used */ | |
86 | ||
0a0bed1d EG |
87 | /* Security */ |
88 | REPLY_WEPKEY = 0x20, | |
89 | ||
b481de9c | 90 | /* RX, TX, LEDs */ |
b481de9c ZY |
91 | REPLY_TX = 0x1c, |
92 | REPLY_RATE_SCALE = 0x47, /* 3945 only */ | |
93 | REPLY_LEDS_CMD = 0x48, | |
94 | REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */ | |
95 | ||
96 | /* 802.11h related */ | |
97 | RADAR_NOTIFICATION = 0x70, /* not used */ | |
98 | REPLY_QUIET_CMD = 0x71, /* not used */ | |
99 | REPLY_CHANNEL_SWITCH = 0x72, | |
100 | CHANNEL_SWITCH_NOTIFICATION = 0x73, | |
101 | REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74, | |
102 | SPECTRUM_MEASURE_NOTIFICATION = 0x75, | |
103 | ||
104 | /* Power Management */ | |
105 | POWER_TABLE_CMD = 0x77, | |
106 | PM_SLEEP_NOTIFICATION = 0x7A, | |
107 | PM_DEBUG_STATISTIC_NOTIFIC = 0x7B, | |
108 | ||
109 | /* Scan commands and notifications */ | |
110 | REPLY_SCAN_CMD = 0x80, | |
111 | REPLY_SCAN_ABORT_CMD = 0x81, | |
112 | SCAN_START_NOTIFICATION = 0x82, | |
113 | SCAN_RESULTS_NOTIFICATION = 0x83, | |
114 | SCAN_COMPLETE_NOTIFICATION = 0x84, | |
115 | ||
116 | /* IBSS/AP commands */ | |
117 | BEACON_NOTIFICATION = 0x90, | |
118 | REPLY_TX_BEACON = 0x91, | |
119 | WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */ | |
120 | ||
121 | /* Miscellaneous commands */ | |
122 | QUIET_NOTIFICATION = 0x96, /* not used */ | |
123 | REPLY_TX_PWR_TABLE_CMD = 0x97, | |
124 | MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */ | |
125 | ||
075416cd | 126 | /* Bluetooth device coexistance config command */ |
b481de9c ZY |
127 | REPLY_BT_CONFIG = 0x9b, |
128 | ||
80cc0c38 | 129 | /* Statistics */ |
b481de9c ZY |
130 | REPLY_STATISTICS_CMD = 0x9c, |
131 | STATISTICS_NOTIFICATION = 0x9d, | |
132 | ||
133 | /* RF-KILL commands and notifications */ | |
134 | REPLY_CARD_STATE_CMD = 0xa0, | |
135 | CARD_STATE_NOTIFICATION = 0xa1, | |
136 | ||
137 | /* Missed beacons notification */ | |
138 | MISSED_BEACONS_NOTIFICATION = 0xa2, | |
139 | ||
b481de9c ZY |
140 | REPLY_CT_KILL_CONFIG_CMD = 0xa4, |
141 | SENSITIVITY_CMD = 0xa8, | |
142 | REPLY_PHY_CALIBRATION_CMD = 0xb0, | |
143 | REPLY_RX_PHY_CMD = 0xc0, | |
144 | REPLY_RX_MPDU_CMD = 0xc1, | |
857485c0 | 145 | REPLY_RX = 0xc3, |
b481de9c | 146 | REPLY_COMPRESSED_BA = 0xc5, |
b481de9c ZY |
147 | REPLY_MAX = 0xff |
148 | }; | |
149 | ||
150 | /****************************************************************************** | |
151 | * (0) | |
abceddb4 | 152 | * Commonly used structures and definitions: |
80cc0c38 | 153 | * Command header, rate_n_flags, txpower |
b481de9c ZY |
154 | * |
155 | *****************************************************************************/ | |
156 | ||
857485c0 | 157 | /* iwl_cmd_header flags value */ |
b481de9c ZY |
158 | #define IWL_CMD_FAILED_MSK 0x40 |
159 | ||
075416cd | 160 | /** |
857485c0 | 161 | * struct iwl_cmd_header |
075416cd BC |
162 | * |
163 | * This header format appears in the beginning of each command sent from the | |
164 | * driver, and each response/notification received from uCode. | |
165 | */ | |
857485c0 | 166 | struct iwl_cmd_header { |
075416cd BC |
167 | u8 cmd; /* Command ID: REPLY_RXON, etc. */ |
168 | u8 flags; /* IWL_CMD_* */ | |
169 | /* | |
170 | * The driver sets up the sequence number to values of its chosing. | |
171 | * uCode does not use this value, but passes it back to the driver | |
172 | * when sending the response to each driver-originated command, so | |
173 | * the driver can match the response to the command. Since the values | |
174 | * don't get used by uCode, the driver may set up an arbitrary format. | |
b481de9c | 175 | * |
075416cd BC |
176 | * There is one exception: uCode sets bit 15 when it originates |
177 | * the response/notification, i.e. when the response/notification | |
178 | * is not a direct response to a command sent by the driver. For | |
179 | * example, uCode issues REPLY_3945_RX when it sends a received frame | |
180 | * to the driver; it is not a direct response to any driver command. | |
b481de9c | 181 | * |
075416cd BC |
182 | * The Linux driver uses the following format: |
183 | * | |
184 | * 0:7 index/position within Tx queue | |
185 | * 8:13 Tx queue selection | |
186 | * 14:14 driver sets this to indicate command is in the 'huge' | |
187 | * storage at the end of the command buffers, i.e. scan cmd | |
188 | * 15:15 uCode sets this in uCode-originated response/notification | |
b481de9c ZY |
189 | */ |
190 | __le16 sequence; | |
191 | ||
075416cd | 192 | /* command or response/notification data follows immediately */ |
b481de9c ZY |
193 | u8 data[0]; |
194 | } __attribute__ ((packed)); | |
195 | ||
abceddb4 BC |
196 | /** |
197 | * 4965 rate_n_flags bit fields | |
198 | * | |
199 | * rate_n_flags format is used in following 4965 commands: | |
857485c0 | 200 | * REPLY_RX (response only) |
abceddb4 BC |
201 | * REPLY_TX (both command and response) |
202 | * REPLY_TX_LINK_QUALITY_CMD | |
203 | * | |
204 | * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"): | |
205 | * 2-0: 0) 6 Mbps | |
206 | * 1) 12 Mbps | |
207 | * 2) 18 Mbps | |
208 | * 3) 24 Mbps | |
209 | * 4) 36 Mbps | |
210 | * 5) 48 Mbps | |
211 | * 6) 54 Mbps | |
212 | * 7) 60 Mbps | |
213 | * | |
214 | * 3: 0) Single stream (SISO) | |
215 | * 1) Dual stream (MIMO) | |
216 | * | |
217 | * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data | |
218 | * | |
219 | * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"): | |
220 | * 3-0: 0xD) 6 Mbps | |
221 | * 0xF) 9 Mbps | |
222 | * 0x5) 12 Mbps | |
223 | * 0x7) 18 Mbps | |
224 | * 0x9) 24 Mbps | |
225 | * 0xB) 36 Mbps | |
226 | * 0x1) 48 Mbps | |
227 | * 0x3) 54 Mbps | |
228 | * | |
229 | * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"): | |
230 | * 3-0: 10) 1 Mbps | |
231 | * 20) 2 Mbps | |
232 | * 55) 5.5 Mbps | |
233 | * 110) 11 Mbps | |
234 | */ | |
235 | #define RATE_MCS_CODE_MSK 0x7 | |
236 | #define RATE_MCS_MIMO_POS 3 | |
237 | #define RATE_MCS_MIMO_MSK 0x8 | |
238 | #define RATE_MCS_HT_DUP_POS 5 | |
239 | #define RATE_MCS_HT_DUP_MSK 0x20 | |
240 | ||
075416cd | 241 | /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */ |
abceddb4 BC |
242 | #define RATE_MCS_FLAGS_POS 8 |
243 | #define RATE_MCS_HT_POS 8 | |
244 | #define RATE_MCS_HT_MSK 0x100 | |
245 | ||
075416cd | 246 | /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ |
abceddb4 BC |
247 | #define RATE_MCS_CCK_POS 9 |
248 | #define RATE_MCS_CCK_MSK 0x200 | |
249 | ||
075416cd | 250 | /* Bit 10: (1) Use Green Field preamble */ |
abceddb4 BC |
251 | #define RATE_MCS_GF_POS 10 |
252 | #define RATE_MCS_GF_MSK 0x400 | |
253 | ||
075416cd | 254 | /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */ |
abceddb4 BC |
255 | #define RATE_MCS_FAT_POS 11 |
256 | #define RATE_MCS_FAT_MSK 0x800 | |
257 | ||
075416cd | 258 | /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */ |
abceddb4 BC |
259 | #define RATE_MCS_DUP_POS 12 |
260 | #define RATE_MCS_DUP_MSK 0x1000 | |
261 | ||
075416cd | 262 | /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ |
abceddb4 BC |
263 | #define RATE_MCS_SGI_POS 13 |
264 | #define RATE_MCS_SGI_MSK 0x2000 | |
265 | ||
266 | /** | |
267 | * rate_n_flags Tx antenna masks (4965 has 2 transmitters): | |
268 | * bit14:15 01 B inactive, A active | |
269 | * 10 B active, A inactive | |
270 | * 11 Both active | |
271 | */ | |
272 | #define RATE_MCS_ANT_A_POS 14 | |
273 | #define RATE_MCS_ANT_B_POS 15 | |
274 | #define RATE_MCS_ANT_A_MSK 0x4000 | |
275 | #define RATE_MCS_ANT_B_MSK 0x8000 | |
276 | #define RATE_MCS_ANT_AB_MSK 0xc000 | |
277 | ||
278 | ||
80cc0c38 BC |
279 | /** |
280 | * struct iwl4965_tx_power - txpower format used in REPLY_SCAN_CMD | |
281 | * | |
282 | * Scan uses only one transmitter, so only one analog/dsp gain pair is needed. | |
283 | */ | |
284 | struct iwl4965_tx_power { | |
285 | u8 tx_gain; /* gain for analog radio */ | |
286 | u8 dsp_atten; /* gain for DSP */ | |
287 | } __attribute__ ((packed)); | |
288 | ||
289 | #define POWER_TABLE_NUM_ENTRIES 33 | |
290 | #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32 | |
291 | #define POWER_TABLE_CCK_ENTRY 32 | |
292 | ||
293 | /** | |
294 | * union iwl4965_tx_power_dual_stream | |
295 | * | |
296 | * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
297 | * Use __le32 version (struct tx_power_dual_stream) when building command. | |
298 | * | |
299 | * Driver provides radio gain and DSP attenuation settings to device in pairs, | |
300 | * one value for each transmitter chain. The first value is for transmitter A, | |
301 | * second for transmitter B. | |
302 | * | |
303 | * For SISO bit rates, both values in a pair should be identical. | |
304 | * For MIMO rates, one value may be different from the other, | |
305 | * in order to balance the Tx output between the two transmitters. | |
306 | * | |
307 | * See more details in doc for TXPOWER in iwl-4965-hw.h. | |
308 | */ | |
309 | union iwl4965_tx_power_dual_stream { | |
310 | struct { | |
311 | u8 radio_tx_gain[2]; | |
312 | u8 dsp_predis_atten[2]; | |
313 | } s; | |
314 | u32 dw; | |
315 | }; | |
316 | ||
317 | /** | |
318 | * struct tx_power_dual_stream | |
319 | * | |
320 | * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
321 | * | |
322 | * Same format as iwl_tx_power_dual_stream, but __le32 | |
323 | */ | |
324 | struct tx_power_dual_stream { | |
325 | __le32 dw; | |
326 | } __attribute__ ((packed)); | |
327 | ||
328 | /** | |
329 | * struct iwl4965_tx_power_db | |
330 | * | |
331 | * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
332 | */ | |
333 | struct iwl4965_tx_power_db { | |
334 | struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES]; | |
335 | } __attribute__ ((packed)); | |
336 | ||
337 | ||
b481de9c ZY |
338 | /****************************************************************************** |
339 | * (0a) | |
340 | * Alive and Error Commands & Responses: | |
341 | * | |
342 | *****************************************************************************/ | |
343 | ||
344 | #define UCODE_VALID_OK __constant_cpu_to_le32(0x1) | |
345 | #define INITIALIZE_SUBTYPE (9) | |
346 | ||
347 | /* | |
075416cd BC |
348 | * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command) |
349 | * | |
350 | * uCode issues this "initialize alive" notification once the initialization | |
351 | * uCode image has completed its work, and is ready to load the runtime image. | |
352 | * This is the *first* "alive" notification that the driver will receive after | |
353 | * rebooting uCode; the "initialize" alive is indicated by subtype field == 9. | |
354 | * | |
355 | * See comments documenting "BSM" (bootstrap state machine). | |
356 | * | |
357 | * For 4965, this notification contains important calibration data for | |
358 | * calculating txpower settings: | |
359 | * | |
360 | * 1) Power supply voltage indication. The voltage sensor outputs higher | |
361 | * values for lower voltage, and vice versa. | |
362 | * | |
363 | * 2) Temperature measurement parameters, for each of two channel widths | |
364 | * (20 MHz and 40 MHz) supported by the radios. Temperature sensing | |
365 | * is done via one of the receiver chains, and channel width influences | |
366 | * the results. | |
367 | * | |
368 | * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation, | |
369 | * for each of 5 frequency ranges. | |
b481de9c | 370 | */ |
075416cd | 371 | struct iwl4965_init_alive_resp { |
b481de9c ZY |
372 | u8 ucode_minor; |
373 | u8 ucode_major; | |
374 | __le16 reserved1; | |
375 | u8 sw_rev[8]; | |
376 | u8 ver_type; | |
075416cd | 377 | u8 ver_subtype; /* "9" for initialize alive */ |
b481de9c ZY |
378 | __le16 reserved2; |
379 | __le32 log_event_table_ptr; | |
380 | __le32 error_event_table_ptr; | |
381 | __le32 timestamp; | |
382 | __le32 is_valid; | |
075416cd BC |
383 | |
384 | /* calibration values from "initialize" uCode */ | |
385 | __le32 voltage; /* signed, higher value is lower voltage */ | |
386 | __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/ | |
387 | __le32 therm_r2[2]; /* signed */ | |
388 | __le32 therm_r3[2]; /* signed */ | |
389 | __le32 therm_r4[2]; /* signed */ | |
390 | __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups, | |
391 | * 2 Tx chains */ | |
b481de9c ZY |
392 | } __attribute__ ((packed)); |
393 | ||
075416cd BC |
394 | |
395 | /** | |
396 | * REPLY_ALIVE = 0x1 (response only, not a command) | |
397 | * | |
398 | * uCode issues this "alive" notification once the runtime image is ready | |
399 | * to receive commands from the driver. This is the *second* "alive" | |
400 | * notification that the driver will receive after rebooting uCode; | |
401 | * this "alive" is indicated by subtype field != 9. | |
402 | * | |
403 | * See comments documenting "BSM" (bootstrap state machine). | |
404 | * | |
405 | * This response includes two pointers to structures within the device's | |
406 | * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging: | |
407 | * | |
408 | * 1) log_event_table_ptr indicates base of the event log. This traces | |
409 | * a 256-entry history of uCode execution within a circular buffer. | |
410 | * Its header format is: | |
411 | * | |
412 | * __le32 log_size; log capacity (in number of entries) | |
413 | * __le32 type; (1) timestamp with each entry, (0) no timestamp | |
414 | * __le32 wraps; # times uCode has wrapped to top of circular buffer | |
415 | * __le32 write_index; next circular buffer entry that uCode would fill | |
416 | * | |
417 | * The header is followed by the circular buffer of log entries. Entries | |
418 | * with timestamps have the following format: | |
419 | * | |
420 | * __le32 event_id; range 0 - 1500 | |
421 | * __le32 timestamp; low 32 bits of TSF (of network, if associated) | |
422 | * __le32 data; event_id-specific data value | |
423 | * | |
424 | * Entries without timestamps contain only event_id and data. | |
425 | * | |
426 | * 2) error_event_table_ptr indicates base of the error log. This contains | |
427 | * information about any uCode error that occurs. For 4965, the format | |
428 | * of the error log is: | |
429 | * | |
430 | * __le32 valid; (nonzero) valid, (0) log is empty | |
431 | * __le32 error_id; type of error | |
432 | * __le32 pc; program counter | |
433 | * __le32 blink1; branch link | |
434 | * __le32 blink2; branch link | |
435 | * __le32 ilink1; interrupt link | |
436 | * __le32 ilink2; interrupt link | |
437 | * __le32 data1; error-specific data | |
438 | * __le32 data2; error-specific data | |
439 | * __le32 line; source code line of error | |
440 | * __le32 bcon_time; beacon timer | |
441 | * __le32 tsf_low; network timestamp function timer | |
442 | * __le32 tsf_hi; network timestamp function timer | |
443 | * | |
444 | * The Linux driver can print both logs to the system log when a uCode error | |
445 | * occurs. | |
446 | */ | |
447 | struct iwl4965_alive_resp { | |
b481de9c ZY |
448 | u8 ucode_minor; |
449 | u8 ucode_major; | |
450 | __le16 reserved1; | |
451 | u8 sw_rev[8]; | |
452 | u8 ver_type; | |
075416cd | 453 | u8 ver_subtype; /* not "9" for runtime alive */ |
b481de9c | 454 | __le16 reserved2; |
075416cd BC |
455 | __le32 log_event_table_ptr; /* SRAM address for event log */ |
456 | __le32 error_event_table_ptr; /* SRAM address for error log */ | |
b481de9c ZY |
457 | __le32 timestamp; |
458 | __le32 is_valid; | |
b481de9c ZY |
459 | } __attribute__ ((packed)); |
460 | ||
075416cd | 461 | |
b481de9c ZY |
462 | union tsf { |
463 | u8 byte[8]; | |
464 | __le16 word[4]; | |
465 | __le32 dw[2]; | |
466 | }; | |
467 | ||
468 | /* | |
469 | * REPLY_ERROR = 0x2 (response only, not a command) | |
470 | */ | |
bb8c093b | 471 | struct iwl4965_error_resp { |
b481de9c ZY |
472 | __le32 error_type; |
473 | u8 cmd_id; | |
474 | u8 reserved1; | |
475 | __le16 bad_cmd_seq_num; | |
b481de9c ZY |
476 | __le32 error_info; |
477 | union tsf timestamp; | |
478 | } __attribute__ ((packed)); | |
479 | ||
480 | /****************************************************************************** | |
481 | * (1) | |
482 | * RXON Commands & Responses: | |
483 | * | |
484 | *****************************************************************************/ | |
485 | ||
486 | /* | |
487 | * Rx config defines & structure | |
488 | */ | |
489 | /* rx_config device types */ | |
490 | enum { | |
491 | RXON_DEV_TYPE_AP = 1, | |
492 | RXON_DEV_TYPE_ESS = 3, | |
493 | RXON_DEV_TYPE_IBSS = 4, | |
494 | RXON_DEV_TYPE_SNIFFER = 6, | |
495 | }; | |
496 | ||
14519a0b | 497 | |
8a1b0245 RC |
498 | #define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1 << 0) |
499 | #define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7 << 1) | |
14519a0b | 500 | #define RXON_RX_CHAIN_VALID_POS (1) |
8a1b0245 | 501 | #define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7 << 4) |
14519a0b | 502 | #define RXON_RX_CHAIN_FORCE_SEL_POS (4) |
8a1b0245 | 503 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7 << 7) |
14519a0b | 504 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7) |
8a1b0245 | 505 | #define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3 << 10) |
14519a0b | 506 | #define RXON_RX_CHAIN_CNT_POS (10) |
8a1b0245 | 507 | #define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3 << 12) |
14519a0b | 508 | #define RXON_RX_CHAIN_MIMO_CNT_POS (12) |
8a1b0245 | 509 | #define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1 << 14) |
14519a0b BC |
510 | #define RXON_RX_CHAIN_MIMO_FORCE_POS (14) |
511 | ||
b481de9c ZY |
512 | /* rx_config flags */ |
513 | /* band & modulation selection */ | |
514 | #define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0) | |
515 | #define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1) | |
516 | /* auto detection enable */ | |
517 | #define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2) | |
518 | /* TGg protection when tx */ | |
519 | #define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3) | |
520 | /* cck short slot & preamble */ | |
521 | #define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4) | |
522 | #define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5) | |
523 | /* antenna selection */ | |
524 | #define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7) | |
525 | #define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00) | |
526 | #define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8) | |
527 | #define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9) | |
528 | /* radar detection enable */ | |
529 | #define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12) | |
530 | #define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13) | |
531 | /* rx response to host with 8-byte TSF | |
532 | * (according to ON_AIR deassertion) */ | |
533 | #define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15) | |
534 | ||
14519a0b BC |
535 | |
536 | /* HT flags */ | |
537 | #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22) | |
8a1b0245 | 538 | #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1 << 22) |
14519a0b BC |
539 | |
540 | #define RXON_FLG_HT_OPERATING_MODE_POS (23) | |
541 | ||
8a1b0245 RC |
542 | #define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1 << 23) |
543 | #define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2 << 23) | |
14519a0b BC |
544 | |
545 | #define RXON_FLG_CHANNEL_MODE_POS (25) | |
8a1b0245 RC |
546 | #define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3 << 25) |
547 | #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1 << 25) | |
548 | #define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2 << 25) | |
14519a0b | 549 | |
b481de9c ZY |
550 | /* rx_config filter flags */ |
551 | /* accept all data frames */ | |
552 | #define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0) | |
553 | /* pass control & management to host */ | |
554 | #define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1) | |
555 | /* accept multi-cast */ | |
556 | #define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2) | |
557 | /* don't decrypt uni-cast frames */ | |
558 | #define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3) | |
559 | /* don't decrypt multi-cast frames */ | |
560 | #define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4) | |
561 | /* STA is associated */ | |
562 | #define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5) | |
563 | /* transfer to host non bssid beacons in associated state */ | |
564 | #define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6) | |
565 | ||
80cc0c38 | 566 | /** |
b481de9c | 567 | * REPLY_RXON = 0x10 (command, has simple generic response) |
80cc0c38 BC |
568 | * |
569 | * RXON tunes the radio tuner to a service channel, and sets up a number | |
570 | * of parameters that are used primarily for Rx, but also for Tx operations. | |
571 | * | |
572 | * NOTE: When tuning to a new channel, driver must set the | |
573 | * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent | |
574 | * info within the device, including the station tables, tx retry | |
575 | * rate tables, and txpower tables. Driver must build a new station | |
576 | * table and txpower table before transmitting anything on the RXON | |
577 | * channel. | |
578 | * | |
579 | * NOTE: All RXONs wipe clean the internal txpower table. Driver must | |
580 | * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10), | |
581 | * regardless of whether RXON_FILTER_ASSOC_MSK is set. | |
b481de9c | 582 | */ |
bb8c093b | 583 | struct iwl4965_rxon_cmd { |
b481de9c ZY |
584 | u8 node_addr[6]; |
585 | __le16 reserved1; | |
586 | u8 bssid_addr[6]; | |
587 | __le16 reserved2; | |
588 | u8 wlap_bssid_addr[6]; | |
589 | __le16 reserved3; | |
590 | u8 dev_type; | |
591 | u8 air_propagation; | |
b481de9c | 592 | __le16 rx_chain; |
b481de9c ZY |
593 | u8 ofdm_basic_rates; |
594 | u8 cck_basic_rates; | |
595 | __le16 assoc_id; | |
596 | __le32 flags; | |
597 | __le32 filter_flags; | |
598 | __le16 channel; | |
b481de9c ZY |
599 | u8 ofdm_ht_single_stream_basic_rates; |
600 | u8 ofdm_ht_dual_stream_basic_rates; | |
b481de9c ZY |
601 | } __attribute__ ((packed)); |
602 | ||
603 | /* | |
604 | * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response) | |
605 | */ | |
bb8c093b | 606 | struct iwl4965_rxon_assoc_cmd { |
b481de9c ZY |
607 | __le32 flags; |
608 | __le32 filter_flags; | |
609 | u8 ofdm_basic_rates; | |
610 | u8 cck_basic_rates; | |
b481de9c ZY |
611 | u8 ofdm_ht_single_stream_basic_rates; |
612 | u8 ofdm_ht_dual_stream_basic_rates; | |
613 | __le16 rx_chain_select_flags; | |
b481de9c ZY |
614 | __le16 reserved; |
615 | } __attribute__ ((packed)); | |
616 | ||
617 | /* | |
618 | * REPLY_RXON_TIMING = 0x14 (command, has simple generic response) | |
619 | */ | |
bb8c093b | 620 | struct iwl4965_rxon_time_cmd { |
b481de9c ZY |
621 | union tsf timestamp; |
622 | __le16 beacon_interval; | |
623 | __le16 atim_window; | |
624 | __le32 beacon_init_val; | |
625 | __le16 listen_interval; | |
626 | __le16 reserved; | |
627 | } __attribute__ ((packed)); | |
628 | ||
b481de9c ZY |
629 | /* |
630 | * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response) | |
631 | */ | |
bb8c093b | 632 | struct iwl4965_channel_switch_cmd { |
b481de9c ZY |
633 | u8 band; |
634 | u8 expect_beacon; | |
635 | __le16 channel; | |
636 | __le32 rxon_flags; | |
637 | __le32 rxon_filter_flags; | |
638 | __le32 switch_time; | |
bb8c093b | 639 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
640 | } __attribute__ ((packed)); |
641 | ||
642 | /* | |
643 | * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command) | |
644 | */ | |
bb8c093b | 645 | struct iwl4965_csa_notification { |
b481de9c ZY |
646 | __le16 band; |
647 | __le16 channel; | |
648 | __le32 status; /* 0 - OK, 1 - fail */ | |
649 | } __attribute__ ((packed)); | |
650 | ||
651 | /****************************************************************************** | |
652 | * (2) | |
653 | * Quality-of-Service (QOS) Commands & Responses: | |
654 | * | |
655 | *****************************************************************************/ | |
2054a00b BC |
656 | |
657 | /** | |
658 | * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM | |
659 | * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd | |
660 | * | |
661 | * @cw_min: Contention window, start value in numbers of slots. | |
662 | * Should be a power-of-2, minus 1. Device's default is 0x0f. | |
663 | * @cw_max: Contention window, max value in numbers of slots. | |
664 | * Should be a power-of-2, minus 1. Device's default is 0x3f. | |
665 | * @aifsn: Number of slots in Arbitration Interframe Space (before | |
666 | * performing random backoff timing prior to Tx). Device default 1. | |
667 | * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0. | |
668 | * | |
669 | * Device will automatically increase contention window by (2*CW) + 1 for each | |
670 | * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW | |
671 | * value, to cap the CW value. | |
672 | */ | |
bb8c093b | 673 | struct iwl4965_ac_qos { |
b481de9c ZY |
674 | __le16 cw_min; |
675 | __le16 cw_max; | |
676 | u8 aifsn; | |
677 | u8 reserved1; | |
678 | __le16 edca_txop; | |
679 | } __attribute__ ((packed)); | |
680 | ||
681 | /* QoS flags defines */ | |
682 | #define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01) | |
683 | #define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02) | |
684 | #define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10) | |
685 | ||
2054a00b | 686 | /* Number of Access Categories (AC) (EDCA), queues 0..3 */ |
b481de9c ZY |
687 | #define AC_NUM 4 |
688 | ||
689 | /* | |
690 | * REPLY_QOS_PARAM = 0x13 (command, has simple generic response) | |
2054a00b BC |
691 | * |
692 | * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs | |
693 | * 0: Background, 1: Best Effort, 2: Video, 3: Voice. | |
b481de9c | 694 | */ |
bb8c093b | 695 | struct iwl4965_qosparam_cmd { |
b481de9c | 696 | __le32 qos_flags; |
bb8c093b | 697 | struct iwl4965_ac_qos ac[AC_NUM]; |
b481de9c ZY |
698 | } __attribute__ ((packed)); |
699 | ||
700 | /****************************************************************************** | |
701 | * (3) | |
702 | * Add/Modify Stations Commands & Responses: | |
703 | * | |
704 | *****************************************************************************/ | |
705 | /* | |
706 | * Multi station support | |
707 | */ | |
2054a00b BC |
708 | |
709 | /* Special, dedicated locations within device's station table */ | |
b481de9c ZY |
710 | #define IWL_AP_ID 0 |
711 | #define IWL_MULTICAST_ID 1 | |
712 | #define IWL_STA_ID 2 | |
b481de9c ZY |
713 | #define IWL4965_BROADCAST_ID 31 |
714 | #define IWL4965_STATION_COUNT 32 | |
715 | ||
716 | #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/ | |
717 | #define IWL_INVALID_STATION 255 | |
718 | ||
8a1b0245 | 719 | #define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1 << 8); |
74093ddf BC |
720 | #define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17) |
721 | #define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18) | |
722 | #define STA_FLG_MAX_AGG_SIZE_POS (19) | |
723 | #define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19) | |
724 | #define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21) | |
725 | #define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22) | |
726 | #define STA_FLG_AGG_MPDU_DENSITY_POS (23) | |
727 | #define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23) | |
b481de9c | 728 | |
2054a00b | 729 | /* Use in mode field. 1: modify existing entry, 0: add new station entry */ |
b481de9c ZY |
730 | #define STA_CONTROL_MODIFY_MSK 0x01 |
731 | ||
732 | /* key flags __le16*/ | |
eaaf7894 EG |
733 | #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x0007) |
734 | #define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0000) | |
735 | #define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x0001) | |
736 | #define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x0002) | |
737 | #define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x0003) | |
b481de9c ZY |
738 | |
739 | #define STA_KEY_FLG_KEYID_POS 8 | |
740 | #define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800) | |
eaaf7894 EG |
741 | /* wep key is either from global key (0) or from station info array (1) */ |
742 | #define STA_KEY_FLG_MAP_KEY_MSK __constant_cpu_to_le16(0x0008) | |
743 | ||
744 | /* wep key in STA: 5-bytes (0) or 13-bytes (1) */ | |
745 | #define STA_KEY_FLG_KEY_SIZE_MSK __constant_cpu_to_le16(0x1000) | |
746 | #define STA_KEY_MULTICAST_MSK __constant_cpu_to_le16(0x4000) | |
deb09c43 | 747 | #define STA_KEY_MAX_NUM 8 |
b481de9c | 748 | |
2054a00b | 749 | /* Flags indicate whether to modify vs. don't change various station params */ |
b481de9c ZY |
750 | #define STA_MODIFY_KEY_MASK 0x01 |
751 | #define STA_MODIFY_TID_DISABLE_TX 0x02 | |
752 | #define STA_MODIFY_TX_RATE_MSK 0x04 | |
753 | #define STA_MODIFY_ADDBA_TID_MSK 0x08 | |
754 | #define STA_MODIFY_DELBA_TID_MSK 0x10 | |
2054a00b BC |
755 | |
756 | /* Receiver address (actually, Rx station's index into station table), | |
757 | * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */ | |
b481de9c ZY |
758 | #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid)) |
759 | ||
bb8c093b | 760 | struct iwl4965_keyinfo { |
b481de9c ZY |
761 | __le16 key_flags; |
762 | u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */ | |
763 | u8 reserved1; | |
764 | __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */ | |
eaaf7894 EG |
765 | u8 key_offset; |
766 | u8 reserved2; | |
b481de9c ZY |
767 | u8 key[16]; /* 16-byte unicast decryption key */ |
768 | } __attribute__ ((packed)); | |
769 | ||
2054a00b BC |
770 | /** |
771 | * struct sta_id_modify | |
772 | * @addr[ETH_ALEN]: station's MAC address | |
773 | * @sta_id: index of station in uCode's station table | |
774 | * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change | |
775 | * | |
776 | * Driver selects unused table index when adding new station, | |
777 | * or the index to a pre-existing station entry when modifying that station. | |
778 | * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP). | |
779 | * | |
780 | * modify_mask flags select which parameters to modify vs. leave alone. | |
781 | */ | |
b481de9c ZY |
782 | struct sta_id_modify { |
783 | u8 addr[ETH_ALEN]; | |
784 | __le16 reserved1; | |
785 | u8 sta_id; | |
786 | u8 modify_mask; | |
787 | __le16 reserved2; | |
788 | } __attribute__ ((packed)); | |
789 | ||
790 | /* | |
791 | * REPLY_ADD_STA = 0x18 (command) | |
2054a00b BC |
792 | * |
793 | * The device contains an internal table of per-station information, | |
794 | * with info on security keys, aggregation parameters, and Tx rates for | |
795 | * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD, | |
796 | * 3945 uses REPLY_RATE_SCALE to set up rate tables). | |
797 | * | |
798 | * REPLY_ADD_STA sets up the table entry for one station, either creating | |
799 | * a new entry, or modifying a pre-existing one. | |
800 | * | |
801 | * NOTE: RXON command (without "associated" bit set) wipes the station table | |
802 | * clean. Moving into RF_KILL state does this also. Driver must set up | |
803 | * new station table before transmitting anything on the RXON channel | |
804 | * (except active scans or active measurements; those commands carry | |
805 | * their own txpower/rate setup data). | |
806 | * | |
807 | * When getting started on a new channel, driver must set up the | |
808 | * IWL_BROADCAST_ID entry (last entry in the table). For a client | |
809 | * station in a BSS, once an AP is selected, driver sets up the AP STA | |
810 | * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP | |
811 | * are all that are needed for a BSS client station. If the device is | |
812 | * used as AP, or in an IBSS network, driver must set up station table | |
813 | * entries for all STAs in network, starting with index IWL_STA_ID. | |
b481de9c | 814 | */ |
bb8c093b | 815 | struct iwl4965_addsta_cmd { |
2054a00b | 816 | u8 mode; /* 1: modify existing, 0: add new station */ |
b481de9c ZY |
817 | u8 reserved[3]; |
818 | struct sta_id_modify sta; | |
bb8c093b | 819 | struct iwl4965_keyinfo key; |
2054a00b BC |
820 | __le32 station_flags; /* STA_FLG_* */ |
821 | __le32 station_flags_msk; /* STA_FLG_* */ | |
822 | ||
823 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) | |
824 | * corresponding to bit (e.g. bit 5 controls TID 5). | |
825 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ | |
b481de9c | 826 | __le16 tid_disable_tx; |
2054a00b | 827 | |
b481de9c | 828 | __le16 reserved1; |
2054a00b BC |
829 | |
830 | /* TID for which to add block-ack support. | |
831 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
b481de9c | 832 | u8 add_immediate_ba_tid; |
2054a00b BC |
833 | |
834 | /* TID for which to remove block-ack support. | |
835 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ | |
b481de9c | 836 | u8 remove_immediate_ba_tid; |
2054a00b BC |
837 | |
838 | /* Starting Sequence Number for added block-ack support. | |
839 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ | |
b481de9c | 840 | __le16 add_immediate_ba_ssn; |
2054a00b | 841 | |
b481de9c | 842 | __le32 reserved2; |
b481de9c ZY |
843 | } __attribute__ ((packed)); |
844 | ||
2054a00b BC |
845 | #define ADD_STA_SUCCESS_MSK 0x1 |
846 | #define ADD_STA_NO_ROOM_IN_TABLE 0x2 | |
847 | #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4 | |
848 | #define ADD_STA_MODIFY_NON_EXIST_STA 0x8 | |
b481de9c ZY |
849 | /* |
850 | * REPLY_ADD_STA = 0x18 (response) | |
851 | */ | |
bb8c093b | 852 | struct iwl4965_add_sta_resp { |
2054a00b | 853 | u8 status; /* ADD_STA_* */ |
b481de9c ZY |
854 | } __attribute__ ((packed)); |
855 | ||
0a0bed1d EG |
856 | /* |
857 | * REPLY_WEP_KEY = 0x20 | |
858 | */ | |
859 | struct iwl_wep_key { | |
860 | u8 key_index; | |
861 | u8 key_offset; | |
862 | u8 reserved1[2]; | |
863 | u8 key_size; | |
864 | u8 reserved2[3]; | |
865 | u8 key[16]; | |
866 | } __attribute__ ((packed)); | |
867 | ||
868 | struct iwl_wep_cmd { | |
869 | u8 num_keys; | |
870 | u8 global_key_type; | |
871 | u8 flags; | |
872 | u8 reserved; | |
873 | struct iwl_wep_key key[0]; | |
874 | } __attribute__ ((packed)); | |
875 | ||
876 | #define WEP_KEY_WEP_TYPE 1 | |
877 | #define WEP_KEYS_MAX 4 | |
878 | #define WEP_INVALID_OFFSET 0xff | |
879 | #define WEP_KEY_LEN_128 13 | |
b481de9c ZY |
880 | |
881 | /****************************************************************************** | |
882 | * (4) | |
883 | * Rx Responses: | |
884 | * | |
885 | *****************************************************************************/ | |
886 | ||
bb8c093b | 887 | struct iwl4965_rx_frame_stats { |
b481de9c ZY |
888 | u8 phy_count; |
889 | u8 id; | |
890 | u8 rssi; | |
891 | u8 agc; | |
892 | __le16 sig_avg; | |
893 | __le16 noise_diff; | |
894 | u8 payload[0]; | |
895 | } __attribute__ ((packed)); | |
896 | ||
bb8c093b | 897 | struct iwl4965_rx_frame_hdr { |
b481de9c ZY |
898 | __le16 channel; |
899 | __le16 phy_flags; | |
900 | u8 reserved1; | |
901 | u8 rate; | |
902 | __le16 len; | |
903 | u8 payload[0]; | |
904 | } __attribute__ ((packed)); | |
905 | ||
8211ef78 TW |
906 | #define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0) |
907 | #define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1) | |
908 | ||
909 | #define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0) | |
910 | #define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1) | |
911 | #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2) | |
912 | #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3) | |
913 | #define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0) | |
914 | ||
915 | #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8) | |
916 | #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8) | |
917 | #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8) | |
918 | #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8) | |
919 | #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8) | |
17e476b8 EG |
920 | #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8) |
921 | ||
922 | #define RX_RES_STATUS_STATION_FOUND (1<<6) | |
923 | #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7) | |
8211ef78 TW |
924 | |
925 | #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11) | |
926 | #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11) | |
927 | #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11) | |
928 | #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11) | |
929 | #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11) | |
b481de9c | 930 | |
17e476b8 EG |
931 | #define RX_MPDU_RES_STATUS_ICV_OK (0x20) |
932 | #define RX_MPDU_RES_STATUS_MIC_OK (0x40) | |
933 | #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7) | |
934 | #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800) | |
935 | ||
bb8c093b | 936 | struct iwl4965_rx_frame_end { |
b481de9c ZY |
937 | __le32 status; |
938 | __le64 timestamp; | |
939 | __le32 beacon_timestamp; | |
940 | } __attribute__ ((packed)); | |
941 | ||
942 | /* | |
943 | * REPLY_3945_RX = 0x1b (response only, not a command) | |
944 | * | |
945 | * NOTE: DO NOT dereference from casts to this structure | |
946 | * It is provided only for calculating minimum data set size. | |
947 | * The actual offsets of the hdr and end are dynamic based on | |
948 | * stats.phy_count | |
949 | */ | |
bb8c093b CH |
950 | struct iwl4965_rx_frame { |
951 | struct iwl4965_rx_frame_stats stats; | |
952 | struct iwl4965_rx_frame_hdr hdr; | |
953 | struct iwl4965_rx_frame_end end; | |
b481de9c ZY |
954 | } __attribute__ ((packed)); |
955 | ||
956 | /* Fixed (non-configurable) rx data from phy */ | |
957 | #define RX_PHY_FLAGS_ANTENNAE_OFFSET (4) | |
958 | #define RX_PHY_FLAGS_ANTENNAE_MASK (0x70) | |
959 | #define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */ | |
960 | #define IWL_AGC_DB_POS (7) | |
961 | struct iwl4965_rx_non_cfg_phy { | |
962 | __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */ | |
963 | __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */ | |
964 | u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */ | |
965 | u8 pad[0]; | |
966 | } __attribute__ ((packed)); | |
967 | ||
968 | /* | |
857485c0 | 969 | * REPLY_RX = 0xc3 (response only, not a command) |
b481de9c ZY |
970 | * Used only for legacy (non 11n) frames. |
971 | */ | |
972 | #define RX_RES_PHY_CNT 14 | |
973 | struct iwl4965_rx_phy_res { | |
974 | u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */ | |
975 | u8 cfg_phy_cnt; /* configurable DSP phy data byte count */ | |
976 | u8 stat_id; /* configurable DSP phy data set ID */ | |
977 | u8 reserved1; | |
978 | __le64 timestamp; /* TSF at on air rise */ | |
979 | __le32 beacon_time_stamp; /* beacon at on-air rise */ | |
980 | __le16 phy_flags; /* general phy flags: band, modulation, ... */ | |
981 | __le16 channel; /* channel number */ | |
982 | __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */ | |
983 | __le32 reserved2; | |
52969981 BC |
984 | __le32 rate_n_flags; /* RATE_MCS_* */ |
985 | __le16 byte_count; /* frame's byte-count */ | |
b481de9c ZY |
986 | __le16 reserved3; |
987 | } __attribute__ ((packed)); | |
988 | ||
989 | struct iwl4965_rx_mpdu_res_start { | |
990 | __le16 byte_count; | |
991 | __le16 reserved; | |
992 | } __attribute__ ((packed)); | |
993 | ||
994 | ||
995 | /****************************************************************************** | |
996 | * (5) | |
997 | * Tx Commands & Responses: | |
998 | * | |
52969981 BC |
999 | * Driver must place each REPLY_TX command into one of the prioritized Tx |
1000 | * queues in host DRAM, shared between driver and device (see comments for | |
1001 | * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode | |
1002 | * are preparing to transmit, the device pulls the Tx command over the PCI | |
1003 | * bus via one of the device's Tx DMA channels, to fill an internal FIFO | |
1004 | * from which data will be transmitted. | |
1005 | * | |
1006 | * uCode handles all timing and protocol related to control frames | |
1007 | * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler | |
1008 | * handle reception of block-acks; uCode updates the host driver via | |
1009 | * REPLY_COMPRESSED_BA (4965). | |
1010 | * | |
1011 | * uCode handles retrying Tx when an ACK is expected but not received. | |
1012 | * This includes trying lower data rates than the one requested in the Tx | |
1013 | * command, as set up by the REPLY_RATE_SCALE (for 3945) or | |
1014 | * REPLY_TX_LINK_QUALITY_CMD (4965). | |
1015 | * | |
1016 | * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD. | |
1017 | * This command must be executed after every RXON command, before Tx can occur. | |
b481de9c ZY |
1018 | *****************************************************************************/ |
1019 | ||
52969981 BC |
1020 | /* REPLY_TX Tx flags field */ |
1021 | ||
1022 | /* 1: Use Request-To-Send protocol before this frame. | |
1023 | * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */ | |
b481de9c | 1024 | #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1) |
52969981 BC |
1025 | |
1026 | /* 1: Transmit Clear-To-Send to self before this frame. | |
1027 | * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames. | |
1028 | * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */ | |
b481de9c | 1029 | #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2) |
52969981 BC |
1030 | |
1031 | /* 1: Expect ACK from receiving station | |
1032 | * 0: Don't expect ACK (MAC header's duration field s/b 0) | |
1033 | * Set this for unicast frames, but not broadcast/multicast. */ | |
b481de9c | 1034 | #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3) |
52969981 BC |
1035 | |
1036 | /* For 4965: | |
1037 | * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD). | |
1038 | * Tx command's initial_rate_index indicates first rate to try; | |
1039 | * uCode walks through table for additional Tx attempts. | |
1040 | * 0: Use Tx rate/MCS from Tx command's rate_n_flags field. | |
1041 | * This rate will be used for all Tx attempts; it will not be scaled. */ | |
b481de9c | 1042 | #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4) |
52969981 BC |
1043 | |
1044 | /* 1: Expect immediate block-ack. | |
1045 | * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */ | |
b481de9c | 1046 | #define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6) |
52969981 BC |
1047 | |
1048 | /* 1: Frame requires full Tx-Op protection. | |
1049 | * Set this if either RTS or CTS Tx Flag gets set. */ | |
b481de9c | 1050 | #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7) |
52969981 BC |
1051 | |
1052 | /* Tx antenna selection field; used only for 3945, reserved (0) for 4965. | |
1053 | * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */ | |
b481de9c ZY |
1054 | #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00) |
1055 | #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8) | |
1056 | #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9) | |
1057 | ||
52969981 BC |
1058 | /* 1: Ignore Bluetooth priority for this frame. |
1059 | * 0: Delay Tx until Bluetooth device is done (normal usage). */ | |
b481de9c ZY |
1060 | #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12) |
1061 | ||
52969981 BC |
1062 | /* 1: uCode overrides sequence control field in MAC header. |
1063 | * 0: Driver provides sequence control field in MAC header. | |
1064 | * Set this for management frames, non-QOS data frames, non-unicast frames, | |
1065 | * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */ | |
b481de9c ZY |
1066 | #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13) |
1067 | ||
52969981 BC |
1068 | /* 1: This frame is non-last MPDU; more fragments are coming. |
1069 | * 0: Last fragment, or not using fragmentation. */ | |
b481de9c ZY |
1070 | #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14) |
1071 | ||
52969981 BC |
1072 | /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame. |
1073 | * 0: No TSF required in outgoing frame. | |
1074 | * Set this for transmitting beacons and probe responses. */ | |
b481de9c ZY |
1075 | #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16) |
1076 | ||
52969981 BC |
1077 | /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword |
1078 | * alignment of frame's payload data field. | |
1079 | * 0: No pad | |
1080 | * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4 | |
1081 | * field (but not both). Driver must align frame data (i.e. data following | |
1082 | * MAC header) to DWORD boundary. */ | |
b481de9c ZY |
1083 | #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20) |
1084 | ||
8236e183 MS |
1085 | /* accelerate aggregation support |
1086 | * 0 - no CCMP encryption; 1 - CCMP encryption */ | |
1087 | #define TX_CMD_FLG_AGG_CCMP_MSK __constant_cpu_to_le32(1 << 22) | |
1088 | ||
b481de9c ZY |
1089 | /* HCCA-AP - disable duration overwriting. */ |
1090 | #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25) | |
1091 | ||
52969981 | 1092 | |
b481de9c ZY |
1093 | /* |
1094 | * TX command security control | |
1095 | */ | |
1096 | #define TX_CMD_SEC_WEP 0x01 | |
1097 | #define TX_CMD_SEC_CCM 0x02 | |
1098 | #define TX_CMD_SEC_TKIP 0x03 | |
1099 | #define TX_CMD_SEC_MSK 0x03 | |
1100 | #define TX_CMD_SEC_SHIFT 6 | |
1101 | #define TX_CMD_SEC_KEY128 0x08 | |
1102 | ||
1103 | /* | |
52969981 BC |
1104 | * 4965 uCode updates these Tx attempt count values in host DRAM. |
1105 | * Used for managing Tx retries when expecting block-acks. | |
1106 | * Driver should set these fields to 0. | |
b481de9c | 1107 | */ |
bb8c093b | 1108 | struct iwl4965_dram_scratch { |
52969981 BC |
1109 | u8 try_cnt; /* Tx attempts */ |
1110 | u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */ | |
b481de9c ZY |
1111 | __le16 reserved; |
1112 | } __attribute__ ((packed)); | |
1113 | ||
1114 | /* | |
1115 | * REPLY_TX = 0x1c (command) | |
1116 | */ | |
bb8c093b | 1117 | struct iwl4965_tx_cmd { |
52969981 BC |
1118 | /* |
1119 | * MPDU byte count: | |
1120 | * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size, | |
1121 | * + 8 byte IV for CCM or TKIP (not used for WEP) | |
1122 | * + Data payload | |
1123 | * + 8-byte MIC (not used for CCM/WEP) | |
1124 | * NOTE: Does not include Tx command bytes, post-MAC pad bytes, | |
1125 | * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i | |
1126 | * Range: 14-2342 bytes. | |
1127 | */ | |
b481de9c | 1128 | __le16 len; |
52969981 BC |
1129 | |
1130 | /* | |
1131 | * MPDU or MSDU byte count for next frame. | |
1132 | * Used for fragmentation and bursting, but not 11n aggregation. | |
1133 | * Same as "len", but for next frame. Set to 0 if not applicable. | |
1134 | */ | |
b481de9c | 1135 | __le16 next_frame_len; |
52969981 BC |
1136 | |
1137 | __le32 tx_flags; /* TX_CMD_FLG_* */ | |
1138 | ||
1139 | /* 4965's uCode may modify this field of the Tx command (in host DRAM!). | |
1140 | * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */ | |
bb8c093b | 1141 | struct iwl4965_dram_scratch scratch; |
52969981 BC |
1142 | |
1143 | /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */ | |
1144 | __le32 rate_n_flags; /* RATE_MCS_* */ | |
1145 | ||
1146 | /* Index of destination station in uCode's station table */ | |
b481de9c | 1147 | u8 sta_id; |
52969981 BC |
1148 | |
1149 | /* Type of security encryption: CCM or TKIP */ | |
1150 | u8 sec_ctl; /* TX_CMD_SEC_* */ | |
1151 | ||
1152 | /* | |
1153 | * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial | |
1154 | * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for | |
1155 | * data frames, this field may be used to selectively reduce initial | |
1156 | * rate (via non-0 value) for special frames (e.g. management), while | |
1157 | * still supporting rate scaling for all frames. | |
1158 | */ | |
b481de9c ZY |
1159 | u8 initial_rate_index; |
1160 | u8 reserved; | |
b481de9c | 1161 | u8 key[16]; |
b481de9c ZY |
1162 | __le16 next_frame_flags; |
1163 | __le16 reserved2; | |
b481de9c ZY |
1164 | union { |
1165 | __le32 life_time; | |
1166 | __le32 attempt; | |
1167 | } stop_time; | |
52969981 BC |
1168 | |
1169 | /* Host DRAM physical address pointer to "scratch" in this command. | |
1170 | * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */ | |
b481de9c ZY |
1171 | __le32 dram_lsb_ptr; |
1172 | u8 dram_msb_ptr; | |
52969981 | 1173 | |
b481de9c ZY |
1174 | u8 rts_retry_limit; /*byte 50 */ |
1175 | u8 data_retry_limit; /*byte 51 */ | |
b481de9c | 1176 | u8 tid_tspec; |
b481de9c ZY |
1177 | union { |
1178 | __le16 pm_frame_timeout; | |
1179 | __le16 attempt_duration; | |
1180 | } timeout; | |
52969981 BC |
1181 | |
1182 | /* | |
1183 | * Duration of EDCA burst Tx Opportunity, in 32-usec units. | |
1184 | * Set this if txop time is not specified by HCCA protocol (e.g. by AP). | |
1185 | */ | |
b481de9c | 1186 | __le16 driver_txop; |
52969981 BC |
1187 | |
1188 | /* | |
1189 | * MAC header goes here, followed by 2 bytes padding if MAC header | |
1190 | * length is 26 or 30 bytes, followed by payload data | |
1191 | */ | |
b481de9c ZY |
1192 | u8 payload[0]; |
1193 | struct ieee80211_hdr hdr[0]; | |
1194 | } __attribute__ ((packed)); | |
1195 | ||
1196 | /* TX command response is sent after *all* transmission attempts. | |
1197 | * | |
1198 | * NOTES: | |
1199 | * | |
1200 | * TX_STATUS_FAIL_NEXT_FRAG | |
1201 | * | |
1202 | * If the fragment flag in the MAC header for the frame being transmitted | |
1203 | * is set and there is insufficient time to transmit the next frame, the | |
1204 | * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'. | |
1205 | * | |
1206 | * TX_STATUS_FIFO_UNDERRUN | |
1207 | * | |
1208 | * Indicates the host did not provide bytes to the FIFO fast enough while | |
1209 | * a TX was in progress. | |
1210 | * | |
1211 | * TX_STATUS_FAIL_MGMNT_ABORT | |
1212 | * | |
1213 | * This status is only possible if the ABORT ON MGMT RX parameter was | |
1214 | * set to true with the TX command. | |
1215 | * | |
1216 | * If the MSB of the status parameter is set then an abort sequence is | |
1217 | * required. This sequence consists of the host activating the TX Abort | |
1218 | * control line, and then waiting for the TX Abort command response. This | |
1219 | * indicates that a the device is no longer in a transmit state, and that the | |
1220 | * command FIFO has been cleared. The host must then deactivate the TX Abort | |
1221 | * control line. Receiving is still allowed in this case. | |
1222 | */ | |
1223 | enum { | |
1224 | TX_STATUS_SUCCESS = 0x01, | |
1225 | TX_STATUS_DIRECT_DONE = 0x02, | |
1226 | TX_STATUS_FAIL_SHORT_LIMIT = 0x82, | |
1227 | TX_STATUS_FAIL_LONG_LIMIT = 0x83, | |
1228 | TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84, | |
1229 | TX_STATUS_FAIL_MGMNT_ABORT = 0x85, | |
1230 | TX_STATUS_FAIL_NEXT_FRAG = 0x86, | |
1231 | TX_STATUS_FAIL_LIFE_EXPIRE = 0x87, | |
1232 | TX_STATUS_FAIL_DEST_PS = 0x88, | |
1233 | TX_STATUS_FAIL_ABORTED = 0x89, | |
1234 | TX_STATUS_FAIL_BT_RETRY = 0x8a, | |
1235 | TX_STATUS_FAIL_STA_INVALID = 0x8b, | |
1236 | TX_STATUS_FAIL_FRAG_DROPPED = 0x8c, | |
1237 | TX_STATUS_FAIL_TID_DISABLE = 0x8d, | |
1238 | TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e, | |
1239 | TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f, | |
1240 | TX_STATUS_FAIL_TX_LOCKED = 0x90, | |
1241 | TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91, | |
1242 | }; | |
1243 | ||
1244 | #define TX_PACKET_MODE_REGULAR 0x0000 | |
1245 | #define TX_PACKET_MODE_BURST_SEQ 0x0100 | |
1246 | #define TX_PACKET_MODE_BURST_FIRST 0x0200 | |
1247 | ||
1248 | enum { | |
1249 | TX_POWER_PA_NOT_ACTIVE = 0x0, | |
1250 | }; | |
1251 | ||
1252 | enum { | |
1253 | TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */ | |
1254 | TX_STATUS_DELAY_MSK = 0x00000040, | |
1255 | TX_STATUS_ABORT_MSK = 0x00000080, | |
1256 | TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */ | |
1257 | TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */ | |
1258 | TX_RESERVED = 0x00780000, /* bits 19:22 */ | |
1259 | TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */ | |
1260 | TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */ | |
1261 | }; | |
1262 | ||
1263 | /* ******************************* | |
52969981 | 1264 | * TX aggregation status |
b481de9c ZY |
1265 | ******************************* */ |
1266 | ||
1267 | enum { | |
1268 | AGG_TX_STATE_TRANSMITTED = 0x00, | |
1269 | AGG_TX_STATE_UNDERRUN_MSK = 0x01, | |
1270 | AGG_TX_STATE_BT_PRIO_MSK = 0x02, | |
1271 | AGG_TX_STATE_FEW_BYTES_MSK = 0x04, | |
1272 | AGG_TX_STATE_ABORT_MSK = 0x08, | |
1273 | AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10, | |
1274 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20, | |
1275 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40, | |
1276 | AGG_TX_STATE_SCD_QUERY_MSK = 0x80, | |
1277 | AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100, | |
1278 | AGG_TX_STATE_RESPONSE_MSK = 0x1ff, | |
1279 | AGG_TX_STATE_DUMP_TX_MSK = 0x200, | |
1280 | AGG_TX_STATE_DELAY_TX_MSK = 0x400 | |
1281 | }; | |
1282 | ||
1283 | #define AGG_TX_STATE_LAST_SENT_MSK \ | |
1284 | (AGG_TX_STATE_LAST_SENT_TTL_MSK | \ | |
1285 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \ | |
1286 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK) | |
1287 | ||
52969981 | 1288 | /* # tx attempts for first frame in aggregation */ |
b481de9c ZY |
1289 | #define AGG_TX_STATE_TRY_CNT_POS 12 |
1290 | #define AGG_TX_STATE_TRY_CNT_MSK 0xf000 | |
1291 | ||
52969981 | 1292 | /* Command ID and sequence number of Tx command for this frame */ |
b481de9c ZY |
1293 | #define AGG_TX_STATE_SEQ_NUM_POS 16 |
1294 | #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000 | |
1295 | ||
1296 | /* | |
1297 | * REPLY_TX = 0x1c (response) | |
52969981 BC |
1298 | * |
1299 | * This response may be in one of two slightly different formats, indicated | |
1300 | * by the frame_count field: | |
1301 | * | |
1302 | * 1) No aggregation (frame_count == 1). This reports Tx results for | |
1303 | * a single frame. Multiple attempts, at various bit rates, may have | |
1304 | * been made for this frame. | |
1305 | * | |
1306 | * 2) Aggregation (frame_count > 1). This reports Tx results for | |
1307 | * 2 or more frames that used block-acknowledge. All frames were | |
1308 | * transmitted at same rate. Rate scaling may have been used if first | |
1309 | * frame in this new agg block failed in previous agg block(s). | |
1310 | * | |
1311 | * Note that, for aggregation, ACK (block-ack) status is not delivered here; | |
1312 | * block-ack has not been received by the time the 4965 records this status. | |
1313 | * This status relates to reasons the tx might have been blocked or aborted | |
1314 | * within the sending station (this 4965), rather than whether it was | |
1315 | * received successfully by the destination station. | |
b481de9c | 1316 | */ |
bb8c093b | 1317 | struct iwl4965_tx_resp { |
b481de9c | 1318 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ |
52969981 BC |
1319 | u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */ |
1320 | u8 failure_rts; /* # failures due to unsuccessful RTS */ | |
1321 | u8 failure_frame; /* # failures due to no ACK (unused for agg) */ | |
1322 | ||
1323 | /* For non-agg: Rate at which frame was successful. | |
1324 | * For agg: Rate at which all frames were transmitted. */ | |
1325 | __le32 rate_n_flags; /* RATE_MCS_* */ | |
1326 | ||
1327 | /* For non-agg: RTS + CTS + frame tx attempts time + ACK. | |
1328 | * For agg: RTS + CTS + aggregation tx time + block-ack time. */ | |
1329 | __le16 wireless_media_time; /* uSecs */ | |
1330 | ||
b481de9c | 1331 | __le16 reserved; |
52969981 | 1332 | __le32 pa_power1; /* RF power amplifier measurement (not used) */ |
b481de9c | 1333 | __le32 pa_power2; |
52969981 BC |
1334 | |
1335 | /* | |
1336 | * For non-agg: frame status TX_STATUS_* | |
1337 | * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status | |
1338 | * fields follow this one, up to frame_count. | |
1339 | * Bit fields: | |
1340 | * 11- 0: AGG_TX_STATE_* status code | |
1341 | * 15-12: Retry count for 1st frame in aggregation (retries | |
1342 | * occur if tx failed for this frame when it was a | |
1343 | * member of a previous aggregation block). If rate | |
1344 | * scaling is used, retry count indicates the rate | |
1345 | * table entry used for all frames in the new agg. | |
1346 | * 31-16: Sequence # for this frame's Tx cmd (not SSN!) | |
1347 | */ | |
b481de9c ZY |
1348 | __le32 status; /* TX status (for aggregation status of 1st frame) */ |
1349 | } __attribute__ ((packed)); | |
1350 | ||
fe01b477 RR |
1351 | struct agg_tx_status { |
1352 | __le16 status; | |
1353 | __le16 sequence; | |
1354 | } __attribute__ ((packed)); | |
1355 | ||
1356 | struct iwl4965_tx_resp_agg { | |
1357 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ | |
1358 | u8 reserved1; | |
1359 | u8 failure_rts; | |
1360 | u8 failure_frame; | |
1361 | __le32 rate_n_flags; | |
1362 | __le16 wireless_media_time; | |
1363 | __le16 reserved3; | |
1364 | __le32 pa_power1; | |
1365 | __le32 pa_power2; | |
1366 | struct agg_tx_status status; /* TX status (for aggregation status */ | |
1367 | /* of 1st frame) */ | |
1368 | } __attribute__ ((packed)); | |
1369 | ||
b481de9c ZY |
1370 | /* |
1371 | * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command) | |
52969981 BC |
1372 | * |
1373 | * Reports Block-Acknowledge from recipient station | |
b481de9c | 1374 | */ |
bb8c093b | 1375 | struct iwl4965_compressed_ba_resp { |
b481de9c ZY |
1376 | __le32 sta_addr_lo32; |
1377 | __le16 sta_addr_hi16; | |
1378 | __le16 reserved; | |
52969981 BC |
1379 | |
1380 | /* Index of recipient (BA-sending) station in uCode's station table */ | |
b481de9c ZY |
1381 | u8 sta_id; |
1382 | u8 tid; | |
fe01b477 RR |
1383 | __le16 seq_ctl; |
1384 | __le64 bitmap; | |
b481de9c ZY |
1385 | __le16 scd_flow; |
1386 | __le16 scd_ssn; | |
1387 | } __attribute__ ((packed)); | |
1388 | ||
1389 | /* | |
1390 | * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response) | |
2bdc7031 BC |
1391 | * |
1392 | * See details under "TXPOWER" in iwl-4965-hw.h. | |
b481de9c | 1393 | */ |
bb8c093b | 1394 | struct iwl4965_txpowertable_cmd { |
b481de9c ZY |
1395 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ |
1396 | u8 reserved; | |
1397 | __le16 channel; | |
bb8c093b | 1398 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
1399 | } __attribute__ ((packed)); |
1400 | ||
b481de9c | 1401 | /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */ |
8a1b0245 | 1402 | #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0) |
b481de9c | 1403 | |
2bdc7031 | 1404 | /* # of EDCA prioritized tx fifos */ |
b481de9c | 1405 | #define LINK_QUAL_AC_NUM AC_NUM |
2bdc7031 BC |
1406 | |
1407 | /* # entries in rate scale table to support Tx retries */ | |
b481de9c ZY |
1408 | #define LINK_QUAL_MAX_RETRY_NUM 16 |
1409 | ||
2bdc7031 | 1410 | /* Tx antenna selection values */ |
8a1b0245 RC |
1411 | #define LINK_QUAL_ANT_A_MSK (1 << 0) |
1412 | #define LINK_QUAL_ANT_B_MSK (1 << 1) | |
b481de9c ZY |
1413 | #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK) |
1414 | ||
2bdc7031 BC |
1415 | |
1416 | /** | |
1417 | * struct iwl4965_link_qual_general_params | |
1418 | * | |
1419 | * Used in REPLY_TX_LINK_QUALITY_CMD | |
1420 | */ | |
bb8c093b | 1421 | struct iwl4965_link_qual_general_params { |
b481de9c | 1422 | u8 flags; |
2bdc7031 BC |
1423 | |
1424 | /* No entries at or above this (driver chosen) index contain MIMO */ | |
b481de9c | 1425 | u8 mimo_delimiter; |
2bdc7031 BC |
1426 | |
1427 | /* Best single antenna to use for single stream (legacy, SISO). */ | |
1428 | u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */ | |
1429 | ||
1430 | /* Best antennas to use for MIMO (unused for 4965, assumes both). */ | |
1431 | u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */ | |
1432 | ||
1433 | /* | |
1434 | * If driver needs to use different initial rates for different | |
1435 | * EDCA QOS access categories (as implemented by tx fifos 0-3), | |
1436 | * this table will set that up, by indicating the indexes in the | |
1437 | * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start. | |
1438 | * Otherwise, driver should set all entries to 0. | |
1439 | * | |
1440 | * Entry usage: | |
1441 | * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice | |
1442 | * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3. | |
1443 | */ | |
b481de9c ZY |
1444 | u8 start_rate_index[LINK_QUAL_AC_NUM]; |
1445 | } __attribute__ ((packed)); | |
1446 | ||
2bdc7031 BC |
1447 | /** |
1448 | * struct iwl4965_link_qual_agg_params | |
1449 | * | |
1450 | * Used in REPLY_TX_LINK_QUALITY_CMD | |
1451 | */ | |
bb8c093b | 1452 | struct iwl4965_link_qual_agg_params { |
2bdc7031 BC |
1453 | |
1454 | /* Maximum number of uSec in aggregation. | |
1455 | * Driver should set this to 4000 (4 milliseconds). */ | |
b481de9c | 1456 | __le16 agg_time_limit; |
2bdc7031 BC |
1457 | |
1458 | /* | |
1459 | * Number of Tx retries allowed for a frame, before that frame will | |
1460 | * no longer be considered for the start of an aggregation sequence | |
1461 | * (scheduler will then try to tx it as single frame). | |
1462 | * Driver should set this to 3. | |
1463 | */ | |
b481de9c | 1464 | u8 agg_dis_start_th; |
2bdc7031 BC |
1465 | |
1466 | /* | |
1467 | * Maximum number of frames in aggregation. | |
1468 | * 0 = no limit (default). 1 = no aggregation. | |
1469 | * Other values = max # frames in aggregation. | |
1470 | */ | |
b481de9c | 1471 | u8 agg_frame_cnt_limit; |
2bdc7031 | 1472 | |
b481de9c ZY |
1473 | __le32 reserved; |
1474 | } __attribute__ ((packed)); | |
1475 | ||
1476 | /* | |
1477 | * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response) | |
2bdc7031 BC |
1478 | * |
1479 | * For 4965 only; 3945 uses REPLY_RATE_SCALE. | |
1480 | * | |
1481 | * Each station in the 4965's internal station table has its own table of 16 | |
1482 | * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when | |
1483 | * an ACK is not received. This command replaces the entire table for | |
1484 | * one station. | |
1485 | * | |
1486 | * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA. | |
1487 | * | |
1488 | * The rate scaling procedures described below work well. Of course, other | |
1489 | * procedures are possible, and may work better for particular environments. | |
1490 | * | |
1491 | * | |
1492 | * FILLING THE RATE TABLE | |
1493 | * | |
1494 | * Given a particular initial rate and mode, as determined by the rate | |
1495 | * scaling algorithm described below, the Linux driver uses the following | |
1496 | * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the | |
1497 | * Link Quality command: | |
1498 | * | |
1499 | * | |
1500 | * 1) If using High-throughput (HT) (SISO or MIMO) initial rate: | |
1501 | * a) Use this same initial rate for first 3 entries. | |
1502 | * b) Find next lower available rate using same mode (SISO or MIMO), | |
1503 | * use for next 3 entries. If no lower rate available, switch to | |
1504 | * legacy mode (no FAT channel, no MIMO, no short guard interval). | |
1505 | * c) If using MIMO, set command's mimo_delimiter to number of entries | |
1506 | * using MIMO (3 or 6). | |
1507 | * d) After trying 2 HT rates, switch to legacy mode (no FAT channel, | |
1508 | * no MIMO, no short guard interval), at the next lower bit rate | |
1509 | * (e.g. if second HT bit rate was 54, try 48 legacy), and follow | |
1510 | * legacy procedure for remaining table entries. | |
1511 | * | |
1512 | * 2) If using legacy initial rate: | |
1513 | * a) Use the initial rate for only one entry. | |
1514 | * b) For each following entry, reduce the rate to next lower available | |
1515 | * rate, until reaching the lowest available rate. | |
1516 | * c) When reducing rate, also switch antenna selection. | |
1517 | * d) Once lowest available rate is reached, repeat this rate until | |
1518 | * rate table is filled (16 entries), switching antenna each entry. | |
1519 | * | |
1520 | * | |
1521 | * ACCUMULATING HISTORY | |
1522 | * | |
1523 | * The rate scaling algorithm for 4965, as implemented in Linux driver, uses | |
1524 | * two sets of frame Tx success history: One for the current/active modulation | |
1525 | * mode, and one for a speculative/search mode that is being attempted. If the | |
1526 | * speculative mode turns out to be more effective (i.e. actual transfer | |
1527 | * rate is better), then the driver continues to use the speculative mode | |
1528 | * as the new current active mode. | |
1529 | * | |
1530 | * Each history set contains, separately for each possible rate, data for a | |
1531 | * sliding window of the 62 most recent tx attempts at that rate. The data | |
1532 | * includes a shifting bitmap of success(1)/failure(0), and sums of successful | |
1533 | * and attempted frames, from which the driver can additionally calculate a | |
1534 | * success ratio (success / attempted) and number of failures | |
1535 | * (attempted - success), and control the size of the window (attempted). | |
1536 | * The driver uses the bit map to remove successes from the success sum, as | |
1537 | * the oldest tx attempts fall out of the window. | |
1538 | * | |
1539 | * When the 4965 makes multiple tx attempts for a given frame, each attempt | |
1540 | * might be at a different rate, and have different modulation characteristics | |
1541 | * (e.g. antenna, fat channel, short guard interval), as set up in the rate | |
1542 | * scaling table in the Link Quality command. The driver must determine | |
1543 | * which rate table entry was used for each tx attempt, to determine which | |
1544 | * rate-specific history to update, and record only those attempts that | |
1545 | * match the modulation characteristics of the history set. | |
1546 | * | |
1547 | * When using block-ack (aggregation), all frames are transmitted at the same | |
1548 | * rate, since there is no per-attempt acknowledgement from the destination | |
1549 | * station. The Tx response struct iwl_tx_resp indicates the Tx rate in | |
1550 | * rate_n_flags field. After receiving a block-ack, the driver can update | |
1551 | * history for the entire block all at once. | |
1552 | * | |
1553 | * | |
1554 | * FINDING BEST STARTING RATE: | |
1555 | * | |
1556 | * When working with a selected initial modulation mode (see below), the | |
1557 | * driver attempts to find a best initial rate. The initial rate is the | |
1558 | * first entry in the Link Quality command's rate table. | |
1559 | * | |
1560 | * 1) Calculate actual throughput (success ratio * expected throughput, see | |
1561 | * table below) for current initial rate. Do this only if enough frames | |
1562 | * have been attempted to make the value meaningful: at least 6 failed | |
1563 | * tx attempts, or at least 8 successes. If not enough, don't try rate | |
1564 | * scaling yet. | |
1565 | * | |
1566 | * 2) Find available rates adjacent to current initial rate. Available means: | |
1567 | * a) supported by hardware && | |
1568 | * b) supported by association && | |
1569 | * c) within any constraints selected by user | |
1570 | * | |
1571 | * 3) Gather measured throughputs for adjacent rates. These might not have | |
1572 | * enough history to calculate a throughput. That's okay, we might try | |
1573 | * using one of them anyway! | |
1574 | * | |
1575 | * 4) Try decreasing rate if, for current rate: | |
1576 | * a) success ratio is < 15% || | |
1577 | * b) lower adjacent rate has better measured throughput || | |
1578 | * c) higher adjacent rate has worse throughput, and lower is unmeasured | |
1579 | * | |
1580 | * As a sanity check, if decrease was determined above, leave rate | |
1581 | * unchanged if: | |
1582 | * a) lower rate unavailable | |
1583 | * b) success ratio at current rate > 85% (very good) | |
1584 | * c) current measured throughput is better than expected throughput | |
1585 | * of lower rate (under perfect 100% tx conditions, see table below) | |
1586 | * | |
1587 | * 5) Try increasing rate if, for current rate: | |
1588 | * a) success ratio is < 15% || | |
1589 | * b) both adjacent rates' throughputs are unmeasured (try it!) || | |
1590 | * b) higher adjacent rate has better measured throughput || | |
1591 | * c) lower adjacent rate has worse throughput, and higher is unmeasured | |
1592 | * | |
1593 | * As a sanity check, if increase was determined above, leave rate | |
1594 | * unchanged if: | |
1595 | * a) success ratio at current rate < 70%. This is not particularly | |
1596 | * good performance; higher rate is sure to have poorer success. | |
1597 | * | |
1598 | * 6) Re-evaluate the rate after each tx frame. If working with block- | |
1599 | * acknowledge, history and statistics may be calculated for the entire | |
1600 | * block (including prior history that fits within the history windows), | |
1601 | * before re-evaluation. | |
1602 | * | |
1603 | * FINDING BEST STARTING MODULATION MODE: | |
1604 | * | |
1605 | * After working with a modulation mode for a "while" (and doing rate scaling), | |
1606 | * the driver searches for a new initial mode in an attempt to improve | |
1607 | * throughput. The "while" is measured by numbers of attempted frames: | |
1608 | * | |
1609 | * For legacy mode, search for new mode after: | |
1610 | * 480 successful frames, or 160 failed frames | |
1611 | * For high-throughput modes (SISO or MIMO), search for new mode after: | |
1612 | * 4500 successful frames, or 400 failed frames | |
1613 | * | |
1614 | * Mode switch possibilities are (3 for each mode): | |
1615 | * | |
1616 | * For legacy: | |
1617 | * Change antenna, try SISO (if HT association), try MIMO (if HT association) | |
1618 | * For SISO: | |
1619 | * Change antenna, try MIMO, try shortened guard interval (SGI) | |
1620 | * For MIMO: | |
1621 | * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI) | |
1622 | * | |
1623 | * When trying a new mode, use the same bit rate as the old/current mode when | |
1624 | * trying antenna switches and shortened guard interval. When switching to | |
1625 | * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate | |
1626 | * for which the expected throughput (under perfect conditions) is about the | |
1627 | * same or slightly better than the actual measured throughput delivered by | |
1628 | * the old/current mode. | |
1629 | * | |
1630 | * Actual throughput can be estimated by multiplying the expected throughput | |
1631 | * by the success ratio (successful / attempted tx frames). Frame size is | |
1632 | * not considered in this calculation; it assumes that frame size will average | |
1633 | * out to be fairly consistent over several samples. The following are | |
1634 | * metric values for expected throughput assuming 100% success ratio. | |
1635 | * Only G band has support for CCK rates: | |
1636 | * | |
1637 | * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60 | |
1638 | * | |
1639 | * G: 7 13 35 58 40 57 72 98 121 154 177 186 186 | |
1640 | * A: 0 0 0 0 40 57 72 98 121 154 177 186 186 | |
1641 | * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202 | |
1642 | * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211 | |
1643 | * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251 | |
1644 | * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257 | |
1645 | * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257 | |
1646 | * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264 | |
1647 | * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289 | |
1648 | * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293 | |
1649 | * | |
1650 | * After the new mode has been tried for a short while (minimum of 6 failed | |
1651 | * frames or 8 successful frames), compare success ratio and actual throughput | |
1652 | * estimate of the new mode with the old. If either is better with the new | |
1653 | * mode, continue to use the new mode. | |
1654 | * | |
1655 | * Continue comparing modes until all 3 possibilities have been tried. | |
1656 | * If moving from legacy to HT, try all 3 possibilities from the new HT | |
1657 | * mode. After trying all 3, a best mode is found. Continue to use this mode | |
1658 | * for the longer "while" described above (e.g. 480 successful frames for | |
1659 | * legacy), and then repeat the search process. | |
1660 | * | |
b481de9c | 1661 | */ |
bb8c093b | 1662 | struct iwl4965_link_quality_cmd { |
2bdc7031 BC |
1663 | |
1664 | /* Index of destination/recipient station in uCode's station table */ | |
b481de9c ZY |
1665 | u8 sta_id; |
1666 | u8 reserved1; | |
2bdc7031 | 1667 | __le16 control; /* not used */ |
bb8c093b CH |
1668 | struct iwl4965_link_qual_general_params general_params; |
1669 | struct iwl4965_link_qual_agg_params agg_params; | |
2bdc7031 BC |
1670 | |
1671 | /* | |
1672 | * Rate info; when using rate-scaling, Tx command's initial_rate_index | |
1673 | * specifies 1st Tx rate attempted, via index into this table. | |
1674 | * 4965 works its way through table when retrying Tx. | |
1675 | */ | |
b481de9c | 1676 | struct { |
2bdc7031 | 1677 | __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */ |
b481de9c ZY |
1678 | } rs_table[LINK_QUAL_MAX_RETRY_NUM]; |
1679 | __le32 reserved2; | |
1680 | } __attribute__ ((packed)); | |
b481de9c ZY |
1681 | |
1682 | /* | |
1683 | * REPLY_BT_CONFIG = 0x9b (command, has simple generic response) | |
3058f021 BC |
1684 | * |
1685 | * 3945 and 4965 support hardware handshake with Bluetooth device on | |
1686 | * same platform. Bluetooth device alerts wireless device when it will Tx; | |
1687 | * wireless device can delay or kill its own Tx to accomodate. | |
b481de9c | 1688 | */ |
bb8c093b | 1689 | struct iwl4965_bt_cmd { |
b481de9c ZY |
1690 | u8 flags; |
1691 | u8 lead_time; | |
1692 | u8 max_kill; | |
1693 | u8 reserved; | |
1694 | __le32 kill_ack_mask; | |
1695 | __le32 kill_cts_mask; | |
1696 | } __attribute__ ((packed)); | |
1697 | ||
1698 | /****************************************************************************** | |
1699 | * (6) | |
1700 | * Spectrum Management (802.11h) Commands, Responses, Notifications: | |
1701 | * | |
1702 | *****************************************************************************/ | |
1703 | ||
1704 | /* | |
1705 | * Spectrum Management | |
1706 | */ | |
1707 | #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \ | |
1708 | RXON_FILTER_CTL2HOST_MSK | \ | |
1709 | RXON_FILTER_ACCEPT_GRP_MSK | \ | |
1710 | RXON_FILTER_DIS_DECRYPT_MSK | \ | |
1711 | RXON_FILTER_DIS_GRP_DECRYPT_MSK | \ | |
1712 | RXON_FILTER_ASSOC_MSK | \ | |
1713 | RXON_FILTER_BCON_AWARE_MSK) | |
1714 | ||
bb8c093b | 1715 | struct iwl4965_measure_channel { |
b481de9c ZY |
1716 | __le32 duration; /* measurement duration in extended beacon |
1717 | * format */ | |
1718 | u8 channel; /* channel to measure */ | |
bb8c093b | 1719 | u8 type; /* see enum iwl4965_measure_type */ |
b481de9c ZY |
1720 | __le16 reserved; |
1721 | } __attribute__ ((packed)); | |
1722 | ||
1723 | /* | |
1724 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command) | |
1725 | */ | |
bb8c093b | 1726 | struct iwl4965_spectrum_cmd { |
b481de9c ZY |
1727 | __le16 len; /* number of bytes starting from token */ |
1728 | u8 token; /* token id */ | |
1729 | u8 id; /* measurement id -- 0 or 1 */ | |
1730 | u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */ | |
1731 | u8 periodic; /* 1 = periodic */ | |
1732 | __le16 path_loss_timeout; | |
1733 | __le32 start_time; /* start time in extended beacon format */ | |
1734 | __le32 reserved2; | |
1735 | __le32 flags; /* rxon flags */ | |
1736 | __le32 filter_flags; /* rxon filter flags */ | |
1737 | __le16 channel_count; /* minimum 1, maximum 10 */ | |
1738 | __le16 reserved3; | |
bb8c093b | 1739 | struct iwl4965_measure_channel channels[10]; |
b481de9c ZY |
1740 | } __attribute__ ((packed)); |
1741 | ||
1742 | /* | |
1743 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response) | |
1744 | */ | |
bb8c093b | 1745 | struct iwl4965_spectrum_resp { |
b481de9c ZY |
1746 | u8 token; |
1747 | u8 id; /* id of the prior command replaced, or 0xff */ | |
1748 | __le16 status; /* 0 - command will be handled | |
1749 | * 1 - cannot handle (conflicts with another | |
1750 | * measurement) */ | |
1751 | } __attribute__ ((packed)); | |
1752 | ||
bb8c093b | 1753 | enum iwl4965_measurement_state { |
b481de9c ZY |
1754 | IWL_MEASUREMENT_START = 0, |
1755 | IWL_MEASUREMENT_STOP = 1, | |
1756 | }; | |
1757 | ||
bb8c093b | 1758 | enum iwl4965_measurement_status { |
b481de9c ZY |
1759 | IWL_MEASUREMENT_OK = 0, |
1760 | IWL_MEASUREMENT_CONCURRENT = 1, | |
1761 | IWL_MEASUREMENT_CSA_CONFLICT = 2, | |
1762 | IWL_MEASUREMENT_TGH_CONFLICT = 3, | |
1763 | /* 4-5 reserved */ | |
1764 | IWL_MEASUREMENT_STOPPED = 6, | |
1765 | IWL_MEASUREMENT_TIMEOUT = 7, | |
1766 | IWL_MEASUREMENT_PERIODIC_FAILED = 8, | |
1767 | }; | |
1768 | ||
1769 | #define NUM_ELEMENTS_IN_HISTOGRAM 8 | |
1770 | ||
bb8c093b | 1771 | struct iwl4965_measurement_histogram { |
b481de9c ZY |
1772 | __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */ |
1773 | __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */ | |
1774 | } __attribute__ ((packed)); | |
1775 | ||
1776 | /* clear channel availability counters */ | |
bb8c093b | 1777 | struct iwl4965_measurement_cca_counters { |
b481de9c ZY |
1778 | __le32 ofdm; |
1779 | __le32 cck; | |
1780 | } __attribute__ ((packed)); | |
1781 | ||
bb8c093b | 1782 | enum iwl4965_measure_type { |
b481de9c ZY |
1783 | IWL_MEASURE_BASIC = (1 << 0), |
1784 | IWL_MEASURE_CHANNEL_LOAD = (1 << 1), | |
1785 | IWL_MEASURE_HISTOGRAM_RPI = (1 << 2), | |
1786 | IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3), | |
1787 | IWL_MEASURE_FRAME = (1 << 4), | |
1788 | /* bits 5:6 are reserved */ | |
1789 | IWL_MEASURE_IDLE = (1 << 7), | |
1790 | }; | |
1791 | ||
1792 | /* | |
1793 | * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command) | |
1794 | */ | |
bb8c093b | 1795 | struct iwl4965_spectrum_notification { |
b481de9c ZY |
1796 | u8 id; /* measurement id -- 0 or 1 */ |
1797 | u8 token; | |
1798 | u8 channel_index; /* index in measurement channel list */ | |
1799 | u8 state; /* 0 - start, 1 - stop */ | |
1800 | __le32 start_time; /* lower 32-bits of TSF */ | |
1801 | u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */ | |
1802 | u8 channel; | |
bb8c093b | 1803 | u8 type; /* see enum iwl4965_measurement_type */ |
b481de9c ZY |
1804 | u8 reserved1; |
1805 | /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only | |
1806 | * valid if applicable for measurement type requested. */ | |
1807 | __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */ | |
1808 | __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */ | |
1809 | __le32 cca_time; /* channel load time in usecs */ | |
1810 | u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 - | |
1811 | * unidentified */ | |
1812 | u8 reserved2[3]; | |
bb8c093b | 1813 | struct iwl4965_measurement_histogram histogram; |
b481de9c | 1814 | __le32 stop_time; /* lower 32-bits of TSF */ |
bb8c093b | 1815 | __le32 status; /* see iwl4965_measurement_status */ |
b481de9c ZY |
1816 | } __attribute__ ((packed)); |
1817 | ||
1818 | /****************************************************************************** | |
1819 | * (7) | |
1820 | * Power Management Commands, Responses, Notifications: | |
1821 | * | |
1822 | *****************************************************************************/ | |
1823 | ||
1824 | /** | |
bb8c093b | 1825 | * struct iwl4965_powertable_cmd - Power Table Command |
b481de9c ZY |
1826 | * @flags: See below: |
1827 | * | |
1828 | * POWER_TABLE_CMD = 0x77 (command, has simple generic response) | |
1829 | * | |
1830 | * PM allow: | |
1831 | * bit 0 - '0' Driver not allow power management | |
1832 | * '1' Driver allow PM (use rest of parameters) | |
1833 | * uCode send sleep notifications: | |
1834 | * bit 1 - '0' Don't send sleep notification | |
1835 | * '1' send sleep notification (SEND_PM_NOTIFICATION) | |
1836 | * Sleep over DTIM | |
1837 | * bit 2 - '0' PM have to walk up every DTIM | |
1838 | * '1' PM could sleep over DTIM till listen Interval. | |
1839 | * PCI power managed | |
1840 | * bit 3 - '0' (PCI_LINK_CTRL & 0x1) | |
1841 | * '1' !(PCI_LINK_CTRL & 0x1) | |
1842 | * Force sleep Modes | |
1843 | * bit 31/30- '00' use both mac/xtal sleeps | |
1844 | * '01' force Mac sleep | |
1845 | * '10' force xtal sleep | |
1846 | * '11' Illegal set | |
1847 | * | |
1848 | * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then | |
1849 | * ucode assume sleep over DTIM is allowed and we don't need to wakeup | |
1850 | * for every DTIM. | |
1851 | */ | |
1852 | #define IWL_POWER_VEC_SIZE 5 | |
1853 | ||
8a1b0245 RC |
1854 | #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1 << 0) |
1855 | #define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1 << 2) | |
1856 | #define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1 << 3) | |
b481de9c | 1857 | |
bb8c093b | 1858 | struct iwl4965_powertable_cmd { |
b481de9c ZY |
1859 | __le16 flags; |
1860 | u8 keep_alive_seconds; | |
1861 | u8 debug_flags; | |
1862 | __le32 rx_data_timeout; | |
1863 | __le32 tx_data_timeout; | |
1864 | __le32 sleep_interval[IWL_POWER_VEC_SIZE]; | |
1865 | __le32 keep_alive_beacons; | |
1866 | } __attribute__ ((packed)); | |
b481de9c ZY |
1867 | |
1868 | /* | |
1869 | * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command) | |
1870 | * 3945 and 4965 identical. | |
1871 | */ | |
bb8c093b | 1872 | struct iwl4965_sleep_notification { |
b481de9c ZY |
1873 | u8 pm_sleep_mode; |
1874 | u8 pm_wakeup_src; | |
1875 | __le16 reserved; | |
1876 | __le32 sleep_time; | |
1877 | __le32 tsf_low; | |
1878 | __le32 bcon_timer; | |
1879 | } __attribute__ ((packed)); | |
1880 | ||
1881 | /* Sleep states. 3945 and 4965 identical. */ | |
1882 | enum { | |
1883 | IWL_PM_NO_SLEEP = 0, | |
1884 | IWL_PM_SLP_MAC = 1, | |
1885 | IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2, | |
1886 | IWL_PM_SLP_FULL_MAC_CARD_STATE = 3, | |
1887 | IWL_PM_SLP_PHY = 4, | |
1888 | IWL_PM_SLP_REPENT = 5, | |
1889 | IWL_PM_WAKEUP_BY_TIMER = 6, | |
1890 | IWL_PM_WAKEUP_BY_DRIVER = 7, | |
1891 | IWL_PM_WAKEUP_BY_RFKILL = 8, | |
1892 | /* 3 reserved */ | |
1893 | IWL_PM_NUM_OF_MODES = 12, | |
1894 | }; | |
1895 | ||
1896 | /* | |
1897 | * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response) | |
1898 | */ | |
1899 | #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */ | |
1900 | #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */ | |
1901 | #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */ | |
bb8c093b | 1902 | struct iwl4965_card_state_cmd { |
b481de9c ZY |
1903 | __le32 status; /* CARD_STATE_CMD_* request new power state */ |
1904 | } __attribute__ ((packed)); | |
1905 | ||
1906 | /* | |
1907 | * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command) | |
1908 | */ | |
bb8c093b | 1909 | struct iwl4965_card_state_notif { |
b481de9c ZY |
1910 | __le32 flags; |
1911 | } __attribute__ ((packed)); | |
1912 | ||
1913 | #define HW_CARD_DISABLED 0x01 | |
1914 | #define SW_CARD_DISABLED 0x02 | |
1915 | #define RF_CARD_DISABLED 0x04 | |
1916 | #define RXON_CARD_DISABLED 0x10 | |
1917 | ||
bb8c093b | 1918 | struct iwl4965_ct_kill_config { |
b481de9c ZY |
1919 | __le32 reserved; |
1920 | __le32 critical_temperature_M; | |
1921 | __le32 critical_temperature_R; | |
1922 | } __attribute__ ((packed)); | |
1923 | ||
1924 | /****************************************************************************** | |
1925 | * (8) | |
1926 | * Scan Commands, Responses, Notifications: | |
1927 | * | |
1928 | *****************************************************************************/ | |
1929 | ||
3058f021 BC |
1930 | /** |
1931 | * struct iwl4965_scan_channel - entry in REPLY_SCAN_CMD channel table | |
1932 | * | |
1933 | * One for each channel in the scan list. | |
1934 | * Each channel can independently select: | |
1935 | * 1) SSID for directed active scans | |
1936 | * 2) Txpower setting (for rate specified within Tx command) | |
1937 | * 3) How long to stay on-channel (behavior may be modified by quiet_time, | |
1938 | * quiet_plcp_th, good_CRC_th) | |
1939 | * | |
1940 | * To avoid uCode errors, make sure the following are true (see comments | |
1941 | * under struct iwl4965_scan_cmd about max_out_time and quiet_time): | |
1942 | * 1) If using passive_dwell (i.e. passive_dwell != 0): | |
1943 | * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0) | |
1944 | * 2) quiet_time <= active_dwell | |
1945 | * 3) If restricting off-channel time (i.e. max_out_time !=0): | |
1946 | * passive_dwell < max_out_time | |
1947 | * active_dwell < max_out_time | |
1948 | */ | |
bb8c093b | 1949 | struct iwl4965_scan_channel { |
3058f021 BC |
1950 | /* |
1951 | * type is defined as: | |
1952 | * 0:0 1 = active, 0 = passive | |
1953 | * 1:4 SSID direct bit map; if a bit is set, then corresponding | |
1954 | * SSID IE is transmitted in probe request. | |
b481de9c ZY |
1955 | * 5:7 reserved |
1956 | */ | |
1957 | u8 type; | |
3058f021 | 1958 | u8 channel; /* band is selected by iwl4965_scan_cmd "flags" field */ |
bb8c093b | 1959 | struct iwl4965_tx_power tpc; |
3058f021 BC |
1960 | __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */ |
1961 | __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */ | |
b481de9c ZY |
1962 | } __attribute__ ((packed)); |
1963 | ||
3058f021 BC |
1964 | /** |
1965 | * struct iwl4965_ssid_ie - directed scan network information element | |
1966 | * | |
1967 | * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field | |
1968 | * in struct iwl4965_scan_channel; each channel may select different ssids from | |
1969 | * among the 4 entries. SSID IEs get transmitted in reverse order of entry. | |
1970 | */ | |
bb8c093b | 1971 | struct iwl4965_ssid_ie { |
b481de9c ZY |
1972 | u8 id; |
1973 | u8 len; | |
1974 | u8 ssid[32]; | |
1975 | } __attribute__ ((packed)); | |
1976 | ||
1977 | #define PROBE_OPTION_MAX 0x4 | |
1978 | #define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF) | |
1979 | #define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1) | |
1980 | #define IWL_MAX_SCAN_SIZE 1024 | |
1981 | ||
1982 | /* | |
1983 | * REPLY_SCAN_CMD = 0x80 (command) | |
3058f021 BC |
1984 | * |
1985 | * The hardware scan command is very powerful; the driver can set it up to | |
1986 | * maintain (relatively) normal network traffic while doing a scan in the | |
1987 | * background. The max_out_time and suspend_time control the ratio of how | |
1988 | * long the device stays on an associated network channel ("service channel") | |
1989 | * vs. how long it's away from the service channel, i.e. tuned to other channels | |
1990 | * for scanning. | |
1991 | * | |
1992 | * max_out_time is the max time off-channel (in usec), and suspend_time | |
1993 | * is how long (in "extended beacon" format) that the scan is "suspended" | |
1994 | * after returning to the service channel. That is, suspend_time is the | |
1995 | * time that we stay on the service channel, doing normal work, between | |
1996 | * scan segments. The driver may set these parameters differently to support | |
1997 | * scanning when associated vs. not associated, and light vs. heavy traffic | |
1998 | * loads when associated. | |
1999 | * | |
2000 | * After receiving this command, the device's scan engine does the following; | |
2001 | * | |
2002 | * 1) Sends SCAN_START notification to driver | |
2003 | * 2) Checks to see if it has time to do scan for one channel | |
2004 | * 3) Sends NULL packet, with power-save (PS) bit set to 1, | |
2005 | * to tell AP that we're going off-channel | |
2006 | * 4) Tunes to first channel in scan list, does active or passive scan | |
2007 | * 5) Sends SCAN_RESULT notification to driver | |
2008 | * 6) Checks to see if it has time to do scan on *next* channel in list | |
2009 | * 7) Repeats 4-6 until it no longer has time to scan the next channel | |
2010 | * before max_out_time expires | |
2011 | * 8) Returns to service channel | |
2012 | * 9) Sends NULL packet with PS=0 to tell AP that we're back | |
2013 | * 10) Stays on service channel until suspend_time expires | |
2014 | * 11) Repeats entire process 2-10 until list is complete | |
2015 | * 12) Sends SCAN_COMPLETE notification | |
2016 | * | |
2017 | * For fast, efficient scans, the scan command also has support for staying on | |
2018 | * a channel for just a short time, if doing active scanning and getting no | |
2019 | * responses to the transmitted probe request. This time is controlled by | |
2020 | * quiet_time, and the number of received packets below which a channel is | |
2021 | * considered "quiet" is controlled by quiet_plcp_threshold. | |
2022 | * | |
2023 | * For active scanning on channels that have regulatory restrictions against | |
2024 | * blindly transmitting, the scan can listen before transmitting, to make sure | |
2025 | * that there is already legitimate activity on the channel. If enough | |
2026 | * packets are cleanly received on the channel (controlled by good_CRC_th, | |
2027 | * typical value 1), the scan engine starts transmitting probe requests. | |
2028 | * | |
2029 | * Driver must use separate scan commands for 2.4 vs. 5 GHz bands. | |
2030 | * | |
2031 | * To avoid uCode errors, see timing restrictions described under | |
2032 | * struct iwl4965_scan_channel. | |
b481de9c | 2033 | */ |
bb8c093b | 2034 | struct iwl4965_scan_cmd { |
b481de9c ZY |
2035 | __le16 len; |
2036 | u8 reserved0; | |
3058f021 BC |
2037 | u8 channel_count; /* # channels in channel list */ |
2038 | __le16 quiet_time; /* dwell only this # millisecs on quiet channel | |
2039 | * (only for active scan) */ | |
2040 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ | |
2041 | __le16 good_CRC_th; /* passive -> active promotion threshold */ | |
2042 | __le16 rx_chain; /* RXON_RX_CHAIN_* */ | |
2043 | __le32 max_out_time; /* max usec to be away from associated (service) | |
2044 | * channel */ | |
2045 | __le32 suspend_time; /* pause scan this long (in "extended beacon | |
2046 | * format") when returning to service chnl: | |
2047 | * 3945; 31:24 # beacons, 19:0 additional usec, | |
2048 | * 4965; 31:22 # beacons, 21:0 additional usec. | |
2049 | */ | |
2050 | __le32 flags; /* RXON_FLG_* */ | |
2051 | __le32 filter_flags; /* RXON_FILTER_* */ | |
2052 | ||
2053 | /* For active scans (set to all-0s for passive scans). | |
2054 | * Does not include payload. Must specify Tx rate; no rate scaling. */ | |
bb8c093b | 2055 | struct iwl4965_tx_cmd tx_cmd; |
3058f021 BC |
2056 | |
2057 | /* For directed active scans (set to all-0s otherwise) */ | |
bb8c093b | 2058 | struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX]; |
b481de9c | 2059 | |
b481de9c | 2060 | /* |
3058f021 BC |
2061 | * Probe request frame, followed by channel list. |
2062 | * | |
2063 | * Size of probe request frame is specified by byte count in tx_cmd. | |
2064 | * Channel list follows immediately after probe request frame. | |
2065 | * Number of channels in list is specified by channel_count. | |
2066 | * Each channel in list is of type: | |
b481de9c | 2067 | * |
bb8c093b | 2068 | * struct iwl4965_scan_channel channels[0]; |
b481de9c ZY |
2069 | * |
2070 | * NOTE: Only one band of channels can be scanned per pass. You | |
3058f021 BC |
2071 | * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait |
2072 | * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION) | |
2073 | * before requesting another scan. | |
b481de9c | 2074 | */ |
3058f021 | 2075 | u8 data[0]; |
b481de9c ZY |
2076 | } __attribute__ ((packed)); |
2077 | ||
2078 | /* Can abort will notify by complete notification with abort status. */ | |
2079 | #define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1) | |
2080 | /* complete notification statuses */ | |
2081 | #define ABORT_STATUS 0x2 | |
2082 | ||
2083 | /* | |
2084 | * REPLY_SCAN_CMD = 0x80 (response) | |
2085 | */ | |
bb8c093b | 2086 | struct iwl4965_scanreq_notification { |
b481de9c ZY |
2087 | __le32 status; /* 1: okay, 2: cannot fulfill request */ |
2088 | } __attribute__ ((packed)); | |
2089 | ||
2090 | /* | |
2091 | * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command) | |
2092 | */ | |
bb8c093b | 2093 | struct iwl4965_scanstart_notification { |
b481de9c ZY |
2094 | __le32 tsf_low; |
2095 | __le32 tsf_high; | |
2096 | __le32 beacon_timer; | |
2097 | u8 channel; | |
2098 | u8 band; | |
2099 | u8 reserved[2]; | |
2100 | __le32 status; | |
2101 | } __attribute__ ((packed)); | |
2102 | ||
2103 | #define SCAN_OWNER_STATUS 0x1; | |
2104 | #define MEASURE_OWNER_STATUS 0x2; | |
2105 | ||
2106 | #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */ | |
2107 | /* | |
2108 | * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command) | |
2109 | */ | |
bb8c093b | 2110 | struct iwl4965_scanresults_notification { |
b481de9c ZY |
2111 | u8 channel; |
2112 | u8 band; | |
2113 | u8 reserved[2]; | |
2114 | __le32 tsf_low; | |
2115 | __le32 tsf_high; | |
2116 | __le32 statistics[NUMBER_OF_STATISTICS]; | |
2117 | } __attribute__ ((packed)); | |
2118 | ||
2119 | /* | |
2120 | * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command) | |
2121 | */ | |
bb8c093b | 2122 | struct iwl4965_scancomplete_notification { |
b481de9c ZY |
2123 | u8 scanned_channels; |
2124 | u8 status; | |
2125 | u8 reserved; | |
2126 | u8 last_channel; | |
2127 | __le32 tsf_low; | |
2128 | __le32 tsf_high; | |
2129 | } __attribute__ ((packed)); | |
2130 | ||
2131 | ||
2132 | /****************************************************************************** | |
2133 | * (9) | |
2134 | * IBSS/AP Commands and Notifications: | |
2135 | * | |
2136 | *****************************************************************************/ | |
2137 | ||
2138 | /* | |
2139 | * BEACON_NOTIFICATION = 0x90 (notification only, not a command) | |
2140 | */ | |
bb8c093b CH |
2141 | struct iwl4965_beacon_notif { |
2142 | struct iwl4965_tx_resp beacon_notify_hdr; | |
b481de9c ZY |
2143 | __le32 low_tsf; |
2144 | __le32 high_tsf; | |
2145 | __le32 ibss_mgr_status; | |
2146 | } __attribute__ ((packed)); | |
2147 | ||
2148 | /* | |
2149 | * REPLY_TX_BEACON = 0x91 (command, has simple generic response) | |
2150 | */ | |
bb8c093b CH |
2151 | struct iwl4965_tx_beacon_cmd { |
2152 | struct iwl4965_tx_cmd tx; | |
b481de9c ZY |
2153 | __le16 tim_idx; |
2154 | u8 tim_size; | |
2155 | u8 reserved1; | |
2156 | struct ieee80211_hdr frame[0]; /* beacon frame */ | |
2157 | } __attribute__ ((packed)); | |
2158 | ||
2159 | /****************************************************************************** | |
2160 | * (10) | |
2161 | * Statistics Commands and Notifications: | |
2162 | * | |
2163 | *****************************************************************************/ | |
2164 | ||
2165 | #define IWL_TEMP_CONVERT 260 | |
2166 | ||
2167 | #define SUP_RATE_11A_MAX_NUM_CHANNELS 8 | |
2168 | #define SUP_RATE_11B_MAX_NUM_CHANNELS 4 | |
2169 | #define SUP_RATE_11G_MAX_NUM_CHANNELS 12 | |
2170 | ||
2171 | /* Used for passing to driver number of successes and failures per rate */ | |
2172 | struct rate_histogram { | |
2173 | union { | |
2174 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
2175 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
2176 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
2177 | } success; | |
2178 | union { | |
2179 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
2180 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
2181 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
2182 | } failed; | |
2183 | } __attribute__ ((packed)); | |
2184 | ||
2185 | /* statistics command response */ | |
2186 | ||
2187 | struct statistics_rx_phy { | |
2188 | __le32 ina_cnt; | |
2189 | __le32 fina_cnt; | |
2190 | __le32 plcp_err; | |
2191 | __le32 crc32_err; | |
2192 | __le32 overrun_err; | |
2193 | __le32 early_overrun_err; | |
2194 | __le32 crc32_good; | |
2195 | __le32 false_alarm_cnt; | |
2196 | __le32 fina_sync_err_cnt; | |
2197 | __le32 sfd_timeout; | |
2198 | __le32 fina_timeout; | |
2199 | __le32 unresponded_rts; | |
2200 | __le32 rxe_frame_limit_overrun; | |
2201 | __le32 sent_ack_cnt; | |
2202 | __le32 sent_cts_cnt; | |
b481de9c ZY |
2203 | __le32 sent_ba_rsp_cnt; |
2204 | __le32 dsp_self_kill; | |
2205 | __le32 mh_format_err; | |
2206 | __le32 re_acq_main_rssi_sum; | |
2207 | __le32 reserved3; | |
b481de9c ZY |
2208 | } __attribute__ ((packed)); |
2209 | ||
b481de9c ZY |
2210 | struct statistics_rx_ht_phy { |
2211 | __le32 plcp_err; | |
2212 | __le32 overrun_err; | |
2213 | __le32 early_overrun_err; | |
2214 | __le32 crc32_good; | |
2215 | __le32 crc32_err; | |
2216 | __le32 mh_format_err; | |
2217 | __le32 agg_crc32_good; | |
2218 | __le32 agg_mpdu_cnt; | |
2219 | __le32 agg_cnt; | |
2220 | __le32 reserved2; | |
2221 | } __attribute__ ((packed)); | |
b481de9c ZY |
2222 | |
2223 | struct statistics_rx_non_phy { | |
2224 | __le32 bogus_cts; /* CTS received when not expecting CTS */ | |
2225 | __le32 bogus_ack; /* ACK received when not expecting ACK */ | |
2226 | __le32 non_bssid_frames; /* number of frames with BSSID that | |
2227 | * doesn't belong to the STA BSSID */ | |
2228 | __le32 filtered_frames; /* count frames that were dumped in the | |
2229 | * filtering process */ | |
2230 | __le32 non_channel_beacons; /* beacons with our bss id but not on | |
2231 | * our serving channel */ | |
b481de9c ZY |
2232 | __le32 channel_beacons; /* beacons with our bss id and in our |
2233 | * serving channel */ | |
2234 | __le32 num_missed_bcon; /* number of missed beacons */ | |
2235 | __le32 adc_rx_saturation_time; /* count in 0.8us units the time the | |
2236 | * ADC was in saturation */ | |
2237 | __le32 ina_detection_search_time;/* total time (in 0.8us) searched | |
2238 | * for INA */ | |
2239 | __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */ | |
2240 | __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */ | |
2241 | __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */ | |
2242 | __le32 interference_data_flag; /* flag for interference data | |
2243 | * availability. 1 when data is | |
2244 | * available. */ | |
3058f021 | 2245 | __le32 channel_load; /* counts RX Enable time in uSec */ |
b481de9c ZY |
2246 | __le32 dsp_false_alarms; /* DSP false alarm (both OFDM |
2247 | * and CCK) counter */ | |
2248 | __le32 beacon_rssi_a; | |
2249 | __le32 beacon_rssi_b; | |
2250 | __le32 beacon_rssi_c; | |
2251 | __le32 beacon_energy_a; | |
2252 | __le32 beacon_energy_b; | |
2253 | __le32 beacon_energy_c; | |
b481de9c ZY |
2254 | } __attribute__ ((packed)); |
2255 | ||
2256 | struct statistics_rx { | |
2257 | struct statistics_rx_phy ofdm; | |
2258 | struct statistics_rx_phy cck; | |
2259 | struct statistics_rx_non_phy general; | |
b481de9c | 2260 | struct statistics_rx_ht_phy ofdm_ht; |
b481de9c ZY |
2261 | } __attribute__ ((packed)); |
2262 | ||
b481de9c ZY |
2263 | struct statistics_tx_non_phy_agg { |
2264 | __le32 ba_timeout; | |
2265 | __le32 ba_reschedule_frames; | |
2266 | __le32 scd_query_agg_frame_cnt; | |
2267 | __le32 scd_query_no_agg; | |
2268 | __le32 scd_query_agg; | |
2269 | __le32 scd_query_mismatch; | |
2270 | __le32 frame_not_ready; | |
2271 | __le32 underrun; | |
2272 | __le32 bt_prio_kill; | |
2273 | __le32 rx_ba_rsp_cnt; | |
2274 | __le32 reserved2; | |
2275 | __le32 reserved3; | |
2276 | } __attribute__ ((packed)); | |
b481de9c ZY |
2277 | |
2278 | struct statistics_tx { | |
2279 | __le32 preamble_cnt; | |
2280 | __le32 rx_detected_cnt; | |
2281 | __le32 bt_prio_defer_cnt; | |
2282 | __le32 bt_prio_kill_cnt; | |
2283 | __le32 few_bytes_cnt; | |
2284 | __le32 cts_timeout; | |
2285 | __le32 ack_timeout; | |
2286 | __le32 expected_ack_cnt; | |
2287 | __le32 actual_ack_cnt; | |
b481de9c ZY |
2288 | __le32 dump_msdu_cnt; |
2289 | __le32 burst_abort_next_frame_mismatch_cnt; | |
2290 | __le32 burst_abort_missing_next_frame_cnt; | |
2291 | __le32 cts_timeout_collision; | |
2292 | __le32 ack_or_ba_timeout_collision; | |
2293 | struct statistics_tx_non_phy_agg agg; | |
b481de9c ZY |
2294 | } __attribute__ ((packed)); |
2295 | ||
2296 | struct statistics_dbg { | |
2297 | __le32 burst_check; | |
2298 | __le32 burst_count; | |
2299 | __le32 reserved[4]; | |
2300 | } __attribute__ ((packed)); | |
2301 | ||
2302 | struct statistics_div { | |
2303 | __le32 tx_on_a; | |
2304 | __le32 tx_on_b; | |
2305 | __le32 exec_time; | |
2306 | __le32 probe_time; | |
b481de9c ZY |
2307 | __le32 reserved1; |
2308 | __le32 reserved2; | |
b481de9c ZY |
2309 | } __attribute__ ((packed)); |
2310 | ||
2311 | struct statistics_general { | |
2312 | __le32 temperature; | |
b481de9c | 2313 | __le32 temperature_m; |
b481de9c ZY |
2314 | struct statistics_dbg dbg; |
2315 | __le32 sleep_time; | |
2316 | __le32 slots_out; | |
2317 | __le32 slots_idle; | |
2318 | __le32 ttl_timestamp; | |
2319 | struct statistics_div div; | |
b481de9c ZY |
2320 | __le32 rx_enable_counter; |
2321 | __le32 reserved1; | |
2322 | __le32 reserved2; | |
2323 | __le32 reserved3; | |
b481de9c ZY |
2324 | } __attribute__ ((packed)); |
2325 | ||
2326 | /* | |
2327 | * REPLY_STATISTICS_CMD = 0x9c, | |
2328 | * 3945 and 4965 identical. | |
2329 | * | |
2330 | * This command triggers an immediate response containing uCode statistics. | |
2331 | * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below. | |
2332 | * | |
2333 | * If the CLEAR_STATS configuration flag is set, uCode will clear its | |
2334 | * internal copy of the statistics (counters) after issuing the response. | |
2335 | * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below). | |
2336 | * | |
2337 | * If the DISABLE_NOTIF configuration flag is set, uCode will not issue | |
2338 | * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag | |
2339 | * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself. | |
2340 | */ | |
2341 | #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */ | |
2342 | #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */ | |
bb8c093b | 2343 | struct iwl4965_statistics_cmd { |
b481de9c ZY |
2344 | __le32 configuration_flags; /* IWL_STATS_CONF_* */ |
2345 | } __attribute__ ((packed)); | |
2346 | ||
2347 | /* | |
2348 | * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command) | |
2349 | * | |
2350 | * By default, uCode issues this notification after receiving a beacon | |
2351 | * while associated. To disable this behavior, set DISABLE_NOTIF flag in the | |
2352 | * REPLY_STATISTICS_CMD 0x9c, above. | |
2353 | * | |
2354 | * Statistics counters continue to increment beacon after beacon, but are | |
2355 | * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD | |
2356 | * 0x9c with CLEAR_STATS bit set (see above). | |
2357 | * | |
2358 | * uCode also issues this notification during scans. uCode clears statistics | |
2359 | * appropriately so that each notification contains statistics for only the | |
2360 | * one channel that has just been scanned. | |
2361 | */ | |
2362 | #define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2) | |
2363 | #define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8) | |
bb8c093b | 2364 | struct iwl4965_notif_statistics { |
b481de9c ZY |
2365 | __le32 flag; |
2366 | struct statistics_rx rx; | |
2367 | struct statistics_tx tx; | |
2368 | struct statistics_general general; | |
2369 | } __attribute__ ((packed)); | |
2370 | ||
2371 | ||
2372 | /* | |
2373 | * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command) | |
2374 | */ | |
2375 | /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row, | |
2376 | * then this notification will be sent. */ | |
2377 | #define CONSECUTIVE_MISSED_BCONS_TH 20 | |
2378 | ||
bb8c093b | 2379 | struct iwl4965_missed_beacon_notif { |
b481de9c ZY |
2380 | __le32 consequtive_missed_beacons; |
2381 | __le32 total_missed_becons; | |
2382 | __le32 num_expected_beacons; | |
2383 | __le32 num_recvd_beacons; | |
2384 | } __attribute__ ((packed)); | |
2385 | ||
f7d09d7c | 2386 | |
b481de9c ZY |
2387 | /****************************************************************************** |
2388 | * (11) | |
2389 | * Rx Calibration Commands: | |
2390 | * | |
f7d09d7c BC |
2391 | * With the uCode used for open source drivers, most Tx calibration (except |
2392 | * for Tx Power) and most Rx calibration is done by uCode during the | |
2393 | * "initialize" phase of uCode boot. Driver must calibrate only: | |
2394 | * | |
2395 | * 1) Tx power (depends on temperature), described elsewhere | |
2396 | * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas) | |
2397 | * 3) Receiver sensitivity (to optimize signal detection) | |
2398 | * | |
b481de9c ZY |
2399 | *****************************************************************************/ |
2400 | ||
f7d09d7c BC |
2401 | /** |
2402 | * SENSITIVITY_CMD = 0xa8 (command, has simple generic response) | |
2403 | * | |
2404 | * This command sets up the Rx signal detector for a sensitivity level that | |
2405 | * is high enough to lock onto all signals within the associated network, | |
2406 | * but low enough to ignore signals that are below a certain threshold, so as | |
2407 | * not to have too many "false alarms". False alarms are signals that the | |
2408 | * Rx DSP tries to lock onto, but then discards after determining that they | |
2409 | * are noise. | |
2410 | * | |
2411 | * The optimum number of false alarms is between 5 and 50 per 200 TUs | |
2412 | * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e. | |
2413 | * time listening, not transmitting). Driver must adjust sensitivity so that | |
2414 | * the ratio of actual false alarms to actual Rx time falls within this range. | |
2415 | * | |
2416 | * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each | |
2417 | * received beacon. These provide information to the driver to analyze the | |
2418 | * sensitivity. Don't analyze statistics that come in from scanning, or any | |
2419 | * other non-associated-network source. Pertinent statistics include: | |
2420 | * | |
2421 | * From "general" statistics (struct statistics_rx_non_phy): | |
2422 | * | |
2423 | * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level) | |
2424 | * Measure of energy of desired signal. Used for establishing a level | |
2425 | * below which the device does not detect signals. | |
2426 | * | |
2427 | * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB) | |
2428 | * Measure of background noise in silent period after beacon. | |
2429 | * | |
2430 | * channel_load | |
2431 | * uSecs of actual Rx time during beacon period (varies according to | |
2432 | * how much time was spent transmitting). | |
2433 | * | |
2434 | * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately: | |
2435 | * | |
2436 | * false_alarm_cnt | |
2437 | * Signal locks abandoned early (before phy-level header). | |
2438 | * | |
2439 | * plcp_err | |
2440 | * Signal locks abandoned late (during phy-level header). | |
2441 | * | |
2442 | * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from | |
2443 | * beacon to beacon, i.e. each value is an accumulation of all errors | |
2444 | * before and including the latest beacon. Values will wrap around to 0 | |
2445 | * after counting up to 2^32 - 1. Driver must differentiate vs. | |
2446 | * previous beacon's values to determine # false alarms in the current | |
2447 | * beacon period. | |
2448 | * | |
2449 | * Total number of false alarms = false_alarms + plcp_errs | |
2450 | * | |
2451 | * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd | |
2452 | * (notice that the start points for OFDM are at or close to settings for | |
2453 | * maximum sensitivity): | |
2454 | * | |
2455 | * START / MIN / MAX | |
2456 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120 | |
2457 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210 | |
2458 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140 | |
2459 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270 | |
2460 | * | |
2461 | * If actual rate of OFDM false alarms (+ plcp_errors) is too high | |
2462 | * (greater than 50 for each 204.8 msecs listening), reduce sensitivity | |
2463 | * by *adding* 1 to all 4 of the table entries above, up to the max for | |
2464 | * each entry. Conversely, if false alarm rate is too low (less than 5 | |
2465 | * for each 204.8 msecs listening), *subtract* 1 from each entry to | |
2466 | * increase sensitivity. | |
2467 | * | |
2468 | * For CCK sensitivity, keep track of the following: | |
2469 | * | |
2470 | * 1). 20-beacon history of maximum background noise, indicated by | |
2471 | * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the | |
2472 | * 3 receivers. For any given beacon, the "silence reference" is | |
2473 | * the maximum of last 60 samples (20 beacons * 3 receivers). | |
2474 | * | |
2475 | * 2). 10-beacon history of strongest signal level, as indicated | |
2476 | * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers, | |
2477 | * i.e. the strength of the signal through the best receiver at the | |
2478 | * moment. These measurements are "upside down", with lower values | |
2479 | * for stronger signals, so max energy will be *minimum* value. | |
2480 | * | |
2481 | * Then for any given beacon, the driver must determine the *weakest* | |
2482 | * of the strongest signals; this is the minimum level that needs to be | |
2483 | * successfully detected, when using the best receiver at the moment. | |
2484 | * "Max cck energy" is the maximum (higher value means lower energy!) | |
2485 | * of the last 10 minima. Once this is determined, driver must add | |
2486 | * a little margin by adding "6" to it. | |
2487 | * | |
2488 | * 3). Number of consecutive beacon periods with too few false alarms. | |
2489 | * Reset this to 0 at the first beacon period that falls within the | |
2490 | * "good" range (5 to 50 false alarms per 204.8 milliseconds rx). | |
2491 | * | |
2492 | * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd | |
2493 | * (notice that the start points for CCK are at maximum sensitivity): | |
2494 | * | |
2495 | * START / MIN / MAX | |
2496 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200 | |
2497 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400 | |
2498 | * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100 | |
2499 | * | |
2500 | * If actual rate of CCK false alarms (+ plcp_errors) is too high | |
2501 | * (greater than 50 for each 204.8 msecs listening), method for reducing | |
2502 | * sensitivity is: | |
2503 | * | |
2504 | * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
2505 | * up to max 400. | |
2506 | * | |
2507 | * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160, | |
2508 | * sensitivity has been reduced a significant amount; bring it up to | |
2509 | * a moderate 161. Otherwise, *add* 3, up to max 200. | |
2510 | * | |
2511 | * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160, | |
2512 | * sensitivity has been reduced only a moderate or small amount; | |
2513 | * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX, | |
2514 | * down to min 0. Otherwise (if gain has been significantly reduced), | |
2515 | * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value. | |
2516 | * | |
2517 | * b) Save a snapshot of the "silence reference". | |
2518 | * | |
2519 | * If actual rate of CCK false alarms (+ plcp_errors) is too low | |
2520 | * (less than 5 for each 204.8 msecs listening), method for increasing | |
2521 | * sensitivity is used only if: | |
2522 | * | |
2523 | * 1a) Previous beacon did not have too many false alarms | |
2524 | * 1b) AND difference between previous "silence reference" and current | |
2525 | * "silence reference" (prev - current) is 2 or more, | |
2526 | * OR 2) 100 or more consecutive beacon periods have had rate of | |
2527 | * less than 5 false alarms per 204.8 milliseconds rx time. | |
2528 | * | |
2529 | * Method for increasing sensitivity: | |
2530 | * | |
2531 | * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX, | |
2532 | * down to min 125. | |
2533 | * | |
2534 | * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
2535 | * down to min 200. | |
2536 | * | |
2537 | * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100. | |
2538 | * | |
2539 | * If actual rate of CCK false alarms (+ plcp_errors) is within good range | |
2540 | * (between 5 and 50 for each 204.8 msecs listening): | |
2541 | * | |
2542 | * 1) Save a snapshot of the silence reference. | |
2543 | * | |
2544 | * 2) If previous beacon had too many CCK false alarms (+ plcp_errors), | |
2545 | * give some extra margin to energy threshold by *subtracting* 8 | |
2546 | * from value in HD_MIN_ENERGY_CCK_DET_INDEX. | |
2547 | * | |
2548 | * For all cases (too few, too many, good range), make sure that the CCK | |
2549 | * detection threshold (energy) is below the energy level for robust | |
2550 | * detection over the past 10 beacon periods, the "Max cck energy". | |
2551 | * Lower values mean higher energy; this means making sure that the value | |
2552 | * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy". | |
2553 | * | |
2554 | * Driver should set the following entries to fixed values: | |
2555 | * | |
2556 | * HD_MIN_ENERGY_OFDM_DET_INDEX 100 | |
2557 | * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190 | |
2558 | * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390 | |
2559 | * HD_OFDM_ENERGY_TH_IN_INDEX 62 | |
2560 | */ | |
2561 | ||
2562 | /* | |
2563 | * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd) | |
2564 | */ | |
2565 | #define HD_TABLE_SIZE (11) /* number of entries */ | |
2566 | #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */ | |
2567 | #define HD_MIN_ENERGY_OFDM_DET_INDEX (1) | |
2568 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2) | |
2569 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3) | |
2570 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4) | |
2571 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5) | |
2572 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6) | |
2573 | #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7) | |
2574 | #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8) | |
2575 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9) | |
2576 | #define HD_OFDM_ENERGY_TH_IN_INDEX (10) | |
2577 | ||
2578 | /* Control field in struct iwl4965_sensitivity_cmd */ | |
2579 | #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0) | |
2580 | #define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1) | |
b481de9c | 2581 | |
f7d09d7c BC |
2582 | /** |
2583 | * struct iwl4965_sensitivity_cmd | |
2584 | * @control: (1) updates working table, (0) updates default table | |
2585 | * @table: energy threshold values, use HD_* as index into table | |
2586 | * | |
2587 | * Always use "1" in "control" to update uCode's working table and DSP. | |
2588 | */ | |
bb8c093b | 2589 | struct iwl4965_sensitivity_cmd { |
f7d09d7c BC |
2590 | __le16 control; /* always use "1" */ |
2591 | __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */ | |
b481de9c ZY |
2592 | } __attribute__ ((packed)); |
2593 | ||
f7d09d7c BC |
2594 | |
2595 | /** | |
2596 | * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response) | |
2597 | * | |
2598 | * This command sets the relative gains of 4965's 3 radio receiver chains. | |
2599 | * | |
2600 | * After the first association, driver should accumulate signal and noise | |
2601 | * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20 | |
2602 | * beacons from the associated network (don't collect statistics that come | |
2603 | * in from scanning, or any other non-network source). | |
2604 | * | |
2605 | * DISCONNECTED ANTENNA: | |
2606 | * | |
2607 | * Driver should determine which antennas are actually connected, by comparing | |
2608 | * average beacon signal levels for the 3 Rx chains. Accumulate (add) the | |
2609 | * following values over 20 beacons, one accumulator for each of the chains | |
2610 | * a/b/c, from struct statistics_rx_non_phy: | |
2611 | * | |
2612 | * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
2613 | * | |
2614 | * Find the strongest signal from among a/b/c. Compare the other two to the | |
2615 | * strongest. If any signal is more than 15 dB (times 20, unless you | |
2616 | * divide the accumulated values by 20) below the strongest, the driver | |
2617 | * considers that antenna to be disconnected, and should not try to use that | |
2618 | * antenna/chain for Rx or Tx. If both A and B seem to be disconnected, | |
2619 | * driver should declare the stronger one as connected, and attempt to use it | |
2620 | * (A and B are the only 2 Tx chains!). | |
2621 | * | |
2622 | * | |
2623 | * RX BALANCE: | |
2624 | * | |
2625 | * Driver should balance the 3 receivers (but just the ones that are connected | |
2626 | * to antennas, see above) for gain, by comparing the average signal levels | |
2627 | * detected during the silence after each beacon (background noise). | |
2628 | * Accumulate (add) the following values over 20 beacons, one accumulator for | |
2629 | * each of the chains a/b/c, from struct statistics_rx_non_phy: | |
2630 | * | |
2631 | * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
2632 | * | |
2633 | * Find the weakest background noise level from among a/b/c. This Rx chain | |
2634 | * will be the reference, with 0 gain adjustment. Attenuate other channels by | |
2635 | * finding noise difference: | |
2636 | * | |
2637 | * (accum_noise[i] - accum_noise[reference]) / 30 | |
2638 | * | |
2639 | * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB. | |
2640 | * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the | |
2641 | * driver should limit the difference results to a range of 0-3 (0-4.5 dB), | |
2642 | * and set bit 2 to indicate "reduce gain". The value for the reference | |
2643 | * (weakest) chain should be "0". | |
2644 | * | |
2645 | * diff_gain_[abc] bit fields: | |
2646 | * 2: (1) reduce gain, (0) increase gain | |
2647 | * 1-0: amount of gain, units of 1.5 dB | |
2648 | */ | |
2649 | ||
2650 | /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */ | |
2651 | #define PHY_CALIBRATE_DIFF_GAIN_CMD (7) | |
2652 | ||
bb8c093b | 2653 | struct iwl4965_calibration_cmd { |
f7d09d7c BC |
2654 | u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */ |
2655 | u8 flags; /* not used */ | |
b481de9c | 2656 | __le16 reserved; |
f7d09d7c | 2657 | s8 diff_gain_a; /* see above */ |
b481de9c ZY |
2658 | s8 diff_gain_b; |
2659 | s8 diff_gain_c; | |
2660 | u8 reserved1; | |
2661 | } __attribute__ ((packed)); | |
2662 | ||
2663 | /****************************************************************************** | |
2664 | * (12) | |
2665 | * Miscellaneous Commands: | |
2666 | * | |
2667 | *****************************************************************************/ | |
2668 | ||
2669 | /* | |
2670 | * LEDs Command & Response | |
2671 | * REPLY_LEDS_CMD = 0x48 (command, has simple generic response) | |
2672 | * | |
2673 | * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field), | |
2674 | * this command turns it on or off, or sets up a periodic blinking cycle. | |
2675 | */ | |
bb8c093b | 2676 | struct iwl4965_led_cmd { |
b481de9c ZY |
2677 | __le32 interval; /* "interval" in uSec */ |
2678 | u8 id; /* 1: Activity, 2: Link, 3: Tech */ | |
2679 | u8 off; /* # intervals off while blinking; | |
2680 | * "0", with >0 "on" value, turns LED on */ | |
2681 | u8 on; /* # intervals on while blinking; | |
2682 | * "0", regardless of "off", turns LED off */ | |
2683 | u8 reserved; | |
2684 | } __attribute__ ((packed)); | |
2685 | ||
2686 | /****************************************************************************** | |
2687 | * (13) | |
2688 | * Union of all expected notifications/responses: | |
2689 | * | |
2690 | *****************************************************************************/ | |
2691 | ||
bb8c093b | 2692 | struct iwl4965_rx_packet { |
b481de9c | 2693 | __le32 len; |
857485c0 | 2694 | struct iwl_cmd_header hdr; |
b481de9c | 2695 | union { |
bb8c093b CH |
2696 | struct iwl4965_alive_resp alive_frame; |
2697 | struct iwl4965_rx_frame rx_frame; | |
2698 | struct iwl4965_tx_resp tx_resp; | |
2699 | struct iwl4965_spectrum_notification spectrum_notif; | |
2700 | struct iwl4965_csa_notification csa_notif; | |
2701 | struct iwl4965_error_resp err_resp; | |
2702 | struct iwl4965_card_state_notif card_state_notif; | |
2703 | struct iwl4965_beacon_notif beacon_status; | |
2704 | struct iwl4965_add_sta_resp add_sta; | |
2705 | struct iwl4965_sleep_notification sleep_notif; | |
2706 | struct iwl4965_spectrum_resp spectrum; | |
2707 | struct iwl4965_notif_statistics stats; | |
2708 | struct iwl4965_compressed_ba_resp compressed_ba; | |
2709 | struct iwl4965_missed_beacon_notif missed_beacon; | |
b481de9c ZY |
2710 | __le32 status; |
2711 | u8 raw[0]; | |
2712 | } u; | |
2713 | } __attribute__ ((packed)); | |
2714 | ||
bb8c093b | 2715 | #define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame)) |
b481de9c | 2716 | |
bb8c093b | 2717 | #endif /* __iwl4965_commands_h__ */ |