1
2
3
4
5
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
18
19
20
21
22
23
24
25
26enum 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
36
37
38
39
40
41enum iwl_ucode_sec {
42 IWL_UCODE_SECTION_DATA,
43 IWL_UCODE_SECTION_INST,
44};
45
46struct 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 unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
55 unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
56
57 const struct iwl_fw_cmd_version *cmd_versions;
58 u32 n_cmd_versions;
59};
60
61static inline bool
62fw_has_api(const struct iwl_ucode_capabilities *capabilities,
63 iwl_ucode_tlv_api_t api)
64{
65 return test_bit((__force long)api, capabilities->_api);
66}
67
68static inline bool
69fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
70 iwl_ucode_tlv_capa_t capa)
71{
72 return test_bit((__force long)capa, capabilities->_capa);
73}
74
75
76struct fw_desc {
77 const void *data;
78 u32 len;
79 u32 offset;
80};
81
82struct fw_img {
83 struct fw_desc *sec;
84 int num_sec;
85 bool is_dual_cpus;
86 u32 paging_mem_size;
87};
88
89
90
91
92#define PAGE_2_EXP_SIZE 12
93#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE)
94#define PAGE_PER_GROUP_2_EXP_SIZE 3
95
96#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
97
98#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
99
100#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
101
102
103
104
105#define BLOCK_PER_IMAGE_2_EXP_SIZE 5
106
107#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
108
109#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
110
111
112#define PAGING_ADDR_SIG 0xAA000000
113
114#define PAGING_CMD_IS_SECURED BIT(9)
115#define PAGING_CMD_IS_ENABLED BIT(8)
116#define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
117#define PAGING_TLV_SECURE_MASK 1
118
119
120#define FW_ADDR_CACHE_CONTROL 0xC0000000UL
121
122
123
124
125
126
127
128
129struct iwl_fw_paging {
130 dma_addr_t fw_paging_phys;
131 struct page *fw_paging_block;
132 u32 fw_paging_size;
133 u32 fw_offs;
134};
135
136
137
138
139
140
141struct iwl_fw_cscheme_list {
142 u8 size;
143 struct iwl_fw_cipher_scheme cs[];
144} __packed;
145
146
147
148
149
150
151enum iwl_fw_type {
152 IWL_FW_DVM,
153 IWL_FW_MVM,
154};
155
156
157
158
159
160
161
162
163
164
165
166
167
168struct iwl_fw_dbg {
169 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv;
170 u8 n_dest_reg;
171 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX];
172 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX];
173 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX];
174 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv;
175 size_t n_mem_tlv;
176 u32 dump_mask;
177};
178
179struct iwl_dump_exclude {
180 u32 addr, size;
181};
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208struct iwl_fw {
209 u32 ucode_ver;
210
211 char fw_version[64];
212
213
214 struct fw_img img[IWL_UCODE_TYPE_MAX];
215 size_t iml_len;
216 u8 *iml;
217
218 struct iwl_ucode_capabilities ucode_capa;
219 bool enhance_sensitivity_table;
220
221 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
222 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
223
224 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
225 u32 phy_config;
226 u8 valid_tx_ant;
227 u8 valid_rx_ant;
228
229 enum iwl_fw_type type;
230
231 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS];
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
242static inline const char *get_fw_dbg_mode_string(int mode)
243{
244 switch (mode) {
245 case SMEM_MODE:
246 return "SMEM";
247 case EXTERNAL_MODE:
248 return "EXTERNAL_DRAM";
249 case MARBH_MODE:
250 return "MARBH";
251 case MIPI_MODE:
252 return "MIPI";
253 default:
254 return "UNKNOWN";
255 }
256}
257
258static inline bool
259iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
260{
261 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id];
262
263 if (!conf_tlv)
264 return false;
265
266 return conf_tlv->usniffer;
267}
268
269static inline const struct fw_img *
270iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type)
271{
272 if (ucode_type >= IWL_UCODE_TYPE_MAX)
273 return NULL;
274
275 return &fw->img[ucode_type];
276}
277
278u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
279
280u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
281const char *iwl_fw_lookup_assert_desc(u32 num);
282#endif
283