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 * 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 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 */ 83 enum 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 */ 98 enum iwl_ucode_sec { 99 IWL_UCODE_SECTION_DATA, 100 IWL_UCODE_SECTION_INST, 101 }; 102 103 struct 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 114 static inline bool 115 fw_has_api(const struct iwl_ucode_capabilities *capabilities, 116 iwl_ucode_tlv_api_t api) 117 { 118 return test_bit((__force long)api, capabilities->_api); 119 } 120 121 static inline bool 122 fw_has_capa(const struct iwl_ucode_capabilities *capabilities, 123 iwl_ucode_tlv_capa_t capa) 124 { 125 return test_bit((__force long)capa, capabilities->_capa); 126 } 127 128 /* one for each uCode image (inst/data, init/runtime/wowlan) */ 129 struct fw_desc { 130 const void *data; /* vmalloc'ed data */ 131 u32 len; /* size in bytes */ 132 u32 offset; /* offset in the device */ 133 }; 134 135 struct fw_img { 136 struct fw_desc *sec; 137 int num_sec; 138 bool is_dual_cpus; 139 u32 paging_mem_size; 140 }; 141 142 /* 143 * Block paging calculations 144 */ 145 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */ 146 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */ 147 #define PAGE_PER_GROUP_2_EXP_SIZE 3 148 /* 8 pages per group */ 149 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE) 150 /* don't change, support only 32KB size */ 151 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE) 152 /* 32K == 2^15 */ 153 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE) 154 155 /* 156 * Image paging calculations 157 */ 158 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5 159 /* 2^5 == 32 blocks per image */ 160 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE) 161 /* maximum image size 1024KB */ 162 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE) 163 164 /* Virtual address signature */ 165 #define PAGING_ADDR_SIG 0xAA000000 166 167 #define PAGING_CMD_IS_SECURED BIT(9) 168 #define PAGING_CMD_IS_ENABLED BIT(8) 169 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0 170 #define PAGING_TLV_SECURE_MASK 1 171 172 /** 173 * struct iwl_fw_paging 174 * @fw_paging_phys: page phy pointer 175 * @fw_paging_block: pointer to the allocated block 176 * @fw_paging_size: page size 177 */ 178 struct iwl_fw_paging { 179 dma_addr_t fw_paging_phys; 180 struct page *fw_paging_block; 181 u32 fw_paging_size; 182 }; 183 184 /** 185 * struct iwl_fw_cscheme_list - a cipher scheme list 186 * @size: a number of entries 187 * @cs: cipher scheme entries 188 */ 189 struct iwl_fw_cscheme_list { 190 u8 size; 191 struct iwl_fw_cipher_scheme cs[]; 192 } __packed; 193 194 /** 195 * enum iwl_fw_type - iwlwifi firmware type 196 * @IWL_FW_DVM: DVM firmware 197 * @IWL_FW_MVM: MVM firmware 198 */ 199 enum iwl_fw_type { 200 IWL_FW_DVM, 201 IWL_FW_MVM, 202 }; 203 204 /** 205 * struct iwl_fw_dbg - debug data 206 * 207 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM) 208 * @n_dest_reg: num of reg_ops in dest_tlv 209 * @conf_tlv: array of pointers to configuration HCMDs 210 * @trigger_tlv: array of pointers to triggers TLVs 211 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries 212 * @mem_tlv: Runtime addresses to dump 213 * @n_mem_tlv: number of runtime addresses 214 * @dump_mask: bitmask of dump regions 215 */ 216 struct iwl_fw_dbg { 217 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 218 u8 n_dest_reg; 219 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 220 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX]; 221 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX]; 222 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv; 223 size_t n_mem_tlv; 224 u32 dump_mask; 225 }; 226 227 /** 228 * @tlv: the buffer allocation tlv 229 * @is_alloc: indicates if the buffer was already allocated 230 */ 231 struct iwl_fw_ini_allocation_data { 232 struct iwl_fw_ini_allocation_tlv tlv; 233 u32 is_alloc; 234 } __packed; 235 236 /** 237 * struct iwl_fw_ini_active_triggers 238 * @active: is this trigger active 239 * @size: allocated memory size of the trigger 240 * @trig: trigger 241 */ 242 struct iwl_fw_ini_active_triggers { 243 bool active; 244 size_t size; 245 struct iwl_fw_ini_trigger *trig; 246 }; 247 248 /** 249 * struct iwl_fw - variables associated with the firmware 250 * 251 * @ucode_ver: ucode version from the ucode file 252 * @fw_version: firmware version string 253 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 254 * @iml_len: length of the image loader image 255 * @iml: image loader fw image 256 * @ucode_capa: capabilities parsed from the ucode file. 257 * @enhance_sensitivity_table: device can do enhanced sensitivity. 258 * @init_evtlog_ptr: event log offset for init ucode. 259 * @init_evtlog_size: event log size for init ucode. 260 * @init_errlog_ptr: error log offfset for init ucode. 261 * @inst_evtlog_ptr: event log offset for runtime ucode. 262 * @inst_evtlog_size: event log size for runtime ucode. 263 * @inst_errlog_ptr: error log offfset for runtime ucode. 264 * @type: firmware type (&enum iwl_fw_type) 265 * @cipher_scheme: optional external cipher scheme. 266 * @human_readable: human readable version 267 * we get the ALIVE from the uCode 268 */ 269 struct iwl_fw { 270 u32 ucode_ver; 271 272 char fw_version[ETHTOOL_FWVERS_LEN]; 273 274 /* ucode images */ 275 struct fw_img img[IWL_UCODE_TYPE_MAX]; 276 size_t iml_len; 277 u8 *iml; 278 279 struct iwl_ucode_capabilities ucode_capa; 280 bool enhance_sensitivity_table; 281 282 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 283 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 284 285 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 286 u32 phy_config; 287 u8 valid_tx_ant; 288 u8 valid_rx_ant; 289 290 enum iwl_fw_type type; 291 292 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS]; 293 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 294 295 struct iwl_fw_dbg dbg; 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