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