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)
80 #define IWL_CCK_RATES 4
81 #define IWL_OFDM_RATES 8
82 #define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES)
88 /* RXON and QOS commands */
90 REPLY_RXON_ASSOC = 0x11,
91 REPLY_QOS_PARAM = 0x13,
92 REPLY_RXON_TIMING = 0x14,
94 /* Multi-Station support */
96 REPLY_REMOVE_STA = 0x19, /* not used */
97 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
103 REPLY_3945_RX = 0x1b, /* 3945 only */
105 REPLY_RATE_SCALE = 0x47, /* 3945 only */
106 REPLY_LEDS_CMD = 0x48,
107 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
109 /* WiMAX coexistence */
110 COEX_PRIORITY_TABLE_CMD = 0x5a, /*5000 only */
111 COEX_MEDIUM_NOTIFICATION = 0x5b,
112 COEX_EVENT_CMD = 0x5c,
115 CALIBRATION_CFG_CMD = 0x65,
116 CALIBRATION_RES_NOTIFICATION = 0x66,
117 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
119 /* 802.11h related */
120 RADAR_NOTIFICATION = 0x70, /* not used */
121 REPLY_QUIET_CMD = 0x71, /* not used */
122 REPLY_CHANNEL_SWITCH = 0x72,
123 CHANNEL_SWITCH_NOTIFICATION = 0x73,
124 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
125 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
127 /* Power Management */
128 POWER_TABLE_CMD = 0x77,
129 PM_SLEEP_NOTIFICATION = 0x7A,
130 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
132 /* Scan commands and notifications */
133 REPLY_SCAN_CMD = 0x80,
134 REPLY_SCAN_ABORT_CMD = 0x81,
135 SCAN_START_NOTIFICATION = 0x82,
136 SCAN_RESULTS_NOTIFICATION = 0x83,
137 SCAN_COMPLETE_NOTIFICATION = 0x84,
139 /* IBSS/AP commands */
140 BEACON_NOTIFICATION = 0x90,
141 REPLY_TX_BEACON = 0x91,
142 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
144 /* Miscellaneous commands */
145 QUIET_NOTIFICATION = 0x96, /* not used */
146 REPLY_TX_PWR_TABLE_CMD = 0x97,
147 REPLY_TX_POWER_DBM_CMD = 0x98,
148 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
150 /* Bluetooth device coexistence config command */
151 REPLY_BT_CONFIG = 0x9b,
154 REPLY_STATISTICS_CMD = 0x9c,
155 STATISTICS_NOTIFICATION = 0x9d,
157 /* RF-KILL commands and notifications */
158 REPLY_CARD_STATE_CMD = 0xa0,
159 CARD_STATE_NOTIFICATION = 0xa1,
161 /* Missed beacons notification */
162 MISSED_BEACONS_NOTIFICATION = 0xa2,
164 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
165 SENSITIVITY_CMD = 0xa8,
166 REPLY_PHY_CALIBRATION_CMD = 0xb0,
167 REPLY_RX_PHY_CMD = 0xc0,
168 REPLY_RX_MPDU_CMD = 0xc1,
170 REPLY_COMPRESSED_BA = 0xc5,
174 /******************************************************************************
176 * Commonly used structures and definitions:
177 * Command header, rate_n_flags, txpower
179 *****************************************************************************/
181 /* iwl_cmd_header flags value */
182 #define IWL_CMD_FAILED_MSK 0x40
184 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
185 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
186 #define SEQ_TO_INDEX(s) ((s) & 0xff)
187 #define INDEX_TO_SEQ(i) ((i) & 0xff)
188 #define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
189 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
192 * struct iwl_cmd_header
194 * This header format appears in the beginning of each command sent from the
195 * driver, and each response/notification received from uCode.
197 struct iwl_cmd_header {
198 u8 cmd; /* Command ID: REPLY_RXON, etc. */
199 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
201 * The driver sets up the sequence number to values of its choosing.
202 * uCode does not use this value, but passes it back to the driver
203 * when sending the response to each driver-originated command, so
204 * the driver can match the response to the command. Since the values
205 * don't get used by uCode, the driver may set up an arbitrary format.
207 * There is one exception: uCode sets bit 15 when it originates
208 * the response/notification, i.e. when the response/notification
209 * is not a direct response to a command sent by the driver. For
210 * example, uCode issues REPLY_3945_RX when it sends a received frame
211 * to the driver; it is not a direct response to any driver command.
213 * The Linux driver uses the following format:
215 * 0:7 tfd index - position within TX queue
218 * 14 huge - driver sets this to indicate command is in the
219 * 'huge' storage at the end of the command buffers
220 * 15 unsolicited RX or uCode-originated notification
224 /* command or response/notification data follows immediately */
226 } __attribute__ ((packed));
229 * iwlagn rate_n_flags bit fields
231 * rate_n_flags format is used in following iwlagn commands:
232 * REPLY_RX (response only)
233 * REPLY_RX_MPDU (response only)
234 * REPLY_TX (both command and response)
235 * REPLY_TX_LINK_QUALITY_CMD
237 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
247 * 4-3: 0) Single stream (SISO)
248 * 1) Dual stream (MIMO)
249 * 2) Triple stream (MIMO)
251 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
253 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
263 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
269 #define RATE_MCS_CODE_MSK 0x7
270 #define RATE_MCS_SPATIAL_POS 3
271 #define RATE_MCS_SPATIAL_MSK 0x18
272 #define RATE_MCS_HT_DUP_POS 5
273 #define RATE_MCS_HT_DUP_MSK 0x20
275 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
276 #define RATE_MCS_FLAGS_POS 8
277 #define RATE_MCS_HT_POS 8
278 #define RATE_MCS_HT_MSK 0x100
280 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
281 #define RATE_MCS_CCK_POS 9
282 #define RATE_MCS_CCK_MSK 0x200
284 /* Bit 10: (1) Use Green Field preamble */
285 #define RATE_MCS_GF_POS 10
286 #define RATE_MCS_GF_MSK 0x400
288 /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
289 #define RATE_MCS_FAT_POS 11
290 #define RATE_MCS_FAT_MSK 0x800
292 /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
293 #define RATE_MCS_DUP_POS 12
294 #define RATE_MCS_DUP_MSK 0x1000
296 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
297 #define RATE_MCS_SGI_POS 13
298 #define RATE_MCS_SGI_MSK 0x2000
301 * rate_n_flags Tx antenna masks
302 * 4965 has 2 transmitters
303 * 5100 has 1 transmitter B
304 * 5150 has 1 transmitter A
305 * 5300 has 3 transmitters
306 * 5350 has 3 transmitters
309 #define RATE_MCS_ANT_POS 14
310 #define RATE_MCS_ANT_A_MSK 0x04000
311 #define RATE_MCS_ANT_B_MSK 0x08000
312 #define RATE_MCS_ANT_C_MSK 0x10000
313 #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
314 #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
315 #define RATE_ANT_NUM 3
317 #define POWER_TABLE_NUM_ENTRIES 33
318 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
319 #define POWER_TABLE_CCK_ENTRY 32
322 * union iwl4965_tx_power_dual_stream
324 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
325 * Use __le32 version (struct tx_power_dual_stream) when building command.
327 * Driver provides radio gain and DSP attenuation settings to device in pairs,
328 * one value for each transmitter chain. The first value is for transmitter A,
329 * second for transmitter B.
331 * For SISO bit rates, both values in a pair should be identical.
332 * For MIMO rates, one value may be different from the other,
333 * in order to balance the Tx output between the two transmitters.
335 * See more details in doc for TXPOWER in iwl-4965-hw.h.
337 union iwl4965_tx_power_dual_stream {
340 u8 dsp_predis_atten[2];
346 * struct tx_power_dual_stream
348 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
350 * Same format as iwl_tx_power_dual_stream, but __le32
352 struct tx_power_dual_stream {
354 } __attribute__ ((packed));
357 * struct iwl4965_tx_power_db
359 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
361 struct iwl4965_tx_power_db {
362 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
363 } __attribute__ ((packed));
366 * Command REPLY_TX_POWER_DBM_CMD = 0x98
367 * struct iwl5000_tx_power_dbm_cmd
369 #define IWL50_TX_POWER_AUTO 0x7f
370 #define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
372 struct iwl5000_tx_power_dbm_cmd {
373 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
375 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
377 } __attribute__ ((packed));
379 /******************************************************************************
381 * Alive and Error Commands & Responses:
383 *****************************************************************************/
385 #define UCODE_VALID_OK cpu_to_le32(0x1)
386 #define INITIALIZE_SUBTYPE (9)
389 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
391 * uCode issues this "initialize alive" notification once the initialization
392 * uCode image has completed its work, and is ready to load the runtime image.
393 * This is the *first* "alive" notification that the driver will receive after
394 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
396 * See comments documenting "BSM" (bootstrap state machine).
398 * For 4965, this notification contains important calibration data for
399 * calculating txpower settings:
401 * 1) Power supply voltage indication. The voltage sensor outputs higher
402 * values for lower voltage, and vice verse.
404 * 2) Temperature measurement parameters, for each of two channel widths
405 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
406 * is done via one of the receiver chains, and channel width influences
409 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
410 * for each of 5 frequency ranges.
412 struct iwl_init_alive_resp {
418 u8 ver_subtype; /* "9" for initialize alive */
420 __le32 log_event_table_ptr;
421 __le32 error_event_table_ptr;
425 /* calibration values from "initialize" uCode */
426 __le32 voltage; /* signed, higher value is lower voltage */
427 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
428 __le32 therm_r2[2]; /* signed */
429 __le32 therm_r3[2]; /* signed */
430 __le32 therm_r4[2]; /* signed */
431 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
433 } __attribute__ ((packed));
437 * REPLY_ALIVE = 0x1 (response only, not a command)
439 * uCode issues this "alive" notification once the runtime image is ready
440 * to receive commands from the driver. This is the *second* "alive"
441 * notification that the driver will receive after rebooting uCode;
442 * this "alive" is indicated by subtype field != 9.
444 * See comments documenting "BSM" (bootstrap state machine).
446 * This response includes two pointers to structures within the device's
447 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
449 * 1) log_event_table_ptr indicates base of the event log. This traces
450 * a 256-entry history of uCode execution within a circular buffer.
451 * Its header format is:
453 * __le32 log_size; log capacity (in number of entries)
454 * __le32 type; (1) timestamp with each entry, (0) no timestamp
455 * __le32 wraps; # times uCode has wrapped to top of circular buffer
456 * __le32 write_index; next circular buffer entry that uCode would fill
458 * The header is followed by the circular buffer of log entries. Entries
459 * with timestamps have the following format:
461 * __le32 event_id; range 0 - 1500
462 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
463 * __le32 data; event_id-specific data value
465 * Entries without timestamps contain only event_id and data.
467 * 2) error_event_table_ptr indicates base of the error log. This contains
468 * information about any uCode error that occurs. For 4965, the format
469 * of the error log is:
471 * __le32 valid; (nonzero) valid, (0) log is empty
472 * __le32 error_id; type of error
473 * __le32 pc; program counter
474 * __le32 blink1; branch link
475 * __le32 blink2; branch link
476 * __le32 ilink1; interrupt link
477 * __le32 ilink2; interrupt link
478 * __le32 data1; error-specific data
479 * __le32 data2; error-specific data
480 * __le32 line; source code line of error
481 * __le32 bcon_time; beacon timer
482 * __le32 tsf_low; network timestamp function timer
483 * __le32 tsf_hi; network timestamp function timer
485 * The Linux driver can print both logs to the system log when a uCode error
488 struct iwl_alive_resp {
494 u8 ver_subtype; /* not "9" for runtime alive */
496 __le32 log_event_table_ptr; /* SRAM address for event log */
497 __le32 error_event_table_ptr; /* SRAM address for error log */
500 } __attribute__ ((packed));
505 * REPLY_ERROR = 0x2 (response only, not a command)
507 struct iwl_error_resp {
511 __le16 bad_cmd_seq_num;
514 } __attribute__ ((packed));
516 /******************************************************************************
518 * RXON Commands & Responses:
520 *****************************************************************************/
523 * Rx config defines & structure
525 /* rx_config device types */
527 RXON_DEV_TYPE_AP = 1,
528 RXON_DEV_TYPE_ESS = 3,
529 RXON_DEV_TYPE_IBSS = 4,
530 RXON_DEV_TYPE_SNIFFER = 6,
534 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
535 #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
536 #define RXON_RX_CHAIN_VALID_POS (1)
537 #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
538 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
539 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
540 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
541 #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
542 #define RXON_RX_CHAIN_CNT_POS (10)
543 #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
544 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
545 #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
546 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
548 /* rx_config flags */
549 /* band & modulation selection */
550 #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
551 #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
552 /* auto detection enable */
553 #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
554 /* TGg protection when tx */
555 #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
556 /* cck short slot & preamble */
557 #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
558 #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
559 /* antenna selection */
560 #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
561 #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
562 #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
563 #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
564 /* radar detection enable */
565 #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
566 #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
567 /* rx response to host with 8-byte TSF
568 * (according to ON_AIR deassertion) */
569 #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
573 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
574 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
576 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
578 #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
579 #define RXON_FLG_FAT_PROT_MSK cpu_to_le32(0x2 << 23)
581 #define RXON_FLG_CHANNEL_MODE_POS (25)
582 #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
583 #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK cpu_to_le32(0x1 << 25)
584 #define RXON_FLG_CHANNEL_MODE_MIXED_MSK cpu_to_le32(0x2 << 25)
585 /* CTS to self (if spec allows) flag */
586 #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
588 /* rx_config filter flags */
589 /* accept all data frames */
590 #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
591 /* pass control & management to host */
592 #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
593 /* accept multi-cast */
594 #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
595 /* don't decrypt uni-cast frames */
596 #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
597 /* don't decrypt multi-cast frames */
598 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
599 /* STA is associated */
600 #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
601 /* transfer to host non bssid beacons in associated state */
602 #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
605 * REPLY_RXON = 0x10 (command, has simple generic response)
607 * RXON tunes the radio tuner to a service channel, and sets up a number
608 * of parameters that are used primarily for Rx, but also for Tx operations.
610 * NOTE: When tuning to a new channel, driver must set the
611 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
612 * info within the device, including the station tables, tx retry
613 * rate tables, and txpower tables. Driver must build a new station
614 * table and txpower table before transmitting anything on the RXON
617 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
618 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
619 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
621 struct iwl4965_rxon_cmd {
626 u8 wlap_bssid_addr[6];
637 u8 ofdm_ht_single_stream_basic_rates;
638 u8 ofdm_ht_dual_stream_basic_rates;
639 } __attribute__ ((packed));
641 /* 5000 HW just extend this command */
642 struct iwl_rxon_cmd {
647 u8 wlap_bssid_addr[6];
658 u8 ofdm_ht_single_stream_basic_rates;
659 u8 ofdm_ht_dual_stream_basic_rates;
660 u8 ofdm_ht_triple_stream_basic_rates;
662 __le16 acquisition_data;
664 } __attribute__ ((packed));
666 struct iwl5000_rxon_assoc_cmd {
672 u8 ofdm_ht_single_stream_basic_rates;
673 u8 ofdm_ht_dual_stream_basic_rates;
674 u8 ofdm_ht_triple_stream_basic_rates;
676 __le16 rx_chain_select_flags;
677 __le16 acquisition_data;
679 } __attribute__ ((packed));
682 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
684 struct iwl4965_rxon_assoc_cmd {
689 u8 ofdm_ht_single_stream_basic_rates;
690 u8 ofdm_ht_dual_stream_basic_rates;
691 __le16 rx_chain_select_flags;
693 } __attribute__ ((packed));
695 #define IWL_CONN_MAX_LISTEN_INTERVAL 10
698 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
700 struct iwl_rxon_time_cmd {
702 __le16 beacon_interval;
704 __le32 beacon_init_val;
705 __le16 listen_interval;
707 } __attribute__ ((packed));
710 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
712 struct iwl_channel_switch_cmd {
717 __le32 rxon_filter_flags;
719 struct iwl4965_tx_power_db tx_power;
720 } __attribute__ ((packed));
723 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
725 struct iwl_csa_notification {
728 __le32 status; /* 0 - OK, 1 - fail */
729 } __attribute__ ((packed));
731 /******************************************************************************
733 * Quality-of-Service (QOS) Commands & Responses:
735 *****************************************************************************/
738 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
739 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
741 * @cw_min: Contention window, start value in numbers of slots.
742 * Should be a power-of-2, minus 1. Device's default is 0x0f.
743 * @cw_max: Contention window, max value in numbers of slots.
744 * Should be a power-of-2, minus 1. Device's default is 0x3f.
745 * @aifsn: Number of slots in Arbitration Interframe Space (before
746 * performing random backoff timing prior to Tx). Device default 1.
747 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
749 * Device will automatically increase contention window by (2*CW) + 1 for each
750 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
751 * value, to cap the CW value.
759 } __attribute__ ((packed));
761 /* QoS flags defines */
762 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
763 #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
764 #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
766 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
770 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
772 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
773 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
775 struct iwl_qosparam_cmd {
777 struct iwl_ac_qos ac[AC_NUM];
778 } __attribute__ ((packed));
780 /******************************************************************************
782 * Add/Modify Stations Commands & Responses:
784 *****************************************************************************/
786 * Multi station support
789 /* Special, dedicated locations within device's station table */
791 #define IWL_MULTICAST_ID 1
793 #define IWL3945_BROADCAST_ID 24
794 #define IWL3945_STATION_COUNT 25
795 #define IWL4965_BROADCAST_ID 31
796 #define IWL4965_STATION_COUNT 32
797 #define IWL5000_BROADCAST_ID 15
798 #define IWL5000_STATION_COUNT 16
800 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
801 #define IWL_INVALID_STATION 255
803 #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2);
804 #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8);
805 #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8);
806 #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
807 #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
808 #define STA_FLG_MAX_AGG_SIZE_POS (19)
809 #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
810 #define STA_FLG_FAT_EN_MSK cpu_to_le32(1 << 21)
811 #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
812 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
813 #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
815 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
816 #define STA_CONTROL_MODIFY_MSK 0x01
818 /* key flags __le16*/
819 #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
820 #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
821 #define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
822 #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
823 #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
825 #define STA_KEY_FLG_KEYID_POS 8
826 #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
827 /* wep key is either from global key (0) or from station info array (1) */
828 #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
830 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
831 #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
832 #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
833 #define STA_KEY_MAX_NUM 8
835 /* Flags indicate whether to modify vs. don't change various station params */
836 #define STA_MODIFY_KEY_MASK 0x01
837 #define STA_MODIFY_TID_DISABLE_TX 0x02
838 #define STA_MODIFY_TX_RATE_MSK 0x04
839 #define STA_MODIFY_ADDBA_TID_MSK 0x08
840 #define STA_MODIFY_DELBA_TID_MSK 0x10
842 /* Receiver address (actually, Rx station's index into station table),
843 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
844 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
846 struct iwl4965_keyinfo {
848 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
850 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
853 u8 key[16]; /* 16-byte unicast decryption key */
854 } __attribute__ ((packed));
859 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
861 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
864 u8 key[16]; /* 16-byte unicast decryption key */
865 __le64 tx_secur_seq_cnt;
866 __le64 hw_tkip_mic_rx_key;
867 __le64 hw_tkip_mic_tx_key;
868 } __attribute__ ((packed));
871 * struct sta_id_modify
872 * @addr[ETH_ALEN]: station's MAC address
873 * @sta_id: index of station in uCode's station table
874 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
876 * Driver selects unused table index when adding new station,
877 * or the index to a pre-existing station entry when modifying that station.
878 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
880 * modify_mask flags select which parameters to modify vs. leave alone.
882 struct sta_id_modify {
888 } __attribute__ ((packed));
891 * REPLY_ADD_STA = 0x18 (command)
893 * The device contains an internal table of per-station information,
894 * with info on security keys, aggregation parameters, and Tx rates for
895 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
896 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
898 * REPLY_ADD_STA sets up the table entry for one station, either creating
899 * a new entry, or modifying a pre-existing one.
901 * NOTE: RXON command (without "associated" bit set) wipes the station table
902 * clean. Moving into RF_KILL state does this also. Driver must set up
903 * new station table before transmitting anything on the RXON channel
904 * (except active scans or active measurements; those commands carry
905 * their own txpower/rate setup data).
907 * When getting started on a new channel, driver must set up the
908 * IWL_BROADCAST_ID entry (last entry in the table). For a client
909 * station in a BSS, once an AP is selected, driver sets up the AP STA
910 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
911 * are all that are needed for a BSS client station. If the device is
912 * used as AP, or in an IBSS network, driver must set up station table
913 * entries for all STAs in network, starting with index IWL_STA_ID.
915 struct iwl4965_addsta_cmd {
916 u8 mode; /* 1: modify existing, 0: add new station */
918 struct sta_id_modify sta;
919 struct iwl4965_keyinfo key;
920 __le32 station_flags; /* STA_FLG_* */
921 __le32 station_flags_msk; /* STA_FLG_* */
923 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
924 * corresponding to bit (e.g. bit 5 controls TID 5).
925 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
926 __le16 tid_disable_tx;
930 /* TID for which to add block-ack support.
931 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
932 u8 add_immediate_ba_tid;
934 /* TID for which to remove block-ack support.
935 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
936 u8 remove_immediate_ba_tid;
938 /* Starting Sequence Number for added block-ack support.
939 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
940 __le16 add_immediate_ba_ssn;
943 } __attribute__ ((packed));
946 struct iwl_addsta_cmd {
947 u8 mode; /* 1: modify existing, 0: add new station */
949 struct sta_id_modify sta;
950 struct iwl_keyinfo key;
951 __le32 station_flags; /* STA_FLG_* */
952 __le32 station_flags_msk; /* STA_FLG_* */
954 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
955 * corresponding to bit (e.g. bit 5 controls TID 5).
956 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
957 __le16 tid_disable_tx;
961 /* TID for which to add block-ack support.
962 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
963 u8 add_immediate_ba_tid;
965 /* TID for which to remove block-ack support.
966 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
967 u8 remove_immediate_ba_tid;
969 /* Starting Sequence Number for added block-ack support.
970 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
971 __le16 add_immediate_ba_ssn;
974 } __attribute__ ((packed));
977 #define ADD_STA_SUCCESS_MSK 0x1
978 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
979 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
980 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
982 * REPLY_ADD_STA = 0x18 (response)
984 struct iwl_add_sta_resp {
985 u8 status; /* ADD_STA_* */
986 } __attribute__ ((packed));
988 #define REM_STA_SUCCESS_MSK 0x1
990 * REPLY_REM_STA = 0x19 (response)
992 struct iwl_rem_sta_resp {
994 } __attribute__ ((packed));
997 * REPLY_REM_STA = 0x19 (command)
999 struct iwl_rem_sta_cmd {
1000 u8 num_sta; /* number of removed stations */
1002 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
1004 } __attribute__ ((packed));
1007 * REPLY_WEP_KEY = 0x20
1009 struct iwl_wep_key {
1016 } __attribute__ ((packed));
1018 struct iwl_wep_cmd {
1023 struct iwl_wep_key key[0];
1024 } __attribute__ ((packed));
1026 #define WEP_KEY_WEP_TYPE 1
1027 #define WEP_KEYS_MAX 4
1028 #define WEP_INVALID_OFFSET 0xff
1029 #define WEP_KEY_LEN_64 5
1030 #define WEP_KEY_LEN_128 13
1032 /******************************************************************************
1036 *****************************************************************************/
1038 #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1039 #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
1041 #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1042 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1043 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1044 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
1045 #define RX_RES_PHY_FLAGS_ANTENNA_MSK cpu_to_le16(0xf0)
1047 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1048 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1049 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1050 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1051 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
1052 #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1054 #define RX_RES_STATUS_STATION_FOUND (1<<6)
1055 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
1057 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1058 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1059 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1060 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1061 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
1063 #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1064 #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1065 #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1066 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1068 /* Fixed (non-configurable) rx data from phy */
1070 #define IWL49_RX_RES_PHY_CNT 14
1071 #define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
1072 #define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
1073 #define IWL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
1074 #define IWL49_AGC_DB_POS (7)
1075 struct iwl4965_rx_non_cfg_phy {
1076 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
1077 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
1078 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
1080 } __attribute__ ((packed));
1083 #define IWL50_RX_RES_PHY_CNT 8
1084 #define IWL50_RX_RES_AGC_IDX 1
1085 #define IWL50_RX_RES_RSSI_AB_IDX 2
1086 #define IWL50_RX_RES_RSSI_C_IDX 3
1087 #define IWL50_OFDM_AGC_MSK 0xfe00
1088 #define IWL50_OFDM_AGC_BIT_POS 9
1089 #define IWL50_OFDM_RSSI_A_MSK 0x00ff
1090 #define IWL50_OFDM_RSSI_A_BIT_POS 0
1091 #define IWL50_OFDM_RSSI_B_MSK 0xff0000
1092 #define IWL50_OFDM_RSSI_B_BIT_POS 16
1093 #define IWL50_OFDM_RSSI_C_MSK 0x00ff
1094 #define IWL50_OFDM_RSSI_C_BIT_POS 0
1096 struct iwl5000_non_cfg_phy {
1097 __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT]; /* up to 8 phy entries */
1098 } __attribute__ ((packed));
1102 * REPLY_RX = 0xc3 (response only, not a command)
1103 * Used only for legacy (non 11n) frames.
1105 struct iwl_rx_phy_res {
1106 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1107 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1108 u8 stat_id; /* configurable DSP phy data set ID */
1110 __le64 timestamp; /* TSF at on air rise */
1111 __le32 beacon_time_stamp; /* beacon at on-air rise */
1112 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1113 __le16 channel; /* channel number */
1114 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1115 __le32 rate_n_flags; /* RATE_MCS_* */
1116 __le16 byte_count; /* frame's byte-count */
1118 } __attribute__ ((packed));
1120 struct iwl4965_rx_mpdu_res_start {
1123 } __attribute__ ((packed));
1126 /******************************************************************************
1128 * Tx Commands & Responses:
1130 * Driver must place each REPLY_TX command into one of the prioritized Tx
1131 * queues in host DRAM, shared between driver and device (see comments for
1132 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1133 * are preparing to transmit, the device pulls the Tx command over the PCI
1134 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1135 * from which data will be transmitted.
1137 * uCode handles all timing and protocol related to control frames
1138 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1139 * handle reception of block-acks; uCode updates the host driver via
1140 * REPLY_COMPRESSED_BA (4965).
1142 * uCode handles retrying Tx when an ACK is expected but not received.
1143 * This includes trying lower data rates than the one requested in the Tx
1144 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1145 * REPLY_TX_LINK_QUALITY_CMD (4965).
1147 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1148 * This command must be executed after every RXON command, before Tx can occur.
1149 *****************************************************************************/
1151 /* REPLY_TX Tx flags field */
1153 /* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1154 * before this frame. if CTS-to-self required check
1155 * RXON_FLG_SELF_CTS_EN status. */
1156 #define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0)
1158 /* 1: Use Request-To-Send protocol before this frame.
1159 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
1160 #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1162 /* 1: Transmit Clear-To-Send to self before this frame.
1163 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1164 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
1165 #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1167 /* 1: Expect ACK from receiving station
1168 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1169 * Set this for unicast frames, but not broadcast/multicast. */
1170 #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1173 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1174 * Tx command's initial_rate_index indicates first rate to try;
1175 * uCode walks through table for additional Tx attempts.
1176 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1177 * This rate will be used for all Tx attempts; it will not be scaled. */
1178 #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1180 /* 1: Expect immediate block-ack.
1181 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1182 #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
1184 /* 1: Frame requires full Tx-Op protection.
1185 * Set this if either RTS or CTS Tx Flag gets set. */
1186 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1188 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1189 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1190 #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1191 #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1192 #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
1194 /* 1: Ignore Bluetooth priority for this frame.
1195 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1196 #define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12)
1198 /* 1: uCode overrides sequence control field in MAC header.
1199 * 0: Driver provides sequence control field in MAC header.
1200 * Set this for management frames, non-QOS data frames, non-unicast frames,
1201 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1202 #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
1204 /* 1: This frame is non-last MPDU; more fragments are coming.
1205 * 0: Last fragment, or not using fragmentation. */
1206 #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
1208 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1209 * 0: No TSF required in outgoing frame.
1210 * Set this for transmitting beacons and probe responses. */
1211 #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
1213 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1214 * alignment of frame's payload data field.
1216 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1217 * field (but not both). Driver must align frame data (i.e. data following
1218 * MAC header) to DWORD boundary. */
1219 #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
1221 /* accelerate aggregation support
1222 * 0 - no CCMP encryption; 1 - CCMP encryption */
1223 #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1225 /* HCCA-AP - disable duration overwriting. */
1226 #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
1230 * TX command security control
1232 #define TX_CMD_SEC_WEP 0x01
1233 #define TX_CMD_SEC_CCM 0x02
1234 #define TX_CMD_SEC_TKIP 0x03
1235 #define TX_CMD_SEC_MSK 0x03
1236 #define TX_CMD_SEC_SHIFT 6
1237 #define TX_CMD_SEC_KEY128 0x08
1240 * security overhead sizes
1242 #define WEP_IV_LEN 4
1243 #define WEP_ICV_LEN 4
1244 #define CCMP_MIC_LEN 8
1245 #define TKIP_ICV_LEN 4
1248 * 4965 uCode updates these Tx attempt count values in host DRAM.
1249 * Used for managing Tx retries when expecting block-acks.
1250 * Driver should set these fields to 0.
1252 struct iwl_dram_scratch {
1253 u8 try_cnt; /* Tx attempts */
1254 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1256 } __attribute__ ((packed));
1259 * REPLY_TX = 0x1c (command)
1264 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1265 * + 8 byte IV for CCM or TKIP (not used for WEP)
1267 * + 8-byte MIC (not used for CCM/WEP)
1268 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1269 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1270 * Range: 14-2342 bytes.
1275 * MPDU or MSDU byte count for next frame.
1276 * Used for fragmentation and bursting, but not 11n aggregation.
1277 * Same as "len", but for next frame. Set to 0 if not applicable.
1279 __le16 next_frame_len;
1281 __le32 tx_flags; /* TX_CMD_FLG_* */
1283 /* uCode may modify this field of the Tx command (in host DRAM!).
1284 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1285 struct iwl_dram_scratch scratch;
1287 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1288 __le32 rate_n_flags; /* RATE_MCS_* */
1290 /* Index of destination station in uCode's station table */
1293 /* Type of security encryption: CCM or TKIP */
1294 u8 sec_ctl; /* TX_CMD_SEC_* */
1297 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1298 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1299 * data frames, this field may be used to selectively reduce initial
1300 * rate (via non-0 value) for special frames (e.g. management), while
1301 * still supporting rate scaling for all frames.
1303 u8 initial_rate_index;
1306 __le16 next_frame_flags;
1313 /* Host DRAM physical address pointer to "scratch" in this command.
1314 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1315 __le32 dram_lsb_ptr;
1318 u8 rts_retry_limit; /*byte 50 */
1319 u8 data_retry_limit; /*byte 51 */
1322 __le16 pm_frame_timeout;
1323 __le16 attempt_duration;
1327 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1328 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1333 * MAC header goes here, followed by 2 bytes padding if MAC header
1334 * length is 26 or 30 bytes, followed by payload data
1337 struct ieee80211_hdr hdr[0];
1338 } __attribute__ ((packed));
1340 /* TX command response is sent after *all* transmission attempts.
1344 * TX_STATUS_FAIL_NEXT_FRAG
1346 * If the fragment flag in the MAC header for the frame being transmitted
1347 * is set and there is insufficient time to transmit the next frame, the
1348 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1350 * TX_STATUS_FIFO_UNDERRUN
1352 * Indicates the host did not provide bytes to the FIFO fast enough while
1353 * a TX was in progress.
1355 * TX_STATUS_FAIL_MGMNT_ABORT
1357 * This status is only possible if the ABORT ON MGMT RX parameter was
1358 * set to true with the TX command.
1360 * If the MSB of the status parameter is set then an abort sequence is
1361 * required. This sequence consists of the host activating the TX Abort
1362 * control line, and then waiting for the TX Abort command response. This
1363 * indicates that a the device is no longer in a transmit state, and that the
1364 * command FIFO has been cleared. The host must then deactivate the TX Abort
1365 * control line. Receiving is still allowed in this case.
1368 TX_STATUS_SUCCESS = 0x01,
1369 TX_STATUS_DIRECT_DONE = 0x02,
1370 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1371 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1372 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1373 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1374 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1375 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1376 TX_STATUS_FAIL_DEST_PS = 0x88,
1377 TX_STATUS_FAIL_ABORTED = 0x89,
1378 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1379 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1380 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1381 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1382 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1383 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1384 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1385 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1388 #define TX_PACKET_MODE_REGULAR 0x0000
1389 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1390 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1393 TX_POWER_PA_NOT_ACTIVE = 0x0,
1397 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1398 TX_STATUS_DELAY_MSK = 0x00000040,
1399 TX_STATUS_ABORT_MSK = 0x00000080,
1400 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1401 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1402 TX_RESERVED = 0x00780000, /* bits 19:22 */
1403 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1404 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1407 static inline bool iwl_is_tx_success(u32 status)
1409 status &= TX_STATUS_MSK;
1410 return (status == TX_STATUS_SUCCESS) ||
1411 (status == TX_STATUS_DIRECT_DONE);
1416 /* *******************************
1417 * TX aggregation status
1418 ******************************* */
1421 AGG_TX_STATE_TRANSMITTED = 0x00,
1422 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1423 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1424 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1425 AGG_TX_STATE_ABORT_MSK = 0x08,
1426 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1427 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1428 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1429 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1430 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1431 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1432 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1433 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1436 #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1437 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1438 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1440 /* # tx attempts for first frame in aggregation */
1441 #define AGG_TX_STATE_TRY_CNT_POS 12
1442 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1444 /* Command ID and sequence number of Tx command for this frame */
1445 #define AGG_TX_STATE_SEQ_NUM_POS 16
1446 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1449 * REPLY_TX = 0x1c (response)
1451 * This response may be in one of two slightly different formats, indicated
1452 * by the frame_count field:
1454 * 1) No aggregation (frame_count == 1). This reports Tx results for
1455 * a single frame. Multiple attempts, at various bit rates, may have
1456 * been made for this frame.
1458 * 2) Aggregation (frame_count > 1). This reports Tx results for
1459 * 2 or more frames that used block-acknowledge. All frames were
1460 * transmitted at same rate. Rate scaling may have been used if first
1461 * frame in this new agg block failed in previous agg block(s).
1463 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1464 * block-ack has not been received by the time the 4965 records this status.
1465 * This status relates to reasons the tx might have been blocked or aborted
1466 * within the sending station (this 4965), rather than whether it was
1467 * received successfully by the destination station.
1469 struct agg_tx_status {
1472 } __attribute__ ((packed));
1474 struct iwl4965_tx_resp {
1475 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1476 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1477 u8 failure_rts; /* # failures due to unsuccessful RTS */
1478 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1480 /* For non-agg: Rate at which frame was successful.
1481 * For agg: Rate at which all frames were transmitted. */
1482 __le32 rate_n_flags; /* RATE_MCS_* */
1484 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1485 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1486 __le16 wireless_media_time; /* uSecs */
1489 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1493 * For non-agg: frame status TX_STATUS_*
1494 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1495 * fields follow this one, up to frame_count.
1497 * 11- 0: AGG_TX_STATE_* status code
1498 * 15-12: Retry count for 1st frame in aggregation (retries
1499 * occur if tx failed for this frame when it was a
1500 * member of a previous aggregation block). If rate
1501 * scaling is used, retry count indicates the rate
1502 * table entry used for all frames in the new agg.
1503 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1507 struct agg_tx_status agg_status[0]; /* for each agg frame */
1509 } __attribute__ ((packed));
1512 * definitions for initial rate index field
1513 * bits [3:0] initial rate index
1514 * bits [6:4] rate table color, used for the initial rate
1515 * bit-7 invalid rate indication
1516 * i.e. rate was not chosen from rate table
1517 * or rate table color was changed during frame retries
1518 * refer tlc rate info
1521 #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1522 #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1523 #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1524 #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1525 #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1527 /* refer to ra_tid */
1528 #define IWL50_TX_RES_TID_POS 0
1529 #define IWL50_TX_RES_TID_MSK 0x0f
1530 #define IWL50_TX_RES_RA_POS 4
1531 #define IWL50_TX_RES_RA_MSK 0xf0
1533 struct iwl5000_tx_resp {
1534 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1535 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1536 u8 failure_rts; /* # failures due to unsuccessful RTS */
1537 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1539 /* For non-agg: Rate at which frame was successful.
1540 * For agg: Rate at which all frames were transmitted. */
1541 __le32 rate_n_flags; /* RATE_MCS_* */
1543 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1544 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1545 __le16 wireless_media_time; /* uSecs */
1547 u8 pa_status; /* RF power amplifier measurement (not used) */
1548 u8 pa_integ_res_a[3];
1549 u8 pa_integ_res_b[3];
1550 u8 pa_integ_res_C[3];
1556 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1559 * For non-agg: frame status TX_STATUS_*
1560 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1561 * fields follow this one, up to frame_count.
1563 * 11- 0: AGG_TX_STATE_* status code
1564 * 15-12: Retry count for 1st frame in aggregation (retries
1565 * occur if tx failed for this frame when it was a
1566 * member of a previous aggregation block). If rate
1567 * scaling is used, retry count indicates the rate
1568 * table entry used for all frames in the new agg.
1569 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1571 struct agg_tx_status status; /* TX status (in aggregation -
1572 * status of 1st frame) */
1573 } __attribute__ ((packed));
1575 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1577 * Reports Block-Acknowledge from recipient station
1579 struct iwl_compressed_ba_resp {
1580 __le32 sta_addr_lo32;
1581 __le16 sta_addr_hi16;
1584 /* Index of recipient (BA-sending) station in uCode's station table */
1591 } __attribute__ ((packed));
1594 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1596 * See details under "TXPOWER" in iwl-4965-hw.h.
1598 struct iwl4965_txpowertable_cmd {
1599 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1602 struct iwl4965_tx_power_db tx_power;
1603 } __attribute__ ((packed));
1605 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1606 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1608 /* # of EDCA prioritized tx fifos */
1609 #define LINK_QUAL_AC_NUM AC_NUM
1611 /* # entries in rate scale table to support Tx retries */
1612 #define LINK_QUAL_MAX_RETRY_NUM 16
1614 /* Tx antenna selection values */
1615 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1616 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1617 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1621 * struct iwl_link_qual_general_params
1623 * Used in REPLY_TX_LINK_QUALITY_CMD
1625 struct iwl_link_qual_general_params {
1628 /* No entries at or above this (driver chosen) index contain MIMO */
1631 /* Best single antenna to use for single stream (legacy, SISO). */
1632 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1634 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1635 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1638 * If driver needs to use different initial rates for different
1639 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1640 * this table will set that up, by indicating the indexes in the
1641 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1642 * Otherwise, driver should set all entries to 0.
1645 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1646 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1648 u8 start_rate_index[LINK_QUAL_AC_NUM];
1649 } __attribute__ ((packed));
1652 * struct iwl_link_qual_agg_params
1654 * Used in REPLY_TX_LINK_QUALITY_CMD
1656 struct iwl_link_qual_agg_params {
1658 /* Maximum number of uSec in aggregation.
1659 * Driver should set this to 4000 (4 milliseconds). */
1660 __le16 agg_time_limit;
1663 * Number of Tx retries allowed for a frame, before that frame will
1664 * no longer be considered for the start of an aggregation sequence
1665 * (scheduler will then try to tx it as single frame).
1666 * Driver should set this to 3.
1668 u8 agg_dis_start_th;
1671 * Maximum number of frames in aggregation.
1672 * 0 = no limit (default). 1 = no aggregation.
1673 * Other values = max # frames in aggregation.
1675 u8 agg_frame_cnt_limit;
1678 } __attribute__ ((packed));
1681 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1683 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1685 * Each station in the 4965's internal station table has its own table of 16
1686 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1687 * an ACK is not received. This command replaces the entire table for
1690 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1692 * The rate scaling procedures described below work well. Of course, other
1693 * procedures are possible, and may work better for particular environments.
1696 * FILLING THE RATE TABLE
1698 * Given a particular initial rate and mode, as determined by the rate
1699 * scaling algorithm described below, the Linux driver uses the following
1700 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1701 * Link Quality command:
1704 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1705 * a) Use this same initial rate for first 3 entries.
1706 * b) Find next lower available rate using same mode (SISO or MIMO),
1707 * use for next 3 entries. If no lower rate available, switch to
1708 * legacy mode (no FAT channel, no MIMO, no short guard interval).
1709 * c) If using MIMO, set command's mimo_delimiter to number of entries
1710 * using MIMO (3 or 6).
1711 * d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1712 * no MIMO, no short guard interval), at the next lower bit rate
1713 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1714 * legacy procedure for remaining table entries.
1716 * 2) If using legacy initial rate:
1717 * a) Use the initial rate for only one entry.
1718 * b) For each following entry, reduce the rate to next lower available
1719 * rate, until reaching the lowest available rate.
1720 * c) When reducing rate, also switch antenna selection.
1721 * d) Once lowest available rate is reached, repeat this rate until
1722 * rate table is filled (16 entries), switching antenna each entry.
1725 * ACCUMULATING HISTORY
1727 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1728 * two sets of frame Tx success history: One for the current/active modulation
1729 * mode, and one for a speculative/search mode that is being attempted. If the
1730 * speculative mode turns out to be more effective (i.e. actual transfer
1731 * rate is better), then the driver continues to use the speculative mode
1732 * as the new current active mode.
1734 * Each history set contains, separately for each possible rate, data for a
1735 * sliding window of the 62 most recent tx attempts at that rate. The data
1736 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1737 * and attempted frames, from which the driver can additionally calculate a
1738 * success ratio (success / attempted) and number of failures
1739 * (attempted - success), and control the size of the window (attempted).
1740 * The driver uses the bit map to remove successes from the success sum, as
1741 * the oldest tx attempts fall out of the window.
1743 * When the 4965 makes multiple tx attempts for a given frame, each attempt
1744 * might be at a different rate, and have different modulation characteristics
1745 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
1746 * scaling table in the Link Quality command. The driver must determine
1747 * which rate table entry was used for each tx attempt, to determine which
1748 * rate-specific history to update, and record only those attempts that
1749 * match the modulation characteristics of the history set.
1751 * When using block-ack (aggregation), all frames are transmitted at the same
1752 * rate, since there is no per-attempt acknowledgment from the destination
1753 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1754 * rate_n_flags field. After receiving a block-ack, the driver can update
1755 * history for the entire block all at once.
1758 * FINDING BEST STARTING RATE:
1760 * When working with a selected initial modulation mode (see below), the
1761 * driver attempts to find a best initial rate. The initial rate is the
1762 * first entry in the Link Quality command's rate table.
1764 * 1) Calculate actual throughput (success ratio * expected throughput, see
1765 * table below) for current initial rate. Do this only if enough frames
1766 * have been attempted to make the value meaningful: at least 6 failed
1767 * tx attempts, or at least 8 successes. If not enough, don't try rate
1770 * 2) Find available rates adjacent to current initial rate. Available means:
1771 * a) supported by hardware &&
1772 * b) supported by association &&
1773 * c) within any constraints selected by user
1775 * 3) Gather measured throughputs for adjacent rates. These might not have
1776 * enough history to calculate a throughput. That's okay, we might try
1777 * using one of them anyway!
1779 * 4) Try decreasing rate if, for current rate:
1780 * a) success ratio is < 15% ||
1781 * b) lower adjacent rate has better measured throughput ||
1782 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1784 * As a sanity check, if decrease was determined above, leave rate
1786 * a) lower rate unavailable
1787 * b) success ratio at current rate > 85% (very good)
1788 * c) current measured throughput is better than expected throughput
1789 * of lower rate (under perfect 100% tx conditions, see table below)
1791 * 5) Try increasing rate if, for current rate:
1792 * a) success ratio is < 15% ||
1793 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1794 * b) higher adjacent rate has better measured throughput ||
1795 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1797 * As a sanity check, if increase was determined above, leave rate
1799 * a) success ratio at current rate < 70%. This is not particularly
1800 * good performance; higher rate is sure to have poorer success.
1802 * 6) Re-evaluate the rate after each tx frame. If working with block-
1803 * acknowledge, history and statistics may be calculated for the entire
1804 * block (including prior history that fits within the history windows),
1805 * before re-evaluation.
1807 * FINDING BEST STARTING MODULATION MODE:
1809 * After working with a modulation mode for a "while" (and doing rate scaling),
1810 * the driver searches for a new initial mode in an attempt to improve
1811 * throughput. The "while" is measured by numbers of attempted frames:
1813 * For legacy mode, search for new mode after:
1814 * 480 successful frames, or 160 failed frames
1815 * For high-throughput modes (SISO or MIMO), search for new mode after:
1816 * 4500 successful frames, or 400 failed frames
1818 * Mode switch possibilities are (3 for each mode):
1821 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1823 * Change antenna, try MIMO, try shortened guard interval (SGI)
1825 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1827 * When trying a new mode, use the same bit rate as the old/current mode when
1828 * trying antenna switches and shortened guard interval. When switching to
1829 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1830 * for which the expected throughput (under perfect conditions) is about the
1831 * same or slightly better than the actual measured throughput delivered by
1832 * the old/current mode.
1834 * Actual throughput can be estimated by multiplying the expected throughput
1835 * by the success ratio (successful / attempted tx frames). Frame size is
1836 * not considered in this calculation; it assumes that frame size will average
1837 * out to be fairly consistent over several samples. The following are
1838 * metric values for expected throughput assuming 100% success ratio.
1839 * Only G band has support for CCK rates:
1841 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1843 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1844 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1845 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1846 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1847 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1848 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1849 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1850 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1851 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1852 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1854 * After the new mode has been tried for a short while (minimum of 6 failed
1855 * frames or 8 successful frames), compare success ratio and actual throughput
1856 * estimate of the new mode with the old. If either is better with the new
1857 * mode, continue to use the new mode.
1859 * Continue comparing modes until all 3 possibilities have been tried.
1860 * If moving from legacy to HT, try all 3 possibilities from the new HT
1861 * mode. After trying all 3, a best mode is found. Continue to use this mode
1862 * for the longer "while" described above (e.g. 480 successful frames for
1863 * legacy), and then repeat the search process.
1866 struct iwl_link_quality_cmd {
1868 /* Index of destination/recipient station in uCode's station table */
1871 __le16 control; /* not used */
1872 struct iwl_link_qual_general_params general_params;
1873 struct iwl_link_qual_agg_params agg_params;
1876 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1877 * specifies 1st Tx rate attempted, via index into this table.
1878 * 4965 works its way through table when retrying Tx.
1881 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1882 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1884 } __attribute__ ((packed));
1887 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1889 * 3945 and 4965 support hardware handshake with Bluetooth device on
1890 * same platform. Bluetooth device alerts wireless device when it will Tx;
1891 * wireless device can delay or kill its own Tx to accommodate.
1898 __le32 kill_ack_mask;
1899 __le32 kill_cts_mask;
1900 } __attribute__ ((packed));
1902 /******************************************************************************
1904 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1906 *****************************************************************************/
1909 * Spectrum Management
1911 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1912 RXON_FILTER_CTL2HOST_MSK | \
1913 RXON_FILTER_ACCEPT_GRP_MSK | \
1914 RXON_FILTER_DIS_DECRYPT_MSK | \
1915 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1916 RXON_FILTER_ASSOC_MSK | \
1917 RXON_FILTER_BCON_AWARE_MSK)
1919 struct iwl_measure_channel {
1920 __le32 duration; /* measurement duration in extended beacon
1922 u8 channel; /* channel to measure */
1923 u8 type; /* see enum iwl_measure_type */
1925 } __attribute__ ((packed));
1928 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1930 struct iwl_spectrum_cmd {
1931 __le16 len; /* number of bytes starting from token */
1932 u8 token; /* token id */
1933 u8 id; /* measurement id -- 0 or 1 */
1934 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1935 u8 periodic; /* 1 = periodic */
1936 __le16 path_loss_timeout;
1937 __le32 start_time; /* start time in extended beacon format */
1939 __le32 flags; /* rxon flags */
1940 __le32 filter_flags; /* rxon filter flags */
1941 __le16 channel_count; /* minimum 1, maximum 10 */
1943 struct iwl_measure_channel channels[10];
1944 } __attribute__ ((packed));
1947 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1949 struct iwl_spectrum_resp {
1951 u8 id; /* id of the prior command replaced, or 0xff */
1952 __le16 status; /* 0 - command will be handled
1953 * 1 - cannot handle (conflicts with another
1955 } __attribute__ ((packed));
1957 enum iwl_measurement_state {
1958 IWL_MEASUREMENT_START = 0,
1959 IWL_MEASUREMENT_STOP = 1,
1962 enum iwl_measurement_status {
1963 IWL_MEASUREMENT_OK = 0,
1964 IWL_MEASUREMENT_CONCURRENT = 1,
1965 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1966 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1968 IWL_MEASUREMENT_STOPPED = 6,
1969 IWL_MEASUREMENT_TIMEOUT = 7,
1970 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1973 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1975 struct iwl_measurement_histogram {
1976 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1977 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1978 } __attribute__ ((packed));
1980 /* clear channel availability counters */
1981 struct iwl_measurement_cca_counters {
1984 } __attribute__ ((packed));
1986 enum iwl_measure_type {
1987 IWL_MEASURE_BASIC = (1 << 0),
1988 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1989 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1990 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1991 IWL_MEASURE_FRAME = (1 << 4),
1992 /* bits 5:6 are reserved */
1993 IWL_MEASURE_IDLE = (1 << 7),
1997 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1999 struct iwl_spectrum_notification {
2000 u8 id; /* measurement id -- 0 or 1 */
2002 u8 channel_index; /* index in measurement channel list */
2003 u8 state; /* 0 - start, 1 - stop */
2004 __le32 start_time; /* lower 32-bits of TSF */
2005 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
2007 u8 type; /* see enum iwl_measurement_type */
2009 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2010 * valid if applicable for measurement type requested. */
2011 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2012 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2013 __le32 cca_time; /* channel load time in usecs */
2014 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2017 struct iwl_measurement_histogram histogram;
2018 __le32 stop_time; /* lower 32-bits of TSF */
2019 __le32 status; /* see iwl_measurement_status */
2020 } __attribute__ ((packed));
2022 /******************************************************************************
2024 * Power Management Commands, Responses, Notifications:
2026 *****************************************************************************/
2029 * struct iwl_powertable_cmd - Power Table Command
2030 * @flags: See below:
2032 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2035 * bit 0 - '0' Driver not allow power management
2036 * '1' Driver allow PM (use rest of parameters)
2037 * uCode send sleep notifications:
2038 * bit 1 - '0' Don't send sleep notification
2039 * '1' send sleep notification (SEND_PM_NOTIFICATION)
2041 * bit 2 - '0' PM have to walk up every DTIM
2042 * '1' PM could sleep over DTIM till listen Interval.
2044 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2045 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
2047 * bit 31/30- '00' use both mac/xtal sleeps
2048 * '01' force Mac sleep
2049 * '10' force xtal sleep
2052 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2053 * ucode assume sleep over DTIM is allowed and we don't need to wake up
2056 #define IWL_POWER_VEC_SIZE 5
2058 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
2059 #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2060 #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2061 #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
2063 struct iwl3945_powertable_cmd {
2066 __le32 rx_data_timeout;
2067 __le32 tx_data_timeout;
2068 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2069 } __attribute__ ((packed));
2071 struct iwl_powertable_cmd {
2073 u8 keep_alive_seconds; /* 3945 reserved */
2074 u8 debug_flags; /* 3945 reserved */
2075 __le32 rx_data_timeout;
2076 __le32 tx_data_timeout;
2077 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2078 __le32 keep_alive_beacons;
2079 } __attribute__ ((packed));
2082 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2083 * 3945 and 4965 identical.
2085 struct iwl_sleep_notification {
2092 } __attribute__ ((packed));
2094 /* Sleep states. 3945 and 4965 identical. */
2096 IWL_PM_NO_SLEEP = 0,
2098 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2099 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2101 IWL_PM_SLP_REPENT = 5,
2102 IWL_PM_WAKEUP_BY_TIMER = 6,
2103 IWL_PM_WAKEUP_BY_DRIVER = 7,
2104 IWL_PM_WAKEUP_BY_RFKILL = 8,
2106 IWL_PM_NUM_OF_MODES = 12,
2110 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2112 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2113 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2114 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
2115 struct iwl_card_state_cmd {
2116 __le32 status; /* CARD_STATE_CMD_* request new power state */
2117 } __attribute__ ((packed));
2120 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2122 struct iwl_card_state_notif {
2124 } __attribute__ ((packed));
2126 #define HW_CARD_DISABLED 0x01
2127 #define SW_CARD_DISABLED 0x02
2128 #define RF_CARD_DISABLED 0x04
2129 #define RXON_CARD_DISABLED 0x10
2131 struct iwl_ct_kill_config {
2133 __le32 critical_temperature_M;
2134 __le32 critical_temperature_R;
2135 } __attribute__ ((packed));
2137 /******************************************************************************
2139 * Scan Commands, Responses, Notifications:
2141 *****************************************************************************/
2143 #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2144 #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
2147 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2149 * One for each channel in the scan list.
2150 * Each channel can independently select:
2151 * 1) SSID for directed active scans
2152 * 2) Txpower setting (for rate specified within Tx command)
2153 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2154 * quiet_plcp_th, good_CRC_th)
2156 * To avoid uCode errors, make sure the following are true (see comments
2157 * under struct iwl_scan_cmd about max_out_time and quiet_time):
2158 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2159 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2160 * 2) quiet_time <= active_dwell
2161 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2162 * passive_dwell < max_out_time
2163 * active_dwell < max_out_time
2165 struct iwl_scan_channel {
2167 * type is defined as:
2168 * 0:0 1 = active, 0 = passive
2169 * 1:20 SSID direct bit map; if a bit is set, then corresponding
2170 * SSID IE is transmitted in probe request.
2174 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2175 u8 tx_gain; /* gain for analog radio */
2176 u8 dsp_atten; /* gain for DSP */
2177 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2178 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2179 } __attribute__ ((packed));
2182 * struct iwl_ssid_ie - directed scan network information element
2184 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
2185 * in struct iwl_scan_channel; each channel may select different ssids from
2186 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
2188 struct iwl_ssid_ie {
2192 } __attribute__ ((packed));
2194 #define PROBE_OPTION_MAX_API1 0x4
2195 #define PROBE_OPTION_MAX 0x14
2196 #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
2197 #define IWL_GOOD_CRC_TH cpu_to_le16(1)
2198 #define IWL_MAX_SCAN_SIZE 1024
2201 * REPLY_SCAN_CMD = 0x80 (command)
2203 * The hardware scan command is very powerful; the driver can set it up to
2204 * maintain (relatively) normal network traffic while doing a scan in the
2205 * background. The max_out_time and suspend_time control the ratio of how
2206 * long the device stays on an associated network channel ("service channel")
2207 * vs. how long it's away from the service channel, i.e. tuned to other channels
2210 * max_out_time is the max time off-channel (in usec), and suspend_time
2211 * is how long (in "extended beacon" format) that the scan is "suspended"
2212 * after returning to the service channel. That is, suspend_time is the
2213 * time that we stay on the service channel, doing normal work, between
2214 * scan segments. The driver may set these parameters differently to support
2215 * scanning when associated vs. not associated, and light vs. heavy traffic
2216 * loads when associated.
2218 * After receiving this command, the device's scan engine does the following;
2220 * 1) Sends SCAN_START notification to driver
2221 * 2) Checks to see if it has time to do scan for one channel
2222 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2223 * to tell AP that we're going off-channel
2224 * 4) Tunes to first channel in scan list, does active or passive scan
2225 * 5) Sends SCAN_RESULT notification to driver
2226 * 6) Checks to see if it has time to do scan on *next* channel in list
2227 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2228 * before max_out_time expires
2229 * 8) Returns to service channel
2230 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2231 * 10) Stays on service channel until suspend_time expires
2232 * 11) Repeats entire process 2-10 until list is complete
2233 * 12) Sends SCAN_COMPLETE notification
2235 * For fast, efficient scans, the scan command also has support for staying on
2236 * a channel for just a short time, if doing active scanning and getting no
2237 * responses to the transmitted probe request. This time is controlled by
2238 * quiet_time, and the number of received packets below which a channel is
2239 * considered "quiet" is controlled by quiet_plcp_threshold.
2241 * For active scanning on channels that have regulatory restrictions against
2242 * blindly transmitting, the scan can listen before transmitting, to make sure
2243 * that there is already legitimate activity on the channel. If enough
2244 * packets are cleanly received on the channel (controlled by good_CRC_th,
2245 * typical value 1), the scan engine starts transmitting probe requests.
2247 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2249 * To avoid uCode errors, see timing restrictions described under
2250 * struct iwl_scan_channel.
2252 struct iwl_scan_cmd {
2255 u8 channel_count; /* # channels in channel list */
2256 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2257 * (only for active scan) */
2258 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2259 __le16 good_CRC_th; /* passive -> active promotion threshold */
2260 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2261 __le32 max_out_time; /* max usec to be away from associated (service)
2263 __le32 suspend_time; /* pause scan this long (in "extended beacon
2264 * format") when returning to service chnl:
2265 * 3945; 31:24 # beacons, 19:0 additional usec,
2266 * 4965; 31:22 # beacons, 21:0 additional usec.
2268 __le32 flags; /* RXON_FLG_* */
2269 __le32 filter_flags; /* RXON_FILTER_* */
2271 /* For active scans (set to all-0s for passive scans).
2272 * Does not include payload. Must specify Tx rate; no rate scaling. */
2273 struct iwl_tx_cmd tx_cmd;
2275 /* For directed active scans (set to all-0s otherwise) */
2276 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2279 * Probe request frame, followed by channel list.
2281 * Size of probe request frame is specified by byte count in tx_cmd.
2282 * Channel list follows immediately after probe request frame.
2283 * Number of channels in list is specified by channel_count.
2284 * Each channel in list is of type:
2286 * struct iwl_scan_channel channels[0];
2288 * NOTE: Only one band of channels can be scanned per pass. You
2289 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2290 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2291 * before requesting another scan.
2294 } __attribute__ ((packed));
2296 /* Can abort will notify by complete notification with abort status. */
2297 #define CAN_ABORT_STATUS cpu_to_le32(0x1)
2298 /* complete notification statuses */
2299 #define ABORT_STATUS 0x2
2302 * REPLY_SCAN_CMD = 0x80 (response)
2304 struct iwl_scanreq_notification {
2305 __le32 status; /* 1: okay, 2: cannot fulfill request */
2306 } __attribute__ ((packed));
2309 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2311 struct iwl_scanstart_notification {
2314 __le32 beacon_timer;
2319 } __attribute__ ((packed));
2321 #define SCAN_OWNER_STATUS 0x1;
2322 #define MEASURE_OWNER_STATUS 0x2;
2324 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2326 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2328 struct iwl_scanresults_notification {
2334 __le32 statistics[NUMBER_OF_STATISTICS];
2335 } __attribute__ ((packed));
2338 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2340 struct iwl_scancomplete_notification {
2341 u8 scanned_channels;
2347 } __attribute__ ((packed));
2350 /******************************************************************************
2352 * IBSS/AP Commands and Notifications:
2354 *****************************************************************************/
2357 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2359 struct iwl4965_beacon_notif {
2360 struct iwl4965_tx_resp beacon_notify_hdr;
2363 __le32 ibss_mgr_status;
2364 } __attribute__ ((packed));
2367 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2369 struct iwl_tx_beacon_cmd {
2370 struct iwl_tx_cmd tx;
2374 struct ieee80211_hdr frame[0]; /* beacon frame */
2375 } __attribute__ ((packed));
2377 /******************************************************************************
2379 * Statistics Commands and Notifications:
2381 *****************************************************************************/
2383 #define IWL_TEMP_CONVERT 260
2385 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2386 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2387 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2389 /* Used for passing to driver number of successes and failures per rate */
2390 struct rate_histogram {
2392 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2393 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2394 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2397 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2398 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2399 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2401 } __attribute__ ((packed));
2403 /* statistics command response */
2405 struct statistics_rx_phy {
2411 __le32 early_overrun_err;
2413 __le32 false_alarm_cnt;
2414 __le32 fina_sync_err_cnt;
2416 __le32 fina_timeout;
2417 __le32 unresponded_rts;
2418 __le32 rxe_frame_limit_overrun;
2419 __le32 sent_ack_cnt;
2420 __le32 sent_cts_cnt;
2421 __le32 sent_ba_rsp_cnt;
2422 __le32 dsp_self_kill;
2423 __le32 mh_format_err;
2424 __le32 re_acq_main_rssi_sum;
2426 } __attribute__ ((packed));
2428 struct statistics_rx_ht_phy {
2431 __le32 early_overrun_err;
2434 __le32 mh_format_err;
2435 __le32 agg_crc32_good;
2436 __le32 agg_mpdu_cnt;
2439 } __attribute__ ((packed));
2441 #define INTERFERENCE_DATA_AVAILABLE __constant_cpu_to_le32(1)
2443 struct statistics_rx_non_phy {
2444 __le32 bogus_cts; /* CTS received when not expecting CTS */
2445 __le32 bogus_ack; /* ACK received when not expecting ACK */
2446 __le32 non_bssid_frames; /* number of frames with BSSID that
2447 * doesn't belong to the STA BSSID */
2448 __le32 filtered_frames; /* count frames that were dumped in the
2449 * filtering process */
2450 __le32 non_channel_beacons; /* beacons with our bss id but not on
2451 * our serving channel */
2452 __le32 channel_beacons; /* beacons with our bss id and in our
2453 * serving channel */
2454 __le32 num_missed_bcon; /* number of missed beacons */
2455 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2456 * ADC was in saturation */
2457 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2459 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2460 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2461 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2462 __le32 interference_data_flag; /* flag for interference data
2463 * availability. 1 when data is
2465 __le32 channel_load; /* counts RX Enable time in uSec */
2466 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2467 * and CCK) counter */
2468 __le32 beacon_rssi_a;
2469 __le32 beacon_rssi_b;
2470 __le32 beacon_rssi_c;
2471 __le32 beacon_energy_a;
2472 __le32 beacon_energy_b;
2473 __le32 beacon_energy_c;
2474 } __attribute__ ((packed));
2476 struct statistics_rx {
2477 struct statistics_rx_phy ofdm;
2478 struct statistics_rx_phy cck;
2479 struct statistics_rx_non_phy general;
2480 struct statistics_rx_ht_phy ofdm_ht;
2481 } __attribute__ ((packed));
2483 struct statistics_tx_non_phy_agg {
2485 __le32 ba_reschedule_frames;
2486 __le32 scd_query_agg_frame_cnt;
2487 __le32 scd_query_no_agg;
2488 __le32 scd_query_agg;
2489 __le32 scd_query_mismatch;
2490 __le32 frame_not_ready;
2492 __le32 bt_prio_kill;
2493 __le32 rx_ba_rsp_cnt;
2496 } __attribute__ ((packed));
2498 struct statistics_tx {
2499 __le32 preamble_cnt;
2500 __le32 rx_detected_cnt;
2501 __le32 bt_prio_defer_cnt;
2502 __le32 bt_prio_kill_cnt;
2503 __le32 few_bytes_cnt;
2506 __le32 expected_ack_cnt;
2507 __le32 actual_ack_cnt;
2508 __le32 dump_msdu_cnt;
2509 __le32 burst_abort_next_frame_mismatch_cnt;
2510 __le32 burst_abort_missing_next_frame_cnt;
2511 __le32 cts_timeout_collision;
2512 __le32 ack_or_ba_timeout_collision;
2513 struct statistics_tx_non_phy_agg agg;
2514 } __attribute__ ((packed));
2516 struct statistics_dbg {
2520 } __attribute__ ((packed));
2522 struct statistics_div {
2529 } __attribute__ ((packed));
2531 struct statistics_general {
2533 __le32 temperature_m;
2534 struct statistics_dbg dbg;
2538 __le32 ttl_timestamp;
2539 struct statistics_div div;
2540 __le32 rx_enable_counter;
2544 } __attribute__ ((packed));
2547 * REPLY_STATISTICS_CMD = 0x9c,
2548 * 3945 and 4965 identical.
2550 * This command triggers an immediate response containing uCode statistics.
2551 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2553 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2554 * internal copy of the statistics (counters) after issuing the response.
2555 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2557 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2558 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2559 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2561 #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
2562 #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
2563 struct iwl_statistics_cmd {
2564 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2565 } __attribute__ ((packed));
2568 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2570 * By default, uCode issues this notification after receiving a beacon
2571 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2572 * REPLY_STATISTICS_CMD 0x9c, above.
2574 * Statistics counters continue to increment beacon after beacon, but are
2575 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2576 * 0x9c with CLEAR_STATS bit set (see above).
2578 * uCode also issues this notification during scans. uCode clears statistics
2579 * appropriately so that each notification contains statistics for only the
2580 * one channel that has just been scanned.
2582 #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
2583 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK cpu_to_le32(0x8)
2584 struct iwl_notif_statistics {
2586 struct statistics_rx rx;
2587 struct statistics_tx tx;
2588 struct statistics_general general;
2589 } __attribute__ ((packed));
2593 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2595 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2596 * then this notification will be sent. */
2597 #define CONSECUTIVE_MISSED_BCONS_TH 20
2599 struct iwl_missed_beacon_notif {
2600 __le32 consequtive_missed_beacons;
2601 __le32 total_missed_becons;
2602 __le32 num_expected_beacons;
2603 __le32 num_recvd_beacons;
2604 } __attribute__ ((packed));
2607 /******************************************************************************
2609 * Rx Calibration Commands:
2611 * With the uCode used for open source drivers, most Tx calibration (except
2612 * for Tx Power) and most Rx calibration is done by uCode during the
2613 * "initialize" phase of uCode boot. Driver must calibrate only:
2615 * 1) Tx power (depends on temperature), described elsewhere
2616 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2617 * 3) Receiver sensitivity (to optimize signal detection)
2619 *****************************************************************************/
2622 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2624 * This command sets up the Rx signal detector for a sensitivity level that
2625 * is high enough to lock onto all signals within the associated network,
2626 * but low enough to ignore signals that are below a certain threshold, so as
2627 * not to have too many "false alarms". False alarms are signals that the
2628 * Rx DSP tries to lock onto, but then discards after determining that they
2631 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2632 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2633 * time listening, not transmitting). Driver must adjust sensitivity so that
2634 * the ratio of actual false alarms to actual Rx time falls within this range.
2636 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2637 * received beacon. These provide information to the driver to analyze the
2638 * sensitivity. Don't analyze statistics that come in from scanning, or any
2639 * other non-associated-network source. Pertinent statistics include:
2641 * From "general" statistics (struct statistics_rx_non_phy):
2643 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2644 * Measure of energy of desired signal. Used for establishing a level
2645 * below which the device does not detect signals.
2647 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2648 * Measure of background noise in silent period after beacon.
2651 * uSecs of actual Rx time during beacon period (varies according to
2652 * how much time was spent transmitting).
2654 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2657 * Signal locks abandoned early (before phy-level header).
2660 * Signal locks abandoned late (during phy-level header).
2662 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2663 * beacon to beacon, i.e. each value is an accumulation of all errors
2664 * before and including the latest beacon. Values will wrap around to 0
2665 * after counting up to 2^32 - 1. Driver must differentiate vs.
2666 * previous beacon's values to determine # false alarms in the current
2669 * Total number of false alarms = false_alarms + plcp_errs
2671 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2672 * (notice that the start points for OFDM are at or close to settings for
2673 * maximum sensitivity):
2676 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2677 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2678 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2679 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2681 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2682 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2683 * by *adding* 1 to all 4 of the table entries above, up to the max for
2684 * each entry. Conversely, if false alarm rate is too low (less than 5
2685 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2686 * increase sensitivity.
2688 * For CCK sensitivity, keep track of the following:
2690 * 1). 20-beacon history of maximum background noise, indicated by
2691 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2692 * 3 receivers. For any given beacon, the "silence reference" is
2693 * the maximum of last 60 samples (20 beacons * 3 receivers).
2695 * 2). 10-beacon history of strongest signal level, as indicated
2696 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2697 * i.e. the strength of the signal through the best receiver at the
2698 * moment. These measurements are "upside down", with lower values
2699 * for stronger signals, so max energy will be *minimum* value.
2701 * Then for any given beacon, the driver must determine the *weakest*
2702 * of the strongest signals; this is the minimum level that needs to be
2703 * successfully detected, when using the best receiver at the moment.
2704 * "Max cck energy" is the maximum (higher value means lower energy!)
2705 * of the last 10 minima. Once this is determined, driver must add
2706 * a little margin by adding "6" to it.
2708 * 3). Number of consecutive beacon periods with too few false alarms.
2709 * Reset this to 0 at the first beacon period that falls within the
2710 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2712 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2713 * (notice that the start points for CCK are at maximum sensitivity):
2716 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2717 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2718 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2720 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2721 * (greater than 50 for each 204.8 msecs listening), method for reducing
2724 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2727 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2728 * sensitivity has been reduced a significant amount; bring it up to
2729 * a moderate 161. Otherwise, *add* 3, up to max 200.
2731 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2732 * sensitivity has been reduced only a moderate or small amount;
2733 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2734 * down to min 0. Otherwise (if gain has been significantly reduced),
2735 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2737 * b) Save a snapshot of the "silence reference".
2739 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2740 * (less than 5 for each 204.8 msecs listening), method for increasing
2741 * sensitivity is used only if:
2743 * 1a) Previous beacon did not have too many false alarms
2744 * 1b) AND difference between previous "silence reference" and current
2745 * "silence reference" (prev - current) is 2 or more,
2746 * OR 2) 100 or more consecutive beacon periods have had rate of
2747 * less than 5 false alarms per 204.8 milliseconds rx time.
2749 * Method for increasing sensitivity:
2751 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2754 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2757 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2759 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
2760 * (between 5 and 50 for each 204.8 msecs listening):
2762 * 1) Save a snapshot of the silence reference.
2764 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2765 * give some extra margin to energy threshold by *subtracting* 8
2766 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2768 * For all cases (too few, too many, good range), make sure that the CCK
2769 * detection threshold (energy) is below the energy level for robust
2770 * detection over the past 10 beacon periods, the "Max cck energy".
2771 * Lower values mean higher energy; this means making sure that the value
2772 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2774 * Driver should set the following entries to fixed values:
2776 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
2777 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2778 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2779 * HD_OFDM_ENERGY_TH_IN_INDEX 62
2783 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
2785 #define HD_TABLE_SIZE (11) /* number of entries */
2786 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2787 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2788 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2789 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2790 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2791 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2792 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2793 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2794 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2795 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2796 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2798 /* Control field in struct iwl_sensitivity_cmd */
2799 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
2800 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
2803 * struct iwl_sensitivity_cmd
2804 * @control: (1) updates working table, (0) updates default table
2805 * @table: energy threshold values, use HD_* as index into table
2807 * Always use "1" in "control" to update uCode's working table and DSP.
2809 struct iwl_sensitivity_cmd {
2810 __le16 control; /* always use "1" */
2811 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2812 } __attribute__ ((packed));
2816 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2818 * This command sets the relative gains of 4965's 3 radio receiver chains.
2820 * After the first association, driver should accumulate signal and noise
2821 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2822 * beacons from the associated network (don't collect statistics that come
2823 * in from scanning, or any other non-network source).
2825 * DISCONNECTED ANTENNA:
2827 * Driver should determine which antennas are actually connected, by comparing
2828 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2829 * following values over 20 beacons, one accumulator for each of the chains
2830 * a/b/c, from struct statistics_rx_non_phy:
2832 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2834 * Find the strongest signal from among a/b/c. Compare the other two to the
2835 * strongest. If any signal is more than 15 dB (times 20, unless you
2836 * divide the accumulated values by 20) below the strongest, the driver
2837 * considers that antenna to be disconnected, and should not try to use that
2838 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2839 * driver should declare the stronger one as connected, and attempt to use it
2840 * (A and B are the only 2 Tx chains!).
2845 * Driver should balance the 3 receivers (but just the ones that are connected
2846 * to antennas, see above) for gain, by comparing the average signal levels
2847 * detected during the silence after each beacon (background noise).
2848 * Accumulate (add) the following values over 20 beacons, one accumulator for
2849 * each of the chains a/b/c, from struct statistics_rx_non_phy:
2851 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2853 * Find the weakest background noise level from among a/b/c. This Rx chain
2854 * will be the reference, with 0 gain adjustment. Attenuate other channels by
2855 * finding noise difference:
2857 * (accum_noise[i] - accum_noise[reference]) / 30
2859 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2860 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2861 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2862 * and set bit 2 to indicate "reduce gain". The value for the reference
2863 * (weakest) chain should be "0".
2865 * diff_gain_[abc] bit fields:
2866 * 2: (1) reduce gain, (0) increase gain
2867 * 1-0: amount of gain, units of 1.5 dB
2870 /* Phy calibration command for series */
2873 IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
2874 IWL_PHY_CALIBRATE_DC_CMD = 8,
2875 IWL_PHY_CALIBRATE_LO_CMD = 9,
2876 IWL_PHY_CALIBRATE_RX_BB_CMD = 10,
2877 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
2878 IWL_PHY_CALIBRATE_RX_IQ_CMD = 12,
2879 IWL_PHY_CALIBRATION_NOISE_CMD = 13,
2880 IWL_PHY_CALIBRATE_AGC_TABLE_CMD = 14,
2881 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
2882 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
2883 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
2884 IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
2885 IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19,
2889 #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
2891 struct iwl_calib_cfg_elmnt_s {
2897 } __attribute__ ((packed));
2899 struct iwl_calib_cfg_status_s {
2900 struct iwl_calib_cfg_elmnt_s once;
2901 struct iwl_calib_cfg_elmnt_s perd;
2903 } __attribute__ ((packed));
2905 struct iwl_calib_cfg_cmd {
2906 struct iwl_calib_cfg_status_s ucd_calib_cfg;
2907 struct iwl_calib_cfg_status_s drv_calib_cfg;
2909 } __attribute__ ((packed));
2911 struct iwl_calib_hdr {
2916 } __attribute__ ((packed));
2918 struct iwl_calib_cmd {
2919 struct iwl_calib_hdr hdr;
2921 } __attribute__ ((packed));
2923 /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2924 struct iwl_calib_diff_gain_cmd {
2925 struct iwl_calib_hdr hdr;
2926 s8 diff_gain_a; /* see above */
2930 } __attribute__ ((packed));
2932 struct iwl_calib_xtal_freq_cmd {
2933 struct iwl_calib_hdr hdr;
2937 } __attribute__ ((packed));
2939 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
2940 struct iwl_calib_chain_noise_reset_cmd {
2941 struct iwl_calib_hdr hdr;
2945 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
2946 struct iwl_calib_chain_noise_gain_cmd {
2947 struct iwl_calib_hdr hdr;
2951 } __attribute__ ((packed));
2953 /******************************************************************************
2955 * Miscellaneous Commands:
2957 *****************************************************************************/
2960 * LEDs Command & Response
2961 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2963 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2964 * this command turns it on or off, or sets up a periodic blinking cycle.
2966 struct iwl_led_cmd {
2967 __le32 interval; /* "interval" in uSec */
2968 u8 id; /* 1: Activity, 2: Link, 3: Tech */
2969 u8 off; /* # intervals off while blinking;
2970 * "0", with >0 "on" value, turns LED on */
2971 u8 on; /* # intervals on while blinking;
2972 * "0", regardless of "off", turns LED off */
2974 } __attribute__ ((packed));
2977 * Coexistence WIFI/WIMAX Command
2978 * COEX_PRIORITY_TABLE_CMD = 0x5a
2982 COEX_UNASSOC_IDLE = 0,
2983 COEX_UNASSOC_MANUAL_SCAN = 1,
2984 COEX_UNASSOC_AUTO_SCAN = 2,
2985 COEX_CALIBRATION = 3,
2986 COEX_PERIODIC_CALIBRATION = 4,
2987 COEX_CONNECTION_ESTAB = 5,
2988 COEX_ASSOCIATED_IDLE = 6,
2989 COEX_ASSOC_MANUAL_SCAN = 7,
2990 COEX_ASSOC_AUTO_SCAN = 8,
2991 COEX_ASSOC_ACTIVE_LEVEL = 9,
2994 COEX_STAND_ALONE_DEBUG = 12,
2995 COEX_IPAN_ASSOC_LEVEL = 13,
2998 COEX_NUM_OF_EVENTS = 16
3001 struct iwl_wimax_coex_event_entry {
3006 } __attribute__ ((packed));
3008 /* COEX flag masks */
3010 /* Station table is valid */
3011 #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
3012 /* UnMask wake up src at unassociated sleep */
3013 #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
3014 /* UnMask wake up src at associated sleep */
3015 #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3016 /* Enable CoEx feature. */
3017 #define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3019 struct iwl_wimax_coex_cmd {
3022 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3023 } __attribute__ ((packed));
3025 /******************************************************************************
3027 * Union of all expected notifications/responses:
3029 *****************************************************************************/
3031 struct iwl_rx_packet {
3033 struct iwl_cmd_header hdr;
3035 struct iwl_alive_resp alive_frame;
3036 struct iwl_spectrum_notification spectrum_notif;
3037 struct iwl_csa_notification csa_notif;
3038 struct iwl_error_resp err_resp;
3039 struct iwl_card_state_notif card_state_notif;
3040 struct iwl_add_sta_resp add_sta;
3041 struct iwl_rem_sta_resp rem_sta;
3042 struct iwl_sleep_notification sleep_notif;
3043 struct iwl_spectrum_resp spectrum;
3044 struct iwl_notif_statistics stats;
3045 struct iwl_compressed_ba_resp compressed_ba;
3046 struct iwl_missed_beacon_notif missed_beacon;
3050 } __attribute__ ((packed));
3052 int iwl_agn_check_rxon_cmd(struct iwl_rxon_cmd *rxon);
3054 #endif /* __iwl_commands_h__ */