/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* * Copyright (C) 2018-2024 Intel Corporation */ #ifndef __iwl_fw_dbg_tlv_h__ #define __iwl_fw_dbg_tlv_h__ #include <linux/bitops.h> #define IWL_FW_INI_MAX_REGION_ID … #define IWL_FW_INI_MAX_NAME … #define IWL_FW_INI_MAX_CFG_NAME … #define IWL_FW_INI_DOMAIN_ALWAYS_ON … #define IWL_FW_INI_REGION_ID_MASK … #define IWL_FW_INI_REGION_DUMP_POLICY_MASK … #define IWL_FW_INI_PRESET_DISABLE … /** * struct iwl_fw_ini_hcmd * * @id: the debug configuration command type for instance: 0xf6 / 0xf5 / DHC * @group: the desired cmd group * @reserved: to align to FW struct * @data: all of the relevant command data to be sent */ struct iwl_fw_ini_hcmd { … } __packed; /* FW_DEBUG_TLV_HCMD_DATA_API_S_VER_1 */ /** * struct iwl_fw_ini_header - Common Header for all ini debug TLV's structures * * @version: TLV version * @domain: domain of the TLV. One of &enum iwl_fw_ini_dbg_domain */ struct iwl_fw_ini_header { … } __packed; /* FW_TLV_DEBUG_HEADER_S_VER_1 */ /** * struct iwl_fw_ini_addr_size - Base address and size that defines * a chunk of memory * * @addr: the base address (fixed size - 4 bytes) * @size: the size to read */ struct iwl_fw_ini_addr_size { … } __packed; /* FW_TLV_DEBUG_ADDR_SIZE_VER_1 */ /** * struct iwl_fw_ini_region_dev_addr_range - Configuration to read * device address range * * @offset: offset to add to the base address of each chunk * The addrs[] array will be treated as an array of &iwl_fw_ini_addr_size - * an array of (addr, size) pairs. */ struct iwl_fw_ini_region_dev_addr_range { … } __packed; /* FW_TLV_DEBUG_DEVICE_ADDR_RANGE_API_S_VER_1 */ /** * struct iwl_fw_ini_region_dev_addr - Configuration to read device addresses * * @size: size of each memory chunk * @offset: offset to add to the base address of each chunk */ struct iwl_fw_ini_region_dev_addr { … } __packed; /* FW_TLV_DEBUG_DEVICE_ADDR_API_S_VER_1 */ /** * struct iwl_fw_ini_region_fifos - Configuration to read Tx/Rx fifos * * @fid: fifos ids array. Used to determine what fifos to collect * @hdr_only: if non zero, collect only the registers * @offset: offset to add to the registers addresses */ struct iwl_fw_ini_region_fifos { … } __packed; /* FW_TLV_DEBUG_REGION_FIFOS_API_S_VER_1 */ /** * struct iwl_fw_ini_region_err_table - error table region data * * Configuration to read Umac/Lmac error table * * @version: version of the error table * @base_addr: base address of the error table * @size: size of the error table * @offset: offset to add to &base_addr */ struct iwl_fw_ini_region_err_table { … } __packed; /* FW_TLV_DEBUG_REGION_ERROR_TABLE_API_S_VER_1 */ /** * struct iwl_fw_ini_region_special_device_memory - special device memory * * Configuration to read a special memory * * @type: type of the special memory * @version: version of the special memory * @base_addr: base address of the error table * @size: size of the error table * @offset: offset to add to &base_addr */ struct iwl_fw_ini_region_special_device_memory { … } __packed; /* FW_TLV_DEBUG_REGION_SPECIAL_DEVICE_ADDR_API_S_VER_1 */ /** * struct iwl_fw_ini_region_internal_buffer - internal buffer region data * * Configuration to read internal monitor buffer * * @alloc_id: allocation id one of &enum iwl_fw_ini_allocation_id * @base_addr: internal buffer base address * @size: size internal buffer size */ struct iwl_fw_ini_region_internal_buffer { … } __packed; /* FW_TLV_DEBUG_REGION_INTERNAL_BUFFER_API_S_VER_1 */ /** * struct iwl_fw_ini_region_tlv - region TLV * * Configures parameters for region data collection * * @hdr: debug header * @id: region id. Max id is %IWL_FW_INI_MAX_REGION_ID * @type: region type. One of &enum iwl_fw_ini_region_type * @sub_type: region sub type * @sub_type_ver: region sub type version * @reserved: not in use * @name: region name * @dev_addr: device address configuration. Used by * %IWL_FW_INI_REGION_DEVICE_MEMORY, %IWL_FW_INI_REGION_PERIPHERY_MAC, * %IWL_FW_INI_REGION_PERIPHERY_PHY, %IWL_FW_INI_REGION_PERIPHERY_AUX, * %IWL_FW_INI_REGION_PAGING, %IWL_FW_INI_REGION_CSR, * %IWL_FW_INI_REGION_DRAM_IMR and %IWL_FW_INI_REGION_PCI_IOSF_CONFIG * %IWL_FW_INI_REGION_DBGI_SRAM, %FW_TLV_DEBUG_REGION_TYPE_DBGI_SRAM, * %IWL_FW_INI_REGION_PERIPHERY_SNPS_DPHYIP, * @dev_addr_range: device address range configuration. Used by * %IWL_FW_INI_REGION_PERIPHERY_MAC_RANGE and * %IWL_FW_INI_REGION_PERIPHERY_PHY_RANGE * @fifos: fifos configuration. Used by %IWL_FW_INI_REGION_TXF and * %IWL_FW_INI_REGION_RXF * @err_table: error table configuration. Used by * %IWL_FW_INI_REGION_LMAC_ERROR_TABLE and * %IWL_FW_INI_REGION_UMAC_ERROR_TABLE * @internal_buffer: internal monitor buffer configuration. Used by * %IWL_FW_INI_REGION_INTERNAL_BUFFER * @special_mem: special device memory region, used by * %IWL_FW_INI_REGION_SPECIAL_DEVICE_MEMORY * @dram_alloc_id: dram allocation id. One of &enum iwl_fw_ini_allocation_id. * Used by %IWL_FW_INI_REGION_DRAM_BUFFER * @tlv_mask: tlv collection mask. Used by %IWL_FW_INI_REGION_TLV * @addrs: array of addresses attached to the end of the region tlv */ struct iwl_fw_ini_region_tlv { … } __packed; /* FW_TLV_DEBUG_REGION_API_S_VER_1 */ /** * struct iwl_fw_ini_debug_info_tlv * * debug configuration name for a specific image * * @hdr: debug header * @image_type: image type * @debug_cfg_name: debug configuration name */ struct iwl_fw_ini_debug_info_tlv { … } __packed; /* FW_TLV_DEBUG_INFO_API_S_VER_1 */ /** * struct iwl_fw_ini_allocation_tlv - Allocates DRAM buffers * * @hdr: debug header * @alloc_id: allocation id. One of &enum iwl_fw_ini_allocation_id * @buf_location: buffer location. One of &enum iwl_fw_ini_buffer_location * @req_size: requested buffer size * @max_frags_num: maximum number of fragments * @min_size: minimum buffer size */ struct iwl_fw_ini_allocation_tlv { … } __packed; /* FW_TLV_DEBUG_BUFFER_ALLOCATION_API_S_VER_1 */ /** * struct iwl_fw_ini_trigger_tlv - trigger TLV * * Trigger that upon firing, determines what regions to collect * * @hdr: debug header * @time_point: time point. One of &enum iwl_fw_ini_time_point * @trigger_reason: trigger reason * @apply_policy: uses &enum iwl_fw_ini_trigger_apply_policy * @dump_delay: delay from trigger fire to dump, in usec * @occurrences: max trigger fire occurrences allowed * @reserved: unused * @ignore_consec: ignore consecutive triggers, in usec * @reset_fw: if non zero, will reset and reload the FW * @multi_dut: initiate debug dump data on several DUTs * @regions_mask: mask of regions to collect * @data: trigger data */ struct iwl_fw_ini_trigger_tlv { … } __packed; /* FW_TLV_DEBUG_TRIGGER_API_S_VER_1 */ /** * struct iwl_fw_ini_hcmd_tlv - Generic Host command pass through TLV * * @hdr: debug header * @time_point: time point. One of &enum iwl_fw_ini_time_point * @period_msec: interval at which the hcmd will be sent to the FW. * Measured in msec (0 = one time command) * @hcmd: a variable length host-command to be sent to apply the configuration */ struct iwl_fw_ini_hcmd_tlv { … } __packed; /* FW_TLV_DEBUG_HCMD_API_S_VER_1 */ /** * struct iwl_fw_ini_addr_val - Address and value to set it to * * @address: the base address * @value: value to set at address */ struct iwl_fw_ini_addr_val { … } __packed; /* FW_TLV_DEBUG_ADDR_VALUE_VER_1 */ /** * struct iwl_fw_ini_conf_set_tlv - configuration TLV to set register/memory. * * @hdr: debug header * @time_point: time point to apply config. One of &enum iwl_fw_ini_time_point * @set_type: write access type preset token for time point. * one of &enum iwl_fw_ini_config_set_type * @addr_offset: the offset to add to any item in address[0] field * @addr_val: address value pair */ struct iwl_fw_ini_conf_set_tlv { … } __packed; /* FW_TLV_DEBUG_CONFIG_SET_API_S_VER_1 */ /** * enum iwl_fw_ini_config_set_type * * @IWL_FW_INI_CONFIG_SET_TYPE_INVALID: invalid config set * @IWL_FW_INI_CONFIG_SET_TYPE_DEVICE_PERIPHERY_MAC: for PERIPHERY MAC configuration * @IWL_FW_INI_CONFIG_SET_TYPE_DEVICE_PERIPHERY_PHY: for PERIPHERY PHY configuration * @IWL_FW_INI_CONFIG_SET_TYPE_DEVICE_PERIPHERY_AUX: for PERIPHERY AUX configuration * @IWL_FW_INI_CONFIG_SET_TYPE_DEVICE_MEMORY: for DEVICE MEMORY configuration * @IWL_FW_INI_CONFIG_SET_TYPE_CSR: for CSR configuration * @IWL_FW_INI_CONFIG_SET_TYPE_DBGC_DRAM_ADDR: for DBGC_DRAM_ADDR configuration * @IWL_FW_INI_CONFIG_SET_TYPE_PERIPH_SCRATCH_HWM: for PERIPH SCRATCH HWM configuration * @IWL_FW_INI_CONFIG_SET_TYPE_MAX_NUM: max number of configuration supported */ enum iwl_fw_ini_config_set_type { … } __packed; /** * enum iwl_fw_ini_allocation_id * * @IWL_FW_INI_ALLOCATION_INVALID: invalid * @IWL_FW_INI_ALLOCATION_ID_DBGC1: allocation meant for DBGC1 configuration * @IWL_FW_INI_ALLOCATION_ID_DBGC2: allocation meant for DBGC2 configuration * @IWL_FW_INI_ALLOCATION_ID_DBGC3: allocation meant for DBGC3 configuration * @IWL_FW_INI_ALLOCATION_ID_DBGC4: allocation meant for DBGC4 configuration * @IWL_FW_INI_ALLOCATION_NUM: number of allocation ids */ enum iwl_fw_ini_allocation_id { … }; /* FW_DEBUG_TLV_ALLOCATION_ID_E_VER_1 */ /** * enum iwl_fw_ini_buffer_location * * @IWL_FW_INI_LOCATION_INVALID: invalid * @IWL_FW_INI_LOCATION_SRAM_PATH: SRAM location * @IWL_FW_INI_LOCATION_DRAM_PATH: DRAM location * @IWL_FW_INI_LOCATION_NPK_PATH: NPK location * @IWL_FW_INI_LOCATION_NUM: number of valid locations */ enum iwl_fw_ini_buffer_location { … }; /* FW_DEBUG_TLV_BUFFER_LOCATION_E_VER_1 */ /** * enum iwl_fw_ini_region_type * * @IWL_FW_INI_REGION_INVALID: invalid * @IWL_FW_INI_REGION_TLV: uCode and debug TLVs * @IWL_FW_INI_REGION_INTERNAL_BUFFER: monitor SMEM buffer * @IWL_FW_INI_REGION_DRAM_BUFFER: monitor DRAM buffer * @IWL_FW_INI_REGION_TXF: TX fifos * @IWL_FW_INI_REGION_RXF: RX fifo * @IWL_FW_INI_REGION_LMAC_ERROR_TABLE: lmac error table * @IWL_FW_INI_REGION_UMAC_ERROR_TABLE: umac error table * @IWL_FW_INI_REGION_RSP_OR_NOTIF: FW response or notification data * @IWL_FW_INI_REGION_DEVICE_MEMORY: device internal memory * @IWL_FW_INI_REGION_PERIPHERY_MAC: periphery registers of MAC * @IWL_FW_INI_REGION_PERIPHERY_PHY: periphery registers of PHY * @IWL_FW_INI_REGION_PERIPHERY_AUX: periphery registers of AUX * @IWL_FW_INI_REGION_PAGING: paging memory * @IWL_FW_INI_REGION_CSR: CSR registers * @IWL_FW_INI_REGION_DRAM_IMR: IMR memory * @IWL_FW_INI_REGION_PCI_IOSF_CONFIG: PCI/IOSF config * @IWL_FW_INI_REGION_SPECIAL_DEVICE_MEMORY: special device memory * @IWL_FW_INI_REGION_DBGI_SRAM: periphery registers of DBGI SRAM * @IWL_FW_INI_REGION_PERIPHERY_MAC_RANGE: a range of periphery registers of MAC * @IWL_FW_INI_REGION_PERIPHERY_PHY_RANGE: a range of periphery registers of PHY * @IWL_FW_INI_REGION_PERIPHERY_SNPS_DPHYIP: periphery registers of SNPS DPHYIP * @IWL_FW_INI_REGION_NUM: number of region types */ enum iwl_fw_ini_region_type { … }; /* FW_TLV_DEBUG_REGION_TYPE_API_E */ enum iwl_fw_ini_region_device_memory_subtype { … }; /* FW_TLV_DEBUG_REGION_DEVICE_MEMORY_SUBTYPE_API_E */ /** * enum iwl_fw_ini_time_point * * Hard coded time points in which the driver can send hcmd or perform dump * collection * * @IWL_FW_INI_TIME_POINT_INVALID: invalid timepoint * @IWL_FW_INI_TIME_POINT_EARLY: pre loading the FW * @IWL_FW_INI_TIME_POINT_AFTER_ALIVE: first cmd from host after alive notif * @IWL_FW_INI_TIME_POINT_POST_INIT: last cmd in series of init sequence * @IWL_FW_INI_TIME_POINT_FW_ASSERT: FW assert * @IWL_FW_INI_TIME_POINT_FW_HW_ERROR: FW HW error * @IWL_FW_INI_TIME_POINT_FW_TFD_Q_HANG: TFD queue hang * @IWL_FW_INI_TIME_POINT_FW_DHC_NOTIFICATION: DHC cmd response and notif * @IWL_FW_INI_TIME_POINT_FW_RSP_OR_NOTIF: FW response or notification. * data field holds id and group * @IWL_FW_INI_TIME_POINT_USER_TRIGGER: user trigger time point * @IWL_FW_INI_TIME_POINT_PERIODIC: periodic timepoint that fires in constant * intervals. data field holds the interval time in msec * @IWL_FW_INI_TIME_POINT_RESERVED: reserved * @IWL_FW_INI_TIME_POINT_HOST_ASSERT: Unused * @IWL_FW_INI_TIME_POINT_HOST_ALIVE_TIMEOUT: alive timeout * @IWL_FW_INI_TIME_POINT_HOST_DEVICE_ENABLE: device enable * @IWL_FW_INI_TIME_POINT_HOST_DEVICE_DISABLE: device disable * @IWL_FW_INI_TIME_POINT_HOST_D3_START: D3 start * @IWL_FW_INI_TIME_POINT_HOST_D3_END: D3 end * @IWL_FW_INI_TIME_POINT_MISSED_BEACONS: missed beacons * @IWL_FW_INI_TIME_POINT_ASSOC_FAILED: association failure * @IWL_FW_INI_TIME_POINT_TX_FAILED: Tx frame failed * @IWL_FW_INI_TIME_POINT_TX_WFD_ACTION_FRAME_FAILED: wifi direct action * frame failed * @IWL_FW_INI_TIME_POINT_TX_LATENCY_THRESHOLD: Tx latency threshold * @IWL_FW_INI_TIME_POINT_HANG_OCCURRED: hang occurred * @IWL_FW_INI_TIME_POINT_EAPOL_FAILED: EAPOL failed * @IWL_FW_INI_TIME_POINT_FAKE_TX: fake Tx * @IWL_FW_INI_TIME_POINT_DEASSOC: de association * @IWL_FW_INI_TIME_POINT_PRESET_OVERRIDE_EXT_REQ: request to override preset * @IWL_FW_INI_TIME_POINT_PRESET_OVERRIDE_START: start handling override preset * request * @IWL_FW_INI_TIME_SCAN_FAILURE: failed scan channel list * @IWL_FW_INI_TIME_POINT_NUM: number of time points */ enum iwl_fw_ini_time_point { … }; /* FW_TLV_DEBUG_TIME_POINT_API_E */ /** * enum iwl_fw_ini_trigger_apply_policy - Determines how to apply triggers * * @IWL_FW_INI_APPLY_POLICY_MATCH_TIME_POINT: match by time point * @IWL_FW_INI_APPLY_POLICY_MATCH_DATA: match by trigger data * @IWL_FW_INI_APPLY_POLICY_OVERRIDE_REGIONS: override regions mask. * Append otherwise * @IWL_FW_INI_APPLY_POLICY_OVERRIDE_CFG: override trigger configuration * @IWL_FW_INI_APPLY_POLICY_OVERRIDE_DATA: override trigger data. * Append otherwise * @IWL_FW_INI_APPLY_POLICY_DUMP_COMPLETE_CMD: send cmd once dump collected */ enum iwl_fw_ini_trigger_apply_policy { … }; /** * enum iwl_fw_ini_trigger_reset_fw_policy - Determines how to handle reset * * @IWL_FW_INI_RESET_FW_MODE_NOTHING: do not stop FW and reload (default) * @IWL_FW_INI_RESET_FW_MODE_STOP_FW_ONLY: stop FW without reload FW * @IWL_FW_INI_RESET_FW_MODE_STOP_AND_RELOAD_FW: stop FW with reload FW */ enum iwl_fw_ini_trigger_reset_fw_policy { … }; /** * enum iwl_fw_ini_dump_policy - Determines how to handle dump based on enabled flags * * @IWL_FW_INI_DEBUG_DUMP_POLICY_NO_LIMIT: OS has no limit of dump size * @IWL_FW_INI_DEBUG_DUMP_POLICY_MAX_LIMIT_600KB: mini dump only 600KB region dump * @IWL_FW_IWL_DEBUG_DUMP_POLICY_MAX_LIMIT_5MB: mini dump 5MB size dump */ enum iwl_fw_ini_dump_policy { … }; /** * enum iwl_fw_ini_dump_type - Determines dump type based on size defined by FW. * * @IWL_FW_INI_DUMP_BRIEF : only dump the most important regions * @IWL_FW_INI_DUMP_MEDIUM: dump more regions than "brief", but not all regions * @IWL_FW_INI_DUMP_VERBOSE : dump all regions */ enum iwl_fw_ini_dump_type { … }; #endif
Codebase Browser
linux