1 /******************************************************************************
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.
8 * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
64 * Please use this file (iwl-commands.h) only for uCode API definitions.
65 * Please use iwl-4965-hw.h for hardware-related definitions.
66 * Please use iwl-dev.h for driver implementation definitions.
69 #ifndef __iwl_commands_h__
70 #define __iwl_commands_h__
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)
82 #define IWL_CCK_RATES 4
83 #define IWL_OFDM_RATES 8
84 #define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES)
90 /* RXON and QOS commands */
92 REPLY_RXON_ASSOC = 0x11,
93 REPLY_QOS_PARAM = 0x13,
94 REPLY_RXON_TIMING = 0x14,
96 /* Multi-Station support */
98 REPLY_REMOVE_STA = 0x19, /* not used */
99 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
105 REPLY_3945_RX = 0x1b, /* 3945 only */
107 REPLY_RATE_SCALE = 0x47, /* 3945 only */
108 REPLY_LEDS_CMD = 0x48,
109 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
111 /* WiMAX coexistence */
112 COEX_PRIORITY_TABLE_CMD = 0x5a, /*5000 only */
113 COEX_MEDIUM_NOTIFICATION = 0x5b,
114 COEX_EVENT_CMD = 0x5c,
117 CALIBRATION_CFG_CMD = 0x65,
118 CALIBRATION_RES_NOTIFICATION = 0x66,
119 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
121 /* 802.11h related */
122 RADAR_NOTIFICATION = 0x70, /* not used */
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,
129 /* Power Management */
130 POWER_TABLE_CMD = 0x77,
131 PM_SLEEP_NOTIFICATION = 0x7A,
132 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
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,
141 /* IBSS/AP commands */
142 BEACON_NOTIFICATION = 0x90,
143 REPLY_TX_BEACON = 0x91,
144 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
146 /* Miscellaneous commands */
147 REPLY_TX_POWER_DBM_CMD = 0x95,
148 QUIET_NOTIFICATION = 0x96, /* not used */
149 REPLY_TX_PWR_TABLE_CMD = 0x97,
150 REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */
151 TX_ANT_CONFIGURATION_CMD = 0x98,
152 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
154 /* Bluetooth device coexistence config command */
155 REPLY_BT_CONFIG = 0x9b,
158 REPLY_STATISTICS_CMD = 0x9c,
159 STATISTICS_NOTIFICATION = 0x9d,
161 /* RF-KILL commands and notifications */
162 REPLY_CARD_STATE_CMD = 0xa0,
163 CARD_STATE_NOTIFICATION = 0xa1,
165 /* Missed beacons notification */
166 MISSED_BEACONS_NOTIFICATION = 0xa2,
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,
174 REPLY_COMPRESSED_BA = 0xc5,
178 /******************************************************************************
180 * Commonly used structures and definitions:
181 * Command header, rate_n_flags, txpower
183 *****************************************************************************/
185 /* iwl_cmd_header flags value */
186 #define IWL_CMD_FAILED_MSK 0x40
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)
192 #define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
193 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
196 * struct iwl_cmd_header
198 * This header format appears in the beginning of each command sent from the
199 * driver, and each response/notification received from uCode.
201 struct iwl_cmd_header {
202 u8 cmd; /* Command ID: REPLY_RXON, etc. */
203 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
205 * The driver sets up the sequence number to values of its choosing.
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.
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.
217 * The Linux driver uses the following format:
219 * 0:7 tfd index - position within TX queue
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
228 /* command or response/notification data follows immediately */
230 } __attribute__ ((packed));
234 * struct iwl3945_tx_power
236 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH
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.
245 * Driver obtains values from struct iwl3945_tx_power power_gain_table[][].
247 struct iwl3945_tx_power {
248 u8 tx_gain; /* gain for analog radio */
249 u8 dsp_atten; /* gain for DSP */
250 } __attribute__ ((packed));
253 * struct iwl3945_power_per_rate
255 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
257 struct iwl3945_power_per_rate {
259 struct iwl3945_tx_power tpc;
261 } __attribute__ ((packed));
264 * iwlagn rate_n_flags bit fields
266 * rate_n_flags format is used in following iwlagn commands:
267 * REPLY_RX (response only)
268 * REPLY_RX_MPDU (response only)
269 * REPLY_TX (both command and response)
270 * REPLY_TX_LINK_QUALITY_CMD
272 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
282 * 4-3: 0) Single stream (SISO)
283 * 1) Dual stream (MIMO)
284 * 2) Triple stream (MIMO)
286 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
288 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
298 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
304 #define RATE_MCS_CODE_MSK 0x7
305 #define RATE_MCS_SPATIAL_POS 3
306 #define RATE_MCS_SPATIAL_MSK 0x18
307 #define RATE_MCS_HT_DUP_POS 5
308 #define RATE_MCS_HT_DUP_MSK 0x20
310 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
311 #define RATE_MCS_FLAGS_POS 8
312 #define RATE_MCS_HT_POS 8
313 #define RATE_MCS_HT_MSK 0x100
315 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
316 #define RATE_MCS_CCK_POS 9
317 #define RATE_MCS_CCK_MSK 0x200
319 /* Bit 10: (1) Use Green Field preamble */
320 #define RATE_MCS_GF_POS 10
321 #define RATE_MCS_GF_MSK 0x400
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
327 /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
328 #define RATE_MCS_DUP_POS 12
329 #define RATE_MCS_DUP_MSK 0x1000
331 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
332 #define RATE_MCS_SGI_POS 13
333 #define RATE_MCS_SGI_MSK 0x2000
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
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)
350 #define RATE_ANT_NUM 3
352 #define POWER_TABLE_NUM_ENTRIES 33
353 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
354 #define POWER_TABLE_CCK_ENTRY 32
357 * union iwl4965_tx_power_dual_stream
359 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
360 * Use __le32 version (struct tx_power_dual_stream) when building command.
362 * Driver provides radio gain and DSP attenuation settings to device in pairs,
363 * one value for each transmitter chain. The first value is for transmitter A,
364 * second for transmitter B.
366 * For SISO bit rates, both values in a pair should be identical.
367 * For MIMO rates, one value may be different from the other,
368 * in order to balance the Tx output between the two transmitters.
370 * See more details in doc for TXPOWER in iwl-4965-hw.h.
372 union iwl4965_tx_power_dual_stream {
375 u8 dsp_predis_atten[2];
381 * struct tx_power_dual_stream
383 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
385 * Same format as iwl_tx_power_dual_stream, but __le32
387 struct tx_power_dual_stream {
389 } __attribute__ ((packed));
392 * struct iwl4965_tx_power_db
394 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
396 struct iwl4965_tx_power_db {
397 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
398 } __attribute__ ((packed));
401 * Command REPLY_TX_POWER_DBM_CMD = 0x98
402 * struct iwl5000_tx_power_dbm_cmd
404 #define IWL50_TX_POWER_AUTO 0x7f
405 #define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
407 struct iwl5000_tx_power_dbm_cmd {
408 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
410 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
412 } __attribute__ ((packed));
415 * Command TX_ANT_CONFIGURATION_CMD = 0x98
416 * This command is used to configure valid Tx antenna.
417 * By default uCode concludes the valid antenna according to the radio flavor.
418 * This command enables the driver to override/modify this conclusion.
420 struct iwl_tx_ant_config_cmd {
422 } __attribute__ ((packed));
424 /******************************************************************************
426 * Alive and Error Commands & Responses:
428 *****************************************************************************/
430 #define UCODE_VALID_OK cpu_to_le32(0x1)
431 #define INITIALIZE_SUBTYPE (9)
434 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
436 * uCode issues this "initialize alive" notification once the initialization
437 * uCode image has completed its work, and is ready to load the runtime image.
438 * This is the *first* "alive" notification that the driver will receive after
439 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
441 * See comments documenting "BSM" (bootstrap state machine).
443 * For 4965, this notification contains important calibration data for
444 * calculating txpower settings:
446 * 1) Power supply voltage indication. The voltage sensor outputs higher
447 * values for lower voltage, and vice verse.
449 * 2) Temperature measurement parameters, for each of two channel widths
450 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
451 * is done via one of the receiver chains, and channel width influences
454 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
455 * for each of 5 frequency ranges.
457 struct iwl_init_alive_resp {
463 u8 ver_subtype; /* "9" for initialize alive */
465 __le32 log_event_table_ptr;
466 __le32 error_event_table_ptr;
470 /* calibration values from "initialize" uCode */
471 __le32 voltage; /* signed, higher value is lower voltage */
472 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */
473 __le32 therm_r2[2]; /* signed */
474 __le32 therm_r3[2]; /* signed */
475 __le32 therm_r4[2]; /* signed */
476 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
478 } __attribute__ ((packed));
482 * REPLY_ALIVE = 0x1 (response only, not a command)
484 * uCode issues this "alive" notification once the runtime image is ready
485 * to receive commands from the driver. This is the *second* "alive"
486 * notification that the driver will receive after rebooting uCode;
487 * this "alive" is indicated by subtype field != 9.
489 * See comments documenting "BSM" (bootstrap state machine).
491 * This response includes two pointers to structures within the device's
492 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
494 * 1) log_event_table_ptr indicates base of the event log. This traces
495 * a 256-entry history of uCode execution within a circular buffer.
496 * Its header format is:
498 * __le32 log_size; log capacity (in number of entries)
499 * __le32 type; (1) timestamp with each entry, (0) no timestamp
500 * __le32 wraps; # times uCode has wrapped to top of circular buffer
501 * __le32 write_index; next circular buffer entry that uCode would fill
503 * The header is followed by the circular buffer of log entries. Entries
504 * with timestamps have the following format:
506 * __le32 event_id; range 0 - 1500
507 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
508 * __le32 data; event_id-specific data value
510 * Entries without timestamps contain only event_id and data.
512 * 2) error_event_table_ptr indicates base of the error log. This contains
513 * information about any uCode error that occurs. For 4965, the format
514 * of the error log is:
516 * __le32 valid; (nonzero) valid, (0) log is empty
517 * __le32 error_id; type of error
518 * __le32 pc; program counter
519 * __le32 blink1; branch link
520 * __le32 blink2; branch link
521 * __le32 ilink1; interrupt link
522 * __le32 ilink2; interrupt link
523 * __le32 data1; error-specific data
524 * __le32 data2; error-specific data
525 * __le32 line; source code line of error
526 * __le32 bcon_time; beacon timer
527 * __le32 tsf_low; network timestamp function timer
528 * __le32 tsf_hi; network timestamp function timer
530 * The Linux driver can print both logs to the system log when a uCode error
533 struct iwl_alive_resp {
539 u8 ver_subtype; /* not "9" for runtime alive */
541 __le32 log_event_table_ptr; /* SRAM address for event log */
542 __le32 error_event_table_ptr; /* SRAM address for error log */
545 } __attribute__ ((packed));
548 * REPLY_ERROR = 0x2 (response only, not a command)
550 struct iwl_error_resp {
554 __le16 bad_cmd_seq_num;
557 } __attribute__ ((packed));
559 /******************************************************************************
561 * RXON Commands & Responses:
563 *****************************************************************************/
566 * Rx config defines & structure
568 /* rx_config device types */
570 RXON_DEV_TYPE_AP = 1,
571 RXON_DEV_TYPE_ESS = 3,
572 RXON_DEV_TYPE_IBSS = 4,
573 RXON_DEV_TYPE_SNIFFER = 6,
577 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
578 #define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)
579 #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
580 #define RXON_RX_CHAIN_VALID_POS (1)
581 #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
582 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
583 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
584 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
585 #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
586 #define RXON_RX_CHAIN_CNT_POS (10)
587 #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
588 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
589 #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
590 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
592 /* rx_config flags */
593 /* band & modulation selection */
594 #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
595 #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
596 /* auto detection enable */
597 #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
598 /* TGg protection when tx */
599 #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
600 /* cck short slot & preamble */
601 #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
602 #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
603 /* antenna selection */
604 #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
605 #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
606 #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
607 #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
608 /* radar detection enable */
609 #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
610 #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
611 /* rx response to host with 8-byte TSF
612 * (according to ON_AIR deassertion) */
613 #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
617 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
618 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
620 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
622 #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
623 #define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)
625 #define RXON_FLG_CHANNEL_MODE_POS (25)
626 #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
630 CHANNEL_MODE_LEGACY = 0,
631 CHANNEL_MODE_PURE_40 = 1,
632 CHANNEL_MODE_MIXED = 2,
633 CHANNEL_MODE_RESERVED = 3,
635 #define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
636 #define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
637 #define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
639 /* CTS to self (if spec allows) flag */
640 #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
642 /* rx_config filter flags */
643 /* accept all data frames */
644 #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
645 /* pass control & management to host */
646 #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
647 /* accept multi-cast */
648 #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
649 /* don't decrypt uni-cast frames */
650 #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
651 /* don't decrypt multi-cast frames */
652 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
653 /* STA is associated */
654 #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
655 /* transfer to host non bssid beacons in associated state */
656 #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
659 * REPLY_RXON = 0x10 (command, has simple generic response)
661 * RXON tunes the radio tuner to a service channel, and sets up a number
662 * of parameters that are used primarily for Rx, but also for Tx operations.
664 * NOTE: When tuning to a new channel, driver must set the
665 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
666 * info within the device, including the station tables, tx retry
667 * rate tables, and txpower tables. Driver must build a new station
668 * table and txpower table before transmitting anything on the RXON
671 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
672 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
673 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
676 struct iwl3945_rxon_cmd {
681 u8 wlap_bssid_addr[6];
693 } __attribute__ ((packed));
695 struct iwl4965_rxon_cmd {
700 u8 wlap_bssid_addr[6];
711 u8 ofdm_ht_single_stream_basic_rates;
712 u8 ofdm_ht_dual_stream_basic_rates;
713 } __attribute__ ((packed));
715 /* 5000 HW just extend this command */
716 struct iwl_rxon_cmd {
721 u8 wlap_bssid_addr[6];
732 u8 ofdm_ht_single_stream_basic_rates;
733 u8 ofdm_ht_dual_stream_basic_rates;
734 u8 ofdm_ht_triple_stream_basic_rates;
736 __le16 acquisition_data;
738 } __attribute__ ((packed));
741 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
743 struct iwl3945_rxon_assoc_cmd {
749 } __attribute__ ((packed));
751 struct iwl4965_rxon_assoc_cmd {
756 u8 ofdm_ht_single_stream_basic_rates;
757 u8 ofdm_ht_dual_stream_basic_rates;
758 __le16 rx_chain_select_flags;
760 } __attribute__ ((packed));
762 struct iwl5000_rxon_assoc_cmd {
768 u8 ofdm_ht_single_stream_basic_rates;
769 u8 ofdm_ht_dual_stream_basic_rates;
770 u8 ofdm_ht_triple_stream_basic_rates;
772 __le16 rx_chain_select_flags;
773 __le16 acquisition_data;
775 } __attribute__ ((packed));
777 #define IWL_CONN_MAX_LISTEN_INTERVAL 10
778 #define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
779 #define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
782 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
784 struct iwl_rxon_time_cmd {
786 __le16 beacon_interval;
788 __le32 beacon_init_val;
789 __le16 listen_interval;
791 } __attribute__ ((packed));
794 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
796 struct iwl3945_channel_switch_cmd {
801 __le32 rxon_filter_flags;
803 struct iwl3945_power_per_rate power[IWL_MAX_RATES];
804 } __attribute__ ((packed));
806 struct iwl_channel_switch_cmd {
811 __le32 rxon_filter_flags;
813 struct iwl4965_tx_power_db tx_power;
814 } __attribute__ ((packed));
817 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
819 struct iwl_csa_notification {
822 __le32 status; /* 0 - OK, 1 - fail */
823 } __attribute__ ((packed));
825 /******************************************************************************
827 * Quality-of-Service (QOS) Commands & Responses:
829 *****************************************************************************/
832 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
833 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
835 * @cw_min: Contention window, start value in numbers of slots.
836 * Should be a power-of-2, minus 1. Device's default is 0x0f.
837 * @cw_max: Contention window, max value in numbers of slots.
838 * Should be a power-of-2, minus 1. Device's default is 0x3f.
839 * @aifsn: Number of slots in Arbitration Interframe Space (before
840 * performing random backoff timing prior to Tx). Device default 1.
841 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
843 * Device will automatically increase contention window by (2*CW) + 1 for each
844 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
845 * value, to cap the CW value.
853 } __attribute__ ((packed));
855 /* QoS flags defines */
856 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
857 #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
858 #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
860 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
864 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
866 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
867 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
869 struct iwl_qosparam_cmd {
871 struct iwl_ac_qos ac[AC_NUM];
872 } __attribute__ ((packed));
874 /******************************************************************************
876 * Add/Modify Stations Commands & Responses:
878 *****************************************************************************/
880 * Multi station support
883 /* Special, dedicated locations within device's station table */
885 #define IWL_MULTICAST_ID 1
887 #define IWL3945_BROADCAST_ID 24
888 #define IWL3945_STATION_COUNT 25
889 #define IWL4965_BROADCAST_ID 31
890 #define IWL4965_STATION_COUNT 32
891 #define IWL5000_BROADCAST_ID 15
892 #define IWL5000_STATION_COUNT 16
894 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
895 #define IWL_INVALID_STATION 255
897 #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2);
898 #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8);
899 #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
900 #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
901 #define STA_FLG_MAX_AGG_SIZE_POS (19)
902 #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
903 #define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)
904 #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
905 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
906 #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
908 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
909 #define STA_CONTROL_MODIFY_MSK 0x01
911 /* key flags __le16*/
912 #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
913 #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
914 #define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
915 #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
916 #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
918 #define STA_KEY_FLG_KEYID_POS 8
919 #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
920 /* wep key is either from global key (0) or from station info array (1) */
921 #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
923 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
924 #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
925 #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
926 #define STA_KEY_MAX_NUM 8
928 /* Flags indicate whether to modify vs. don't change various station params */
929 #define STA_MODIFY_KEY_MASK 0x01
930 #define STA_MODIFY_TID_DISABLE_TX 0x02
931 #define STA_MODIFY_TX_RATE_MSK 0x04
932 #define STA_MODIFY_ADDBA_TID_MSK 0x08
933 #define STA_MODIFY_DELBA_TID_MSK 0x10
935 /* Receiver address (actually, Rx station's index into station table),
936 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
937 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
939 struct iwl4965_keyinfo {
941 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
943 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
946 u8 key[16]; /* 16-byte unicast decryption key */
947 } __attribute__ ((packed));
952 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
954 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
957 u8 key[16]; /* 16-byte unicast decryption key */
958 __le64 tx_secur_seq_cnt;
959 __le64 hw_tkip_mic_rx_key;
960 __le64 hw_tkip_mic_tx_key;
961 } __attribute__ ((packed));
964 * struct sta_id_modify
965 * @addr[ETH_ALEN]: station's MAC address
966 * @sta_id: index of station in uCode's station table
967 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
969 * Driver selects unused table index when adding new station,
970 * or the index to a pre-existing station entry when modifying that station.
971 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
973 * modify_mask flags select which parameters to modify vs. leave alone.
975 struct sta_id_modify {
981 } __attribute__ ((packed));
984 * REPLY_ADD_STA = 0x18 (command)
986 * The device contains an internal table of per-station information,
987 * with info on security keys, aggregation parameters, and Tx rates for
988 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
989 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
991 * REPLY_ADD_STA sets up the table entry for one station, either creating
992 * a new entry, or modifying a pre-existing one.
994 * NOTE: RXON command (without "associated" bit set) wipes the station table
995 * clean. Moving into RF_KILL state does this also. Driver must set up
996 * new station table before transmitting anything on the RXON channel
997 * (except active scans or active measurements; those commands carry
998 * their own txpower/rate setup data).
1000 * When getting started on a new channel, driver must set up the
1001 * IWL_BROADCAST_ID entry (last entry in the table). For a client
1002 * station in a BSS, once an AP is selected, driver sets up the AP STA
1003 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
1004 * are all that are needed for a BSS client station. If the device is
1005 * used as AP, or in an IBSS network, driver must set up station table
1006 * entries for all STAs in network, starting with index IWL_STA_ID.
1009 struct iwl3945_addsta_cmd {
1010 u8 mode; /* 1: modify existing, 0: add new station */
1012 struct sta_id_modify sta;
1013 struct iwl4965_keyinfo key;
1014 __le32 station_flags; /* STA_FLG_* */
1015 __le32 station_flags_msk; /* STA_FLG_* */
1017 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1018 * corresponding to bit (e.g. bit 5 controls TID 5).
1019 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
1020 __le16 tid_disable_tx;
1022 __le16 rate_n_flags;
1024 /* TID for which to add block-ack support.
1025 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1026 u8 add_immediate_ba_tid;
1028 /* TID for which to remove block-ack support.
1029 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
1030 u8 remove_immediate_ba_tid;
1032 /* Starting Sequence Number for added block-ack support.
1033 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1034 __le16 add_immediate_ba_ssn;
1035 } __attribute__ ((packed));
1037 struct iwl4965_addsta_cmd {
1038 u8 mode; /* 1: modify existing, 0: add new station */
1040 struct sta_id_modify sta;
1041 struct iwl4965_keyinfo key;
1042 __le32 station_flags; /* STA_FLG_* */
1043 __le32 station_flags_msk; /* STA_FLG_* */
1045 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1046 * corresponding to bit (e.g. bit 5 controls TID 5).
1047 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
1048 __le16 tid_disable_tx;
1052 /* TID for which to add block-ack support.
1053 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1054 u8 add_immediate_ba_tid;
1056 /* TID for which to remove block-ack support.
1057 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
1058 u8 remove_immediate_ba_tid;
1060 /* Starting Sequence Number for added block-ack support.
1061 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1062 __le16 add_immediate_ba_ssn;
1065 } __attribute__ ((packed));
1068 struct iwl_addsta_cmd {
1069 u8 mode; /* 1: modify existing, 0: add new station */
1071 struct sta_id_modify sta;
1072 struct iwl_keyinfo key;
1073 __le32 station_flags; /* STA_FLG_* */
1074 __le32 station_flags_msk; /* STA_FLG_* */
1076 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1077 * corresponding to bit (e.g. bit 5 controls TID 5).
1078 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
1079 __le16 tid_disable_tx;
1081 __le16 rate_n_flags; /* 3945 only */
1083 /* TID for which to add block-ack support.
1084 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1085 u8 add_immediate_ba_tid;
1087 /* TID for which to remove block-ack support.
1088 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
1089 u8 remove_immediate_ba_tid;
1091 /* Starting Sequence Number for added block-ack support.
1092 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1093 __le16 add_immediate_ba_ssn;
1096 } __attribute__ ((packed));
1099 #define ADD_STA_SUCCESS_MSK 0x1
1100 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
1101 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
1102 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
1104 * REPLY_ADD_STA = 0x18 (response)
1106 struct iwl_add_sta_resp {
1107 u8 status; /* ADD_STA_* */
1108 } __attribute__ ((packed));
1110 #define REM_STA_SUCCESS_MSK 0x1
1112 * REPLY_REM_STA = 0x19 (response)
1114 struct iwl_rem_sta_resp {
1116 } __attribute__ ((packed));
1119 * REPLY_REM_STA = 0x19 (command)
1121 struct iwl_rem_sta_cmd {
1122 u8 num_sta; /* number of removed stations */
1124 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
1126 } __attribute__ ((packed));
1129 * REPLY_WEP_KEY = 0x20
1131 struct iwl_wep_key {
1138 } __attribute__ ((packed));
1140 struct iwl_wep_cmd {
1145 struct iwl_wep_key key[0];
1146 } __attribute__ ((packed));
1148 #define WEP_KEY_WEP_TYPE 1
1149 #define WEP_KEYS_MAX 4
1150 #define WEP_INVALID_OFFSET 0xff
1151 #define WEP_KEY_LEN_64 5
1152 #define WEP_KEY_LEN_128 13
1154 /******************************************************************************
1158 *****************************************************************************/
1160 #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1161 #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
1163 #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1164 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1165 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1166 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
1167 #define RX_RES_PHY_FLAGS_ANTENNA_MSK cpu_to_le16(0xf0)
1168 #define RX_RES_PHY_FLAGS_ANTENNA_POS 4
1170 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1171 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1172 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1173 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1174 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
1175 #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1177 #define RX_RES_STATUS_STATION_FOUND (1<<6)
1178 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
1180 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1181 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1182 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1183 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1184 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
1186 #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1187 #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1188 #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1189 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1192 struct iwl3945_rx_frame_stats {
1200 } __attribute__ ((packed));
1202 struct iwl3945_rx_frame_hdr {
1209 } __attribute__ ((packed));
1211 struct iwl3945_rx_frame_end {
1214 __le32 beacon_timestamp;
1215 } __attribute__ ((packed));
1218 * REPLY_3945_RX = 0x1b (response only, not a command)
1220 * NOTE: DO NOT dereference from casts to this structure
1221 * It is provided only for calculating minimum data set size.
1222 * The actual offsets of the hdr and end are dynamic based on
1225 struct iwl3945_rx_frame {
1226 struct iwl3945_rx_frame_stats stats;
1227 struct iwl3945_rx_frame_hdr hdr;
1228 struct iwl3945_rx_frame_end end;
1229 } __attribute__ ((packed));
1231 #define IWL39_RX_FRAME_SIZE (4 + sizeof(struct iwl3945_rx_frame))
1233 /* Fixed (non-configurable) rx data from phy */
1235 #define IWL49_RX_RES_PHY_CNT 14
1236 #define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
1237 #define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
1238 #define IWL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
1239 #define IWL49_AGC_DB_POS (7)
1240 struct iwl4965_rx_non_cfg_phy {
1241 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
1242 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
1243 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
1245 } __attribute__ ((packed));
1248 #define IWL50_RX_RES_PHY_CNT 8
1249 #define IWL50_RX_RES_AGC_IDX 1
1250 #define IWL50_RX_RES_RSSI_AB_IDX 2
1251 #define IWL50_RX_RES_RSSI_C_IDX 3
1252 #define IWL50_OFDM_AGC_MSK 0xfe00
1253 #define IWL50_OFDM_AGC_BIT_POS 9
1254 #define IWL50_OFDM_RSSI_A_MSK 0x00ff
1255 #define IWL50_OFDM_RSSI_A_BIT_POS 0
1256 #define IWL50_OFDM_RSSI_B_MSK 0xff0000
1257 #define IWL50_OFDM_RSSI_B_BIT_POS 16
1258 #define IWL50_OFDM_RSSI_C_MSK 0x00ff
1259 #define IWL50_OFDM_RSSI_C_BIT_POS 0
1261 struct iwl5000_non_cfg_phy {
1262 __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT]; /* up to 8 phy entries */
1263 } __attribute__ ((packed));
1267 * REPLY_RX = 0xc3 (response only, not a command)
1268 * Used only for legacy (non 11n) frames.
1270 struct iwl_rx_phy_res {
1271 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1272 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1273 u8 stat_id; /* configurable DSP phy data set ID */
1275 __le64 timestamp; /* TSF at on air rise */
1276 __le32 beacon_time_stamp; /* beacon at on-air rise */
1277 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1278 __le16 channel; /* channel number */
1279 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1280 __le32 rate_n_flags; /* RATE_MCS_* */
1281 __le16 byte_count; /* frame's byte-count */
1283 } __attribute__ ((packed));
1285 struct iwl4965_rx_mpdu_res_start {
1288 } __attribute__ ((packed));
1291 /******************************************************************************
1293 * Tx Commands & Responses:
1295 * Driver must place each REPLY_TX command into one of the prioritized Tx
1296 * queues in host DRAM, shared between driver and device (see comments for
1297 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1298 * are preparing to transmit, the device pulls the Tx command over the PCI
1299 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1300 * from which data will be transmitted.
1302 * uCode handles all timing and protocol related to control frames
1303 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1304 * handle reception of block-acks; uCode updates the host driver via
1305 * REPLY_COMPRESSED_BA (4965).
1307 * uCode handles retrying Tx when an ACK is expected but not received.
1308 * This includes trying lower data rates than the one requested in the Tx
1309 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1310 * REPLY_TX_LINK_QUALITY_CMD (4965).
1312 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1313 * This command must be executed after every RXON command, before Tx can occur.
1314 *****************************************************************************/
1316 /* REPLY_TX Tx flags field */
1318 /* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1319 * before this frame. if CTS-to-self required check
1320 * RXON_FLG_SELF_CTS_EN status. */
1321 #define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0)
1323 /* 1: Use Request-To-Send protocol before this frame.
1324 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
1325 #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1327 /* 1: Transmit Clear-To-Send to self before this frame.
1328 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1329 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
1330 #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1332 /* 1: Expect ACK from receiving station
1333 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1334 * Set this for unicast frames, but not broadcast/multicast. */
1335 #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1338 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1339 * Tx command's initial_rate_index indicates first rate to try;
1340 * uCode walks through table for additional Tx attempts.
1341 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1342 * This rate will be used for all Tx attempts; it will not be scaled. */
1343 #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1345 /* 1: Expect immediate block-ack.
1346 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1347 #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
1349 /* 1: Frame requires full Tx-Op protection.
1350 * Set this if either RTS or CTS Tx Flag gets set. */
1351 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1353 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1354 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1355 #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1356 #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1357 #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
1359 /* 1: Ignore Bluetooth priority for this frame.
1360 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1361 #define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12)
1363 /* 1: uCode overrides sequence control field in MAC header.
1364 * 0: Driver provides sequence control field in MAC header.
1365 * Set this for management frames, non-QOS data frames, non-unicast frames,
1366 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1367 #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
1369 /* 1: This frame is non-last MPDU; more fragments are coming.
1370 * 0: Last fragment, or not using fragmentation. */
1371 #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
1373 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1374 * 0: No TSF required in outgoing frame.
1375 * Set this for transmitting beacons and probe responses. */
1376 #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
1378 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1379 * alignment of frame's payload data field.
1381 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1382 * field (but not both). Driver must align frame data (i.e. data following
1383 * MAC header) to DWORD boundary. */
1384 #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
1386 /* accelerate aggregation support
1387 * 0 - no CCMP encryption; 1 - CCMP encryption */
1388 #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1390 /* HCCA-AP - disable duration overwriting. */
1391 #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
1395 * TX command security control
1397 #define TX_CMD_SEC_WEP 0x01
1398 #define TX_CMD_SEC_CCM 0x02
1399 #define TX_CMD_SEC_TKIP 0x03
1400 #define TX_CMD_SEC_MSK 0x03
1401 #define TX_CMD_SEC_SHIFT 6
1402 #define TX_CMD_SEC_KEY128 0x08
1405 * security overhead sizes
1407 #define WEP_IV_LEN 4
1408 #define WEP_ICV_LEN 4
1409 #define CCMP_MIC_LEN 8
1410 #define TKIP_ICV_LEN 4
1413 * REPLY_TX = 0x1c (command)
1416 struct iwl3945_tx_cmd {
1419 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1420 * + 8 byte IV for CCM or TKIP (not used for WEP)
1422 * + 8-byte MIC (not used for CCM/WEP)
1423 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1424 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1425 * Range: 14-2342 bytes.
1430 * MPDU or MSDU byte count for next frame.
1431 * Used for fragmentation and bursting, but not 11n aggregation.
1432 * Same as "len", but for next frame. Set to 0 if not applicable.
1434 __le16 next_frame_len;
1436 __le32 tx_flags; /* TX_CMD_FLG_* */
1440 /* Index of recipient station in uCode's station table */
1450 __le32 next_frame_info;
1456 u8 rts_retry_limit; /*byte 50 */
1457 u8 data_retry_limit; /*byte 51 */
1459 __le16 pm_frame_timeout;
1460 __le16 attempt_duration;
1464 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1465 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1470 * MAC header goes here, followed by 2 bytes padding if MAC header
1471 * length is 26 or 30 bytes, followed by payload data
1474 struct ieee80211_hdr hdr[0];
1475 } __attribute__ ((packed));
1478 * REPLY_TX = 0x1c (response)
1480 struct iwl3945_tx_resp {
1485 __le32 wireless_media_time;
1486 __le32 status; /* TX status */
1487 } __attribute__ ((packed));
1491 * 4965 uCode updates these Tx attempt count values in host DRAM.
1492 * Used for managing Tx retries when expecting block-acks.
1493 * Driver should set these fields to 0.
1495 struct iwl_dram_scratch {
1496 u8 try_cnt; /* Tx attempts */
1497 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1499 } __attribute__ ((packed));
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)
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.
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.
1519 __le16 next_frame_len;
1521 __le32 tx_flags; /* TX_CMD_FLG_* */
1523 /* uCode may modify this field of the Tx command (in host DRAM!).
1524 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1525 struct iwl_dram_scratch scratch;
1527 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1528 __le32 rate_n_flags; /* RATE_MCS_* */
1530 /* Index of destination station in uCode's station table */
1533 /* Type of security encryption: CCM or TKIP */
1534 u8 sec_ctl; /* TX_CMD_SEC_* */
1537 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1538 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1539 * data frames, this field may be used to selectively reduce initial
1540 * rate (via non-0 value) for special frames (e.g. management), while
1541 * still supporting rate scaling for all frames.
1543 u8 initial_rate_index;
1546 __le16 next_frame_flags;
1553 /* Host DRAM physical address pointer to "scratch" in this command.
1554 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1555 __le32 dram_lsb_ptr;
1558 u8 rts_retry_limit; /*byte 50 */
1559 u8 data_retry_limit; /*byte 51 */
1562 __le16 pm_frame_timeout;
1563 __le16 attempt_duration;
1567 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1568 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1573 * MAC header goes here, followed by 2 bytes padding if MAC header
1574 * length is 26 or 30 bytes, followed by payload data
1577 struct ieee80211_hdr hdr[0];
1578 } __attribute__ ((packed));
1580 /* TX command response is sent after *all* transmission attempts.
1584 * TX_STATUS_FAIL_NEXT_FRAG
1586 * If the fragment flag in the MAC header for the frame being transmitted
1587 * is set and there is insufficient time to transmit the next frame, the
1588 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1590 * TX_STATUS_FIFO_UNDERRUN
1592 * Indicates the host did not provide bytes to the FIFO fast enough while
1593 * a TX was in progress.
1595 * TX_STATUS_FAIL_MGMNT_ABORT
1597 * This status is only possible if the ABORT ON MGMT RX parameter was
1598 * set to true with the TX command.
1600 * If the MSB of the status parameter is set then an abort sequence is
1601 * required. This sequence consists of the host activating the TX Abort
1602 * control line, and then waiting for the TX Abort command response. This
1603 * indicates that a the device is no longer in a transmit state, and that the
1604 * command FIFO has been cleared. The host must then deactivate the TX Abort
1605 * control line. Receiving is still allowed in this case.
1608 TX_STATUS_SUCCESS = 0x01,
1609 TX_STATUS_DIRECT_DONE = 0x02,
1610 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1611 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1612 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1613 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1614 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1615 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1616 TX_STATUS_FAIL_DEST_PS = 0x88,
1617 TX_STATUS_FAIL_ABORTED = 0x89,
1618 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1619 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1620 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1621 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1622 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1623 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1624 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1625 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1628 #define TX_PACKET_MODE_REGULAR 0x0000
1629 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1630 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1633 TX_POWER_PA_NOT_ACTIVE = 0x0,
1637 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1638 TX_STATUS_DELAY_MSK = 0x00000040,
1639 TX_STATUS_ABORT_MSK = 0x00000080,
1640 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1641 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1642 TX_RESERVED = 0x00780000, /* bits 19:22 */
1643 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1644 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1647 static inline bool iwl_is_tx_success(u32 status)
1649 status &= TX_STATUS_MSK;
1650 return (status == TX_STATUS_SUCCESS) ||
1651 (status == TX_STATUS_DIRECT_DONE);
1656 /* *******************************
1657 * TX aggregation status
1658 ******************************* */
1661 AGG_TX_STATE_TRANSMITTED = 0x00,
1662 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1663 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1664 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1665 AGG_TX_STATE_ABORT_MSK = 0x08,
1666 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1667 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1668 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1669 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1670 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1671 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1672 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1673 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1676 #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1677 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1678 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1680 /* # tx attempts for first frame in aggregation */
1681 #define AGG_TX_STATE_TRY_CNT_POS 12
1682 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1684 /* Command ID and sequence number of Tx command for this frame */
1685 #define AGG_TX_STATE_SEQ_NUM_POS 16
1686 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1689 * REPLY_TX = 0x1c (response)
1691 * This response may be in one of two slightly different formats, indicated
1692 * by the frame_count field:
1694 * 1) No aggregation (frame_count == 1). This reports Tx results for
1695 * a single frame. Multiple attempts, at various bit rates, may have
1696 * been made for this frame.
1698 * 2) Aggregation (frame_count > 1). This reports Tx results for
1699 * 2 or more frames that used block-acknowledge. All frames were
1700 * transmitted at same rate. Rate scaling may have been used if first
1701 * frame in this new agg block failed in previous agg block(s).
1703 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1704 * block-ack has not been received by the time the 4965 records this status.
1705 * This status relates to reasons the tx might have been blocked or aborted
1706 * within the sending station (this 4965), rather than whether it was
1707 * received successfully by the destination station.
1709 struct agg_tx_status {
1712 } __attribute__ ((packed));
1714 struct iwl4965_tx_resp {
1715 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1716 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1717 u8 failure_rts; /* # failures due to unsuccessful RTS */
1718 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1720 /* For non-agg: Rate at which frame was successful.
1721 * For agg: Rate at which all frames were transmitted. */
1722 __le32 rate_n_flags; /* RATE_MCS_* */
1724 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1725 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1726 __le16 wireless_media_time; /* uSecs */
1729 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1733 * For non-agg: frame status TX_STATUS_*
1734 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1735 * fields follow this one, up to frame_count.
1737 * 11- 0: AGG_TX_STATE_* status code
1738 * 15-12: Retry count for 1st frame in aggregation (retries
1739 * occur if tx failed for this frame when it was a
1740 * member of a previous aggregation block). If rate
1741 * scaling is used, retry count indicates the rate
1742 * table entry used for all frames in the new agg.
1743 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1747 struct agg_tx_status agg_status[0]; /* for each agg frame */
1749 } __attribute__ ((packed));
1752 * definitions for initial rate index field
1753 * bits [3:0] initial rate index
1754 * bits [6:4] rate table color, used for the initial rate
1755 * bit-7 invalid rate indication
1756 * i.e. rate was not chosen from rate table
1757 * or rate table color was changed during frame retries
1758 * refer tlc rate info
1761 #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1762 #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1763 #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1764 #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1765 #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1767 /* refer to ra_tid */
1768 #define IWL50_TX_RES_TID_POS 0
1769 #define IWL50_TX_RES_TID_MSK 0x0f
1770 #define IWL50_TX_RES_RA_POS 4
1771 #define IWL50_TX_RES_RA_MSK 0xf0
1773 struct iwl5000_tx_resp {
1774 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1775 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1776 u8 failure_rts; /* # failures due to unsuccessful RTS */
1777 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1779 /* For non-agg: Rate at which frame was successful.
1780 * For agg: Rate at which all frames were transmitted. */
1781 __le32 rate_n_flags; /* RATE_MCS_* */
1783 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1784 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1785 __le16 wireless_media_time; /* uSecs */
1787 u8 pa_status; /* RF power amplifier measurement (not used) */
1788 u8 pa_integ_res_a[3];
1789 u8 pa_integ_res_b[3];
1790 u8 pa_integ_res_C[3];
1796 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1799 * For non-agg: frame status TX_STATUS_*
1800 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1801 * fields follow this one, up to frame_count.
1803 * 11- 0: AGG_TX_STATE_* status code
1804 * 15-12: Retry count for 1st frame in aggregation (retries
1805 * occur if tx failed for this frame when it was a
1806 * member of a previous aggregation block). If rate
1807 * scaling is used, retry count indicates the rate
1808 * table entry used for all frames in the new agg.
1809 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1811 struct agg_tx_status status; /* TX status (in aggregation -
1812 * status of 1st frame) */
1813 } __attribute__ ((packed));
1815 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1817 * Reports Block-Acknowledge from recipient station
1819 struct iwl_compressed_ba_resp {
1820 __le32 sta_addr_lo32;
1821 __le16 sta_addr_hi16;
1824 /* Index of recipient (BA-sending) station in uCode's station table */
1831 } __attribute__ ((packed));
1834 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1836 * See details under "TXPOWER" in iwl-4965-hw.h.
1839 struct iwl3945_txpowertable_cmd {
1840 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1843 struct iwl3945_power_per_rate power[IWL_MAX_RATES];
1844 } __attribute__ ((packed));
1846 struct iwl4965_txpowertable_cmd {
1847 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1850 struct iwl4965_tx_power_db tx_power;
1851 } __attribute__ ((packed));
1855 * struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response
1857 * REPLY_RATE_SCALE = 0x47 (command, has simple generic response)
1859 * NOTE: The table of rates passed to the uCode via the
1860 * RATE_SCALE command sets up the corresponding order of
1861 * rates used for all related commands, including rate
1864 * For example, if you set 9MB (PLCP 0x0f) as the first
1865 * rate in the rate table, the bit mask for that rate
1866 * when passed through ofdm_basic_rates on the REPLY_RXON
1867 * command would be bit 0 (1 << 0)
1869 struct iwl3945_rate_scaling_info {
1870 __le16 rate_n_flags;
1873 } __attribute__ ((packed));
1875 struct iwl3945_rate_scaling_cmd {
1878 struct iwl3945_rate_scaling_info table[IWL_MAX_RATES];
1879 } __attribute__ ((packed));
1882 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1883 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1885 /* # of EDCA prioritized tx fifos */
1886 #define LINK_QUAL_AC_NUM AC_NUM
1888 /* # entries in rate scale table to support Tx retries */
1889 #define LINK_QUAL_MAX_RETRY_NUM 16
1891 /* Tx antenna selection values */
1892 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1893 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1894 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1898 * struct iwl_link_qual_general_params
1900 * Used in REPLY_TX_LINK_QUALITY_CMD
1902 struct iwl_link_qual_general_params {
1905 /* No entries at or above this (driver chosen) index contain MIMO */
1908 /* Best single antenna to use for single stream (legacy, SISO). */
1909 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1911 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1912 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1915 * If driver needs to use different initial rates for different
1916 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1917 * this table will set that up, by indicating the indexes in the
1918 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1919 * Otherwise, driver should set all entries to 0.
1922 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1923 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1925 u8 start_rate_index[LINK_QUAL_AC_NUM];
1926 } __attribute__ ((packed));
1928 #define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
1929 #define LINK_QUAL_AGG_TIME_LIMIT_MAX (65535)
1930 #define LINK_QUAL_AGG_TIME_LIMIT_MIN (0)
1932 #define LINK_QUAL_AGG_DISABLE_START_DEF (3)
1933 #define LINK_QUAL_AGG_DISABLE_START_MAX (255)
1934 #define LINK_QUAL_AGG_DISABLE_START_MIN (0)
1936 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31)
1937 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
1938 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
1941 * struct iwl_link_qual_agg_params
1943 * Used in REPLY_TX_LINK_QUALITY_CMD
1945 struct iwl_link_qual_agg_params {
1947 /* Maximum number of uSec in aggregation.
1948 * Driver should set this to 4000 (4 milliseconds). */
1949 __le16 agg_time_limit;
1952 * Number of Tx retries allowed for a frame, before that frame will
1953 * no longer be considered for the start of an aggregation sequence
1954 * (scheduler will then try to tx it as single frame).
1955 * Driver should set this to 3.
1957 u8 agg_dis_start_th;
1960 * Maximum number of frames in aggregation.
1961 * 0 = no limit (default). 1 = no aggregation.
1962 * Other values = max # frames in aggregation.
1964 u8 agg_frame_cnt_limit;
1967 } __attribute__ ((packed));
1970 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1972 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1974 * Each station in the 4965's internal station table has its own table of 16
1975 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1976 * an ACK is not received. This command replaces the entire table for
1979 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1981 * The rate scaling procedures described below work well. Of course, other
1982 * procedures are possible, and may work better for particular environments.
1985 * FILLING THE RATE TABLE
1987 * Given a particular initial rate and mode, as determined by the rate
1988 * scaling algorithm described below, the Linux driver uses the following
1989 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1990 * Link Quality command:
1993 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1994 * a) Use this same initial rate for first 3 entries.
1995 * b) Find next lower available rate using same mode (SISO or MIMO),
1996 * use for next 3 entries. If no lower rate available, switch to
1997 * legacy mode (no HT40 channel, no MIMO, no short guard interval).
1998 * c) If using MIMO, set command's mimo_delimiter to number of entries
1999 * using MIMO (3 or 6).
2000 * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
2001 * no MIMO, no short guard interval), at the next lower bit rate
2002 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
2003 * legacy procedure for remaining table entries.
2005 * 2) If using legacy initial rate:
2006 * a) Use the initial rate for only one entry.
2007 * b) For each following entry, reduce the rate to next lower available
2008 * rate, until reaching the lowest available rate.
2009 * c) When reducing rate, also switch antenna selection.
2010 * d) Once lowest available rate is reached, repeat this rate until
2011 * rate table is filled (16 entries), switching antenna each entry.
2014 * ACCUMULATING HISTORY
2016 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
2017 * two sets of frame Tx success history: One for the current/active modulation
2018 * mode, and one for a speculative/search mode that is being attempted. If the
2019 * speculative mode turns out to be more effective (i.e. actual transfer
2020 * rate is better), then the driver continues to use the speculative mode
2021 * as the new current active mode.
2023 * Each history set contains, separately for each possible rate, data for a
2024 * sliding window of the 62 most recent tx attempts at that rate. The data
2025 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
2026 * and attempted frames, from which the driver can additionally calculate a
2027 * success ratio (success / attempted) and number of failures
2028 * (attempted - success), and control the size of the window (attempted).
2029 * The driver uses the bit map to remove successes from the success sum, as
2030 * the oldest tx attempts fall out of the window.
2032 * When the 4965 makes multiple tx attempts for a given frame, each attempt
2033 * might be at a different rate, and have different modulation characteristics
2034 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
2035 * scaling table in the Link Quality command. The driver must determine
2036 * which rate table entry was used for each tx attempt, to determine which
2037 * rate-specific history to update, and record only those attempts that
2038 * match the modulation characteristics of the history set.
2040 * When using block-ack (aggregation), all frames are transmitted at the same
2041 * rate, since there is no per-attempt acknowledgment from the destination
2042 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
2043 * rate_n_flags field. After receiving a block-ack, the driver can update
2044 * history for the entire block all at once.
2047 * FINDING BEST STARTING RATE:
2049 * When working with a selected initial modulation mode (see below), the
2050 * driver attempts to find a best initial rate. The initial rate is the
2051 * first entry in the Link Quality command's rate table.
2053 * 1) Calculate actual throughput (success ratio * expected throughput, see
2054 * table below) for current initial rate. Do this only if enough frames
2055 * have been attempted to make the value meaningful: at least 6 failed
2056 * tx attempts, or at least 8 successes. If not enough, don't try rate
2059 * 2) Find available rates adjacent to current initial rate. Available means:
2060 * a) supported by hardware &&
2061 * b) supported by association &&
2062 * c) within any constraints selected by user
2064 * 3) Gather measured throughputs for adjacent rates. These might not have
2065 * enough history to calculate a throughput. That's okay, we might try
2066 * using one of them anyway!
2068 * 4) Try decreasing rate if, for current rate:
2069 * a) success ratio is < 15% ||
2070 * b) lower adjacent rate has better measured throughput ||
2071 * c) higher adjacent rate has worse throughput, and lower is unmeasured
2073 * As a sanity check, if decrease was determined above, leave rate
2075 * a) lower rate unavailable
2076 * b) success ratio at current rate > 85% (very good)
2077 * c) current measured throughput is better than expected throughput
2078 * of lower rate (under perfect 100% tx conditions, see table below)
2080 * 5) Try increasing rate if, for current rate:
2081 * a) success ratio is < 15% ||
2082 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
2083 * b) higher adjacent rate has better measured throughput ||
2084 * c) lower adjacent rate has worse throughput, and higher is unmeasured
2086 * As a sanity check, if increase was determined above, leave rate
2088 * a) success ratio at current rate < 70%. This is not particularly
2089 * good performance; higher rate is sure to have poorer success.
2091 * 6) Re-evaluate the rate after each tx frame. If working with block-
2092 * acknowledge, history and statistics may be calculated for the entire
2093 * block (including prior history that fits within the history windows),
2094 * before re-evaluation.
2096 * FINDING BEST STARTING MODULATION MODE:
2098 * After working with a modulation mode for a "while" (and doing rate scaling),
2099 * the driver searches for a new initial mode in an attempt to improve
2100 * throughput. The "while" is measured by numbers of attempted frames:
2102 * For legacy mode, search for new mode after:
2103 * 480 successful frames, or 160 failed frames
2104 * For high-throughput modes (SISO or MIMO), search for new mode after:
2105 * 4500 successful frames, or 400 failed frames
2107 * Mode switch possibilities are (3 for each mode):
2110 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
2112 * Change antenna, try MIMO, try shortened guard interval (SGI)
2114 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
2116 * When trying a new mode, use the same bit rate as the old/current mode when
2117 * trying antenna switches and shortened guard interval. When switching to
2118 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
2119 * for which the expected throughput (under perfect conditions) is about the
2120 * same or slightly better than the actual measured throughput delivered by
2121 * the old/current mode.
2123 * Actual throughput can be estimated by multiplying the expected throughput
2124 * by the success ratio (successful / attempted tx frames). Frame size is
2125 * not considered in this calculation; it assumes that frame size will average
2126 * out to be fairly consistent over several samples. The following are
2127 * metric values for expected throughput assuming 100% success ratio.
2128 * Only G band has support for CCK rates:
2130 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
2132 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
2133 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
2134 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
2135 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
2136 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
2137 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
2138 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
2139 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
2140 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
2141 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
2143 * After the new mode has been tried for a short while (minimum of 6 failed
2144 * frames or 8 successful frames), compare success ratio and actual throughput
2145 * estimate of the new mode with the old. If either is better with the new
2146 * mode, continue to use the new mode.
2148 * Continue comparing modes until all 3 possibilities have been tried.
2149 * If moving from legacy to HT, try all 3 possibilities from the new HT
2150 * mode. After trying all 3, a best mode is found. Continue to use this mode
2151 * for the longer "while" described above (e.g. 480 successful frames for
2152 * legacy), and then repeat the search process.
2155 struct iwl_link_quality_cmd {
2157 /* Index of destination/recipient station in uCode's station table */
2160 __le16 control; /* not used */
2161 struct iwl_link_qual_general_params general_params;
2162 struct iwl_link_qual_agg_params agg_params;
2165 * Rate info; when using rate-scaling, Tx command's initial_rate_index
2166 * specifies 1st Tx rate attempted, via index into this table.
2167 * 4965 works its way through table when retrying Tx.
2170 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
2171 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
2173 } __attribute__ ((packed));
2176 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
2178 * 3945 and 4965 support hardware handshake with Bluetooth device on
2179 * same platform. Bluetooth device alerts wireless device when it will Tx;
2180 * wireless device can delay or kill its own Tx to accommodate.
2187 __le32 kill_ack_mask;
2188 __le32 kill_cts_mask;
2189 } __attribute__ ((packed));
2191 /******************************************************************************
2193 * Spectrum Management (802.11h) Commands, Responses, Notifications:
2195 *****************************************************************************/
2198 * Spectrum Management
2200 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
2201 RXON_FILTER_CTL2HOST_MSK | \
2202 RXON_FILTER_ACCEPT_GRP_MSK | \
2203 RXON_FILTER_DIS_DECRYPT_MSK | \
2204 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
2205 RXON_FILTER_ASSOC_MSK | \
2206 RXON_FILTER_BCON_AWARE_MSK)
2208 struct iwl_measure_channel {
2209 __le32 duration; /* measurement duration in extended beacon
2211 u8 channel; /* channel to measure */
2212 u8 type; /* see enum iwl_measure_type */
2214 } __attribute__ ((packed));
2217 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
2219 struct iwl_spectrum_cmd {
2220 __le16 len; /* number of bytes starting from token */
2221 u8 token; /* token id */
2222 u8 id; /* measurement id -- 0 or 1 */
2223 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
2224 u8 periodic; /* 1 = periodic */
2225 __le16 path_loss_timeout;
2226 __le32 start_time; /* start time in extended beacon format */
2228 __le32 flags; /* rxon flags */
2229 __le32 filter_flags; /* rxon filter flags */
2230 __le16 channel_count; /* minimum 1, maximum 10 */
2232 struct iwl_measure_channel channels[10];
2233 } __attribute__ ((packed));
2236 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
2238 struct iwl_spectrum_resp {
2240 u8 id; /* id of the prior command replaced, or 0xff */
2241 __le16 status; /* 0 - command will be handled
2242 * 1 - cannot handle (conflicts with another
2244 } __attribute__ ((packed));
2246 enum iwl_measurement_state {
2247 IWL_MEASUREMENT_START = 0,
2248 IWL_MEASUREMENT_STOP = 1,
2251 enum iwl_measurement_status {
2252 IWL_MEASUREMENT_OK = 0,
2253 IWL_MEASUREMENT_CONCURRENT = 1,
2254 IWL_MEASUREMENT_CSA_CONFLICT = 2,
2255 IWL_MEASUREMENT_TGH_CONFLICT = 3,
2257 IWL_MEASUREMENT_STOPPED = 6,
2258 IWL_MEASUREMENT_TIMEOUT = 7,
2259 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
2262 #define NUM_ELEMENTS_IN_HISTOGRAM 8
2264 struct iwl_measurement_histogram {
2265 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
2266 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
2267 } __attribute__ ((packed));
2269 /* clear channel availability counters */
2270 struct iwl_measurement_cca_counters {
2273 } __attribute__ ((packed));
2275 enum iwl_measure_type {
2276 IWL_MEASURE_BASIC = (1 << 0),
2277 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
2278 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
2279 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
2280 IWL_MEASURE_FRAME = (1 << 4),
2281 /* bits 5:6 are reserved */
2282 IWL_MEASURE_IDLE = (1 << 7),
2286 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
2288 struct iwl_spectrum_notification {
2289 u8 id; /* measurement id -- 0 or 1 */
2291 u8 channel_index; /* index in measurement channel list */
2292 u8 state; /* 0 - start, 1 - stop */
2293 __le32 start_time; /* lower 32-bits of TSF */
2294 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
2296 u8 type; /* see enum iwl_measurement_type */
2298 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2299 * valid if applicable for measurement type requested. */
2300 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2301 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2302 __le32 cca_time; /* channel load time in usecs */
2303 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2306 struct iwl_measurement_histogram histogram;
2307 __le32 stop_time; /* lower 32-bits of TSF */
2308 __le32 status; /* see iwl_measurement_status */
2309 } __attribute__ ((packed));
2311 /******************************************************************************
2313 * Power Management Commands, Responses, Notifications:
2315 *****************************************************************************/
2318 * struct iwl_powertable_cmd - Power Table Command
2319 * @flags: See below:
2321 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2324 * bit 0 - '0' Driver not allow power management
2325 * '1' Driver allow PM (use rest of parameters)
2327 * uCode send sleep notifications:
2328 * bit 1 - '0' Don't send sleep notification
2329 * '1' send sleep notification (SEND_PM_NOTIFICATION)
2332 * bit 2 - '0' PM have to walk up every DTIM
2333 * '1' PM could sleep over DTIM till listen Interval.
2336 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2337 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
2340 * bit 4 - '1' Put radio to sleep when receiving frame for others
2343 * bit 31/30- '00' use both mac/xtal sleeps
2344 * '01' force Mac sleep
2345 * '10' force xtal sleep
2348 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2349 * ucode assume sleep over DTIM is allowed and we don't need to wake up
2352 #define IWL_POWER_VEC_SIZE 5
2354 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
2355 #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2356 #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2357 #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
2359 struct iwl3945_powertable_cmd {
2362 __le32 rx_data_timeout;
2363 __le32 tx_data_timeout;
2364 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2365 } __attribute__ ((packed));
2367 struct iwl_powertable_cmd {
2369 u8 keep_alive_seconds; /* 3945 reserved */
2370 u8 debug_flags; /* 3945 reserved */
2371 __le32 rx_data_timeout;
2372 __le32 tx_data_timeout;
2373 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2374 __le32 keep_alive_beacons;
2375 } __attribute__ ((packed));
2378 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2379 * 3945 and 4965 identical.
2381 struct iwl_sleep_notification {
2388 } __attribute__ ((packed));
2390 /* Sleep states. 3945 and 4965 identical. */
2392 IWL_PM_NO_SLEEP = 0,
2394 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2395 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2397 IWL_PM_SLP_REPENT = 5,
2398 IWL_PM_WAKEUP_BY_TIMER = 6,
2399 IWL_PM_WAKEUP_BY_DRIVER = 7,
2400 IWL_PM_WAKEUP_BY_RFKILL = 8,
2402 IWL_PM_NUM_OF_MODES = 12,
2406 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2408 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2409 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2410 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
2411 struct iwl_card_state_cmd {
2412 __le32 status; /* CARD_STATE_CMD_* request new power state */
2413 } __attribute__ ((packed));
2416 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2418 struct iwl_card_state_notif {
2420 } __attribute__ ((packed));
2422 #define HW_CARD_DISABLED 0x01
2423 #define SW_CARD_DISABLED 0x02
2424 #define RF_CARD_DISABLED 0x04
2425 #define RXON_CARD_DISABLED 0x10
2427 struct iwl_ct_kill_config {
2429 __le32 critical_temperature_M;
2430 __le32 critical_temperature_R;
2431 } __attribute__ ((packed));
2433 /* 1000, and 6x00 */
2434 struct iwl_ct_kill_throttling_config {
2435 __le32 critical_temperature_exit;
2437 __le32 critical_temperature_enter;
2438 } __attribute__ ((packed));
2440 /******************************************************************************
2442 * Scan Commands, Responses, Notifications:
2444 *****************************************************************************/
2446 #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2447 #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
2450 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2452 * One for each channel in the scan list.
2453 * Each channel can independently select:
2454 * 1) SSID for directed active scans
2455 * 2) Txpower setting (for rate specified within Tx command)
2456 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2457 * quiet_plcp_th, good_CRC_th)
2459 * To avoid uCode errors, make sure the following are true (see comments
2460 * under struct iwl_scan_cmd about max_out_time and quiet_time):
2461 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2462 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2463 * 2) quiet_time <= active_dwell
2464 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2465 * passive_dwell < max_out_time
2466 * active_dwell < max_out_time
2469 /* FIXME: rename to AP1, remove tpc */
2470 struct iwl3945_scan_channel {
2472 * type is defined as:
2473 * 0:0 1 = active, 0 = passive
2474 * 1:4 SSID direct bit map; if a bit is set, then corresponding
2475 * SSID IE is transmitted in probe request.
2479 u8 channel; /* band is selected by iwl3945_scan_cmd "flags" field */
2480 struct iwl3945_tx_power tpc;
2481 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2482 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2483 } __attribute__ ((packed));
2485 /* set number of direct probes u8 type */
2486 #define IWL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))
2488 struct iwl_scan_channel {
2490 * type is defined as:
2491 * 0:0 1 = active, 0 = passive
2492 * 1:20 SSID direct bit map; if a bit is set, then corresponding
2493 * SSID IE is transmitted in probe request.
2497 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2498 u8 tx_gain; /* gain for analog radio */
2499 u8 dsp_atten; /* gain for DSP */
2500 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2501 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2502 } __attribute__ ((packed));
2504 /* set number of direct probes __le32 type */
2505 #define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2508 * struct iwl_ssid_ie - directed scan network information element
2510 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
2511 * in struct iwl_scan_channel; each channel may select different ssids from
2512 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
2514 struct iwl_ssid_ie {
2518 } __attribute__ ((packed));
2520 #define PROBE_OPTION_MAX_3945 4
2521 #define PROBE_OPTION_MAX 20
2522 #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
2523 #define IWL_GOOD_CRC_TH cpu_to_le16(1)
2524 #define IWL_MAX_SCAN_SIZE 1024
2525 #define IWL_MAX_PROBE_REQUEST 200
2528 * REPLY_SCAN_CMD = 0x80 (command)
2530 * The hardware scan command is very powerful; the driver can set it up to
2531 * maintain (relatively) normal network traffic while doing a scan in the
2532 * background. The max_out_time and suspend_time control the ratio of how
2533 * long the device stays on an associated network channel ("service channel")
2534 * vs. how long it's away from the service channel, i.e. tuned to other channels
2537 * max_out_time is the max time off-channel (in usec), and suspend_time
2538 * is how long (in "extended beacon" format) that the scan is "suspended"
2539 * after returning to the service channel. That is, suspend_time is the
2540 * time that we stay on the service channel, doing normal work, between
2541 * scan segments. The driver may set these parameters differently to support
2542 * scanning when associated vs. not associated, and light vs. heavy traffic
2543 * loads when associated.
2545 * After receiving this command, the device's scan engine does the following;
2547 * 1) Sends SCAN_START notification to driver
2548 * 2) Checks to see if it has time to do scan for one channel
2549 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2550 * to tell AP that we're going off-channel
2551 * 4) Tunes to first channel in scan list, does active or passive scan
2552 * 5) Sends SCAN_RESULT notification to driver
2553 * 6) Checks to see if it has time to do scan on *next* channel in list
2554 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2555 * before max_out_time expires
2556 * 8) Returns to service channel
2557 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2558 * 10) Stays on service channel until suspend_time expires
2559 * 11) Repeats entire process 2-10 until list is complete
2560 * 12) Sends SCAN_COMPLETE notification
2562 * For fast, efficient scans, the scan command also has support for staying on
2563 * a channel for just a short time, if doing active scanning and getting no
2564 * responses to the transmitted probe request. This time is controlled by
2565 * quiet_time, and the number of received packets below which a channel is
2566 * considered "quiet" is controlled by quiet_plcp_threshold.
2568 * For active scanning on channels that have regulatory restrictions against
2569 * blindly transmitting, the scan can listen before transmitting, to make sure
2570 * that there is already legitimate activity on the channel. If enough
2571 * packets are cleanly received on the channel (controlled by good_CRC_th,
2572 * typical value 1), the scan engine starts transmitting probe requests.
2574 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2576 * To avoid uCode errors, see timing restrictions described under
2577 * struct iwl_scan_channel.
2580 struct iwl3945_scan_cmd {
2583 u8 channel_count; /* # channels in channel list */
2584 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2585 * (only for active scan) */
2586 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2587 __le16 good_CRC_th; /* passive -> active promotion threshold */
2589 __le32 max_out_time; /* max usec to be away from associated (service)
2591 __le32 suspend_time; /* pause scan this long (in "extended beacon
2592 * format") when returning to service channel:
2593 * 3945; 31:24 # beacons, 19:0 additional usec,
2594 * 4965; 31:22 # beacons, 21:0 additional usec.
2596 __le32 flags; /* RXON_FLG_* */
2597 __le32 filter_flags; /* RXON_FILTER_* */
2599 /* For active scans (set to all-0s for passive scans).
2600 * Does not include payload. Must specify Tx rate; no rate scaling. */
2601 struct iwl3945_tx_cmd tx_cmd;
2603 /* For directed active scans (set to all-0s otherwise) */
2604 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX_3945];
2607 * Probe request frame, followed by channel list.
2609 * Size of probe request frame is specified by byte count in tx_cmd.
2610 * Channel list follows immediately after probe request frame.
2611 * Number of channels in list is specified by channel_count.
2612 * Each channel in list is of type:
2614 * struct iwl3945_scan_channel channels[0];
2616 * NOTE: Only one band of channels can be scanned per pass. You
2617 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2618 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2619 * before requesting another scan.
2622 } __attribute__ ((packed));
2624 struct iwl_scan_cmd {
2627 u8 channel_count; /* # channels in channel list */
2628 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2629 * (only for active scan) */
2630 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2631 __le16 good_CRC_th; /* passive -> active promotion threshold */
2632 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2633 __le32 max_out_time; /* max usec to be away from associated (service)
2635 __le32 suspend_time; /* pause scan this long (in "extended beacon
2636 * format") when returning to service chnl:
2637 * 3945; 31:24 # beacons, 19:0 additional usec,
2638 * 4965; 31:22 # beacons, 21:0 additional usec.
2640 __le32 flags; /* RXON_FLG_* */
2641 __le32 filter_flags; /* RXON_FILTER_* */
2643 /* For active scans (set to all-0s for passive scans).
2644 * Does not include payload. Must specify Tx rate; no rate scaling. */
2645 struct iwl_tx_cmd tx_cmd;
2647 /* For directed active scans (set to all-0s otherwise) */
2648 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2651 * Probe request frame, followed by channel list.
2653 * Size of probe request frame is specified by byte count in tx_cmd.
2654 * Channel list follows immediately after probe request frame.
2655 * Number of channels in list is specified by channel_count.
2656 * Each channel in list is of type:
2658 * struct iwl_scan_channel channels[0];
2660 * NOTE: Only one band of channels can be scanned per pass. You
2661 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2662 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2663 * before requesting another scan.
2666 } __attribute__ ((packed));
2668 /* Can abort will notify by complete notification with abort status. */
2669 #define CAN_ABORT_STATUS cpu_to_le32(0x1)
2670 /* complete notification statuses */
2671 #define ABORT_STATUS 0x2
2674 * REPLY_SCAN_CMD = 0x80 (response)
2676 struct iwl_scanreq_notification {
2677 __le32 status; /* 1: okay, 2: cannot fulfill request */
2678 } __attribute__ ((packed));
2681 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2683 struct iwl_scanstart_notification {
2686 __le32 beacon_timer;
2691 } __attribute__ ((packed));
2693 #define SCAN_OWNER_STATUS 0x1;
2694 #define MEASURE_OWNER_STATUS 0x2;
2696 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2698 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2700 struct iwl_scanresults_notification {
2706 __le32 statistics[NUMBER_OF_STATISTICS];
2707 } __attribute__ ((packed));
2710 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2712 struct iwl_scancomplete_notification {
2713 u8 scanned_channels;
2719 } __attribute__ ((packed));
2722 /******************************************************************************
2724 * IBSS/AP Commands and Notifications:
2726 *****************************************************************************/
2729 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2732 struct iwl3945_beacon_notif {
2733 struct iwl3945_tx_resp beacon_notify_hdr;
2736 __le32 ibss_mgr_status;
2737 } __attribute__ ((packed));
2739 struct iwl4965_beacon_notif {
2740 struct iwl4965_tx_resp beacon_notify_hdr;
2743 __le32 ibss_mgr_status;
2744 } __attribute__ ((packed));
2747 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2750 struct iwl3945_tx_beacon_cmd {
2751 struct iwl3945_tx_cmd tx;
2755 struct ieee80211_hdr frame[0]; /* beacon frame */
2756 } __attribute__ ((packed));
2758 struct iwl_tx_beacon_cmd {
2759 struct iwl_tx_cmd tx;
2763 struct ieee80211_hdr frame[0]; /* beacon frame */
2764 } __attribute__ ((packed));
2766 /******************************************************************************
2768 * Statistics Commands and Notifications:
2770 *****************************************************************************/
2772 #define IWL_TEMP_CONVERT 260
2774 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2775 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2776 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2778 /* Used for passing to driver number of successes and failures per rate */
2779 struct rate_histogram {
2781 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2782 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2783 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2786 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2787 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2788 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2790 } __attribute__ ((packed));
2792 /* statistics command response */
2794 struct iwl39_statistics_rx_phy {
2800 __le32 early_overrun_err;
2802 __le32 false_alarm_cnt;
2803 __le32 fina_sync_err_cnt;
2805 __le32 fina_timeout;
2806 __le32 unresponded_rts;
2807 __le32 rxe_frame_limit_overrun;
2808 __le32 sent_ack_cnt;
2809 __le32 sent_cts_cnt;
2810 } __attribute__ ((packed));
2812 struct iwl39_statistics_rx_non_phy {
2813 __le32 bogus_cts; /* CTS received when not expecting CTS */
2814 __le32 bogus_ack; /* ACK received when not expecting ACK */
2815 __le32 non_bssid_frames; /* number of frames with BSSID that
2816 * doesn't belong to the STA BSSID */
2817 __le32 filtered_frames; /* count frames that were dumped in the
2818 * filtering process */
2819 __le32 non_channel_beacons; /* beacons with our bss id but not on
2820 * our serving channel */
2821 } __attribute__ ((packed));
2823 struct iwl39_statistics_rx {
2824 struct iwl39_statistics_rx_phy ofdm;
2825 struct iwl39_statistics_rx_phy cck;
2826 struct iwl39_statistics_rx_non_phy general;
2827 } __attribute__ ((packed));
2829 struct iwl39_statistics_tx {
2830 __le32 preamble_cnt;
2831 __le32 rx_detected_cnt;
2832 __le32 bt_prio_defer_cnt;
2833 __le32 bt_prio_kill_cnt;
2834 __le32 few_bytes_cnt;
2837 __le32 expected_ack_cnt;
2838 __le32 actual_ack_cnt;
2839 } __attribute__ ((packed));
2841 struct statistics_dbg {
2845 } __attribute__ ((packed));
2847 struct iwl39_statistics_div {
2852 } __attribute__ ((packed));
2854 struct iwl39_statistics_general {
2856 struct statistics_dbg dbg;
2860 __le32 ttl_timestamp;
2861 struct iwl39_statistics_div div;
2862 } __attribute__ ((packed));
2864 struct statistics_rx_phy {
2870 __le32 early_overrun_err;
2872 __le32 false_alarm_cnt;
2873 __le32 fina_sync_err_cnt;
2875 __le32 fina_timeout;
2876 __le32 unresponded_rts;
2877 __le32 rxe_frame_limit_overrun;
2878 __le32 sent_ack_cnt;
2879 __le32 sent_cts_cnt;
2880 __le32 sent_ba_rsp_cnt;
2881 __le32 dsp_self_kill;
2882 __le32 mh_format_err;
2883 __le32 re_acq_main_rssi_sum;
2885 } __attribute__ ((packed));
2887 struct statistics_rx_ht_phy {
2890 __le32 early_overrun_err;
2893 __le32 mh_format_err;
2894 __le32 agg_crc32_good;
2895 __le32 agg_mpdu_cnt;
2898 } __attribute__ ((packed));
2900 #define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)
2902 struct statistics_rx_non_phy {
2903 __le32 bogus_cts; /* CTS received when not expecting CTS */
2904 __le32 bogus_ack; /* ACK received when not expecting ACK */
2905 __le32 non_bssid_frames; /* number of frames with BSSID that
2906 * doesn't belong to the STA BSSID */
2907 __le32 filtered_frames; /* count frames that were dumped in the
2908 * filtering process */
2909 __le32 non_channel_beacons; /* beacons with our bss id but not on
2910 * our serving channel */
2911 __le32 channel_beacons; /* beacons with our bss id and in our
2912 * serving channel */
2913 __le32 num_missed_bcon; /* number of missed beacons */
2914 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2915 * ADC was in saturation */
2916 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2918 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2919 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2920 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2921 __le32 interference_data_flag; /* flag for interference data
2922 * availability. 1 when data is
2924 __le32 channel_load; /* counts RX Enable time in uSec */
2925 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2926 * and CCK) counter */
2927 __le32 beacon_rssi_a;
2928 __le32 beacon_rssi_b;
2929 __le32 beacon_rssi_c;
2930 __le32 beacon_energy_a;
2931 __le32 beacon_energy_b;
2932 __le32 beacon_energy_c;
2933 } __attribute__ ((packed));
2935 struct statistics_rx {
2936 struct statistics_rx_phy ofdm;
2937 struct statistics_rx_phy cck;
2938 struct statistics_rx_non_phy general;
2939 struct statistics_rx_ht_phy ofdm_ht;
2940 } __attribute__ ((packed));
2943 * struct statistics_tx_power - current tx power
2945 * @ant_a: current tx power on chain a in 1/2 dB step
2946 * @ant_b: current tx power on chain b in 1/2 dB step
2947 * @ant_c: current tx power on chain c in 1/2 dB step
2949 struct statistics_tx_power {
2954 } __attribute__ ((packed));
2956 struct statistics_tx_non_phy_agg {
2958 __le32 ba_reschedule_frames;
2959 __le32 scd_query_agg_frame_cnt;
2960 __le32 scd_query_no_agg;
2961 __le32 scd_query_agg;
2962 __le32 scd_query_mismatch;
2963 __le32 frame_not_ready;
2965 __le32 bt_prio_kill;
2966 __le32 rx_ba_rsp_cnt;
2967 } __attribute__ ((packed));
2969 struct statistics_tx {
2970 __le32 preamble_cnt;
2971 __le32 rx_detected_cnt;
2972 __le32 bt_prio_defer_cnt;
2973 __le32 bt_prio_kill_cnt;
2974 __le32 few_bytes_cnt;
2977 __le32 expected_ack_cnt;
2978 __le32 actual_ack_cnt;
2979 __le32 dump_msdu_cnt;
2980 __le32 burst_abort_next_frame_mismatch_cnt;
2981 __le32 burst_abort_missing_next_frame_cnt;
2982 __le32 cts_timeout_collision;
2983 __le32 ack_or_ba_timeout_collision;
2984 struct statistics_tx_non_phy_agg agg;
2985 struct statistics_tx_power tx_power;
2987 } __attribute__ ((packed));
2990 struct statistics_div {
2997 } __attribute__ ((packed));
2999 struct statistics_general {
3001 __le32 temperature_m;
3002 struct statistics_dbg dbg;
3006 __le32 ttl_timestamp;
3007 struct statistics_div div;
3008 __le32 rx_enable_counter;
3012 } __attribute__ ((packed));
3015 * REPLY_STATISTICS_CMD = 0x9c,
3016 * 3945 and 4965 identical.
3018 * This command triggers an immediate response containing uCode statistics.
3019 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
3021 * If the CLEAR_STATS configuration flag is set, uCode will clear its
3022 * internal copy of the statistics (counters) after issuing the response.
3023 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
3025 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
3026 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
3027 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
3029 #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
3030 #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
3031 struct iwl_statistics_cmd {
3032 __le32 configuration_flags; /* IWL_STATS_CONF_* */
3033 } __attribute__ ((packed));
3036 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
3038 * By default, uCode issues this notification after receiving a beacon
3039 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
3040 * REPLY_STATISTICS_CMD 0x9c, above.
3042 * Statistics counters continue to increment beacon after beacon, but are
3043 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
3044 * 0x9c with CLEAR_STATS bit set (see above).
3046 * uCode also issues this notification during scans. uCode clears statistics
3047 * appropriately so that each notification contains statistics for only the
3048 * one channel that has just been scanned.
3050 #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
3051 #define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)
3053 struct iwl3945_notif_statistics {
3055 struct iwl39_statistics_rx rx;
3056 struct iwl39_statistics_tx tx;
3057 struct iwl39_statistics_general general;
3058 } __attribute__ ((packed));
3060 struct iwl_notif_statistics {
3062 struct statistics_rx rx;
3063 struct statistics_tx tx;
3064 struct statistics_general general;
3065 } __attribute__ ((packed));
3069 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
3071 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
3072 * then this notification will be sent. */
3073 #define CONSECUTIVE_MISSED_BCONS_TH 20
3075 struct iwl_missed_beacon_notif {
3076 __le32 consequtive_missed_beacons;
3077 __le32 total_missed_becons;
3078 __le32 num_expected_beacons;
3079 __le32 num_recvd_beacons;
3080 } __attribute__ ((packed));
3083 /******************************************************************************
3085 * Rx Calibration Commands:
3087 * With the uCode used for open source drivers, most Tx calibration (except
3088 * for Tx Power) and most Rx calibration is done by uCode during the
3089 * "initialize" phase of uCode boot. Driver must calibrate only:
3091 * 1) Tx power (depends on temperature), described elsewhere
3092 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
3093 * 3) Receiver sensitivity (to optimize signal detection)
3095 *****************************************************************************/
3098 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
3100 * This command sets up the Rx signal detector for a sensitivity level that
3101 * is high enough to lock onto all signals within the associated network,
3102 * but low enough to ignore signals that are below a certain threshold, so as
3103 * not to have too many "false alarms". False alarms are signals that the
3104 * Rx DSP tries to lock onto, but then discards after determining that they
3107 * The optimum number of false alarms is between 5 and 50 per 200 TUs
3108 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
3109 * time listening, not transmitting). Driver must adjust sensitivity so that
3110 * the ratio of actual false alarms to actual Rx time falls within this range.
3112 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
3113 * received beacon. These provide information to the driver to analyze the
3114 * sensitivity. Don't analyze statistics that come in from scanning, or any
3115 * other non-associated-network source. Pertinent statistics include:
3117 * From "general" statistics (struct statistics_rx_non_phy):
3119 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
3120 * Measure of energy of desired signal. Used for establishing a level
3121 * below which the device does not detect signals.
3123 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
3124 * Measure of background noise in silent period after beacon.
3127 * uSecs of actual Rx time during beacon period (varies according to
3128 * how much time was spent transmitting).
3130 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
3133 * Signal locks abandoned early (before phy-level header).
3136 * Signal locks abandoned late (during phy-level header).
3138 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
3139 * beacon to beacon, i.e. each value is an accumulation of all errors
3140 * before and including the latest beacon. Values will wrap around to 0
3141 * after counting up to 2^32 - 1. Driver must differentiate vs.
3142 * previous beacon's values to determine # false alarms in the current
3145 * Total number of false alarms = false_alarms + plcp_errs
3147 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
3148 * (notice that the start points for OFDM are at or close to settings for
3149 * maximum sensitivity):
3152 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
3153 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
3154 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
3155 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
3157 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
3158 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
3159 * by *adding* 1 to all 4 of the table entries above, up to the max for
3160 * each entry. Conversely, if false alarm rate is too low (less than 5
3161 * for each 204.8 msecs listening), *subtract* 1 from each entry to
3162 * increase sensitivity.
3164 * For CCK sensitivity, keep track of the following:
3166 * 1). 20-beacon history of maximum background noise, indicated by
3167 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
3168 * 3 receivers. For any given beacon, the "silence reference" is
3169 * the maximum of last 60 samples (20 beacons * 3 receivers).
3171 * 2). 10-beacon history of strongest signal level, as indicated
3172 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
3173 * i.e. the strength of the signal through the best receiver at the
3174 * moment. These measurements are "upside down", with lower values
3175 * for stronger signals, so max energy will be *minimum* value.
3177 * Then for any given beacon, the driver must determine the *weakest*
3178 * of the strongest signals; this is the minimum level that needs to be
3179 * successfully detected, when using the best receiver at the moment.
3180 * "Max cck energy" is the maximum (higher value means lower energy!)
3181 * of the last 10 minima. Once this is determined, driver must add
3182 * a little margin by adding "6" to it.
3184 * 3). Number of consecutive beacon periods with too few false alarms.
3185 * Reset this to 0 at the first beacon period that falls within the
3186 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
3188 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
3189 * (notice that the start points for CCK are at maximum sensitivity):
3192 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
3193 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
3194 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
3196 * If actual rate of CCK false alarms (+ plcp_errors) is too high
3197 * (greater than 50 for each 204.8 msecs listening), method for reducing
3200 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3203 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
3204 * sensitivity has been reduced a significant amount; bring it up to
3205 * a moderate 161. Otherwise, *add* 3, up to max 200.
3207 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
3208 * sensitivity has been reduced only a moderate or small amount;
3209 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
3210 * down to min 0. Otherwise (if gain has been significantly reduced),
3211 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
3213 * b) Save a snapshot of the "silence reference".
3215 * If actual rate of CCK false alarms (+ plcp_errors) is too low
3216 * (less than 5 for each 204.8 msecs listening), method for increasing
3217 * sensitivity is used only if:
3219 * 1a) Previous beacon did not have too many false alarms
3220 * 1b) AND difference between previous "silence reference" and current
3221 * "silence reference" (prev - current) is 2 or more,
3222 * OR 2) 100 or more consecutive beacon periods have had rate of
3223 * less than 5 false alarms per 204.8 milliseconds rx time.
3225 * Method for increasing sensitivity:
3227 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
3230 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3233 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
3235 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
3236 * (between 5 and 50 for each 204.8 msecs listening):
3238 * 1) Save a snapshot of the silence reference.
3240 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
3241 * give some extra margin to energy threshold by *subtracting* 8
3242 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
3244 * For all cases (too few, too many, good range), make sure that the CCK
3245 * detection threshold (energy) is below the energy level for robust
3246 * detection over the past 10 beacon periods, the "Max cck energy".
3247 * Lower values mean higher energy; this means making sure that the value
3248 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
3250 * Driver should set the following entries to fixed values:
3252 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
3253 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
3254 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
3255 * HD_OFDM_ENERGY_TH_IN_INDEX 62
3259 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
3261 #define HD_TABLE_SIZE (11) /* number of entries */
3262 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
3263 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
3264 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
3265 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
3266 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
3267 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
3268 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
3269 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
3270 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
3271 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
3272 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
3274 /* Control field in struct iwl_sensitivity_cmd */
3275 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
3276 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
3279 * struct iwl_sensitivity_cmd
3280 * @control: (1) updates working table, (0) updates default table
3281 * @table: energy threshold values, use HD_* as index into table
3283 * Always use "1" in "control" to update uCode's working table and DSP.
3285 struct iwl_sensitivity_cmd {
3286 __le16 control; /* always use "1" */
3287 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
3288 } __attribute__ ((packed));
3292 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
3294 * This command sets the relative gains of 4965's 3 radio receiver chains.
3296 * After the first association, driver should accumulate signal and noise
3297 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
3298 * beacons from the associated network (don't collect statistics that come
3299 * in from scanning, or any other non-network source).
3301 * DISCONNECTED ANTENNA:
3303 * Driver should determine which antennas are actually connected, by comparing
3304 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
3305 * following values over 20 beacons, one accumulator for each of the chains
3306 * a/b/c, from struct statistics_rx_non_phy:
3308 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
3310 * Find the strongest signal from among a/b/c. Compare the other two to the
3311 * strongest. If any signal is more than 15 dB (times 20, unless you
3312 * divide the accumulated values by 20) below the strongest, the driver
3313 * considers that antenna to be disconnected, and should not try to use that
3314 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
3315 * driver should declare the stronger one as connected, and attempt to use it
3316 * (A and B are the only 2 Tx chains!).
3321 * Driver should balance the 3 receivers (but just the ones that are connected
3322 * to antennas, see above) for gain, by comparing the average signal levels
3323 * detected during the silence after each beacon (background noise).
3324 * Accumulate (add) the following values over 20 beacons, one accumulator for
3325 * each of the chains a/b/c, from struct statistics_rx_non_phy:
3327 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
3329 * Find the weakest background noise level from among a/b/c. This Rx chain
3330 * will be the reference, with 0 gain adjustment. Attenuate other channels by
3331 * finding noise difference:
3333 * (accum_noise[i] - accum_noise[reference]) / 30
3335 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
3336 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
3337 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3338 * and set bit 2 to indicate "reduce gain". The value for the reference
3339 * (weakest) chain should be "0".
3341 * diff_gain_[abc] bit fields:
3342 * 2: (1) reduce gain, (0) increase gain
3343 * 1-0: amount of gain, units of 1.5 dB
3346 /* Phy calibration command for series */
3349 IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
3350 IWL_PHY_CALIBRATE_DC_CMD = 8,
3351 IWL_PHY_CALIBRATE_LO_CMD = 9,
3352 IWL_PHY_CALIBRATE_RX_BB_CMD = 10,
3353 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
3354 IWL_PHY_CALIBRATE_RX_IQ_CMD = 12,
3355 IWL_PHY_CALIBRATION_NOISE_CMD = 13,
3356 IWL_PHY_CALIBRATE_AGC_TABLE_CMD = 14,
3357 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
3358 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
3359 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
3360 IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
3361 IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19,
3365 #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
3367 struct iwl_calib_cfg_elmnt_s {
3373 } __attribute__ ((packed));
3375 struct iwl_calib_cfg_status_s {
3376 struct iwl_calib_cfg_elmnt_s once;
3377 struct iwl_calib_cfg_elmnt_s perd;
3379 } __attribute__ ((packed));
3381 struct iwl_calib_cfg_cmd {
3382 struct iwl_calib_cfg_status_s ucd_calib_cfg;
3383 struct iwl_calib_cfg_status_s drv_calib_cfg;
3385 } __attribute__ ((packed));
3387 struct iwl_calib_hdr {
3392 } __attribute__ ((packed));
3394 struct iwl_calib_cmd {
3395 struct iwl_calib_hdr hdr;
3397 } __attribute__ ((packed));
3399 /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
3400 struct iwl_calib_diff_gain_cmd {
3401 struct iwl_calib_hdr hdr;
3402 s8 diff_gain_a; /* see above */
3406 } __attribute__ ((packed));
3408 struct iwl_calib_xtal_freq_cmd {
3409 struct iwl_calib_hdr hdr;
3413 } __attribute__ ((packed));
3415 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
3416 struct iwl_calib_chain_noise_reset_cmd {
3417 struct iwl_calib_hdr hdr;
3421 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
3422 struct iwl_calib_chain_noise_gain_cmd {
3423 struct iwl_calib_hdr hdr;
3427 } __attribute__ ((packed));
3429 /******************************************************************************
3431 * Miscellaneous Commands:
3433 *****************************************************************************/
3436 * LEDs Command & Response
3437 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
3439 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
3440 * this command turns it on or off, or sets up a periodic blinking cycle.
3442 struct iwl_led_cmd {
3443 __le32 interval; /* "interval" in uSec */
3444 u8 id; /* 1: Activity, 2: Link, 3: Tech */
3445 u8 off; /* # intervals off while blinking;
3446 * "0", with >0 "on" value, turns LED on */
3447 u8 on; /* # intervals on while blinking;
3448 * "0", regardless of "off", turns LED off */
3450 } __attribute__ ((packed));
3453 * Coexistence WIFI/WIMAX Command
3454 * COEX_PRIORITY_TABLE_CMD = 0x5a
3458 COEX_UNASSOC_IDLE = 0,
3459 COEX_UNASSOC_MANUAL_SCAN = 1,
3460 COEX_UNASSOC_AUTO_SCAN = 2,
3461 COEX_CALIBRATION = 3,
3462 COEX_PERIODIC_CALIBRATION = 4,
3463 COEX_CONNECTION_ESTAB = 5,
3464 COEX_ASSOCIATED_IDLE = 6,
3465 COEX_ASSOC_MANUAL_SCAN = 7,
3466 COEX_ASSOC_AUTO_SCAN = 8,
3467 COEX_ASSOC_ACTIVE_LEVEL = 9,
3470 COEX_STAND_ALONE_DEBUG = 12,
3471 COEX_IPAN_ASSOC_LEVEL = 13,
3474 COEX_NUM_OF_EVENTS = 16
3477 struct iwl_wimax_coex_event_entry {
3482 } __attribute__ ((packed));
3484 /* COEX flag masks */
3486 /* Station table is valid */
3487 #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
3488 /* UnMask wake up src at unassociated sleep */
3489 #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
3490 /* UnMask wake up src at associated sleep */
3491 #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3492 /* Enable CoEx feature. */
3493 #define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3495 struct iwl_wimax_coex_cmd {
3498 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3499 } __attribute__ ((packed));
3501 /******************************************************************************
3503 * Union of all expected notifications/responses:
3505 *****************************************************************************/
3507 struct iwl_rx_packet {
3509 struct iwl_cmd_header hdr;
3511 struct iwl3945_rx_frame rx_frame;
3512 struct iwl3945_tx_resp tx_resp;
3513 struct iwl3945_beacon_notif beacon_status;
3515 struct iwl_alive_resp alive_frame;
3516 struct iwl_spectrum_notification spectrum_notif;
3517 struct iwl_csa_notification csa_notif;
3518 struct iwl_error_resp err_resp;
3519 struct iwl_card_state_notif card_state_notif;
3520 struct iwl_add_sta_resp add_sta;
3521 struct iwl_rem_sta_resp rem_sta;
3522 struct iwl_sleep_notification sleep_notif;
3523 struct iwl_spectrum_resp spectrum;
3524 struct iwl_notif_statistics stats;
3525 struct iwl_compressed_ba_resp compressed_ba;
3526 struct iwl_missed_beacon_notif missed_beacon;
3530 } __attribute__ ((packed));
3532 int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
3534 #endif /* __iwl_commands_h__ */