1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2005-2014, 2018-2024 Intel Corporation 4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016 Intel Deutschland GmbH 6 */ 7 #ifndef __iwl_fw_img_h__ 8 #define __iwl_fw_img_h__ 9 #include <linux/types.h> 10 11 #include "api/dbg-tlv.h" 12 #include "api/nvm-reg.h" 13 14 #include "file.h" 15 #include "error-dump.h" 16 17 /** 18 * enum iwl_ucode_type - type of ucode 19 * 20 * @IWL_UCODE_REGULAR: Normal runtime ucode 21 * @IWL_UCODE_INIT: Initial ucode 22 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode 23 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image 24 * @IWL_UCODE_TYPE_MAX: (internal value) 25 */ 26 enum iwl_ucode_type { 27 IWL_UCODE_REGULAR, 28 IWL_UCODE_INIT, 29 IWL_UCODE_WOWLAN, 30 IWL_UCODE_REGULAR_USNIFFER, 31 IWL_UCODE_TYPE_MAX, 32 }; 33 34 /* 35 * enumeration of ucode section. 36 * This enumeration is used directly for older firmware (before 16.0). 37 * For new firmware, there can be up to 4 sections (see below) but the 38 * first one packaged into the firmware file is the DATA section and 39 * some debugging code accesses that. 40 */ 41 enum iwl_ucode_sec { 42 IWL_UCODE_SECTION_DATA, 43 IWL_UCODE_SECTION_INST, 44 }; 45 46 struct iwl_ucode_capabilities { 47 u32 max_probe_length; 48 u32 n_scan_channels; 49 u32 standard_phy_calibration_size; 50 u32 flags; 51 u32 error_log_addr; 52 u32 error_log_size; 53 u32 num_stations; 54 u32 num_links; 55 u32 num_beacons; 56 DECLARE_BITMAP(_api, NUM_IWL_UCODE_TLV_API); 57 DECLARE_BITMAP(_capa, NUM_IWL_UCODE_TLV_CAPA); 58 59 const struct iwl_fw_cmd_version *cmd_versions; 60 u32 n_cmd_versions; 61 62 const struct iwl_fw_cmd_bios_table *cmd_bios_tables; 63 u32 n_cmd_bios_tables; 64 }; 65 66 static inline bool 67 fw_has_api(const struct iwl_ucode_capabilities *capabilities, 68 iwl_ucode_tlv_api_t api) 69 { 70 return test_bit((__force long)api, capabilities->_api); 71 } 72 73 static inline bool 74 fw_has_capa(const struct iwl_ucode_capabilities *capabilities, 75 iwl_ucode_tlv_capa_t capa) 76 { 77 return test_bit((__force long)capa, capabilities->_capa); 78 } 79 80 /* one for each uCode image (inst/data, init/runtime/wowlan) */ 81 struct fw_desc { 82 const void *data; /* vmalloc'ed data */ 83 u32 len; /* size in bytes */ 84 u32 offset; /* offset in the device */ 85 }; 86 87 struct fw_img { 88 struct fw_desc *sec; 89 int num_sec; 90 bool is_dual_cpus; 91 u32 paging_mem_size; 92 }; 93 94 /* 95 * Block paging calculations 96 */ 97 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */ 98 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */ 99 #define PAGE_PER_GROUP_2_EXP_SIZE 3 100 /* 8 pages per group */ 101 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE) 102 /* don't change, support only 32KB size */ 103 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE) 104 /* 32K == 2^15 */ 105 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE) 106 107 /* 108 * Image paging calculations 109 */ 110 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5 111 /* 2^5 == 32 blocks per image */ 112 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE) 113 /* maximum image size 1024KB */ 114 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE) 115 116 /* Virtual address signature */ 117 #define PAGING_ADDR_SIG 0xAA000000 118 119 #define PAGING_CMD_IS_SECURED BIT(9) 120 #define PAGING_CMD_IS_ENABLED BIT(8) 121 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0 122 #define PAGING_TLV_SECURE_MASK 1 123 124 /* FW MSB Mask for regions/cache_control */ 125 #define FW_ADDR_CACHE_CONTROL 0xC0000000UL 126 127 /** 128 * struct iwl_fw_paging - FW paging descriptor 129 * @fw_paging_phys: page phy pointer 130 * @fw_paging_block: pointer to the allocated block 131 * @fw_paging_size: page size 132 * @fw_offs: offset in the device 133 */ 134 struct iwl_fw_paging { 135 dma_addr_t fw_paging_phys; 136 struct page *fw_paging_block; 137 u32 fw_paging_size; 138 u32 fw_offs; 139 }; 140 141 /** 142 * enum iwl_fw_type - iwlwifi firmware type 143 * @IWL_FW_DVM: DVM firmware 144 * @IWL_FW_MVM: MVM firmware 145 */ 146 enum iwl_fw_type { 147 IWL_FW_DVM, 148 IWL_FW_MVM, 149 }; 150 151 /** 152 * struct iwl_fw_dbg - debug data 153 * 154 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM) 155 * @n_dest_reg: num of reg_ops in dest_tlv 156 * @conf_tlv: array of pointers to configuration HCMDs 157 * @trigger_tlv: array of pointers to triggers TLVs 158 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries 159 * @mem_tlv: Runtime addresses to dump 160 * @n_mem_tlv: number of runtime addresses 161 * @dump_mask: bitmask of dump regions 162 */ 163 struct iwl_fw_dbg { 164 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 165 u8 n_dest_reg; 166 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 167 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX]; 168 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX]; 169 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv; 170 size_t n_mem_tlv; 171 u32 dump_mask; 172 }; 173 174 struct iwl_dump_exclude { 175 u32 addr, size; 176 }; 177 178 /** 179 * struct iwl_fw - variables associated with the firmware 180 * 181 * @ucode_ver: ucode version from the ucode file 182 * @fw_version: firmware version string 183 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 184 * @iml_len: length of the image loader image 185 * @iml: image loader fw image 186 * @ucode_capa: capabilities parsed from the ucode file. 187 * @enhance_sensitivity_table: device can do enhanced sensitivity. 188 * @init_evtlog_ptr: event log offset for init ucode. 189 * @init_evtlog_size: event log size for init ucode. 190 * @init_errlog_ptr: error log offset for init ucode. 191 * @inst_evtlog_ptr: event log offset for runtime ucode. 192 * @inst_evtlog_size: event log size for runtime ucode. 193 * @inst_errlog_ptr: error log offset for runtime ucode. 194 * @type: firmware type (&enum iwl_fw_type) 195 * @human_readable: human readable version 196 * we get the ALIVE from the uCode 197 * @phy_integration_ver: PHY integration version string 198 * @phy_integration_ver_len: length of @phy_integration_ver 199 * @dump_excl: image dump exclusion areas for RT image 200 * @dump_excl_wowlan: image dump exclusion areas for WoWLAN image 201 * @pnvm_data: PNVM data embedded in the .ucode file, if any 202 * @pnvm_size: size of the embedded PNVM data 203 * @dbg: debug data, see &struct iwl_fw_dbg 204 * @default_calib: default calibration data 205 * @phy_config: PHY configuration flags 206 * @valid_rx_ant: valid RX antenna bitmap 207 * @valid_tx_ant: valid TX antenna bitmap 208 */ 209 struct iwl_fw { 210 u32 ucode_ver; 211 212 char fw_version[128]; 213 214 /* ucode images */ 215 struct fw_img img[IWL_UCODE_TYPE_MAX]; 216 size_t iml_len; 217 u8 *iml; 218 219 struct iwl_ucode_capabilities ucode_capa; 220 bool enhance_sensitivity_table; 221 222 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 223 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 224 225 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 226 u32 phy_config; 227 u8 valid_tx_ant; 228 u8 valid_rx_ant; 229 230 enum iwl_fw_type type; 231 232 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 233 234 struct iwl_fw_dbg dbg; 235 236 u8 *phy_integration_ver; 237 u32 phy_integration_ver_len; 238 239 struct iwl_dump_exclude dump_excl[2], dump_excl_wowlan[2]; 240 241 const void *pnvm_data; 242 u32 pnvm_size; 243 }; 244 245 static inline const char *get_fw_dbg_mode_string(int mode) 246 { 247 switch (mode) { 248 case SMEM_MODE: 249 return "SMEM"; 250 case EXTERNAL_MODE: 251 return "EXTERNAL_DRAM"; 252 case MARBH_MODE: 253 return "MARBH"; 254 case MIPI_MODE: 255 return "MIPI"; 256 default: 257 return "UNKNOWN"; 258 } 259 } 260 261 static inline bool 262 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id) 263 { 264 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id]; 265 266 if (!conf_tlv) 267 return false; 268 269 return conf_tlv->usniffer; 270 } 271 272 static inline const struct fw_img * 273 iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type) 274 { 275 if (ucode_type >= IWL_UCODE_TYPE_MAX) 276 return NULL; 277 278 return &fw->img[ucode_type]; 279 } 280 281 u8 iwl_fw_lookup_cmd_bios_supported_revision(const struct iwl_fw *fw, 282 enum bios_source table_source, 283 u32 cmd_id, u8 def); 284 285 u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u32 cmd_id, u8 def); 286 287 u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def); 288 const char *iwl_fw_lookup_assert_desc(u32 num); 289 290 #define FW_SYSASSERT_CPU_MASK 0xf0000000 291 #define FW_SYSASSERT_PNVM_MISSING 0x0010070d 292 293 #endif /* __iwl_fw_img_h__ */ 294