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