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 - 2011 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 - 2011 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-xxxx-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 #include <linux/etherdevice.h>
73 #include <linux/ieee80211.h>
77 /* uCode version contains 4 values: Major/Minor/API/Serial */
78 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
79 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
80 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
81 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
85 #define IWL_CCK_RATES 4
86 #define IWL_OFDM_RATES 8
87 #define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES)
92 REPLY_ECHO = 0x3, /* test command */
94 /* RXON and QOS commands */
96 REPLY_RXON_ASSOC = 0x11,
97 REPLY_QOS_PARAM = 0x13,
98 REPLY_RXON_TIMING = 0x14,
100 /* Multi-Station support */
101 REPLY_ADD_STA = 0x18,
102 REPLY_REMOVE_STA = 0x19,
103 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
104 REPLY_TXFIFO_FLUSH = 0x1e,
111 REPLY_LEDS_CMD = 0x48,
112 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 and up */
114 /* WiMAX coexistence */
115 COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */
116 COEX_MEDIUM_NOTIFICATION = 0x5b,
117 COEX_EVENT_CMD = 0x5c,
120 TEMPERATURE_NOTIFICATION = 0x62,
121 CALIBRATION_CFG_CMD = 0x65,
122 CALIBRATION_RES_NOTIFICATION = 0x66,
123 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
125 /* 802.11h related */
126 REPLY_QUIET_CMD = 0x71, /* not used */
127 REPLY_CHANNEL_SWITCH = 0x72,
128 CHANNEL_SWITCH_NOTIFICATION = 0x73,
129 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
130 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
132 /* Power Management */
133 POWER_TABLE_CMD = 0x77,
134 PM_SLEEP_NOTIFICATION = 0x7A,
135 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
137 /* Scan commands and notifications */
138 REPLY_SCAN_CMD = 0x80,
139 REPLY_SCAN_ABORT_CMD = 0x81,
140 SCAN_START_NOTIFICATION = 0x82,
141 SCAN_RESULTS_NOTIFICATION = 0x83,
142 SCAN_COMPLETE_NOTIFICATION = 0x84,
144 /* IBSS/AP commands */
145 BEACON_NOTIFICATION = 0x90,
146 REPLY_TX_BEACON = 0x91,
147 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
149 /* Miscellaneous commands */
150 REPLY_TX_POWER_DBM_CMD = 0x95,
151 QUIET_NOTIFICATION = 0x96, /* not used */
152 REPLY_TX_PWR_TABLE_CMD = 0x97,
153 REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */
154 TX_ANT_CONFIGURATION_CMD = 0x98,
155 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
157 /* Bluetooth device coexistence config command */
158 REPLY_BT_CONFIG = 0x9b,
161 REPLY_STATISTICS_CMD = 0x9c,
162 STATISTICS_NOTIFICATION = 0x9d,
164 /* RF-KILL commands and notifications */
165 REPLY_CARD_STATE_CMD = 0xa0,
166 CARD_STATE_NOTIFICATION = 0xa1,
168 /* Missed beacons notification */
169 MISSED_BEACONS_NOTIFICATION = 0xa2,
171 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
172 SENSITIVITY_CMD = 0xa8,
173 REPLY_PHY_CALIBRATION_CMD = 0xb0,
174 REPLY_RX_PHY_CMD = 0xc0,
175 REPLY_RX_MPDU_CMD = 0xc1,
177 REPLY_COMPRESSED_BA = 0xc5,
180 REPLY_BT_COEX_PRIO_TABLE = 0xcc,
181 REPLY_BT_COEX_PROT_ENV = 0xcd,
182 REPLY_BT_COEX_PROFILE_NOTIF = 0xce,
185 REPLY_WIPAN_PARAMS = 0xb2,
186 REPLY_WIPAN_RXON = 0xb3, /* use REPLY_RXON structure */
187 REPLY_WIPAN_RXON_TIMING = 0xb4, /* use REPLY_RXON_TIMING structure */
188 REPLY_WIPAN_RXON_ASSOC = 0xb6, /* use REPLY_RXON_ASSOC structure */
189 REPLY_WIPAN_QOS_PARAM = 0xb7, /* use REPLY_QOS_PARAM structure */
190 REPLY_WIPAN_WEPKEY = 0xb8, /* use REPLY_WEPKEY structure */
191 REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9,
192 REPLY_WIPAN_NOA_NOTIFICATION = 0xbc,
193 REPLY_WIPAN_DEACTIVATION_COMPLETE = 0xbd,
195 REPLY_WOWLAN_PATTERNS = 0xe0,
196 REPLY_WOWLAN_WAKEUP_FILTER = 0xe1,
197 REPLY_WOWLAN_TSC_RSC_PARAMS = 0xe2,
198 REPLY_WOWLAN_TKIP_PARAMS = 0xe3,
199 REPLY_WOWLAN_KEK_KCK_MATERIAL = 0xe4,
200 REPLY_WOWLAN_GET_STATUS = 0xe5,
205 /******************************************************************************
207 * Commonly used structures and definitions:
208 * Command header, rate_n_flags, txpower
210 *****************************************************************************/
212 /* iwl_cmd_header flags value */
213 #define IWL_CMD_FAILED_MSK 0x40
215 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
216 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
217 #define SEQ_TO_INDEX(s) ((s) & 0xff)
218 #define INDEX_TO_SEQ(i) ((i) & 0xff)
219 #define SEQ_RX_FRAME cpu_to_le16(0x8000)
222 * struct iwl_cmd_header
224 * This header format appears in the beginning of each command sent from the
225 * driver, and each response/notification received from uCode.
227 struct iwl_cmd_header {
228 u8 cmd; /* Command ID: REPLY_RXON, etc. */
229 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
231 * The driver sets up the sequence number to values of its choosing.
232 * uCode does not use this value, but passes it back to the driver
233 * when sending the response to each driver-originated command, so
234 * the driver can match the response to the command. Since the values
235 * don't get used by uCode, the driver may set up an arbitrary format.
237 * There is one exception: uCode sets bit 15 when it originates
238 * the response/notification, i.e. when the response/notification
239 * is not a direct response to a command sent by the driver. For
240 * example, uCode issues REPLY_RX when it sends a received frame
241 * to the driver; it is not a direct response to any driver command.
243 * The Linux driver uses the following format:
245 * 0:7 tfd index - position within TX queue
248 * 15 unsolicited RX or uCode-originated notification
252 /* command or response/notification data follows immediately */
258 * iwlagn rate_n_flags bit fields
260 * rate_n_flags format is used in following iwlagn commands:
261 * REPLY_RX (response only)
262 * REPLY_RX_MPDU (response only)
263 * REPLY_TX (both command and response)
264 * REPLY_TX_LINK_QUALITY_CMD
266 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
276 * 4-3: 0) Single stream (SISO)
277 * 1) Dual stream (MIMO)
278 * 2) Triple stream (MIMO)
280 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
282 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
292 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
298 #define RATE_MCS_CODE_MSK 0x7
299 #define RATE_MCS_SPATIAL_POS 3
300 #define RATE_MCS_SPATIAL_MSK 0x18
301 #define RATE_MCS_HT_DUP_POS 5
302 #define RATE_MCS_HT_DUP_MSK 0x20
303 /* Both legacy and HT use bits 7:0 as the CCK/OFDM rate or HT MCS */
304 #define RATE_MCS_RATE_MSK 0xff
306 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
307 #define RATE_MCS_FLAGS_POS 8
308 #define RATE_MCS_HT_POS 8
309 #define RATE_MCS_HT_MSK 0x100
311 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
312 #define RATE_MCS_CCK_POS 9
313 #define RATE_MCS_CCK_MSK 0x200
315 /* Bit 10: (1) Use Green Field preamble */
316 #define RATE_MCS_GF_POS 10
317 #define RATE_MCS_GF_MSK 0x400
319 /* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
320 #define RATE_MCS_HT40_POS 11
321 #define RATE_MCS_HT40_MSK 0x800
323 /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
324 #define RATE_MCS_DUP_POS 12
325 #define RATE_MCS_DUP_MSK 0x1000
327 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
328 #define RATE_MCS_SGI_POS 13
329 #define RATE_MCS_SGI_MSK 0x2000
332 * rate_n_flags Tx antenna masks
333 * 4965 has 2 transmitters
334 * 5100 has 1 transmitter B
335 * 5150 has 1 transmitter A
336 * 5300 has 3 transmitters
337 * 5350 has 3 transmitters
340 #define RATE_MCS_ANT_POS 14
341 #define RATE_MCS_ANT_A_MSK 0x04000
342 #define RATE_MCS_ANT_B_MSK 0x08000
343 #define RATE_MCS_ANT_C_MSK 0x10000
344 #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
345 #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
346 #define RATE_ANT_NUM 3
348 #define POWER_TABLE_NUM_ENTRIES 33
349 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
350 #define POWER_TABLE_CCK_ENTRY 32
352 #define IWL_PWR_NUM_HT_OFDM_ENTRIES 24
353 #define IWL_PWR_CCK_ENTRIES 2
356 * struct tx_power_dual_stream
358 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
360 * Same format as iwl_tx_power_dual_stream, but __le32
362 struct tx_power_dual_stream {
367 * Command REPLY_TX_POWER_DBM_CMD = 0x98
368 * struct iwlagn_tx_power_dbm_cmd
370 #define IWLAGN_TX_POWER_AUTO 0x7f
371 #define IWLAGN_TX_POWER_NO_CLOSED (0x1 << 6)
373 struct iwlagn_tx_power_dbm_cmd {
374 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
376 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
381 * Command TX_ANT_CONFIGURATION_CMD = 0x98
382 * This command is used to configure valid Tx antenna.
383 * By default uCode concludes the valid antenna according to the radio flavor.
384 * This command enables the driver to override/modify this conclusion.
386 struct iwl_tx_ant_config_cmd {
390 /******************************************************************************
392 * Alive and Error Commands & Responses:
394 *****************************************************************************/
396 #define UCODE_VALID_OK cpu_to_le32(0x1)
399 * REPLY_ALIVE = 0x1 (response only, not a command)
401 * uCode issues this "alive" notification once the runtime image is ready
402 * to receive commands from the driver. This is the *second* "alive"
403 * notification that the driver will receive after rebooting uCode;
404 * this "alive" is indicated by subtype field != 9.
406 * See comments documenting "BSM" (bootstrap state machine).
408 * This response includes two pointers to structures within the device's
409 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
411 * 1) log_event_table_ptr indicates base of the event log. This traces
412 * a 256-entry history of uCode execution within a circular buffer.
413 * Its header format is:
415 * __le32 log_size; log capacity (in number of entries)
416 * __le32 type; (1) timestamp with each entry, (0) no timestamp
417 * __le32 wraps; # times uCode has wrapped to top of circular buffer
418 * __le32 write_index; next circular buffer entry that uCode would fill
420 * The header is followed by the circular buffer of log entries. Entries
421 * with timestamps have the following format:
423 * __le32 event_id; range 0 - 1500
424 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
425 * __le32 data; event_id-specific data value
427 * Entries without timestamps contain only event_id and data.
430 * 2) error_event_table_ptr indicates base of the error log. This contains
431 * information about any uCode error that occurs. For agn, the format
432 * of the error log is defined by struct iwl_error_event_table.
434 * The Linux driver can print both logs to the system log when a uCode error
439 * Note: This structure is read from the device with IO accesses,
440 * and the reading already does the endian conversion. As it is
441 * read with u32-sized accesses, any members with a different size
442 * need to be ordered correctly though!
444 struct iwl_error_event_table {
445 u32 valid; /* (nonzero) valid, (0) log is empty */
446 u32 error_id; /* type of error */
447 u32 pc; /* program counter */
448 u32 blink1; /* branch link */
449 u32 blink2; /* branch link */
450 u32 ilink1; /* interrupt link */
451 u32 ilink2; /* interrupt link */
452 u32 data1; /* error-specific data */
453 u32 data2; /* error-specific data */
454 u32 line; /* source code line of error */
455 u32 bcon_time; /* beacon timer */
456 u32 tsf_low; /* network timestamp function timer */
457 u32 tsf_hi; /* network timestamp function timer */
458 u32 gp1; /* GP1 timer register */
459 u32 gp2; /* GP2 timer register */
460 u32 gp3; /* GP3 timer register */
461 u32 ucode_ver; /* uCode version */
462 u32 hw_ver; /* HW Silicon version */
463 u32 brd_ver; /* HW board version */
464 u32 log_pc; /* log program counter */
465 u32 frame_ptr; /* frame pointer */
466 u32 stack_ptr; /* stack pointer */
467 u32 hcmd; /* last host command header */
469 /* no need to read the remainder, we don't use the values */
470 u32 isr0; /* isr status register LMPM_NIC_ISR0: rxtx_flag */
471 u32 isr1; /* isr status register LMPM_NIC_ISR1: host_flag */
472 u32 isr2; /* isr status register LMPM_NIC_ISR2: enc_flag */
473 u32 isr3; /* isr status register LMPM_NIC_ISR3: time_flag */
474 u32 isr4; /* isr status register LMPM_NIC_ISR4: wico interrupt */
475 u32 isr_pref; /* isr status register LMPM_NIC_PREF_STAT */
476 u32 wait_event; /* wait event() caller address */
477 u32 l2p_control; /* L2pControlField */
478 u32 l2p_duration; /* L2pDurationField */
479 u32 l2p_mhvalid; /* L2pMhValidBits */
480 u32 l2p_addr_match; /* L2pAddrMatchStat */
481 u32 lmpm_pmg_sel; /* indicate which clocks are turned on (LMPM_PMG_SEL) */
482 u32 u_timestamp; /* indicate when the date and time of the compilation */
483 u32 flow_handler; /* FH read/write pointers, RX credit */
487 struct iwl_alive_resp {
493 u8 ver_subtype; /* not "9" for runtime alive */
495 __le32 log_event_table_ptr; /* SRAM address for event log */
496 __le32 error_event_table_ptr; /* SRAM address for error log */
502 * REPLY_ERROR = 0x2 (response only, not a command)
504 struct iwl_error_resp {
508 __le16 bad_cmd_seq_num;
513 /******************************************************************************
515 * RXON Commands & Responses:
517 *****************************************************************************/
520 * Rx config defines & structure
522 /* rx_config device types */
524 RXON_DEV_TYPE_AP = 1,
525 RXON_DEV_TYPE_ESS = 3,
526 RXON_DEV_TYPE_IBSS = 4,
527 RXON_DEV_TYPE_SNIFFER = 6,
528 RXON_DEV_TYPE_CP = 7,
529 RXON_DEV_TYPE_2STA = 8,
530 RXON_DEV_TYPE_P2P = 9,
534 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
535 #define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)
536 #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
537 #define RXON_RX_CHAIN_VALID_POS (1)
538 #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
539 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
540 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
541 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
542 #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
543 #define RXON_RX_CHAIN_CNT_POS (10)
544 #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
545 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
546 #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
547 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
549 /* rx_config flags */
550 /* band & modulation selection */
551 #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
552 #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
553 /* auto detection enable */
554 #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
555 /* TGg protection when tx */
556 #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
557 /* cck short slot & preamble */
558 #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
559 #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
560 /* antenna selection */
561 #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
562 #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
563 #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
564 #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
565 /* radar detection enable */
566 #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
567 #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
568 /* rx response to host with 8-byte TSF
569 * (according to ON_AIR deassertion) */
570 #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
574 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
575 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
577 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
579 #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
580 #define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)
582 #define RXON_FLG_CHANNEL_MODE_POS (25)
583 #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
587 CHANNEL_MODE_LEGACY = 0,
588 CHANNEL_MODE_PURE_40 = 1,
589 CHANNEL_MODE_MIXED = 2,
590 CHANNEL_MODE_RESERVED = 3,
592 #define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
593 #define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
594 #define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
596 /* CTS to self (if spec allows) flag */
597 #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
599 /* rx_config filter flags */
600 /* accept all data frames */
601 #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
602 /* pass control & management to host */
603 #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
604 /* accept multi-cast */
605 #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
606 /* don't decrypt uni-cast frames */
607 #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
608 /* don't decrypt multi-cast frames */
609 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
610 /* STA is associated */
611 #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
612 /* transfer to host non bssid beacons in associated state */
613 #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
616 * REPLY_RXON = 0x10 (command, has simple generic response)
618 * RXON tunes the radio tuner to a service channel, and sets up a number
619 * of parameters that are used primarily for Rx, but also for Tx operations.
621 * NOTE: When tuning to a new channel, driver must set the
622 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
623 * info within the device, including the station tables, tx retry
624 * rate tables, and txpower tables. Driver must build a new station
625 * table and txpower table before transmitting anything on the RXON
628 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
629 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
630 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
633 struct iwl_rxon_cmd {
638 u8 wlap_bssid_addr[6];
649 u8 ofdm_ht_single_stream_basic_rates;
650 u8 ofdm_ht_dual_stream_basic_rates;
651 u8 ofdm_ht_triple_stream_basic_rates;
653 __le16 acquisition_data;
658 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
660 struct iwl_rxon_assoc_cmd {
666 u8 ofdm_ht_single_stream_basic_rates;
667 u8 ofdm_ht_dual_stream_basic_rates;
668 u8 ofdm_ht_triple_stream_basic_rates;
670 __le16 rx_chain_select_flags;
671 __le16 acquisition_data;
675 #define IWL_CONN_MAX_LISTEN_INTERVAL 10
676 #define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
679 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
681 struct iwl_rxon_time_cmd {
683 __le16 beacon_interval;
685 __le32 beacon_init_val;
686 __le16 listen_interval;
688 u8 delta_cp_bss_tbtts;
692 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
695 * struct iwl5000_channel_switch_cmd
696 * @band: 0- 5.2GHz, 1- 2.4GHz
697 * @expect_beacon: 0- resume transmits after channel switch
698 * 1- wait for beacon to resume transmits
699 * @channel: new channel number
700 * @rxon_flags: Rx on flags
701 * @rxon_filter_flags: filtering parameters
702 * @switch_time: switch time in extended beacon format
703 * @reserved: reserved bytes
705 struct iwl5000_channel_switch_cmd {
710 __le32 rxon_filter_flags;
712 __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
716 * struct iwl6000_channel_switch_cmd
717 * @band: 0- 5.2GHz, 1- 2.4GHz
718 * @expect_beacon: 0- resume transmits after channel switch
719 * 1- wait for beacon to resume transmits
720 * @channel: new channel number
721 * @rxon_flags: Rx on flags
722 * @rxon_filter_flags: filtering parameters
723 * @switch_time: switch time in extended beacon format
724 * @reserved: reserved bytes
726 struct iwl6000_channel_switch_cmd {
731 __le32 rxon_filter_flags;
733 __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
737 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
739 struct iwl_csa_notification {
742 __le32 status; /* 0 - OK, 1 - fail */
745 /******************************************************************************
747 * Quality-of-Service (QOS) Commands & Responses:
749 *****************************************************************************/
752 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
753 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
755 * @cw_min: Contention window, start value in numbers of slots.
756 * Should be a power-of-2, minus 1. Device's default is 0x0f.
757 * @cw_max: Contention window, max value in numbers of slots.
758 * Should be a power-of-2, minus 1. Device's default is 0x3f.
759 * @aifsn: Number of slots in Arbitration Interframe Space (before
760 * performing random backoff timing prior to Tx). Device default 1.
761 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
763 * Device will automatically increase contention window by (2*CW) + 1 for each
764 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
765 * value, to cap the CW value.
775 /* QoS flags defines */
776 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
777 #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
778 #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
780 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
784 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
786 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
787 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
789 struct iwl_qosparam_cmd {
791 struct iwl_ac_qos ac[AC_NUM];
794 /******************************************************************************
796 * Add/Modify Stations Commands & Responses:
798 *****************************************************************************/
800 * Multi station support
803 /* Special, dedicated locations within device's station table */
805 #define IWL_AP_ID_PAN 1
807 #define IWLAGN_PAN_BCAST_ID 14
808 #define IWLAGN_BROADCAST_ID 15
809 #define IWLAGN_STATION_COUNT 16
811 #define IWL_INVALID_STATION 255
812 #define IWL_MAX_TID_COUNT 9
814 #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2)
815 #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8)
816 #define STA_FLG_PAN_STATION cpu_to_le32(1 << 13)
817 #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
818 #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
819 #define STA_FLG_MAX_AGG_SIZE_POS (19)
820 #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
821 #define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)
822 #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
823 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
824 #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
826 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
827 #define STA_CONTROL_MODIFY_MSK 0x01
829 /* key flags __le16*/
830 #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
831 #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
832 #define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
833 #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
834 #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
836 #define STA_KEY_FLG_KEYID_POS 8
837 #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
838 /* wep key is either from global key (0) or from station info array (1) */
839 #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
841 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
842 #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
843 #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
844 #define STA_KEY_MAX_NUM 8
845 #define STA_KEY_MAX_NUM_PAN 16
846 /* must not match WEP_INVALID_OFFSET */
847 #define IWLAGN_HW_KEY_DEFAULT 0xfe
849 /* Flags indicate whether to modify vs. don't change various station params */
850 #define STA_MODIFY_KEY_MASK 0x01
851 #define STA_MODIFY_TID_DISABLE_TX 0x02
852 #define STA_MODIFY_TX_RATE_MSK 0x04
853 #define STA_MODIFY_ADDBA_TID_MSK 0x08
854 #define STA_MODIFY_DELBA_TID_MSK 0x10
855 #define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20
857 /* Receiver address (actually, Rx station's index into station table),
858 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
859 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
864 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
866 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
869 u8 key[16]; /* 16-byte unicast decryption key */
870 __le64 tx_secur_seq_cnt;
871 __le64 hw_tkip_mic_rx_key;
872 __le64 hw_tkip_mic_tx_key;
876 * struct sta_id_modify
877 * @addr[ETH_ALEN]: station's MAC address
878 * @sta_id: index of station in uCode's station table
879 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
881 * Driver selects unused table index when adding new station,
882 * or the index to a pre-existing station entry when modifying that station.
883 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
885 * modify_mask flags select which parameters to modify vs. leave alone.
887 struct sta_id_modify {
896 * REPLY_ADD_STA = 0x18 (command)
898 * The device contains an internal table of per-station information,
899 * with info on security keys, aggregation parameters, and Tx rates for
900 * initial Tx attempt and any retries (agn devices uses
901 * REPLY_TX_LINK_QUALITY_CMD,
903 * REPLY_ADD_STA sets up the table entry for one station, either creating
904 * a new entry, or modifying a pre-existing one.
906 * NOTE: RXON command (without "associated" bit set) wipes the station table
907 * clean. Moving into RF_KILL state does this also. Driver must set up
908 * new station table before transmitting anything on the RXON channel
909 * (except active scans or active measurements; those commands carry
910 * their own txpower/rate setup data).
912 * When getting started on a new channel, driver must set up the
913 * IWL_BROADCAST_ID entry (last entry in the table). For a client
914 * station in a BSS, once an AP is selected, driver sets up the AP STA
915 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
916 * are all that are needed for a BSS client station. If the device is
917 * used as AP, or in an IBSS network, driver must set up station table
918 * entries for all STAs in network, starting with index IWL_STA_ID.
921 struct iwl_addsta_cmd {
922 u8 mode; /* 1: modify existing, 0: add new station */
924 struct sta_id_modify sta;
925 struct iwl_keyinfo key;
926 __le32 station_flags; /* STA_FLG_* */
927 __le32 station_flags_msk; /* STA_FLG_* */
929 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
930 * corresponding to bit (e.g. bit 5 controls TID 5).
931 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
932 __le16 tid_disable_tx;
934 __le16 rate_n_flags; /* 3945 only */
936 /* TID for which to add block-ack support.
937 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
938 u8 add_immediate_ba_tid;
940 /* TID for which to remove block-ack support.
941 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
942 u8 remove_immediate_ba_tid;
944 /* Starting Sequence Number for added block-ack support.
945 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
946 __le16 add_immediate_ba_ssn;
949 * Number of packets OK to transmit to station even though
950 * it is asleep -- used to synchronise PS-poll and u-APSD
951 * responses while ucode keeps track of STA sleep state.
953 __le16 sleep_tx_count;
959 #define ADD_STA_SUCCESS_MSK 0x1
960 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
961 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
962 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
964 * REPLY_ADD_STA = 0x18 (response)
966 struct iwl_add_sta_resp {
967 u8 status; /* ADD_STA_* */
970 #define REM_STA_SUCCESS_MSK 0x1
972 * REPLY_REM_STA = 0x19 (response)
974 struct iwl_rem_sta_resp {
979 * REPLY_REM_STA = 0x19 (command)
981 struct iwl_rem_sta_cmd {
982 u8 num_sta; /* number of removed stations */
984 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
989 /* WiFi queues mask */
990 #define IWL_SCD_BK_MSK cpu_to_le32(BIT(0))
991 #define IWL_SCD_BE_MSK cpu_to_le32(BIT(1))
992 #define IWL_SCD_VI_MSK cpu_to_le32(BIT(2))
993 #define IWL_SCD_VO_MSK cpu_to_le32(BIT(3))
994 #define IWL_SCD_MGMT_MSK cpu_to_le32(BIT(3))
996 /* PAN queues mask */
997 #define IWL_PAN_SCD_BK_MSK cpu_to_le32(BIT(4))
998 #define IWL_PAN_SCD_BE_MSK cpu_to_le32(BIT(5))
999 #define IWL_PAN_SCD_VI_MSK cpu_to_le32(BIT(6))
1000 #define IWL_PAN_SCD_VO_MSK cpu_to_le32(BIT(7))
1001 #define IWL_PAN_SCD_MGMT_MSK cpu_to_le32(BIT(7))
1002 #define IWL_PAN_SCD_MULTICAST_MSK cpu_to_le32(BIT(8))
1004 #define IWL_AGG_TX_QUEUE_MSK cpu_to_le32(0xffc00)
1006 #define IWL_DROP_SINGLE 0
1007 #define IWL_DROP_ALL (BIT(IWL_RXON_CTX_BSS) | BIT(IWL_RXON_CTX_PAN))
1010 * REPLY_TXFIFO_FLUSH = 0x1e(command and response)
1012 * When using full FIFO flush this command checks the scheduler HW block WR/RD
1013 * pointers to check if all the frames were transferred by DMA into the
1014 * relevant TX FIFO queue. Only when the DMA is finished and the queue is
1015 * empty the command can finish.
1016 * This command is used to flush the TXFIFO from transmit commands, it may
1017 * operate on single or multiple queues, the command queue can't be flushed by
1018 * this command. The command response is returned when all the queue flush
1019 * operations are done. Each TX command flushed return response with the FLUSH
1020 * status set in the TX response status. When FIFO flush operation is used,
1021 * the flush operation ends when both the scheduler DMA done and TXFIFO empty
1024 * @fifo_control: bit mask for which queues to flush
1025 * @flush_control: flush controls
1026 * 0: Dump single MSDU
1027 * 1: Dump multiple MSDU according to PS, INVALID STA, TTL, TID disable.
1030 struct iwl_txfifo_flush_cmd {
1031 __le32 fifo_control;
1032 __le16 flush_control;
1037 * REPLY_WEP_KEY = 0x20
1039 struct iwl_wep_key {
1048 struct iwl_wep_cmd {
1053 struct iwl_wep_key key[0];
1056 #define WEP_KEY_WEP_TYPE 1
1057 #define WEP_KEYS_MAX 4
1058 #define WEP_INVALID_OFFSET 0xff
1059 #define WEP_KEY_LEN_64 5
1060 #define WEP_KEY_LEN_128 13
1062 /******************************************************************************
1066 *****************************************************************************/
1068 #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1069 #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
1071 #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1072 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1073 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1074 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
1075 #define RX_RES_PHY_FLAGS_ANTENNA_MSK 0xf0
1076 #define RX_RES_PHY_FLAGS_ANTENNA_POS 4
1078 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1079 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1080 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1081 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1082 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
1083 #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1085 #define RX_RES_STATUS_STATION_FOUND (1<<6)
1086 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
1088 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1089 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1090 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1091 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1092 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
1094 #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1095 #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1096 #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1097 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1100 #define IWLAGN_RX_RES_PHY_CNT 8
1101 #define IWLAGN_RX_RES_AGC_IDX 1
1102 #define IWLAGN_RX_RES_RSSI_AB_IDX 2
1103 #define IWLAGN_RX_RES_RSSI_C_IDX 3
1104 #define IWLAGN_OFDM_AGC_MSK 0xfe00
1105 #define IWLAGN_OFDM_AGC_BIT_POS 9
1106 #define IWLAGN_OFDM_RSSI_INBAND_A_BITMSK 0x00ff
1107 #define IWLAGN_OFDM_RSSI_ALLBAND_A_BITMSK 0xff00
1108 #define IWLAGN_OFDM_RSSI_A_BIT_POS 0
1109 #define IWLAGN_OFDM_RSSI_INBAND_B_BITMSK 0xff0000
1110 #define IWLAGN_OFDM_RSSI_ALLBAND_B_BITMSK 0xff000000
1111 #define IWLAGN_OFDM_RSSI_B_BIT_POS 16
1112 #define IWLAGN_OFDM_RSSI_INBAND_C_BITMSK 0x00ff
1113 #define IWLAGN_OFDM_RSSI_ALLBAND_C_BITMSK 0xff00
1114 #define IWLAGN_OFDM_RSSI_C_BIT_POS 0
1116 struct iwlagn_non_cfg_phy {
1117 __le32 non_cfg_phy[IWLAGN_RX_RES_PHY_CNT]; /* up to 8 phy entries */
1122 * REPLY_RX = 0xc3 (response only, not a command)
1123 * Used only for legacy (non 11n) frames.
1125 struct iwl_rx_phy_res {
1126 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1127 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1128 u8 stat_id; /* configurable DSP phy data set ID */
1130 __le64 timestamp; /* TSF at on air rise */
1131 __le32 beacon_time_stamp; /* beacon at on-air rise */
1132 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1133 __le16 channel; /* channel number */
1134 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1135 __le32 rate_n_flags; /* RATE_MCS_* */
1136 __le16 byte_count; /* frame's byte-count */
1137 __le16 frame_time; /* frame's time on the air */
1140 struct iwl_rx_mpdu_res_start {
1146 /******************************************************************************
1148 * Tx Commands & Responses:
1150 * Driver must place each REPLY_TX command into one of the prioritized Tx
1151 * queues in host DRAM, shared between driver and device (see comments for
1152 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1153 * are preparing to transmit, the device pulls the Tx command over the PCI
1154 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1155 * from which data will be transmitted.
1157 * uCode handles all timing and protocol related to control frames
1158 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1159 * handle reception of block-acks; uCode updates the host driver via
1160 * REPLY_COMPRESSED_BA.
1162 * uCode handles retrying Tx when an ACK is expected but not received.
1163 * This includes trying lower data rates than the one requested in the Tx
1164 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1165 * REPLY_TX_LINK_QUALITY_CMD (agn).
1167 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1168 * This command must be executed after every RXON command, before Tx can occur.
1169 *****************************************************************************/
1171 /* REPLY_TX Tx flags field */
1174 * 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1175 * before this frame. if CTS-to-self required check
1176 * RXON_FLG_SELF_CTS_EN status.
1177 * unused in 3945/4965, used in 5000 series and after
1179 #define TX_CMD_FLG_PROT_REQUIRE_MSK cpu_to_le32(1 << 0)
1182 * 1: Use Request-To-Send protocol before this frame.
1183 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
1184 * used in 3945/4965, unused in 5000 series and after
1186 #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1189 * 1: Transmit Clear-To-Send to self before this frame.
1190 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1191 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
1192 * used in 3945/4965, unused in 5000 series and after
1194 #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1196 /* 1: Expect ACK from receiving station
1197 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1198 * Set this for unicast frames, but not broadcast/multicast. */
1199 #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1202 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1203 * Tx command's initial_rate_index indicates first rate to try;
1204 * uCode walks through table for additional Tx attempts.
1205 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1206 * This rate will be used for all Tx attempts; it will not be scaled. */
1207 #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1209 /* 1: Expect immediate block-ack.
1210 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1211 #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
1214 * 1: Frame requires full Tx-Op protection.
1215 * Set this if either RTS or CTS Tx Flag gets set.
1216 * used in 3945/4965, unused in 5000 series and after
1218 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1220 /* Tx antenna selection field; used only for 3945, reserved (0) for agn devices.
1221 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1222 #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1223 #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1224 #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
1226 /* 1: Ignore Bluetooth priority for this frame.
1227 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1228 #define TX_CMD_FLG_IGNORE_BT cpu_to_le32(1 << 12)
1230 /* 1: uCode overrides sequence control field in MAC header.
1231 * 0: Driver provides sequence control field in MAC header.
1232 * Set this for management frames, non-QOS data frames, non-unicast frames,
1233 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1234 #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
1236 /* 1: This frame is non-last MPDU; more fragments are coming.
1237 * 0: Last fragment, or not using fragmentation. */
1238 #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
1240 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1241 * 0: No TSF required in outgoing frame.
1242 * Set this for transmitting beacons and probe responses. */
1243 #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
1245 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1246 * alignment of frame's payload data field.
1248 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1249 * field (but not both). Driver must align frame data (i.e. data following
1250 * MAC header) to DWORD boundary. */
1251 #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
1253 /* accelerate aggregation support
1254 * 0 - no CCMP encryption; 1 - CCMP encryption */
1255 #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1257 /* HCCA-AP - disable duration overwriting. */
1258 #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
1262 * TX command security control
1264 #define TX_CMD_SEC_WEP 0x01
1265 #define TX_CMD_SEC_CCM 0x02
1266 #define TX_CMD_SEC_TKIP 0x03
1267 #define TX_CMD_SEC_MSK 0x03
1268 #define TX_CMD_SEC_SHIFT 6
1269 #define TX_CMD_SEC_KEY128 0x08
1272 * security overhead sizes
1274 #define WEP_IV_LEN 4
1275 #define WEP_ICV_LEN 4
1276 #define CCMP_MIC_LEN 8
1277 #define TKIP_ICV_LEN 4
1280 * REPLY_TX = 0x1c (command)
1284 * 4965 uCode updates these Tx attempt count values in host DRAM.
1285 * Used for managing Tx retries when expecting block-acks.
1286 * Driver should set these fields to 0.
1288 struct iwl_dram_scratch {
1289 u8 try_cnt; /* Tx attempts */
1290 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1297 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1298 * + 8 byte IV for CCM or TKIP (not used for WEP)
1300 * + 8-byte MIC (not used for CCM/WEP)
1301 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1302 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1303 * Range: 14-2342 bytes.
1308 * MPDU or MSDU byte count for next frame.
1309 * Used for fragmentation and bursting, but not 11n aggregation.
1310 * Same as "len", but for next frame. Set to 0 if not applicable.
1312 __le16 next_frame_len;
1314 __le32 tx_flags; /* TX_CMD_FLG_* */
1316 /* uCode may modify this field of the Tx command (in host DRAM!).
1317 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1318 struct iwl_dram_scratch scratch;
1320 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1321 __le32 rate_n_flags; /* RATE_MCS_* */
1323 /* Index of destination station in uCode's station table */
1326 /* Type of security encryption: CCM or TKIP */
1327 u8 sec_ctl; /* TX_CMD_SEC_* */
1330 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1331 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1332 * data frames, this field may be used to selectively reduce initial
1333 * rate (via non-0 value) for special frames (e.g. management), while
1334 * still supporting rate scaling for all frames.
1336 u8 initial_rate_index;
1339 __le16 next_frame_flags;
1346 /* Host DRAM physical address pointer to "scratch" in this command.
1347 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1348 __le32 dram_lsb_ptr;
1351 u8 rts_retry_limit; /*byte 50 */
1352 u8 data_retry_limit; /*byte 51 */
1355 __le16 pm_frame_timeout;
1356 __le16 attempt_duration;
1360 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1361 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1366 * MAC header goes here, followed by 2 bytes padding if MAC header
1367 * length is 26 or 30 bytes, followed by payload data
1370 struct ieee80211_hdr hdr[0];
1374 * TX command response is sent after *agn* transmission attempts.
1376 * both postpone and abort status are expected behavior from uCode. there is
1377 * no special operation required from driver; except for RFKILL_FLUSH,
1378 * which required tx flush host command to flush all the tx frames in queues
1381 TX_STATUS_SUCCESS = 0x01,
1382 TX_STATUS_DIRECT_DONE = 0x02,
1384 TX_STATUS_POSTPONE_DELAY = 0x40,
1385 TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
1386 TX_STATUS_POSTPONE_BT_PRIO = 0x42,
1387 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
1388 TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
1390 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
1391 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1392 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1393 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1394 TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
1395 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
1396 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1397 TX_STATUS_FAIL_DEST_PS = 0x88,
1398 TX_STATUS_FAIL_HOST_ABORTED = 0x89,
1399 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1400 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1401 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1402 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1403 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
1404 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1405 TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,
1406 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1409 #define TX_PACKET_MODE_REGULAR 0x0000
1410 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1411 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1414 TX_POWER_PA_NOT_ACTIVE = 0x0,
1418 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1419 TX_STATUS_DELAY_MSK = 0x00000040,
1420 TX_STATUS_ABORT_MSK = 0x00000080,
1421 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1422 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1423 TX_RESERVED = 0x00780000, /* bits 19:22 */
1424 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1425 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1428 /* *******************************
1429 * TX aggregation status
1430 ******************************* */
1433 AGG_TX_STATE_TRANSMITTED = 0x00,
1434 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1435 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1436 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1437 AGG_TX_STATE_ABORT_MSK = 0x08,
1438 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1439 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1440 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1441 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1442 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1443 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1444 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1445 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1448 #define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */
1449 #define AGG_TX_TRY_MSK 0x0000f000 /* bits 12:15 */
1451 #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1452 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1453 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1455 /* # tx attempts for first frame in aggregation */
1456 #define AGG_TX_STATE_TRY_CNT_POS 12
1457 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1459 /* Command ID and sequence number of Tx command for this frame */
1460 #define AGG_TX_STATE_SEQ_NUM_POS 16
1461 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1464 * REPLY_TX = 0x1c (response)
1466 * This response may be in one of two slightly different formats, indicated
1467 * by the frame_count field:
1469 * 1) No aggregation (frame_count == 1). This reports Tx results for
1470 * a single frame. Multiple attempts, at various bit rates, may have
1471 * been made for this frame.
1473 * 2) Aggregation (frame_count > 1). This reports Tx results for
1474 * 2 or more frames that used block-acknowledge. All frames were
1475 * transmitted at same rate. Rate scaling may have been used if first
1476 * frame in this new agg block failed in previous agg block(s).
1478 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1479 * block-ack has not been received by the time the agn device records
1481 * This status relates to reasons the tx might have been blocked or aborted
1482 * within the sending station (this agn device), rather than whether it was
1483 * received successfully by the destination station.
1485 struct agg_tx_status {
1491 * definitions for initial rate index field
1492 * bits [3:0] initial rate index
1493 * bits [6:4] rate table color, used for the initial rate
1494 * bit-7 invalid rate indication
1495 * i.e. rate was not chosen from rate table
1496 * or rate table color was changed during frame retries
1497 * refer tlc rate info
1500 #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1501 #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1502 #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1503 #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1504 #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1506 /* refer to ra_tid */
1507 #define IWLAGN_TX_RES_TID_POS 0
1508 #define IWLAGN_TX_RES_TID_MSK 0x0f
1509 #define IWLAGN_TX_RES_RA_POS 4
1510 #define IWLAGN_TX_RES_RA_MSK 0xf0
1512 struct iwlagn_tx_resp {
1513 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1514 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1515 u8 failure_rts; /* # failures due to unsuccessful RTS */
1516 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1518 /* For non-agg: Rate at which frame was successful.
1519 * For agg: Rate at which all frames were transmitted. */
1520 __le32 rate_n_flags; /* RATE_MCS_* */
1522 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1523 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1524 __le16 wireless_media_time; /* uSecs */
1526 u8 pa_status; /* RF power amplifier measurement (not used) */
1527 u8 pa_integ_res_a[3];
1528 u8 pa_integ_res_b[3];
1529 u8 pa_integ_res_C[3];
1535 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1538 * For non-agg: frame status TX_STATUS_*
1539 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1540 * fields follow this one, up to frame_count.
1542 * 11- 0: AGG_TX_STATE_* status code
1543 * 15-12: Retry count for 1st frame in aggregation (retries
1544 * occur if tx failed for this frame when it was a
1545 * member of a previous aggregation block). If rate
1546 * scaling is used, retry count indicates the rate
1547 * table entry used for all frames in the new agg.
1548 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1550 struct agg_tx_status status; /* TX status (in aggregation -
1551 * status of 1st frame) */
1554 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1556 * Reports Block-Acknowledge from recipient station
1558 struct iwl_compressed_ba_resp {
1559 __le32 sta_addr_lo32;
1560 __le16 sta_addr_hi16;
1563 /* Index of recipient (BA-sending) station in uCode's station table */
1570 /* following only for 5000 series and up */
1571 u8 txed; /* number of frames sent */
1572 u8 txed_2_done; /* number of frames acked */
1576 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1580 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1581 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1583 /* # of EDCA prioritized tx fifos */
1584 #define LINK_QUAL_AC_NUM AC_NUM
1586 /* # entries in rate scale table to support Tx retries */
1587 #define LINK_QUAL_MAX_RETRY_NUM 16
1589 /* Tx antenna selection values */
1590 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1591 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1592 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1596 * struct iwl_link_qual_general_params
1598 * Used in REPLY_TX_LINK_QUALITY_CMD
1600 struct iwl_link_qual_general_params {
1603 /* No entries at or above this (driver chosen) index contain MIMO */
1606 /* Best single antenna to use for single stream (legacy, SISO). */
1607 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1609 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1610 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1613 * If driver needs to use different initial rates for different
1614 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1615 * this table will set that up, by indicating the indexes in the
1616 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1617 * Otherwise, driver should set all entries to 0.
1620 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1621 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1623 u8 start_rate_index[LINK_QUAL_AC_NUM];
1626 #define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
1627 #define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)
1628 #define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)
1630 #define LINK_QUAL_AGG_DISABLE_START_DEF (3)
1631 #define LINK_QUAL_AGG_DISABLE_START_MAX (255)
1632 #define LINK_QUAL_AGG_DISABLE_START_MIN (0)
1634 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63)
1635 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
1636 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
1639 * struct iwl_link_qual_agg_params
1641 * Used in REPLY_TX_LINK_QUALITY_CMD
1643 struct iwl_link_qual_agg_params {
1646 *Maximum number of uSec in aggregation.
1647 * default set to 4000 (4 milliseconds) if not configured in .cfg
1649 __le16 agg_time_limit;
1652 * Number of Tx retries allowed for a frame, before that frame will
1653 * no longer be considered for the start of an aggregation sequence
1654 * (scheduler will then try to tx it as single frame).
1655 * Driver should set this to 3.
1657 u8 agg_dis_start_th;
1660 * Maximum number of frames in aggregation.
1661 * 0 = no limit (default). 1 = no aggregation.
1662 * Other values = max # frames in aggregation.
1664 u8 agg_frame_cnt_limit;
1670 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1672 * For agn devices only; 3945 uses REPLY_RATE_SCALE.
1674 * Each station in the agn device's internal station table has its own table
1676 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1677 * an ACK is not received. This command replaces the entire table for
1680 * NOTE: Station must already be in agn device's station table.
1681 * Use REPLY_ADD_STA.
1683 * The rate scaling procedures described below work well. Of course, other
1684 * procedures are possible, and may work better for particular environments.
1687 * FILLING THE RATE TABLE
1689 * Given a particular initial rate and mode, as determined by the rate
1690 * scaling algorithm described below, the Linux driver uses the following
1691 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1692 * Link Quality command:
1695 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1696 * a) Use this same initial rate for first 3 entries.
1697 * b) Find next lower available rate using same mode (SISO or MIMO),
1698 * use for next 3 entries. If no lower rate available, switch to
1699 * legacy mode (no HT40 channel, no MIMO, no short guard interval).
1700 * c) If using MIMO, set command's mimo_delimiter to number of entries
1701 * using MIMO (3 or 6).
1702 * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
1703 * no MIMO, no short guard interval), at the next lower bit rate
1704 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1705 * legacy procedure for remaining table entries.
1707 * 2) If using legacy initial rate:
1708 * a) Use the initial rate for only one entry.
1709 * b) For each following entry, reduce the rate to next lower available
1710 * rate, until reaching the lowest available rate.
1711 * c) When reducing rate, also switch antenna selection.
1712 * d) Once lowest available rate is reached, repeat this rate until
1713 * rate table is filled (16 entries), switching antenna each entry.
1716 * ACCUMULATING HISTORY
1718 * The rate scaling algorithm for agn devices, as implemented in Linux driver,
1719 * uses two sets of frame Tx success history: One for the current/active
1720 * modulation mode, and one for a speculative/search mode that is being
1721 * attempted. If the speculative mode turns out to be more effective (i.e.
1722 * actual transfer rate is better), then the driver continues to use the
1723 * speculative mode as the new current active mode.
1725 * Each history set contains, separately for each possible rate, data for a
1726 * sliding window of the 62 most recent tx attempts at that rate. The data
1727 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1728 * and attempted frames, from which the driver can additionally calculate a
1729 * success ratio (success / attempted) and number of failures
1730 * (attempted - success), and control the size of the window (attempted).
1731 * The driver uses the bit map to remove successes from the success sum, as
1732 * the oldest tx attempts fall out of the window.
1734 * When the agn device makes multiple tx attempts for a given frame, each
1735 * attempt might be at a different rate, and have different modulation
1736 * characteristics (e.g. antenna, fat channel, short guard interval), as set
1737 * up in the rate scaling table in the Link Quality command. The driver must
1738 * determine which rate table entry was used for each tx attempt, to determine
1739 * which rate-specific history to update, and record only those attempts that
1740 * match the modulation characteristics of the history set.
1742 * When using block-ack (aggregation), all frames are transmitted at the same
1743 * rate, since there is no per-attempt acknowledgment from the destination
1744 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1745 * rate_n_flags field. After receiving a block-ack, the driver can update
1746 * history for the entire block all at once.
1749 * FINDING BEST STARTING RATE:
1751 * When working with a selected initial modulation mode (see below), the
1752 * driver attempts to find a best initial rate. The initial rate is the
1753 * first entry in the Link Quality command's rate table.
1755 * 1) Calculate actual throughput (success ratio * expected throughput, see
1756 * table below) for current initial rate. Do this only if enough frames
1757 * have been attempted to make the value meaningful: at least 6 failed
1758 * tx attempts, or at least 8 successes. If not enough, don't try rate
1761 * 2) Find available rates adjacent to current initial rate. Available means:
1762 * a) supported by hardware &&
1763 * b) supported by association &&
1764 * c) within any constraints selected by user
1766 * 3) Gather measured throughputs for adjacent rates. These might not have
1767 * enough history to calculate a throughput. That's okay, we might try
1768 * using one of them anyway!
1770 * 4) Try decreasing rate if, for current rate:
1771 * a) success ratio is < 15% ||
1772 * b) lower adjacent rate has better measured throughput ||
1773 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1775 * As a sanity check, if decrease was determined above, leave rate
1777 * a) lower rate unavailable
1778 * b) success ratio at current rate > 85% (very good)
1779 * c) current measured throughput is better than expected throughput
1780 * of lower rate (under perfect 100% tx conditions, see table below)
1782 * 5) Try increasing rate if, for current rate:
1783 * a) success ratio is < 15% ||
1784 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1785 * b) higher adjacent rate has better measured throughput ||
1786 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1788 * As a sanity check, if increase was determined above, leave rate
1790 * a) success ratio at current rate < 70%. This is not particularly
1791 * good performance; higher rate is sure to have poorer success.
1793 * 6) Re-evaluate the rate after each tx frame. If working with block-
1794 * acknowledge, history and statistics may be calculated for the entire
1795 * block (including prior history that fits within the history windows),
1796 * before re-evaluation.
1798 * FINDING BEST STARTING MODULATION MODE:
1800 * After working with a modulation mode for a "while" (and doing rate scaling),
1801 * the driver searches for a new initial mode in an attempt to improve
1802 * throughput. The "while" is measured by numbers of attempted frames:
1804 * For legacy mode, search for new mode after:
1805 * 480 successful frames, or 160 failed frames
1806 * For high-throughput modes (SISO or MIMO), search for new mode after:
1807 * 4500 successful frames, or 400 failed frames
1809 * Mode switch possibilities are (3 for each mode):
1812 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1814 * Change antenna, try MIMO, try shortened guard interval (SGI)
1816 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1818 * When trying a new mode, use the same bit rate as the old/current mode when
1819 * trying antenna switches and shortened guard interval. When switching to
1820 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1821 * for which the expected throughput (under perfect conditions) is about the
1822 * same or slightly better than the actual measured throughput delivered by
1823 * the old/current mode.
1825 * Actual throughput can be estimated by multiplying the expected throughput
1826 * by the success ratio (successful / attempted tx frames). Frame size is
1827 * not considered in this calculation; it assumes that frame size will average
1828 * out to be fairly consistent over several samples. The following are
1829 * metric values for expected throughput assuming 100% success ratio.
1830 * Only G band has support for CCK rates:
1832 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1834 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1835 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1836 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1837 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1838 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1839 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1840 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1841 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1842 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1843 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1845 * After the new mode has been tried for a short while (minimum of 6 failed
1846 * frames or 8 successful frames), compare success ratio and actual throughput
1847 * estimate of the new mode with the old. If either is better with the new
1848 * mode, continue to use the new mode.
1850 * Continue comparing modes until all 3 possibilities have been tried.
1851 * If moving from legacy to HT, try all 3 possibilities from the new HT
1852 * mode. After trying all 3, a best mode is found. Continue to use this mode
1853 * for the longer "while" described above (e.g. 480 successful frames for
1854 * legacy), and then repeat the search process.
1857 struct iwl_link_quality_cmd {
1859 /* Index of destination/recipient station in uCode's station table */
1862 __le16 control; /* not used */
1863 struct iwl_link_qual_general_params general_params;
1864 struct iwl_link_qual_agg_params agg_params;
1867 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1868 * specifies 1st Tx rate attempted, via index into this table.
1869 * agn devices works its way through table when retrying Tx.
1872 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1873 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1878 * BT configuration enable flags:
1879 * bit 0 - 1: BT channel announcement enabled
1881 * bit 1 - 1: priority of BT device enabled
1883 * bit 2 - 1: BT 2 wire support enabled
1886 #define BT_COEX_DISABLE (0x0)
1887 #define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)
1888 #define BT_ENABLE_PRIORITY BIT(1)
1889 #define BT_ENABLE_2_WIRE BIT(2)
1891 #define BT_COEX_DISABLE (0x0)
1892 #define BT_COEX_ENABLE (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)
1894 #define BT_LEAD_TIME_MIN (0x0)
1895 #define BT_LEAD_TIME_DEF (0x1E)
1896 #define BT_LEAD_TIME_MAX (0xFF)
1898 #define BT_MAX_KILL_MIN (0x1)
1899 #define BT_MAX_KILL_DEF (0x5)
1900 #define BT_MAX_KILL_MAX (0xFF)
1902 #define BT_DURATION_LIMIT_DEF 625
1903 #define BT_DURATION_LIMIT_MAX 1250
1904 #define BT_DURATION_LIMIT_MIN 625
1906 #define BT_ON_THRESHOLD_DEF 4
1907 #define BT_ON_THRESHOLD_MAX 1000
1908 #define BT_ON_THRESHOLD_MIN 1
1910 #define BT_FRAG_THRESHOLD_DEF 0
1911 #define BT_FRAG_THRESHOLD_MAX 0
1912 #define BT_FRAG_THRESHOLD_MIN 0
1914 #define BT_AGG_THRESHOLD_DEF 1200
1915 #define BT_AGG_THRESHOLD_MAX 8000
1916 #define BT_AGG_THRESHOLD_MIN 400
1919 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1921 * 3945 and agn devices support hardware handshake with Bluetooth device on
1922 * same platform. Bluetooth device alerts wireless device when it will Tx;
1923 * wireless device can delay or kill its own Tx to accommodate.
1930 __le32 kill_ack_mask;
1931 __le32 kill_cts_mask;
1934 #define IWLAGN_BT_FLAG_CHANNEL_INHIBITION BIT(0)
1936 #define IWLAGN_BT_FLAG_COEX_MODE_MASK (BIT(3)|BIT(4)|BIT(5))
1937 #define IWLAGN_BT_FLAG_COEX_MODE_SHIFT 3
1938 #define IWLAGN_BT_FLAG_COEX_MODE_DISABLED 0
1939 #define IWLAGN_BT_FLAG_COEX_MODE_LEGACY_2W 1
1940 #define IWLAGN_BT_FLAG_COEX_MODE_3W 2
1941 #define IWLAGN_BT_FLAG_COEX_MODE_4W 3
1943 #define IWLAGN_BT_FLAG_UCODE_DEFAULT BIT(6)
1944 /* Disable Sync PSPoll on SCO/eSCO */
1945 #define IWLAGN_BT_FLAG_SYNC_2_BT_DISABLE BIT(7)
1947 #define IWLAGN_BT_PSP_MIN_RSSI_THRESHOLD -75 /* dBm */
1948 #define IWLAGN_BT_PSP_MAX_RSSI_THRESHOLD -65 /* dBm */
1950 #define IWLAGN_BT_PRIO_BOOST_MAX 0xFF
1951 #define IWLAGN_BT_PRIO_BOOST_MIN 0x00
1952 #define IWLAGN_BT_PRIO_BOOST_DEFAULT 0xF0
1954 #define IWLAGN_BT_MAX_KILL_DEFAULT 5
1956 #define IWLAGN_BT3_T7_DEFAULT 1
1958 #define IWLAGN_BT_KILL_ACK_MASK_DEFAULT cpu_to_le32(0xffff0000)
1959 #define IWLAGN_BT_KILL_CTS_MASK_DEFAULT cpu_to_le32(0xffff0000)
1960 #define IWLAGN_BT_KILL_ACK_CTS_MASK_SCO cpu_to_le32(0xffffffff)
1962 #define IWLAGN_BT3_PRIO_SAMPLE_DEFAULT 2
1964 #define IWLAGN_BT3_T2_DEFAULT 0xc
1966 #define IWLAGN_BT_VALID_ENABLE_FLAGS cpu_to_le16(BIT(0))
1967 #define IWLAGN_BT_VALID_BOOST cpu_to_le16(BIT(1))
1968 #define IWLAGN_BT_VALID_MAX_KILL cpu_to_le16(BIT(2))
1969 #define IWLAGN_BT_VALID_3W_TIMERS cpu_to_le16(BIT(3))
1970 #define IWLAGN_BT_VALID_KILL_ACK_MASK cpu_to_le16(BIT(4))
1971 #define IWLAGN_BT_VALID_KILL_CTS_MASK cpu_to_le16(BIT(5))
1972 #define IWLAGN_BT_VALID_BT4_TIMES cpu_to_le16(BIT(6))
1973 #define IWLAGN_BT_VALID_3W_LUT cpu_to_le16(BIT(7))
1975 #define IWLAGN_BT_ALL_VALID_MSK (IWLAGN_BT_VALID_ENABLE_FLAGS | \
1976 IWLAGN_BT_VALID_BOOST | \
1977 IWLAGN_BT_VALID_MAX_KILL | \
1978 IWLAGN_BT_VALID_3W_TIMERS | \
1979 IWLAGN_BT_VALID_KILL_ACK_MASK | \
1980 IWLAGN_BT_VALID_KILL_CTS_MASK | \
1981 IWLAGN_BT_VALID_BT4_TIMES | \
1982 IWLAGN_BT_VALID_3W_LUT)
1984 struct iwl_basic_bt_cmd {
1986 u8 ledtime; /* unused */
1988 u8 bt3_timer_t7_value;
1989 __le32 kill_ack_mask;
1990 __le32 kill_cts_mask;
1991 u8 bt3_prio_sample_time;
1992 u8 bt3_timer_t2_value;
1993 __le16 bt4_reaction_time; /* unused */
1994 __le32 bt3_lookup_table[12];
1995 __le16 bt4_decision_time; /* unused */
1999 struct iwl6000_bt_cmd {
2000 struct iwl_basic_bt_cmd basic;
2003 * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
2004 * if configure the following patterns
2006 u8 tx_prio_boost; /* SW boost of WiFi tx priority */
2007 __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
2010 struct iwl2000_bt_cmd {
2011 struct iwl_basic_bt_cmd basic;
2014 * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
2015 * if configure the following patterns
2018 u8 tx_prio_boost; /* SW boost of WiFi tx priority */
2019 __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
2022 #define IWLAGN_BT_SCO_ACTIVE cpu_to_le32(BIT(0))
2024 struct iwlagn_bt_sco_cmd {
2028 /******************************************************************************
2030 * Spectrum Management (802.11h) Commands, Responses, Notifications:
2032 *****************************************************************************/
2035 * Spectrum Management
2037 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
2038 RXON_FILTER_CTL2HOST_MSK | \
2039 RXON_FILTER_ACCEPT_GRP_MSK | \
2040 RXON_FILTER_DIS_DECRYPT_MSK | \
2041 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
2042 RXON_FILTER_ASSOC_MSK | \
2043 RXON_FILTER_BCON_AWARE_MSK)
2045 struct iwl_measure_channel {
2046 __le32 duration; /* measurement duration in extended beacon
2048 u8 channel; /* channel to measure */
2049 u8 type; /* see enum iwl_measure_type */
2054 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
2056 struct iwl_spectrum_cmd {
2057 __le16 len; /* number of bytes starting from token */
2058 u8 token; /* token id */
2059 u8 id; /* measurement id -- 0 or 1 */
2060 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
2061 u8 periodic; /* 1 = periodic */
2062 __le16 path_loss_timeout;
2063 __le32 start_time; /* start time in extended beacon format */
2065 __le32 flags; /* rxon flags */
2066 __le32 filter_flags; /* rxon filter flags */
2067 __le16 channel_count; /* minimum 1, maximum 10 */
2069 struct iwl_measure_channel channels[10];
2073 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
2075 struct iwl_spectrum_resp {
2077 u8 id; /* id of the prior command replaced, or 0xff */
2078 __le16 status; /* 0 - command will be handled
2079 * 1 - cannot handle (conflicts with another
2083 enum iwl_measurement_state {
2084 IWL_MEASUREMENT_START = 0,
2085 IWL_MEASUREMENT_STOP = 1,
2088 enum iwl_measurement_status {
2089 IWL_MEASUREMENT_OK = 0,
2090 IWL_MEASUREMENT_CONCURRENT = 1,
2091 IWL_MEASUREMENT_CSA_CONFLICT = 2,
2092 IWL_MEASUREMENT_TGH_CONFLICT = 3,
2094 IWL_MEASUREMENT_STOPPED = 6,
2095 IWL_MEASUREMENT_TIMEOUT = 7,
2096 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
2099 #define NUM_ELEMENTS_IN_HISTOGRAM 8
2101 struct iwl_measurement_histogram {
2102 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
2103 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
2106 /* clear channel availability counters */
2107 struct iwl_measurement_cca_counters {
2112 enum iwl_measure_type {
2113 IWL_MEASURE_BASIC = (1 << 0),
2114 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
2115 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
2116 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
2117 IWL_MEASURE_FRAME = (1 << 4),
2118 /* bits 5:6 are reserved */
2119 IWL_MEASURE_IDLE = (1 << 7),
2123 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
2125 struct iwl_spectrum_notification {
2126 u8 id; /* measurement id -- 0 or 1 */
2128 u8 channel_index; /* index in measurement channel list */
2129 u8 state; /* 0 - start, 1 - stop */
2130 __le32 start_time; /* lower 32-bits of TSF */
2131 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
2133 u8 type; /* see enum iwl_measurement_type */
2135 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2136 * valid if applicable for measurement type requested. */
2137 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2138 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2139 __le32 cca_time; /* channel load time in usecs */
2140 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2143 struct iwl_measurement_histogram histogram;
2144 __le32 stop_time; /* lower 32-bits of TSF */
2145 __le32 status; /* see iwl_measurement_status */
2148 /******************************************************************************
2150 * Power Management Commands, Responses, Notifications:
2152 *****************************************************************************/
2155 * struct iwl_powertable_cmd - Power Table Command
2156 * @flags: See below:
2158 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2161 * bit 0 - '0' Driver not allow power management
2162 * '1' Driver allow PM (use rest of parameters)
2164 * uCode send sleep notifications:
2165 * bit 1 - '0' Don't send sleep notification
2166 * '1' send sleep notification (SEND_PM_NOTIFICATION)
2169 * bit 2 - '0' PM have to walk up every DTIM
2170 * '1' PM could sleep over DTIM till listen Interval.
2173 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2174 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
2177 * bit 4 - '1' Put radio to sleep when receiving frame for others
2180 * bit 31/30- '00' use both mac/xtal sleeps
2181 * '01' force Mac sleep
2182 * '10' force xtal sleep
2185 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2186 * ucode assume sleep over DTIM is allowed and we don't need to wake up
2189 #define IWL_POWER_VEC_SIZE 5
2191 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
2192 #define IWL_POWER_POWER_SAVE_ENA_MSK cpu_to_le16(BIT(0))
2193 #define IWL_POWER_POWER_MANAGEMENT_ENA_MSK cpu_to_le16(BIT(1))
2194 #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2195 #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2196 #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
2197 #define IWL_POWER_BEACON_FILTERING cpu_to_le16(BIT(5))
2198 #define IWL_POWER_SHADOW_REG_ENA cpu_to_le16(BIT(6))
2199 #define IWL_POWER_CT_KILL_SET cpu_to_le16(BIT(7))
2200 #define IWL_POWER_BT_SCO_ENA cpu_to_le16(BIT(8))
2201 #define IWL_POWER_ADVANCE_PM_ENA_MSK cpu_to_le16(BIT(9))
2203 struct iwl_powertable_cmd {
2205 u8 keep_alive_seconds; /* 3945 reserved */
2206 u8 debug_flags; /* 3945 reserved */
2207 __le32 rx_data_timeout;
2208 __le32 tx_data_timeout;
2209 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2210 __le32 keep_alive_beacons;
2214 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2215 * all devices identical.
2217 struct iwl_sleep_notification {
2226 /* Sleep states. all devices identical. */
2228 IWL_PM_NO_SLEEP = 0,
2230 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2231 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2233 IWL_PM_SLP_REPENT = 5,
2234 IWL_PM_WAKEUP_BY_TIMER = 6,
2235 IWL_PM_WAKEUP_BY_DRIVER = 7,
2236 IWL_PM_WAKEUP_BY_RFKILL = 8,
2238 IWL_PM_NUM_OF_MODES = 12,
2242 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2244 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2245 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2246 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
2247 struct iwl_card_state_cmd {
2248 __le32 status; /* CARD_STATE_CMD_* request new power state */
2252 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2254 struct iwl_card_state_notif {
2258 #define HW_CARD_DISABLED 0x01
2259 #define SW_CARD_DISABLED 0x02
2260 #define CT_CARD_DISABLED 0x04
2261 #define RXON_CARD_DISABLED 0x10
2263 struct iwl_ct_kill_config {
2265 __le32 critical_temperature_M;
2266 __le32 critical_temperature_R;
2269 /* 1000, and 6x00 */
2270 struct iwl_ct_kill_throttling_config {
2271 __le32 critical_temperature_exit;
2273 __le32 critical_temperature_enter;
2276 /******************************************************************************
2278 * Scan Commands, Responses, Notifications:
2280 *****************************************************************************/
2282 #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2283 #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
2286 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2288 * One for each channel in the scan list.
2289 * Each channel can independently select:
2290 * 1) SSID for directed active scans
2291 * 2) Txpower setting (for rate specified within Tx command)
2292 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2293 * quiet_plcp_th, good_CRC_th)
2295 * To avoid uCode errors, make sure the following are true (see comments
2296 * under struct iwl_scan_cmd about max_out_time and quiet_time):
2297 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2298 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2299 * 2) quiet_time <= active_dwell
2300 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2301 * passive_dwell < max_out_time
2302 * active_dwell < max_out_time
2305 struct iwl_scan_channel {
2307 * type is defined as:
2308 * 0:0 1 = active, 0 = passive
2309 * 1:20 SSID direct bit map; if a bit is set, then corresponding
2310 * SSID IE is transmitted in probe request.
2314 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2315 u8 tx_gain; /* gain for analog radio */
2316 u8 dsp_atten; /* gain for DSP */
2317 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2318 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2321 /* set number of direct probes __le32 type */
2322 #define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2325 * struct iwl_ssid_ie - directed scan network information element
2327 * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
2328 * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
2329 * each channel may select different ssids from among the 20 (4) entries.
2330 * SSID IEs get transmitted in reverse order of entry.
2332 struct iwl_ssid_ie {
2338 #define PROBE_OPTION_MAX_3945 4
2339 #define PROBE_OPTION_MAX 20
2340 #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
2341 #define IWL_GOOD_CRC_TH_DISABLED 0
2342 #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
2343 #define IWL_GOOD_CRC_TH_NEVER cpu_to_le16(0xffff)
2344 #define IWL_MAX_SCAN_SIZE 1024
2345 #define IWL_MAX_CMD_SIZE 4096
2348 * REPLY_SCAN_CMD = 0x80 (command)
2350 * The hardware scan command is very powerful; the driver can set it up to
2351 * maintain (relatively) normal network traffic while doing a scan in the
2352 * background. The max_out_time and suspend_time control the ratio of how
2353 * long the device stays on an associated network channel ("service channel")
2354 * vs. how long it's away from the service channel, i.e. tuned to other channels
2357 * max_out_time is the max time off-channel (in usec), and suspend_time
2358 * is how long (in "extended beacon" format) that the scan is "suspended"
2359 * after returning to the service channel. That is, suspend_time is the
2360 * time that we stay on the service channel, doing normal work, between
2361 * scan segments. The driver may set these parameters differently to support
2362 * scanning when associated vs. not associated, and light vs. heavy traffic
2363 * loads when associated.
2365 * After receiving this command, the device's scan engine does the following;
2367 * 1) Sends SCAN_START notification to driver
2368 * 2) Checks to see if it has time to do scan for one channel
2369 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2370 * to tell AP that we're going off-channel
2371 * 4) Tunes to first channel in scan list, does active or passive scan
2372 * 5) Sends SCAN_RESULT notification to driver
2373 * 6) Checks to see if it has time to do scan on *next* channel in list
2374 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2375 * before max_out_time expires
2376 * 8) Returns to service channel
2377 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2378 * 10) Stays on service channel until suspend_time expires
2379 * 11) Repeats entire process 2-10 until list is complete
2380 * 12) Sends SCAN_COMPLETE notification
2382 * For fast, efficient scans, the scan command also has support for staying on
2383 * a channel for just a short time, if doing active scanning and getting no
2384 * responses to the transmitted probe request. This time is controlled by
2385 * quiet_time, and the number of received packets below which a channel is
2386 * considered "quiet" is controlled by quiet_plcp_threshold.
2388 * For active scanning on channels that have regulatory restrictions against
2389 * blindly transmitting, the scan can listen before transmitting, to make sure
2390 * that there is already legitimate activity on the channel. If enough
2391 * packets are cleanly received on the channel (controlled by good_CRC_th,
2392 * typical value 1), the scan engine starts transmitting probe requests.
2394 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2396 * To avoid uCode errors, see timing restrictions described under
2397 * struct iwl_scan_channel.
2400 enum iwl_scan_flags {
2401 /* BIT(0) currently unused */
2402 IWL_SCAN_FLAGS_ACTION_FRAME_TX = BIT(1),
2403 /* bits 2-7 reserved */
2406 struct iwl_scan_cmd {
2408 u8 scan_flags; /* scan flags: see enum iwl_scan_flags */
2409 u8 channel_count; /* # channels in channel list */
2410 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2411 * (only for active scan) */
2412 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2413 __le16 good_CRC_th; /* passive -> active promotion threshold */
2414 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2415 __le32 max_out_time; /* max usec to be away from associated (service)
2417 __le32 suspend_time; /* pause scan this long (in "extended beacon
2418 * format") when returning to service chnl:
2419 * 3945; 31:24 # beacons, 19:0 additional usec,
2420 * 4965; 31:22 # beacons, 21:0 additional usec.
2422 __le32 flags; /* RXON_FLG_* */
2423 __le32 filter_flags; /* RXON_FILTER_* */
2425 /* For active scans (set to all-0s for passive scans).
2426 * Does not include payload. Must specify Tx rate; no rate scaling. */
2427 struct iwl_tx_cmd tx_cmd;
2429 /* For directed active scans (set to all-0s otherwise) */
2430 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2433 * Probe request frame, followed by channel list.
2435 * Size of probe request frame is specified by byte count in tx_cmd.
2436 * Channel list follows immediately after probe request frame.
2437 * Number of channels in list is specified by channel_count.
2438 * Each channel in list is of type:
2440 * struct iwl_scan_channel channels[0];
2442 * NOTE: Only one band of channels can be scanned per pass. You
2443 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2444 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2445 * before requesting another scan.
2450 /* Can abort will notify by complete notification with abort status. */
2451 #define CAN_ABORT_STATUS cpu_to_le32(0x1)
2452 /* complete notification statuses */
2453 #define ABORT_STATUS 0x2
2456 * REPLY_SCAN_CMD = 0x80 (response)
2458 struct iwl_scanreq_notification {
2459 __le32 status; /* 1: okay, 2: cannot fulfill request */
2463 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2465 struct iwl_scanstart_notification {
2468 __le32 beacon_timer;
2475 #define SCAN_OWNER_STATUS 0x1
2476 #define MEASURE_OWNER_STATUS 0x2
2478 #define IWL_PROBE_STATUS_OK 0
2479 #define IWL_PROBE_STATUS_TX_FAILED BIT(0)
2480 /* error statuses combined with TX_FAILED */
2481 #define IWL_PROBE_STATUS_FAIL_TTL BIT(1)
2482 #define IWL_PROBE_STATUS_FAIL_BT BIT(2)
2484 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2486 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2488 struct iwl_scanresults_notification {
2492 u8 num_probe_not_sent; /* not enough time to send */
2495 __le32 statistics[NUMBER_OF_STATISTICS];
2499 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2501 struct iwl_scancomplete_notification {
2502 u8 scanned_channels;
2504 u8 bt_status; /* BT On/Off status */
2511 /******************************************************************************
2513 * IBSS/AP Commands and Notifications:
2515 *****************************************************************************/
2517 enum iwl_ibss_manager {
2518 IWL_NOT_IBSS_MANAGER = 0,
2519 IWL_IBSS_MANAGER = 1,
2523 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2526 struct iwlagn_beacon_notif {
2527 struct iwlagn_tx_resp beacon_notify_hdr;
2530 __le32 ibss_mgr_status;
2534 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2537 struct iwl_tx_beacon_cmd {
2538 struct iwl_tx_cmd tx;
2542 struct ieee80211_hdr frame[0]; /* beacon frame */
2545 /******************************************************************************
2547 * Statistics Commands and Notifications:
2549 *****************************************************************************/
2551 #define IWL_TEMP_CONVERT 260
2553 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2554 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2555 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2557 /* Used for passing to driver number of successes and failures per rate */
2558 struct rate_histogram {
2560 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2561 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2562 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2565 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2566 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2567 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2571 /* statistics command response */
2573 struct statistics_dbg {
2576 __le32 wait_for_silence_timeout_cnt;
2580 struct statistics_rx_phy {
2586 __le32 early_overrun_err;
2588 __le32 false_alarm_cnt;
2589 __le32 fina_sync_err_cnt;
2591 __le32 fina_timeout;
2592 __le32 unresponded_rts;
2593 __le32 rxe_frame_limit_overrun;
2594 __le32 sent_ack_cnt;
2595 __le32 sent_cts_cnt;
2596 __le32 sent_ba_rsp_cnt;
2597 __le32 dsp_self_kill;
2598 __le32 mh_format_err;
2599 __le32 re_acq_main_rssi_sum;
2603 struct statistics_rx_ht_phy {
2606 __le32 early_overrun_err;
2609 __le32 mh_format_err;
2610 __le32 agg_crc32_good;
2611 __le32 agg_mpdu_cnt;
2613 __le32 unsupport_mcs;
2616 #define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)
2618 struct statistics_rx_non_phy {
2619 __le32 bogus_cts; /* CTS received when not expecting CTS */
2620 __le32 bogus_ack; /* ACK received when not expecting ACK */
2621 __le32 non_bssid_frames; /* number of frames with BSSID that
2622 * doesn't belong to the STA BSSID */
2623 __le32 filtered_frames; /* count frames that were dumped in the
2624 * filtering process */
2625 __le32 non_channel_beacons; /* beacons with our bss id but not on
2626 * our serving channel */
2627 __le32 channel_beacons; /* beacons with our bss id and in our
2628 * serving channel */
2629 __le32 num_missed_bcon; /* number of missed beacons */
2630 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2631 * ADC was in saturation */
2632 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2634 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2635 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2636 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2637 __le32 interference_data_flag; /* flag for interference data
2638 * availability. 1 when data is
2640 __le32 channel_load; /* counts RX Enable time in uSec */
2641 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2642 * and CCK) counter */
2643 __le32 beacon_rssi_a;
2644 __le32 beacon_rssi_b;
2645 __le32 beacon_rssi_c;
2646 __le32 beacon_energy_a;
2647 __le32 beacon_energy_b;
2648 __le32 beacon_energy_c;
2651 struct statistics_rx_non_phy_bt {
2652 struct statistics_rx_non_phy common;
2653 /* additional stats for bt */
2654 __le32 num_bt_kills;
2658 struct statistics_rx {
2659 struct statistics_rx_phy ofdm;
2660 struct statistics_rx_phy cck;
2661 struct statistics_rx_non_phy general;
2662 struct statistics_rx_ht_phy ofdm_ht;
2665 struct statistics_rx_bt {
2666 struct statistics_rx_phy ofdm;
2667 struct statistics_rx_phy cck;
2668 struct statistics_rx_non_phy_bt general;
2669 struct statistics_rx_ht_phy ofdm_ht;
2673 * struct statistics_tx_power - current tx power
2675 * @ant_a: current tx power on chain a in 1/2 dB step
2676 * @ant_b: current tx power on chain b in 1/2 dB step
2677 * @ant_c: current tx power on chain c in 1/2 dB step
2679 struct statistics_tx_power {
2686 struct statistics_tx_non_phy_agg {
2688 __le32 ba_reschedule_frames;
2689 __le32 scd_query_agg_frame_cnt;
2690 __le32 scd_query_no_agg;
2691 __le32 scd_query_agg;
2692 __le32 scd_query_mismatch;
2693 __le32 frame_not_ready;
2695 __le32 bt_prio_kill;
2696 __le32 rx_ba_rsp_cnt;
2699 struct statistics_tx {
2700 __le32 preamble_cnt;
2701 __le32 rx_detected_cnt;
2702 __le32 bt_prio_defer_cnt;
2703 __le32 bt_prio_kill_cnt;
2704 __le32 few_bytes_cnt;
2707 __le32 expected_ack_cnt;
2708 __le32 actual_ack_cnt;
2709 __le32 dump_msdu_cnt;
2710 __le32 burst_abort_next_frame_mismatch_cnt;
2711 __le32 burst_abort_missing_next_frame_cnt;
2712 __le32 cts_timeout_collision;
2713 __le32 ack_or_ba_timeout_collision;
2714 struct statistics_tx_non_phy_agg agg;
2716 * "tx_power" are optional parameters provided by uCode,
2717 * 6000 series is the only device provide the information,
2718 * Those are reserved fields for all the other devices
2720 struct statistics_tx_power tx_power;
2725 struct statistics_div {
2734 struct statistics_general_common {
2735 __le32 temperature; /* radio temperature */
2736 __le32 temperature_m; /* for 5000 and up, this is radio voltage */
2737 struct statistics_dbg dbg;
2741 __le32 ttl_timestamp;
2742 struct statistics_div div;
2743 __le32 rx_enable_counter;
2745 * num_of_sos_states:
2746 * count the number of times we have to re-tune
2747 * in order to get out of bad PHY status
2749 __le32 num_of_sos_states;
2752 struct statistics_bt_activity {
2754 __le32 hi_priority_tx_req_cnt;
2755 __le32 hi_priority_tx_denied_cnt;
2756 __le32 lo_priority_tx_req_cnt;
2757 __le32 lo_priority_tx_denied_cnt;
2759 __le32 hi_priority_rx_req_cnt;
2760 __le32 hi_priority_rx_denied_cnt;
2761 __le32 lo_priority_rx_req_cnt;
2762 __le32 lo_priority_rx_denied_cnt;
2765 struct statistics_general {
2766 struct statistics_general_common common;
2771 struct statistics_general_bt {
2772 struct statistics_general_common common;
2773 struct statistics_bt_activity activity;
2778 #define UCODE_STATISTICS_CLEAR_MSK (0x1 << 0)
2779 #define UCODE_STATISTICS_FREQUENCY_MSK (0x1 << 1)
2780 #define UCODE_STATISTICS_NARROW_BAND_MSK (0x1 << 2)
2783 * REPLY_STATISTICS_CMD = 0x9c,
2784 * all devices identical.
2786 * This command triggers an immediate response containing uCode statistics.
2787 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2789 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2790 * internal copy of the statistics (counters) after issuing the response.
2791 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2793 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2794 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2795 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2797 #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
2798 #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
2799 struct iwl_statistics_cmd {
2800 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2804 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2806 * By default, uCode issues this notification after receiving a beacon
2807 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2808 * REPLY_STATISTICS_CMD 0x9c, above.
2810 * Statistics counters continue to increment beacon after beacon, but are
2811 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2812 * 0x9c with CLEAR_STATS bit set (see above).
2814 * uCode also issues this notification during scans. uCode clears statistics
2815 * appropriately so that each notification contains statistics for only the
2816 * one channel that has just been scanned.
2818 #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
2819 #define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)
2821 struct iwl_notif_statistics {
2823 struct statistics_rx rx;
2824 struct statistics_tx tx;
2825 struct statistics_general general;
2828 struct iwl_bt_notif_statistics {
2830 struct statistics_rx_bt rx;
2831 struct statistics_tx tx;
2832 struct statistics_general_bt general;
2836 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2838 * uCode send MISSED_BEACONS_NOTIFICATION to driver when detect beacon missed
2839 * in regardless of how many missed beacons, which mean when driver receive the
2840 * notification, inside the command, it can find all the beacons information
2841 * which include number of total missed beacons, number of consecutive missed
2842 * beacons, number of beacons received and number of beacons expected to
2845 * If uCode detected consecutive_missed_beacons > 5, it will reset the radio
2846 * in order to bring the radio/PHY back to working state; which has no relation
2847 * to when driver will perform sensitivity calibration.
2849 * Driver should set it own missed_beacon_threshold to decide when to perform
2850 * sensitivity calibration based on number of consecutive missed beacons in
2851 * order to improve overall performance, especially in noisy environment.
2855 #define IWL_MISSED_BEACON_THRESHOLD_MIN (1)
2856 #define IWL_MISSED_BEACON_THRESHOLD_DEF (5)
2857 #define IWL_MISSED_BEACON_THRESHOLD_MAX IWL_MISSED_BEACON_THRESHOLD_DEF
2859 struct iwl_missed_beacon_notif {
2860 __le32 consecutive_missed_beacons;
2861 __le32 total_missed_becons;
2862 __le32 num_expected_beacons;
2863 __le32 num_recvd_beacons;
2867 /******************************************************************************
2869 * Rx Calibration Commands:
2871 * With the uCode used for open source drivers, most Tx calibration (except
2872 * for Tx Power) and most Rx calibration is done by uCode during the
2873 * "initialize" phase of uCode boot. Driver must calibrate only:
2875 * 1) Tx power (depends on temperature), described elsewhere
2876 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2877 * 3) Receiver sensitivity (to optimize signal detection)
2879 *****************************************************************************/
2882 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2884 * This command sets up the Rx signal detector for a sensitivity level that
2885 * is high enough to lock onto all signals within the associated network,
2886 * but low enough to ignore signals that are below a certain threshold, so as
2887 * not to have too many "false alarms". False alarms are signals that the
2888 * Rx DSP tries to lock onto, but then discards after determining that they
2891 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2892 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2893 * time listening, not transmitting). Driver must adjust sensitivity so that
2894 * the ratio of actual false alarms to actual Rx time falls within this range.
2896 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2897 * received beacon. These provide information to the driver to analyze the
2898 * sensitivity. Don't analyze statistics that come in from scanning, or any
2899 * other non-associated-network source. Pertinent statistics include:
2901 * From "general" statistics (struct statistics_rx_non_phy):
2903 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2904 * Measure of energy of desired signal. Used for establishing a level
2905 * below which the device does not detect signals.
2907 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2908 * Measure of background noise in silent period after beacon.
2911 * uSecs of actual Rx time during beacon period (varies according to
2912 * how much time was spent transmitting).
2914 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2917 * Signal locks abandoned early (before phy-level header).
2920 * Signal locks abandoned late (during phy-level header).
2922 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2923 * beacon to beacon, i.e. each value is an accumulation of all errors
2924 * before and including the latest beacon. Values will wrap around to 0
2925 * after counting up to 2^32 - 1. Driver must differentiate vs.
2926 * previous beacon's values to determine # false alarms in the current
2929 * Total number of false alarms = false_alarms + plcp_errs
2931 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2932 * (notice that the start points for OFDM are at or close to settings for
2933 * maximum sensitivity):
2936 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2937 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2938 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2939 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2941 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2942 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2943 * by *adding* 1 to all 4 of the table entries above, up to the max for
2944 * each entry. Conversely, if false alarm rate is too low (less than 5
2945 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2946 * increase sensitivity.
2948 * For CCK sensitivity, keep track of the following:
2950 * 1). 20-beacon history of maximum background noise, indicated by
2951 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2952 * 3 receivers. For any given beacon, the "silence reference" is
2953 * the maximum of last 60 samples (20 beacons * 3 receivers).
2955 * 2). 10-beacon history of strongest signal level, as indicated
2956 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2957 * i.e. the strength of the signal through the best receiver at the
2958 * moment. These measurements are "upside down", with lower values
2959 * for stronger signals, so max energy will be *minimum* value.
2961 * Then for any given beacon, the driver must determine the *weakest*
2962 * of the strongest signals; this is the minimum level that needs to be
2963 * successfully detected, when using the best receiver at the moment.
2964 * "Max cck energy" is the maximum (higher value means lower energy!)
2965 * of the last 10 minima. Once this is determined, driver must add
2966 * a little margin by adding "6" to it.
2968 * 3). Number of consecutive beacon periods with too few false alarms.
2969 * Reset this to 0 at the first beacon period that falls within the
2970 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2972 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2973 * (notice that the start points for CCK are at maximum sensitivity):
2976 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2977 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2978 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2980 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2981 * (greater than 50 for each 204.8 msecs listening), method for reducing
2984 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2987 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2988 * sensitivity has been reduced a significant amount; bring it up to
2989 * a moderate 161. Otherwise, *add* 3, up to max 200.
2991 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2992 * sensitivity has been reduced only a moderate or small amount;
2993 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2994 * down to min 0. Otherwise (if gain has been significantly reduced),
2995 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2997 * b) Save a snapshot of the "silence reference".
2999 * If actual rate of CCK false alarms (+ plcp_errors) is too low
3000 * (less than 5 for each 204.8 msecs listening), method for increasing
3001 * sensitivity is used only if:
3003 * 1a) Previous beacon did not have too many false alarms
3004 * 1b) AND difference between previous "silence reference" and current
3005 * "silence reference" (prev - current) is 2 or more,
3006 * OR 2) 100 or more consecutive beacon periods have had rate of
3007 * less than 5 false alarms per 204.8 milliseconds rx time.
3009 * Method for increasing sensitivity:
3011 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
3014 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3017 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
3019 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
3020 * (between 5 and 50 for each 204.8 msecs listening):
3022 * 1) Save a snapshot of the silence reference.
3024 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
3025 * give some extra margin to energy threshold by *subtracting* 8
3026 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
3028 * For all cases (too few, too many, good range), make sure that the CCK
3029 * detection threshold (energy) is below the energy level for robust
3030 * detection over the past 10 beacon periods, the "Max cck energy".
3031 * Lower values mean higher energy; this means making sure that the value
3032 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
3037 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
3039 #define HD_TABLE_SIZE (11) /* number of entries */
3040 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
3041 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
3042 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
3043 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
3044 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
3045 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
3046 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
3047 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
3048 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
3049 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
3050 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
3053 * Additional table entries in enhance SENSITIVITY_CMD
3055 #define HD_INA_NON_SQUARE_DET_OFDM_INDEX (11)
3056 #define HD_INA_NON_SQUARE_DET_CCK_INDEX (12)
3057 #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_INDEX (13)
3058 #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_INDEX (14)
3059 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (15)
3060 #define HD_OFDM_NON_SQUARE_DET_SLOPE_INDEX (16)
3061 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_INDEX (17)
3062 #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_INDEX (18)
3063 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (19)
3064 #define HD_CCK_NON_SQUARE_DET_SLOPE_INDEX (20)
3065 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_INDEX (21)
3066 #define HD_RESERVED (22)
3068 /* number of entries for enhanced tbl */
3069 #define ENHANCE_HD_TABLE_SIZE (23)
3071 /* number of additional entries for enhanced tbl */
3072 #define ENHANCE_HD_TABLE_ENTRIES (ENHANCE_HD_TABLE_SIZE - HD_TABLE_SIZE)
3074 #define HD_INA_NON_SQUARE_DET_OFDM_DATA_V1 cpu_to_le16(0)
3075 #define HD_INA_NON_SQUARE_DET_CCK_DATA_V1 cpu_to_le16(0)
3076 #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA_V1 cpu_to_le16(0)
3077 #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA_V1 cpu_to_le16(668)
3078 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA_V1 cpu_to_le16(4)
3079 #define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA_V1 cpu_to_le16(486)
3080 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA_V1 cpu_to_le16(37)
3081 #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA_V1 cpu_to_le16(853)
3082 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA_V1 cpu_to_le16(4)
3083 #define HD_CCK_NON_SQUARE_DET_SLOPE_DATA_V1 cpu_to_le16(476)
3084 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA_V1 cpu_to_le16(99)
3086 #define HD_INA_NON_SQUARE_DET_OFDM_DATA_V2 cpu_to_le16(1)
3087 #define HD_INA_NON_SQUARE_DET_CCK_DATA_V2 cpu_to_le16(1)
3088 #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA_V2 cpu_to_le16(1)
3089 #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA_V2 cpu_to_le16(600)
3090 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA_V2 cpu_to_le16(40)
3091 #define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA_V2 cpu_to_le16(486)
3092 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA_V2 cpu_to_le16(45)
3093 #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA_V2 cpu_to_le16(853)
3094 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA_V2 cpu_to_le16(60)
3095 #define HD_CCK_NON_SQUARE_DET_SLOPE_DATA_V2 cpu_to_le16(476)
3096 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA_V2 cpu_to_le16(99)
3099 /* Control field in struct iwl_sensitivity_cmd */
3100 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
3101 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
3104 * struct iwl_sensitivity_cmd
3105 * @control: (1) updates working table, (0) updates default table
3106 * @table: energy threshold values, use HD_* as index into table
3108 * Always use "1" in "control" to update uCode's working table and DSP.
3110 struct iwl_sensitivity_cmd {
3111 __le16 control; /* always use "1" */
3112 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
3118 struct iwl_enhance_sensitivity_cmd {
3119 __le16 control; /* always use "1" */
3120 __le16 enhance_table[ENHANCE_HD_TABLE_SIZE]; /* use HD_* as index */
3125 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
3127 * This command sets the relative gains of agn device's 3 radio receiver chains.
3129 * After the first association, driver should accumulate signal and noise
3130 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
3131 * beacons from the associated network (don't collect statistics that come
3132 * in from scanning, or any other non-network source).
3134 * DISCONNECTED ANTENNA:
3136 * Driver should determine which antennas are actually connected, by comparing
3137 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
3138 * following values over 20 beacons, one accumulator for each of the chains
3139 * a/b/c, from struct statistics_rx_non_phy:
3141 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
3143 * Find the strongest signal from among a/b/c. Compare the other two to the
3144 * strongest. If any signal is more than 15 dB (times 20, unless you
3145 * divide the accumulated values by 20) below the strongest, the driver
3146 * considers that antenna to be disconnected, and should not try to use that
3147 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
3148 * driver should declare the stronger one as connected, and attempt to use it
3149 * (A and B are the only 2 Tx chains!).
3154 * Driver should balance the 3 receivers (but just the ones that are connected
3155 * to antennas, see above) for gain, by comparing the average signal levels
3156 * detected during the silence after each beacon (background noise).
3157 * Accumulate (add) the following values over 20 beacons, one accumulator for
3158 * each of the chains a/b/c, from struct statistics_rx_non_phy:
3160 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
3162 * Find the weakest background noise level from among a/b/c. This Rx chain
3163 * will be the reference, with 0 gain adjustment. Attenuate other channels by
3164 * finding noise difference:
3166 * (accum_noise[i] - accum_noise[reference]) / 30
3168 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
3169 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
3170 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3171 * and set bit 2 to indicate "reduce gain". The value for the reference
3172 * (weakest) chain should be "0".
3174 * diff_gain_[abc] bit fields:
3175 * 2: (1) reduce gain, (0) increase gain
3176 * 1-0: amount of gain, units of 1.5 dB
3179 /* Phy calibration command for series */
3180 /* The default calibrate table size if not specified by firmware */
3181 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
3183 IWL_PHY_CALIBRATE_DC_CMD = 8,
3184 IWL_PHY_CALIBRATE_LO_CMD = 9,
3185 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
3186 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
3187 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
3188 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
3189 IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD = 18,
3190 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19,
3193 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE (253)
3195 /* This enum defines the bitmap of various calibrations to enable in both
3196 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
3198 enum iwl_ucode_calib_cfg {
3199 IWL_CALIB_CFG_RX_BB_IDX = BIT(0),
3200 IWL_CALIB_CFG_DC_IDX = BIT(1),
3201 IWL_CALIB_CFG_LO_IDX = BIT(2),
3202 IWL_CALIB_CFG_TX_IQ_IDX = BIT(3),
3203 IWL_CALIB_CFG_RX_IQ_IDX = BIT(4),
3204 IWL_CALIB_CFG_NOISE_IDX = BIT(5),
3205 IWL_CALIB_CFG_CRYSTAL_IDX = BIT(6),
3206 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(7),
3207 IWL_CALIB_CFG_PAPD_IDX = BIT(8),
3208 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(9),
3209 IWL_CALIB_CFG_TX_PWR_IDX = BIT(10),
3212 #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(IWL_CALIB_CFG_RX_BB_IDX | \
3213 IWL_CALIB_CFG_DC_IDX | \
3214 IWL_CALIB_CFG_LO_IDX | \
3215 IWL_CALIB_CFG_TX_IQ_IDX | \
3216 IWL_CALIB_CFG_RX_IQ_IDX | \
3217 IWL_CALIB_CFG_CRYSTAL_IDX)
3219 #define IWL_CALIB_RT_CFG_ALL cpu_to_le32(IWL_CALIB_CFG_RX_BB_IDX | \
3220 IWL_CALIB_CFG_DC_IDX | \
3221 IWL_CALIB_CFG_LO_IDX | \
3222 IWL_CALIB_CFG_TX_IQ_IDX | \
3223 IWL_CALIB_CFG_RX_IQ_IDX | \
3224 IWL_CALIB_CFG_TEMPERATURE_IDX | \
3225 IWL_CALIB_CFG_PAPD_IDX | \
3226 IWL_CALIB_CFG_TX_PWR_IDX | \
3227 IWL_CALIB_CFG_CRYSTAL_IDX)
3229 #define IWL_CALIB_CFG_FLAG_SEND_COMPLETE_NTFY_MSK cpu_to_le32(BIT(0))
3231 struct iwl_calib_cfg_elmnt_s {
3239 struct iwl_calib_cfg_status_s {
3240 struct iwl_calib_cfg_elmnt_s once;
3241 struct iwl_calib_cfg_elmnt_s perd;
3245 struct iwl_calib_cfg_cmd {
3246 struct iwl_calib_cfg_status_s ucd_calib_cfg;
3247 struct iwl_calib_cfg_status_s drv_calib_cfg;
3251 struct iwl_calib_hdr {
3258 struct iwl_calib_cmd {
3259 struct iwl_calib_hdr hdr;
3263 struct iwl_calib_xtal_freq_cmd {
3264 struct iwl_calib_hdr hdr;
3270 #define DEFAULT_RADIO_SENSOR_OFFSET cpu_to_le16(2700)
3271 struct iwl_calib_temperature_offset_cmd {
3272 struct iwl_calib_hdr hdr;
3273 __le16 radio_sensor_offset;
3277 struct iwl_calib_temperature_offset_v2_cmd {
3278 struct iwl_calib_hdr hdr;
3279 __le16 radio_sensor_offset_high;
3280 __le16 radio_sensor_offset_low;
3281 __le16 burntVoltageRef;
3285 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
3286 struct iwl_calib_chain_noise_reset_cmd {
3287 struct iwl_calib_hdr hdr;
3291 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
3292 struct iwl_calib_chain_noise_gain_cmd {
3293 struct iwl_calib_hdr hdr;
3299 /******************************************************************************
3301 * Miscellaneous Commands:
3303 *****************************************************************************/
3306 * LEDs Command & Response
3307 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
3309 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
3310 * this command turns it on or off, or sets up a periodic blinking cycle.
3312 struct iwl_led_cmd {
3313 __le32 interval; /* "interval" in uSec */
3314 u8 id; /* 1: Activity, 2: Link, 3: Tech */
3315 u8 off; /* # intervals off while blinking;
3316 * "0", with >0 "on" value, turns LED on */
3317 u8 on; /* # intervals on while blinking;
3318 * "0", regardless of "off", turns LED off */
3323 * station priority table entries
3324 * also used as potential "events" value for both
3325 * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
3329 * COEX events entry flag masks
3330 * RP - Requested Priority
3331 * WP - Win Medium Priority: priority assigned when the contention has been won
3333 #define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG (0x1)
3334 #define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG (0x2)
3335 #define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG (0x4)
3337 #define COEX_CU_UNASSOC_IDLE_RP 4
3338 #define COEX_CU_UNASSOC_MANUAL_SCAN_RP 4
3339 #define COEX_CU_UNASSOC_AUTO_SCAN_RP 4
3340 #define COEX_CU_CALIBRATION_RP 4
3341 #define COEX_CU_PERIODIC_CALIBRATION_RP 4
3342 #define COEX_CU_CONNECTION_ESTAB_RP 4
3343 #define COEX_CU_ASSOCIATED_IDLE_RP 4
3344 #define COEX_CU_ASSOC_MANUAL_SCAN_RP 4
3345 #define COEX_CU_ASSOC_AUTO_SCAN_RP 4
3346 #define COEX_CU_ASSOC_ACTIVE_LEVEL_RP 4
3347 #define COEX_CU_RF_ON_RP 6
3348 #define COEX_CU_RF_OFF_RP 4
3349 #define COEX_CU_STAND_ALONE_DEBUG_RP 6
3350 #define COEX_CU_IPAN_ASSOC_LEVEL_RP 4
3351 #define COEX_CU_RSRVD1_RP 4
3352 #define COEX_CU_RSRVD2_RP 4
3354 #define COEX_CU_UNASSOC_IDLE_WP 3
3355 #define COEX_CU_UNASSOC_MANUAL_SCAN_WP 3
3356 #define COEX_CU_UNASSOC_AUTO_SCAN_WP 3
3357 #define COEX_CU_CALIBRATION_WP 3
3358 #define COEX_CU_PERIODIC_CALIBRATION_WP 3
3359 #define COEX_CU_CONNECTION_ESTAB_WP 3
3360 #define COEX_CU_ASSOCIATED_IDLE_WP 3
3361 #define COEX_CU_ASSOC_MANUAL_SCAN_WP 3
3362 #define COEX_CU_ASSOC_AUTO_SCAN_WP 3
3363 #define COEX_CU_ASSOC_ACTIVE_LEVEL_WP 3
3364 #define COEX_CU_RF_ON_WP 3
3365 #define COEX_CU_RF_OFF_WP 3
3366 #define COEX_CU_STAND_ALONE_DEBUG_WP 6
3367 #define COEX_CU_IPAN_ASSOC_LEVEL_WP 3
3368 #define COEX_CU_RSRVD1_WP 3
3369 #define COEX_CU_RSRVD2_WP 3
3371 #define COEX_UNASSOC_IDLE_FLAGS 0
3372 #define COEX_UNASSOC_MANUAL_SCAN_FLAGS \
3373 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3374 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3375 #define COEX_UNASSOC_AUTO_SCAN_FLAGS \
3376 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3377 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3378 #define COEX_CALIBRATION_FLAGS \
3379 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3380 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3381 #define COEX_PERIODIC_CALIBRATION_FLAGS 0
3383 * COEX_CONNECTION_ESTAB:
3384 * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3386 #define COEX_CONNECTION_ESTAB_FLAGS \
3387 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3388 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3389 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3390 #define COEX_ASSOCIATED_IDLE_FLAGS 0
3391 #define COEX_ASSOC_MANUAL_SCAN_FLAGS \
3392 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3393 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3394 #define COEX_ASSOC_AUTO_SCAN_FLAGS \
3395 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3396 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3397 #define COEX_ASSOC_ACTIVE_LEVEL_FLAGS 0
3398 #define COEX_RF_ON_FLAGS 0
3399 #define COEX_RF_OFF_FLAGS 0
3400 #define COEX_STAND_ALONE_DEBUG_FLAGS \
3401 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3402 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3403 #define COEX_IPAN_ASSOC_LEVEL_FLAGS \
3404 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3405 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3406 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3407 #define COEX_RSRVD1_FLAGS 0
3408 #define COEX_RSRVD2_FLAGS 0
3410 * COEX_CU_RF_ON is the event wrapping all radio ownership.
3411 * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3413 #define COEX_CU_RF_ON_FLAGS \
3414 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3415 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3416 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3420 /* un-association part */
3421 COEX_UNASSOC_IDLE = 0,
3422 COEX_UNASSOC_MANUAL_SCAN = 1,
3423 COEX_UNASSOC_AUTO_SCAN = 2,
3425 COEX_CALIBRATION = 3,
3426 COEX_PERIODIC_CALIBRATION = 4,
3428 COEX_CONNECTION_ESTAB = 5,
3429 /* association part */
3430 COEX_ASSOCIATED_IDLE = 6,
3431 COEX_ASSOC_MANUAL_SCAN = 7,
3432 COEX_ASSOC_AUTO_SCAN = 8,
3433 COEX_ASSOC_ACTIVE_LEVEL = 9,
3437 COEX_STAND_ALONE_DEBUG = 12,
3439 COEX_IPAN_ASSOC_LEVEL = 13,
3443 COEX_NUM_OF_EVENTS = 16
3447 * Coexistence WIFI/WIMAX Command
3448 * COEX_PRIORITY_TABLE_CMD = 0x5a
3451 struct iwl_wimax_coex_event_entry {
3458 /* COEX flag masks */
3460 /* Station table is valid */
3461 #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
3462 /* UnMask wake up src at unassociated sleep */
3463 #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
3464 /* UnMask wake up src at associated sleep */
3465 #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3466 /* Enable CoEx feature. */
3467 #define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3469 struct iwl_wimax_coex_cmd {
3472 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3476 * Coexistence MEDIUM NOTIFICATION
3477 * COEX_MEDIUM_NOTIFICATION = 0x5b
3479 * notification from uCode to host to indicate medium changes
3484 * bit 0 - 2: medium status
3485 * bit 3: medium change indication
3486 * bit 4 - 31: reserved
3488 /* status option values, (0 - 2 bits) */
3489 #define COEX_MEDIUM_BUSY (0x0) /* radio belongs to WiMAX */
3490 #define COEX_MEDIUM_ACTIVE (0x1) /* radio belongs to WiFi */
3491 #define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */
3492 #define COEX_MEDIUM_MSK (0x7)
3494 /* send notification status (1 bit) */
3495 #define COEX_MEDIUM_CHANGED (0x8)
3496 #define COEX_MEDIUM_CHANGED_MSK (0x8)
3497 #define COEX_MEDIUM_SHIFT (3)
3499 struct iwl_coex_medium_notification {
3505 * Coexistence EVENT Command
3506 * COEX_EVENT_CMD = 0x5c
3508 * send from host to uCode for coex event request.
3511 #define COEX_EVENT_REQUEST_MSK (0x1)
3513 struct iwl_coex_event_cmd {
3519 struct iwl_coex_event_resp {
3524 /******************************************************************************
3525 * Bluetooth Coexistence commands
3527 *****************************************************************************/
3530 * BT Status notification
3531 * REPLY_BT_COEX_PROFILE_NOTIF = 0xce
3533 enum iwl_bt_coex_profile_traffic_load {
3534 IWL_BT_COEX_TRAFFIC_LOAD_NONE = 0,
3535 IWL_BT_COEX_TRAFFIC_LOAD_LOW = 1,
3536 IWL_BT_COEX_TRAFFIC_LOAD_HIGH = 2,
3537 IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS = 3,
3539 * There are no more even though below is a u8, the
3540 * indication from the BT device only has two bits.
3544 #define BT_SESSION_ACTIVITY_1_UART_MSG 0x1
3545 #define BT_SESSION_ACTIVITY_2_UART_MSG 0x2
3547 /* BT UART message - Share Part (BT -> WiFi) */
3548 #define BT_UART_MSG_FRAME1MSGTYPE_POS (0)
3549 #define BT_UART_MSG_FRAME1MSGTYPE_MSK \
3550 (0x7 << BT_UART_MSG_FRAME1MSGTYPE_POS)
3551 #define BT_UART_MSG_FRAME1SSN_POS (3)
3552 #define BT_UART_MSG_FRAME1SSN_MSK \
3553 (0x3 << BT_UART_MSG_FRAME1SSN_POS)
3554 #define BT_UART_MSG_FRAME1UPDATEREQ_POS (5)
3555 #define BT_UART_MSG_FRAME1UPDATEREQ_MSK \
3556 (0x1 << BT_UART_MSG_FRAME1UPDATEREQ_POS)
3557 #define BT_UART_MSG_FRAME1RESERVED_POS (6)
3558 #define BT_UART_MSG_FRAME1RESERVED_MSK \
3559 (0x3 << BT_UART_MSG_FRAME1RESERVED_POS)
3561 #define BT_UART_MSG_FRAME2OPENCONNECTIONS_POS (0)
3562 #define BT_UART_MSG_FRAME2OPENCONNECTIONS_MSK \
3563 (0x3 << BT_UART_MSG_FRAME2OPENCONNECTIONS_POS)
3564 #define BT_UART_MSG_FRAME2TRAFFICLOAD_POS (2)
3565 #define BT_UART_MSG_FRAME2TRAFFICLOAD_MSK \
3566 (0x3 << BT_UART_MSG_FRAME2TRAFFICLOAD_POS)
3567 #define BT_UART_MSG_FRAME2CHLSEQN_POS (4)
3568 #define BT_UART_MSG_FRAME2CHLSEQN_MSK \
3569 (0x1 << BT_UART_MSG_FRAME2CHLSEQN_POS)
3570 #define BT_UART_MSG_FRAME2INBAND_POS (5)
3571 #define BT_UART_MSG_FRAME2INBAND_MSK \
3572 (0x1 << BT_UART_MSG_FRAME2INBAND_POS)
3573 #define BT_UART_MSG_FRAME2RESERVED_POS (6)
3574 #define BT_UART_MSG_FRAME2RESERVED_MSK \
3575 (0x3 << BT_UART_MSG_FRAME2RESERVED_POS)
3577 #define BT_UART_MSG_FRAME3SCOESCO_POS (0)
3578 #define BT_UART_MSG_FRAME3SCOESCO_MSK \
3579 (0x1 << BT_UART_MSG_FRAME3SCOESCO_POS)
3580 #define BT_UART_MSG_FRAME3SNIFF_POS (1)
3581 #define BT_UART_MSG_FRAME3SNIFF_MSK \
3582 (0x1 << BT_UART_MSG_FRAME3SNIFF_POS)
3583 #define BT_UART_MSG_FRAME3A2DP_POS (2)
3584 #define BT_UART_MSG_FRAME3A2DP_MSK \
3585 (0x1 << BT_UART_MSG_FRAME3A2DP_POS)
3586 #define BT_UART_MSG_FRAME3ACL_POS (3)
3587 #define BT_UART_MSG_FRAME3ACL_MSK \
3588 (0x1 << BT_UART_MSG_FRAME3ACL_POS)
3589 #define BT_UART_MSG_FRAME3MASTER_POS (4)
3590 #define BT_UART_MSG_FRAME3MASTER_MSK \
3591 (0x1 << BT_UART_MSG_FRAME3MASTER_POS)
3592 #define BT_UART_MSG_FRAME3OBEX_POS (5)
3593 #define BT_UART_MSG_FRAME3OBEX_MSK \
3594 (0x1 << BT_UART_MSG_FRAME3OBEX_POS)
3595 #define BT_UART_MSG_FRAME3RESERVED_POS (6)
3596 #define BT_UART_MSG_FRAME3RESERVED_MSK \
3597 (0x3 << BT_UART_MSG_FRAME3RESERVED_POS)
3599 #define BT_UART_MSG_FRAME4IDLEDURATION_POS (0)
3600 #define BT_UART_MSG_FRAME4IDLEDURATION_MSK \
3601 (0x3F << BT_UART_MSG_FRAME4IDLEDURATION_POS)
3602 #define BT_UART_MSG_FRAME4RESERVED_POS (6)
3603 #define BT_UART_MSG_FRAME4RESERVED_MSK \
3604 (0x3 << BT_UART_MSG_FRAME4RESERVED_POS)
3606 #define BT_UART_MSG_FRAME5TXACTIVITY_POS (0)
3607 #define BT_UART_MSG_FRAME5TXACTIVITY_MSK \
3608 (0x3 << BT_UART_MSG_FRAME5TXACTIVITY_POS)
3609 #define BT_UART_MSG_FRAME5RXACTIVITY_POS (2)
3610 #define BT_UART_MSG_FRAME5RXACTIVITY_MSK \
3611 (0x3 << BT_UART_MSG_FRAME5RXACTIVITY_POS)
3612 #define BT_UART_MSG_FRAME5ESCORETRANSMIT_POS (4)
3613 #define BT_UART_MSG_FRAME5ESCORETRANSMIT_MSK \
3614 (0x3 << BT_UART_MSG_FRAME5ESCORETRANSMIT_POS)
3615 #define BT_UART_MSG_FRAME5RESERVED_POS (6)
3616 #define BT_UART_MSG_FRAME5RESERVED_MSK \
3617 (0x3 << BT_UART_MSG_FRAME5RESERVED_POS)
3619 #define BT_UART_MSG_FRAME6SNIFFINTERVAL_POS (0)
3620 #define BT_UART_MSG_FRAME6SNIFFINTERVAL_MSK \
3621 (0x1F << BT_UART_MSG_FRAME6SNIFFINTERVAL_POS)
3622 #define BT_UART_MSG_FRAME6DISCOVERABLE_POS (5)
3623 #define BT_UART_MSG_FRAME6DISCOVERABLE_MSK \
3624 (0x1 << BT_UART_MSG_FRAME6DISCOVERABLE_POS)
3625 #define BT_UART_MSG_FRAME6RESERVED_POS (6)
3626 #define BT_UART_MSG_FRAME6RESERVED_MSK \
3627 (0x3 << BT_UART_MSG_FRAME6RESERVED_POS)
3629 #define BT_UART_MSG_FRAME7SNIFFACTIVITY_POS (0)
3630 #define BT_UART_MSG_FRAME7SNIFFACTIVITY_MSK \
3631 (0x7 << BT_UART_MSG_FRAME7SNIFFACTIVITY_POS)
3632 #define BT_UART_MSG_FRAME7PAGE_POS (3)
3633 #define BT_UART_MSG_FRAME7PAGE_MSK \
3634 (0x1 << BT_UART_MSG_FRAME7PAGE_POS)
3635 #define BT_UART_MSG_FRAME7INQUIRY_POS (4)
3636 #define BT_UART_MSG_FRAME7INQUIRY_MSK \
3637 (0x1 << BT_UART_MSG_FRAME7INQUIRY_POS)
3638 #define BT_UART_MSG_FRAME7CONNECTABLE_POS (5)
3639 #define BT_UART_MSG_FRAME7CONNECTABLE_MSK \
3640 (0x1 << BT_UART_MSG_FRAME7CONNECTABLE_POS)
3641 #define BT_UART_MSG_FRAME7RESERVED_POS (6)
3642 #define BT_UART_MSG_FRAME7RESERVED_MSK \
3643 (0x3 << BT_UART_MSG_FRAME7RESERVED_POS)
3645 /* BT Session Activity 2 UART message (BT -> WiFi) */
3646 #define BT_UART_MSG_2_FRAME1RESERVED1_POS (5)
3647 #define BT_UART_MSG_2_FRAME1RESERVED1_MSK \
3648 (0x1<<BT_UART_MSG_2_FRAME1RESERVED1_POS)
3649 #define BT_UART_MSG_2_FRAME1RESERVED2_POS (6)
3650 #define BT_UART_MSG_2_FRAME1RESERVED2_MSK \
3651 (0x3<<BT_UART_MSG_2_FRAME1RESERVED2_POS)
3653 #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS (0)
3654 #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_MSK \
3655 (0x3F<<BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS)
3656 #define BT_UART_MSG_2_FRAME2RESERVED_POS (6)
3657 #define BT_UART_MSG_2_FRAME2RESERVED_MSK \
3658 (0x3<<BT_UART_MSG_2_FRAME2RESERVED_POS)
3660 #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS (0)
3661 #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_MSK \
3662 (0xF<<BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS)
3663 #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS (4)
3664 #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_MSK \
3665 (0x1<<BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS)
3666 #define BT_UART_MSG_2_FRAME3LEMASTER_POS (5)
3667 #define BT_UART_MSG_2_FRAME3LEMASTER_MSK \
3668 (0x1<<BT_UART_MSG_2_FRAME3LEMASTER_POS)
3669 #define BT_UART_MSG_2_FRAME3RESERVED_POS (6)
3670 #define BT_UART_MSG_2_FRAME3RESERVED_MSK \
3671 (0x3<<BT_UART_MSG_2_FRAME3RESERVED_POS)
3673 #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS (0)
3674 #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_MSK \
3675 (0xF<<BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS)
3676 #define BT_UART_MSG_2_FRAME4NUMLECONN_POS (4)
3677 #define BT_UART_MSG_2_FRAME4NUMLECONN_MSK \
3678 (0x3<<BT_UART_MSG_2_FRAME4NUMLECONN_POS)
3679 #define BT_UART_MSG_2_FRAME4RESERVED_POS (6)
3680 #define BT_UART_MSG_2_FRAME4RESERVED_MSK \
3681 (0x3<<BT_UART_MSG_2_FRAME4RESERVED_POS)
3683 #define BT_UART_MSG_2_FRAME5BTMINRSSI_POS (0)
3684 #define BT_UART_MSG_2_FRAME5BTMINRSSI_MSK \
3685 (0xF<<BT_UART_MSG_2_FRAME5BTMINRSSI_POS)
3686 #define BT_UART_MSG_2_FRAME5LESCANINITMODE_POS (4)
3687 #define BT_UART_MSG_2_FRAME5LESCANINITMODE_MSK \
3688 (0x1<<BT_UART_MSG_2_FRAME5LESCANINITMODE_POS)
3689 #define BT_UART_MSG_2_FRAME5LEADVERMODE_POS (5)
3690 #define BT_UART_MSG_2_FRAME5LEADVERMODE_MSK \
3691 (0x1<<BT_UART_MSG_2_FRAME5LEADVERMODE_POS)
3692 #define BT_UART_MSG_2_FRAME5RESERVED_POS (6)
3693 #define BT_UART_MSG_2_FRAME5RESERVED_MSK \
3694 (0x3<<BT_UART_MSG_2_FRAME5RESERVED_POS)
3696 #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS (0)
3697 #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_MSK \
3698 (0x1F<<BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS)
3699 #define BT_UART_MSG_2_FRAME6RFU_POS (5)
3700 #define BT_UART_MSG_2_FRAME6RFU_MSK \
3701 (0x1<<BT_UART_MSG_2_FRAME6RFU_POS)
3702 #define BT_UART_MSG_2_FRAME6RESERVED_POS (6)
3703 #define BT_UART_MSG_2_FRAME6RESERVED_MSK \
3704 (0x3<<BT_UART_MSG_2_FRAME6RESERVED_POS)
3706 #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS (0)
3707 #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_MSK \
3708 (0x7<<BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS)
3709 #define BT_UART_MSG_2_FRAME7LEPROFILE1_POS (3)
3710 #define BT_UART_MSG_2_FRAME7LEPROFILE1_MSK \
3711 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE1_POS)
3712 #define BT_UART_MSG_2_FRAME7LEPROFILE2_POS (4)
3713 #define BT_UART_MSG_2_FRAME7LEPROFILE2_MSK \
3714 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE2_POS)
3715 #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS (5)
3716 #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_MSK \
3717 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS)
3718 #define BT_UART_MSG_2_FRAME7RESERVED_POS (6)
3719 #define BT_UART_MSG_2_FRAME7RESERVED_MSK \
3720 (0x3<<BT_UART_MSG_2_FRAME7RESERVED_POS)
3723 struct iwl_bt_uart_msg {
3732 } __attribute__((packed));
3734 struct iwl_bt_coex_profile_notif {
3735 struct iwl_bt_uart_msg last_bt_uart_msg;
3736 u8 bt_status; /* 0 - off, 1 - on */
3737 u8 bt_traffic_load; /* 0 .. 3? */
3738 u8 bt_ci_compliance; /* 0 - not complied, 1 - complied */
3740 } __attribute__((packed));
3742 #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS 0
3743 #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_MSK 0x1
3744 #define IWL_BT_COEX_PRIO_TBL_PRIO_POS 1
3745 #define IWL_BT_COEX_PRIO_TBL_PRIO_MASK 0x0e
3746 #define IWL_BT_COEX_PRIO_TBL_RESERVED_POS 4
3747 #define IWL_BT_COEX_PRIO_TBL_RESERVED_MASK 0xf0
3748 #define IWL_BT_COEX_PRIO_TBL_PRIO_SHIFT 1
3751 * BT Coexistence Priority table
3752 * REPLY_BT_COEX_PRIO_TABLE = 0xcc
3754 enum bt_coex_prio_table_events {
3755 BT_COEX_PRIO_TBL_EVT_INIT_CALIB1 = 0,
3756 BT_COEX_PRIO_TBL_EVT_INIT_CALIB2 = 1,
3757 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1 = 2,
3758 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2 = 3, /* DC calib */
3759 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1 = 4,
3760 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2 = 5,
3761 BT_COEX_PRIO_TBL_EVT_DTIM = 6,
3762 BT_COEX_PRIO_TBL_EVT_SCAN52 = 7,
3763 BT_COEX_PRIO_TBL_EVT_SCAN24 = 8,
3764 BT_COEX_PRIO_TBL_EVT_RESERVED0 = 9,
3765 BT_COEX_PRIO_TBL_EVT_RESERVED1 = 10,
3766 BT_COEX_PRIO_TBL_EVT_RESERVED2 = 11,
3767 BT_COEX_PRIO_TBL_EVT_RESERVED3 = 12,
3768 BT_COEX_PRIO_TBL_EVT_RESERVED4 = 13,
3769 BT_COEX_PRIO_TBL_EVT_RESERVED5 = 14,
3770 BT_COEX_PRIO_TBL_EVT_RESERVED6 = 15,
3771 /* BT_COEX_PRIO_TBL_EVT_MAX should always be last */
3772 BT_COEX_PRIO_TBL_EVT_MAX,
3775 enum bt_coex_prio_table_priorities {
3776 BT_COEX_PRIO_TBL_DISABLED = 0,
3777 BT_COEX_PRIO_TBL_PRIO_LOW = 1,
3778 BT_COEX_PRIO_TBL_PRIO_HIGH = 2,
3779 BT_COEX_PRIO_TBL_PRIO_BYPASS = 3,
3780 BT_COEX_PRIO_TBL_PRIO_COEX_OFF = 4,
3781 BT_COEX_PRIO_TBL_PRIO_COEX_ON = 5,
3782 BT_COEX_PRIO_TBL_PRIO_RSRVD1 = 6,
3783 BT_COEX_PRIO_TBL_PRIO_RSRVD2 = 7,
3784 BT_COEX_PRIO_TBL_MAX,
3787 struct iwl_bt_coex_prio_table_cmd {
3788 u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
3789 } __attribute__((packed));
3791 #define IWL_BT_COEX_ENV_CLOSE 0
3792 #define IWL_BT_COEX_ENV_OPEN 1
3794 * BT Protection Envelope
3795 * REPLY_BT_COEX_PROT_ENV = 0xcd
3797 struct iwl_bt_coex_prot_env_cmd {
3798 u8 action; /* 0 = closed, 1 = open */
3799 u8 type; /* 0 .. 15 */
3801 } __attribute__((packed));
3804 * REPLY_WOWLAN_PATTERNS
3806 #define IWLAGN_WOWLAN_MIN_PATTERN_LEN 16
3807 #define IWLAGN_WOWLAN_MAX_PATTERN_LEN 128
3809 struct iwlagn_wowlan_pattern {
3810 u8 mask[IWLAGN_WOWLAN_MAX_PATTERN_LEN / 8];
3811 u8 pattern[IWLAGN_WOWLAN_MAX_PATTERN_LEN];
3817 #define IWLAGN_WOWLAN_MAX_PATTERNS 20
3819 struct iwlagn_wowlan_patterns_cmd {
3821 struct iwlagn_wowlan_pattern patterns[];
3825 * REPLY_WOWLAN_WAKEUP_FILTER
3827 enum iwlagn_wowlan_wakeup_filters {
3828 IWLAGN_WOWLAN_WAKEUP_MAGIC_PACKET = BIT(0),
3829 IWLAGN_WOWLAN_WAKEUP_PATTERN_MATCH = BIT(1),
3830 IWLAGN_WOWLAN_WAKEUP_BEACON_MISS = BIT(2),
3831 IWLAGN_WOWLAN_WAKEUP_LINK_CHANGE = BIT(3),
3832 IWLAGN_WOWLAN_WAKEUP_GTK_REKEY_FAIL = BIT(4),
3833 IWLAGN_WOWLAN_WAKEUP_RFKILL = BIT(5),
3834 IWLAGN_WOWLAN_WAKEUP_UCODE_ERROR = BIT(6),
3835 IWLAGN_WOWLAN_WAKEUP_EAP_IDENT_REQ = BIT(7),
3836 IWLAGN_WOWLAN_WAKEUP_4WAY_HANDSHAKE = BIT(8),
3837 IWLAGN_WOWLAN_WAKEUP_ALWAYS = BIT(9),
3838 IWLAGN_WOWLAN_WAKEUP_ENABLE_NET_DETECT = BIT(10),
3841 struct iwlagn_wowlan_wakeup_filter_cmd {
3844 u8 min_sleep_seconds;
3850 * REPLY_WOWLAN_TSC_RSC_PARAMS
3852 #define IWLAGN_NUM_RSC 16
3860 struct iwlagn_tkip_rsc_tsc {
3861 struct tkip_sc unicast_rsc[IWLAGN_NUM_RSC];
3862 struct tkip_sc multicast_rsc[IWLAGN_NUM_RSC];
3870 struct iwlagn_aes_rsc_tsc {
3871 struct aes_sc unicast_rsc[IWLAGN_NUM_RSC];
3872 struct aes_sc multicast_rsc[IWLAGN_NUM_RSC];
3876 union iwlagn_all_tsc_rsc {
3877 struct iwlagn_tkip_rsc_tsc tkip;
3878 struct iwlagn_aes_rsc_tsc aes;
3881 struct iwlagn_wowlan_rsc_tsc_params_cmd {
3882 union iwlagn_all_tsc_rsc all_tsc_rsc;
3886 * REPLY_WOWLAN_TKIP_PARAMS
3888 #define IWLAGN_MIC_KEY_SIZE 8
3889 #define IWLAGN_P1K_SIZE 5
3890 struct iwlagn_mic_keys {
3891 u8 tx[IWLAGN_MIC_KEY_SIZE];
3892 u8 rx_unicast[IWLAGN_MIC_KEY_SIZE];
3893 u8 rx_mcast[IWLAGN_MIC_KEY_SIZE];
3896 struct iwlagn_p1k_cache {
3897 __le16 p1k[IWLAGN_P1K_SIZE];
3900 #define IWLAGN_NUM_RX_P1K_CACHE 2
3902 struct iwlagn_wowlan_tkip_params_cmd {
3903 struct iwlagn_mic_keys mic_keys;
3904 struct iwlagn_p1k_cache tx;
3905 struct iwlagn_p1k_cache rx_uni[IWLAGN_NUM_RX_P1K_CACHE];
3906 struct iwlagn_p1k_cache rx_multi[IWLAGN_NUM_RX_P1K_CACHE];
3910 * REPLY_WOWLAN_KEK_KCK_MATERIAL
3913 #define IWLAGN_KCK_MAX_SIZE 32
3914 #define IWLAGN_KEK_MAX_SIZE 32
3916 struct iwlagn_wowlan_kek_kck_material_cmd {
3917 u8 kck[IWLAGN_KCK_MAX_SIZE];
3918 u8 kek[IWLAGN_KEK_MAX_SIZE];
3924 /******************************************************************************
3926 * Union of all expected notifications/responses:
3928 *****************************************************************************/
3929 #define FH_RSCSR_FRAME_SIZE_MSK (0x00003FFF) /* bits 0-13 */
3931 struct iwl_rx_packet {
3933 * The first 4 bytes of the RX frame header contain both the RX frame
3934 * size and some flags.
3936 * 31: flag flush RB request
3937 * 30: flag ignore TC (terminal counter) request
3938 * 29: flag fast IRQ request
3940 * 13-00: RX frame size
3943 struct iwl_cmd_header hdr;
3945 struct iwl_alive_resp alive_frame;
3946 struct iwl_spectrum_notification spectrum_notif;
3947 struct iwl_csa_notification csa_notif;
3948 struct iwl_error_resp err_resp;
3949 struct iwl_card_state_notif card_state_notif;
3950 struct iwl_add_sta_resp add_sta;
3951 struct iwl_rem_sta_resp rem_sta;
3952 struct iwl_sleep_notification sleep_notif;
3953 struct iwl_spectrum_resp spectrum;
3954 struct iwl_notif_statistics stats;
3955 struct iwl_bt_notif_statistics stats_bt;
3956 struct iwl_compressed_ba_resp compressed_ba;
3957 struct iwl_missed_beacon_notif missed_beacon;
3958 struct iwl_coex_medium_notification coex_medium_notif;
3959 struct iwl_coex_event_resp coex_event;
3960 struct iwl_bt_coex_profile_notif bt_coex_profile_notif;
3966 int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
3969 * REPLY_WIPAN_PARAMS = 0xb2 (Commands and Notification)
3973 * Minimum slot time in TU
3975 #define IWL_MIN_SLOT_TIME 20
3978 * struct iwl_wipan_slot
3979 * @width: Time in TU
3984 struct iwl_wipan_slot {
3990 #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_CTS BIT(1) /* reserved */
3991 #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_QUIET BIT(2) /* reserved */
3992 #define IWL_WIPAN_PARAMS_FLG_SLOTTED_MODE BIT(3) /* reserved */
3993 #define IWL_WIPAN_PARAMS_FLG_FILTER_BEACON_NOTIF BIT(4)
3994 #define IWL_WIPAN_PARAMS_FLG_FULL_SLOTTED_MODE BIT(5)
3997 * struct iwl_wipan_params_cmd
4000 * bit1: CP leave channel with CTS
4001 * bit2: CP leave channel qith Quiet
4002 * bit3: slotted mode
4003 * 1 - work in slotted mode
4004 * 0 - work in non slotted mode
4005 * bit4: filter beacon notification
4006 * bit5: full tx slotted mode. if this flag is set,
4007 * uCode will perform leaving channel methods in context switch
4008 * also when working in same channel mode
4009 * @num_slots: 1 - 10
4011 struct iwl_wipan_params_cmd {
4015 struct iwl_wipan_slot slots[10];
4019 * REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9
4021 * TODO: Figure out what this is used for,
4022 * it can only switch between 2.4 GHz
4026 struct iwl_wipan_p2p_channel_switch_cmd {
4032 * REPLY_WIPAN_NOA_NOTIFICATION = 0xbc
4034 * This is used by the device to notify us of the
4035 * NoA schedule it determined so we can forward it
4036 * to userspace for inclusion in probe responses.
4038 * In beacons, the NoA schedule is simply appended
4039 * to the frame we give the device.
4042 struct iwl_wipan_noa_descriptor {
4049 struct iwl_wipan_noa_attribute {
4054 struct iwl_wipan_noa_descriptor descr0, descr1;
4058 struct iwl_wipan_noa_notification {
4060 struct iwl_wipan_noa_attribute noa_attribute;
4063 #endif /* __iwl_commands_h__ */
git.openpandora.org / pandora-kernel.git / blob