1 /******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
9 * Copyright(c) 2016 Intel Deutschland GmbH
10 * Copyright(c) 2008 - 2014, 2018 - 2020 Intel Corporation
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * The full GNU General Public License is included in this distribution
22 * in the file called COPYING.
23 *
24 * Contact Information:
25 * Intel Linux Wireless <linuxwifi@intel.com>
26 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *
28 * BSD LICENSE
29 *
30 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
31 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
32 * Copyright(c) 2016 Intel Deutschland GmbH
33 * Copyright(c) 2008 - 2014, 2018 - 2020 Intel Corporation
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *****************************************************************************/
62
63 #ifndef __iwl_fw_img_h__
64 #define __iwl_fw_img_h__
65 #include <linux/types.h>
66
67 #include "api/dbg-tlv.h"
68
69 #include "file.h"
70 #include "error-dump.h"
71
72 /**
73 * enum iwl_ucode_type
74 *
75 * The type of ucode.
76 *
77 * @IWL_UCODE_REGULAR: Normal runtime ucode
78 * @IWL_UCODE_INIT: Initial ucode
79 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
80 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
81 */
82 enum iwl_ucode_type {
83 IWL_UCODE_REGULAR,
84 IWL_UCODE_INIT,
85 IWL_UCODE_WOWLAN,
86 IWL_UCODE_REGULAR_USNIFFER,
87 IWL_UCODE_TYPE_MAX,
88 };
89
90 /*
91 * enumeration of ucode section.
92 * This enumeration is used directly for older firmware (before 16.0).
93 * For new firmware, there can be up to 4 sections (see below) but the
94 * first one packaged into the firmware file is the DATA section and
95 * some debugging code accesses that.
96 */
97 enum iwl_ucode_sec {
98 IWL_UCODE_SECTION_DATA,
99 IWL_UCODE_SECTION_INST,
100 };
101
102 struct iwl_ucode_capabilities {
103 u32 max_probe_length;
104 u32 n_scan_channels;
105 u32 standard_phy_calibration_size;
106 u32 flags;
107 u32 error_log_addr;
108 u32 error_log_size;
109 u32 num_stations;
110 unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
111 unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
112
113 const struct iwl_fw_cmd_version *cmd_versions;
114 u32 n_cmd_versions;
115 };
116
117 static inline bool
fw_has_api(const struct iwl_ucode_capabilities * capabilities,iwl_ucode_tlv_api_t api)118 fw_has_api(const struct iwl_ucode_capabilities *capabilities,
119 iwl_ucode_tlv_api_t api)
120 {
121 return test_bit((__force long)api, capabilities->_api);
122 }
123
124 static inline bool
fw_has_capa(const struct iwl_ucode_capabilities * capabilities,iwl_ucode_tlv_capa_t capa)125 fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
126 iwl_ucode_tlv_capa_t capa)
127 {
128 return test_bit((__force long)capa, capabilities->_capa);
129 }
130
131 /* one for each uCode image (inst/data, init/runtime/wowlan) */
132 struct fw_desc {
133 const void *data; /* vmalloc'ed data */
134 u32 len; /* size in bytes */
135 u32 offset; /* offset in the device */
136 };
137
138 struct fw_img {
139 struct fw_desc *sec;
140 int num_sec;
141 bool is_dual_cpus;
142 u32 paging_mem_size;
143 };
144
145 /*
146 * Block paging calculations
147 */
148 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
149 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
150 #define PAGE_PER_GROUP_2_EXP_SIZE 3
151 /* 8 pages per group */
152 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
153 /* don't change, support only 32KB size */
154 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
155 /* 32K == 2^15 */
156 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
157
158 /*
159 * Image paging calculations
160 */
161 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5
162 /* 2^5 == 32 blocks per image */
163 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
164 /* maximum image size 1024KB */
165 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
166
167 /* Virtual address signature */
168 #define PAGING_ADDR_SIG 0xAA000000
169
170 #define PAGING_CMD_IS_SECURED BIT(9)
171 #define PAGING_CMD_IS_ENABLED BIT(8)
172 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
173 #define PAGING_TLV_SECURE_MASK 1
174
175 /**
176 * struct iwl_fw_paging
177 * @fw_paging_phys: page phy pointer
178 * @fw_paging_block: pointer to the allocated block
179 * @fw_paging_size: page size
180 */
181 struct iwl_fw_paging {
182 dma_addr_t fw_paging_phys;
183 struct page *fw_paging_block;
184 u32 fw_paging_size;
185 };
186
187 /**
188 * struct iwl_fw_cscheme_list - a cipher scheme list
189 * @size: a number of entries
190 * @cs: cipher scheme entries
191 */
192 struct iwl_fw_cscheme_list {
193 u8 size;
194 struct iwl_fw_cipher_scheme cs[];
195 } __packed;
196
197 /**
198 * enum iwl_fw_type - iwlwifi firmware type
199 * @IWL_FW_DVM: DVM firmware
200 * @IWL_FW_MVM: MVM firmware
201 */
202 enum iwl_fw_type {
203 IWL_FW_DVM,
204 IWL_FW_MVM,
205 };
206
207 /**
208 * struct iwl_fw_dbg - debug data
209 *
210 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM)
211 * @n_dest_reg: num of reg_ops in dest_tlv
212 * @conf_tlv: array of pointers to configuration HCMDs
213 * @trigger_tlv: array of pointers to triggers TLVs
214 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
215 * @mem_tlv: Runtime addresses to dump
216 * @n_mem_tlv: number of runtime addresses
217 * @dump_mask: bitmask of dump regions
218 */
219 struct iwl_fw_dbg {
220 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv;
221 u8 n_dest_reg;
222 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX];
223 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX];
224 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX];
225 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv;
226 size_t n_mem_tlv;
227 u32 dump_mask;
228 };
229
230 /**
231 * struct iwl_fw - variables associated with the firmware
232 *
233 * @ucode_ver: ucode version from the ucode file
234 * @fw_version: firmware version string
235 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
236 * @iml_len: length of the image loader image
237 * @iml: image loader fw image
238 * @ucode_capa: capabilities parsed from the ucode file.
239 * @enhance_sensitivity_table: device can do enhanced sensitivity.
240 * @init_evtlog_ptr: event log offset for init ucode.
241 * @init_evtlog_size: event log size for init ucode.
242 * @init_errlog_ptr: error log offfset for init ucode.
243 * @inst_evtlog_ptr: event log offset for runtime ucode.
244 * @inst_evtlog_size: event log size for runtime ucode.
245 * @inst_errlog_ptr: error log offfset for runtime ucode.
246 * @type: firmware type (&enum iwl_fw_type)
247 * @cipher_scheme: optional external cipher scheme.
248 * @human_readable: human readable version
249 * we get the ALIVE from the uCode
250 */
251 struct iwl_fw {
252 u32 ucode_ver;
253
254 char fw_version[64];
255
256 /* ucode images */
257 struct fw_img img[IWL_UCODE_TYPE_MAX];
258 size_t iml_len;
259 u8 *iml;
260
261 struct iwl_ucode_capabilities ucode_capa;
262 bool enhance_sensitivity_table;
263
264 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
265 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
266
267 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
268 u32 phy_config;
269 u8 valid_tx_ant;
270 u8 valid_rx_ant;
271
272 enum iwl_fw_type type;
273
274 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS];
275 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
276
277 struct iwl_fw_dbg dbg;
278 };
279
get_fw_dbg_mode_string(int mode)280 static inline const char *get_fw_dbg_mode_string(int mode)
281 {
282 switch (mode) {
283 case SMEM_MODE:
284 return "SMEM";
285 case EXTERNAL_MODE:
286 return "EXTERNAL_DRAM";
287 case MARBH_MODE:
288 return "MARBH";
289 case MIPI_MODE:
290 return "MIPI";
291 default:
292 return "UNKNOWN";
293 }
294 }
295
296 static inline bool
iwl_fw_dbg_conf_usniffer(const struct iwl_fw * fw,u8 id)297 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
298 {
299 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id];
300
301 if (!conf_tlv)
302 return false;
303
304 return conf_tlv->usniffer;
305 }
306
307 static inline const struct fw_img *
iwl_get_ucode_image(const struct iwl_fw * fw,enum iwl_ucode_type ucode_type)308 iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type)
309 {
310 if (ucode_type >= IWL_UCODE_TYPE_MAX)
311 return NULL;
312
313 return &fw->img[ucode_type];
314 }
315
316 u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
317
318 u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
319 const char *iwl_fw_lookup_assert_desc(u32 num);
320 #endif /* __iwl_fw_img_h__ */
321
