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