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 "file.h" 69 #include "error-dump.h" 70 71 /** 72 * enum iwl_ucode_type 73 * 74 * The type of ucode. 75 * 76 * @IWL_UCODE_REGULAR: Normal runtime ucode 77 * @IWL_UCODE_INIT: Initial ucode 78 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode 79 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image 80 */ 81 enum iwl_ucode_type { 82 IWL_UCODE_REGULAR, 83 IWL_UCODE_INIT, 84 IWL_UCODE_WOWLAN, 85 IWL_UCODE_REGULAR_USNIFFER, 86 IWL_UCODE_TYPE_MAX, 87 }; 88 89 /* 90 * enumeration of ucode section. 91 * This enumeration is used directly for older firmware (before 16.0). 92 * For new firmware, there can be up to 4 sections (see below) but the 93 * first one packaged into the firmware file is the DATA section and 94 * some debugging code accesses that. 95 */ 96 enum iwl_ucode_sec { 97 IWL_UCODE_SECTION_DATA, 98 IWL_UCODE_SECTION_INST, 99 }; 100 101 struct iwl_ucode_capabilities { 102 u32 max_probe_length; 103 u32 n_scan_channels; 104 u32 standard_phy_calibration_size; 105 u32 flags; 106 unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)]; 107 unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)]; 108 }; 109 110 static inline bool 111 fw_has_api(const struct iwl_ucode_capabilities *capabilities, 112 iwl_ucode_tlv_api_t api) 113 { 114 return test_bit((__force long)api, capabilities->_api); 115 } 116 117 static inline bool 118 fw_has_capa(const struct iwl_ucode_capabilities *capabilities, 119 iwl_ucode_tlv_capa_t capa) 120 { 121 return test_bit((__force long)capa, capabilities->_capa); 122 } 123 124 /* one for each uCode image (inst/data, init/runtime/wowlan) */ 125 struct fw_desc { 126 const void *data; /* vmalloc'ed data */ 127 u32 len; /* size in bytes */ 128 u32 offset; /* offset in the device */ 129 }; 130 131 struct fw_img { 132 struct fw_desc *sec; 133 int num_sec; 134 bool is_dual_cpus; 135 u32 paging_mem_size; 136 }; 137 138 /* 139 * Block paging calculations 140 */ 141 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */ 142 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */ 143 #define PAGE_PER_GROUP_2_EXP_SIZE 3 144 /* 8 pages per group */ 145 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE) 146 /* don't change, support only 32KB size */ 147 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE) 148 /* 32K == 2^15 */ 149 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE) 150 151 /* 152 * Image paging calculations 153 */ 154 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5 155 /* 2^5 == 32 blocks per image */ 156 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE) 157 /* maximum image size 1024KB */ 158 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE) 159 160 /* Virtual address signature */ 161 #define PAGING_ADDR_SIG 0xAA000000 162 163 #define PAGING_CMD_IS_SECURED BIT(9) 164 #define PAGING_CMD_IS_ENABLED BIT(8) 165 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0 166 #define PAGING_TLV_SECURE_MASK 1 167 168 /** 169 * struct iwl_fw_paging 170 * @fw_paging_phys: page phy pointer 171 * @fw_paging_block: pointer to the allocated block 172 * @fw_paging_size: page size 173 */ 174 struct iwl_fw_paging { 175 dma_addr_t fw_paging_phys; 176 struct page *fw_paging_block; 177 u32 fw_paging_size; 178 }; 179 180 /** 181 * struct iwl_fw_cscheme_list - a cipher scheme list 182 * @size: a number of entries 183 * @cs: cipher scheme entries 184 */ 185 struct iwl_fw_cscheme_list { 186 u8 size; 187 struct iwl_fw_cipher_scheme cs[]; 188 } __packed; 189 190 /** 191 * enum iwl_fw_type - iwlwifi firmware type 192 * @IWL_FW_DVM: DVM firmware 193 * @IWL_FW_MVM: MVM firmware 194 */ 195 enum iwl_fw_type { 196 IWL_FW_DVM, 197 IWL_FW_MVM, 198 }; 199 200 /** 201 * struct iwl_fw_dbg - debug data 202 * 203 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM) 204 * @n_dest_reg: num of reg_ops in dest_tlv 205 * @conf_tlv: array of pointers to configuration HCMDs 206 * @trigger_tlv: array of pointers to triggers TLVs 207 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries 208 * @mem_tlv: Runtime addresses to dump 209 * @n_mem_tlv: number of runtime addresses 210 * @dump_mask: bitmask of dump regions 211 */ 212 struct iwl_fw_dbg { 213 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 214 u8 n_dest_reg; 215 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 216 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX]; 217 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX]; 218 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv; 219 size_t n_mem_tlv; 220 u32 dump_mask; 221 }; 222 223 /** 224 * struct iwl_fw - variables associated with the firmware 225 * 226 * @ucode_ver: ucode version from the ucode file 227 * @fw_version: firmware version string 228 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 229 * @iml_len: length of the image loader image 230 * @iml: image loader fw image 231 * @ucode_capa: capabilities parsed from the ucode file. 232 * @enhance_sensitivity_table: device can do enhanced sensitivity. 233 * @init_evtlog_ptr: event log offset for init ucode. 234 * @init_evtlog_size: event log size for init ucode. 235 * @init_errlog_ptr: error log offfset for init ucode. 236 * @inst_evtlog_ptr: event log offset for runtime ucode. 237 * @inst_evtlog_size: event log size for runtime ucode. 238 * @inst_errlog_ptr: error log offfset for runtime ucode. 239 * @type: firmware type (&enum iwl_fw_type) 240 * @cipher_scheme: optional external cipher scheme. 241 * @human_readable: human readable version 242 * we get the ALIVE from the uCode 243 */ 244 struct iwl_fw { 245 u32 ucode_ver; 246 247 char fw_version[ETHTOOL_FWVERS_LEN]; 248 249 /* ucode images */ 250 struct fw_img img[IWL_UCODE_TYPE_MAX]; 251 size_t iml_len; 252 u8 *iml; 253 254 struct iwl_ucode_capabilities ucode_capa; 255 bool enhance_sensitivity_table; 256 257 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 258 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 259 260 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 261 u32 phy_config; 262 u8 valid_tx_ant; 263 u8 valid_rx_ant; 264 265 enum iwl_fw_type type; 266 267 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS]; 268 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 269 270 struct iwl_fw_dbg dbg; 271 }; 272 273 static inline const char *get_fw_dbg_mode_string(int mode) 274 { 275 switch (mode) { 276 case SMEM_MODE: 277 return "SMEM"; 278 case EXTERNAL_MODE: 279 return "EXTERNAL_DRAM"; 280 case MARBH_MODE: 281 return "MARBH"; 282 case MIPI_MODE: 283 return "MIPI"; 284 default: 285 return "UNKNOWN"; 286 } 287 } 288 289 static inline bool 290 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id) 291 { 292 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id]; 293 294 if (!conf_tlv) 295 return false; 296 297 return conf_tlv->usniffer; 298 } 299 300 static inline const struct fw_img * 301 iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type) 302 { 303 if (ucode_type >= IWL_UCODE_TYPE_MAX) 304 return NULL; 305 306 return &fw->img[ucode_type]; 307 } 308 309 #endif /* __iwl_fw_img_h__ */ 310