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