/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* * Copyright (C) 2005-2014, 2018-2023 Intel Corporation * Copyright (C) 2013-2015 Intel Mobile Communications GmbH * Copyright (C) 2016-2017 Intel Deutschland GmbH */ #ifndef __iwl_fw_api_debug_h__ #define __iwl_fw_api_debug_h__ /** * enum iwl_debug_cmds - debug commands */ enum iwl_debug_cmds { /** * @LMAC_RD_WR: * LMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and * &struct iwl_dbg_mem_access_rsp */ LMAC_RD_WR = 0x0, /** * @UMAC_RD_WR: * UMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and * &struct iwl_dbg_mem_access_rsp */ UMAC_RD_WR = 0x1, /** * @HOST_EVENT_CFG: * updates the enabled event severities * &struct iwl_dbg_host_event_cfg_cmd */ HOST_EVENT_CFG = 0x3, /** * @INVALID_WR_PTR_CMD: invalid write pointer, set in the TFD * when it's not in use */ INVALID_WR_PTR_CMD = 0x6, /** * @DBGC_SUSPEND_RESUME: * DBGC suspend/resume commad. Uses a single dword as data: * 0 - resume DBGC recording * 1 - suspend DBGC recording */ DBGC_SUSPEND_RESUME = 0x7, /** * @BUFFER_ALLOCATION: * passes DRAM buffers to a DBGC * &struct iwl_buf_alloc_cmd */ BUFFER_ALLOCATION = 0x8, /** * @GET_TAS_STATUS: * sends command to fw to get TAS status * the response is &struct iwl_mvm_tas_status_resp */ GET_TAS_STATUS = 0xA, /** * @FW_DUMP_COMPLETE_CMD: * sends command to fw once dump collection completed * &struct iwl_dbg_dump_complete_cmd */ FW_DUMP_COMPLETE_CMD = 0xB, /** * @FW_CLEAR_BUFFER: * clears the firmware's internal buffer * no payload */ FW_CLEAR_BUFFER = 0xD, /** * @MFU_ASSERT_DUMP_NTF: * &struct iwl_mfu_assert_dump_notif */ MFU_ASSERT_DUMP_NTF = 0xFE, }; /* Error response/notification */ enum { FW_ERR_UNKNOWN_CMD = 0x0, FW_ERR_INVALID_CMD_PARAM = 0x1, FW_ERR_SERVICE = 0x2, FW_ERR_ARC_MEMORY = 0x3, FW_ERR_ARC_CODE = 0x4, FW_ERR_WATCH_DOG = 0x5, FW_ERR_WEP_GRP_KEY_INDX = 0x10, FW_ERR_WEP_KEY_SIZE = 0x11, FW_ERR_OBSOLETE_FUNC = 0x12, FW_ERR_UNEXPECTED = 0xFE, FW_ERR_FATAL = 0xFF }; /** enum iwl_dbg_suspend_resume_cmds - dbgc suspend resume operations * dbgc suspend resume command operations * @DBGC_RESUME_CMD: resume dbgc recording * @DBGC_SUSPEND_CMD: stop dbgc recording */ enum iwl_dbg_suspend_resume_cmds { DBGC_RESUME_CMD, DBGC_SUSPEND_CMD, }; /** * struct iwl_error_resp - FW error indication * ( REPLY_ERROR = 0x2 ) * @error_type: one of FW_ERR_* * @cmd_id: the command ID for which the error occurred * @reserved1: reserved * @bad_cmd_seq_num: sequence number of the erroneous command * @error_service: which service created the error, applicable only if * error_type = 2, otherwise 0 * @timestamp: TSF in usecs. */ struct iwl_error_resp { __le32 error_type; u8 cmd_id; u8 reserved1; __le16 bad_cmd_seq_num; __le32 error_service; __le64 timestamp; } __packed; #define TX_FIFO_MAX_NUM_9000 8 #define TX_FIFO_MAX_NUM 15 #define RX_FIFO_MAX_NUM 2 #define TX_FIFO_INTERNAL_MAX_NUM 6 /** * struct iwl_shared_mem_cfg_v2 - Shared memory configuration information * * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not * accessible) * @shared_mem_size: shared memory size * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to * 0x0 as accessible only via DBGM RDAT) * @sample_buff_size: internal sample buff size * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre * 8000 HW set to 0x0 as not accessible) * @txfifo_size: size of TXF0 ... TXF7 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0 * @page_buff_addr: used by UMAC and performance debug (page miss analysis), * when paging is not supported this should be 0 * @page_buff_size: size of %page_buff_addr * @rxfifo_addr: Start address of rxFifo * @internal_txfifo_addr: start address of internalFifo * @internal_txfifo_size: internal fifos' size * * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG * set, the last 3 members don't exist. */ struct iwl_shared_mem_cfg_v2 { __le32 shared_mem_addr; __le32 shared_mem_size; __le32 sample_buff_addr; __le32 sample_buff_size; __le32 txfifo_addr; __le32 txfifo_size[TX_FIFO_MAX_NUM_9000]; __le32 rxfifo_size[RX_FIFO_MAX_NUM]; __le32 page_buff_addr; __le32 page_buff_size; __le32 rxfifo_addr; __le32 internal_txfifo_addr; __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; } __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */ /** * struct iwl_shared_mem_lmac_cfg - LMAC shared memory configuration * * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB) * @txfifo_size: size of TX FIFOs * @rxfifo1_addr: RXF1 addr * @rxfifo1_size: RXF1 size */ struct iwl_shared_mem_lmac_cfg { __le32 txfifo_addr; __le32 txfifo_size[TX_FIFO_MAX_NUM]; __le32 rxfifo1_addr; __le32 rxfifo1_size; } __packed; /* SHARED_MEM_ALLOC_LMAC_API_S_VER_1 */ /** * struct iwl_shared_mem_cfg - Shared memory configuration information * * @shared_mem_addr: shared memory address * @shared_mem_size: shared memory size * @sample_buff_addr: internal sample (mon/adc) buff addr * @sample_buff_size: internal sample buff size * @rxfifo2_addr: start addr of RXF2 * @rxfifo2_size: size of RXF2 * @page_buff_addr: used by UMAC and performance debug (page miss analysis), * when paging is not supported this should be 0 * @page_buff_size: size of %page_buff_addr * @lmac_num: number of LMACs (1 or 2) * @lmac_smem: per - LMAC smem data * @rxfifo2_control_addr: start addr of RXF2C * @rxfifo2_control_size: size of RXF2C */ struct iwl_shared_mem_cfg { __le32 shared_mem_addr; __le32 shared_mem_size; __le32 sample_buff_addr; __le32 sample_buff_size; __le32 rxfifo2_addr; __le32 rxfifo2_size; __le32 page_buff_addr; __le32 page_buff_size; __le32 lmac_num; struct iwl_shared_mem_lmac_cfg lmac_smem[3]; __le32 rxfifo2_control_addr; __le32 rxfifo2_control_size; } __packed; /* SHARED_MEM_ALLOC_API_S_VER_4 */ /** * struct iwl_mfuart_load_notif_v1 - mfuart image version & status * ( MFUART_LOAD_NOTIFICATION = 0xb1 ) * @installed_ver: installed image version * @external_ver: external image version * @status: MFUART loading status * @duration: MFUART loading time */ struct iwl_mfuart_load_notif_v1 { __le32 installed_ver; __le32 external_ver; __le32 status; __le32 duration; } __packed; /* MFU_LOADER_NTFY_API_S_VER_1 */ /** * struct iwl_mfuart_load_notif - mfuart image version & status * ( MFUART_LOAD_NOTIFICATION = 0xb1 ) * @installed_ver: installed image version * @external_ver: external image version * @status: MFUART loading status * @duration: MFUART loading time * @image_size: MFUART image size in bytes */ struct iwl_mfuart_load_notif { __le32 installed_ver; __le32 external_ver; __le32 status; __le32 duration; /* image size valid only in v2 of the command */ __le32 image_size; } __packed; /* MFU_LOADER_NTFY_API_S_VER_2 */ /** * struct iwl_mfu_assert_dump_notif - mfuart dump logs * ( MFU_ASSERT_DUMP_NTF = 0xfe ) * @assert_id: mfuart assert id that cause the notif * @curr_reset_num: number of asserts since uptime * @index_num: current chunk id * @parts_num: total number of chunks * @data_size: number of data bytes sent * @data: data buffer */ struct iwl_mfu_assert_dump_notif { __le32 assert_id; __le32 curr_reset_num; __le16 index_num; __le16 parts_num; __le32 data_size; __le32 data[]; } __packed; /* MFU_DUMP_ASSERT_API_S_VER_1 */ /** * enum iwl_mvm_marker_id - marker ids * * The ids for different type of markers to insert into the usniffer logs * * @MARKER_ID_TX_FRAME_LATENCY: TX latency marker * @MARKER_ID_SYNC_CLOCK: sync FW time and systime */ enum iwl_mvm_marker_id { MARKER_ID_TX_FRAME_LATENCY = 1, MARKER_ID_SYNC_CLOCK = 2, }; /* MARKER_ID_API_E_VER_2 */ /** * struct iwl_mvm_marker - mark info into the usniffer logs * * (MARKER_CMD = 0xcb) * * Mark the UTC time stamp into the usniffer logs together with additional * metadata, so the usniffer output can be parsed. * In the command response the ucode will return the GP2 time. * * @dw_len: The amount of dwords following this byte including this byte. * @marker_id: A unique marker id (iwl_mvm_marker_id). * @reserved: reserved. * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC * @metadata: additional meta data that will be written to the unsiffer log */ struct iwl_mvm_marker { u8 dw_len; u8 marker_id; __le16 reserved; __le64 timestamp; __le32 metadata[]; } __packed; /* MARKER_API_S_VER_1 */ /** * struct iwl_mvm_marker_rsp - Response to marker cmd * * @gp2: The gp2 clock value in the FW */ struct iwl_mvm_marker_rsp { __le32 gp2; } __packed; /* Operation types for the debug mem access */ enum { DEBUG_MEM_OP_READ = 0, DEBUG_MEM_OP_WRITE = 1, DEBUG_MEM_OP_WRITE_BYTES = 2, }; #define DEBUG_MEM_MAX_SIZE_DWORDS 32 /** * struct iwl_dbg_mem_access_cmd - Request the device to read/write memory * @op: DEBUG_MEM_OP_* * @addr: address to read/write from/to * @len: in dwords, to read/write * @data: for write opeations, contains the source buffer */ struct iwl_dbg_mem_access_cmd { __le32 op; __le32 addr; __le32 len; __le32 data[]; } __packed; /* DEBUG_(U|L)MAC_RD_WR_CMD_API_S_VER_1 */ /* Status responses for the debug mem access */ enum { DEBUG_MEM_STATUS_SUCCESS = 0x0, DEBUG_MEM_STATUS_FAILED = 0x1, DEBUG_MEM_STATUS_LOCKED = 0x2, DEBUG_MEM_STATUS_HIDDEN = 0x3, DEBUG_MEM_STATUS_LENGTH = 0x4, }; /** * struct iwl_dbg_mem_access_rsp - Response to debug mem commands * @status: DEBUG_MEM_STATUS_* * @len: read dwords (0 for write operations) * @data: contains the read DWs */ struct iwl_dbg_mem_access_rsp { __le32 status; __le32 len; __le32 data[]; } __packed; /* DEBUG_(U|L)MAC_RD_WR_RSP_API_S_VER_1 */ /** * struct iwl_dbg_suspend_resume_cmd - dbgc suspend resume command * @operation: suspend or resume operation, uses * &enum iwl_dbg_suspend_resume_cmds */ struct iwl_dbg_suspend_resume_cmd { __le32 operation; } __packed; #define BUF_ALLOC_MAX_NUM_FRAGS 16 /** * struct iwl_buf_alloc_frag - a DBGC fragment * @addr: base address of the fragment * @size: size of the fragment */ struct iwl_buf_alloc_frag { __le64 addr; __le32 size; } __packed; /* FRAGMENT_STRUCTURE_API_S_VER_1 */ /** * struct iwl_buf_alloc_cmd - buffer allocation command * @alloc_id: &enum iwl_fw_ini_allocation_id * @buf_location: &enum iwl_fw_ini_buffer_location * @num_frags: number of fragments * @frags: fragments array */ struct iwl_buf_alloc_cmd { __le32 alloc_id; __le32 buf_location; __le32 num_frags; struct iwl_buf_alloc_frag frags[BUF_ALLOC_MAX_NUM_FRAGS]; } __packed; /* BUFFER_ALLOCATION_CMD_API_S_VER_2 */ #define DRAM_INFO_FIRST_MAGIC_WORD 0x76543210 #define DRAM_INFO_SECOND_MAGIC_WORD 0x89ABCDEF /** * struct iwl_dram_info - DRAM fragments allocation struct * * Driver will fill in the first 1K(+) of the pointed DRAM fragment * * @first_word: magic word value * @second_word: magic word value * @framfrags: DRAM fragmentaion detail */ struct iwl_dram_info { __le32 first_word; __le32 second_word; struct iwl_buf_alloc_cmd dram_frags[IWL_FW_INI_ALLOCATION_NUM - 1]; } __packed; /* INIT_DRAM_FRAGS_ALLOCATIONS_S_VER_1 */ /** * struct iwl_dbgc1_info - DBGC1 address and size * * Driver will fill the dbcg1 address and size at address based on config TLV. * * @first_word: all 0 set as identifier * @dbgc1_add_lsb: LSB bits of DBGC1 physical address * @dbgc1_add_msb: MSB bits of DBGC1 physical address * @dbgc1_size: DBGC1 size */ struct iwl_dbgc1_info { __le32 first_word; __le32 dbgc1_add_lsb; __le32 dbgc1_add_msb; __le32 dbgc1_size; } __packed; /* INIT_DRAM_FRAGS_ALLOCATIONS_S_VER_1 */ /** * struct iwl_dbg_host_event_cfg_cmd * @enabled_severities: enabled severities */ struct iwl_dbg_host_event_cfg_cmd { __le32 enabled_severities; } __packed; /* DEBUG_HOST_EVENT_CFG_CMD_API_S_VER_1 */ /** * struct iwl_dbg_dump_complete_cmd - dump complete cmd * * @tp: timepoint whose dump has completed * @tp_data: timepoint data */ struct iwl_dbg_dump_complete_cmd { __le32 tp; __le32 tp_data; } __packed; /* FW_DUMP_COMPLETE_CMD_API_S_VER_1 */ #define TAS_LMAC_BAND_HB 0 #define TAS_LMAC_BAND_LB 1 #define TAS_LMAC_BAND_UHB 2 #define TAS_LMAC_BAND_INVALID 3 /** * struct iwl_mvm_tas_status_per_mac - tas status per lmac * @static_status: tas statically enabled or disabled per lmac - TRUE/FALSE * @static_dis_reason: TAS static disable reason, uses * &enum iwl_mvm_tas_statically_disabled_reason * @dynamic_status: Current TAS status. uses * &enum iwl_mvm_tas_dyna_status * @near_disconnection: is TAS currently near disconnection per lmac? - TRUE/FALSE * @max_reg_pwr_limit: Regulatory power limits in dBm * @sar_limit: SAR limits per lmac in dBm * @band: Band per lmac * @reserved: reserved */ struct iwl_mvm_tas_status_per_mac { u8 static_status; u8 static_dis_reason; u8 dynamic_status; u8 near_disconnection; __le16 max_reg_pwr_limit; __le16 sar_limit; u8 band; u8 reserved[3]; } __packed; /*DEBUG_GET_TAS_STATUS_PER_MAC_S_VER_1*/ /** * struct iwl_mvm_tas_status_resp - Response to GET_TAS_STATUS * @tas_fw_version: TAS FW version * @is_uhb_for_usa_enable: is UHB enabled in USA? - TRUE/FALSE * @curr_mcc: current mcc * @block_list: country block list * @tas_status_mac: TAS status per lmac, uses * &struct iwl_mvm_tas_status_per_mac * @in_dual_radio: is TAS in dual radio? - TRUE/FALSE * @reserved: reserved */ struct iwl_mvm_tas_status_resp { u8 tas_fw_version; u8 is_uhb_for_usa_enable; __le16 curr_mcc; __le16 block_list[16]; struct iwl_mvm_tas_status_per_mac tas_status_mac[2]; u8 in_dual_radio; u8 reserved[3]; } __packed; /*DEBUG_GET_TAS_STATUS_RSP_API_S_VER_3*/ /** * enum iwl_mvm_tas_dyna_status - TAS current running status * @TAS_DYNA_INACTIVE: TAS status is inactive * @TAS_DYNA_INACTIVE_MVM_MODE: TAS is disabled due because FW is in MVM mode * or is in softap mode. * @TAS_DYNA_INACTIVE_TRIGGER_MODE: TAS is disabled because FW is in * multi user trigger mode * @TAS_DYNA_INACTIVE_BLOCK_LISTED: TAS is disabled because current mcc * is blocklisted mcc * @TAS_DYNA_INACTIVE_UHB_NON_US: TAS is disabled because current band is UHB * and current mcc is USA * @TAS_DYNA_ACTIVE: TAS is currently active * @TAS_DYNA_STATUS_MAX: TAS status max value */ enum iwl_mvm_tas_dyna_status { TAS_DYNA_INACTIVE, TAS_DYNA_INACTIVE_MVM_MODE, TAS_DYNA_INACTIVE_TRIGGER_MODE, TAS_DYNA_INACTIVE_BLOCK_LISTED, TAS_DYNA_INACTIVE_UHB_NON_US, TAS_DYNA_ACTIVE, TAS_DYNA_STATUS_MAX, }; /*_TAS_DYNA_STATUS_E*/ /** * enum iwl_mvm_tas_statically_disabled_reason - TAS statically disabled reason * @TAS_DISABLED_DUE_TO_BIOS: TAS is disabled because TAS is disabled in BIOS * @TAS_DISABLED_DUE_TO_SAR_6DBM: TAS is disabled because SAR limit is less than 6 Dbm * @TAS_DISABLED_REASON_INVALID: TAS disable reason is invalid * @TAS_DISABLED_REASON_MAX: TAS disable reason max value */ enum iwl_mvm_tas_statically_disabled_reason { TAS_DISABLED_DUE_TO_BIOS, TAS_DISABLED_DUE_TO_SAR_6DBM, TAS_DISABLED_REASON_INVALID, TAS_DISABLED_REASON_MAX, }; /*_TAS_STATICALLY_DISABLED_REASON_E*/ /** * enum iwl_fw_dbg_config_cmd_type - types of FW debug config command * @DEBUG_TOKEN_CONFIG_TYPE: token config type */ enum iwl_fw_dbg_config_cmd_type { DEBUG_TOKEN_CONFIG_TYPE = 0x2B, }; /* LDBG_CFG_CMD_TYPE_API_E_VER_1 */ /* this token disables debug asserts in the firmware */ #define IWL_FW_DBG_CONFIG_TOKEN 0x00011301 /** * struct iwl_fw_dbg_config_cmd - configure FW debug * * @type: according to &enum iwl_fw_dbg_config_cmd_type * @conf: FW configuration */ struct iwl_fw_dbg_config_cmd { __le32 type; __le32 conf; } __packed; /* LDBG_CFG_CMD_API_S_VER_7 */ #endif /* __iwl_fw_api_debug_h__ */