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 */
85 IWL_MVM_OFFCHANNEL_QUEUE = 8,
86 IWL_MVM_CMD_QUEUE = 9,
89 enum iwl_mvm_tx_fifo {
90 IWL_MVM_TX_FIFO_BK = 0,
94 IWL_MVM_TX_FIFO_MCAST = 5,
95 IWL_MVM_TX_FIFO_CMD = 7,
98 #define IWL_MVM_STATION_COUNT 16
100 #define IWL_MVM_TDLS_STA_COUNT 4
108 INIT_COMPLETE_NOTIF = 0x4,
110 /* PHY context commands */
111 PHY_CONTEXT_CMD = 0x8,
113 ANTENNA_COUPLING_NOTIFICATION = 0xa,
115 /* UMAC scan commands */
116 SCAN_ITERATION_COMPLETE_UMAC = 0xb5,
119 SCAN_ABORT_UMAC = 0xe,
120 SCAN_COMPLETE_UMAC = 0xf,
127 /* paging get item */
128 FW_GET_ITEM_CMD = 0x1a,
133 MGMT_MCAST_KEY = 0x1f,
135 /* scheduler config */
136 SCD_QUEUE_CFG = 0x1d,
142 SHARED_MEM_CFG = 0x25,
145 TDLS_CHANNEL_SWITCH_CMD = 0x27,
146 TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
147 TDLS_CONFIG_CMD = 0xa7,
149 /* MAC and Binding commands */
150 MAC_CONTEXT_CMD = 0x28,
151 TIME_EVENT_CMD = 0x29, /* both CMD and response */
152 TIME_EVENT_NOTIFICATION = 0x2a,
153 BINDING_CONTEXT_CMD = 0x2b,
154 TIME_QUOTA_CMD = 0x2c,
155 NON_QOS_TX_COUNTER_CMD = 0x2d,
159 /* paging block to FW cpu2 */
160 FW_PAGING_BLOCK_CMD = 0x4f,
163 SCAN_OFFLOAD_REQUEST_CMD = 0x51,
164 SCAN_OFFLOAD_ABORT_CMD = 0x52,
166 SCAN_OFFLOAD_COMPLETE = 0x6D,
167 SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
168 SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
169 MATCH_FOUND_NOTIFICATION = 0xd9,
170 SCAN_ITERATION_COMPLETE = 0xe7,
173 PHY_CONFIGURATION_CMD = 0x6a,
174 CALIB_RES_NOTIF_PHY_DB = 0x6b,
175 /* PHY_DB_CMD = 0x6c, */
177 /* ToF - 802.11mc FTM */
179 TOF_NOTIFICATION = 0x11,
181 /* Power - legacy power table command */
182 POWER_TABLE_CMD = 0x77,
183 PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
186 /* Thermal Throttling*/
187 REPLY_THERMAL_MNG_BACKOFF = 0x7e,
189 /* Set/Get DC2DC frequency tune */
190 DC2DC_CONFIG_CMD = 0x83,
193 NVM_ACCESS_CMD = 0x88,
195 SET_CALIB_DEFAULT_CMD = 0x8e,
197 BEACON_NOTIFICATION = 0x90,
198 BEACON_TEMPLATE_CMD = 0x91,
199 TX_ANT_CONFIGURATION_CMD = 0x98,
200 STATISTICS_CMD = 0x9c,
201 STATISTICS_NOTIFICATION = 0x9d,
202 EOSP_NOTIFICATION = 0x9e,
203 REDUCE_TX_POWER_CMD = 0x9f,
205 /* RF-KILL commands and notifications */
206 CARD_STATE_CMD = 0xa0,
207 CARD_STATE_NOTIFICATION = 0xa1,
209 MISSED_BEACONS_NOTIFICATION = 0xa2,
211 /* Power - new power table command */
212 MAC_PM_POWER_TABLE = 0xa9,
214 MFUART_LOAD_NOTIFICATION = 0xb1,
216 REPLY_RX_PHY_CMD = 0xc0,
217 REPLY_RX_MPDU_CMD = 0xc1,
218 FRAME_RELEASE = 0xc3,
221 /* Location Aware Regulatory */
222 MCC_UPDATE_CMD = 0xc8,
223 MCC_CHUB_UPDATE_CMD = 0xc9,
228 BT_COEX_PRIO_TABLE = 0xcc,
229 BT_COEX_PROT_ENV = 0xcd,
230 BT_PROFILE_NOTIFICATION = 0xce,
232 BT_COEX_UPDATE_SW_BOOST = 0x5a,
233 BT_COEX_UPDATE_CORUN_LUT = 0x5b,
234 BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
237 REPLY_SF_CFG_CMD = 0xd1,
238 REPLY_BEACON_FILTERING_CMD = 0xd2,
240 /* DTS measurements */
241 CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
242 DTS_MEASUREMENT_NOTIFICATION = 0xdd,
244 REPLY_DEBUG_CMD = 0xf0,
245 LDBG_CONFIG_CMD = 0xf6,
246 DEBUG_LOG_MSG = 0xf7,
248 BCAST_FILTER_CMD = 0xcf,
249 MCAST_FILTER_CMD = 0xd0,
251 /* D3 commands/notifications */
252 D3_CONFIG_CMD = 0xd3,
253 PROT_OFFLOAD_CONFIG_CMD = 0xd4,
254 OFFLOADS_QUERY_CMD = 0xd5,
255 REMOTE_WAKE_CONFIG_CMD = 0xd6,
258 /* for WoWLAN in particular */
259 WOWLAN_PATTERNS = 0xe0,
260 WOWLAN_CONFIGURATION = 0xe1,
261 WOWLAN_TSC_RSC_PARAM = 0xe2,
262 WOWLAN_TKIP_PARAM = 0xe3,
263 WOWLAN_KEK_KCK_MATERIAL = 0xe4,
264 WOWLAN_GET_STATUSES = 0xe5,
265 WOWLAN_TX_POWER_PER_DB = 0xe6,
267 /* and for NetDetect */
268 SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
269 SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
270 SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
275 /* Please keep this enum *SORTED* by hex value.
276 * Needed for binary search, otherwise a warning will be triggered.
278 enum iwl_phy_ops_subcmd_ids {
279 CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0,
280 DTS_MEASUREMENT_NOTIF_WIDE = 0xFF,
291 * struct iwl_cmd_response - generic response struct for most commands
292 * @status: status of the command asked, changes for each one
294 struct iwl_cmd_response {
299 * struct iwl_tx_ant_cfg_cmd
300 * @valid: valid antenna configuration
302 struct iwl_tx_ant_cfg_cmd {
307 * Calibration control struct.
308 * Sent as part of the phy configuration command.
309 * @flow_trigger: bitmap for which calibrations to perform according to
311 * @event_trigger: bitmap for which calibrations to perform according to
314 struct iwl_calib_ctrl {
316 __le32 event_trigger;
319 /* This enum defines the bitmap of various calibrations to enable in both
320 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
323 IWL_CALIB_CFG_XTAL_IDX = BIT(0),
324 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(1),
325 IWL_CALIB_CFG_VOLTAGE_READ_IDX = BIT(2),
326 IWL_CALIB_CFG_PAPD_IDX = BIT(3),
327 IWL_CALIB_CFG_TX_PWR_IDX = BIT(4),
328 IWL_CALIB_CFG_DC_IDX = BIT(5),
329 IWL_CALIB_CFG_BB_FILTER_IDX = BIT(6),
330 IWL_CALIB_CFG_LO_LEAKAGE_IDX = BIT(7),
331 IWL_CALIB_CFG_TX_IQ_IDX = BIT(8),
332 IWL_CALIB_CFG_TX_IQ_SKEW_IDX = BIT(9),
333 IWL_CALIB_CFG_RX_IQ_IDX = BIT(10),
334 IWL_CALIB_CFG_RX_IQ_SKEW_IDX = BIT(11),
335 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(12),
336 IWL_CALIB_CFG_CHAIN_NOISE_IDX = BIT(13),
337 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX = BIT(14),
338 IWL_CALIB_CFG_ANT_COUPLING_IDX = BIT(15),
339 IWL_CALIB_CFG_DAC_IDX = BIT(16),
340 IWL_CALIB_CFG_ABS_IDX = BIT(17),
341 IWL_CALIB_CFG_AGC_IDX = BIT(18),
345 * Phy configuration command.
347 struct iwl_phy_cfg_cmd {
349 struct iwl_calib_ctrl calib_control;
352 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1))
353 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3))
354 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5))
355 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7))
356 #define PHY_CFG_TX_CHAIN_A BIT(8)
357 #define PHY_CFG_TX_CHAIN_B BIT(9)
358 #define PHY_CFG_TX_CHAIN_C BIT(10)
359 #define PHY_CFG_RX_CHAIN_A BIT(12)
360 #define PHY_CFG_RX_CHAIN_B BIT(13)
361 #define PHY_CFG_RX_CHAIN_C BIT(14)
364 /* Target of the NVM_ACCESS_CMD */
366 NVM_ACCESS_TARGET_CACHE = 0,
367 NVM_ACCESS_TARGET_OTP = 1,
368 NVM_ACCESS_TARGET_EEPROM = 2,
371 /* Section types for NVM_ACCESS_CMD */
373 NVM_SECTION_TYPE_SW = 1,
374 NVM_SECTION_TYPE_REGULATORY = 3,
375 NVM_SECTION_TYPE_CALIBRATION = 4,
376 NVM_SECTION_TYPE_PRODUCTION = 5,
377 NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
378 NVM_SECTION_TYPE_PHY_SKU = 12,
379 NVM_MAX_NUM_SECTIONS = 13,
383 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
384 * @op_code: 0 - read, 1 - write
385 * @target: NVM_ACCESS_TARGET_*
386 * @type: NVM_SECTION_TYPE_*
387 * @offset: offset in bytes into the section
388 * @length: in bytes, to read/write
389 * @data: if write operation, the data to write. On read its empty
391 struct iwl_nvm_access_cmd {
398 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
400 #define NUM_OF_FW_PAGING_BLOCKS 33 /* 32 for data and 1 block for CSS */
403 * struct iwl_fw_paging_cmd - paging layout
405 * (FW_PAGING_BLOCK_CMD = 0x4f)
407 * Send to FW the paging layout in the driver.
409 * @flags: various flags for the command
410 * @block_size: the block size in powers of 2
411 * @block_num: number of blocks specified in the command.
412 * @device_phy_addr: virtual addresses from device side
414 struct iwl_fw_paging_cmd {
418 __le32 device_phy_addr[NUM_OF_FW_PAGING_BLOCKS];
419 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_1 */
424 * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload
427 enum iwl_fw_item_id {
428 IWL_FW_ITEM_ID_PAGING = 3,
432 * struct iwl_fw_get_item_cmd - get an item from the fw
434 struct iwl_fw_get_item_cmd {
436 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */
438 #define CONT_REC_COMMAND_SIZE 80
439 #define ENABLE_CONT_RECORDING 0x15
440 #define DISABLE_CONT_RECORDING 0x16
443 * struct iwl_continuous_record_mode - recording mode
445 struct iwl_continuous_record_mode {
446 __le16 enable_recording;
450 * struct iwl_continuous_record_cmd - enable/disable continuous recording
452 struct iwl_continuous_record_cmd {
453 struct iwl_continuous_record_mode record_mode;
454 u8 pad[CONT_REC_COMMAND_SIZE -
455 sizeof(struct iwl_continuous_record_mode)];
458 struct iwl_fw_get_item_resp {
460 __le32 item_byte_cnt;
462 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */
465 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
466 * @offset: offset in bytes into the section
467 * @length: in bytes, either how much was written or read
468 * @type: NVM_SECTION_TYPE_*
469 * @status: 0 for success, fail otherwise
470 * @data: if read operation, the data returned. Empty on write.
472 struct iwl_nvm_access_resp {
478 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
482 /* alive response is_valid values */
483 #define ALIVE_RESP_UCODE_OK BIT(0)
484 #define ALIVE_RESP_RFKILL BIT(1)
486 /* alive response ver_type values */
496 /* alive response ver_subtype values */
498 FW_SUBTYPE_FULL_FEATURE = 0,
499 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
500 FW_SUBTYPE_REDUCED = 2,
501 FW_SUBTYPE_ALIVE_ONLY = 3,
502 FW_SUBTYPE_WOWLAN = 4,
503 FW_SUBTYPE_AP_SUBTYPE = 5,
504 FW_SUBTYPE_WIPAN = 6,
505 FW_SUBTYPE_INITIALIZE = 9
508 #define IWL_ALIVE_STATUS_ERR 0xDEAD
509 #define IWL_ALIVE_STATUS_OK 0xCAFE
511 #define IWL_ALIVE_FLG_RFKILL BIT(0)
513 struct mvm_alive_resp_ver1 {
527 __le32 error_event_table_ptr; /* SRAM address for error log */
528 __le32 log_event_table_ptr; /* SRAM address for event log */
529 __le32 cpu_register_ptr;
530 __le32 dbgm_config_ptr;
531 __le32 alive_counter_ptr;
532 __le32 scd_base_ptr; /* SRAM address for SCD */
533 } __packed; /* ALIVE_RES_API_S_VER_1 */
535 struct mvm_alive_resp_ver2 {
549 __le32 error_event_table_ptr; /* SRAM address for error log */
550 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */
551 __le32 cpu_register_ptr;
552 __le32 dbgm_config_ptr;
553 __le32 alive_counter_ptr;
554 __le32 scd_base_ptr; /* SRAM address for SCD */
555 __le32 st_fwrd_addr; /* pointer to Store and forward */
557 u8 umac_minor; /* UMAC version: minor */
558 u8 umac_major; /* UMAC version: major */
559 __le16 umac_id; /* UMAC version: id */
560 __le32 error_info_addr; /* SRAM address for UMAC error log */
561 __le32 dbg_print_buff_addr;
562 } __packed; /* ALIVE_RES_API_S_VER_2 */
564 struct mvm_alive_resp {
574 __le32 error_event_table_ptr; /* SRAM address for error log */
575 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */
576 __le32 cpu_register_ptr;
577 __le32 dbgm_config_ptr;
578 __le32 alive_counter_ptr;
579 __le32 scd_base_ptr; /* SRAM address for SCD */
580 __le32 st_fwrd_addr; /* pointer to Store and forward */
582 __le32 umac_minor; /* UMAC version: minor */
583 __le32 umac_major; /* UMAC version: major */
584 __le32 error_info_addr; /* SRAM address for UMAC error log */
585 __le32 dbg_print_buff_addr;
586 } __packed; /* ALIVE_RES_API_S_VER_3 */
588 /* Error response/notification */
590 FW_ERR_UNKNOWN_CMD = 0x0,
591 FW_ERR_INVALID_CMD_PARAM = 0x1,
592 FW_ERR_SERVICE = 0x2,
593 FW_ERR_ARC_MEMORY = 0x3,
594 FW_ERR_ARC_CODE = 0x4,
595 FW_ERR_WATCH_DOG = 0x5,
596 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
597 FW_ERR_WEP_KEY_SIZE = 0x11,
598 FW_ERR_OBSOLETE_FUNC = 0x12,
599 FW_ERR_UNEXPECTED = 0xFE,
604 * struct iwl_error_resp - FW error indication
605 * ( REPLY_ERROR = 0x2 )
606 * @error_type: one of FW_ERR_*
607 * @cmd_id: the command ID for which the error occured
608 * @bad_cmd_seq_num: sequence number of the erroneous command
609 * @error_service: which service created the error, applicable only if
610 * error_type = 2, otherwise 0
611 * @timestamp: TSF in usecs.
613 struct iwl_error_resp {
617 __le16 bad_cmd_seq_num;
618 __le32 error_service;
623 /* Common PHY, MAC and Bindings definitions */
625 #define MAX_MACS_IN_BINDING (3)
626 #define MAX_BINDINGS (4)
627 #define AUX_BINDING_INDEX (3)
630 /* Used to extract ID and color from the context dword */
631 #define FW_CTXT_ID_POS (0)
632 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS)
633 #define FW_CTXT_COLOR_POS (8)
634 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
635 #define FW_CTXT_INVALID (0xffffffff)
637 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
638 (_color << FW_CTXT_COLOR_POS))
640 /* Possible actions on PHYs, MACs and Bindings */
642 FW_CTXT_ACTION_STUB = 0,
644 FW_CTXT_ACTION_MODIFY,
645 FW_CTXT_ACTION_REMOVE,
647 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
651 /* Time Event types, according to MAC type */
652 enum iwl_time_event_type {
653 /* BSS Station Events */
654 TE_BSS_STA_AGGRESSIVE_ASSOC,
656 TE_BSS_EAP_DHCP_PROT,
659 /* P2P Device Events */
660 TE_P2P_DEVICE_DISCOVERABLE,
661 TE_P2P_DEVICE_LISTEN,
662 TE_P2P_DEVICE_ACTION_SCAN,
663 TE_P2P_DEVICE_FULL_SCAN,
665 /* P2P Client Events */
666 TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
668 TE_P2P_CLIENT_QUIET_PERIOD,
671 TE_P2P_GO_ASSOC_PROT,
672 TE_P2P_GO_REPETITIVE_NOA,
675 /* WiDi Sync Events */
678 /* Channel Switch NoA */
679 TE_CHANNEL_SWITCH_PERIOD,
682 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
686 /* Time event - defines for command API v1 */
689 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
690 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
691 * the first fragment is scheduled.
692 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
693 * the first 2 fragments are scheduled.
694 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
695 * number of fragments are valid.
697 * Other than the constant defined above, specifying a fragmentation value 'x'
698 * means that the event can be fragmented but only the first 'x' will be
703 TE_V1_FRAG_SINGLE = 1,
705 TE_V1_FRAG_ENDLESS = 0xffffffff
708 /* If a Time Event can be fragmented, this is the max number of fragments */
709 #define TE_V1_FRAG_MAX_MSK 0x0fffffff
710 /* Repeat the time event endlessly (until removed) */
711 #define TE_V1_REPEAT_ENDLESS 0xffffffff
712 /* If a Time Event has bounded repetitions, this is the maximal value */
713 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
715 /* Time Event dependencies: none, on another TE, or in a specific time */
717 TE_V1_INDEPENDENT = 0,
718 TE_V1_DEP_OTHER = BIT(0),
719 TE_V1_DEP_TSF = BIT(1),
720 TE_V1_EVENT_SOCIOPATHIC = BIT(2),
721 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
724 * @TE_V1_NOTIF_NONE: no notifications
725 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
726 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
727 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
728 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
729 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
730 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
731 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
732 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
734 * Supported Time event notifications configuration.
735 * A notification (both event and fragment) includes a status indicating weather
736 * the FW was able to schedule the event or not. For fragment start/end
737 * notification the status is always success. There is no start/end fragment
738 * notification for monolithic events.
741 TE_V1_NOTIF_NONE = 0,
742 TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
743 TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
744 TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
745 TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
746 TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
747 TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
748 TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
749 TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
750 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
752 /* Time event - defines for command API */
755 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
756 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
757 * the first fragment is scheduled.
758 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
759 * the first 2 fragments are scheduled.
760 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
761 * number of fragments are valid.
763 * Other than the constant defined above, specifying a fragmentation value 'x'
764 * means that the event can be fragmented but only the first 'x' will be
769 TE_V2_FRAG_SINGLE = 1,
771 TE_V2_FRAG_MAX = 0xfe,
772 TE_V2_FRAG_ENDLESS = 0xff
775 /* Repeat the time event endlessly (until removed) */
776 #define TE_V2_REPEAT_ENDLESS 0xff
777 /* If a Time Event has bounded repetitions, this is the maximal value */
778 #define TE_V2_REPEAT_MAX 0xfe
780 #define TE_V2_PLACEMENT_POS 12
781 #define TE_V2_ABSENCE_POS 15
783 /* Time event policy values
784 * A notification (both event and fragment) includes a status indicating weather
785 * the FW was able to schedule the event or not. For fragment start/end
786 * notification the status is always success. There is no start/end fragment
787 * notification for monolithic events.
789 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
790 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
791 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
792 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
793 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
794 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
795 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
796 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
797 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
798 * @TE_V2_DEP_OTHER: depends on another time event
799 * @TE_V2_DEP_TSF: depends on a specific time
800 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
801 * @TE_V2_ABSENCE: are we present or absent during the Time Event.
804 TE_V2_DEFAULT_POLICY = 0x0,
806 /* notifications (event start/stop, fragment start/stop) */
807 TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
808 TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
809 TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
810 TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
812 TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
813 TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
814 TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
815 TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
816 T2_V2_START_IMMEDIATELY = BIT(11),
818 TE_V2_NOTIF_MSK = 0xff,
820 /* placement characteristics */
821 TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
822 TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
823 TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
825 /* are we present or absent during the Time Event. */
826 TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
830 * struct iwl_time_event_cmd_api - configuring Time Events
831 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
832 * with version 1. determined by IWL_UCODE_TLV_FLAGS)
833 * ( TIME_EVENT_CMD = 0x29 )
834 * @id_and_color: ID and color of the relevant MAC
835 * @action: action to perform, one of FW_CTXT_ACTION_*
836 * @id: this field has two meanings, depending on the action:
837 * If the action is ADD, then it means the type of event to add.
838 * For all other actions it is the unique event ID assigned when the
839 * event was added by the FW.
840 * @apply_time: When to start the Time Event (in GP2)
841 * @max_delay: maximum delay to event's start (apply time), in TU
842 * @depends_on: the unique ID of the event we depend on (if any)
843 * @interval: interval between repetitions, in TU
844 * @duration: duration of event in TU
845 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
846 * @max_frags: maximal number of fragments the Time Event can be divided to
847 * @policy: defines whether uCode shall notify the host or other uCode modules
848 * on event and/or fragment start and/or end
849 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
850 * TE_EVENT_SOCIOPATHIC
851 * using TE_ABSENCE and using TE_NOTIF_*
853 struct iwl_time_event_cmd {
854 /* COMMON_INDEX_HDR_API_S_VER_1 */
858 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
867 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
870 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
871 * @status: bit 0 indicates success, all others specify errors
872 * @id: the Time Event type
873 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
874 * @id_and_color: ID and color of the relevant MAC
876 struct iwl_time_event_resp {
881 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
884 * struct iwl_time_event_notif - notifications of time event start/stop
885 * ( TIME_EVENT_NOTIFICATION = 0x2a )
886 * @timestamp: action timestamp in GP2
887 * @session_id: session's unique id
888 * @unique_id: unique id of the Time Event itself
889 * @id_and_color: ID and color of the relevant MAC
890 * @action: one of TE_NOTIF_START or TE_NOTIF_END
891 * @status: true if scheduled, false otherwise (not executed)
893 struct iwl_time_event_notif {
900 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
903 /* Bindings and Time Quota */
906 * struct iwl_binding_cmd - configuring bindings
907 * ( BINDING_CONTEXT_CMD = 0x2b )
908 * @id_and_color: ID and color of the relevant Binding
909 * @action: action to perform, one of FW_CTXT_ACTION_*
910 * @macs: array of MAC id and colors which belong to the binding
911 * @phy: PHY id and color which belongs to the binding
913 struct iwl_binding_cmd {
914 /* COMMON_INDEX_HDR_API_S_VER_1 */
917 /* BINDING_DATA_API_S_VER_1 */
918 __le32 macs[MAX_MACS_IN_BINDING];
920 } __packed; /* BINDING_CMD_API_S_VER_1 */
922 /* The maximal number of fragments in the FW's schedule session */
923 #define IWL_MVM_MAX_QUOTA 128
926 * struct iwl_time_quota_data - configuration of time quota per binding
927 * @id_and_color: ID and color of the relevant Binding
928 * @quota: absolute time quota in TU. The scheduler will try to divide the
929 * remainig quota (after Time Events) according to this quota.
930 * @max_duration: max uninterrupted context duration in TU
932 struct iwl_time_quota_data {
936 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
939 * struct iwl_time_quota_cmd - configuration of time quota between bindings
940 * ( TIME_QUOTA_CMD = 0x2c )
941 * @quotas: allocations per binding
943 struct iwl_time_quota_cmd {
944 struct iwl_time_quota_data quotas[MAX_BINDINGS];
945 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
950 /* Supported bands */
951 #define PHY_BAND_5 (0)
952 #define PHY_BAND_24 (1)
954 /* Supported channel width, vary if there is VHT support */
955 #define PHY_VHT_CHANNEL_MODE20 (0x0)
956 #define PHY_VHT_CHANNEL_MODE40 (0x1)
957 #define PHY_VHT_CHANNEL_MODE80 (0x2)
958 #define PHY_VHT_CHANNEL_MODE160 (0x3)
961 * Control channel position:
962 * For legacy set bit means upper channel, otherwise lower.
963 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
964 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
967 * 40Mhz |_______|_______|
968 * 80Mhz |_______|_______|_______|_______|
969 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
970 * code 011 010 001 000 | 100 101 110 111
972 #define PHY_VHT_CTRL_POS_1_BELOW (0x0)
973 #define PHY_VHT_CTRL_POS_2_BELOW (0x1)
974 #define PHY_VHT_CTRL_POS_3_BELOW (0x2)
975 #define PHY_VHT_CTRL_POS_4_BELOW (0x3)
976 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4)
977 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5)
978 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6)
979 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7)
983 * @channel: channel number
984 * @width: PHY_[VHT|LEGACY]_CHANNEL_*
985 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
987 struct iwl_fw_channel_info {
994 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0)
995 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
996 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
997 #define PHY_RX_CHAIN_VALID_POS (1)
998 #define PHY_RX_CHAIN_VALID_MSK \
999 (0x7 << PHY_RX_CHAIN_VALID_POS)
1000 #define PHY_RX_CHAIN_FORCE_SEL_POS (4)
1001 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
1002 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
1003 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
1004 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
1005 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
1006 #define PHY_RX_CHAIN_CNT_POS (10)
1007 #define PHY_RX_CHAIN_CNT_MSK \
1008 (0x3 << PHY_RX_CHAIN_CNT_POS)
1009 #define PHY_RX_CHAIN_MIMO_CNT_POS (12)
1010 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
1011 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
1012 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14)
1013 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
1014 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
1016 /* TODO: fix the value, make it depend on firmware at runtime? */
1017 #define NUM_PHY_CTX 3
1019 /* TODO: complete missing documentation */
1021 * struct iwl_phy_context_cmd - config of the PHY context
1022 * ( PHY_CONTEXT_CMD = 0x8 )
1023 * @id_and_color: ID and color of the relevant Binding
1024 * @action: action to perform, one of FW_CTXT_ACTION_*
1025 * @apply_time: 0 means immediate apply and context switch.
1026 * other value means apply new params after X usecs
1027 * @tx_param_color: ???
1029 * @txchain_info: ???
1030 * @rxchain_info: ???
1031 * @acquisition_data: ???
1032 * @dsp_cfg_flags: set to 0
1034 struct iwl_phy_context_cmd {
1035 /* COMMON_INDEX_HDR_API_S_VER_1 */
1036 __le32 id_and_color;
1038 /* PHY_CONTEXT_DATA_API_S_VER_1 */
1040 __le32 tx_param_color;
1041 struct iwl_fw_channel_info ci;
1042 __le32 txchain_info;
1043 __le32 rxchain_info;
1044 __le32 acquisition_data;
1045 __le32 dsp_cfg_flags;
1046 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
1051 * Command requests the firmware to create a time event for a certain duration
1052 * and remain on the given channel. This is done by using the Aux framework in
1054 * The command was first used for Hot Spot issues - but can be used regardless
1057 * ( HOT_SPOT_CMD 0x53 )
1059 * @id_and_color: ID and color of the MAC
1060 * @action: action to perform, one of FW_CTXT_ACTION_*
1061 * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
1062 * event_unique_id should be the id of the time event assigned by ucode.
1063 * Otherwise ignore the event_unique_id.
1064 * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
1066 * @channel_info: channel info
1067 * @node_addr: Our MAC Address
1068 * @reserved: reserved for alignment
1069 * @apply_time: GP2 value to start (should always be the current GP2 value)
1070 * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
1071 * time by which start of the event is allowed to be postponed.
1072 * @duration: event duration in TU To calculate event duration:
1073 * timeEventDuration = min(duration, remainingQuota)
1075 struct iwl_hs20_roc_req {
1076 /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
1077 __le32 id_and_color;
1079 __le32 event_unique_id;
1080 __le32 sta_id_and_color;
1081 struct iwl_fw_channel_info channel_info;
1082 u8 node_addr[ETH_ALEN];
1085 __le32 apply_time_max_delay;
1087 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
1090 * values for AUX ROC result values
1092 enum iwl_mvm_hot_spot {
1093 HOT_SPOT_RSP_STATUS_OK,
1094 HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
1095 HOT_SPOT_MAX_NUM_OF_SESSIONS,
1099 * Aux ROC command response
1101 * In response to iwl_hs20_roc_req the FW sends this command to notify the
1102 * driver the uid of the timevent.
1104 * ( HOT_SPOT_CMD 0x53 )
1106 * @event_unique_id: Unique ID of time event assigned by ucode
1107 * @status: Return status 0 is success, all the rest used for specific errors
1109 struct iwl_hs20_roc_res {
1110 __le32 event_unique_id;
1112 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1115 * struct iwl_radio_version_notif - information on the radio version
1116 * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1121 struct iwl_radio_version_notif {
1122 __le32 radio_flavor;
1125 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1127 enum iwl_card_state_flags {
1128 CARD_ENABLED = 0x00,
1129 HW_CARD_DISABLED = 0x01,
1130 SW_CARD_DISABLED = 0x02,
1131 CT_KILL_CARD_DISABLED = 0x04,
1132 HALT_CARD_DISABLED = 0x08,
1133 CARD_DISABLED_MSK = 0x0f,
1134 CARD_IS_RX_ON = 0x10,
1138 * struct iwl_radio_version_notif - information on the radio version
1139 * ( CARD_STATE_NOTIFICATION = 0xa1 )
1140 * @flags: %iwl_card_state_flags
1142 struct iwl_card_state_notif {
1144 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1147 * struct iwl_missed_beacons_notif - information on missed beacons
1148 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1149 * @mac_id: interface ID
1150 * @consec_missed_beacons_since_last_rx: number of consecutive missed
1151 * beacons since last RX.
1152 * @consec_missed_beacons: number of consecutive missed beacons
1153 * @num_expected_beacons:
1154 * @num_recvd_beacons:
1156 struct iwl_missed_beacons_notif {
1158 __le32 consec_missed_beacons_since_last_rx;
1159 __le32 consec_missed_beacons;
1160 __le32 num_expected_beacons;
1161 __le32 num_recvd_beacons;
1162 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1165 * struct iwl_mfuart_load_notif - mfuart image version & status
1166 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1167 * @installed_ver: installed image version
1168 * @external_ver: external image version
1169 * @status: MFUART loading status
1170 * @duration: MFUART loading time
1172 struct iwl_mfuart_load_notif {
1173 __le32 installed_ver;
1174 __le32 external_ver;
1177 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/
1180 * struct iwl_set_calib_default_cmd - set default value for calibration.
1181 * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1182 * @calib_index: the calibration to set value for
1184 * @data: the value to set for the calibration result
1186 struct iwl_set_calib_default_cmd {
1190 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1192 #define MAX_PORT_ID_NUM 2
1193 #define MAX_MCAST_FILTERING_ADDRESSES 256
1196 * struct iwl_mcast_filter_cmd - configure multicast filter.
1197 * @filter_own: Set 1 to filter out multicast packets sent by station itself
1198 * @port_id: Multicast MAC addresses array specifier. This is a strange way
1199 * to identify network interface adopted in host-device IF.
1200 * It is used by FW as index in array of addresses. This array has
1201 * MAX_PORT_ID_NUM members.
1202 * @count: Number of MAC addresses in the array
1203 * @pass_all: Set 1 to pass all multicast packets.
1204 * @bssid: current association BSSID.
1205 * @addr_list: Place holder for array of MAC addresses.
1206 * IMPORTANT: add padding if necessary to ensure DWORD alignment.
1208 struct iwl_mcast_filter_cmd {
1216 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1218 #define MAX_BCAST_FILTERS 8
1219 #define MAX_BCAST_FILTER_ATTRS 2
1222 * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1223 * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1224 * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1225 * start of ip payload).
1227 enum iwl_mvm_bcast_filter_attr_offset {
1228 BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1229 BCAST_FILTER_OFFSET_IP_END = 1,
1233 * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1234 * @offset_type: &enum iwl_mvm_bcast_filter_attr_offset.
1235 * @offset: starting offset of this pattern.
1236 * @val: value to match - big endian (MSB is the first
1237 * byte to match from offset pos).
1238 * @mask: mask to match (big endian).
1240 struct iwl_fw_bcast_filter_attr {
1246 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1249 * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1250 * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1251 * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1253 enum iwl_mvm_bcast_filter_frame_type {
1254 BCAST_FILTER_FRAME_TYPE_ALL = 0,
1255 BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1259 * struct iwl_fw_bcast_filter - broadcast filter
1260 * @discard: discard frame (1) or let it pass (0).
1261 * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1262 * @num_attrs: number of valid attributes in this filter.
1263 * @attrs: attributes of this filter. a filter is considered matched
1264 * only when all its attributes are matched (i.e. AND relationship)
1266 struct iwl_fw_bcast_filter {
1271 struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1272 } __packed; /* BCAST_FILTER_S_VER_1 */
1275 * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1276 * @default_discard: default action for this mac (discard (1) / pass (0)).
1277 * @attached_filters: bitmap of relevant filters for this mac.
1279 struct iwl_fw_bcast_mac {
1282 __le16 attached_filters;
1283 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1286 * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1287 * @disable: enable (0) / disable (1)
1288 * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1289 * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1290 * @filters: broadcast filters
1291 * @macs: broadcast filtering configuration per-mac
1293 struct iwl_bcast_filter_cmd {
1295 u8 max_bcast_filters;
1298 struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1299 struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1300 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1303 * enum iwl_mvm_marker_id - maker ids
1305 * The ids for different type of markers to insert into the usniffer logs
1307 enum iwl_mvm_marker_id {
1308 MARKER_ID_TX_FRAME_LATENCY = 1,
1309 }; /* MARKER_ID_API_E_VER_1 */
1312 * struct iwl_mvm_marker - mark info into the usniffer logs
1314 * (MARKER_CMD = 0xcb)
1316 * Mark the UTC time stamp into the usniffer logs together with additional
1317 * metadata, so the usniffer output can be parsed.
1318 * In the command response the ucode will return the GP2 time.
1320 * @dw_len: The amount of dwords following this byte including this byte.
1321 * @marker_id: A unique marker id (iwl_mvm_marker_id).
1322 * @reserved: reserved.
1323 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1324 * @metadata: additional meta data that will be written to the unsiffer log
1326 struct iwl_mvm_marker {
1332 } __packed; /* MARKER_API_S_VER_1 */
1335 * enum iwl_dc2dc_config_id - flag ids
1337 * Ids of dc2dc configuration flags
1339 enum iwl_dc2dc_config_id {
1340 DCDC_LOW_POWER_MODE_MSK_SET = 0x1, /* not used */
1341 DCDC_FREQ_TUNE_SET = 0x2,
1342 }; /* MARKER_ID_API_E_VER_1 */
1345 * struct iwl_dc2dc_config_cmd - configure dc2dc values
1347 * (DC2DC_CONFIG_CMD = 0x83)
1349 * Set/Get & configure dc2dc values.
1350 * The command always returns the current dc2dc values.
1352 * @flags: set/get dc2dc
1353 * @enable_low_power_mode: not used.
1354 * @dc2dc_freq_tune0: frequency divider - digital domain
1355 * @dc2dc_freq_tune1: frequency divider - analog domain
1357 struct iwl_dc2dc_config_cmd {
1359 __le32 enable_low_power_mode; /* not used */
1360 __le32 dc2dc_freq_tune0;
1361 __le32 dc2dc_freq_tune1;
1362 } __packed; /* DC2DC_CONFIG_CMD_API_S_VER_1 */
1365 * struct iwl_dc2dc_config_resp - response for iwl_dc2dc_config_cmd
1367 * Current dc2dc values returned by the FW.
1369 * @dc2dc_freq_tune0: frequency divider - digital domain
1370 * @dc2dc_freq_tune1: frequency divider - analog domain
1372 struct iwl_dc2dc_config_resp {
1373 __le32 dc2dc_freq_tune0;
1374 __le32 dc2dc_freq_tune1;
1375 } __packed; /* DC2DC_CONFIG_RESP_API_S_VER_1 */
1377 /***********************************
1379 ***********************************/
1380 /* Smart Fifo state */
1382 SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1389 /* Smart Fifo possible scenario */
1390 enum iwl_sf_scenario {
1391 SF_SCENARIO_SINGLE_UNICAST,
1392 SF_SCENARIO_AGG_UNICAST,
1393 SF_SCENARIO_MULTICAST,
1394 SF_SCENARIO_BA_RESP,
1395 SF_SCENARIO_TX_RESP,
1399 #define SF_TRANSIENT_STATES_NUMBER 2 /* SF_LONG_DELAY_ON and SF_FULL_ON */
1400 #define SF_NUM_TIMEOUT_TYPES 2 /* Aging timer and Idle timer */
1402 /* smart FIFO default values */
1403 #define SF_W_MARK_SISO 6144
1404 #define SF_W_MARK_MIMO2 8192
1405 #define SF_W_MARK_MIMO3 6144
1406 #define SF_W_MARK_LEGACY 4096
1407 #define SF_W_MARK_SCAN 4096
1409 /* SF Scenarios timers for default configuration (aligned to 32 uSec) */
1410 #define SF_SINGLE_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */
1411 #define SF_SINGLE_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1412 #define SF_AGG_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */
1413 #define SF_AGG_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1414 #define SF_MCAST_IDLE_TIMER_DEF 160 /* 150 mSec */
1415 #define SF_MCAST_AGING_TIMER_DEF 400 /* 0.4 mSec */
1416 #define SF_BA_IDLE_TIMER_DEF 160 /* 150 uSec */
1417 #define SF_BA_AGING_TIMER_DEF 400 /* 0.4 mSec */
1418 #define SF_TX_RE_IDLE_TIMER_DEF 160 /* 150 uSec */
1419 #define SF_TX_RE_AGING_TIMER_DEF 400 /* 0.4 mSec */
1421 /* SF Scenarios timers for BSS MAC configuration (aligned to 32 uSec) */
1422 #define SF_SINGLE_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1423 #define SF_SINGLE_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1424 #define SF_AGG_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1425 #define SF_AGG_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1426 #define SF_MCAST_IDLE_TIMER 2016 /* 2 mSec */
1427 #define SF_MCAST_AGING_TIMER 10016 /* 10 mSec */
1428 #define SF_BA_IDLE_TIMER 320 /* 300 uSec */
1429 #define SF_BA_AGING_TIMER 2016 /* 2 mSec */
1430 #define SF_TX_RE_IDLE_TIMER 320 /* 300 uSec */
1431 #define SF_TX_RE_AGING_TIMER 2016 /* 2 mSec */
1433 #define SF_LONG_DELAY_AGING_TIMER 1000000 /* 1 Sec */
1435 #define SF_CFG_DUMMY_NOTIF_OFF BIT(16)
1438 * Smart Fifo configuration command.
1439 * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1440 * @watermark: Minimum allowed availabe free space in RXF for transient state.
1441 * @long_delay_timeouts: aging and idle timer values for each scenario
1442 * in long delay state.
1443 * @full_on_timeouts: timer values for each scenario in full on state.
1445 struct iwl_sf_cfg_cmd {
1447 __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1448 __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1449 __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1450 } __packed; /* SF_CFG_API_S_VER_2 */
1452 /***********************************
1453 * Location Aware Regulatory (LAR) API - MCC updates
1454 ***********************************/
1457 * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic
1458 * regulatory profile according to the given MCC (Mobile Country Code).
1459 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1460 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1461 * MCC in the cmd response will be the relevant MCC in the NVM.
1462 * @mcc: given mobile country code
1463 * @source_id: the source from where we got the MCC, see iwl_mcc_source
1464 * @reserved: reserved for alignment
1466 struct iwl_mcc_update_cmd_v1 {
1470 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_1 */
1473 * struct iwl_mcc_update_cmd - Request the device to update geographic
1474 * regulatory profile according to the given MCC (Mobile Country Code).
1475 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1476 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1477 * MCC in the cmd response will be the relevant MCC in the NVM.
1478 * @mcc: given mobile country code
1479 * @source_id: the source from where we got the MCC, see iwl_mcc_source
1480 * @reserved: reserved for alignment
1481 * @key: integrity key for MCC API OEM testing
1482 * @reserved2: reserved
1484 struct iwl_mcc_update_cmd {
1489 __le32 reserved2[5];
1490 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */
1493 * iwl_mcc_update_resp_v1 - response to MCC_UPDATE_CMD.
1494 * Contains the new channel control profile map, if changed, and the new MCC
1495 * (mobile country code).
1496 * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1497 * @status: see &enum iwl_mcc_update_status
1498 * @mcc: the new applied MCC
1499 * @cap: capabilities for all channels which matches the MCC
1500 * @source_id: the MCC source, see iwl_mcc_source
1501 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1502 * channels, depending on platform)
1503 * @channels: channel control data map, DWORD for each channel. Only the first
1506 struct iwl_mcc_update_resp_v1 {
1513 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */
1516 * iwl_mcc_update_resp - response to MCC_UPDATE_CMD.
1517 * Contains the new channel control profile map, if changed, and the new MCC
1518 * (mobile country code).
1519 * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1520 * @status: see &enum iwl_mcc_update_status
1521 * @mcc: the new applied MCC
1522 * @cap: capabilities for all channels which matches the MCC
1523 * @source_id: the MCC source, see iwl_mcc_source
1524 * @time: time elapsed from the MCC test start (in 30 seconds TU)
1525 * @reserved: reserved.
1526 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1527 * channels, depending on platform)
1528 * @channels: channel control data map, DWORD for each channel. Only the first
1531 struct iwl_mcc_update_resp {
1540 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_2 */
1543 * struct iwl_mcc_chub_notif - chub notifies of mcc change
1544 * (MCC_CHUB_UPDATE_CMD = 0xc9)
1545 * The Chub (Communication Hub, CommsHUB) is a HW component that connects to
1546 * the cellular and connectivity cores that gets updates of the mcc, and
1547 * notifies the ucode directly of any mcc change.
1548 * The ucode requests the driver to request the device to update geographic
1549 * regulatory profile according to the given MCC (Mobile Country Code).
1550 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1551 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1552 * MCC in the cmd response will be the relevant MCC in the NVM.
1553 * @mcc: given mobile country code
1554 * @source_id: identity of the change originator, see iwl_mcc_source
1555 * @reserved1: reserved for alignment
1557 struct iwl_mcc_chub_notif {
1561 } __packed; /* LAR_MCC_NOTIFY_S */
1563 enum iwl_mcc_update_status {
1564 MCC_RESP_NEW_CHAN_PROFILE,
1565 MCC_RESP_SAME_CHAN_PROFILE,
1567 MCC_RESP_NVM_DISABLED,
1569 MCC_RESP_LOW_PRIORITY,
1570 MCC_RESP_TEST_MODE_ACTIVE,
1571 MCC_RESP_TEST_MODE_NOT_ACTIVE,
1572 MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE,
1575 enum iwl_mcc_source {
1576 MCC_SOURCE_OLD_FW = 0,
1578 MCC_SOURCE_BIOS = 2,
1579 MCC_SOURCE_3G_LTE_HOST = 3,
1580 MCC_SOURCE_3G_LTE_DEVICE = 4,
1581 MCC_SOURCE_WIFI = 5,
1582 MCC_SOURCE_RESERVED = 6,
1583 MCC_SOURCE_DEFAULT = 7,
1584 MCC_SOURCE_UNINITIALIZED = 8,
1585 MCC_SOURCE_MCC_API = 9,
1586 MCC_SOURCE_GET_CURRENT = 0x10,
1587 MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11,
1590 /* DTS measurements */
1592 enum iwl_dts_measurement_flags {
1593 DTS_TRIGGER_CMD_FLAGS_TEMP = BIT(0),
1594 DTS_TRIGGER_CMD_FLAGS_VOLT = BIT(1),
1598 * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1600 * @flags: indicates which measurements we want as specified in &enum
1601 * iwl_dts_measurement_flags
1603 struct iwl_dts_measurement_cmd {
1605 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1608 * enum iwl_dts_control_measurement_mode - DTS measurement type
1609 * @DTS_AUTOMATIC: Automatic mode (full SW control). Provide temperature read
1610 * back (latest value. Not waiting for new value). Use automatic
1611 * SW DTS configuration.
1612 * @DTS_REQUEST_READ: Request DTS read. Configure DTS with manual settings,
1613 * trigger DTS reading and provide read back temperature read
1615 * @DTS_OVER_WRITE: over-write the DTS temperatures in the SW until next read
1616 * @DTS_DIRECT_WITHOUT_MEASURE: DTS returns its latest temperature result,
1617 * without measurement trigger.
1619 enum iwl_dts_control_measurement_mode {
1621 DTS_REQUEST_READ = 1,
1623 DTS_DIRECT_WITHOUT_MEASURE = 3,
1627 * enum iwl_dts_used - DTS to use or used for measurement in the DTS request
1629 * @DTS_USE_CHAIN_A: chain A
1630 * @DTS_USE_CHAIN_B: chain B
1631 * @DTS_USE_CHAIN_C: chain C
1632 * @XTAL_TEMPERATURE - read temperature from xtal
1636 DTS_USE_CHAIN_A = 1,
1637 DTS_USE_CHAIN_B = 2,
1638 DTS_USE_CHAIN_C = 3,
1639 XTAL_TEMPERATURE = 4,
1643 * enum iwl_dts_bit_mode - bit-mode to use in DTS request read mode
1644 * @DTS_BIT6_MODE: bit 6 mode
1645 * @DTS_BIT8_MODE: bit 8 mode
1647 enum iwl_dts_bit_mode {
1653 * iwl_ext_dts_measurement_cmd - request extended DTS temperature measurements
1654 * @control_mode: see &enum iwl_dts_control_measurement_mode
1655 * @temperature: used when over write DTS mode is selected
1656 * @sensor: set temperature sensor to use. See &enum iwl_dts_used
1657 * @avg_factor: average factor to DTS in request DTS read mode
1658 * @bit_mode: value defines the DTS bit mode to use. See &enum iwl_dts_bit_mode
1659 * @step_duration: step duration for the DTS
1661 struct iwl_ext_dts_measurement_cmd {
1662 __le32 control_mode;
1667 __le32 step_duration;
1668 } __packed; /* XVT_FW_DTS_CONTROL_MEASUREMENT_REQUEST_API_S */
1671 * iwl_dts_measurement_notif - notification received with the measurements
1673 * @temp: the measured temperature
1674 * @voltage: the measured voltage
1676 struct iwl_dts_measurement_notif {
1679 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S */
1681 /***********************************
1683 ***********************************/
1685 /* Type of TDLS request */
1686 enum iwl_tdls_channel_switch_type {
1687 TDLS_SEND_CHAN_SW_REQ = 0,
1688 TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1690 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1693 * Switch timing sub-element in a TDLS channel-switch command
1694 * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1695 * received from peer
1696 * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1697 * to the TDLS off-channel communication. For instance if the DTIM is
1698 * 200TU and the TDLS peer is to be given 25% of the time, the value
1699 * given will be 50TU, or 50 * 1024 if translated into microseconds.
1700 * @switch_time: switch time the peer sent in its channel switch timing IE
1701 * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1703 struct iwl_tdls_channel_switch_timing {
1704 __le32 frame_timestamp; /* GP2 time of peer packet Rx */
1705 __le32 max_offchan_duration; /* given in micro-seconds */
1706 __le32 switch_time; /* given in micro-seconds */
1707 __le32 switch_timeout; /* given in micro-seconds */
1708 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1710 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1713 * TDLS channel switch frame template
1715 * A template representing a TDLS channel-switch request or response frame
1717 * @switch_time_offset: offset to the channel switch timing IE in the template
1718 * @tx_cmd: Tx parameters for the frame
1721 struct iwl_tdls_channel_switch_frame {
1722 __le32 switch_time_offset;
1723 struct iwl_tx_cmd tx_cmd;
1724 u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1725 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1728 * TDLS channel switch command
1730 * The command is sent to initiate a channel switch and also in response to
1731 * incoming TDLS channel-switch request/response packets from remote peers.
1733 * @switch_type: see &enum iwl_tdls_channel_switch_type
1734 * @peer_sta_id: station id of TDLS peer
1735 * @ci: channel we switch to
1736 * @timing: timing related data for command
1737 * @frame: channel-switch request/response template, depending to switch_type
1739 struct iwl_tdls_channel_switch_cmd {
1742 struct iwl_fw_channel_info ci;
1743 struct iwl_tdls_channel_switch_timing timing;
1744 struct iwl_tdls_channel_switch_frame frame;
1745 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1748 * TDLS channel switch start notification
1750 * @status: non-zero on success
1751 * @offchannel_duration: duration given in microseconds
1752 * @sta_id: peer currently performing the channel-switch with
1754 struct iwl_tdls_channel_switch_notif {
1756 __le32 offchannel_duration;
1758 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1763 * @sta_id: station id of the TDLS peer
1764 * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1765 * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1766 * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1768 struct iwl_tdls_sta_info {
1771 __le16 tx_to_peer_ssn;
1772 __le32 is_initiator;
1773 } __packed; /* TDLS_STA_INFO_VER_1 */
1776 * TDLS basic config command
1778 * @id_and_color: MAC id and color being configured
1779 * @tdls_peer_count: amount of currently connected TDLS peers
1780 * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1781 * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1782 * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1783 * @pti_req_data_offset: offset of network-level data for the PTI template
1784 * @pti_req_tx_cmd: Tx parameters for PTI request template
1785 * @pti_req_template: PTI request template data
1787 struct iwl_tdls_config_cmd {
1788 __le32 id_and_color; /* mac id and color */
1791 __le16 tx_to_ap_ssn;
1792 struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1794 __le32 pti_req_data_offset;
1795 struct iwl_tx_cmd pti_req_tx_cmd;
1796 u8 pti_req_template[0];
1797 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1800 * TDLS per-station config information from FW
1802 * @sta_id: station id of the TDLS peer
1803 * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1806 struct iwl_tdls_config_sta_info_res {
1808 __le16 tx_to_peer_last_seq;
1809 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1812 * TDLS config information from FW
1814 * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1815 * @sta_info: per-station TDLS config information
1817 struct iwl_tdls_config_res {
1818 __le32 tx_to_ap_last_seq;
1819 struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1820 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1822 #define TX_FIFO_MAX_NUM 8
1823 #define RX_FIFO_MAX_NUM 2
1826 * Shared memory configuration information from the FW
1828 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1830 * @shared_mem_size: shared memory size
1831 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1832 * 0x0 as accessible only via DBGM RDAT)
1833 * @sample_buff_size: internal sample buff size
1834 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
1835 * 8000 HW set to 0x0 as not accessible)
1836 * @txfifo_size: size of TXF0 ... TXF7
1837 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
1838 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
1839 * when paging is not supported this should be 0
1840 * @page_buff_size: size of %page_buff_addr
1842 struct iwl_shared_mem_cfg {
1843 __le32 shared_mem_addr;
1844 __le32 shared_mem_size;
1845 __le32 sample_buff_addr;
1846 __le32 sample_buff_size;
1848 __le32 txfifo_size[TX_FIFO_MAX_NUM];
1849 __le32 rxfifo_size[RX_FIFO_MAX_NUM];
1850 __le32 page_buff_addr;
1851 __le32 page_buff_size;
1852 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_1 */
1854 #endif /* __fw_api_h__ */