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 | * | |
8 | * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved. | |
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 | * | |
33 | * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved. | |
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 | ||
87 | /* RX, TX, LEDs */ | |
b481de9c ZY |
88 | REPLY_TX = 0x1c, |
89 | REPLY_RATE_SCALE = 0x47, /* 3945 only */ | |
90 | REPLY_LEDS_CMD = 0x48, | |
91 | REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */ | |
92 | ||
93 | /* 802.11h related */ | |
94 | RADAR_NOTIFICATION = 0x70, /* not used */ | |
95 | REPLY_QUIET_CMD = 0x71, /* not used */ | |
96 | REPLY_CHANNEL_SWITCH = 0x72, | |
97 | CHANNEL_SWITCH_NOTIFICATION = 0x73, | |
98 | REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74, | |
99 | SPECTRUM_MEASURE_NOTIFICATION = 0x75, | |
100 | ||
101 | /* Power Management */ | |
102 | POWER_TABLE_CMD = 0x77, | |
103 | PM_SLEEP_NOTIFICATION = 0x7A, | |
104 | PM_DEBUG_STATISTIC_NOTIFIC = 0x7B, | |
105 | ||
106 | /* Scan commands and notifications */ | |
107 | REPLY_SCAN_CMD = 0x80, | |
108 | REPLY_SCAN_ABORT_CMD = 0x81, | |
109 | SCAN_START_NOTIFICATION = 0x82, | |
110 | SCAN_RESULTS_NOTIFICATION = 0x83, | |
111 | SCAN_COMPLETE_NOTIFICATION = 0x84, | |
112 | ||
113 | /* IBSS/AP commands */ | |
114 | BEACON_NOTIFICATION = 0x90, | |
115 | REPLY_TX_BEACON = 0x91, | |
116 | WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */ | |
117 | ||
118 | /* Miscellaneous commands */ | |
119 | QUIET_NOTIFICATION = 0x96, /* not used */ | |
120 | REPLY_TX_PWR_TABLE_CMD = 0x97, | |
121 | MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */ | |
122 | ||
075416cd | 123 | /* Bluetooth device coexistance config command */ |
b481de9c ZY |
124 | REPLY_BT_CONFIG = 0x9b, |
125 | ||
80cc0c38 | 126 | /* Statistics */ |
b481de9c ZY |
127 | REPLY_STATISTICS_CMD = 0x9c, |
128 | STATISTICS_NOTIFICATION = 0x9d, | |
129 | ||
130 | /* RF-KILL commands and notifications */ | |
131 | REPLY_CARD_STATE_CMD = 0xa0, | |
132 | CARD_STATE_NOTIFICATION = 0xa1, | |
133 | ||
134 | /* Missed beacons notification */ | |
135 | MISSED_BEACONS_NOTIFICATION = 0xa2, | |
136 | ||
b481de9c ZY |
137 | REPLY_CT_KILL_CONFIG_CMD = 0xa4, |
138 | SENSITIVITY_CMD = 0xa8, | |
139 | REPLY_PHY_CALIBRATION_CMD = 0xb0, | |
140 | REPLY_RX_PHY_CMD = 0xc0, | |
141 | REPLY_RX_MPDU_CMD = 0xc1, | |
142 | REPLY_4965_RX = 0xc3, | |
143 | REPLY_COMPRESSED_BA = 0xc5, | |
b481de9c ZY |
144 | REPLY_MAX = 0xff |
145 | }; | |
146 | ||
147 | /****************************************************************************** | |
148 | * (0) | |
abceddb4 | 149 | * Commonly used structures and definitions: |
80cc0c38 | 150 | * Command header, rate_n_flags, txpower |
b481de9c ZY |
151 | * |
152 | *****************************************************************************/ | |
153 | ||
075416cd | 154 | /* iwl4965_cmd_header flags value */ |
b481de9c ZY |
155 | #define IWL_CMD_FAILED_MSK 0x40 |
156 | ||
075416cd BC |
157 | /** |
158 | * struct iwl4965_cmd_header | |
159 | * | |
160 | * This header format appears in the beginning of each command sent from the | |
161 | * driver, and each response/notification received from uCode. | |
162 | */ | |
bb8c093b | 163 | struct iwl4965_cmd_header { |
075416cd BC |
164 | u8 cmd; /* Command ID: REPLY_RXON, etc. */ |
165 | u8 flags; /* IWL_CMD_* */ | |
166 | /* | |
167 | * The driver sets up the sequence number to values of its chosing. | |
168 | * uCode does not use this value, but passes it back to the driver | |
169 | * when sending the response to each driver-originated command, so | |
170 | * the driver can match the response to the command. Since the values | |
171 | * don't get used by uCode, the driver may set up an arbitrary format. | |
b481de9c | 172 | * |
075416cd BC |
173 | * There is one exception: uCode sets bit 15 when it originates |
174 | * the response/notification, i.e. when the response/notification | |
175 | * is not a direct response to a command sent by the driver. For | |
176 | * example, uCode issues REPLY_3945_RX when it sends a received frame | |
177 | * to the driver; it is not a direct response to any driver command. | |
b481de9c | 178 | * |
075416cd BC |
179 | * The Linux driver uses the following format: |
180 | * | |
181 | * 0:7 index/position within Tx queue | |
182 | * 8:13 Tx queue selection | |
183 | * 14:14 driver sets this to indicate command is in the 'huge' | |
184 | * storage at the end of the command buffers, i.e. scan cmd | |
185 | * 15:15 uCode sets this in uCode-originated response/notification | |
b481de9c ZY |
186 | */ |
187 | __le16 sequence; | |
188 | ||
075416cd | 189 | /* command or response/notification data follows immediately */ |
b481de9c ZY |
190 | u8 data[0]; |
191 | } __attribute__ ((packed)); | |
192 | ||
abceddb4 BC |
193 | /** |
194 | * 4965 rate_n_flags bit fields | |
195 | * | |
196 | * rate_n_flags format is used in following 4965 commands: | |
197 | * REPLY_4965_RX (response only) | |
198 | * REPLY_TX (both command and response) | |
199 | * REPLY_TX_LINK_QUALITY_CMD | |
200 | * | |
201 | * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"): | |
202 | * 2-0: 0) 6 Mbps | |
203 | * 1) 12 Mbps | |
204 | * 2) 18 Mbps | |
205 | * 3) 24 Mbps | |
206 | * 4) 36 Mbps | |
207 | * 5) 48 Mbps | |
208 | * 6) 54 Mbps | |
209 | * 7) 60 Mbps | |
210 | * | |
211 | * 3: 0) Single stream (SISO) | |
212 | * 1) Dual stream (MIMO) | |
213 | * | |
214 | * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data | |
215 | * | |
216 | * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"): | |
217 | * 3-0: 0xD) 6 Mbps | |
218 | * 0xF) 9 Mbps | |
219 | * 0x5) 12 Mbps | |
220 | * 0x7) 18 Mbps | |
221 | * 0x9) 24 Mbps | |
222 | * 0xB) 36 Mbps | |
223 | * 0x1) 48 Mbps | |
224 | * 0x3) 54 Mbps | |
225 | * | |
226 | * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"): | |
227 | * 3-0: 10) 1 Mbps | |
228 | * 20) 2 Mbps | |
229 | * 55) 5.5 Mbps | |
230 | * 110) 11 Mbps | |
231 | */ | |
232 | #define RATE_MCS_CODE_MSK 0x7 | |
233 | #define RATE_MCS_MIMO_POS 3 | |
234 | #define RATE_MCS_MIMO_MSK 0x8 | |
235 | #define RATE_MCS_HT_DUP_POS 5 | |
236 | #define RATE_MCS_HT_DUP_MSK 0x20 | |
237 | ||
075416cd | 238 | /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */ |
abceddb4 BC |
239 | #define RATE_MCS_FLAGS_POS 8 |
240 | #define RATE_MCS_HT_POS 8 | |
241 | #define RATE_MCS_HT_MSK 0x100 | |
242 | ||
075416cd | 243 | /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ |
abceddb4 BC |
244 | #define RATE_MCS_CCK_POS 9 |
245 | #define RATE_MCS_CCK_MSK 0x200 | |
246 | ||
075416cd | 247 | /* Bit 10: (1) Use Green Field preamble */ |
abceddb4 BC |
248 | #define RATE_MCS_GF_POS 10 |
249 | #define RATE_MCS_GF_MSK 0x400 | |
250 | ||
075416cd | 251 | /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */ |
abceddb4 BC |
252 | #define RATE_MCS_FAT_POS 11 |
253 | #define RATE_MCS_FAT_MSK 0x800 | |
254 | ||
075416cd | 255 | /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */ |
abceddb4 BC |
256 | #define RATE_MCS_DUP_POS 12 |
257 | #define RATE_MCS_DUP_MSK 0x1000 | |
258 | ||
075416cd | 259 | /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ |
abceddb4 BC |
260 | #define RATE_MCS_SGI_POS 13 |
261 | #define RATE_MCS_SGI_MSK 0x2000 | |
262 | ||
263 | /** | |
264 | * rate_n_flags Tx antenna masks (4965 has 2 transmitters): | |
265 | * bit14:15 01 B inactive, A active | |
266 | * 10 B active, A inactive | |
267 | * 11 Both active | |
268 | */ | |
269 | #define RATE_MCS_ANT_A_POS 14 | |
270 | #define RATE_MCS_ANT_B_POS 15 | |
271 | #define RATE_MCS_ANT_A_MSK 0x4000 | |
272 | #define RATE_MCS_ANT_B_MSK 0x8000 | |
273 | #define RATE_MCS_ANT_AB_MSK 0xc000 | |
274 | ||
275 | ||
80cc0c38 BC |
276 | /** |
277 | * struct iwl4965_tx_power - txpower format used in REPLY_SCAN_CMD | |
278 | * | |
279 | * Scan uses only one transmitter, so only one analog/dsp gain pair is needed. | |
280 | */ | |
281 | struct iwl4965_tx_power { | |
282 | u8 tx_gain; /* gain for analog radio */ | |
283 | u8 dsp_atten; /* gain for DSP */ | |
284 | } __attribute__ ((packed)); | |
285 | ||
286 | #define POWER_TABLE_NUM_ENTRIES 33 | |
287 | #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32 | |
288 | #define POWER_TABLE_CCK_ENTRY 32 | |
289 | ||
290 | /** | |
291 | * union iwl4965_tx_power_dual_stream | |
292 | * | |
293 | * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
294 | * Use __le32 version (struct tx_power_dual_stream) when building command. | |
295 | * | |
296 | * Driver provides radio gain and DSP attenuation settings to device in pairs, | |
297 | * one value for each transmitter chain. The first value is for transmitter A, | |
298 | * second for transmitter B. | |
299 | * | |
300 | * For SISO bit rates, both values in a pair should be identical. | |
301 | * For MIMO rates, one value may be different from the other, | |
302 | * in order to balance the Tx output between the two transmitters. | |
303 | * | |
304 | * See more details in doc for TXPOWER in iwl-4965-hw.h. | |
305 | */ | |
306 | union iwl4965_tx_power_dual_stream { | |
307 | struct { | |
308 | u8 radio_tx_gain[2]; | |
309 | u8 dsp_predis_atten[2]; | |
310 | } s; | |
311 | u32 dw; | |
312 | }; | |
313 | ||
314 | /** | |
315 | * struct tx_power_dual_stream | |
316 | * | |
317 | * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
318 | * | |
319 | * Same format as iwl_tx_power_dual_stream, but __le32 | |
320 | */ | |
321 | struct tx_power_dual_stream { | |
322 | __le32 dw; | |
323 | } __attribute__ ((packed)); | |
324 | ||
325 | /** | |
326 | * struct iwl4965_tx_power_db | |
327 | * | |
328 | * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH | |
329 | */ | |
330 | struct iwl4965_tx_power_db { | |
331 | struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES]; | |
332 | } __attribute__ ((packed)); | |
333 | ||
334 | ||
b481de9c ZY |
335 | /****************************************************************************** |
336 | * (0a) | |
337 | * Alive and Error Commands & Responses: | |
338 | * | |
339 | *****************************************************************************/ | |
340 | ||
341 | #define UCODE_VALID_OK __constant_cpu_to_le32(0x1) | |
342 | #define INITIALIZE_SUBTYPE (9) | |
343 | ||
344 | /* | |
075416cd BC |
345 | * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command) |
346 | * | |
347 | * uCode issues this "initialize alive" notification once the initialization | |
348 | * uCode image has completed its work, and is ready to load the runtime image. | |
349 | * This is the *first* "alive" notification that the driver will receive after | |
350 | * rebooting uCode; the "initialize" alive is indicated by subtype field == 9. | |
351 | * | |
352 | * See comments documenting "BSM" (bootstrap state machine). | |
353 | * | |
354 | * For 4965, this notification contains important calibration data for | |
355 | * calculating txpower settings: | |
356 | * | |
357 | * 1) Power supply voltage indication. The voltage sensor outputs higher | |
358 | * values for lower voltage, and vice versa. | |
359 | * | |
360 | * 2) Temperature measurement parameters, for each of two channel widths | |
361 | * (20 MHz and 40 MHz) supported by the radios. Temperature sensing | |
362 | * is done via one of the receiver chains, and channel width influences | |
363 | * the results. | |
364 | * | |
365 | * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation, | |
366 | * for each of 5 frequency ranges. | |
b481de9c | 367 | */ |
075416cd | 368 | struct iwl4965_init_alive_resp { |
b481de9c ZY |
369 | u8 ucode_minor; |
370 | u8 ucode_major; | |
371 | __le16 reserved1; | |
372 | u8 sw_rev[8]; | |
373 | u8 ver_type; | |
075416cd | 374 | u8 ver_subtype; /* "9" for initialize alive */ |
b481de9c ZY |
375 | __le16 reserved2; |
376 | __le32 log_event_table_ptr; | |
377 | __le32 error_event_table_ptr; | |
378 | __le32 timestamp; | |
379 | __le32 is_valid; | |
075416cd BC |
380 | |
381 | /* calibration values from "initialize" uCode */ | |
382 | __le32 voltage; /* signed, higher value is lower voltage */ | |
383 | __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/ | |
384 | __le32 therm_r2[2]; /* signed */ | |
385 | __le32 therm_r3[2]; /* signed */ | |
386 | __le32 therm_r4[2]; /* signed */ | |
387 | __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups, | |
388 | * 2 Tx chains */ | |
b481de9c ZY |
389 | } __attribute__ ((packed)); |
390 | ||
075416cd BC |
391 | |
392 | /** | |
393 | * REPLY_ALIVE = 0x1 (response only, not a command) | |
394 | * | |
395 | * uCode issues this "alive" notification once the runtime image is ready | |
396 | * to receive commands from the driver. This is the *second* "alive" | |
397 | * notification that the driver will receive after rebooting uCode; | |
398 | * this "alive" is indicated by subtype field != 9. | |
399 | * | |
400 | * See comments documenting "BSM" (bootstrap state machine). | |
401 | * | |
402 | * This response includes two pointers to structures within the device's | |
403 | * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging: | |
404 | * | |
405 | * 1) log_event_table_ptr indicates base of the event log. This traces | |
406 | * a 256-entry history of uCode execution within a circular buffer. | |
407 | * Its header format is: | |
408 | * | |
409 | * __le32 log_size; log capacity (in number of entries) | |
410 | * __le32 type; (1) timestamp with each entry, (0) no timestamp | |
411 | * __le32 wraps; # times uCode has wrapped to top of circular buffer | |
412 | * __le32 write_index; next circular buffer entry that uCode would fill | |
413 | * | |
414 | * The header is followed by the circular buffer of log entries. Entries | |
415 | * with timestamps have the following format: | |
416 | * | |
417 | * __le32 event_id; range 0 - 1500 | |
418 | * __le32 timestamp; low 32 bits of TSF (of network, if associated) | |
419 | * __le32 data; event_id-specific data value | |
420 | * | |
421 | * Entries without timestamps contain only event_id and data. | |
422 | * | |
423 | * 2) error_event_table_ptr indicates base of the error log. This contains | |
424 | * information about any uCode error that occurs. For 4965, the format | |
425 | * of the error log is: | |
426 | * | |
427 | * __le32 valid; (nonzero) valid, (0) log is empty | |
428 | * __le32 error_id; type of error | |
429 | * __le32 pc; program counter | |
430 | * __le32 blink1; branch link | |
431 | * __le32 blink2; branch link | |
432 | * __le32 ilink1; interrupt link | |
433 | * __le32 ilink2; interrupt link | |
434 | * __le32 data1; error-specific data | |
435 | * __le32 data2; error-specific data | |
436 | * __le32 line; source code line of error | |
437 | * __le32 bcon_time; beacon timer | |
438 | * __le32 tsf_low; network timestamp function timer | |
439 | * __le32 tsf_hi; network timestamp function timer | |
440 | * | |
441 | * The Linux driver can print both logs to the system log when a uCode error | |
442 | * occurs. | |
443 | */ | |
444 | struct iwl4965_alive_resp { | |
b481de9c ZY |
445 | u8 ucode_minor; |
446 | u8 ucode_major; | |
447 | __le16 reserved1; | |
448 | u8 sw_rev[8]; | |
449 | u8 ver_type; | |
075416cd | 450 | u8 ver_subtype; /* not "9" for runtime alive */ |
b481de9c | 451 | __le16 reserved2; |
075416cd BC |
452 | __le32 log_event_table_ptr; /* SRAM address for event log */ |
453 | __le32 error_event_table_ptr; /* SRAM address for error log */ | |
b481de9c ZY |
454 | __le32 timestamp; |
455 | __le32 is_valid; | |
b481de9c ZY |
456 | } __attribute__ ((packed)); |
457 | ||
075416cd | 458 | |
b481de9c ZY |
459 | union tsf { |
460 | u8 byte[8]; | |
461 | __le16 word[4]; | |
462 | __le32 dw[2]; | |
463 | }; | |
464 | ||
465 | /* | |
466 | * REPLY_ERROR = 0x2 (response only, not a command) | |
467 | */ | |
bb8c093b | 468 | struct iwl4965_error_resp { |
b481de9c ZY |
469 | __le32 error_type; |
470 | u8 cmd_id; | |
471 | u8 reserved1; | |
472 | __le16 bad_cmd_seq_num; | |
b481de9c ZY |
473 | __le32 error_info; |
474 | union tsf timestamp; | |
475 | } __attribute__ ((packed)); | |
476 | ||
477 | /****************************************************************************** | |
478 | * (1) | |
479 | * RXON Commands & Responses: | |
480 | * | |
481 | *****************************************************************************/ | |
482 | ||
483 | /* | |
484 | * Rx config defines & structure | |
485 | */ | |
486 | /* rx_config device types */ | |
487 | enum { | |
488 | RXON_DEV_TYPE_AP = 1, | |
489 | RXON_DEV_TYPE_ESS = 3, | |
490 | RXON_DEV_TYPE_IBSS = 4, | |
491 | RXON_DEV_TYPE_SNIFFER = 6, | |
492 | }; | |
493 | ||
14519a0b BC |
494 | |
495 | #define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1<<0) | |
496 | #define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7<<1) | |
497 | #define RXON_RX_CHAIN_VALID_POS (1) | |
498 | #define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7<<4) | |
499 | #define RXON_RX_CHAIN_FORCE_SEL_POS (4) | |
500 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7<<7) | |
501 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7) | |
502 | #define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3<<10) | |
503 | #define RXON_RX_CHAIN_CNT_POS (10) | |
504 | #define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3<<12) | |
505 | #define RXON_RX_CHAIN_MIMO_CNT_POS (12) | |
506 | #define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1<<14) | |
507 | #define RXON_RX_CHAIN_MIMO_FORCE_POS (14) | |
508 | ||
b481de9c ZY |
509 | /* rx_config flags */ |
510 | /* band & modulation selection */ | |
511 | #define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0) | |
512 | #define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1) | |
513 | /* auto detection enable */ | |
514 | #define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2) | |
515 | /* TGg protection when tx */ | |
516 | #define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3) | |
517 | /* cck short slot & preamble */ | |
518 | #define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4) | |
519 | #define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5) | |
520 | /* antenna selection */ | |
521 | #define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7) | |
522 | #define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00) | |
523 | #define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8) | |
524 | #define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9) | |
525 | /* radar detection enable */ | |
526 | #define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12) | |
527 | #define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13) | |
528 | /* rx response to host with 8-byte TSF | |
529 | * (according to ON_AIR deassertion) */ | |
530 | #define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15) | |
531 | ||
14519a0b BC |
532 | |
533 | /* HT flags */ | |
534 | #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22) | |
535 | #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1<<22) | |
536 | ||
537 | #define RXON_FLG_HT_OPERATING_MODE_POS (23) | |
538 | ||
539 | #define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1<<23) | |
540 | #define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2<<23) | |
541 | ||
542 | #define RXON_FLG_CHANNEL_MODE_POS (25) | |
543 | #define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3<<25) | |
544 | #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1<<25) | |
545 | #define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2<<25) | |
546 | ||
b481de9c ZY |
547 | /* rx_config filter flags */ |
548 | /* accept all data frames */ | |
549 | #define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0) | |
550 | /* pass control & management to host */ | |
551 | #define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1) | |
552 | /* accept multi-cast */ | |
553 | #define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2) | |
554 | /* don't decrypt uni-cast frames */ | |
555 | #define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3) | |
556 | /* don't decrypt multi-cast frames */ | |
557 | #define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4) | |
558 | /* STA is associated */ | |
559 | #define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5) | |
560 | /* transfer to host non bssid beacons in associated state */ | |
561 | #define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6) | |
562 | ||
80cc0c38 | 563 | /** |
b481de9c | 564 | * REPLY_RXON = 0x10 (command, has simple generic response) |
80cc0c38 BC |
565 | * |
566 | * RXON tunes the radio tuner to a service channel, and sets up a number | |
567 | * of parameters that are used primarily for Rx, but also for Tx operations. | |
568 | * | |
569 | * NOTE: When tuning to a new channel, driver must set the | |
570 | * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent | |
571 | * info within the device, including the station tables, tx retry | |
572 | * rate tables, and txpower tables. Driver must build a new station | |
573 | * table and txpower table before transmitting anything on the RXON | |
574 | * channel. | |
575 | * | |
576 | * NOTE: All RXONs wipe clean the internal txpower table. Driver must | |
577 | * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10), | |
578 | * regardless of whether RXON_FILTER_ASSOC_MSK is set. | |
b481de9c | 579 | */ |
bb8c093b | 580 | struct iwl4965_rxon_cmd { |
b481de9c ZY |
581 | u8 node_addr[6]; |
582 | __le16 reserved1; | |
583 | u8 bssid_addr[6]; | |
584 | __le16 reserved2; | |
585 | u8 wlap_bssid_addr[6]; | |
586 | __le16 reserved3; | |
587 | u8 dev_type; | |
588 | u8 air_propagation; | |
b481de9c | 589 | __le16 rx_chain; |
b481de9c ZY |
590 | u8 ofdm_basic_rates; |
591 | u8 cck_basic_rates; | |
592 | __le16 assoc_id; | |
593 | __le32 flags; | |
594 | __le32 filter_flags; | |
595 | __le16 channel; | |
b481de9c ZY |
596 | u8 ofdm_ht_single_stream_basic_rates; |
597 | u8 ofdm_ht_dual_stream_basic_rates; | |
b481de9c ZY |
598 | } __attribute__ ((packed)); |
599 | ||
600 | /* | |
601 | * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response) | |
602 | */ | |
bb8c093b | 603 | struct iwl4965_rxon_assoc_cmd { |
b481de9c ZY |
604 | __le32 flags; |
605 | __le32 filter_flags; | |
606 | u8 ofdm_basic_rates; | |
607 | u8 cck_basic_rates; | |
b481de9c ZY |
608 | u8 ofdm_ht_single_stream_basic_rates; |
609 | u8 ofdm_ht_dual_stream_basic_rates; | |
610 | __le16 rx_chain_select_flags; | |
b481de9c ZY |
611 | __le16 reserved; |
612 | } __attribute__ ((packed)); | |
613 | ||
614 | /* | |
615 | * REPLY_RXON_TIMING = 0x14 (command, has simple generic response) | |
616 | */ | |
bb8c093b | 617 | struct iwl4965_rxon_time_cmd { |
b481de9c ZY |
618 | union tsf timestamp; |
619 | __le16 beacon_interval; | |
620 | __le16 atim_window; | |
621 | __le32 beacon_init_val; | |
622 | __le16 listen_interval; | |
623 | __le16 reserved; | |
624 | } __attribute__ ((packed)); | |
625 | ||
b481de9c ZY |
626 | /* |
627 | * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response) | |
628 | */ | |
bb8c093b | 629 | struct iwl4965_channel_switch_cmd { |
b481de9c ZY |
630 | u8 band; |
631 | u8 expect_beacon; | |
632 | __le16 channel; | |
633 | __le32 rxon_flags; | |
634 | __le32 rxon_filter_flags; | |
635 | __le32 switch_time; | |
bb8c093b | 636 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
637 | } __attribute__ ((packed)); |
638 | ||
639 | /* | |
640 | * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command) | |
641 | */ | |
bb8c093b | 642 | struct iwl4965_csa_notification { |
b481de9c ZY |
643 | __le16 band; |
644 | __le16 channel; | |
645 | __le32 status; /* 0 - OK, 1 - fail */ | |
646 | } __attribute__ ((packed)); | |
647 | ||
648 | /****************************************************************************** | |
649 | * (2) | |
650 | * Quality-of-Service (QOS) Commands & Responses: | |
651 | * | |
652 | *****************************************************************************/ | |
bb8c093b | 653 | struct iwl4965_ac_qos { |
b481de9c ZY |
654 | __le16 cw_min; |
655 | __le16 cw_max; | |
656 | u8 aifsn; | |
657 | u8 reserved1; | |
658 | __le16 edca_txop; | |
659 | } __attribute__ ((packed)); | |
660 | ||
661 | /* QoS flags defines */ | |
662 | #define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01) | |
663 | #define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02) | |
664 | #define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10) | |
665 | ||
666 | /* | |
667 | * TXFIFO Queue number defines | |
668 | */ | |
669 | /* number of Access categories (AC) (EDCA), queues 0..3 */ | |
670 | #define AC_NUM 4 | |
671 | ||
672 | /* | |
673 | * REPLY_QOS_PARAM = 0x13 (command, has simple generic response) | |
674 | */ | |
bb8c093b | 675 | struct iwl4965_qosparam_cmd { |
b481de9c | 676 | __le32 qos_flags; |
bb8c093b | 677 | struct iwl4965_ac_qos ac[AC_NUM]; |
b481de9c ZY |
678 | } __attribute__ ((packed)); |
679 | ||
680 | /****************************************************************************** | |
681 | * (3) | |
682 | * Add/Modify Stations Commands & Responses: | |
683 | * | |
684 | *****************************************************************************/ | |
685 | /* | |
686 | * Multi station support | |
687 | */ | |
688 | #define IWL_AP_ID 0 | |
689 | #define IWL_MULTICAST_ID 1 | |
690 | #define IWL_STA_ID 2 | |
691 | ||
692 | #define IWL3945_BROADCAST_ID 24 | |
693 | #define IWL3945_STATION_COUNT 25 | |
694 | ||
695 | #define IWL4965_BROADCAST_ID 31 | |
696 | #define IWL4965_STATION_COUNT 32 | |
697 | ||
698 | #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/ | |
699 | #define IWL_INVALID_STATION 255 | |
700 | ||
b481de9c | 701 | #define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1<<8); |
74093ddf BC |
702 | #define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17) |
703 | #define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18) | |
704 | #define STA_FLG_MAX_AGG_SIZE_POS (19) | |
705 | #define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19) | |
706 | #define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21) | |
707 | #define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22) | |
708 | #define STA_FLG_AGG_MPDU_DENSITY_POS (23) | |
709 | #define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23) | |
b481de9c ZY |
710 | |
711 | #define STA_CONTROL_MODIFY_MSK 0x01 | |
712 | ||
713 | /* key flags __le16*/ | |
714 | #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7) | |
715 | #define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0) | |
716 | #define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x1) | |
717 | #define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x2) | |
718 | #define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x3) | |
719 | ||
720 | #define STA_KEY_FLG_KEYID_POS 8 | |
721 | #define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800) | |
722 | ||
723 | /* modify flags */ | |
724 | #define STA_MODIFY_KEY_MASK 0x01 | |
725 | #define STA_MODIFY_TID_DISABLE_TX 0x02 | |
726 | #define STA_MODIFY_TX_RATE_MSK 0x04 | |
727 | #define STA_MODIFY_ADDBA_TID_MSK 0x08 | |
728 | #define STA_MODIFY_DELBA_TID_MSK 0x10 | |
729 | #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid)) | |
730 | ||
bb8c093b | 731 | struct iwl4965_keyinfo { |
b481de9c ZY |
732 | __le16 key_flags; |
733 | u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */ | |
734 | u8 reserved1; | |
735 | __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */ | |
736 | __le16 reserved2; | |
737 | u8 key[16]; /* 16-byte unicast decryption key */ | |
738 | } __attribute__ ((packed)); | |
739 | ||
740 | struct sta_id_modify { | |
741 | u8 addr[ETH_ALEN]; | |
742 | __le16 reserved1; | |
743 | u8 sta_id; | |
744 | u8 modify_mask; | |
745 | __le16 reserved2; | |
746 | } __attribute__ ((packed)); | |
747 | ||
748 | /* | |
749 | * REPLY_ADD_STA = 0x18 (command) | |
750 | */ | |
bb8c093b | 751 | struct iwl4965_addsta_cmd { |
b481de9c ZY |
752 | u8 mode; |
753 | u8 reserved[3]; | |
754 | struct sta_id_modify sta; | |
bb8c093b | 755 | struct iwl4965_keyinfo key; |
b481de9c ZY |
756 | __le32 station_flags; |
757 | __le32 station_flags_msk; | |
758 | __le16 tid_disable_tx; | |
b481de9c | 759 | __le16 reserved1; |
b481de9c ZY |
760 | u8 add_immediate_ba_tid; |
761 | u8 remove_immediate_ba_tid; | |
762 | __le16 add_immediate_ba_ssn; | |
b481de9c | 763 | __le32 reserved2; |
b481de9c ZY |
764 | } __attribute__ ((packed)); |
765 | ||
766 | /* | |
767 | * REPLY_ADD_STA = 0x18 (response) | |
768 | */ | |
bb8c093b | 769 | struct iwl4965_add_sta_resp { |
b481de9c ZY |
770 | u8 status; |
771 | } __attribute__ ((packed)); | |
772 | ||
773 | #define ADD_STA_SUCCESS_MSK 0x1 | |
774 | ||
775 | /****************************************************************************** | |
776 | * (4) | |
777 | * Rx Responses: | |
778 | * | |
779 | *****************************************************************************/ | |
780 | ||
bb8c093b | 781 | struct iwl4965_rx_frame_stats { |
b481de9c ZY |
782 | u8 phy_count; |
783 | u8 id; | |
784 | u8 rssi; | |
785 | u8 agc; | |
786 | __le16 sig_avg; | |
787 | __le16 noise_diff; | |
788 | u8 payload[0]; | |
789 | } __attribute__ ((packed)); | |
790 | ||
bb8c093b | 791 | struct iwl4965_rx_frame_hdr { |
b481de9c ZY |
792 | __le16 channel; |
793 | __le16 phy_flags; | |
794 | u8 reserved1; | |
795 | u8 rate; | |
796 | __le16 len; | |
797 | u8 payload[0]; | |
798 | } __attribute__ ((packed)); | |
799 | ||
800 | #define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0) | |
801 | #define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1) | |
802 | ||
803 | #define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0) | |
804 | #define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1) | |
805 | #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2) | |
806 | #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3) | |
807 | #define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0) | |
808 | ||
809 | #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8) | |
810 | #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8) | |
811 | #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8) | |
812 | #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8) | |
813 | #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8) | |
814 | ||
815 | #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11) | |
816 | #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11) | |
817 | #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11) | |
818 | #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11) | |
819 | #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11) | |
820 | ||
bb8c093b | 821 | struct iwl4965_rx_frame_end { |
b481de9c ZY |
822 | __le32 status; |
823 | __le64 timestamp; | |
824 | __le32 beacon_timestamp; | |
825 | } __attribute__ ((packed)); | |
826 | ||
827 | /* | |
828 | * REPLY_3945_RX = 0x1b (response only, not a command) | |
829 | * | |
830 | * NOTE: DO NOT dereference from casts to this structure | |
831 | * It is provided only for calculating minimum data set size. | |
832 | * The actual offsets of the hdr and end are dynamic based on | |
833 | * stats.phy_count | |
834 | */ | |
bb8c093b CH |
835 | struct iwl4965_rx_frame { |
836 | struct iwl4965_rx_frame_stats stats; | |
837 | struct iwl4965_rx_frame_hdr hdr; | |
838 | struct iwl4965_rx_frame_end end; | |
b481de9c ZY |
839 | } __attribute__ ((packed)); |
840 | ||
841 | /* Fixed (non-configurable) rx data from phy */ | |
842 | #define RX_PHY_FLAGS_ANTENNAE_OFFSET (4) | |
843 | #define RX_PHY_FLAGS_ANTENNAE_MASK (0x70) | |
844 | #define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */ | |
845 | #define IWL_AGC_DB_POS (7) | |
846 | struct iwl4965_rx_non_cfg_phy { | |
847 | __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */ | |
848 | __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */ | |
849 | u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */ | |
850 | u8 pad[0]; | |
851 | } __attribute__ ((packed)); | |
852 | ||
853 | /* | |
854 | * REPLY_4965_RX = 0xc3 (response only, not a command) | |
855 | * Used only for legacy (non 11n) frames. | |
856 | */ | |
857 | #define RX_RES_PHY_CNT 14 | |
858 | struct iwl4965_rx_phy_res { | |
859 | u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */ | |
860 | u8 cfg_phy_cnt; /* configurable DSP phy data byte count */ | |
861 | u8 stat_id; /* configurable DSP phy data set ID */ | |
862 | u8 reserved1; | |
863 | __le64 timestamp; /* TSF at on air rise */ | |
864 | __le32 beacon_time_stamp; /* beacon at on-air rise */ | |
865 | __le16 phy_flags; /* general phy flags: band, modulation, ... */ | |
866 | __le16 channel; /* channel number */ | |
867 | __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */ | |
868 | __le32 reserved2; | |
869 | __le32 rate_n_flags; | |
870 | __le16 byte_count; /* frame's byte-count */ | |
871 | __le16 reserved3; | |
872 | } __attribute__ ((packed)); | |
873 | ||
874 | struct iwl4965_rx_mpdu_res_start { | |
875 | __le16 byte_count; | |
876 | __le16 reserved; | |
877 | } __attribute__ ((packed)); | |
878 | ||
879 | ||
880 | /****************************************************************************** | |
881 | * (5) | |
882 | * Tx Commands & Responses: | |
883 | * | |
884 | *****************************************************************************/ | |
885 | ||
886 | /* Tx flags */ | |
887 | #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1) | |
888 | #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2) | |
889 | #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3) | |
890 | #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4) | |
891 | #define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6) | |
892 | #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7) | |
893 | #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00) | |
894 | #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8) | |
895 | #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9) | |
896 | ||
897 | /* ucode ignores BT priority for this frame */ | |
898 | #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12) | |
899 | ||
900 | /* ucode overrides sequence control */ | |
901 | #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13) | |
902 | ||
903 | /* signal that this frame is non-last MPDU */ | |
904 | #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14) | |
905 | ||
906 | /* calculate TSF in outgoing frame */ | |
907 | #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16) | |
908 | ||
909 | /* activate TX calibration. */ | |
910 | #define TX_CMD_FLG_CALIB_MSK __constant_cpu_to_le32(1 << 17) | |
911 | ||
912 | /* signals that 2 bytes pad was inserted | |
913 | after the MAC header */ | |
914 | #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20) | |
915 | ||
916 | /* HCCA-AP - disable duration overwriting. */ | |
917 | #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25) | |
918 | ||
919 | /* | |
920 | * TX command security control | |
921 | */ | |
922 | #define TX_CMD_SEC_WEP 0x01 | |
923 | #define TX_CMD_SEC_CCM 0x02 | |
924 | #define TX_CMD_SEC_TKIP 0x03 | |
925 | #define TX_CMD_SEC_MSK 0x03 | |
926 | #define TX_CMD_SEC_SHIFT 6 | |
927 | #define TX_CMD_SEC_KEY128 0x08 | |
928 | ||
929 | /* | |
930 | * TX command Frame life time | |
931 | */ | |
932 | ||
bb8c093b | 933 | struct iwl4965_dram_scratch { |
b481de9c ZY |
934 | u8 try_cnt; |
935 | u8 bt_kill_cnt; | |
936 | __le16 reserved; | |
937 | } __attribute__ ((packed)); | |
938 | ||
939 | /* | |
940 | * REPLY_TX = 0x1c (command) | |
941 | */ | |
bb8c093b | 942 | struct iwl4965_tx_cmd { |
b481de9c ZY |
943 | __le16 len; |
944 | __le16 next_frame_len; | |
945 | __le32 tx_flags; | |
bb8c093b | 946 | struct iwl4965_dram_scratch scratch; |
b481de9c ZY |
947 | __le32 rate_n_flags; |
948 | u8 sta_id; | |
b481de9c | 949 | u8 sec_ctl; |
b481de9c ZY |
950 | u8 initial_rate_index; |
951 | u8 reserved; | |
b481de9c | 952 | u8 key[16]; |
b481de9c ZY |
953 | __le16 next_frame_flags; |
954 | __le16 reserved2; | |
b481de9c ZY |
955 | union { |
956 | __le32 life_time; | |
957 | __le32 attempt; | |
958 | } stop_time; | |
b481de9c ZY |
959 | __le32 dram_lsb_ptr; |
960 | u8 dram_msb_ptr; | |
b481de9c ZY |
961 | u8 rts_retry_limit; /*byte 50 */ |
962 | u8 data_retry_limit; /*byte 51 */ | |
b481de9c | 963 | u8 tid_tspec; |
b481de9c ZY |
964 | union { |
965 | __le16 pm_frame_timeout; | |
966 | __le16 attempt_duration; | |
967 | } timeout; | |
968 | __le16 driver_txop; | |
969 | u8 payload[0]; | |
970 | struct ieee80211_hdr hdr[0]; | |
971 | } __attribute__ ((packed)); | |
972 | ||
973 | /* TX command response is sent after *all* transmission attempts. | |
974 | * | |
975 | * NOTES: | |
976 | * | |
977 | * TX_STATUS_FAIL_NEXT_FRAG | |
978 | * | |
979 | * If the fragment flag in the MAC header for the frame being transmitted | |
980 | * is set and there is insufficient time to transmit the next frame, the | |
981 | * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'. | |
982 | * | |
983 | * TX_STATUS_FIFO_UNDERRUN | |
984 | * | |
985 | * Indicates the host did not provide bytes to the FIFO fast enough while | |
986 | * a TX was in progress. | |
987 | * | |
988 | * TX_STATUS_FAIL_MGMNT_ABORT | |
989 | * | |
990 | * This status is only possible if the ABORT ON MGMT RX parameter was | |
991 | * set to true with the TX command. | |
992 | * | |
993 | * If the MSB of the status parameter is set then an abort sequence is | |
994 | * required. This sequence consists of the host activating the TX Abort | |
995 | * control line, and then waiting for the TX Abort command response. This | |
996 | * indicates that a the device is no longer in a transmit state, and that the | |
997 | * command FIFO has been cleared. The host must then deactivate the TX Abort | |
998 | * control line. Receiving is still allowed in this case. | |
999 | */ | |
1000 | enum { | |
1001 | TX_STATUS_SUCCESS = 0x01, | |
1002 | TX_STATUS_DIRECT_DONE = 0x02, | |
1003 | TX_STATUS_FAIL_SHORT_LIMIT = 0x82, | |
1004 | TX_STATUS_FAIL_LONG_LIMIT = 0x83, | |
1005 | TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84, | |
1006 | TX_STATUS_FAIL_MGMNT_ABORT = 0x85, | |
1007 | TX_STATUS_FAIL_NEXT_FRAG = 0x86, | |
1008 | TX_STATUS_FAIL_LIFE_EXPIRE = 0x87, | |
1009 | TX_STATUS_FAIL_DEST_PS = 0x88, | |
1010 | TX_STATUS_FAIL_ABORTED = 0x89, | |
1011 | TX_STATUS_FAIL_BT_RETRY = 0x8a, | |
1012 | TX_STATUS_FAIL_STA_INVALID = 0x8b, | |
1013 | TX_STATUS_FAIL_FRAG_DROPPED = 0x8c, | |
1014 | TX_STATUS_FAIL_TID_DISABLE = 0x8d, | |
1015 | TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e, | |
1016 | TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f, | |
1017 | TX_STATUS_FAIL_TX_LOCKED = 0x90, | |
1018 | TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91, | |
1019 | }; | |
1020 | ||
1021 | #define TX_PACKET_MODE_REGULAR 0x0000 | |
1022 | #define TX_PACKET_MODE_BURST_SEQ 0x0100 | |
1023 | #define TX_PACKET_MODE_BURST_FIRST 0x0200 | |
1024 | ||
1025 | enum { | |
1026 | TX_POWER_PA_NOT_ACTIVE = 0x0, | |
1027 | }; | |
1028 | ||
1029 | enum { | |
1030 | TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */ | |
1031 | TX_STATUS_DELAY_MSK = 0x00000040, | |
1032 | TX_STATUS_ABORT_MSK = 0x00000080, | |
1033 | TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */ | |
1034 | TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */ | |
1035 | TX_RESERVED = 0x00780000, /* bits 19:22 */ | |
1036 | TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */ | |
1037 | TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */ | |
1038 | }; | |
1039 | ||
1040 | /* ******************************* | |
1041 | * TX aggregation state | |
1042 | ******************************* */ | |
1043 | ||
1044 | enum { | |
1045 | AGG_TX_STATE_TRANSMITTED = 0x00, | |
1046 | AGG_TX_STATE_UNDERRUN_MSK = 0x01, | |
1047 | AGG_TX_STATE_BT_PRIO_MSK = 0x02, | |
1048 | AGG_TX_STATE_FEW_BYTES_MSK = 0x04, | |
1049 | AGG_TX_STATE_ABORT_MSK = 0x08, | |
1050 | AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10, | |
1051 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20, | |
1052 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40, | |
1053 | AGG_TX_STATE_SCD_QUERY_MSK = 0x80, | |
1054 | AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100, | |
1055 | AGG_TX_STATE_RESPONSE_MSK = 0x1ff, | |
1056 | AGG_TX_STATE_DUMP_TX_MSK = 0x200, | |
1057 | AGG_TX_STATE_DELAY_TX_MSK = 0x400 | |
1058 | }; | |
1059 | ||
1060 | #define AGG_TX_STATE_LAST_SENT_MSK \ | |
1061 | (AGG_TX_STATE_LAST_SENT_TTL_MSK | \ | |
1062 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \ | |
1063 | AGG_TX_STATE_LAST_SENT_BT_KILL_MSK) | |
1064 | ||
1065 | #define AGG_TX_STATE_TRY_CNT_POS 12 | |
1066 | #define AGG_TX_STATE_TRY_CNT_MSK 0xf000 | |
1067 | ||
1068 | #define AGG_TX_STATE_SEQ_NUM_POS 16 | |
1069 | #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000 | |
1070 | ||
1071 | /* | |
1072 | * REPLY_TX = 0x1c (response) | |
1073 | */ | |
bb8c093b | 1074 | struct iwl4965_tx_resp { |
b481de9c ZY |
1075 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ |
1076 | u8 bt_kill_count; | |
1077 | u8 failure_rts; | |
1078 | u8 failure_frame; | |
1079 | __le32 rate_n_flags; | |
1080 | __le16 wireless_media_time; | |
1081 | __le16 reserved; | |
1082 | __le32 pa_power1; | |
1083 | __le32 pa_power2; | |
1084 | __le32 status; /* TX status (for aggregation status of 1st frame) */ | |
1085 | } __attribute__ ((packed)); | |
1086 | ||
b481de9c ZY |
1087 | /* |
1088 | * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command) | |
1089 | */ | |
bb8c093b | 1090 | struct iwl4965_compressed_ba_resp { |
b481de9c ZY |
1091 | __le32 sta_addr_lo32; |
1092 | __le16 sta_addr_hi16; | |
1093 | __le16 reserved; | |
1094 | u8 sta_id; | |
1095 | u8 tid; | |
1096 | __le16 ba_seq_ctl; | |
1097 | __le32 ba_bitmap0; | |
1098 | __le32 ba_bitmap1; | |
1099 | __le16 scd_flow; | |
1100 | __le16 scd_ssn; | |
1101 | } __attribute__ ((packed)); | |
1102 | ||
1103 | /* | |
1104 | * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response) | |
1105 | */ | |
bb8c093b | 1106 | struct iwl4965_txpowertable_cmd { |
b481de9c ZY |
1107 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ |
1108 | u8 reserved; | |
1109 | __le16 channel; | |
bb8c093b | 1110 | struct iwl4965_tx_power_db tx_power; |
b481de9c ZY |
1111 | } __attribute__ ((packed)); |
1112 | ||
b481de9c ZY |
1113 | /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */ |
1114 | #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1<<0) | |
1115 | ||
1116 | #define LINK_QUAL_AC_NUM AC_NUM | |
1117 | #define LINK_QUAL_MAX_RETRY_NUM 16 | |
1118 | ||
1119 | #define LINK_QUAL_ANT_A_MSK (1<<0) | |
1120 | #define LINK_QUAL_ANT_B_MSK (1<<1) | |
1121 | #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK) | |
1122 | ||
bb8c093b | 1123 | struct iwl4965_link_qual_general_params { |
b481de9c ZY |
1124 | u8 flags; |
1125 | u8 mimo_delimiter; | |
1126 | u8 single_stream_ant_msk; | |
1127 | u8 dual_stream_ant_msk; | |
1128 | u8 start_rate_index[LINK_QUAL_AC_NUM]; | |
1129 | } __attribute__ ((packed)); | |
1130 | ||
bb8c093b | 1131 | struct iwl4965_link_qual_agg_params { |
b481de9c ZY |
1132 | __le16 agg_time_limit; |
1133 | u8 agg_dis_start_th; | |
1134 | u8 agg_frame_cnt_limit; | |
1135 | __le32 reserved; | |
1136 | } __attribute__ ((packed)); | |
1137 | ||
1138 | /* | |
1139 | * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response) | |
1140 | */ | |
bb8c093b | 1141 | struct iwl4965_link_quality_cmd { |
b481de9c ZY |
1142 | u8 sta_id; |
1143 | u8 reserved1; | |
1144 | __le16 control; | |
bb8c093b CH |
1145 | struct iwl4965_link_qual_general_params general_params; |
1146 | struct iwl4965_link_qual_agg_params agg_params; | |
b481de9c ZY |
1147 | struct { |
1148 | __le32 rate_n_flags; | |
1149 | } rs_table[LINK_QUAL_MAX_RETRY_NUM]; | |
1150 | __le32 reserved2; | |
1151 | } __attribute__ ((packed)); | |
b481de9c ZY |
1152 | |
1153 | /* | |
1154 | * REPLY_BT_CONFIG = 0x9b (command, has simple generic response) | |
1155 | */ | |
bb8c093b | 1156 | struct iwl4965_bt_cmd { |
b481de9c ZY |
1157 | u8 flags; |
1158 | u8 lead_time; | |
1159 | u8 max_kill; | |
1160 | u8 reserved; | |
1161 | __le32 kill_ack_mask; | |
1162 | __le32 kill_cts_mask; | |
1163 | } __attribute__ ((packed)); | |
1164 | ||
1165 | /****************************************************************************** | |
1166 | * (6) | |
1167 | * Spectrum Management (802.11h) Commands, Responses, Notifications: | |
1168 | * | |
1169 | *****************************************************************************/ | |
1170 | ||
1171 | /* | |
1172 | * Spectrum Management | |
1173 | */ | |
1174 | #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \ | |
1175 | RXON_FILTER_CTL2HOST_MSK | \ | |
1176 | RXON_FILTER_ACCEPT_GRP_MSK | \ | |
1177 | RXON_FILTER_DIS_DECRYPT_MSK | \ | |
1178 | RXON_FILTER_DIS_GRP_DECRYPT_MSK | \ | |
1179 | RXON_FILTER_ASSOC_MSK | \ | |
1180 | RXON_FILTER_BCON_AWARE_MSK) | |
1181 | ||
bb8c093b | 1182 | struct iwl4965_measure_channel { |
b481de9c ZY |
1183 | __le32 duration; /* measurement duration in extended beacon |
1184 | * format */ | |
1185 | u8 channel; /* channel to measure */ | |
bb8c093b | 1186 | u8 type; /* see enum iwl4965_measure_type */ |
b481de9c ZY |
1187 | __le16 reserved; |
1188 | } __attribute__ ((packed)); | |
1189 | ||
1190 | /* | |
1191 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command) | |
1192 | */ | |
bb8c093b | 1193 | struct iwl4965_spectrum_cmd { |
b481de9c ZY |
1194 | __le16 len; /* number of bytes starting from token */ |
1195 | u8 token; /* token id */ | |
1196 | u8 id; /* measurement id -- 0 or 1 */ | |
1197 | u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */ | |
1198 | u8 periodic; /* 1 = periodic */ | |
1199 | __le16 path_loss_timeout; | |
1200 | __le32 start_time; /* start time in extended beacon format */ | |
1201 | __le32 reserved2; | |
1202 | __le32 flags; /* rxon flags */ | |
1203 | __le32 filter_flags; /* rxon filter flags */ | |
1204 | __le16 channel_count; /* minimum 1, maximum 10 */ | |
1205 | __le16 reserved3; | |
bb8c093b | 1206 | struct iwl4965_measure_channel channels[10]; |
b481de9c ZY |
1207 | } __attribute__ ((packed)); |
1208 | ||
1209 | /* | |
1210 | * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response) | |
1211 | */ | |
bb8c093b | 1212 | struct iwl4965_spectrum_resp { |
b481de9c ZY |
1213 | u8 token; |
1214 | u8 id; /* id of the prior command replaced, or 0xff */ | |
1215 | __le16 status; /* 0 - command will be handled | |
1216 | * 1 - cannot handle (conflicts with another | |
1217 | * measurement) */ | |
1218 | } __attribute__ ((packed)); | |
1219 | ||
bb8c093b | 1220 | enum iwl4965_measurement_state { |
b481de9c ZY |
1221 | IWL_MEASUREMENT_START = 0, |
1222 | IWL_MEASUREMENT_STOP = 1, | |
1223 | }; | |
1224 | ||
bb8c093b | 1225 | enum iwl4965_measurement_status { |
b481de9c ZY |
1226 | IWL_MEASUREMENT_OK = 0, |
1227 | IWL_MEASUREMENT_CONCURRENT = 1, | |
1228 | IWL_MEASUREMENT_CSA_CONFLICT = 2, | |
1229 | IWL_MEASUREMENT_TGH_CONFLICT = 3, | |
1230 | /* 4-5 reserved */ | |
1231 | IWL_MEASUREMENT_STOPPED = 6, | |
1232 | IWL_MEASUREMENT_TIMEOUT = 7, | |
1233 | IWL_MEASUREMENT_PERIODIC_FAILED = 8, | |
1234 | }; | |
1235 | ||
1236 | #define NUM_ELEMENTS_IN_HISTOGRAM 8 | |
1237 | ||
bb8c093b | 1238 | struct iwl4965_measurement_histogram { |
b481de9c ZY |
1239 | __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */ |
1240 | __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */ | |
1241 | } __attribute__ ((packed)); | |
1242 | ||
1243 | /* clear channel availability counters */ | |
bb8c093b | 1244 | struct iwl4965_measurement_cca_counters { |
b481de9c ZY |
1245 | __le32 ofdm; |
1246 | __le32 cck; | |
1247 | } __attribute__ ((packed)); | |
1248 | ||
bb8c093b | 1249 | enum iwl4965_measure_type { |
b481de9c ZY |
1250 | IWL_MEASURE_BASIC = (1 << 0), |
1251 | IWL_MEASURE_CHANNEL_LOAD = (1 << 1), | |
1252 | IWL_MEASURE_HISTOGRAM_RPI = (1 << 2), | |
1253 | IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3), | |
1254 | IWL_MEASURE_FRAME = (1 << 4), | |
1255 | /* bits 5:6 are reserved */ | |
1256 | IWL_MEASURE_IDLE = (1 << 7), | |
1257 | }; | |
1258 | ||
1259 | /* | |
1260 | * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command) | |
1261 | */ | |
bb8c093b | 1262 | struct iwl4965_spectrum_notification { |
b481de9c ZY |
1263 | u8 id; /* measurement id -- 0 or 1 */ |
1264 | u8 token; | |
1265 | u8 channel_index; /* index in measurement channel list */ | |
1266 | u8 state; /* 0 - start, 1 - stop */ | |
1267 | __le32 start_time; /* lower 32-bits of TSF */ | |
1268 | u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */ | |
1269 | u8 channel; | |
bb8c093b | 1270 | u8 type; /* see enum iwl4965_measurement_type */ |
b481de9c ZY |
1271 | u8 reserved1; |
1272 | /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only | |
1273 | * valid if applicable for measurement type requested. */ | |
1274 | __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */ | |
1275 | __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */ | |
1276 | __le32 cca_time; /* channel load time in usecs */ | |
1277 | u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 - | |
1278 | * unidentified */ | |
1279 | u8 reserved2[3]; | |
bb8c093b | 1280 | struct iwl4965_measurement_histogram histogram; |
b481de9c | 1281 | __le32 stop_time; /* lower 32-bits of TSF */ |
bb8c093b | 1282 | __le32 status; /* see iwl4965_measurement_status */ |
b481de9c ZY |
1283 | } __attribute__ ((packed)); |
1284 | ||
1285 | /****************************************************************************** | |
1286 | * (7) | |
1287 | * Power Management Commands, Responses, Notifications: | |
1288 | * | |
1289 | *****************************************************************************/ | |
1290 | ||
1291 | /** | |
bb8c093b | 1292 | * struct iwl4965_powertable_cmd - Power Table Command |
b481de9c ZY |
1293 | * @flags: See below: |
1294 | * | |
1295 | * POWER_TABLE_CMD = 0x77 (command, has simple generic response) | |
1296 | * | |
1297 | * PM allow: | |
1298 | * bit 0 - '0' Driver not allow power management | |
1299 | * '1' Driver allow PM (use rest of parameters) | |
1300 | * uCode send sleep notifications: | |
1301 | * bit 1 - '0' Don't send sleep notification | |
1302 | * '1' send sleep notification (SEND_PM_NOTIFICATION) | |
1303 | * Sleep over DTIM | |
1304 | * bit 2 - '0' PM have to walk up every DTIM | |
1305 | * '1' PM could sleep over DTIM till listen Interval. | |
1306 | * PCI power managed | |
1307 | * bit 3 - '0' (PCI_LINK_CTRL & 0x1) | |
1308 | * '1' !(PCI_LINK_CTRL & 0x1) | |
1309 | * Force sleep Modes | |
1310 | * bit 31/30- '00' use both mac/xtal sleeps | |
1311 | * '01' force Mac sleep | |
1312 | * '10' force xtal sleep | |
1313 | * '11' Illegal set | |
1314 | * | |
1315 | * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then | |
1316 | * ucode assume sleep over DTIM is allowed and we don't need to wakeup | |
1317 | * for every DTIM. | |
1318 | */ | |
1319 | #define IWL_POWER_VEC_SIZE 5 | |
1320 | ||
b481de9c ZY |
1321 | #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1<<0) |
1322 | #define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1<<2) | |
1323 | #define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1<<3) | |
1324 | ||
bb8c093b | 1325 | struct iwl4965_powertable_cmd { |
b481de9c ZY |
1326 | __le16 flags; |
1327 | u8 keep_alive_seconds; | |
1328 | u8 debug_flags; | |
1329 | __le32 rx_data_timeout; | |
1330 | __le32 tx_data_timeout; | |
1331 | __le32 sleep_interval[IWL_POWER_VEC_SIZE]; | |
1332 | __le32 keep_alive_beacons; | |
1333 | } __attribute__ ((packed)); | |
b481de9c ZY |
1334 | |
1335 | /* | |
1336 | * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command) | |
1337 | * 3945 and 4965 identical. | |
1338 | */ | |
bb8c093b | 1339 | struct iwl4965_sleep_notification { |
b481de9c ZY |
1340 | u8 pm_sleep_mode; |
1341 | u8 pm_wakeup_src; | |
1342 | __le16 reserved; | |
1343 | __le32 sleep_time; | |
1344 | __le32 tsf_low; | |
1345 | __le32 bcon_timer; | |
1346 | } __attribute__ ((packed)); | |
1347 | ||
1348 | /* Sleep states. 3945 and 4965 identical. */ | |
1349 | enum { | |
1350 | IWL_PM_NO_SLEEP = 0, | |
1351 | IWL_PM_SLP_MAC = 1, | |
1352 | IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2, | |
1353 | IWL_PM_SLP_FULL_MAC_CARD_STATE = 3, | |
1354 | IWL_PM_SLP_PHY = 4, | |
1355 | IWL_PM_SLP_REPENT = 5, | |
1356 | IWL_PM_WAKEUP_BY_TIMER = 6, | |
1357 | IWL_PM_WAKEUP_BY_DRIVER = 7, | |
1358 | IWL_PM_WAKEUP_BY_RFKILL = 8, | |
1359 | /* 3 reserved */ | |
1360 | IWL_PM_NUM_OF_MODES = 12, | |
1361 | }; | |
1362 | ||
1363 | /* | |
1364 | * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response) | |
1365 | */ | |
1366 | #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */ | |
1367 | #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */ | |
1368 | #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */ | |
bb8c093b | 1369 | struct iwl4965_card_state_cmd { |
b481de9c ZY |
1370 | __le32 status; /* CARD_STATE_CMD_* request new power state */ |
1371 | } __attribute__ ((packed)); | |
1372 | ||
1373 | /* | |
1374 | * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command) | |
1375 | */ | |
bb8c093b | 1376 | struct iwl4965_card_state_notif { |
b481de9c ZY |
1377 | __le32 flags; |
1378 | } __attribute__ ((packed)); | |
1379 | ||
1380 | #define HW_CARD_DISABLED 0x01 | |
1381 | #define SW_CARD_DISABLED 0x02 | |
1382 | #define RF_CARD_DISABLED 0x04 | |
1383 | #define RXON_CARD_DISABLED 0x10 | |
1384 | ||
bb8c093b | 1385 | struct iwl4965_ct_kill_config { |
b481de9c ZY |
1386 | __le32 reserved; |
1387 | __le32 critical_temperature_M; | |
1388 | __le32 critical_temperature_R; | |
1389 | } __attribute__ ((packed)); | |
1390 | ||
1391 | /****************************************************************************** | |
1392 | * (8) | |
1393 | * Scan Commands, Responses, Notifications: | |
1394 | * | |
1395 | *****************************************************************************/ | |
1396 | ||
bb8c093b | 1397 | struct iwl4965_scan_channel { |
b481de9c ZY |
1398 | /* type is defined as: |
1399 | * 0:0 active (0 - passive) | |
1400 | * 1:4 SSID direct | |
1401 | * If 1 is set then corresponding SSID IE is transmitted in probe | |
1402 | * 5:7 reserved | |
1403 | */ | |
1404 | u8 type; | |
1405 | u8 channel; | |
bb8c093b | 1406 | struct iwl4965_tx_power tpc; |
b481de9c ZY |
1407 | __le16 active_dwell; |
1408 | __le16 passive_dwell; | |
1409 | } __attribute__ ((packed)); | |
1410 | ||
bb8c093b | 1411 | struct iwl4965_ssid_ie { |
b481de9c ZY |
1412 | u8 id; |
1413 | u8 len; | |
1414 | u8 ssid[32]; | |
1415 | } __attribute__ ((packed)); | |
1416 | ||
1417 | #define PROBE_OPTION_MAX 0x4 | |
1418 | #define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF) | |
1419 | #define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1) | |
1420 | #define IWL_MAX_SCAN_SIZE 1024 | |
1421 | ||
1422 | /* | |
1423 | * REPLY_SCAN_CMD = 0x80 (command) | |
1424 | */ | |
bb8c093b | 1425 | struct iwl4965_scan_cmd { |
b481de9c ZY |
1426 | __le16 len; |
1427 | u8 reserved0; | |
1428 | u8 channel_count; | |
1429 | __le16 quiet_time; /* dwell only this long on quiet chnl | |
1430 | * (active scan) */ | |
1431 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ | |
1432 | __le16 good_CRC_th; /* passive -> active promotion threshold */ | |
b481de9c | 1433 | __le16 rx_chain; |
b481de9c ZY |
1434 | __le32 max_out_time; /* max usec to be out of associated (service) |
1435 | * chnl */ | |
1436 | __le32 suspend_time; /* pause scan this long when returning to svc | |
1437 | * chnl. | |
1438 | * 3945 -- 31:24 # beacons, 19:0 additional usec, | |
1439 | * 4965 -- 31:22 # beacons, 21:0 additional usec. | |
1440 | */ | |
1441 | __le32 flags; | |
1442 | __le32 filter_flags; | |
1443 | ||
bb8c093b CH |
1444 | struct iwl4965_tx_cmd tx_cmd; |
1445 | struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX]; | |
b481de9c ZY |
1446 | |
1447 | u8 data[0]; | |
1448 | /* | |
1449 | * The channels start after the probe request payload and are of type: | |
1450 | * | |
bb8c093b | 1451 | * struct iwl4965_scan_channel channels[0]; |
b481de9c ZY |
1452 | * |
1453 | * NOTE: Only one band of channels can be scanned per pass. You | |
1454 | * can not mix 2.4GHz channels and 5.2GHz channels and must | |
1455 | * request a scan multiple times (not concurrently) | |
1456 | * | |
1457 | */ | |
1458 | } __attribute__ ((packed)); | |
1459 | ||
1460 | /* Can abort will notify by complete notification with abort status. */ | |
1461 | #define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1) | |
1462 | /* complete notification statuses */ | |
1463 | #define ABORT_STATUS 0x2 | |
1464 | ||
1465 | /* | |
1466 | * REPLY_SCAN_CMD = 0x80 (response) | |
1467 | */ | |
bb8c093b | 1468 | struct iwl4965_scanreq_notification { |
b481de9c ZY |
1469 | __le32 status; /* 1: okay, 2: cannot fulfill request */ |
1470 | } __attribute__ ((packed)); | |
1471 | ||
1472 | /* | |
1473 | * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command) | |
1474 | */ | |
bb8c093b | 1475 | struct iwl4965_scanstart_notification { |
b481de9c ZY |
1476 | __le32 tsf_low; |
1477 | __le32 tsf_high; | |
1478 | __le32 beacon_timer; | |
1479 | u8 channel; | |
1480 | u8 band; | |
1481 | u8 reserved[2]; | |
1482 | __le32 status; | |
1483 | } __attribute__ ((packed)); | |
1484 | ||
1485 | #define SCAN_OWNER_STATUS 0x1; | |
1486 | #define MEASURE_OWNER_STATUS 0x2; | |
1487 | ||
1488 | #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */ | |
1489 | /* | |
1490 | * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command) | |
1491 | */ | |
bb8c093b | 1492 | struct iwl4965_scanresults_notification { |
b481de9c ZY |
1493 | u8 channel; |
1494 | u8 band; | |
1495 | u8 reserved[2]; | |
1496 | __le32 tsf_low; | |
1497 | __le32 tsf_high; | |
1498 | __le32 statistics[NUMBER_OF_STATISTICS]; | |
1499 | } __attribute__ ((packed)); | |
1500 | ||
1501 | /* | |
1502 | * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command) | |
1503 | */ | |
bb8c093b | 1504 | struct iwl4965_scancomplete_notification { |
b481de9c ZY |
1505 | u8 scanned_channels; |
1506 | u8 status; | |
1507 | u8 reserved; | |
1508 | u8 last_channel; | |
1509 | __le32 tsf_low; | |
1510 | __le32 tsf_high; | |
1511 | } __attribute__ ((packed)); | |
1512 | ||
1513 | ||
1514 | /****************************************************************************** | |
1515 | * (9) | |
1516 | * IBSS/AP Commands and Notifications: | |
1517 | * | |
1518 | *****************************************************************************/ | |
1519 | ||
1520 | /* | |
1521 | * BEACON_NOTIFICATION = 0x90 (notification only, not a command) | |
1522 | */ | |
bb8c093b CH |
1523 | struct iwl4965_beacon_notif { |
1524 | struct iwl4965_tx_resp beacon_notify_hdr; | |
b481de9c ZY |
1525 | __le32 low_tsf; |
1526 | __le32 high_tsf; | |
1527 | __le32 ibss_mgr_status; | |
1528 | } __attribute__ ((packed)); | |
1529 | ||
1530 | /* | |
1531 | * REPLY_TX_BEACON = 0x91 (command, has simple generic response) | |
1532 | */ | |
bb8c093b CH |
1533 | struct iwl4965_tx_beacon_cmd { |
1534 | struct iwl4965_tx_cmd tx; | |
b481de9c ZY |
1535 | __le16 tim_idx; |
1536 | u8 tim_size; | |
1537 | u8 reserved1; | |
1538 | struct ieee80211_hdr frame[0]; /* beacon frame */ | |
1539 | } __attribute__ ((packed)); | |
1540 | ||
1541 | /****************************************************************************** | |
1542 | * (10) | |
1543 | * Statistics Commands and Notifications: | |
1544 | * | |
1545 | *****************************************************************************/ | |
1546 | ||
1547 | #define IWL_TEMP_CONVERT 260 | |
1548 | ||
1549 | #define SUP_RATE_11A_MAX_NUM_CHANNELS 8 | |
1550 | #define SUP_RATE_11B_MAX_NUM_CHANNELS 4 | |
1551 | #define SUP_RATE_11G_MAX_NUM_CHANNELS 12 | |
1552 | ||
1553 | /* Used for passing to driver number of successes and failures per rate */ | |
1554 | struct rate_histogram { | |
1555 | union { | |
1556 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
1557 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
1558 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
1559 | } success; | |
1560 | union { | |
1561 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; | |
1562 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; | |
1563 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; | |
1564 | } failed; | |
1565 | } __attribute__ ((packed)); | |
1566 | ||
1567 | /* statistics command response */ | |
1568 | ||
1569 | struct statistics_rx_phy { | |
1570 | __le32 ina_cnt; | |
1571 | __le32 fina_cnt; | |
1572 | __le32 plcp_err; | |
1573 | __le32 crc32_err; | |
1574 | __le32 overrun_err; | |
1575 | __le32 early_overrun_err; | |
1576 | __le32 crc32_good; | |
1577 | __le32 false_alarm_cnt; | |
1578 | __le32 fina_sync_err_cnt; | |
1579 | __le32 sfd_timeout; | |
1580 | __le32 fina_timeout; | |
1581 | __le32 unresponded_rts; | |
1582 | __le32 rxe_frame_limit_overrun; | |
1583 | __le32 sent_ack_cnt; | |
1584 | __le32 sent_cts_cnt; | |
b481de9c ZY |
1585 | __le32 sent_ba_rsp_cnt; |
1586 | __le32 dsp_self_kill; | |
1587 | __le32 mh_format_err; | |
1588 | __le32 re_acq_main_rssi_sum; | |
1589 | __le32 reserved3; | |
b481de9c ZY |
1590 | } __attribute__ ((packed)); |
1591 | ||
b481de9c ZY |
1592 | struct statistics_rx_ht_phy { |
1593 | __le32 plcp_err; | |
1594 | __le32 overrun_err; | |
1595 | __le32 early_overrun_err; | |
1596 | __le32 crc32_good; | |
1597 | __le32 crc32_err; | |
1598 | __le32 mh_format_err; | |
1599 | __le32 agg_crc32_good; | |
1600 | __le32 agg_mpdu_cnt; | |
1601 | __le32 agg_cnt; | |
1602 | __le32 reserved2; | |
1603 | } __attribute__ ((packed)); | |
b481de9c ZY |
1604 | |
1605 | struct statistics_rx_non_phy { | |
1606 | __le32 bogus_cts; /* CTS received when not expecting CTS */ | |
1607 | __le32 bogus_ack; /* ACK received when not expecting ACK */ | |
1608 | __le32 non_bssid_frames; /* number of frames with BSSID that | |
1609 | * doesn't belong to the STA BSSID */ | |
1610 | __le32 filtered_frames; /* count frames that were dumped in the | |
1611 | * filtering process */ | |
1612 | __le32 non_channel_beacons; /* beacons with our bss id but not on | |
1613 | * our serving channel */ | |
b481de9c ZY |
1614 | __le32 channel_beacons; /* beacons with our bss id and in our |
1615 | * serving channel */ | |
1616 | __le32 num_missed_bcon; /* number of missed beacons */ | |
1617 | __le32 adc_rx_saturation_time; /* count in 0.8us units the time the | |
1618 | * ADC was in saturation */ | |
1619 | __le32 ina_detection_search_time;/* total time (in 0.8us) searched | |
1620 | * for INA */ | |
1621 | __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */ | |
1622 | __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */ | |
1623 | __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */ | |
1624 | __le32 interference_data_flag; /* flag for interference data | |
1625 | * availability. 1 when data is | |
1626 | * available. */ | |
1627 | __le32 channel_load; /* counts RX Enable time */ | |
1628 | __le32 dsp_false_alarms; /* DSP false alarm (both OFDM | |
1629 | * and CCK) counter */ | |
1630 | __le32 beacon_rssi_a; | |
1631 | __le32 beacon_rssi_b; | |
1632 | __le32 beacon_rssi_c; | |
1633 | __le32 beacon_energy_a; | |
1634 | __le32 beacon_energy_b; | |
1635 | __le32 beacon_energy_c; | |
b481de9c ZY |
1636 | } __attribute__ ((packed)); |
1637 | ||
1638 | struct statistics_rx { | |
1639 | struct statistics_rx_phy ofdm; | |
1640 | struct statistics_rx_phy cck; | |
1641 | struct statistics_rx_non_phy general; | |
b481de9c | 1642 | struct statistics_rx_ht_phy ofdm_ht; |
b481de9c ZY |
1643 | } __attribute__ ((packed)); |
1644 | ||
b481de9c ZY |
1645 | struct statistics_tx_non_phy_agg { |
1646 | __le32 ba_timeout; | |
1647 | __le32 ba_reschedule_frames; | |
1648 | __le32 scd_query_agg_frame_cnt; | |
1649 | __le32 scd_query_no_agg; | |
1650 | __le32 scd_query_agg; | |
1651 | __le32 scd_query_mismatch; | |
1652 | __le32 frame_not_ready; | |
1653 | __le32 underrun; | |
1654 | __le32 bt_prio_kill; | |
1655 | __le32 rx_ba_rsp_cnt; | |
1656 | __le32 reserved2; | |
1657 | __le32 reserved3; | |
1658 | } __attribute__ ((packed)); | |
b481de9c ZY |
1659 | |
1660 | struct statistics_tx { | |
1661 | __le32 preamble_cnt; | |
1662 | __le32 rx_detected_cnt; | |
1663 | __le32 bt_prio_defer_cnt; | |
1664 | __le32 bt_prio_kill_cnt; | |
1665 | __le32 few_bytes_cnt; | |
1666 | __le32 cts_timeout; | |
1667 | __le32 ack_timeout; | |
1668 | __le32 expected_ack_cnt; | |
1669 | __le32 actual_ack_cnt; | |
b481de9c ZY |
1670 | __le32 dump_msdu_cnt; |
1671 | __le32 burst_abort_next_frame_mismatch_cnt; | |
1672 | __le32 burst_abort_missing_next_frame_cnt; | |
1673 | __le32 cts_timeout_collision; | |
1674 | __le32 ack_or_ba_timeout_collision; | |
1675 | struct statistics_tx_non_phy_agg agg; | |
b481de9c ZY |
1676 | } __attribute__ ((packed)); |
1677 | ||
1678 | struct statistics_dbg { | |
1679 | __le32 burst_check; | |
1680 | __le32 burst_count; | |
1681 | __le32 reserved[4]; | |
1682 | } __attribute__ ((packed)); | |
1683 | ||
1684 | struct statistics_div { | |
1685 | __le32 tx_on_a; | |
1686 | __le32 tx_on_b; | |
1687 | __le32 exec_time; | |
1688 | __le32 probe_time; | |
b481de9c ZY |
1689 | __le32 reserved1; |
1690 | __le32 reserved2; | |
b481de9c ZY |
1691 | } __attribute__ ((packed)); |
1692 | ||
1693 | struct statistics_general { | |
1694 | __le32 temperature; | |
b481de9c | 1695 | __le32 temperature_m; |
b481de9c ZY |
1696 | struct statistics_dbg dbg; |
1697 | __le32 sleep_time; | |
1698 | __le32 slots_out; | |
1699 | __le32 slots_idle; | |
1700 | __le32 ttl_timestamp; | |
1701 | struct statistics_div div; | |
b481de9c ZY |
1702 | __le32 rx_enable_counter; |
1703 | __le32 reserved1; | |
1704 | __le32 reserved2; | |
1705 | __le32 reserved3; | |
b481de9c ZY |
1706 | } __attribute__ ((packed)); |
1707 | ||
1708 | /* | |
1709 | * REPLY_STATISTICS_CMD = 0x9c, | |
1710 | * 3945 and 4965 identical. | |
1711 | * | |
1712 | * This command triggers an immediate response containing uCode statistics. | |
1713 | * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below. | |
1714 | * | |
1715 | * If the CLEAR_STATS configuration flag is set, uCode will clear its | |
1716 | * internal copy of the statistics (counters) after issuing the response. | |
1717 | * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below). | |
1718 | * | |
1719 | * If the DISABLE_NOTIF configuration flag is set, uCode will not issue | |
1720 | * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag | |
1721 | * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself. | |
1722 | */ | |
1723 | #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */ | |
1724 | #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */ | |
bb8c093b | 1725 | struct iwl4965_statistics_cmd { |
b481de9c ZY |
1726 | __le32 configuration_flags; /* IWL_STATS_CONF_* */ |
1727 | } __attribute__ ((packed)); | |
1728 | ||
1729 | /* | |
1730 | * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command) | |
1731 | * | |
1732 | * By default, uCode issues this notification after receiving a beacon | |
1733 | * while associated. To disable this behavior, set DISABLE_NOTIF flag in the | |
1734 | * REPLY_STATISTICS_CMD 0x9c, above. | |
1735 | * | |
1736 | * Statistics counters continue to increment beacon after beacon, but are | |
1737 | * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD | |
1738 | * 0x9c with CLEAR_STATS bit set (see above). | |
1739 | * | |
1740 | * uCode also issues this notification during scans. uCode clears statistics | |
1741 | * appropriately so that each notification contains statistics for only the | |
1742 | * one channel that has just been scanned. | |
1743 | */ | |
1744 | #define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2) | |
1745 | #define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8) | |
bb8c093b | 1746 | struct iwl4965_notif_statistics { |
b481de9c ZY |
1747 | __le32 flag; |
1748 | struct statistics_rx rx; | |
1749 | struct statistics_tx tx; | |
1750 | struct statistics_general general; | |
1751 | } __attribute__ ((packed)); | |
1752 | ||
1753 | ||
1754 | /* | |
1755 | * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command) | |
1756 | */ | |
1757 | /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row, | |
1758 | * then this notification will be sent. */ | |
1759 | #define CONSECUTIVE_MISSED_BCONS_TH 20 | |
1760 | ||
bb8c093b | 1761 | struct iwl4965_missed_beacon_notif { |
b481de9c ZY |
1762 | __le32 consequtive_missed_beacons; |
1763 | __le32 total_missed_becons; | |
1764 | __le32 num_expected_beacons; | |
1765 | __le32 num_recvd_beacons; | |
1766 | } __attribute__ ((packed)); | |
1767 | ||
f7d09d7c | 1768 | |
b481de9c ZY |
1769 | /****************************************************************************** |
1770 | * (11) | |
1771 | * Rx Calibration Commands: | |
1772 | * | |
f7d09d7c BC |
1773 | * With the uCode used for open source drivers, most Tx calibration (except |
1774 | * for Tx Power) and most Rx calibration is done by uCode during the | |
1775 | * "initialize" phase of uCode boot. Driver must calibrate only: | |
1776 | * | |
1777 | * 1) Tx power (depends on temperature), described elsewhere | |
1778 | * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas) | |
1779 | * 3) Receiver sensitivity (to optimize signal detection) | |
1780 | * | |
b481de9c ZY |
1781 | *****************************************************************************/ |
1782 | ||
f7d09d7c BC |
1783 | /** |
1784 | * SENSITIVITY_CMD = 0xa8 (command, has simple generic response) | |
1785 | * | |
1786 | * This command sets up the Rx signal detector for a sensitivity level that | |
1787 | * is high enough to lock onto all signals within the associated network, | |
1788 | * but low enough to ignore signals that are below a certain threshold, so as | |
1789 | * not to have too many "false alarms". False alarms are signals that the | |
1790 | * Rx DSP tries to lock onto, but then discards after determining that they | |
1791 | * are noise. | |
1792 | * | |
1793 | * The optimum number of false alarms is between 5 and 50 per 200 TUs | |
1794 | * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e. | |
1795 | * time listening, not transmitting). Driver must adjust sensitivity so that | |
1796 | * the ratio of actual false alarms to actual Rx time falls within this range. | |
1797 | * | |
1798 | * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each | |
1799 | * received beacon. These provide information to the driver to analyze the | |
1800 | * sensitivity. Don't analyze statistics that come in from scanning, or any | |
1801 | * other non-associated-network source. Pertinent statistics include: | |
1802 | * | |
1803 | * From "general" statistics (struct statistics_rx_non_phy): | |
1804 | * | |
1805 | * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level) | |
1806 | * Measure of energy of desired signal. Used for establishing a level | |
1807 | * below which the device does not detect signals. | |
1808 | * | |
1809 | * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB) | |
1810 | * Measure of background noise in silent period after beacon. | |
1811 | * | |
1812 | * channel_load | |
1813 | * uSecs of actual Rx time during beacon period (varies according to | |
1814 | * how much time was spent transmitting). | |
1815 | * | |
1816 | * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately: | |
1817 | * | |
1818 | * false_alarm_cnt | |
1819 | * Signal locks abandoned early (before phy-level header). | |
1820 | * | |
1821 | * plcp_err | |
1822 | * Signal locks abandoned late (during phy-level header). | |
1823 | * | |
1824 | * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from | |
1825 | * beacon to beacon, i.e. each value is an accumulation of all errors | |
1826 | * before and including the latest beacon. Values will wrap around to 0 | |
1827 | * after counting up to 2^32 - 1. Driver must differentiate vs. | |
1828 | * previous beacon's values to determine # false alarms in the current | |
1829 | * beacon period. | |
1830 | * | |
1831 | * Total number of false alarms = false_alarms + plcp_errs | |
1832 | * | |
1833 | * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd | |
1834 | * (notice that the start points for OFDM are at or close to settings for | |
1835 | * maximum sensitivity): | |
1836 | * | |
1837 | * START / MIN / MAX | |
1838 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120 | |
1839 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210 | |
1840 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140 | |
1841 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270 | |
1842 | * | |
1843 | * If actual rate of OFDM false alarms (+ plcp_errors) is too high | |
1844 | * (greater than 50 for each 204.8 msecs listening), reduce sensitivity | |
1845 | * by *adding* 1 to all 4 of the table entries above, up to the max for | |
1846 | * each entry. Conversely, if false alarm rate is too low (less than 5 | |
1847 | * for each 204.8 msecs listening), *subtract* 1 from each entry to | |
1848 | * increase sensitivity. | |
1849 | * | |
1850 | * For CCK sensitivity, keep track of the following: | |
1851 | * | |
1852 | * 1). 20-beacon history of maximum background noise, indicated by | |
1853 | * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the | |
1854 | * 3 receivers. For any given beacon, the "silence reference" is | |
1855 | * the maximum of last 60 samples (20 beacons * 3 receivers). | |
1856 | * | |
1857 | * 2). 10-beacon history of strongest signal level, as indicated | |
1858 | * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers, | |
1859 | * i.e. the strength of the signal through the best receiver at the | |
1860 | * moment. These measurements are "upside down", with lower values | |
1861 | * for stronger signals, so max energy will be *minimum* value. | |
1862 | * | |
1863 | * Then for any given beacon, the driver must determine the *weakest* | |
1864 | * of the strongest signals; this is the minimum level that needs to be | |
1865 | * successfully detected, when using the best receiver at the moment. | |
1866 | * "Max cck energy" is the maximum (higher value means lower energy!) | |
1867 | * of the last 10 minima. Once this is determined, driver must add | |
1868 | * a little margin by adding "6" to it. | |
1869 | * | |
1870 | * 3). Number of consecutive beacon periods with too few false alarms. | |
1871 | * Reset this to 0 at the first beacon period that falls within the | |
1872 | * "good" range (5 to 50 false alarms per 204.8 milliseconds rx). | |
1873 | * | |
1874 | * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd | |
1875 | * (notice that the start points for CCK are at maximum sensitivity): | |
1876 | * | |
1877 | * START / MIN / MAX | |
1878 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200 | |
1879 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400 | |
1880 | * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100 | |
1881 | * | |
1882 | * If actual rate of CCK false alarms (+ plcp_errors) is too high | |
1883 | * (greater than 50 for each 204.8 msecs listening), method for reducing | |
1884 | * sensitivity is: | |
1885 | * | |
1886 | * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
1887 | * up to max 400. | |
1888 | * | |
1889 | * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160, | |
1890 | * sensitivity has been reduced a significant amount; bring it up to | |
1891 | * a moderate 161. Otherwise, *add* 3, up to max 200. | |
1892 | * | |
1893 | * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160, | |
1894 | * sensitivity has been reduced only a moderate or small amount; | |
1895 | * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX, | |
1896 | * down to min 0. Otherwise (if gain has been significantly reduced), | |
1897 | * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value. | |
1898 | * | |
1899 | * b) Save a snapshot of the "silence reference". | |
1900 | * | |
1901 | * If actual rate of CCK false alarms (+ plcp_errors) is too low | |
1902 | * (less than 5 for each 204.8 msecs listening), method for increasing | |
1903 | * sensitivity is used only if: | |
1904 | * | |
1905 | * 1a) Previous beacon did not have too many false alarms | |
1906 | * 1b) AND difference between previous "silence reference" and current | |
1907 | * "silence reference" (prev - current) is 2 or more, | |
1908 | * OR 2) 100 or more consecutive beacon periods have had rate of | |
1909 | * less than 5 false alarms per 204.8 milliseconds rx time. | |
1910 | * | |
1911 | * Method for increasing sensitivity: | |
1912 | * | |
1913 | * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX, | |
1914 | * down to min 125. | |
1915 | * | |
1916 | * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX, | |
1917 | * down to min 200. | |
1918 | * | |
1919 | * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100. | |
1920 | * | |
1921 | * If actual rate of CCK false alarms (+ plcp_errors) is within good range | |
1922 | * (between 5 and 50 for each 204.8 msecs listening): | |
1923 | * | |
1924 | * 1) Save a snapshot of the silence reference. | |
1925 | * | |
1926 | * 2) If previous beacon had too many CCK false alarms (+ plcp_errors), | |
1927 | * give some extra margin to energy threshold by *subtracting* 8 | |
1928 | * from value in HD_MIN_ENERGY_CCK_DET_INDEX. | |
1929 | * | |
1930 | * For all cases (too few, too many, good range), make sure that the CCK | |
1931 | * detection threshold (energy) is below the energy level for robust | |
1932 | * detection over the past 10 beacon periods, the "Max cck energy". | |
1933 | * Lower values mean higher energy; this means making sure that the value | |
1934 | * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy". | |
1935 | * | |
1936 | * Driver should set the following entries to fixed values: | |
1937 | * | |
1938 | * HD_MIN_ENERGY_OFDM_DET_INDEX 100 | |
1939 | * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190 | |
1940 | * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390 | |
1941 | * HD_OFDM_ENERGY_TH_IN_INDEX 62 | |
1942 | */ | |
1943 | ||
1944 | /* | |
1945 | * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd) | |
1946 | */ | |
1947 | #define HD_TABLE_SIZE (11) /* number of entries */ | |
1948 | #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */ | |
1949 | #define HD_MIN_ENERGY_OFDM_DET_INDEX (1) | |
1950 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2) | |
1951 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3) | |
1952 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4) | |
1953 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5) | |
1954 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6) | |
1955 | #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7) | |
1956 | #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8) | |
1957 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9) | |
1958 | #define HD_OFDM_ENERGY_TH_IN_INDEX (10) | |
1959 | ||
1960 | /* Control field in struct iwl4965_sensitivity_cmd */ | |
1961 | #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0) | |
1962 | #define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1) | |
b481de9c | 1963 | |
f7d09d7c BC |
1964 | /** |
1965 | * struct iwl4965_sensitivity_cmd | |
1966 | * @control: (1) updates working table, (0) updates default table | |
1967 | * @table: energy threshold values, use HD_* as index into table | |
1968 | * | |
1969 | * Always use "1" in "control" to update uCode's working table and DSP. | |
1970 | */ | |
bb8c093b | 1971 | struct iwl4965_sensitivity_cmd { |
f7d09d7c BC |
1972 | __le16 control; /* always use "1" */ |
1973 | __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */ | |
b481de9c ZY |
1974 | } __attribute__ ((packed)); |
1975 | ||
f7d09d7c BC |
1976 | |
1977 | /** | |
1978 | * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response) | |
1979 | * | |
1980 | * This command sets the relative gains of 4965's 3 radio receiver chains. | |
1981 | * | |
1982 | * After the first association, driver should accumulate signal and noise | |
1983 | * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20 | |
1984 | * beacons from the associated network (don't collect statistics that come | |
1985 | * in from scanning, or any other non-network source). | |
1986 | * | |
1987 | * DISCONNECTED ANTENNA: | |
1988 | * | |
1989 | * Driver should determine which antennas are actually connected, by comparing | |
1990 | * average beacon signal levels for the 3 Rx chains. Accumulate (add) the | |
1991 | * following values over 20 beacons, one accumulator for each of the chains | |
1992 | * a/b/c, from struct statistics_rx_non_phy: | |
1993 | * | |
1994 | * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
1995 | * | |
1996 | * Find the strongest signal from among a/b/c. Compare the other two to the | |
1997 | * strongest. If any signal is more than 15 dB (times 20, unless you | |
1998 | * divide the accumulated values by 20) below the strongest, the driver | |
1999 | * considers that antenna to be disconnected, and should not try to use that | |
2000 | * antenna/chain for Rx or Tx. If both A and B seem to be disconnected, | |
2001 | * driver should declare the stronger one as connected, and attempt to use it | |
2002 | * (A and B are the only 2 Tx chains!). | |
2003 | * | |
2004 | * | |
2005 | * RX BALANCE: | |
2006 | * | |
2007 | * Driver should balance the 3 receivers (but just the ones that are connected | |
2008 | * to antennas, see above) for gain, by comparing the average signal levels | |
2009 | * detected during the silence after each beacon (background noise). | |
2010 | * Accumulate (add) the following values over 20 beacons, one accumulator for | |
2011 | * each of the chains a/b/c, from struct statistics_rx_non_phy: | |
2012 | * | |
2013 | * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB) | |
2014 | * | |
2015 | * Find the weakest background noise level from among a/b/c. This Rx chain | |
2016 | * will be the reference, with 0 gain adjustment. Attenuate other channels by | |
2017 | * finding noise difference: | |
2018 | * | |
2019 | * (accum_noise[i] - accum_noise[reference]) / 30 | |
2020 | * | |
2021 | * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB. | |
2022 | * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the | |
2023 | * driver should limit the difference results to a range of 0-3 (0-4.5 dB), | |
2024 | * and set bit 2 to indicate "reduce gain". The value for the reference | |
2025 | * (weakest) chain should be "0". | |
2026 | * | |
2027 | * diff_gain_[abc] bit fields: | |
2028 | * 2: (1) reduce gain, (0) increase gain | |
2029 | * 1-0: amount of gain, units of 1.5 dB | |
2030 | */ | |
2031 | ||
2032 | /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */ | |
2033 | #define PHY_CALIBRATE_DIFF_GAIN_CMD (7) | |
2034 | ||
bb8c093b | 2035 | struct iwl4965_calibration_cmd { |
f7d09d7c BC |
2036 | u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */ |
2037 | u8 flags; /* not used */ | |
b481de9c | 2038 | __le16 reserved; |
f7d09d7c | 2039 | s8 diff_gain_a; /* see above */ |
b481de9c ZY |
2040 | s8 diff_gain_b; |
2041 | s8 diff_gain_c; | |
2042 | u8 reserved1; | |
2043 | } __attribute__ ((packed)); | |
2044 | ||
2045 | /****************************************************************************** | |
2046 | * (12) | |
2047 | * Miscellaneous Commands: | |
2048 | * | |
2049 | *****************************************************************************/ | |
2050 | ||
2051 | /* | |
2052 | * LEDs Command & Response | |
2053 | * REPLY_LEDS_CMD = 0x48 (command, has simple generic response) | |
2054 | * | |
2055 | * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field), | |
2056 | * this command turns it on or off, or sets up a periodic blinking cycle. | |
2057 | */ | |
bb8c093b | 2058 | struct iwl4965_led_cmd { |
b481de9c ZY |
2059 | __le32 interval; /* "interval" in uSec */ |
2060 | u8 id; /* 1: Activity, 2: Link, 3: Tech */ | |
2061 | u8 off; /* # intervals off while blinking; | |
2062 | * "0", with >0 "on" value, turns LED on */ | |
2063 | u8 on; /* # intervals on while blinking; | |
2064 | * "0", regardless of "off", turns LED off */ | |
2065 | u8 reserved; | |
2066 | } __attribute__ ((packed)); | |
2067 | ||
2068 | /****************************************************************************** | |
2069 | * (13) | |
2070 | * Union of all expected notifications/responses: | |
2071 | * | |
2072 | *****************************************************************************/ | |
2073 | ||
bb8c093b | 2074 | struct iwl4965_rx_packet { |
b481de9c | 2075 | __le32 len; |
bb8c093b | 2076 | struct iwl4965_cmd_header hdr; |
b481de9c | 2077 | union { |
bb8c093b CH |
2078 | struct iwl4965_alive_resp alive_frame; |
2079 | struct iwl4965_rx_frame rx_frame; | |
2080 | struct iwl4965_tx_resp tx_resp; | |
2081 | struct iwl4965_spectrum_notification spectrum_notif; | |
2082 | struct iwl4965_csa_notification csa_notif; | |
2083 | struct iwl4965_error_resp err_resp; | |
2084 | struct iwl4965_card_state_notif card_state_notif; | |
2085 | struct iwl4965_beacon_notif beacon_status; | |
2086 | struct iwl4965_add_sta_resp add_sta; | |
2087 | struct iwl4965_sleep_notification sleep_notif; | |
2088 | struct iwl4965_spectrum_resp spectrum; | |
2089 | struct iwl4965_notif_statistics stats; | |
2090 | struct iwl4965_compressed_ba_resp compressed_ba; | |
2091 | struct iwl4965_missed_beacon_notif missed_beacon; | |
b481de9c ZY |
2092 | __le32 status; |
2093 | u8 raw[0]; | |
2094 | } u; | |
2095 | } __attribute__ ((packed)); | |
2096 | ||
bb8c093b | 2097 | #define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame)) |
b481de9c | 2098 | |
bb8c093b | 2099 | #endif /* __iwl4965_commands_h__ */ |