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
13 #include "file.h"
14 #include "error-dump.h"
15
16 /**
17 * enum iwl_ucode_type
18 *
19 * The type of ucode.
20 *
21 * @IWL_UCODE_REGULAR: Normal runtime ucode
22 * @IWL_UCODE_INIT: Initial ucode
23 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
24 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
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
63 static inline bool
fw_has_api(const struct iwl_ucode_capabilities * capabilities,iwl_ucode_tlv_api_t api)64 fw_has_api(const struct iwl_ucode_capabilities *capabilities,
65 iwl_ucode_tlv_api_t api)
66 {
67 return test_bit((__force long)api, capabilities->_api);
68 }
69
70 static inline bool
fw_has_capa(const struct iwl_ucode_capabilities * capabilities,iwl_ucode_tlv_capa_t capa)71 fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
72 iwl_ucode_tlv_capa_t capa)
73 {
74 return test_bit((__force long)capa, capabilities->_capa);
75 }
76
77 /* one for each uCode image (inst/data, init/runtime/wowlan) */
78 struct fw_desc {
79 const void *data; /* vmalloc'ed data */
80 u32 len; /* size in bytes */
81 u32 offset; /* offset in the device */
82 };
83
84 struct fw_img {
85 struct fw_desc *sec;
86 int num_sec;
87 bool is_dual_cpus;
88 u32 paging_mem_size;
89 };
90
91 /*
92 * Block paging calculations
93 */
94 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
95 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
96 #define PAGE_PER_GROUP_2_EXP_SIZE 3
97 /* 8 pages per group */
98 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
99 /* don't change, support only 32KB size */
100 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
101 /* 32K == 2^15 */
102 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
103
104 /*
105 * Image paging calculations
106 */
107 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5
108 /* 2^5 == 32 blocks per image */
109 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
110 /* maximum image size 1024KB */
111 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
112
113 /* Virtual address signature */
114 #define PAGING_ADDR_SIG 0xAA000000
115
116 #define PAGING_CMD_IS_SECURED BIT(9)
117 #define PAGING_CMD_IS_ENABLED BIT(8)
118 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
119 #define PAGING_TLV_SECURE_MASK 1
120
121 /* FW MSB Mask for regions/cache_control */
122 #define FW_ADDR_CACHE_CONTROL 0xC0000000UL
123
124 /**
125 * struct iwl_fw_paging
126 * @fw_paging_phys: page phy pointer
127 * @fw_paging_block: pointer to the allocated block
128 * @fw_paging_size: page size
129 * @fw_offs: offset in the device
130 */
131 struct iwl_fw_paging {
132 dma_addr_t fw_paging_phys;
133 struct page *fw_paging_block;
134 u32 fw_paging_size;
135 u32 fw_offs;
136 };
137
138 /**
139 * enum iwl_fw_type - iwlwifi firmware type
140 * @IWL_FW_DVM: DVM firmware
141 * @IWL_FW_MVM: MVM firmware
142 */
143 enum iwl_fw_type {
144 IWL_FW_DVM,
145 IWL_FW_MVM,
146 };
147
148 /**
149 * struct iwl_fw_dbg - debug data
150 *
151 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM)
152 * @n_dest_reg: num of reg_ops in dest_tlv
153 * @conf_tlv: array of pointers to configuration HCMDs
154 * @trigger_tlv: array of pointers to triggers TLVs
155 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
156 * @mem_tlv: Runtime addresses to dump
157 * @n_mem_tlv: number of runtime addresses
158 * @dump_mask: bitmask of dump regions
159 */
160 struct iwl_fw_dbg {
161 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv;
162 u8 n_dest_reg;
163 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX];
164 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX];
165 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX];
166 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv;
167 size_t n_mem_tlv;
168 u32 dump_mask;
169 };
170
171 struct iwl_dump_exclude {
172 u32 addr, size;
173 };
174
175 /**
176 * struct iwl_fw - variables associated with the firmware
177 *
178 * @ucode_ver: ucode version from the ucode file
179 * @fw_version: firmware version string
180 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
181 * @iml_len: length of the image loader image
182 * @iml: image loader fw image
183 * @ucode_capa: capabilities parsed from the ucode file.
184 * @enhance_sensitivity_table: device can do enhanced sensitivity.
185 * @init_evtlog_ptr: event log offset for init ucode.
186 * @init_evtlog_size: event log size for init ucode.
187 * @init_errlog_ptr: error log offset for init ucode.
188 * @inst_evtlog_ptr: event log offset for runtime ucode.
189 * @inst_evtlog_size: event log size for runtime ucode.
190 * @inst_errlog_ptr: error log offset for runtime ucode.
191 * @type: firmware type (&enum iwl_fw_type)
192 * @human_readable: human readable version
193 * we get the ALIVE from the uCode
194 * @phy_integration_ver: PHY integration version string
195 * @phy_integration_ver_len: length of @phy_integration_ver
196 * @dump_excl: image dump exclusion areas for RT image
197 * @dump_excl_wowlan: image dump exclusion areas for WoWLAN image
198 * @pnvm_data: PNVM data embedded in the .ucode file, if any
199 * @pnvm_size: size of the embedded PNVM data
200 */
201 struct iwl_fw {
202 u32 ucode_ver;
203
204 char fw_version[128];
205
206 /* ucode images */
207 struct fw_img img[IWL_UCODE_TYPE_MAX];
208 size_t iml_len;
209 u8 *iml;
210
211 struct iwl_ucode_capabilities ucode_capa;
212 bool enhance_sensitivity_table;
213
214 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
215 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
216
217 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
218 u32 phy_config;
219 u8 valid_tx_ant;
220 u8 valid_rx_ant;
221
222 enum iwl_fw_type type;
223
224 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
225
226 struct iwl_fw_dbg dbg;
227
228 u8 *phy_integration_ver;
229 u32 phy_integration_ver_len;
230
231 struct iwl_dump_exclude dump_excl[2], dump_excl_wowlan[2];
232
233 const void *pnvm_data;
234 u32 pnvm_size;
235 };
236
get_fw_dbg_mode_string(int mode)237 static inline const char *get_fw_dbg_mode_string(int mode)
238 {
239 switch (mode) {
240 case SMEM_MODE:
241 return "SMEM";
242 case EXTERNAL_MODE:
243 return "EXTERNAL_DRAM";
244 case MARBH_MODE:
245 return "MARBH";
246 case MIPI_MODE:
247 return "MIPI";
248 default:
249 return "UNKNOWN";
250 }
251 }
252
253 static inline bool
iwl_fw_dbg_conf_usniffer(const struct iwl_fw * fw,u8 id)254 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
255 {
256 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id];
257
258 if (!conf_tlv)
259 return false;
260
261 return conf_tlv->usniffer;
262 }
263
264 static inline const struct fw_img *
iwl_get_ucode_image(const struct iwl_fw * fw,enum iwl_ucode_type ucode_type)265 iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type)
266 {
267 if (ucode_type >= IWL_UCODE_TYPE_MAX)
268 return NULL;
269
270 return &fw->img[ucode_type];
271 }
272
273 u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u32 cmd_id, u8 def);
274
275 u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
276 const char *iwl_fw_lookup_assert_desc(u32 num);
277
278 #define FW_SYSASSERT_CPU_MASK 0xf0000000
279 #define FW_SYSASSERT_PNVM_MISSING 0x0010070d
280
281 #endif /* __iwl_fw_img_h__ */
282