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 */ 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 unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)]; 109 unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)]; 110}; 111 112static inline bool 113fw_has_api(const struct iwl_ucode_capabilities *capabilities, 114 iwl_ucode_tlv_api_t api) 115{ 116 return test_bit((__force long)api, capabilities->_api); 117} 118 119static inline bool 120fw_has_capa(const struct iwl_ucode_capabilities *capabilities, 121 iwl_ucode_tlv_capa_t capa) 122{ 123 return test_bit((__force long)capa, capabilities->_capa); 124} 125 126/* one for each uCode image (inst/data, init/runtime/wowlan) */ 127struct fw_desc { 128 const void *data; /* vmalloc'ed data */ 129 u32 len; /* size in bytes */ 130 u32 offset; /* offset in the device */ 131}; 132 133struct fw_img { 134 struct fw_desc *sec; 135 int num_sec; 136 bool is_dual_cpus; 137 u32 paging_mem_size; 138}; 139 140/* 141 * Block paging calculations 142 */ 143#define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */ 144#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */ 145#define PAGE_PER_GROUP_2_EXP_SIZE 3 146/* 8 pages per group */ 147#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE) 148/* don't change, support only 32KB size */ 149#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE) 150/* 32K == 2^15 */ 151#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE) 152 153/* 154 * Image paging calculations 155 */ 156#define BLOCK_PER_IMAGE_2_EXP_SIZE 5 157/* 2^5 == 32 blocks per image */ 158#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE) 159/* maximum image size 1024KB */ 160#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE) 161 162/* Virtual address signature */ 163#define PAGING_ADDR_SIG 0xAA000000 164 165#define PAGING_CMD_IS_SECURED BIT(9) 166#define PAGING_CMD_IS_ENABLED BIT(8) 167#define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0 168#define PAGING_TLV_SECURE_MASK 1 169 170/** 171 * struct iwl_fw_paging 172 * @fw_paging_phys: page phy pointer 173 * @fw_paging_block: pointer to the allocated block 174 * @fw_paging_size: page size 175 */ 176struct iwl_fw_paging { 177 dma_addr_t fw_paging_phys; 178 struct page *fw_paging_block; 179 u32 fw_paging_size; 180}; 181 182/** 183 * struct iwl_fw_cscheme_list - a cipher scheme list 184 * @size: a number of entries 185 * @cs: cipher scheme entries 186 */ 187struct iwl_fw_cscheme_list { 188 u8 size; 189 struct iwl_fw_cipher_scheme cs[]; 190} __packed; 191 192/** 193 * enum iwl_fw_type - iwlwifi firmware type 194 * @IWL_FW_DVM: DVM firmware 195 * @IWL_FW_MVM: MVM firmware 196 */ 197enum iwl_fw_type { 198 IWL_FW_DVM, 199 IWL_FW_MVM, 200}; 201 202/** 203 * struct iwl_fw_dbg - debug data 204 * 205 * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM) 206 * @n_dest_reg: num of reg_ops in dest_tlv 207 * @conf_tlv: array of pointers to configuration HCMDs 208 * @trigger_tlv: array of pointers to triggers TLVs 209 * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries 210 * @mem_tlv: Runtime addresses to dump 211 * @n_mem_tlv: number of runtime addresses 212 * @dump_mask: bitmask of dump regions 213*/ 214struct iwl_fw_dbg { 215 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv; 216 u8 n_dest_reg; 217 struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX]; 218 struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX]; 219 size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX]; 220 struct iwl_fw_dbg_mem_seg_tlv *mem_tlv; 221 size_t n_mem_tlv; 222 u32 dump_mask; 223}; 224 225/** 226 * struct iwl_fw_ini_active_triggers 227 * @active: is this trigger active 228 * @apply_point: last apply point that updated this trigger 229 * @conf: active trigger 230 * @conf_ext: second trigger, contains extra regions to dump 231 */ 232struct iwl_fw_ini_active_triggers { 233 bool active; 234 enum iwl_fw_ini_apply_point apply_point; 235 struct iwl_fw_ini_trigger *conf; 236 struct iwl_fw_ini_trigger *conf_ext; 237}; 238 239/** 240 * struct iwl_fw_ini_active_regs 241 * @reg: active region from TLV 242 * @apply_point: apply point where it became active 243 */ 244struct iwl_fw_ini_active_regs { 245 struct iwl_fw_ini_region_cfg *reg; 246 enum iwl_fw_ini_apply_point apply_point; 247}; 248 249/** 250 * struct iwl_fw - variables associated with the firmware 251 * 252 * @ucode_ver: ucode version from the ucode file 253 * @fw_version: firmware version string 254 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 255 * @iml_len: length of the image loader image 256 * @iml: image loader fw image 257 * @ucode_capa: capabilities parsed from the ucode file. 258 * @enhance_sensitivity_table: device can do enhanced sensitivity. 259 * @init_evtlog_ptr: event log offset for init ucode. 260 * @init_evtlog_size: event log size for init ucode. 261 * @init_errlog_ptr: error log offfset for init ucode. 262 * @inst_evtlog_ptr: event log offset for runtime ucode. 263 * @inst_evtlog_size: event log size for runtime ucode. 264 * @inst_errlog_ptr: error log offfset for runtime ucode. 265 * @type: firmware type (&enum iwl_fw_type) 266 * @cipher_scheme: optional external cipher scheme. 267 * @human_readable: human readable version 268 * we get the ALIVE from the uCode 269 */ 270struct iwl_fw { 271 u32 ucode_ver; 272 273 char fw_version[ETHTOOL_FWVERS_LEN]; 274 275 /* ucode images */ 276 struct fw_img img[IWL_UCODE_TYPE_MAX]; 277 size_t iml_len; 278 u8 *iml; 279 280 struct iwl_ucode_capabilities ucode_capa; 281 bool enhance_sensitivity_table; 282 283 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 284 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 285 286 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 287 u32 phy_config; 288 u8 valid_tx_ant; 289 u8 valid_rx_ant; 290 291 enum iwl_fw_type type; 292 293 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS]; 294 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 295 296 struct iwl_fw_dbg dbg; 297}; 298 299static inline const char *get_fw_dbg_mode_string(int mode) 300{ 301 switch (mode) { 302 case SMEM_MODE: 303 return "SMEM"; 304 case EXTERNAL_MODE: 305 return "EXTERNAL_DRAM"; 306 case MARBH_MODE: 307 return "MARBH"; 308 case MIPI_MODE: 309 return "MIPI"; 310 default: 311 return "UNKNOWN"; 312 } 313} 314 315static inline bool 316iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id) 317{ 318 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg.conf_tlv[id]; 319 320 if (!conf_tlv) 321 return false; 322 323 return conf_tlv->usniffer; 324} 325 326static inline const struct fw_img * 327iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type) 328{ 329 if (ucode_type >= IWL_UCODE_TYPE_MAX) 330 return NULL; 331 332 return &fw->img[ucode_type]; 333} 334 335#endif /* __iwl_fw_img_h__ */ 336