/* 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 Intel Deutschland GmbH */ #ifndef __iwl_fw_img_h__ #define __iwl_fw_img_h__ #include <linux/types.h> #include "api/dbg-tlv.h" #include "file.h" #include "error-dump.h" /** * enum iwl_ucode_type * * The type of ucode. * * @IWL_UCODE_REGULAR: Normal runtime ucode * @IWL_UCODE_INIT: Initial ucode * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image */ enum iwl_ucode_type { … }; /* * enumeration of ucode section. * This enumeration is used directly for older firmware (before 16.0). * For new firmware, there can be up to 4 sections (see below) but the * first one packaged into the firmware file is the DATA section and * some debugging code accesses that. */ enum iwl_ucode_sec { … }; struct iwl_ucode_capabilities { … }; static inline bool fw_has_api(const struct iwl_ucode_capabilities *capabilities, iwl_ucode_tlv_api_t api) { … } static inline bool fw_has_capa(const struct iwl_ucode_capabilities *capabilities, iwl_ucode_tlv_capa_t capa) { … } /* one for each uCode image (inst/data, init/runtime/wowlan) */ struct fw_desc { … }; struct fw_img { … }; /* * Block paging calculations */ #define PAGE_2_EXP_SIZE … #define FW_PAGING_SIZE … #define PAGE_PER_GROUP_2_EXP_SIZE … /* 8 pages per group */ #define NUM_OF_PAGE_PER_GROUP … /* don't change, support only 32KB size */ #define PAGING_BLOCK_SIZE … /* 32K == 2^15 */ #define BLOCK_2_EXP_SIZE … /* * Image paging calculations */ #define BLOCK_PER_IMAGE_2_EXP_SIZE … /* 2^5 == 32 blocks per image */ #define NUM_OF_BLOCK_PER_IMAGE … /* maximum image size 1024KB */ #define MAX_PAGING_IMAGE_SIZE … /* Virtual address signature */ #define PAGING_ADDR_SIG … #define PAGING_CMD_IS_SECURED … #define PAGING_CMD_IS_ENABLED … #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS … #define PAGING_TLV_SECURE_MASK … /* FW MSB Mask for regions/cache_control */ #define FW_ADDR_CACHE_CONTROL … /** * struct iwl_fw_paging * @fw_paging_phys: page phy pointer * @fw_paging_block: pointer to the allocated block * @fw_paging_size: page size * @fw_offs: offset in the device */ struct iwl_fw_paging { … }; /** * enum iwl_fw_type - iwlwifi firmware type * @IWL_FW_DVM: DVM firmware * @IWL_FW_MVM: MVM firmware */ enum iwl_fw_type { … }; /** * struct iwl_fw_dbg - debug data * * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM) * @n_dest_reg: num of reg_ops in dest_tlv * @conf_tlv: array of pointers to configuration HCMDs * @trigger_tlv: array of pointers to triggers TLVs * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries * @mem_tlv: Runtime addresses to dump * @n_mem_tlv: number of runtime addresses * @dump_mask: bitmask of dump regions */ struct iwl_fw_dbg { … }; struct iwl_dump_exclude { … }; /** * struct iwl_fw - variables associated with the firmware * * @ucode_ver: ucode version from the ucode file * @fw_version: firmware version string * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. * @iml_len: length of the image loader image * @iml: image loader fw image * @ucode_capa: capabilities parsed from the ucode file. * @enhance_sensitivity_table: device can do enhanced sensitivity. * @init_evtlog_ptr: event log offset for init ucode. * @init_evtlog_size: event log size for init ucode. * @init_errlog_ptr: error log offset for init ucode. * @inst_evtlog_ptr: event log offset for runtime ucode. * @inst_evtlog_size: event log size for runtime ucode. * @inst_errlog_ptr: error log offset for runtime ucode. * @type: firmware type (&enum iwl_fw_type) * @human_readable: human readable version * we get the ALIVE from the uCode * @phy_integration_ver: PHY integration version string * @phy_integration_ver_len: length of @phy_integration_ver * @dump_excl: image dump exclusion areas for RT image * @dump_excl_wowlan: image dump exclusion areas for WoWLAN image */ struct iwl_fw { … }; static inline const char *get_fw_dbg_mode_string(int mode) { … } static inline bool iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id) { … } static inline const struct fw_img * iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type) { … } u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u32 cmd_id, u8 def); u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def); const char *iwl_fw_lookup_assert_desc(u32 num); #define FW_SYSASSERT_CPU_MASK … #define FW_SYSASSERT_PNVM_MISSING … #endif /* __iwl_fw_img_h__ */
Codebase Browser
linux