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) 2012 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 Intel Deutschland GmbH
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
26 * The full GNU General Public License is included in this distribution
27 * in the file called COPYING.
29 * Contact Information:
30 * Intel Linux Wireless <linuxwifi@intel.com>
31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
35 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
37 * Copyright(c) 2016 Intel Deutschland GmbH
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
44 * * Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * * Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in
48 * the documentation and/or other materials provided with the
50 * * Neither the name Intel Corporation nor the names of its
51 * contributors may be used to endorse or promote products derived
52 * from this software without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 *****************************************************************************/
71 #include "fw-api-rs.h"
72 #include "fw-api-rx.h"
73 #include "fw-api-tx.h"
74 #include "fw-api-sta.h"
75 #include "fw-api-mac.h"
76 #include "fw-api-power.h"
77 #include "fw-api-d3.h"
78 #include "fw-api-coex.h"
79 #include "fw-api-scan.h"
80 #include "fw-api-stats.h"
81 #include "fw-api-tof.h"
83 /* Tx queue numbers for non-DQA mode */
85 IWL_MVM_OFFCHANNEL_QUEUE = 8,
86 IWL_MVM_CMD_QUEUE = 9,
92 * @IWL_MVM_DQA_CMD_QUEUE: a queue reserved for sending HCMDs to the FW
93 * @IWL_MVM_DQA_AUX_QUEUE: a queue reserved for aux frames
94 * @IWL_MVM_DQA_P2P_DEVICE_QUEUE: a queue reserved for P2P device frames
95 * @IWL_MVM_DQA_GCAST_QUEUE: a queue reserved for P2P GO/SoftAP GCAST frames
96 * @IWL_MVM_DQA_BSS_CLIENT_QUEUE: a queue reserved for BSS activity, to ensure
97 * that we are never left without the possibility to connect to an AP.
98 * @IWL_MVM_DQA_MIN_MGMT_QUEUE: first TXQ in pool for MGMT and non-QOS frames.
99 * Each MGMT queue is mapped to a single STA
100 * MGMT frames are frames that return true on ieee80211_is_mgmt()
101 * @IWL_MVM_DQA_MAX_MGMT_QUEUE: last TXQ in pool for MGMT frames
102 * @IWL_MVM_DQA_AP_PROBE_RESP_QUEUE: a queue reserved for P2P GO/SoftAP probe
104 * @IWL_MVM_DQA_MIN_DATA_QUEUE: first TXQ in pool for DATA frames.
105 * DATA frames are intended for !ieee80211_is_mgmt() frames, but if
106 * the MGMT TXQ pool is exhausted, mgmt frames can be sent on DATA queues
108 * @IWL_MVM_DQA_MAX_DATA_QUEUE: last TXQ in pool for DATA frames
110 enum iwl_mvm_dqa_txq {
111 IWL_MVM_DQA_CMD_QUEUE = 0,
112 IWL_MVM_DQA_AUX_QUEUE = 1,
113 IWL_MVM_DQA_P2P_DEVICE_QUEUE = 2,
114 IWL_MVM_DQA_GCAST_QUEUE = 3,
115 IWL_MVM_DQA_BSS_CLIENT_QUEUE = 4,
116 IWL_MVM_DQA_MIN_MGMT_QUEUE = 5,
117 IWL_MVM_DQA_MAX_MGMT_QUEUE = 8,
118 IWL_MVM_DQA_AP_PROBE_RESP_QUEUE = 9,
119 IWL_MVM_DQA_MIN_DATA_QUEUE = 10,
120 IWL_MVM_DQA_MAX_DATA_QUEUE = 31,
123 enum iwl_mvm_tx_fifo {
124 IWL_MVM_TX_FIFO_BK = 0,
128 IWL_MVM_TX_FIFO_MCAST = 5,
129 IWL_MVM_TX_FIFO_CMD = 7,
139 INIT_COMPLETE_NOTIF = 0x4,
141 /* PHY context commands */
142 PHY_CONTEXT_CMD = 0x8,
144 ANTENNA_COUPLING_NOTIFICATION = 0xa,
146 /* UMAC scan commands */
147 SCAN_ITERATION_COMPLETE_UMAC = 0xb5,
150 SCAN_ABORT_UMAC = 0xe,
151 SCAN_COMPLETE_UMAC = 0xf,
153 BA_WINDOW_STATUS_NOTIFICATION_ID = 0x13,
160 /* paging get item */
161 FW_GET_ITEM_CMD = 0x1a,
166 MGMT_MCAST_KEY = 0x1f,
168 /* scheduler config */
169 SCD_QUEUE_CFG = 0x1d,
175 SHARED_MEM_CFG = 0x25,
178 TDLS_CHANNEL_SWITCH_CMD = 0x27,
179 TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
180 TDLS_CONFIG_CMD = 0xa7,
182 /* MAC and Binding commands */
183 MAC_CONTEXT_CMD = 0x28,
184 TIME_EVENT_CMD = 0x29, /* both CMD and response */
185 TIME_EVENT_NOTIFICATION = 0x2a,
186 BINDING_CONTEXT_CMD = 0x2b,
187 TIME_QUOTA_CMD = 0x2c,
188 NON_QOS_TX_COUNTER_CMD = 0x2d,
192 /* paging block to FW cpu2 */
193 FW_PAGING_BLOCK_CMD = 0x4f,
196 SCAN_OFFLOAD_REQUEST_CMD = 0x51,
197 SCAN_OFFLOAD_ABORT_CMD = 0x52,
199 SCAN_OFFLOAD_COMPLETE = 0x6D,
200 SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
201 SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
202 MATCH_FOUND_NOTIFICATION = 0xd9,
203 SCAN_ITERATION_COMPLETE = 0xe7,
206 PHY_CONFIGURATION_CMD = 0x6a,
207 CALIB_RES_NOTIF_PHY_DB = 0x6b,
210 /* ToF - 802.11mc FTM */
212 TOF_NOTIFICATION = 0x11,
214 /* Power - legacy power table command */
215 POWER_TABLE_CMD = 0x77,
216 PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
219 /* Thermal Throttling*/
220 REPLY_THERMAL_MNG_BACKOFF = 0x7e,
222 /* Set/Get DC2DC frequency tune */
223 DC2DC_CONFIG_CMD = 0x83,
226 NVM_ACCESS_CMD = 0x88,
228 SET_CALIB_DEFAULT_CMD = 0x8e,
230 BEACON_NOTIFICATION = 0x90,
231 BEACON_TEMPLATE_CMD = 0x91,
232 TX_ANT_CONFIGURATION_CMD = 0x98,
233 STATISTICS_CMD = 0x9c,
234 STATISTICS_NOTIFICATION = 0x9d,
235 EOSP_NOTIFICATION = 0x9e,
236 REDUCE_TX_POWER_CMD = 0x9f,
238 /* RF-KILL commands and notifications */
239 CARD_STATE_CMD = 0xa0,
240 CARD_STATE_NOTIFICATION = 0xa1,
242 MISSED_BEACONS_NOTIFICATION = 0xa2,
244 /* Power - new power table command */
245 MAC_PM_POWER_TABLE = 0xa9,
247 MFUART_LOAD_NOTIFICATION = 0xb1,
249 RSS_CONFIG_CMD = 0xb3,
251 REPLY_RX_PHY_CMD = 0xc0,
252 REPLY_RX_MPDU_CMD = 0xc1,
253 FRAME_RELEASE = 0xc3,
256 /* Location Aware Regulatory */
257 MCC_UPDATE_CMD = 0xc8,
258 MCC_CHUB_UPDATE_CMD = 0xc9,
263 BT_COEX_PRIO_TABLE = 0xcc,
264 BT_COEX_PROT_ENV = 0xcd,
265 BT_PROFILE_NOTIFICATION = 0xce,
267 BT_COEX_UPDATE_SW_BOOST = 0x5a,
268 BT_COEX_UPDATE_CORUN_LUT = 0x5b,
269 BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
272 REPLY_SF_CFG_CMD = 0xd1,
273 REPLY_BEACON_FILTERING_CMD = 0xd2,
275 /* DTS measurements */
276 CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
277 DTS_MEASUREMENT_NOTIFICATION = 0xdd,
279 REPLY_DEBUG_CMD = 0xf0,
280 LDBG_CONFIG_CMD = 0xf6,
281 DEBUG_LOG_MSG = 0xf7,
283 BCAST_FILTER_CMD = 0xcf,
284 MCAST_FILTER_CMD = 0xd0,
286 /* D3 commands/notifications */
287 D3_CONFIG_CMD = 0xd3,
288 PROT_OFFLOAD_CONFIG_CMD = 0xd4,
289 OFFLOADS_QUERY_CMD = 0xd5,
290 REMOTE_WAKE_CONFIG_CMD = 0xd6,
293 /* for WoWLAN in particular */
294 WOWLAN_PATTERNS = 0xe0,
295 WOWLAN_CONFIGURATION = 0xe1,
296 WOWLAN_TSC_RSC_PARAM = 0xe2,
297 WOWLAN_TKIP_PARAM = 0xe3,
298 WOWLAN_KEK_KCK_MATERIAL = 0xe4,
299 WOWLAN_GET_STATUSES = 0xe5,
300 WOWLAN_TX_POWER_PER_DB = 0xe6,
302 /* and for NetDetect */
303 SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
304 SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
305 SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
310 /* Please keep this enum *SORTED* by hex value.
311 * Needed for binary search, otherwise a warning will be triggered.
313 enum iwl_mac_conf_subcmd_ids {
314 LINK_QUALITY_MEASUREMENT_CMD = 0x1,
315 LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF = 0xFE,
316 CHANNEL_SWITCH_NOA_NOTIF = 0xFF,
319 enum iwl_phy_ops_subcmd_ids {
320 CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0,
321 CTDP_CONFIG_CMD = 0x03,
322 TEMP_REPORTING_THRESHOLDS_CMD = 0x04,
323 CT_KILL_NOTIFICATION = 0xFE,
324 DTS_MEASUREMENT_NOTIF_WIDE = 0xFF,
327 enum iwl_system_subcmd_ids {
328 SHARED_MEM_CFG_CMD = 0x0,
331 enum iwl_data_path_subcmd_ids {
332 DQA_ENABLE_CMD = 0x0,
333 UPDATE_MU_GROUPS_CMD = 0x1,
334 TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
335 MU_GROUP_MGMT_NOTIF = 0xFE,
336 RX_QUEUES_NOTIFICATION = 0xFF,
339 enum iwl_prot_offload_subcmd_ids {
340 STORED_BEACON_NTF = 0xFF,
343 enum iwl_fmac_debug_cmds {
353 MAC_CONF_GROUP = 0x3,
355 DATA_PATH_GROUP = 0x5,
356 PROT_OFFLOAD_GROUP = 0xb,
361 * struct iwl_cmd_response - generic response struct for most commands
362 * @status: status of the command asked, changes for each one
364 struct iwl_cmd_response {
369 * struct iwl_dqa_enable_cmd
370 * @cmd_queue: the TXQ number of the command queue
372 struct iwl_dqa_enable_cmd {
374 } __packed; /* DQA_CONTROL_CMD_API_S_VER_1 */
377 * struct iwl_tx_ant_cfg_cmd
378 * @valid: valid antenna configuration
380 struct iwl_tx_ant_cfg_cmd {
385 * Calibration control struct.
386 * Sent as part of the phy configuration command.
387 * @flow_trigger: bitmap for which calibrations to perform according to
389 * @event_trigger: bitmap for which calibrations to perform according to
392 struct iwl_calib_ctrl {
394 __le32 event_trigger;
397 /* This enum defines the bitmap of various calibrations to enable in both
398 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
401 IWL_CALIB_CFG_XTAL_IDX = BIT(0),
402 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(1),
403 IWL_CALIB_CFG_VOLTAGE_READ_IDX = BIT(2),
404 IWL_CALIB_CFG_PAPD_IDX = BIT(3),
405 IWL_CALIB_CFG_TX_PWR_IDX = BIT(4),
406 IWL_CALIB_CFG_DC_IDX = BIT(5),
407 IWL_CALIB_CFG_BB_FILTER_IDX = BIT(6),
408 IWL_CALIB_CFG_LO_LEAKAGE_IDX = BIT(7),
409 IWL_CALIB_CFG_TX_IQ_IDX = BIT(8),
410 IWL_CALIB_CFG_TX_IQ_SKEW_IDX = BIT(9),
411 IWL_CALIB_CFG_RX_IQ_IDX = BIT(10),
412 IWL_CALIB_CFG_RX_IQ_SKEW_IDX = BIT(11),
413 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(12),
414 IWL_CALIB_CFG_CHAIN_NOISE_IDX = BIT(13),
415 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX = BIT(14),
416 IWL_CALIB_CFG_ANT_COUPLING_IDX = BIT(15),
417 IWL_CALIB_CFG_DAC_IDX = BIT(16),
418 IWL_CALIB_CFG_ABS_IDX = BIT(17),
419 IWL_CALIB_CFG_AGC_IDX = BIT(18),
423 * Phy configuration command.
425 struct iwl_phy_cfg_cmd {
427 struct iwl_calib_ctrl calib_control;
430 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1))
431 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3))
432 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5))
433 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7))
434 #define PHY_CFG_TX_CHAIN_A BIT(8)
435 #define PHY_CFG_TX_CHAIN_B BIT(9)
436 #define PHY_CFG_TX_CHAIN_C BIT(10)
437 #define PHY_CFG_RX_CHAIN_A BIT(12)
438 #define PHY_CFG_RX_CHAIN_B BIT(13)
439 #define PHY_CFG_RX_CHAIN_C BIT(14)
442 /* Target of the NVM_ACCESS_CMD */
444 NVM_ACCESS_TARGET_CACHE = 0,
445 NVM_ACCESS_TARGET_OTP = 1,
446 NVM_ACCESS_TARGET_EEPROM = 2,
449 /* Section types for NVM_ACCESS_CMD */
451 NVM_SECTION_TYPE_SW = 1,
452 NVM_SECTION_TYPE_REGULATORY = 3,
453 NVM_SECTION_TYPE_CALIBRATION = 4,
454 NVM_SECTION_TYPE_PRODUCTION = 5,
455 NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
456 NVM_SECTION_TYPE_PHY_SKU = 12,
457 NVM_MAX_NUM_SECTIONS = 13,
461 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
462 * @op_code: 0 - read, 1 - write
463 * @target: NVM_ACCESS_TARGET_*
464 * @type: NVM_SECTION_TYPE_*
465 * @offset: offset in bytes into the section
466 * @length: in bytes, to read/write
467 * @data: if write operation, the data to write. On read its empty
469 struct iwl_nvm_access_cmd {
476 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
478 #define NUM_OF_FW_PAGING_BLOCKS 33 /* 32 for data and 1 block for CSS */
481 * struct iwl_fw_paging_cmd - paging layout
483 * (FW_PAGING_BLOCK_CMD = 0x4f)
485 * Send to FW the paging layout in the driver.
487 * @flags: various flags for the command
488 * @block_size: the block size in powers of 2
489 * @block_num: number of blocks specified in the command.
490 * @device_phy_addr: virtual addresses from device side
491 * 32 bit address for API version 1, 64 bit address for API version 2.
493 struct iwl_fw_paging_cmd {
498 __le32 addr32[NUM_OF_FW_PAGING_BLOCKS];
499 __le64 addr64[NUM_OF_FW_PAGING_BLOCKS];
501 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_2 */
506 * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload
509 enum iwl_fw_item_id {
510 IWL_FW_ITEM_ID_PAGING = 3,
514 * struct iwl_fw_get_item_cmd - get an item from the fw
516 struct iwl_fw_get_item_cmd {
518 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */
520 #define CONT_REC_COMMAND_SIZE 80
521 #define ENABLE_CONT_RECORDING 0x15
522 #define DISABLE_CONT_RECORDING 0x16
525 * struct iwl_continuous_record_mode - recording mode
527 struct iwl_continuous_record_mode {
528 __le16 enable_recording;
532 * struct iwl_continuous_record_cmd - enable/disable continuous recording
534 struct iwl_continuous_record_cmd {
535 struct iwl_continuous_record_mode record_mode;
536 u8 pad[CONT_REC_COMMAND_SIZE -
537 sizeof(struct iwl_continuous_record_mode)];
540 struct iwl_fw_get_item_resp {
542 __le32 item_byte_cnt;
544 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */
547 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
548 * @offset: offset in bytes into the section
549 * @length: in bytes, either how much was written or read
550 * @type: NVM_SECTION_TYPE_*
551 * @status: 0 for success, fail otherwise
552 * @data: if read operation, the data returned. Empty on write.
554 struct iwl_nvm_access_resp {
560 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
564 /* alive response is_valid values */
565 #define ALIVE_RESP_UCODE_OK BIT(0)
566 #define ALIVE_RESP_RFKILL BIT(1)
568 /* alive response ver_type values */
578 /* alive response ver_subtype values */
580 FW_SUBTYPE_FULL_FEATURE = 0,
581 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
582 FW_SUBTYPE_REDUCED = 2,
583 FW_SUBTYPE_ALIVE_ONLY = 3,
584 FW_SUBTYPE_WOWLAN = 4,
585 FW_SUBTYPE_AP_SUBTYPE = 5,
586 FW_SUBTYPE_WIPAN = 6,
587 FW_SUBTYPE_INITIALIZE = 9
590 #define IWL_ALIVE_STATUS_ERR 0xDEAD
591 #define IWL_ALIVE_STATUS_OK 0xCAFE
593 #define IWL_ALIVE_FLG_RFKILL BIT(0)
595 struct mvm_alive_resp_ver1 {
609 __le32 error_event_table_ptr; /* SRAM address for error log */
610 __le32 log_event_table_ptr; /* SRAM address for event log */
611 __le32 cpu_register_ptr;
612 __le32 dbgm_config_ptr;
613 __le32 alive_counter_ptr;
614 __le32 scd_base_ptr; /* SRAM address for SCD */
615 } __packed; /* ALIVE_RES_API_S_VER_1 */
617 struct mvm_alive_resp_ver2 {
631 __le32 error_event_table_ptr; /* SRAM address for error log */
632 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */
633 __le32 cpu_register_ptr;
634 __le32 dbgm_config_ptr;
635 __le32 alive_counter_ptr;
636 __le32 scd_base_ptr; /* SRAM address for SCD */
637 __le32 st_fwrd_addr; /* pointer to Store and forward */
639 u8 umac_minor; /* UMAC version: minor */
640 u8 umac_major; /* UMAC version: major */
641 __le16 umac_id; /* UMAC version: id */
642 __le32 error_info_addr; /* SRAM address for UMAC error log */
643 __le32 dbg_print_buff_addr;
644 } __packed; /* ALIVE_RES_API_S_VER_2 */
646 struct mvm_alive_resp {
656 __le32 error_event_table_ptr; /* SRAM address for error log */
657 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */
658 __le32 cpu_register_ptr;
659 __le32 dbgm_config_ptr;
660 __le32 alive_counter_ptr;
661 __le32 scd_base_ptr; /* SRAM address for SCD */
662 __le32 st_fwrd_addr; /* pointer to Store and forward */
664 __le32 umac_minor; /* UMAC version: minor */
665 __le32 umac_major; /* UMAC version: major */
666 __le32 error_info_addr; /* SRAM address for UMAC error log */
667 __le32 dbg_print_buff_addr;
668 } __packed; /* ALIVE_RES_API_S_VER_3 */
670 /* Error response/notification */
672 FW_ERR_UNKNOWN_CMD = 0x0,
673 FW_ERR_INVALID_CMD_PARAM = 0x1,
674 FW_ERR_SERVICE = 0x2,
675 FW_ERR_ARC_MEMORY = 0x3,
676 FW_ERR_ARC_CODE = 0x4,
677 FW_ERR_WATCH_DOG = 0x5,
678 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
679 FW_ERR_WEP_KEY_SIZE = 0x11,
680 FW_ERR_OBSOLETE_FUNC = 0x12,
681 FW_ERR_UNEXPECTED = 0xFE,
686 * struct iwl_error_resp - FW error indication
687 * ( REPLY_ERROR = 0x2 )
688 * @error_type: one of FW_ERR_*
689 * @cmd_id: the command ID for which the error occured
690 * @bad_cmd_seq_num: sequence number of the erroneous command
691 * @error_service: which service created the error, applicable only if
692 * error_type = 2, otherwise 0
693 * @timestamp: TSF in usecs.
695 struct iwl_error_resp {
699 __le16 bad_cmd_seq_num;
700 __le32 error_service;
705 /* Common PHY, MAC and Bindings definitions */
707 #define MAX_MACS_IN_BINDING (3)
708 #define MAX_BINDINGS (4)
709 #define AUX_BINDING_INDEX (3)
712 /* Used to extract ID and color from the context dword */
713 #define FW_CTXT_ID_POS (0)
714 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS)
715 #define FW_CTXT_COLOR_POS (8)
716 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
717 #define FW_CTXT_INVALID (0xffffffff)
719 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
720 (_color << FW_CTXT_COLOR_POS))
722 /* Possible actions on PHYs, MACs and Bindings */
724 FW_CTXT_ACTION_STUB = 0,
726 FW_CTXT_ACTION_MODIFY,
727 FW_CTXT_ACTION_REMOVE,
729 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
733 /* Time Event types, according to MAC type */
734 enum iwl_time_event_type {
735 /* BSS Station Events */
736 TE_BSS_STA_AGGRESSIVE_ASSOC,
738 TE_BSS_EAP_DHCP_PROT,
741 /* P2P Device Events */
742 TE_P2P_DEVICE_DISCOVERABLE,
743 TE_P2P_DEVICE_LISTEN,
744 TE_P2P_DEVICE_ACTION_SCAN,
745 TE_P2P_DEVICE_FULL_SCAN,
747 /* P2P Client Events */
748 TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
750 TE_P2P_CLIENT_QUIET_PERIOD,
753 TE_P2P_GO_ASSOC_PROT,
754 TE_P2P_GO_REPETITIVET_NOA,
757 /* WiDi Sync Events */
760 /* Channel Switch NoA */
761 TE_CHANNEL_SWITCH_PERIOD,
764 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
768 /* Time event - defines for command API v1 */
771 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
772 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
773 * the first fragment is scheduled.
774 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
775 * the first 2 fragments are scheduled.
776 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
777 * number of fragments are valid.
779 * Other than the constant defined above, specifying a fragmentation value 'x'
780 * means that the event can be fragmented but only the first 'x' will be
785 TE_V1_FRAG_SINGLE = 1,
787 TE_V1_FRAG_ENDLESS = 0xffffffff
790 /* If a Time Event can be fragmented, this is the max number of fragments */
791 #define TE_V1_FRAG_MAX_MSK 0x0fffffff
792 /* Repeat the time event endlessly (until removed) */
793 #define TE_V1_REPEAT_ENDLESS 0xffffffff
794 /* If a Time Event has bounded repetitions, this is the maximal value */
795 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
797 /* Time Event dependencies: none, on another TE, or in a specific time */
799 TE_V1_INDEPENDENT = 0,
800 TE_V1_DEP_OTHER = BIT(0),
801 TE_V1_DEP_TSF = BIT(1),
802 TE_V1_EVENT_SOCIOPATHIC = BIT(2),
803 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
806 * @TE_V1_NOTIF_NONE: no notifications
807 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
808 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
809 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
810 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
811 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
812 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
813 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
814 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
816 * Supported Time event notifications configuration.
817 * A notification (both event and fragment) includes a status indicating weather
818 * the FW was able to schedule the event or not. For fragment start/end
819 * notification the status is always success. There is no start/end fragment
820 * notification for monolithic events.
823 TE_V1_NOTIF_NONE = 0,
824 TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
825 TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
826 TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
827 TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
828 TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
829 TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
830 TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
831 TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
832 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
834 /* Time event - defines for command API */
837 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
838 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
839 * the first fragment is scheduled.
840 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
841 * the first 2 fragments are scheduled.
842 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
843 * number of fragments are valid.
845 * Other than the constant defined above, specifying a fragmentation value 'x'
846 * means that the event can be fragmented but only the first 'x' will be
851 TE_V2_FRAG_SINGLE = 1,
853 TE_V2_FRAG_MAX = 0xfe,
854 TE_V2_FRAG_ENDLESS = 0xff
857 /* Repeat the time event endlessly (until removed) */
858 #define TE_V2_REPEAT_ENDLESS 0xff
859 /* If a Time Event has bounded repetitions, this is the maximal value */
860 #define TE_V2_REPEAT_MAX 0xfe
862 #define TE_V2_PLACEMENT_POS 12
863 #define TE_V2_ABSENCE_POS 15
865 /* Time event policy values
866 * A notification (both event and fragment) includes a status indicating weather
867 * the FW was able to schedule the event or not. For fragment start/end
868 * notification the status is always success. There is no start/end fragment
869 * notification for monolithic events.
871 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
872 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
873 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
874 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
875 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
876 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
877 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
878 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
879 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
880 * @TE_V2_DEP_OTHER: depends on another time event
881 * @TE_V2_DEP_TSF: depends on a specific time
882 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
883 * @TE_V2_ABSENCE: are we present or absent during the Time Event.
886 TE_V2_DEFAULT_POLICY = 0x0,
888 /* notifications (event start/stop, fragment start/stop) */
889 TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
890 TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
891 TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
892 TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
894 TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
895 TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
896 TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
897 TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
898 T2_V2_START_IMMEDIATELY = BIT(11),
900 TE_V2_NOTIF_MSK = 0xff,
902 /* placement characteristics */
903 TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
904 TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
905 TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
907 /* are we present or absent during the Time Event. */
908 TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
912 * struct iwl_time_event_cmd_api - configuring Time Events
913 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
914 * with version 1. determined by IWL_UCODE_TLV_FLAGS)
915 * ( TIME_EVENT_CMD = 0x29 )
916 * @id_and_color: ID and color of the relevant MAC
917 * @action: action to perform, one of FW_CTXT_ACTION_*
918 * @id: this field has two meanings, depending on the action:
919 * If the action is ADD, then it means the type of event to add.
920 * For all other actions it is the unique event ID assigned when the
921 * event was added by the FW.
922 * @apply_time: When to start the Time Event (in GP2)
923 * @max_delay: maximum delay to event's start (apply time), in TU
924 * @depends_on: the unique ID of the event we depend on (if any)
925 * @interval: interval between repetitions, in TU
926 * @duration: duration of event in TU
927 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
928 * @max_frags: maximal number of fragments the Time Event can be divided to
929 * @policy: defines whether uCode shall notify the host or other uCode modules
930 * on event and/or fragment start and/or end
931 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
932 * TE_EVENT_SOCIOPATHIC
933 * using TE_ABSENCE and using TE_NOTIF_*
935 struct iwl_time_event_cmd {
936 /* COMMON_INDEX_HDR_API_S_VER_1 */
940 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
949 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
952 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
953 * @status: bit 0 indicates success, all others specify errors
954 * @id: the Time Event type
955 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
956 * @id_and_color: ID and color of the relevant MAC
958 struct iwl_time_event_resp {
963 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
966 * struct iwl_time_event_notif - notifications of time event start/stop
967 * ( TIME_EVENT_NOTIFICATION = 0x2a )
968 * @timestamp: action timestamp in GP2
969 * @session_id: session's unique id
970 * @unique_id: unique id of the Time Event itself
971 * @id_and_color: ID and color of the relevant MAC
972 * @action: one of TE_NOTIF_START or TE_NOTIF_END
973 * @status: true if scheduled, false otherwise (not executed)
975 struct iwl_time_event_notif {
982 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
985 /* Bindings and Time Quota */
988 * struct iwl_binding_cmd - configuring bindings
989 * ( BINDING_CONTEXT_CMD = 0x2b )
990 * @id_and_color: ID and color of the relevant Binding
991 * @action: action to perform, one of FW_CTXT_ACTION_*
992 * @macs: array of MAC id and colors which belong to the binding
993 * @phy: PHY id and color which belongs to the binding
995 struct iwl_binding_cmd {
996 /* COMMON_INDEX_HDR_API_S_VER_1 */
999 /* BINDING_DATA_API_S_VER_1 */
1000 __le32 macs[MAX_MACS_IN_BINDING];
1002 } __packed; /* BINDING_CMD_API_S_VER_1 */
1004 /* The maximal number of fragments in the FW's schedule session */
1005 #define IWL_MVM_MAX_QUOTA 128
1008 * struct iwl_time_quota_data - configuration of time quota per binding
1009 * @id_and_color: ID and color of the relevant Binding
1010 * @quota: absolute time quota in TU. The scheduler will try to divide the
1011 * remainig quota (after Time Events) according to this quota.
1012 * @max_duration: max uninterrupted context duration in TU
1014 struct iwl_time_quota_data {
1015 __le32 id_and_color;
1017 __le32 max_duration;
1018 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
1021 * struct iwl_time_quota_cmd - configuration of time quota between bindings
1022 * ( TIME_QUOTA_CMD = 0x2c )
1023 * @quotas: allocations per binding
1025 struct iwl_time_quota_cmd {
1026 struct iwl_time_quota_data quotas[MAX_BINDINGS];
1027 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
1032 /* Supported bands */
1033 #define PHY_BAND_5 (0)
1034 #define PHY_BAND_24 (1)
1036 /* Supported channel width, vary if there is VHT support */
1037 #define PHY_VHT_CHANNEL_MODE20 (0x0)
1038 #define PHY_VHT_CHANNEL_MODE40 (0x1)
1039 #define PHY_VHT_CHANNEL_MODE80 (0x2)
1040 #define PHY_VHT_CHANNEL_MODE160 (0x3)
1043 * Control channel position:
1044 * For legacy set bit means upper channel, otherwise lower.
1045 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
1046 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
1049 * 40Mhz |_______|_______|
1050 * 80Mhz |_______|_______|_______|_______|
1051 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
1052 * code 011 010 001 000 | 100 101 110 111
1054 #define PHY_VHT_CTRL_POS_1_BELOW (0x0)
1055 #define PHY_VHT_CTRL_POS_2_BELOW (0x1)
1056 #define PHY_VHT_CTRL_POS_3_BELOW (0x2)
1057 #define PHY_VHT_CTRL_POS_4_BELOW (0x3)
1058 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4)
1059 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5)
1060 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6)
1061 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7)
1065 * @channel: channel number
1066 * @width: PHY_[VHT|LEGACY]_CHANNEL_*
1067 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
1069 struct iwl_fw_channel_info {
1076 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0)
1077 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
1078 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
1079 #define PHY_RX_CHAIN_VALID_POS (1)
1080 #define PHY_RX_CHAIN_VALID_MSK \
1081 (0x7 << PHY_RX_CHAIN_VALID_POS)
1082 #define PHY_RX_CHAIN_FORCE_SEL_POS (4)
1083 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
1084 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
1085 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
1086 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
1087 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
1088 #define PHY_RX_CHAIN_CNT_POS (10)
1089 #define PHY_RX_CHAIN_CNT_MSK \
1090 (0x3 << PHY_RX_CHAIN_CNT_POS)
1091 #define PHY_RX_CHAIN_MIMO_CNT_POS (12)
1092 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
1093 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
1094 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14)
1095 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
1096 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
1098 /* TODO: fix the value, make it depend on firmware at runtime? */
1099 #define NUM_PHY_CTX 3
1101 /* TODO: complete missing documentation */
1103 * struct iwl_phy_context_cmd - config of the PHY context
1104 * ( PHY_CONTEXT_CMD = 0x8 )
1105 * @id_and_color: ID and color of the relevant Binding
1106 * @action: action to perform, one of FW_CTXT_ACTION_*
1107 * @apply_time: 0 means immediate apply and context switch.
1108 * other value means apply new params after X usecs
1109 * @tx_param_color: ???
1111 * @txchain_info: ???
1112 * @rxchain_info: ???
1113 * @acquisition_data: ???
1114 * @dsp_cfg_flags: set to 0
1116 struct iwl_phy_context_cmd {
1117 /* COMMON_INDEX_HDR_API_S_VER_1 */
1118 __le32 id_and_color;
1120 /* PHY_CONTEXT_DATA_API_S_VER_1 */
1122 __le32 tx_param_color;
1123 struct iwl_fw_channel_info ci;
1124 __le32 txchain_info;
1125 __le32 rxchain_info;
1126 __le32 acquisition_data;
1127 __le32 dsp_cfg_flags;
1128 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
1133 * Command requests the firmware to create a time event for a certain duration
1134 * and remain on the given channel. This is done by using the Aux framework in
1136 * The command was first used for Hot Spot issues - but can be used regardless
1139 * ( HOT_SPOT_CMD 0x53 )
1141 * @id_and_color: ID and color of the MAC
1142 * @action: action to perform, one of FW_CTXT_ACTION_*
1143 * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
1144 * event_unique_id should be the id of the time event assigned by ucode.
1145 * Otherwise ignore the event_unique_id.
1146 * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
1148 * @channel_info: channel info
1149 * @node_addr: Our MAC Address
1150 * @reserved: reserved for alignment
1151 * @apply_time: GP2 value to start (should always be the current GP2 value)
1152 * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
1153 * time by which start of the event is allowed to be postponed.
1154 * @duration: event duration in TU To calculate event duration:
1155 * timeEventDuration = min(duration, remainingQuota)
1157 struct iwl_hs20_roc_req {
1158 /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
1159 __le32 id_and_color;
1161 __le32 event_unique_id;
1162 __le32 sta_id_and_color;
1163 struct iwl_fw_channel_info channel_info;
1164 u8 node_addr[ETH_ALEN];
1167 __le32 apply_time_max_delay;
1169 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
1172 * values for AUX ROC result values
1174 enum iwl_mvm_hot_spot {
1175 HOT_SPOT_RSP_STATUS_OK,
1176 HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
1177 HOT_SPOT_MAX_NUM_OF_SESSIONS,
1181 * Aux ROC command response
1183 * In response to iwl_hs20_roc_req the FW sends this command to notify the
1184 * driver the uid of the timevent.
1186 * ( HOT_SPOT_CMD 0x53 )
1188 * @event_unique_id: Unique ID of time event assigned by ucode
1189 * @status: Return status 0 is success, all the rest used for specific errors
1191 struct iwl_hs20_roc_res {
1192 __le32 event_unique_id;
1194 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1197 * struct iwl_radio_version_notif - information on the radio version
1198 * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1203 struct iwl_radio_version_notif {
1204 __le32 radio_flavor;
1207 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1209 enum iwl_card_state_flags {
1210 CARD_ENABLED = 0x00,
1211 HW_CARD_DISABLED = 0x01,
1212 SW_CARD_DISABLED = 0x02,
1213 CT_KILL_CARD_DISABLED = 0x04,
1214 HALT_CARD_DISABLED = 0x08,
1215 CARD_DISABLED_MSK = 0x0f,
1216 CARD_IS_RX_ON = 0x10,
1220 * struct iwl_radio_version_notif - information on the radio version
1221 * ( CARD_STATE_NOTIFICATION = 0xa1 )
1222 * @flags: %iwl_card_state_flags
1224 struct iwl_card_state_notif {
1226 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1229 * struct iwl_missed_beacons_notif - information on missed beacons
1230 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1231 * @mac_id: interface ID
1232 * @consec_missed_beacons_since_last_rx: number of consecutive missed
1233 * beacons since last RX.
1234 * @consec_missed_beacons: number of consecutive missed beacons
1235 * @num_expected_beacons:
1236 * @num_recvd_beacons:
1238 struct iwl_missed_beacons_notif {
1240 __le32 consec_missed_beacons_since_last_rx;
1241 __le32 consec_missed_beacons;
1242 __le32 num_expected_beacons;
1243 __le32 num_recvd_beacons;
1244 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1247 * struct iwl_mfuart_load_notif - mfuart image version & status
1248 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1249 * @installed_ver: installed image version
1250 * @external_ver: external image version
1251 * @status: MFUART loading status
1252 * @duration: MFUART loading time
1254 struct iwl_mfuart_load_notif {
1255 __le32 installed_ver;
1256 __le32 external_ver;
1259 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/
1262 * struct iwl_set_calib_default_cmd - set default value for calibration.
1263 * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1264 * @calib_index: the calibration to set value for
1266 * @data: the value to set for the calibration result
1268 struct iwl_set_calib_default_cmd {
1272 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1274 #define MAX_PORT_ID_NUM 2
1275 #define MAX_MCAST_FILTERING_ADDRESSES 256
1278 * struct iwl_mcast_filter_cmd - configure multicast filter.
1279 * @filter_own: Set 1 to filter out multicast packets sent by station itself
1280 * @port_id: Multicast MAC addresses array specifier. This is a strange way
1281 * to identify network interface adopted in host-device IF.
1282 * It is used by FW as index in array of addresses. This array has
1283 * MAX_PORT_ID_NUM members.
1284 * @count: Number of MAC addresses in the array
1285 * @pass_all: Set 1 to pass all multicast packets.
1286 * @bssid: current association BSSID.
1287 * @addr_list: Place holder for array of MAC addresses.
1288 * IMPORTANT: add padding if necessary to ensure DWORD alignment.
1290 struct iwl_mcast_filter_cmd {
1298 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1300 #define MAX_BCAST_FILTERS 8
1301 #define MAX_BCAST_FILTER_ATTRS 2
1304 * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1305 * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1306 * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1307 * start of ip payload).
1309 enum iwl_mvm_bcast_filter_attr_offset {
1310 BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1311 BCAST_FILTER_OFFSET_IP_END = 1,
1315 * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1316 * @offset_type: &enum iwl_mvm_bcast_filter_attr_offset.
1317 * @offset: starting offset of this pattern.
1318 * @val: value to match - big endian (MSB is the first
1319 * byte to match from offset pos).
1320 * @mask: mask to match (big endian).
1322 struct iwl_fw_bcast_filter_attr {
1328 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1331 * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1332 * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1333 * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1335 enum iwl_mvm_bcast_filter_frame_type {
1336 BCAST_FILTER_FRAME_TYPE_ALL = 0,
1337 BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1341 * struct iwl_fw_bcast_filter - broadcast filter
1342 * @discard: discard frame (1) or let it pass (0).
1343 * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1344 * @num_attrs: number of valid attributes in this filter.
1345 * @attrs: attributes of this filter. a filter is considered matched
1346 * only when all its attributes are matched (i.e. AND relationship)
1348 struct iwl_fw_bcast_filter {
1353 struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1354 } __packed; /* BCAST_FILTER_S_VER_1 */
1356 #define BA_WINDOW_STREAMS_MAX 16
1357 #define BA_WINDOW_STATUS_TID_MSK 0x000F
1358 #define BA_WINDOW_STATUS_STA_ID_POS 4
1359 #define BA_WINDOW_STATUS_STA_ID_MSK 0x01F0
1360 #define BA_WINDOW_STATUS_VALID_MSK BIT(9)
1363 * struct iwl_ba_window_status_notif - reordering window's status notification
1364 * @bitmap: bitmap of received frames [start_seq_num + 0]..[start_seq_num + 63]
1365 * @ra_tid: bit 3:0 - TID, bit 8:4 - STA_ID, bit 9 - valid
1366 * @start_seq_num: the start sequence number of the bitmap
1367 * @mpdu_rx_count: the number of received MPDUs since entering D0i3
1369 struct iwl_ba_window_status_notif {
1370 __le64 bitmap[BA_WINDOW_STREAMS_MAX];
1371 __le16 ra_tid[BA_WINDOW_STREAMS_MAX];
1372 __le32 start_seq_num[BA_WINDOW_STREAMS_MAX];
1373 __le16 mpdu_rx_count[BA_WINDOW_STREAMS_MAX];
1374 } __packed; /* BA_WINDOW_STATUS_NTFY_API_S_VER_1 */
1377 * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1378 * @default_discard: default action for this mac (discard (1) / pass (0)).
1379 * @attached_filters: bitmap of relevant filters for this mac.
1381 struct iwl_fw_bcast_mac {
1384 __le16 attached_filters;
1385 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1388 * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1389 * @disable: enable (0) / disable (1)
1390 * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1391 * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1392 * @filters: broadcast filters
1393 * @macs: broadcast filtering configuration per-mac
1395 struct iwl_bcast_filter_cmd {
1397 u8 max_bcast_filters;
1400 struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1401 struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1402 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1405 * enum iwl_mvm_marker_id - maker ids
1407 * The ids for different type of markers to insert into the usniffer logs
1409 enum iwl_mvm_marker_id {
1410 MARKER_ID_TX_FRAME_LATENCY = 1,
1411 }; /* MARKER_ID_API_E_VER_1 */
1414 * struct iwl_mvm_marker - mark info into the usniffer logs
1416 * (MARKER_CMD = 0xcb)
1418 * Mark the UTC time stamp into the usniffer logs together with additional
1419 * metadata, so the usniffer output can be parsed.
1420 * In the command response the ucode will return the GP2 time.
1422 * @dw_len: The amount of dwords following this byte including this byte.
1423 * @marker_id: A unique marker id (iwl_mvm_marker_id).
1424 * @reserved: reserved.
1425 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1426 * @metadata: additional meta data that will be written to the unsiffer log
1428 struct iwl_mvm_marker {
1434 } __packed; /* MARKER_API_S_VER_1 */
1437 * enum iwl_dc2dc_config_id - flag ids
1439 * Ids of dc2dc configuration flags
1441 enum iwl_dc2dc_config_id {
1442 DCDC_LOW_POWER_MODE_MSK_SET = 0x1, /* not used */
1443 DCDC_FREQ_TUNE_SET = 0x2,
1444 }; /* MARKER_ID_API_E_VER_1 */
1447 * struct iwl_dc2dc_config_cmd - configure dc2dc values
1449 * (DC2DC_CONFIG_CMD = 0x83)
1451 * Set/Get & configure dc2dc values.
1452 * The command always returns the current dc2dc values.
1454 * @flags: set/get dc2dc
1455 * @enable_low_power_mode: not used.
1456 * @dc2dc_freq_tune0: frequency divider - digital domain
1457 * @dc2dc_freq_tune1: frequency divider - analog domain
1459 struct iwl_dc2dc_config_cmd {
1461 __le32 enable_low_power_mode; /* not used */
1462 __le32 dc2dc_freq_tune0;
1463 __le32 dc2dc_freq_tune1;
1464 } __packed; /* DC2DC_CONFIG_CMD_API_S_VER_1 */
1467 * struct iwl_dc2dc_config_resp - response for iwl_dc2dc_config_cmd
1469 * Current dc2dc values returned by the FW.
1471 * @dc2dc_freq_tune0: frequency divider - digital domain
1472 * @dc2dc_freq_tune1: frequency divider - analog domain
1474 struct iwl_dc2dc_config_resp {
1475 __le32 dc2dc_freq_tune0;
1476 __le32 dc2dc_freq_tune1;
1477 } __packed; /* DC2DC_CONFIG_RESP_API_S_VER_1 */
1479 /***********************************
1481 ***********************************/
1482 /* Smart Fifo state */
1484 SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1491 /* Smart Fifo possible scenario */
1492 enum iwl_sf_scenario {
1493 SF_SCENARIO_SINGLE_UNICAST,
1494 SF_SCENARIO_AGG_UNICAST,
1495 SF_SCENARIO_MULTICAST,
1496 SF_SCENARIO_BA_RESP,
1497 SF_SCENARIO_TX_RESP,
1501 #define SF_TRANSIENT_STATES_NUMBER 2 /* SF_LONG_DELAY_ON and SF_FULL_ON */
1502 #define SF_NUM_TIMEOUT_TYPES 2 /* Aging timer and Idle timer */
1504 /* smart FIFO default values */
1505 #define SF_W_MARK_SISO 6144
1506 #define SF_W_MARK_MIMO2 8192
1507 #define SF_W_MARK_MIMO3 6144
1508 #define SF_W_MARK_LEGACY 4096
1509 #define SF_W_MARK_SCAN 4096
1511 /* SF Scenarios timers for default configuration (aligned to 32 uSec) */
1512 #define SF_SINGLE_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */
1513 #define SF_SINGLE_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1514 #define SF_AGG_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */
1515 #define SF_AGG_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1516 #define SF_MCAST_IDLE_TIMER_DEF 160 /* 150 mSec */
1517 #define SF_MCAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1518 #define SF_BA_IDLE_TIMER_DEF 160 /* 150 uSec */
1519 #define SF_BA_AGING_TIMER_DEF 400 /* 0.4 mSec */
1520 #define SF_TX_RE_IDLE_TIMER_DEF 160 /* 150 uSec */
1521 #define SF_TX_RE_AGING_TIMER_DEF 400 /* 0.4 mSec */
1523 /* SF Scenarios timers for BSS MAC configuration (aligned to 32 uSec) */
1524 #define SF_SINGLE_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1525 #define SF_SINGLE_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1526 #define SF_AGG_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1527 #define SF_AGG_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1528 #define SF_MCAST_IDLE_TIMER 2016 /* 2 mSec */
1529 #define SF_MCAST_AGING_TIMER 10016 /* 10 mSec */
1530 #define SF_BA_IDLE_TIMER 320 /* 300 uSec */
1531 #define SF_BA_AGING_TIMER 2016 /* 2 mSec */
1532 #define SF_TX_RE_IDLE_TIMER 320 /* 300 uSec */
1533 #define SF_TX_RE_AGING_TIMER 2016 /* 2 mSec */
1535 #define SF_LONG_DELAY_AGING_TIMER 1000000 /* 1 Sec */
1537 #define SF_CFG_DUMMY_NOTIF_OFF BIT(16)
1540 * Smart Fifo configuration command.
1541 * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1542 * @watermark: Minimum allowed availabe free space in RXF for transient state.
1543 * @long_delay_timeouts: aging and idle timer values for each scenario
1544 * in long delay state.
1545 * @full_on_timeouts: timer values for each scenario in full on state.
1547 struct iwl_sf_cfg_cmd {
1549 __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1550 __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1551 __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1552 } __packed; /* SF_CFG_API_S_VER_2 */
1554 /***********************************
1555 * Location Aware Regulatory (LAR) API - MCC updates
1556 ***********************************/
1559 * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic
1560 * regulatory profile according to the given MCC (Mobile Country Code).
1561 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1562 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1563 * MCC in the cmd response will be the relevant MCC in the NVM.
1564 * @mcc: given mobile country code
1565 * @source_id: the source from where we got the MCC, see iwl_mcc_source
1566 * @reserved: reserved for alignment
1568 struct iwl_mcc_update_cmd_v1 {
1572 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_1 */
1575 * struct iwl_mcc_update_cmd - Request the device to update geographic
1576 * regulatory profile according to the given MCC (Mobile Country Code).
1577 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1578 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1579 * MCC in the cmd response will be the relevant MCC in the NVM.
1580 * @mcc: given mobile country code
1581 * @source_id: the source from where we got the MCC, see iwl_mcc_source
1582 * @reserved: reserved for alignment
1583 * @key: integrity key for MCC API OEM testing
1584 * @reserved2: reserved
1586 struct iwl_mcc_update_cmd {
1591 __le32 reserved2[5];
1592 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */
1595 * iwl_mcc_update_resp_v1 - response to MCC_UPDATE_CMD.
1596 * Contains the new channel control profile map, if changed, and the new MCC
1597 * (mobile country code).
1598 * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1599 * @status: see &enum iwl_mcc_update_status
1600 * @mcc: the new applied MCC
1601 * @cap: capabilities for all channels which matches the MCC
1602 * @source_id: the MCC source, see iwl_mcc_source
1603 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1604 * channels, depending on platform)
1605 * @channels: channel control data map, DWORD for each channel. Only the first
1608 struct iwl_mcc_update_resp_v1 {
1615 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */
1618 * iwl_mcc_update_resp - response to MCC_UPDATE_CMD.
1619 * Contains the new channel control profile map, if changed, and the new MCC
1620 * (mobile country code).
1621 * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1622 * @status: see &enum iwl_mcc_update_status
1623 * @mcc: the new applied MCC
1624 * @cap: capabilities for all channels which matches the MCC
1625 * @source_id: the MCC source, see iwl_mcc_source
1626 * @time: time elapsed from the MCC test start (in 30 seconds TU)
1627 * @reserved: reserved.
1628 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1629 * channels, depending on platform)
1630 * @channels: channel control data map, DWORD for each channel. Only the first
1633 struct iwl_mcc_update_resp {
1642 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_2 */
1645 * struct iwl_mcc_chub_notif - chub notifies of mcc change
1646 * (MCC_CHUB_UPDATE_CMD = 0xc9)
1647 * The Chub (Communication Hub, CommsHUB) is a HW component that connects to
1648 * the cellular and connectivity cores that gets updates of the mcc, and
1649 * notifies the ucode directly of any mcc change.
1650 * The ucode requests the driver to request the device to update geographic
1651 * regulatory profile according to the given MCC (Mobile Country Code).
1652 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1653 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1654 * MCC in the cmd response will be the relevant MCC in the NVM.
1655 * @mcc: given mobile country code
1656 * @source_id: identity of the change originator, see iwl_mcc_source
1657 * @reserved1: reserved for alignment
1659 struct iwl_mcc_chub_notif {
1663 } __packed; /* LAR_MCC_NOTIFY_S */
1665 enum iwl_mcc_update_status {
1666 MCC_RESP_NEW_CHAN_PROFILE,
1667 MCC_RESP_SAME_CHAN_PROFILE,
1669 MCC_RESP_NVM_DISABLED,
1671 MCC_RESP_LOW_PRIORITY,
1672 MCC_RESP_TEST_MODE_ACTIVE,
1673 MCC_RESP_TEST_MODE_NOT_ACTIVE,
1674 MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE,
1677 enum iwl_mcc_source {
1678 MCC_SOURCE_OLD_FW = 0,
1680 MCC_SOURCE_BIOS = 2,
1681 MCC_SOURCE_3G_LTE_HOST = 3,
1682 MCC_SOURCE_3G_LTE_DEVICE = 4,
1683 MCC_SOURCE_WIFI = 5,
1684 MCC_SOURCE_RESERVED = 6,
1685 MCC_SOURCE_DEFAULT = 7,
1686 MCC_SOURCE_UNINITIALIZED = 8,
1687 MCC_SOURCE_MCC_API = 9,
1688 MCC_SOURCE_GET_CURRENT = 0x10,
1689 MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11,
1692 /* DTS measurements */
1694 enum iwl_dts_measurement_flags {
1695 DTS_TRIGGER_CMD_FLAGS_TEMP = BIT(0),
1696 DTS_TRIGGER_CMD_FLAGS_VOLT = BIT(1),
1700 * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1702 * @flags: indicates which measurements we want as specified in &enum
1703 * iwl_dts_measurement_flags
1705 struct iwl_dts_measurement_cmd {
1707 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1710 * enum iwl_dts_control_measurement_mode - DTS measurement type
1711 * @DTS_AUTOMATIC: Automatic mode (full SW control). Provide temperature read
1712 * back (latest value. Not waiting for new value). Use automatic
1713 * SW DTS configuration.
1714 * @DTS_REQUEST_READ: Request DTS read. Configure DTS with manual settings,
1715 * trigger DTS reading and provide read back temperature read
1717 * @DTS_OVER_WRITE: over-write the DTS temperatures in the SW until next read
1718 * @DTS_DIRECT_WITHOUT_MEASURE: DTS returns its latest temperature result,
1719 * without measurement trigger.
1721 enum iwl_dts_control_measurement_mode {
1723 DTS_REQUEST_READ = 1,
1725 DTS_DIRECT_WITHOUT_MEASURE = 3,
1729 * enum iwl_dts_used - DTS to use or used for measurement in the DTS request
1731 * @DTS_USE_CHAIN_A: chain A
1732 * @DTS_USE_CHAIN_B: chain B
1733 * @DTS_USE_CHAIN_C: chain C
1734 * @XTAL_TEMPERATURE - read temperature from xtal
1738 DTS_USE_CHAIN_A = 1,
1739 DTS_USE_CHAIN_B = 2,
1740 DTS_USE_CHAIN_C = 3,
1741 XTAL_TEMPERATURE = 4,
1745 * enum iwl_dts_bit_mode - bit-mode to use in DTS request read mode
1746 * @DTS_BIT6_MODE: bit 6 mode
1747 * @DTS_BIT8_MODE: bit 8 mode
1749 enum iwl_dts_bit_mode {
1755 * iwl_ext_dts_measurement_cmd - request extended DTS temperature measurements
1756 * @control_mode: see &enum iwl_dts_control_measurement_mode
1757 * @temperature: used when over write DTS mode is selected
1758 * @sensor: set temperature sensor to use. See &enum iwl_dts_used
1759 * @avg_factor: average factor to DTS in request DTS read mode
1760 * @bit_mode: value defines the DTS bit mode to use. See &enum iwl_dts_bit_mode
1761 * @step_duration: step duration for the DTS
1763 struct iwl_ext_dts_measurement_cmd {
1764 __le32 control_mode;
1769 __le32 step_duration;
1770 } __packed; /* XVT_FW_DTS_CONTROL_MEASUREMENT_REQUEST_API_S */
1773 * struct iwl_dts_measurement_notif_v1 - measurements notification
1775 * @temp: the measured temperature
1776 * @voltage: the measured voltage
1778 struct iwl_dts_measurement_notif_v1 {
1781 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_1*/
1784 * struct iwl_dts_measurement_notif_v2 - measurements notification
1786 * @temp: the measured temperature
1787 * @voltage: the measured voltage
1788 * @threshold_idx: the trip index that was crossed
1790 struct iwl_dts_measurement_notif_v2 {
1793 __le32 threshold_idx;
1794 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_2 */
1797 * struct ct_kill_notif - CT-kill entry notification
1799 * @temperature: the current temperature in celsius
1800 * @reserved: reserved
1802 struct ct_kill_notif {
1805 } __packed; /* GRP_PHY_CT_KILL_NTF */
1808 * enum ctdp_cmd_operation - CTDP command operations
1809 * @CTDP_CMD_OPERATION_START: update the current budget
1810 * @CTDP_CMD_OPERATION_STOP: stop ctdp
1811 * @CTDP_CMD_OPERATION_REPORT: get the avgerage budget
1813 enum iwl_mvm_ctdp_cmd_operation {
1814 CTDP_CMD_OPERATION_START = 0x1,
1815 CTDP_CMD_OPERATION_STOP = 0x2,
1816 CTDP_CMD_OPERATION_REPORT = 0x4,
1817 };/* CTDP_CMD_OPERATION_TYPE_E */
1820 * struct iwl_mvm_ctdp_cmd - track and manage the FW power consumption budget
1822 * @operation: see &enum iwl_mvm_ctdp_cmd_operation
1823 * @budget: the budget in milliwatt
1824 * @window_size: defined in API but not used
1826 struct iwl_mvm_ctdp_cmd {
1832 #define IWL_MAX_DTS_TRIPS 8
1835 * struct iwl_temp_report_ths_cmd - set temperature thresholds
1837 * @num_temps: number of temperature thresholds passed
1838 * @thresholds: array with the thresholds to be configured
1840 struct temp_report_ths_cmd {
1842 __le16 thresholds[IWL_MAX_DTS_TRIPS];
1843 } __packed; /* GRP_PHY_TEMP_REPORTING_THRESHOLDS_CMD */
1845 /***********************************
1847 ***********************************/
1849 /* Type of TDLS request */
1850 enum iwl_tdls_channel_switch_type {
1851 TDLS_SEND_CHAN_SW_REQ = 0,
1852 TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1854 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1857 * Switch timing sub-element in a TDLS channel-switch command
1858 * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1859 * received from peer
1860 * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1861 * to the TDLS off-channel communication. For instance if the DTIM is
1862 * 200TU and the TDLS peer is to be given 25% of the time, the value
1863 * given will be 50TU, or 50 * 1024 if translated into microseconds.
1864 * @switch_time: switch time the peer sent in its channel switch timing IE
1865 * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1867 struct iwl_tdls_channel_switch_timing {
1868 __le32 frame_timestamp; /* GP2 time of peer packet Rx */
1869 __le32 max_offchan_duration; /* given in micro-seconds */
1870 __le32 switch_time; /* given in micro-seconds */
1871 __le32 switch_timeout; /* given in micro-seconds */
1872 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1874 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1877 * TDLS channel switch frame template
1879 * A template representing a TDLS channel-switch request or response frame
1881 * @switch_time_offset: offset to the channel switch timing IE in the template
1882 * @tx_cmd: Tx parameters for the frame
1885 struct iwl_tdls_channel_switch_frame {
1886 __le32 switch_time_offset;
1887 struct iwl_tx_cmd tx_cmd;
1888 u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1889 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1892 * TDLS channel switch command
1894 * The command is sent to initiate a channel switch and also in response to
1895 * incoming TDLS channel-switch request/response packets from remote peers.
1897 * @switch_type: see &enum iwl_tdls_channel_switch_type
1898 * @peer_sta_id: station id of TDLS peer
1899 * @ci: channel we switch to
1900 * @timing: timing related data for command
1901 * @frame: channel-switch request/response template, depending to switch_type
1903 struct iwl_tdls_channel_switch_cmd {
1906 struct iwl_fw_channel_info ci;
1907 struct iwl_tdls_channel_switch_timing timing;
1908 struct iwl_tdls_channel_switch_frame frame;
1909 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1912 * TDLS channel switch start notification
1914 * @status: non-zero on success
1915 * @offchannel_duration: duration given in microseconds
1916 * @sta_id: peer currently performing the channel-switch with
1918 struct iwl_tdls_channel_switch_notif {
1920 __le32 offchannel_duration;
1922 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1927 * @sta_id: station id of the TDLS peer
1928 * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1929 * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1930 * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1932 struct iwl_tdls_sta_info {
1935 __le16 tx_to_peer_ssn;
1936 __le32 is_initiator;
1937 } __packed; /* TDLS_STA_INFO_VER_1 */
1940 * TDLS basic config command
1942 * @id_and_color: MAC id and color being configured
1943 * @tdls_peer_count: amount of currently connected TDLS peers
1944 * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1945 * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1946 * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1947 * @pti_req_data_offset: offset of network-level data for the PTI template
1948 * @pti_req_tx_cmd: Tx parameters for PTI request template
1949 * @pti_req_template: PTI request template data
1951 struct iwl_tdls_config_cmd {
1952 __le32 id_and_color; /* mac id and color */
1955 __le16 tx_to_ap_ssn;
1956 struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1958 __le32 pti_req_data_offset;
1959 struct iwl_tx_cmd pti_req_tx_cmd;
1960 u8 pti_req_template[0];
1961 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1964 * TDLS per-station config information from FW
1966 * @sta_id: station id of the TDLS peer
1967 * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1970 struct iwl_tdls_config_sta_info_res {
1972 __le16 tx_to_peer_last_seq;
1973 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1976 * TDLS config information from FW
1978 * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1979 * @sta_info: per-station TDLS config information
1981 struct iwl_tdls_config_res {
1982 __le32 tx_to_ap_last_seq;
1983 struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1984 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1986 #define TX_FIFO_MAX_NUM_9000 8
1987 #define TX_FIFO_MAX_NUM 15
1988 #define RX_FIFO_MAX_NUM 2
1989 #define TX_FIFO_INTERNAL_MAX_NUM 6
1992 * Shared memory configuration information from the FW
1994 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1996 * @shared_mem_size: shared memory size
1997 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1998 * 0x0 as accessible only via DBGM RDAT)
1999 * @sample_buff_size: internal sample buff size
2000 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
2001 * 8000 HW set to 0x0 as not accessible)
2002 * @txfifo_size: size of TXF0 ... TXF7
2003 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
2004 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
2005 * when paging is not supported this should be 0
2006 * @page_buff_size: size of %page_buff_addr
2007 * @rxfifo_addr: Start address of rxFifo
2008 * @internal_txfifo_addr: start address of internalFifo
2009 * @internal_txfifo_size: internal fifos' size
2011 * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
2012 * set, the last 3 members don't exist.
2014 struct iwl_shared_mem_cfg_v1 {
2015 __le32 shared_mem_addr;
2016 __le32 shared_mem_size;
2017 __le32 sample_buff_addr;
2018 __le32 sample_buff_size;
2020 __le32 txfifo_size[TX_FIFO_MAX_NUM_9000];
2021 __le32 rxfifo_size[RX_FIFO_MAX_NUM];
2022 __le32 page_buff_addr;
2023 __le32 page_buff_size;
2025 __le32 internal_txfifo_addr;
2026 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
2027 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */
2029 struct iwl_shared_mem_cfg {
2030 __le32 shared_mem_addr;
2031 __le32 shared_mem_size;
2032 __le32 sample_buff_addr;
2033 __le32 sample_buff_size;
2035 __le32 txfifo_size[TX_FIFO_MAX_NUM];
2036 __le32 rxfifo_size[RX_FIFO_MAX_NUM];
2037 __le32 page_buff_addr;
2038 __le32 page_buff_size;
2040 __le32 internal_txfifo_addr;
2041 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
2042 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_3 */
2045 * VHT MU-MIMO group configuration
2047 * @membership_status: a bitmap of MU groups
2048 * @user_position:the position of station in a group. If the station is in the
2049 * group then bits (group * 2) is the position -1
2051 struct iwl_mu_group_mgmt_cmd {
2053 __le32 membership_status[2];
2054 __le32 user_position[4];
2055 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
2058 * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
2060 * @membership_status: a bitmap of MU groups
2061 * @user_position: the position of station in a group. If the station is in the
2062 * group then bits (group * 2) is the position -1
2064 struct iwl_mu_group_mgmt_notif {
2065 __le32 membership_status[2];
2066 __le32 user_position[4];
2067 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
2069 #define MAX_STORED_BEACON_SIZE 600
2072 * Stored beacon notification
2074 * @system_time: system time on air rise
2075 * @tsf: TSF on air rise
2076 * @beacon_timestamp: beacon on air rise
2077 * @phy_flags: general phy flags: band, modulation, etc.
2078 * @channel: channel this beacon was received on
2079 * @rates: rate in ucode internal format
2080 * @byte_count: frame's byte count
2082 struct iwl_stored_beacon_notif {
2085 __le32 beacon_timestamp;
2090 u8 data[MAX_STORED_BEACON_SIZE];
2091 } __packed; /* WOWLAN_STROED_BEACON_INFO_S_VER_1 */
2093 #define LQM_NUMBER_OF_STATIONS_IN_REPORT 16
2095 enum iwl_lqm_cmd_operatrions {
2096 LQM_CMD_OPERATION_START_MEASUREMENT = 0x01,
2097 LQM_CMD_OPERATION_STOP_MEASUREMENT = 0x02,
2100 enum iwl_lqm_status {
2101 LQM_STATUS_SUCCESS = 0,
2102 LQM_STATUS_TIMEOUT = 1,
2103 LQM_STATUS_ABORT = 2,
2107 * Link Quality Measurement command
2108 * @cmd_operatrion: command operation to be performed (start or stop)
2110 * @mac_id: MAC ID the measurement applies to.
2111 * @measurement_time: time of the total measurement to be performed, in uSec.
2112 * @timeout: maximum time allowed until a response is sent, in uSec.
2114 struct iwl_link_qual_msrmnt_cmd {
2115 __le32 cmd_operation;
2117 __le32 measurement_time;
2119 } __packed /* LQM_CMD_API_S_VER_1 */;
2122 * Link Quality Measurement notification
2124 * @frequent_stations_air_time: an array containing the total air time
2125 * (in uSec) used by the most frequently transmitting stations.
2126 * @number_of_stations: the number of uniqe stations included in the array
2127 * (a number between 0 to 16)
2128 * @total_air_time_other_stations: the total air time (uSec) used by all the
2129 * stations which are not included in the above report.
2130 * @time_in_measurement_window: the total time in uSec in which a measurement
2132 * @tx_frame_dropped: the number of TX frames dropped due to retry limit during
2134 * @mac_id: MAC ID the measurement applies to.
2135 * @status: return status. may be one of the LQM_STATUS_* defined above.
2136 * @reserved: reserved.
2138 struct iwl_link_qual_msrmnt_notif {
2139 __le32 frequent_stations_air_time[LQM_NUMBER_OF_STATIONS_IN_REPORT];
2140 __le32 number_of_stations;
2141 __le32 total_air_time_other_stations;
2142 __le32 time_in_measurement_window;
2143 __le32 tx_frame_dropped;
2147 } __packed; /* LQM_MEASUREMENT_COMPLETE_NTF_API_S_VER1 */
2150 * Channel switch NOA notification
2152 * @id_and_color: ID and color of the MAC
2154 struct iwl_channel_switch_noa_notif {
2155 __le32 id_and_color;
2156 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_1 */
2158 /* Operation types for the debug mem access */
2160 DEBUG_MEM_OP_READ = 0,
2161 DEBUG_MEM_OP_WRITE = 1,
2162 DEBUG_MEM_OP_WRITE_BYTES = 2,
2165 #define DEBUG_MEM_MAX_SIZE_DWORDS 32
2168 * struct iwl_dbg_mem_access_cmd - Request the device to read/write memory
2169 * @op: DEBUG_MEM_OP_*
2170 * @addr: address to read/write from/to
2171 * @len: in dwords, to read/write
2172 * @data: for write opeations, contains the source buffer
2174 struct iwl_dbg_mem_access_cmd {
2179 } __packed; /* DEBUG_(U|L)MAC_RD_WR_CMD_API_S_VER_1 */
2181 /* Status responses for the debug mem access */
2183 DEBUG_MEM_STATUS_SUCCESS = 0x0,
2184 DEBUG_MEM_STATUS_FAILED = 0x1,
2185 DEBUG_MEM_STATUS_LOCKED = 0x2,
2186 DEBUG_MEM_STATUS_HIDDEN = 0x3,
2187 DEBUG_MEM_STATUS_LENGTH = 0x4,
2191 * struct iwl_dbg_mem_access_rsp - Response to debug mem commands
2192 * @status: DEBUG_MEM_STATUS_*
2193 * @len: read dwords (0 for write operations)
2194 * @data: contains the read DWs
2196 struct iwl_dbg_mem_access_rsp {
2200 } __packed; /* DEBUG_(U|L)MAC_RD_WR_RSP_API_S_VER_1 */
2202 #endif /* __fw_api_h__ */