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 - 2008 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 - 2008 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__
72 /* uCode version contains 4 values: Major/Minor/API/Serial */
73 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
74 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
75 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
76 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
82 /* RXON and QOS commands */
84 REPLY_RXON_ASSOC = 0x11,
85 REPLY_QOS_PARAM = 0x13,
86 REPLY_RXON_TIMING = 0x14,
88 /* Multi-Station support */
90 REPLY_REMOVE_STA = 0x19, /* not used */
91 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
97 REPLY_3945_RX = 0x1b, /* 3945 only */
99 REPLY_RATE_SCALE = 0x47, /* 3945 only */
100 REPLY_LEDS_CMD = 0x48,
101 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
103 /* WiMAX coexistence */
104 COEX_PRIORITY_TABLE_CMD = 0x5a, /*5000 only */
105 COEX_MEDIUM_NOTIFICATION = 0x5b,
106 COEX_EVENT_CMD = 0x5c,
109 CALIBRATION_CFG_CMD = 0x65,
110 CALIBRATION_RES_NOTIFICATION = 0x66,
111 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
113 /* 802.11h related */
114 RADAR_NOTIFICATION = 0x70, /* not used */
115 REPLY_QUIET_CMD = 0x71, /* not used */
116 REPLY_CHANNEL_SWITCH = 0x72,
117 CHANNEL_SWITCH_NOTIFICATION = 0x73,
118 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
119 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
121 /* Power Management */
122 POWER_TABLE_CMD = 0x77,
123 PM_SLEEP_NOTIFICATION = 0x7A,
124 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
126 /* Scan commands and notifications */
127 REPLY_SCAN_CMD = 0x80,
128 REPLY_SCAN_ABORT_CMD = 0x81,
129 SCAN_START_NOTIFICATION = 0x82,
130 SCAN_RESULTS_NOTIFICATION = 0x83,
131 SCAN_COMPLETE_NOTIFICATION = 0x84,
133 /* IBSS/AP commands */
134 BEACON_NOTIFICATION = 0x90,
135 REPLY_TX_BEACON = 0x91,
136 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
138 /* Miscellaneous commands */
139 QUIET_NOTIFICATION = 0x96, /* not used */
140 REPLY_TX_PWR_TABLE_CMD = 0x97,
141 REPLY_TX_POWER_DBM_CMD = 0x98,
142 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
144 /* Bluetooth device coexistence config command */
145 REPLY_BT_CONFIG = 0x9b,
148 REPLY_STATISTICS_CMD = 0x9c,
149 STATISTICS_NOTIFICATION = 0x9d,
151 /* RF-KILL commands and notifications */
152 REPLY_CARD_STATE_CMD = 0xa0,
153 CARD_STATE_NOTIFICATION = 0xa1,
155 /* Missed beacons notification */
156 MISSED_BEACONS_NOTIFICATION = 0xa2,
158 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
159 SENSITIVITY_CMD = 0xa8,
160 REPLY_PHY_CALIBRATION_CMD = 0xb0,
161 REPLY_RX_PHY_CMD = 0xc0,
162 REPLY_RX_MPDU_CMD = 0xc1,
164 REPLY_COMPRESSED_BA = 0xc5,
168 /******************************************************************************
170 * Commonly used structures and definitions:
171 * Command header, rate_n_flags, txpower
173 *****************************************************************************/
175 /* iwl_cmd_header flags value */
176 #define IWL_CMD_FAILED_MSK 0x40
178 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
179 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
180 #define SEQ_TO_INDEX(s) ((s) & 0xff)
181 #define INDEX_TO_SEQ(i) ((i) & 0xff)
182 #define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
183 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
186 * struct iwl_cmd_header
188 * This header format appears in the beginning of each command sent from the
189 * driver, and each response/notification received from uCode.
191 struct iwl_cmd_header {
192 u8 cmd; /* Command ID: REPLY_RXON, etc. */
193 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
195 * The driver sets up the sequence number to values of its choosing.
196 * uCode does not use this value, but passes it back to the driver
197 * when sending the response to each driver-originated command, so
198 * the driver can match the response to the command. Since the values
199 * don't get used by uCode, the driver may set up an arbitrary format.
201 * There is one exception: uCode sets bit 15 when it originates
202 * the response/notification, i.e. when the response/notification
203 * is not a direct response to a command sent by the driver. For
204 * example, uCode issues REPLY_3945_RX when it sends a received frame
205 * to the driver; it is not a direct response to any driver command.
207 * The Linux driver uses the following format:
209 * 0:7 tfd index - position within TX queue
212 * 14 huge - driver sets this to indicate command is in the
213 * 'huge' storage at the end of the command buffers
214 * 15 unsolicited RX or uCode-originated notification
218 /* command or response/notification data follows immediately */
220 } __attribute__ ((packed));
223 * iwlagn rate_n_flags bit fields
225 * rate_n_flags format is used in following iwlagn commands:
226 * REPLY_RX (response only)
227 * REPLY_RX_MPDU (response only)
228 * REPLY_TX (both command and response)
229 * REPLY_TX_LINK_QUALITY_CMD
231 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
241 * 4-3: 0) Single stream (SISO)
242 * 1) Dual stream (MIMO)
243 * 2) Triple stream (MIMO)
245 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
247 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
257 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
263 #define RATE_MCS_CODE_MSK 0x7
264 #define RATE_MCS_SPATIAL_POS 3
265 #define RATE_MCS_SPATIAL_MSK 0x18
266 #define RATE_MCS_HT_DUP_POS 5
267 #define RATE_MCS_HT_DUP_MSK 0x20
269 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
270 #define RATE_MCS_FLAGS_POS 8
271 #define RATE_MCS_HT_POS 8
272 #define RATE_MCS_HT_MSK 0x100
274 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
275 #define RATE_MCS_CCK_POS 9
276 #define RATE_MCS_CCK_MSK 0x200
278 /* Bit 10: (1) Use Green Field preamble */
279 #define RATE_MCS_GF_POS 10
280 #define RATE_MCS_GF_MSK 0x400
282 /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
283 #define RATE_MCS_FAT_POS 11
284 #define RATE_MCS_FAT_MSK 0x800
286 /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
287 #define RATE_MCS_DUP_POS 12
288 #define RATE_MCS_DUP_MSK 0x1000
290 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
291 #define RATE_MCS_SGI_POS 13
292 #define RATE_MCS_SGI_MSK 0x2000
295 * rate_n_flags Tx antenna masks
296 * 4965 has 2 transmitters
297 * 5100 has 1 transmitter B
298 * 5150 has 1 transmitter A
299 * 5300 has 3 transmitters
300 * 5350 has 3 transmitters
303 #define RATE_MCS_ANT_POS 14
304 #define RATE_MCS_ANT_A_MSK 0x04000
305 #define RATE_MCS_ANT_B_MSK 0x08000
306 #define RATE_MCS_ANT_C_MSK 0x10000
307 #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
308 #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
309 #define RATE_ANT_NUM 3
311 #define POWER_TABLE_NUM_ENTRIES 33
312 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
313 #define POWER_TABLE_CCK_ENTRY 32
316 * union iwl4965_tx_power_dual_stream
318 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
319 * Use __le32 version (struct tx_power_dual_stream) when building command.
321 * Driver provides radio gain and DSP attenuation settings to device in pairs,
322 * one value for each transmitter chain. The first value is for transmitter A,
323 * second for transmitter B.
325 * For SISO bit rates, both values in a pair should be identical.
326 * For MIMO rates, one value may be different from the other,
327 * in order to balance the Tx output between the two transmitters.
329 * See more details in doc for TXPOWER in iwl-4965-hw.h.
331 union iwl4965_tx_power_dual_stream {
334 u8 dsp_predis_atten[2];
340 * struct tx_power_dual_stream
342 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
344 * Same format as iwl_tx_power_dual_stream, but __le32
346 struct tx_power_dual_stream {
348 } __attribute__ ((packed));
351 * struct iwl4965_tx_power_db
353 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
355 struct iwl4965_tx_power_db {
356 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
357 } __attribute__ ((packed));
360 * Command REPLY_TX_POWER_DBM_CMD = 0x98
361 * struct iwl5000_tx_power_dbm_cmd
363 #define IWL50_TX_POWER_AUTO 0x7f
364 #define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
366 struct iwl5000_tx_power_dbm_cmd {
367 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
369 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
371 } __attribute__ ((packed));
373 /******************************************************************************
375 * Alive and Error Commands & Responses:
377 *****************************************************************************/
379 #define UCODE_VALID_OK cpu_to_le32(0x1)
380 #define INITIALIZE_SUBTYPE (9)
383 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
385 * uCode issues this "initialize alive" notification once the initialization
386 * uCode image has completed its work, and is ready to load the runtime image.
387 * This is the *first* "alive" notification that the driver will receive after
388 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
390 * See comments documenting "BSM" (bootstrap state machine).
392 * For 4965, this notification contains important calibration data for
393 * calculating txpower settings:
395 * 1) Power supply voltage indication. The voltage sensor outputs higher
396 * values for lower voltage, and vice verse.
398 * 2) Temperature measurement parameters, for each of two channel widths
399 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
400 * is done via one of the receiver chains, and channel width influences
403 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
404 * for each of 5 frequency ranges.
406 struct iwl_init_alive_resp {
412 u8 ver_subtype; /* "9" for initialize alive */
414 __le32 log_event_table_ptr;
415 __le32 error_event_table_ptr;
419 /* calibration values from "initialize" uCode */
420 __le32 voltage; /* signed, higher value is lower voltage */
421 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
422 __le32 therm_r2[2]; /* signed */
423 __le32 therm_r3[2]; /* signed */
424 __le32 therm_r4[2]; /* signed */
425 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
427 } __attribute__ ((packed));
431 * REPLY_ALIVE = 0x1 (response only, not a command)
433 * uCode issues this "alive" notification once the runtime image is ready
434 * to receive commands from the driver. This is the *second* "alive"
435 * notification that the driver will receive after rebooting uCode;
436 * this "alive" is indicated by subtype field != 9.
438 * See comments documenting "BSM" (bootstrap state machine).
440 * This response includes two pointers to structures within the device's
441 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
443 * 1) log_event_table_ptr indicates base of the event log. This traces
444 * a 256-entry history of uCode execution within a circular buffer.
445 * Its header format is:
447 * __le32 log_size; log capacity (in number of entries)
448 * __le32 type; (1) timestamp with each entry, (0) no timestamp
449 * __le32 wraps; # times uCode has wrapped to top of circular buffer
450 * __le32 write_index; next circular buffer entry that uCode would fill
452 * The header is followed by the circular buffer of log entries. Entries
453 * with timestamps have the following format:
455 * __le32 event_id; range 0 - 1500
456 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
457 * __le32 data; event_id-specific data value
459 * Entries without timestamps contain only event_id and data.
461 * 2) error_event_table_ptr indicates base of the error log. This contains
462 * information about any uCode error that occurs. For 4965, the format
463 * of the error log is:
465 * __le32 valid; (nonzero) valid, (0) log is empty
466 * __le32 error_id; type of error
467 * __le32 pc; program counter
468 * __le32 blink1; branch link
469 * __le32 blink2; branch link
470 * __le32 ilink1; interrupt link
471 * __le32 ilink2; interrupt link
472 * __le32 data1; error-specific data
473 * __le32 data2; error-specific data
474 * __le32 line; source code line of error
475 * __le32 bcon_time; beacon timer
476 * __le32 tsf_low; network timestamp function timer
477 * __le32 tsf_hi; network timestamp function timer
479 * The Linux driver can print both logs to the system log when a uCode error
482 struct iwl_alive_resp {
488 u8 ver_subtype; /* not "9" for runtime alive */
490 __le32 log_event_table_ptr; /* SRAM address for event log */
491 __le32 error_event_table_ptr; /* SRAM address for error log */
494 } __attribute__ ((packed));
499 * REPLY_ERROR = 0x2 (response only, not a command)
501 struct iwl_error_resp {
505 __le16 bad_cmd_seq_num;
508 } __attribute__ ((packed));
510 /******************************************************************************
512 * RXON Commands & Responses:
514 *****************************************************************************/
517 * Rx config defines & structure
519 /* rx_config device types */
521 RXON_DEV_TYPE_AP = 1,
522 RXON_DEV_TYPE_ESS = 3,
523 RXON_DEV_TYPE_IBSS = 4,
524 RXON_DEV_TYPE_SNIFFER = 6,
528 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
529 #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
530 #define RXON_RX_CHAIN_VALID_POS (1)
531 #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
532 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
533 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
534 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
535 #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
536 #define RXON_RX_CHAIN_CNT_POS (10)
537 #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
538 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
539 #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
540 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
542 /* rx_config flags */
543 /* band & modulation selection */
544 #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
545 #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
546 /* auto detection enable */
547 #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
548 /* TGg protection when tx */
549 #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
550 /* cck short slot & preamble */
551 #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
552 #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
553 /* antenna selection */
554 #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
555 #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
556 #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
557 #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
558 /* radar detection enable */
559 #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
560 #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
561 /* rx response to host with 8-byte TSF
562 * (according to ON_AIR deassertion) */
563 #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
567 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
568 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
570 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
572 #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
573 #define RXON_FLG_FAT_PROT_MSK cpu_to_le32(0x2 << 23)
575 #define RXON_FLG_CHANNEL_MODE_POS (25)
576 #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
577 #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK cpu_to_le32(0x1 << 25)
578 #define RXON_FLG_CHANNEL_MODE_MIXED_MSK cpu_to_le32(0x2 << 25)
579 /* CTS to self (if spec allows) flag */
580 #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
582 /* rx_config filter flags */
583 /* accept all data frames */
584 #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
585 /* pass control & management to host */
586 #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
587 /* accept multi-cast */
588 #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
589 /* don't decrypt uni-cast frames */
590 #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
591 /* don't decrypt multi-cast frames */
592 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
593 /* STA is associated */
594 #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
595 /* transfer to host non bssid beacons in associated state */
596 #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
599 * REPLY_RXON = 0x10 (command, has simple generic response)
601 * RXON tunes the radio tuner to a service channel, and sets up a number
602 * of parameters that are used primarily for Rx, but also for Tx operations.
604 * NOTE: When tuning to a new channel, driver must set the
605 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
606 * info within the device, including the station tables, tx retry
607 * rate tables, and txpower tables. Driver must build a new station
608 * table and txpower table before transmitting anything on the RXON
611 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
612 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
613 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
615 struct iwl4965_rxon_cmd {
620 u8 wlap_bssid_addr[6];
631 u8 ofdm_ht_single_stream_basic_rates;
632 u8 ofdm_ht_dual_stream_basic_rates;
633 } __attribute__ ((packed));
635 /* 5000 HW just extend this command */
636 struct iwl_rxon_cmd {
641 u8 wlap_bssid_addr[6];
652 u8 ofdm_ht_single_stream_basic_rates;
653 u8 ofdm_ht_dual_stream_basic_rates;
654 u8 ofdm_ht_triple_stream_basic_rates;
656 __le16 acquisition_data;
658 } __attribute__ ((packed));
660 struct iwl5000_rxon_assoc_cmd {
666 u8 ofdm_ht_single_stream_basic_rates;
667 u8 ofdm_ht_dual_stream_basic_rates;
668 u8 ofdm_ht_triple_stream_basic_rates;
670 __le16 rx_chain_select_flags;
671 __le16 acquisition_data;
673 } __attribute__ ((packed));
676 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
678 struct iwl4965_rxon_assoc_cmd {
683 u8 ofdm_ht_single_stream_basic_rates;
684 u8 ofdm_ht_dual_stream_basic_rates;
685 __le16 rx_chain_select_flags;
687 } __attribute__ ((packed));
689 #define IWL_CONN_MAX_LISTEN_INTERVAL 10
692 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
694 struct iwl_rxon_time_cmd {
696 __le16 beacon_interval;
698 __le32 beacon_init_val;
699 __le16 listen_interval;
701 } __attribute__ ((packed));
704 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
706 struct iwl_channel_switch_cmd {
711 __le32 rxon_filter_flags;
713 struct iwl4965_tx_power_db tx_power;
714 } __attribute__ ((packed));
717 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
719 struct iwl_csa_notification {
722 __le32 status; /* 0 - OK, 1 - fail */
723 } __attribute__ ((packed));
725 /******************************************************************************
727 * Quality-of-Service (QOS) Commands & Responses:
729 *****************************************************************************/
732 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
733 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
735 * @cw_min: Contention window, start value in numbers of slots.
736 * Should be a power-of-2, minus 1. Device's default is 0x0f.
737 * @cw_max: Contention window, max value in numbers of slots.
738 * Should be a power-of-2, minus 1. Device's default is 0x3f.
739 * @aifsn: Number of slots in Arbitration Interframe Space (before
740 * performing random backoff timing prior to Tx). Device default 1.
741 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
743 * Device will automatically increase contention window by (2*CW) + 1 for each
744 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
745 * value, to cap the CW value.
753 } __attribute__ ((packed));
755 /* QoS flags defines */
756 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
757 #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
758 #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
760 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
764 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
766 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
767 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
769 struct iwl_qosparam_cmd {
771 struct iwl_ac_qos ac[AC_NUM];
772 } __attribute__ ((packed));
774 /******************************************************************************
776 * Add/Modify Stations Commands & Responses:
778 *****************************************************************************/
780 * Multi station support
783 /* Special, dedicated locations within device's station table */
785 #define IWL_MULTICAST_ID 1
787 #define IWL4965_BROADCAST_ID 31
788 #define IWL4965_STATION_COUNT 32
789 #define IWL5000_BROADCAST_ID 15
790 #define IWL5000_STATION_COUNT 16
792 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
793 #define IWL_INVALID_STATION 255
795 #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8);
796 #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
797 #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
798 #define STA_FLG_MAX_AGG_SIZE_POS (19)
799 #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
800 #define STA_FLG_FAT_EN_MSK cpu_to_le32(1 << 21)
801 #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
802 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
803 #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
805 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
806 #define STA_CONTROL_MODIFY_MSK 0x01
808 /* key flags __le16*/
809 #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
810 #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
811 #define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
812 #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
813 #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
815 #define STA_KEY_FLG_KEYID_POS 8
816 #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
817 /* wep key is either from global key (0) or from station info array (1) */
818 #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
820 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
821 #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
822 #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
823 #define STA_KEY_MAX_NUM 8
825 /* Flags indicate whether to modify vs. don't change various station params */
826 #define STA_MODIFY_KEY_MASK 0x01
827 #define STA_MODIFY_TID_DISABLE_TX 0x02
828 #define STA_MODIFY_TX_RATE_MSK 0x04
829 #define STA_MODIFY_ADDBA_TID_MSK 0x08
830 #define STA_MODIFY_DELBA_TID_MSK 0x10
832 /* Receiver address (actually, Rx station's index into station table),
833 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
834 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
836 struct iwl4965_keyinfo {
838 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
840 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
843 u8 key[16]; /* 16-byte unicast decryption key */
844 } __attribute__ ((packed));
849 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
851 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
854 u8 key[16]; /* 16-byte unicast decryption key */
855 __le64 tx_secur_seq_cnt;
856 __le64 hw_tkip_mic_rx_key;
857 __le64 hw_tkip_mic_tx_key;
858 } __attribute__ ((packed));
861 * struct sta_id_modify
862 * @addr[ETH_ALEN]: station's MAC address
863 * @sta_id: index of station in uCode's station table
864 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
866 * Driver selects unused table index when adding new station,
867 * or the index to a pre-existing station entry when modifying that station.
868 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
870 * modify_mask flags select which parameters to modify vs. leave alone.
872 struct sta_id_modify {
878 } __attribute__ ((packed));
881 * REPLY_ADD_STA = 0x18 (command)
883 * The device contains an internal table of per-station information,
884 * with info on security keys, aggregation parameters, and Tx rates for
885 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
886 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
888 * REPLY_ADD_STA sets up the table entry for one station, either creating
889 * a new entry, or modifying a pre-existing one.
891 * NOTE: RXON command (without "associated" bit set) wipes the station table
892 * clean. Moving into RF_KILL state does this also. Driver must set up
893 * new station table before transmitting anything on the RXON channel
894 * (except active scans or active measurements; those commands carry
895 * their own txpower/rate setup data).
897 * When getting started on a new channel, driver must set up the
898 * IWL_BROADCAST_ID entry (last entry in the table). For a client
899 * station in a BSS, once an AP is selected, driver sets up the AP STA
900 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
901 * are all that are needed for a BSS client station. If the device is
902 * used as AP, or in an IBSS network, driver must set up station table
903 * entries for all STAs in network, starting with index IWL_STA_ID.
905 struct iwl4965_addsta_cmd {
906 u8 mode; /* 1: modify existing, 0: add new station */
908 struct sta_id_modify sta;
909 struct iwl4965_keyinfo key;
910 __le32 station_flags; /* STA_FLG_* */
911 __le32 station_flags_msk; /* STA_FLG_* */
913 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
914 * corresponding to bit (e.g. bit 5 controls TID 5).
915 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
916 __le16 tid_disable_tx;
920 /* TID for which to add block-ack support.
921 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
922 u8 add_immediate_ba_tid;
924 /* TID for which to remove block-ack support.
925 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
926 u8 remove_immediate_ba_tid;
928 /* Starting Sequence Number for added block-ack support.
929 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
930 __le16 add_immediate_ba_ssn;
933 } __attribute__ ((packed));
936 struct iwl_addsta_cmd {
937 u8 mode; /* 1: modify existing, 0: add new station */
939 struct sta_id_modify sta;
940 struct iwl_keyinfo key;
941 __le32 station_flags; /* STA_FLG_* */
942 __le32 station_flags_msk; /* STA_FLG_* */
944 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
945 * corresponding to bit (e.g. bit 5 controls TID 5).
946 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
947 __le16 tid_disable_tx;
951 /* TID for which to add block-ack support.
952 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
953 u8 add_immediate_ba_tid;
955 /* TID for which to remove block-ack support.
956 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
957 u8 remove_immediate_ba_tid;
959 /* Starting Sequence Number for added block-ack support.
960 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
961 __le16 add_immediate_ba_ssn;
964 } __attribute__ ((packed));
967 #define ADD_STA_SUCCESS_MSK 0x1
968 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
969 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
970 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
972 * REPLY_ADD_STA = 0x18 (response)
974 struct iwl_add_sta_resp {
975 u8 status; /* ADD_STA_* */
976 } __attribute__ ((packed));
978 #define REM_STA_SUCCESS_MSK 0x1
980 * REPLY_REM_STA = 0x19 (response)
982 struct iwl_rem_sta_resp {
984 } __attribute__ ((packed));
987 * REPLY_REM_STA = 0x19 (command)
989 struct iwl_rem_sta_cmd {
990 u8 num_sta; /* number of removed stations */
992 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
994 } __attribute__ ((packed));
997 * REPLY_WEP_KEY = 0x20
1006 } __attribute__ ((packed));
1008 struct iwl_wep_cmd {
1013 struct iwl_wep_key key[0];
1014 } __attribute__ ((packed));
1016 #define WEP_KEY_WEP_TYPE 1
1017 #define WEP_KEYS_MAX 4
1018 #define WEP_INVALID_OFFSET 0xff
1019 #define WEP_KEY_LEN_64 5
1020 #define WEP_KEY_LEN_128 13
1022 /******************************************************************************
1026 *****************************************************************************/
1028 #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1029 #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
1031 #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1032 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1033 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1034 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
1035 #define RX_RES_PHY_FLAGS_ANTENNA_MSK cpu_to_le16(0xf0)
1037 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1038 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1039 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1040 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1041 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
1042 #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1044 #define RX_RES_STATUS_STATION_FOUND (1<<6)
1045 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
1047 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1048 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1049 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1050 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1051 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
1053 #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1054 #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1055 #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1056 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1058 /* Fixed (non-configurable) rx data from phy */
1060 #define IWL49_RX_RES_PHY_CNT 14
1061 #define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
1062 #define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
1063 #define IWL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
1064 #define IWL49_AGC_DB_POS (7)
1065 struct iwl4965_rx_non_cfg_phy {
1066 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
1067 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
1068 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
1070 } __attribute__ ((packed));
1073 #define IWL50_RX_RES_PHY_CNT 8
1074 #define IWL50_RX_RES_AGC_IDX 1
1075 #define IWL50_RX_RES_RSSI_AB_IDX 2
1076 #define IWL50_RX_RES_RSSI_C_IDX 3
1077 #define IWL50_OFDM_AGC_MSK 0xfe00
1078 #define IWL50_OFDM_AGC_BIT_POS 9
1079 #define IWL50_OFDM_RSSI_A_MSK 0x00ff
1080 #define IWL50_OFDM_RSSI_A_BIT_POS 0
1081 #define IWL50_OFDM_RSSI_B_MSK 0xff0000
1082 #define IWL50_OFDM_RSSI_B_BIT_POS 16
1083 #define IWL50_OFDM_RSSI_C_MSK 0x00ff
1084 #define IWL50_OFDM_RSSI_C_BIT_POS 0
1086 struct iwl5000_non_cfg_phy {
1087 __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT]; /* up to 8 phy entries */
1088 } __attribute__ ((packed));
1092 * REPLY_RX = 0xc3 (response only, not a command)
1093 * Used only for legacy (non 11n) frames.
1095 struct iwl_rx_phy_res {
1096 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1097 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1098 u8 stat_id; /* configurable DSP phy data set ID */
1100 __le64 timestamp; /* TSF at on air rise */
1101 __le32 beacon_time_stamp; /* beacon at on-air rise */
1102 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1103 __le16 channel; /* channel number */
1104 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1105 __le32 rate_n_flags; /* RATE_MCS_* */
1106 __le16 byte_count; /* frame's byte-count */
1108 } __attribute__ ((packed));
1110 struct iwl4965_rx_mpdu_res_start {
1113 } __attribute__ ((packed));
1116 /******************************************************************************
1118 * Tx Commands & Responses:
1120 * Driver must place each REPLY_TX command into one of the prioritized Tx
1121 * queues in host DRAM, shared between driver and device (see comments for
1122 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1123 * are preparing to transmit, the device pulls the Tx command over the PCI
1124 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1125 * from which data will be transmitted.
1127 * uCode handles all timing and protocol related to control frames
1128 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1129 * handle reception of block-acks; uCode updates the host driver via
1130 * REPLY_COMPRESSED_BA (4965).
1132 * uCode handles retrying Tx when an ACK is expected but not received.
1133 * This includes trying lower data rates than the one requested in the Tx
1134 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1135 * REPLY_TX_LINK_QUALITY_CMD (4965).
1137 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1138 * This command must be executed after every RXON command, before Tx can occur.
1139 *****************************************************************************/
1141 /* REPLY_TX Tx flags field */
1143 /* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1144 * before this frame. if CTS-to-self required check
1145 * RXON_FLG_SELF_CTS_EN status. */
1146 #define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0)
1148 /* 1: Use Request-To-Send protocol before this frame.
1149 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
1150 #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1152 /* 1: Transmit Clear-To-Send to self before this frame.
1153 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1154 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
1155 #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1157 /* 1: Expect ACK from receiving station
1158 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1159 * Set this for unicast frames, but not broadcast/multicast. */
1160 #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1163 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1164 * Tx command's initial_rate_index indicates first rate to try;
1165 * uCode walks through table for additional Tx attempts.
1166 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1167 * This rate will be used for all Tx attempts; it will not be scaled. */
1168 #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1170 /* 1: Expect immediate block-ack.
1171 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1172 #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
1174 /* 1: Frame requires full Tx-Op protection.
1175 * Set this if either RTS or CTS Tx Flag gets set. */
1176 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1178 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1179 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1180 #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1181 #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1182 #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
1184 /* 1: Ignore Bluetooth priority for this frame.
1185 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1186 #define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12)
1188 /* 1: uCode overrides sequence control field in MAC header.
1189 * 0: Driver provides sequence control field in MAC header.
1190 * Set this for management frames, non-QOS data frames, non-unicast frames,
1191 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1192 #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
1194 /* 1: This frame is non-last MPDU; more fragments are coming.
1195 * 0: Last fragment, or not using fragmentation. */
1196 #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
1198 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1199 * 0: No TSF required in outgoing frame.
1200 * Set this for transmitting beacons and probe responses. */
1201 #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
1203 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1204 * alignment of frame's payload data field.
1206 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1207 * field (but not both). Driver must align frame data (i.e. data following
1208 * MAC header) to DWORD boundary. */
1209 #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
1211 /* accelerate aggregation support
1212 * 0 - no CCMP encryption; 1 - CCMP encryption */
1213 #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1215 /* HCCA-AP - disable duration overwriting. */
1216 #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
1220 * TX command security control
1222 #define TX_CMD_SEC_WEP 0x01
1223 #define TX_CMD_SEC_CCM 0x02
1224 #define TX_CMD_SEC_TKIP 0x03
1225 #define TX_CMD_SEC_MSK 0x03
1226 #define TX_CMD_SEC_SHIFT 6
1227 #define TX_CMD_SEC_KEY128 0x08
1230 * security overhead sizes
1232 #define WEP_IV_LEN 4
1233 #define WEP_ICV_LEN 4
1234 #define CCMP_MIC_LEN 8
1235 #define TKIP_ICV_LEN 4
1238 * 4965 uCode updates these Tx attempt count values in host DRAM.
1239 * Used for managing Tx retries when expecting block-acks.
1240 * Driver should set these fields to 0.
1242 struct iwl_dram_scratch {
1243 u8 try_cnt; /* Tx attempts */
1244 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1246 } __attribute__ ((packed));
1249 * REPLY_TX = 0x1c (command)
1254 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1255 * + 8 byte IV for CCM or TKIP (not used for WEP)
1257 * + 8-byte MIC (not used for CCM/WEP)
1258 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1259 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1260 * Range: 14-2342 bytes.
1265 * MPDU or MSDU byte count for next frame.
1266 * Used for fragmentation and bursting, but not 11n aggregation.
1267 * Same as "len", but for next frame. Set to 0 if not applicable.
1269 __le16 next_frame_len;
1271 __le32 tx_flags; /* TX_CMD_FLG_* */
1273 /* uCode may modify this field of the Tx command (in host DRAM!).
1274 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1275 struct iwl_dram_scratch scratch;
1277 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1278 __le32 rate_n_flags; /* RATE_MCS_* */
1280 /* Index of destination station in uCode's station table */
1283 /* Type of security encryption: CCM or TKIP */
1284 u8 sec_ctl; /* TX_CMD_SEC_* */
1287 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1288 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1289 * data frames, this field may be used to selectively reduce initial
1290 * rate (via non-0 value) for special frames (e.g. management), while
1291 * still supporting rate scaling for all frames.
1293 u8 initial_rate_index;
1296 __le16 next_frame_flags;
1303 /* Host DRAM physical address pointer to "scratch" in this command.
1304 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1305 __le32 dram_lsb_ptr;
1308 u8 rts_retry_limit; /*byte 50 */
1309 u8 data_retry_limit; /*byte 51 */
1312 __le16 pm_frame_timeout;
1313 __le16 attempt_duration;
1317 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1318 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1323 * MAC header goes here, followed by 2 bytes padding if MAC header
1324 * length is 26 or 30 bytes, followed by payload data
1327 struct ieee80211_hdr hdr[0];
1328 } __attribute__ ((packed));
1330 /* TX command response is sent after *all* transmission attempts.
1334 * TX_STATUS_FAIL_NEXT_FRAG
1336 * If the fragment flag in the MAC header for the frame being transmitted
1337 * is set and there is insufficient time to transmit the next frame, the
1338 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1340 * TX_STATUS_FIFO_UNDERRUN
1342 * Indicates the host did not provide bytes to the FIFO fast enough while
1343 * a TX was in progress.
1345 * TX_STATUS_FAIL_MGMNT_ABORT
1347 * This status is only possible if the ABORT ON MGMT RX parameter was
1348 * set to true with the TX command.
1350 * If the MSB of the status parameter is set then an abort sequence is
1351 * required. This sequence consists of the host activating the TX Abort
1352 * control line, and then waiting for the TX Abort command response. This
1353 * indicates that a the device is no longer in a transmit state, and that the
1354 * command FIFO has been cleared. The host must then deactivate the TX Abort
1355 * control line. Receiving is still allowed in this case.
1358 TX_STATUS_SUCCESS = 0x01,
1359 TX_STATUS_DIRECT_DONE = 0x02,
1360 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1361 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1362 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1363 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1364 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1365 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1366 TX_STATUS_FAIL_DEST_PS = 0x88,
1367 TX_STATUS_FAIL_ABORTED = 0x89,
1368 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1369 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1370 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1371 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1372 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1373 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1374 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1375 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1378 #define TX_PACKET_MODE_REGULAR 0x0000
1379 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1380 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1383 TX_POWER_PA_NOT_ACTIVE = 0x0,
1387 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1388 TX_STATUS_DELAY_MSK = 0x00000040,
1389 TX_STATUS_ABORT_MSK = 0x00000080,
1390 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1391 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1392 TX_RESERVED = 0x00780000, /* bits 19:22 */
1393 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1394 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1397 static inline bool iwl_is_tx_success(u32 status)
1399 status &= TX_STATUS_MSK;
1400 return (status == TX_STATUS_SUCCESS) ||
1401 (status == TX_STATUS_DIRECT_DONE);
1406 /* *******************************
1407 * TX aggregation status
1408 ******************************* */
1411 AGG_TX_STATE_TRANSMITTED = 0x00,
1412 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1413 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1414 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1415 AGG_TX_STATE_ABORT_MSK = 0x08,
1416 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1417 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1418 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1419 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1420 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1421 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1422 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1423 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1426 #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1427 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1428 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1430 /* # tx attempts for first frame in aggregation */
1431 #define AGG_TX_STATE_TRY_CNT_POS 12
1432 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1434 /* Command ID and sequence number of Tx command for this frame */
1435 #define AGG_TX_STATE_SEQ_NUM_POS 16
1436 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1439 * REPLY_TX = 0x1c (response)
1441 * This response may be in one of two slightly different formats, indicated
1442 * by the frame_count field:
1444 * 1) No aggregation (frame_count == 1). This reports Tx results for
1445 * a single frame. Multiple attempts, at various bit rates, may have
1446 * been made for this frame.
1448 * 2) Aggregation (frame_count > 1). This reports Tx results for
1449 * 2 or more frames that used block-acknowledge. All frames were
1450 * transmitted at same rate. Rate scaling may have been used if first
1451 * frame in this new agg block failed in previous agg block(s).
1453 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1454 * block-ack has not been received by the time the 4965 records this status.
1455 * This status relates to reasons the tx might have been blocked or aborted
1456 * within the sending station (this 4965), rather than whether it was
1457 * received successfully by the destination station.
1459 struct agg_tx_status {
1462 } __attribute__ ((packed));
1464 struct iwl4965_tx_resp {
1465 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1466 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1467 u8 failure_rts; /* # failures due to unsuccessful RTS */
1468 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1470 /* For non-agg: Rate at which frame was successful.
1471 * For agg: Rate at which all frames were transmitted. */
1472 __le32 rate_n_flags; /* RATE_MCS_* */
1474 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1475 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1476 __le16 wireless_media_time; /* uSecs */
1479 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1483 * For non-agg: frame status TX_STATUS_*
1484 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1485 * fields follow this one, up to frame_count.
1487 * 11- 0: AGG_TX_STATE_* status code
1488 * 15-12: Retry count for 1st frame in aggregation (retries
1489 * occur if tx failed for this frame when it was a
1490 * member of a previous aggregation block). If rate
1491 * scaling is used, retry count indicates the rate
1492 * table entry used for all frames in the new agg.
1493 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1497 struct agg_tx_status agg_status[0]; /* for each agg frame */
1499 } __attribute__ ((packed));
1502 * definitions for initial rate index field
1503 * bits [3:0] initial rate index
1504 * bits [6:4] rate table color, used for the initial rate
1505 * bit-7 invalid rate indication
1506 * i.e. rate was not chosen from rate table
1507 * or rate table color was changed during frame retries
1508 * refer tlc rate info
1511 #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1512 #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1513 #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1514 #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1515 #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1517 /* refer to ra_tid */
1518 #define IWL50_TX_RES_TID_POS 0
1519 #define IWL50_TX_RES_TID_MSK 0x0f
1520 #define IWL50_TX_RES_RA_POS 4
1521 #define IWL50_TX_RES_RA_MSK 0xf0
1523 struct iwl5000_tx_resp {
1524 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1525 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1526 u8 failure_rts; /* # failures due to unsuccessful RTS */
1527 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1529 /* For non-agg: Rate at which frame was successful.
1530 * For agg: Rate at which all frames were transmitted. */
1531 __le32 rate_n_flags; /* RATE_MCS_* */
1533 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1534 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1535 __le16 wireless_media_time; /* uSecs */
1537 u8 pa_status; /* RF power amplifier measurement (not used) */
1538 u8 pa_integ_res_a[3];
1539 u8 pa_integ_res_b[3];
1540 u8 pa_integ_res_C[3];
1546 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1549 * For non-agg: frame status TX_STATUS_*
1550 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1551 * fields follow this one, up to frame_count.
1553 * 11- 0: AGG_TX_STATE_* status code
1554 * 15-12: Retry count for 1st frame in aggregation (retries
1555 * occur if tx failed for this frame when it was a
1556 * member of a previous aggregation block). If rate
1557 * scaling is used, retry count indicates the rate
1558 * table entry used for all frames in the new agg.
1559 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1561 struct agg_tx_status status; /* TX status (in aggregation -
1562 * status of 1st frame) */
1563 } __attribute__ ((packed));
1565 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1567 * Reports Block-Acknowledge from recipient station
1569 struct iwl_compressed_ba_resp {
1570 __le32 sta_addr_lo32;
1571 __le16 sta_addr_hi16;
1574 /* Index of recipient (BA-sending) station in uCode's station table */
1581 } __attribute__ ((packed));
1584 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1586 * See details under "TXPOWER" in iwl-4965-hw.h.
1588 struct iwl4965_txpowertable_cmd {
1589 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1592 struct iwl4965_tx_power_db tx_power;
1593 } __attribute__ ((packed));
1595 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1596 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1598 /* # of EDCA prioritized tx fifos */
1599 #define LINK_QUAL_AC_NUM AC_NUM
1601 /* # entries in rate scale table to support Tx retries */
1602 #define LINK_QUAL_MAX_RETRY_NUM 16
1604 /* Tx antenna selection values */
1605 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1606 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1607 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1611 * struct iwl_link_qual_general_params
1613 * Used in REPLY_TX_LINK_QUALITY_CMD
1615 struct iwl_link_qual_general_params {
1618 /* No entries at or above this (driver chosen) index contain MIMO */
1621 /* Best single antenna to use for single stream (legacy, SISO). */
1622 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1624 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1625 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1628 * If driver needs to use different initial rates for different
1629 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1630 * this table will set that up, by indicating the indexes in the
1631 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1632 * Otherwise, driver should set all entries to 0.
1635 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1636 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1638 u8 start_rate_index[LINK_QUAL_AC_NUM];
1639 } __attribute__ ((packed));
1642 * struct iwl_link_qual_agg_params
1644 * Used in REPLY_TX_LINK_QUALITY_CMD
1646 struct iwl_link_qual_agg_params {
1648 /* Maximum number of uSec in aggregation.
1649 * Driver should set this to 4000 (4 milliseconds). */
1650 __le16 agg_time_limit;
1653 * Number of Tx retries allowed for a frame, before that frame will
1654 * no longer be considered for the start of an aggregation sequence
1655 * (scheduler will then try to tx it as single frame).
1656 * Driver should set this to 3.
1658 u8 agg_dis_start_th;
1661 * Maximum number of frames in aggregation.
1662 * 0 = no limit (default). 1 = no aggregation.
1663 * Other values = max # frames in aggregation.
1665 u8 agg_frame_cnt_limit;
1668 } __attribute__ ((packed));
1671 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1673 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1675 * Each station in the 4965's internal station table has its own table of 16
1676 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1677 * an ACK is not received. This command replaces the entire table for
1680 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1682 * The rate scaling procedures described below work well. Of course, other
1683 * procedures are possible, and may work better for particular environments.
1686 * FILLING THE RATE TABLE
1688 * Given a particular initial rate and mode, as determined by the rate
1689 * scaling algorithm described below, the Linux driver uses the following
1690 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1691 * Link Quality command:
1694 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1695 * a) Use this same initial rate for first 3 entries.
1696 * b) Find next lower available rate using same mode (SISO or MIMO),
1697 * use for next 3 entries. If no lower rate available, switch to
1698 * legacy mode (no FAT channel, no MIMO, no short guard interval).
1699 * c) If using MIMO, set command's mimo_delimiter to number of entries
1700 * using MIMO (3 or 6).
1701 * d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1702 * no MIMO, no short guard interval), at the next lower bit rate
1703 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1704 * legacy procedure for remaining table entries.
1706 * 2) If using legacy initial rate:
1707 * a) Use the initial rate for only one entry.
1708 * b) For each following entry, reduce the rate to next lower available
1709 * rate, until reaching the lowest available rate.
1710 * c) When reducing rate, also switch antenna selection.
1711 * d) Once lowest available rate is reached, repeat this rate until
1712 * rate table is filled (16 entries), switching antenna each entry.
1715 * ACCUMULATING HISTORY
1717 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1718 * two sets of frame Tx success history: One for the current/active modulation
1719 * mode, and one for a speculative/search mode that is being attempted. If the
1720 * speculative mode turns out to be more effective (i.e. actual transfer
1721 * rate is better), then the driver continues to use the speculative mode
1722 * as the new current active mode.
1724 * Each history set contains, separately for each possible rate, data for a
1725 * sliding window of the 62 most recent tx attempts at that rate. The data
1726 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1727 * and attempted frames, from which the driver can additionally calculate a
1728 * success ratio (success / attempted) and number of failures
1729 * (attempted - success), and control the size of the window (attempted).
1730 * The driver uses the bit map to remove successes from the success sum, as
1731 * the oldest tx attempts fall out of the window.
1733 * When the 4965 makes multiple tx attempts for a given frame, each attempt
1734 * might be at a different rate, and have different modulation characteristics
1735 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
1736 * scaling table in the Link Quality command. The driver must determine
1737 * which rate table entry was used for each tx attempt, to determine which
1738 * rate-specific history to update, and record only those attempts that
1739 * match the modulation characteristics of the history set.
1741 * When using block-ack (aggregation), all frames are transmitted at the same
1742 * rate, since there is no per-attempt acknowledgment from the destination
1743 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1744 * rate_n_flags field. After receiving a block-ack, the driver can update
1745 * history for the entire block all at once.
1748 * FINDING BEST STARTING RATE:
1750 * When working with a selected initial modulation mode (see below), the
1751 * driver attempts to find a best initial rate. The initial rate is the
1752 * first entry in the Link Quality command's rate table.
1754 * 1) Calculate actual throughput (success ratio * expected throughput, see
1755 * table below) for current initial rate. Do this only if enough frames
1756 * have been attempted to make the value meaningful: at least 6 failed
1757 * tx attempts, or at least 8 successes. If not enough, don't try rate
1760 * 2) Find available rates adjacent to current initial rate. Available means:
1761 * a) supported by hardware &&
1762 * b) supported by association &&
1763 * c) within any constraints selected by user
1765 * 3) Gather measured throughputs for adjacent rates. These might not have
1766 * enough history to calculate a throughput. That's okay, we might try
1767 * using one of them anyway!
1769 * 4) Try decreasing rate if, for current rate:
1770 * a) success ratio is < 15% ||
1771 * b) lower adjacent rate has better measured throughput ||
1772 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1774 * As a sanity check, if decrease was determined above, leave rate
1776 * a) lower rate unavailable
1777 * b) success ratio at current rate > 85% (very good)
1778 * c) current measured throughput is better than expected throughput
1779 * of lower rate (under perfect 100% tx conditions, see table below)
1781 * 5) Try increasing rate if, for current rate:
1782 * a) success ratio is < 15% ||
1783 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1784 * b) higher adjacent rate has better measured throughput ||
1785 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1787 * As a sanity check, if increase was determined above, leave rate
1789 * a) success ratio at current rate < 70%. This is not particularly
1790 * good performance; higher rate is sure to have poorer success.
1792 * 6) Re-evaluate the rate after each tx frame. If working with block-
1793 * acknowledge, history and statistics may be calculated for the entire
1794 * block (including prior history that fits within the history windows),
1795 * before re-evaluation.
1797 * FINDING BEST STARTING MODULATION MODE:
1799 * After working with a modulation mode for a "while" (and doing rate scaling),
1800 * the driver searches for a new initial mode in an attempt to improve
1801 * throughput. The "while" is measured by numbers of attempted frames:
1803 * For legacy mode, search for new mode after:
1804 * 480 successful frames, or 160 failed frames
1805 * For high-throughput modes (SISO or MIMO), search for new mode after:
1806 * 4500 successful frames, or 400 failed frames
1808 * Mode switch possibilities are (3 for each mode):
1811 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1813 * Change antenna, try MIMO, try shortened guard interval (SGI)
1815 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1817 * When trying a new mode, use the same bit rate as the old/current mode when
1818 * trying antenna switches and shortened guard interval. When switching to
1819 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1820 * for which the expected throughput (under perfect conditions) is about the
1821 * same or slightly better than the actual measured throughput delivered by
1822 * the old/current mode.
1824 * Actual throughput can be estimated by multiplying the expected throughput
1825 * by the success ratio (successful / attempted tx frames). Frame size is
1826 * not considered in this calculation; it assumes that frame size will average
1827 * out to be fairly consistent over several samples. The following are
1828 * metric values for expected throughput assuming 100% success ratio.
1829 * Only G band has support for CCK rates:
1831 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1833 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1834 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1835 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1836 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1837 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1838 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1839 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1840 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1841 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1842 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1844 * After the new mode has been tried for a short while (minimum of 6 failed
1845 * frames or 8 successful frames), compare success ratio and actual throughput
1846 * estimate of the new mode with the old. If either is better with the new
1847 * mode, continue to use the new mode.
1849 * Continue comparing modes until all 3 possibilities have been tried.
1850 * If moving from legacy to HT, try all 3 possibilities from the new HT
1851 * mode. After trying all 3, a best mode is found. Continue to use this mode
1852 * for the longer "while" described above (e.g. 480 successful frames for
1853 * legacy), and then repeat the search process.
1856 struct iwl_link_quality_cmd {
1858 /* Index of destination/recipient station in uCode's station table */
1861 __le16 control; /* not used */
1862 struct iwl_link_qual_general_params general_params;
1863 struct iwl_link_qual_agg_params agg_params;
1866 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1867 * specifies 1st Tx rate attempted, via index into this table.
1868 * 4965 works its way through table when retrying Tx.
1871 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1872 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1874 } __attribute__ ((packed));
1877 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1879 * 3945 and 4965 support hardware handshake with Bluetooth device on
1880 * same platform. Bluetooth device alerts wireless device when it will Tx;
1881 * wireless device can delay or kill its own Tx to accommodate.
1888 __le32 kill_ack_mask;
1889 __le32 kill_cts_mask;
1890 } __attribute__ ((packed));
1892 /******************************************************************************
1894 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1896 *****************************************************************************/
1899 * Spectrum Management
1901 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1902 RXON_FILTER_CTL2HOST_MSK | \
1903 RXON_FILTER_ACCEPT_GRP_MSK | \
1904 RXON_FILTER_DIS_DECRYPT_MSK | \
1905 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1906 RXON_FILTER_ASSOC_MSK | \
1907 RXON_FILTER_BCON_AWARE_MSK)
1909 struct iwl_measure_channel {
1910 __le32 duration; /* measurement duration in extended beacon
1912 u8 channel; /* channel to measure */
1913 u8 type; /* see enum iwl_measure_type */
1915 } __attribute__ ((packed));
1918 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1920 struct iwl_spectrum_cmd {
1921 __le16 len; /* number of bytes starting from token */
1922 u8 token; /* token id */
1923 u8 id; /* measurement id -- 0 or 1 */
1924 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1925 u8 periodic; /* 1 = periodic */
1926 __le16 path_loss_timeout;
1927 __le32 start_time; /* start time in extended beacon format */
1929 __le32 flags; /* rxon flags */
1930 __le32 filter_flags; /* rxon filter flags */
1931 __le16 channel_count; /* minimum 1, maximum 10 */
1933 struct iwl_measure_channel channels[10];
1934 } __attribute__ ((packed));
1937 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1939 struct iwl_spectrum_resp {
1941 u8 id; /* id of the prior command replaced, or 0xff */
1942 __le16 status; /* 0 - command will be handled
1943 * 1 - cannot handle (conflicts with another
1945 } __attribute__ ((packed));
1947 enum iwl_measurement_state {
1948 IWL_MEASUREMENT_START = 0,
1949 IWL_MEASUREMENT_STOP = 1,
1952 enum iwl_measurement_status {
1953 IWL_MEASUREMENT_OK = 0,
1954 IWL_MEASUREMENT_CONCURRENT = 1,
1955 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1956 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1958 IWL_MEASUREMENT_STOPPED = 6,
1959 IWL_MEASUREMENT_TIMEOUT = 7,
1960 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1963 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1965 struct iwl_measurement_histogram {
1966 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1967 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1968 } __attribute__ ((packed));
1970 /* clear channel availability counters */
1971 struct iwl_measurement_cca_counters {
1974 } __attribute__ ((packed));
1976 enum iwl_measure_type {
1977 IWL_MEASURE_BASIC = (1 << 0),
1978 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1979 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1980 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1981 IWL_MEASURE_FRAME = (1 << 4),
1982 /* bits 5:6 are reserved */
1983 IWL_MEASURE_IDLE = (1 << 7),
1987 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1989 struct iwl_spectrum_notification {
1990 u8 id; /* measurement id -- 0 or 1 */
1992 u8 channel_index; /* index in measurement channel list */
1993 u8 state; /* 0 - start, 1 - stop */
1994 __le32 start_time; /* lower 32-bits of TSF */
1995 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1997 u8 type; /* see enum iwl_measurement_type */
1999 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2000 * valid if applicable for measurement type requested. */
2001 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2002 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2003 __le32 cca_time; /* channel load time in usecs */
2004 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2007 struct iwl_measurement_histogram histogram;
2008 __le32 stop_time; /* lower 32-bits of TSF */
2009 __le32 status; /* see iwl_measurement_status */
2010 } __attribute__ ((packed));
2012 /******************************************************************************
2014 * Power Management Commands, Responses, Notifications:
2016 *****************************************************************************/
2019 * struct iwl_powertable_cmd - Power Table Command
2020 * @flags: See below:
2022 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2025 * bit 0 - '0' Driver not allow power management
2026 * '1' Driver allow PM (use rest of parameters)
2027 * uCode send sleep notifications:
2028 * bit 1 - '0' Don't send sleep notification
2029 * '1' send sleep notification (SEND_PM_NOTIFICATION)
2031 * bit 2 - '0' PM have to walk up every DTIM
2032 * '1' PM could sleep over DTIM till listen Interval.
2034 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2035 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
2037 * bit 31/30- '00' use both mac/xtal sleeps
2038 * '01' force Mac sleep
2039 * '10' force xtal sleep
2042 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2043 * ucode assume sleep over DTIM is allowed and we don't need to wake up
2046 #define IWL_POWER_VEC_SIZE 5
2048 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
2049 #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2050 #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2051 #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
2053 struct iwl3945_powertable_cmd {
2056 __le32 rx_data_timeout;
2057 __le32 tx_data_timeout;
2058 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2059 } __attribute__ ((packed));
2061 struct iwl_powertable_cmd {
2063 u8 keep_alive_seconds; /* 3945 reserved */
2064 u8 debug_flags; /* 3945 reserved */
2065 __le32 rx_data_timeout;
2066 __le32 tx_data_timeout;
2067 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2068 __le32 keep_alive_beacons;
2069 } __attribute__ ((packed));
2072 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2073 * 3945 and 4965 identical.
2075 struct iwl_sleep_notification {
2082 } __attribute__ ((packed));
2084 /* Sleep states. 3945 and 4965 identical. */
2086 IWL_PM_NO_SLEEP = 0,
2088 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2089 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2091 IWL_PM_SLP_REPENT = 5,
2092 IWL_PM_WAKEUP_BY_TIMER = 6,
2093 IWL_PM_WAKEUP_BY_DRIVER = 7,
2094 IWL_PM_WAKEUP_BY_RFKILL = 8,
2096 IWL_PM_NUM_OF_MODES = 12,
2100 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2102 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2103 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2104 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
2105 struct iwl_card_state_cmd {
2106 __le32 status; /* CARD_STATE_CMD_* request new power state */
2107 } __attribute__ ((packed));
2110 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2112 struct iwl_card_state_notif {
2114 } __attribute__ ((packed));
2116 #define HW_CARD_DISABLED 0x01
2117 #define SW_CARD_DISABLED 0x02
2118 #define RF_CARD_DISABLED 0x04
2119 #define RXON_CARD_DISABLED 0x10
2121 struct iwl_ct_kill_config {
2123 __le32 critical_temperature_M;
2124 __le32 critical_temperature_R;
2125 } __attribute__ ((packed));
2127 /******************************************************************************
2129 * Scan Commands, Responses, Notifications:
2131 *****************************************************************************/
2133 #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2134 #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
2137 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2139 * One for each channel in the scan list.
2140 * Each channel can independently select:
2141 * 1) SSID for directed active scans
2142 * 2) Txpower setting (for rate specified within Tx command)
2143 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2144 * quiet_plcp_th, good_CRC_th)
2146 * To avoid uCode errors, make sure the following are true (see comments
2147 * under struct iwl_scan_cmd about max_out_time and quiet_time):
2148 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2149 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2150 * 2) quiet_time <= active_dwell
2151 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2152 * passive_dwell < max_out_time
2153 * active_dwell < max_out_time
2155 struct iwl_scan_channel {
2157 * type is defined as:
2158 * 0:0 1 = active, 0 = passive
2159 * 1:20 SSID direct bit map; if a bit is set, then corresponding
2160 * SSID IE is transmitted in probe request.
2164 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2165 u8 tx_gain; /* gain for analog radio */
2166 u8 dsp_atten; /* gain for DSP */
2167 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2168 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2169 } __attribute__ ((packed));
2172 * struct iwl_ssid_ie - directed scan network information element
2174 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
2175 * in struct iwl_scan_channel; each channel may select different ssids from
2176 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
2178 struct iwl_ssid_ie {
2182 } __attribute__ ((packed));
2184 #define PROBE_OPTION_MAX 0x14
2185 #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
2186 #define IWL_GOOD_CRC_TH cpu_to_le16(1)
2187 #define IWL_MAX_SCAN_SIZE 1024
2190 * REPLY_SCAN_CMD = 0x80 (command)
2192 * The hardware scan command is very powerful; the driver can set it up to
2193 * maintain (relatively) normal network traffic while doing a scan in the
2194 * background. The max_out_time and suspend_time control the ratio of how
2195 * long the device stays on an associated network channel ("service channel")
2196 * vs. how long it's away from the service channel, i.e. tuned to other channels
2199 * max_out_time is the max time off-channel (in usec), and suspend_time
2200 * is how long (in "extended beacon" format) that the scan is "suspended"
2201 * after returning to the service channel. That is, suspend_time is the
2202 * time that we stay on the service channel, doing normal work, between
2203 * scan segments. The driver may set these parameters differently to support
2204 * scanning when associated vs. not associated, and light vs. heavy traffic
2205 * loads when associated.
2207 * After receiving this command, the device's scan engine does the following;
2209 * 1) Sends SCAN_START notification to driver
2210 * 2) Checks to see if it has time to do scan for one channel
2211 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2212 * to tell AP that we're going off-channel
2213 * 4) Tunes to first channel in scan list, does active or passive scan
2214 * 5) Sends SCAN_RESULT notification to driver
2215 * 6) Checks to see if it has time to do scan on *next* channel in list
2216 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2217 * before max_out_time expires
2218 * 8) Returns to service channel
2219 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2220 * 10) Stays on service channel until suspend_time expires
2221 * 11) Repeats entire process 2-10 until list is complete
2222 * 12) Sends SCAN_COMPLETE notification
2224 * For fast, efficient scans, the scan command also has support for staying on
2225 * a channel for just a short time, if doing active scanning and getting no
2226 * responses to the transmitted probe request. This time is controlled by
2227 * quiet_time, and the number of received packets below which a channel is
2228 * considered "quiet" is controlled by quiet_plcp_threshold.
2230 * For active scanning on channels that have regulatory restrictions against
2231 * blindly transmitting, the scan can listen before transmitting, to make sure
2232 * that there is already legitimate activity on the channel. If enough
2233 * packets are cleanly received on the channel (controlled by good_CRC_th,
2234 * typical value 1), the scan engine starts transmitting probe requests.
2236 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2238 * To avoid uCode errors, see timing restrictions described under
2239 * struct iwl_scan_channel.
2241 struct iwl_scan_cmd {
2244 u8 channel_count; /* # channels in channel list */
2245 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2246 * (only for active scan) */
2247 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2248 __le16 good_CRC_th; /* passive -> active promotion threshold */
2249 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2250 __le32 max_out_time; /* max usec to be away from associated (service)
2252 __le32 suspend_time; /* pause scan this long (in "extended beacon
2253 * format") when returning to service chnl:
2254 * 3945; 31:24 # beacons, 19:0 additional usec,
2255 * 4965; 31:22 # beacons, 21:0 additional usec.
2257 __le32 flags; /* RXON_FLG_* */
2258 __le32 filter_flags; /* RXON_FILTER_* */
2260 /* For active scans (set to all-0s for passive scans).
2261 * Does not include payload. Must specify Tx rate; no rate scaling. */
2262 struct iwl_tx_cmd tx_cmd;
2264 /* For directed active scans (set to all-0s otherwise) */
2265 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2268 * Probe request frame, followed by channel list.
2270 * Size of probe request frame is specified by byte count in tx_cmd.
2271 * Channel list follows immediately after probe request frame.
2272 * Number of channels in list is specified by channel_count.
2273 * Each channel in list is of type:
2275 * struct iwl_scan_channel channels[0];
2277 * NOTE: Only one band of channels can be scanned per pass. You
2278 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2279 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2280 * before requesting another scan.
2283 } __attribute__ ((packed));
2285 /* Can abort will notify by complete notification with abort status. */
2286 #define CAN_ABORT_STATUS cpu_to_le32(0x1)
2287 /* complete notification statuses */
2288 #define ABORT_STATUS 0x2
2291 * REPLY_SCAN_CMD = 0x80 (response)
2293 struct iwl_scanreq_notification {
2294 __le32 status; /* 1: okay, 2: cannot fulfill request */
2295 } __attribute__ ((packed));
2298 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2300 struct iwl_scanstart_notification {
2303 __le32 beacon_timer;
2308 } __attribute__ ((packed));
2310 #define SCAN_OWNER_STATUS 0x1;
2311 #define MEASURE_OWNER_STATUS 0x2;
2313 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2315 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2317 struct iwl_scanresults_notification {
2323 __le32 statistics[NUMBER_OF_STATISTICS];
2324 } __attribute__ ((packed));
2327 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2329 struct iwl_scancomplete_notification {
2330 u8 scanned_channels;
2336 } __attribute__ ((packed));
2339 /******************************************************************************
2341 * IBSS/AP Commands and Notifications:
2343 *****************************************************************************/
2346 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2348 struct iwl4965_beacon_notif {
2349 struct iwl4965_tx_resp beacon_notify_hdr;
2352 __le32 ibss_mgr_status;
2353 } __attribute__ ((packed));
2356 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2358 struct iwl_tx_beacon_cmd {
2359 struct iwl_tx_cmd tx;
2363 struct ieee80211_hdr frame[0]; /* beacon frame */
2364 } __attribute__ ((packed));
2366 /******************************************************************************
2368 * Statistics Commands and Notifications:
2370 *****************************************************************************/
2372 #define IWL_TEMP_CONVERT 260
2374 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2375 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2376 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2378 /* Used for passing to driver number of successes and failures per rate */
2379 struct rate_histogram {
2381 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2382 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2383 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2386 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2387 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2388 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2390 } __attribute__ ((packed));
2392 /* statistics command response */
2394 struct statistics_rx_phy {
2400 __le32 early_overrun_err;
2402 __le32 false_alarm_cnt;
2403 __le32 fina_sync_err_cnt;
2405 __le32 fina_timeout;
2406 __le32 unresponded_rts;
2407 __le32 rxe_frame_limit_overrun;
2408 __le32 sent_ack_cnt;
2409 __le32 sent_cts_cnt;
2410 __le32 sent_ba_rsp_cnt;
2411 __le32 dsp_self_kill;
2412 __le32 mh_format_err;
2413 __le32 re_acq_main_rssi_sum;
2415 } __attribute__ ((packed));
2417 struct statistics_rx_ht_phy {
2420 __le32 early_overrun_err;
2423 __le32 mh_format_err;
2424 __le32 agg_crc32_good;
2425 __le32 agg_mpdu_cnt;
2428 } __attribute__ ((packed));
2430 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
2432 struct statistics_rx_non_phy {
2433 __le32 bogus_cts; /* CTS received when not expecting CTS */
2434 __le32 bogus_ack; /* ACK received when not expecting ACK */
2435 __le32 non_bssid_frames; /* number of frames with BSSID that
2436 * doesn't belong to the STA BSSID */
2437 __le32 filtered_frames; /* count frames that were dumped in the
2438 * filtering process */
2439 __le32 non_channel_beacons; /* beacons with our bss id but not on
2440 * our serving channel */
2441 __le32 channel_beacons; /* beacons with our bss id and in our
2442 * serving channel */
2443 __le32 num_missed_bcon; /* number of missed beacons */
2444 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2445 * ADC was in saturation */
2446 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2448 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2449 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2450 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2451 __le32 interference_data_flag; /* flag for interference data
2452 * availability. 1 when data is
2454 __le32 channel_load; /* counts RX Enable time in uSec */
2455 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2456 * and CCK) counter */
2457 __le32 beacon_rssi_a;
2458 __le32 beacon_rssi_b;
2459 __le32 beacon_rssi_c;
2460 __le32 beacon_energy_a;
2461 __le32 beacon_energy_b;
2462 __le32 beacon_energy_c;
2463 } __attribute__ ((packed));
2465 struct statistics_rx {
2466 struct statistics_rx_phy ofdm;
2467 struct statistics_rx_phy cck;
2468 struct statistics_rx_non_phy general;
2469 struct statistics_rx_ht_phy ofdm_ht;
2470 } __attribute__ ((packed));
2472 struct statistics_tx_non_phy_agg {
2474 __le32 ba_reschedule_frames;
2475 __le32 scd_query_agg_frame_cnt;
2476 __le32 scd_query_no_agg;
2477 __le32 scd_query_agg;
2478 __le32 scd_query_mismatch;
2479 __le32 frame_not_ready;
2481 __le32 bt_prio_kill;
2482 __le32 rx_ba_rsp_cnt;
2485 } __attribute__ ((packed));
2487 struct statistics_tx {
2488 __le32 preamble_cnt;
2489 __le32 rx_detected_cnt;
2490 __le32 bt_prio_defer_cnt;
2491 __le32 bt_prio_kill_cnt;
2492 __le32 few_bytes_cnt;
2495 __le32 expected_ack_cnt;
2496 __le32 actual_ack_cnt;
2497 __le32 dump_msdu_cnt;
2498 __le32 burst_abort_next_frame_mismatch_cnt;
2499 __le32 burst_abort_missing_next_frame_cnt;
2500 __le32 cts_timeout_collision;
2501 __le32 ack_or_ba_timeout_collision;
2502 struct statistics_tx_non_phy_agg agg;
2503 } __attribute__ ((packed));
2505 struct statistics_dbg {
2509 } __attribute__ ((packed));
2511 struct statistics_div {
2518 } __attribute__ ((packed));
2520 struct statistics_general {
2522 __le32 temperature_m;
2523 struct statistics_dbg dbg;
2527 __le32 ttl_timestamp;
2528 struct statistics_div div;
2529 __le32 rx_enable_counter;
2533 } __attribute__ ((packed));
2536 * REPLY_STATISTICS_CMD = 0x9c,
2537 * 3945 and 4965 identical.
2539 * This command triggers an immediate response containing uCode statistics.
2540 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2542 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2543 * internal copy of the statistics (counters) after issuing the response.
2544 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2546 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2547 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2548 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2550 #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
2551 #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
2552 struct iwl_statistics_cmd {
2553 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2554 } __attribute__ ((packed));
2557 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2559 * By default, uCode issues this notification after receiving a beacon
2560 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2561 * REPLY_STATISTICS_CMD 0x9c, above.
2563 * Statistics counters continue to increment beacon after beacon, but are
2564 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2565 * 0x9c with CLEAR_STATS bit set (see above).
2567 * uCode also issues this notification during scans. uCode clears statistics
2568 * appropriately so that each notification contains statistics for only the
2569 * one channel that has just been scanned.
2571 #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
2572 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK cpu_to_le32(0x8)
2573 struct iwl_notif_statistics {
2575 struct statistics_rx rx;
2576 struct statistics_tx tx;
2577 struct statistics_general general;
2578 } __attribute__ ((packed));
2582 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2584 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2585 * then this notification will be sent. */
2586 #define CONSECUTIVE_MISSED_BCONS_TH 20
2588 struct iwl_missed_beacon_notif {
2589 __le32 consequtive_missed_beacons;
2590 __le32 total_missed_becons;
2591 __le32 num_expected_beacons;
2592 __le32 num_recvd_beacons;
2593 } __attribute__ ((packed));
2596 /******************************************************************************
2598 * Rx Calibration Commands:
2600 * With the uCode used for open source drivers, most Tx calibration (except
2601 * for Tx Power) and most Rx calibration is done by uCode during the
2602 * "initialize" phase of uCode boot. Driver must calibrate only:
2604 * 1) Tx power (depends on temperature), described elsewhere
2605 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2606 * 3) Receiver sensitivity (to optimize signal detection)
2608 *****************************************************************************/
2611 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2613 * This command sets up the Rx signal detector for a sensitivity level that
2614 * is high enough to lock onto all signals within the associated network,
2615 * but low enough to ignore signals that are below a certain threshold, so as
2616 * not to have too many "false alarms". False alarms are signals that the
2617 * Rx DSP tries to lock onto, but then discards after determining that they
2620 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2621 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2622 * time listening, not transmitting). Driver must adjust sensitivity so that
2623 * the ratio of actual false alarms to actual Rx time falls within this range.
2625 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2626 * received beacon. These provide information to the driver to analyze the
2627 * sensitivity. Don't analyze statistics that come in from scanning, or any
2628 * other non-associated-network source. Pertinent statistics include:
2630 * From "general" statistics (struct statistics_rx_non_phy):
2632 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2633 * Measure of energy of desired signal. Used for establishing a level
2634 * below which the device does not detect signals.
2636 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2637 * Measure of background noise in silent period after beacon.
2640 * uSecs of actual Rx time during beacon period (varies according to
2641 * how much time was spent transmitting).
2643 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2646 * Signal locks abandoned early (before phy-level header).
2649 * Signal locks abandoned late (during phy-level header).
2651 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2652 * beacon to beacon, i.e. each value is an accumulation of all errors
2653 * before and including the latest beacon. Values will wrap around to 0
2654 * after counting up to 2^32 - 1. Driver must differentiate vs.
2655 * previous beacon's values to determine # false alarms in the current
2658 * Total number of false alarms = false_alarms + plcp_errs
2660 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2661 * (notice that the start points for OFDM are at or close to settings for
2662 * maximum sensitivity):
2665 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2666 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2667 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2668 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2670 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2671 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2672 * by *adding* 1 to all 4 of the table entries above, up to the max for
2673 * each entry. Conversely, if false alarm rate is too low (less than 5
2674 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2675 * increase sensitivity.
2677 * For CCK sensitivity, keep track of the following:
2679 * 1). 20-beacon history of maximum background noise, indicated by
2680 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2681 * 3 receivers. For any given beacon, the "silence reference" is
2682 * the maximum of last 60 samples (20 beacons * 3 receivers).
2684 * 2). 10-beacon history of strongest signal level, as indicated
2685 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2686 * i.e. the strength of the signal through the best receiver at the
2687 * moment. These measurements are "upside down", with lower values
2688 * for stronger signals, so max energy will be *minimum* value.
2690 * Then for any given beacon, the driver must determine the *weakest*
2691 * of the strongest signals; this is the minimum level that needs to be
2692 * successfully detected, when using the best receiver at the moment.
2693 * "Max cck energy" is the maximum (higher value means lower energy!)
2694 * of the last 10 minima. Once this is determined, driver must add
2695 * a little margin by adding "6" to it.
2697 * 3). Number of consecutive beacon periods with too few false alarms.
2698 * Reset this to 0 at the first beacon period that falls within the
2699 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2701 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2702 * (notice that the start points for CCK are at maximum sensitivity):
2705 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2706 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2707 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2709 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2710 * (greater than 50 for each 204.8 msecs listening), method for reducing
2713 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2716 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2717 * sensitivity has been reduced a significant amount; bring it up to
2718 * a moderate 161. Otherwise, *add* 3, up to max 200.
2720 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2721 * sensitivity has been reduced only a moderate or small amount;
2722 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2723 * down to min 0. Otherwise (if gain has been significantly reduced),
2724 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2726 * b) Save a snapshot of the "silence reference".
2728 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2729 * (less than 5 for each 204.8 msecs listening), method for increasing
2730 * sensitivity is used only if:
2732 * 1a) Previous beacon did not have too many false alarms
2733 * 1b) AND difference between previous "silence reference" and current
2734 * "silence reference" (prev - current) is 2 or more,
2735 * OR 2) 100 or more consecutive beacon periods have had rate of
2736 * less than 5 false alarms per 204.8 milliseconds rx time.
2738 * Method for increasing sensitivity:
2740 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2743 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2746 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2748 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
2749 * (between 5 and 50 for each 204.8 msecs listening):
2751 * 1) Save a snapshot of the silence reference.
2753 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2754 * give some extra margin to energy threshold by *subtracting* 8
2755 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2757 * For all cases (too few, too many, good range), make sure that the CCK
2758 * detection threshold (energy) is below the energy level for robust
2759 * detection over the past 10 beacon periods, the "Max cck energy".
2760 * Lower values mean higher energy; this means making sure that the value
2761 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2763 * Driver should set the following entries to fixed values:
2765 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
2766 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2767 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2768 * HD_OFDM_ENERGY_TH_IN_INDEX 62
2772 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
2774 #define HD_TABLE_SIZE (11) /* number of entries */
2775 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2776 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2777 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2778 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2779 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2780 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2781 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2782 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2783 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2784 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2785 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2787 /* Control field in struct iwl_sensitivity_cmd */
2788 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
2789 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
2792 * struct iwl_sensitivity_cmd
2793 * @control: (1) updates working table, (0) updates default table
2794 * @table: energy threshold values, use HD_* as index into table
2796 * Always use "1" in "control" to update uCode's working table and DSP.
2798 struct iwl_sensitivity_cmd {
2799 __le16 control; /* always use "1" */
2800 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2801 } __attribute__ ((packed));
2805 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2807 * This command sets the relative gains of 4965's 3 radio receiver chains.
2809 * After the first association, driver should accumulate signal and noise
2810 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2811 * beacons from the associated network (don't collect statistics that come
2812 * in from scanning, or any other non-network source).
2814 * DISCONNECTED ANTENNA:
2816 * Driver should determine which antennas are actually connected, by comparing
2817 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2818 * following values over 20 beacons, one accumulator for each of the chains
2819 * a/b/c, from struct statistics_rx_non_phy:
2821 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2823 * Find the strongest signal from among a/b/c. Compare the other two to the
2824 * strongest. If any signal is more than 15 dB (times 20, unless you
2825 * divide the accumulated values by 20) below the strongest, the driver
2826 * considers that antenna to be disconnected, and should not try to use that
2827 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2828 * driver should declare the stronger one as connected, and attempt to use it
2829 * (A and B are the only 2 Tx chains!).
2834 * Driver should balance the 3 receivers (but just the ones that are connected
2835 * to antennas, see above) for gain, by comparing the average signal levels
2836 * detected during the silence after each beacon (background noise).
2837 * Accumulate (add) the following values over 20 beacons, one accumulator for
2838 * each of the chains a/b/c, from struct statistics_rx_non_phy:
2840 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2842 * Find the weakest background noise level from among a/b/c. This Rx chain
2843 * will be the reference, with 0 gain adjustment. Attenuate other channels by
2844 * finding noise difference:
2846 * (accum_noise[i] - accum_noise[reference]) / 30
2848 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2849 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2850 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2851 * and set bit 2 to indicate "reduce gain". The value for the reference
2852 * (weakest) chain should be "0".
2854 * diff_gain_[abc] bit fields:
2855 * 2: (1) reduce gain, (0) increase gain
2856 * 1-0: amount of gain, units of 1.5 dB
2859 /* Phy calibration command for series */
2862 IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
2863 IWL_PHY_CALIBRATE_DC_CMD = 8,
2864 IWL_PHY_CALIBRATE_LO_CMD = 9,
2865 IWL_PHY_CALIBRATE_RX_BB_CMD = 10,
2866 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
2867 IWL_PHY_CALIBRATE_RX_IQ_CMD = 12,
2868 IWL_PHY_CALIBRATION_NOISE_CMD = 13,
2869 IWL_PHY_CALIBRATE_AGC_TABLE_CMD = 14,
2870 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
2871 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
2872 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
2873 IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
2874 IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19,
2878 #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
2880 struct iwl_calib_cfg_elmnt_s {
2886 } __attribute__ ((packed));
2888 struct iwl_calib_cfg_status_s {
2889 struct iwl_calib_cfg_elmnt_s once;
2890 struct iwl_calib_cfg_elmnt_s perd;
2892 } __attribute__ ((packed));
2894 struct iwl_calib_cfg_cmd {
2895 struct iwl_calib_cfg_status_s ucd_calib_cfg;
2896 struct iwl_calib_cfg_status_s drv_calib_cfg;
2898 } __attribute__ ((packed));
2900 struct iwl_calib_hdr {
2905 } __attribute__ ((packed));
2907 struct iwl_calib_cmd {
2908 struct iwl_calib_hdr hdr;
2910 } __attribute__ ((packed));
2912 /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2913 struct iwl_calib_diff_gain_cmd {
2914 struct iwl_calib_hdr hdr;
2915 s8 diff_gain_a; /* see above */
2919 } __attribute__ ((packed));
2921 struct iwl_calib_xtal_freq_cmd {
2922 struct iwl_calib_hdr hdr;
2926 } __attribute__ ((packed));
2928 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
2929 struct iwl_calib_chain_noise_reset_cmd {
2930 struct iwl_calib_hdr hdr;
2934 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
2935 struct iwl_calib_chain_noise_gain_cmd {
2936 struct iwl_calib_hdr hdr;
2940 } __attribute__ ((packed));
2942 /******************************************************************************
2944 * Miscellaneous Commands:
2946 *****************************************************************************/
2949 * LEDs Command & Response
2950 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2952 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2953 * this command turns it on or off, or sets up a periodic blinking cycle.
2955 struct iwl_led_cmd {
2956 __le32 interval; /* "interval" in uSec */
2957 u8 id; /* 1: Activity, 2: Link, 3: Tech */
2958 u8 off; /* # intervals off while blinking;
2959 * "0", with >0 "on" value, turns LED on */
2960 u8 on; /* # intervals on while blinking;
2961 * "0", regardless of "off", turns LED off */
2963 } __attribute__ ((packed));
2966 * Coexistence WIFI/WIMAX Command
2967 * COEX_PRIORITY_TABLE_CMD = 0x5a
2971 COEX_UNASSOC_IDLE = 0,
2972 COEX_UNASSOC_MANUAL_SCAN = 1,
2973 COEX_UNASSOC_AUTO_SCAN = 2,
2974 COEX_CALIBRATION = 3,
2975 COEX_PERIODIC_CALIBRATION = 4,
2976 COEX_CONNECTION_ESTAB = 5,
2977 COEX_ASSOCIATED_IDLE = 6,
2978 COEX_ASSOC_MANUAL_SCAN = 7,
2979 COEX_ASSOC_AUTO_SCAN = 8,
2980 COEX_ASSOC_ACTIVE_LEVEL = 9,
2983 COEX_STAND_ALONE_DEBUG = 12,
2984 COEX_IPAN_ASSOC_LEVEL = 13,
2987 COEX_NUM_OF_EVENTS = 16
2990 struct iwl_wimax_coex_event_entry {
2995 } __attribute__ ((packed));
2997 /* COEX flag masks */
2999 /* Station table is valid */
3000 #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
3001 /* UnMask wake up src at unassociated sleep */
3002 #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
3003 /* UnMask wake up src at associated sleep */
3004 #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3005 /* Enable CoEx feature. */
3006 #define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3008 struct iwl_wimax_coex_cmd {
3011 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3012 } __attribute__ ((packed));
3014 /******************************************************************************
3016 * Union of all expected notifications/responses:
3018 *****************************************************************************/
3020 struct iwl_rx_packet {
3022 struct iwl_cmd_header hdr;
3024 struct iwl_alive_resp alive_frame;
3025 struct iwl_spectrum_notification spectrum_notif;
3026 struct iwl_csa_notification csa_notif;
3027 struct iwl_error_resp err_resp;
3028 struct iwl_card_state_notif card_state_notif;
3029 struct iwl_add_sta_resp add_sta;
3030 struct iwl_rem_sta_resp rem_sta;
3031 struct iwl_sleep_notification sleep_notif;
3032 struct iwl_spectrum_resp spectrum;
3033 struct iwl_notif_statistics stats;
3034 struct iwl_compressed_ba_resp compressed_ba;
3035 struct iwl_missed_beacon_notif missed_beacon;
3039 } __attribute__ ((packed));
3041 int iwl_agn_check_rxon_cmd(struct iwl_rxon_cmd *rxon);
3043 #endif /* __iwl_commands_h__ */