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 struct iwl_sf_region { 142 u32 addr; 143 u32 size; 144 }; 145 146 /* 147 * Block paging calculations 148 */ 149 #define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */ 150 #define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */ 151 #define PAGE_PER_GROUP_2_EXP_SIZE 3 152 /* 8 pages per group */ 153 #define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE) 154 /* don't change, support only 32KB size */ 155 #define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE) 156 /* 32K == 2^15 */ 157 #define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE) 158 159 /* 160 * Image paging calculations 161 */ 162 #define BLOCK_PER_IMAGE_2_EXP_SIZE 5 163 /* 2^5 == 32 blocks per image */ 164 #define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE) 165 /* maximum image size 1024KB */ 166 #define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE) 167 168 /* Virtual address signature */ 169 #define PAGING_ADDR_SIG 0xAA000000 170 171 #define PAGING_CMD_IS_SECURED BIT(9) 172 #define PAGING_CMD_IS_ENABLED BIT(8) 173 #define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0 174 #define PAGING_TLV_SECURE_MASK 1 175 176 /** 177 * struct iwl_fw_paging 178 * @fw_paging_phys: page phy pointer 179 * @fw_paging_block: pointer to the allocated block 180 * @fw_paging_size: page size 181 */ 182 struct iwl_fw_paging { 183 dma_addr_t fw_paging_phys; 184 struct page *fw_paging_block; 185 u32 fw_paging_size; 186 }; 187 188 /** 189 * struct iwl_fw_cscheme_list - a cipher scheme list 190 * @size: a number of entries 191 * @cs: cipher scheme entries 192 */ 193 struct iwl_fw_cscheme_list { 194 u8 size; 195 struct iwl_fw_cipher_scheme cs[]; 196 } __packed; 197 198 /** 199 * struct iwl_gscan_capabilities - gscan capabilities supported by FW 200 * @max_scan_cache_size: total space allocated for scan results (in bytes). 201 * @max_scan_buckets: maximum number of channel buckets. 202 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan. 203 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI. 204 * @max_scan_reporting_threshold: max possible report threshold. in percentage. 205 * @max_hotlist_aps: maximum number of entries for hotlist APs. 206 * @max_significant_change_aps: maximum number of entries for significant 207 * change APs. 208 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can 209 * hold. 210 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs. 211 * @max_number_epno_networks: max number of epno entries. 212 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is 213 * specified. 214 * @max_number_of_white_listed_ssid: max number of white listed SSIDs. 215 * @max_number_of_black_listed_ssid: max number of black listed SSIDs. 216 */ 217 struct iwl_gscan_capabilities { 218 u32 max_scan_cache_size; 219 u32 max_scan_buckets; 220 u32 max_ap_cache_per_scan; 221 u32 max_rssi_sample_size; 222 u32 max_scan_reporting_threshold; 223 u32 max_hotlist_aps; 224 u32 max_significant_change_aps; 225 u32 max_bssid_history_entries; 226 u32 max_hotlist_ssids; 227 u32 max_number_epno_networks; 228 u32 max_number_epno_networks_by_ssid; 229 u32 max_number_of_white_listed_ssid; 230 u32 max_number_of_black_listed_ssid; 231 }; 232 233 /** 234 * enum iwl_fw_type - iwlwifi firmware type 235 * @IWL_FW_DVM: DVM firmware 236 * @IWL_FW_MVM: MVM firmware 237 */ 238 enum iwl_fw_type { 239 IWL_FW_DVM, 240 IWL_FW_MVM, 241 }; 242 243 /** 244 * struct iwl_fw - variables associated with the firmware 245 * 246 * @ucode_ver: ucode version from the ucode file 247 * @fw_version: firmware version string 248 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan. 249 * @ucode_capa: capabilities parsed from the ucode file. 250 * @enhance_sensitivity_table: device can do enhanced sensitivity. 251 * @init_evtlog_ptr: event log offset for init ucode. 252 * @init_evtlog_size: event log size for init ucode. 253 * @init_errlog_ptr: error log offfset for init ucode. 254 * @inst_evtlog_ptr: event log offset for runtime ucode. 255 * @inst_evtlog_size: event log size for runtime ucode. 256 * @inst_errlog_ptr: error log offfset for runtime ucode. 257 * @type: firmware type (&enum iwl_fw_type) 258 * @cipher_scheme: optional external cipher scheme. 259 * @human_readable: human readable version 260 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until 261 * we get the ALIVE from the uCode 262 * @dbg_dest_tlv: points to the destination TLV for debug 263 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug 264 * @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries 265 * @dbg_trigger_tlv: array of pointers to triggers TLVs 266 * @dbg_trigger_tlv_len: lengths of the @dbg_trigger_tlv entries 267 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv 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 277 struct iwl_ucode_capabilities ucode_capa; 278 bool enhance_sensitivity_table; 279 280 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr; 281 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr; 282 283 struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX]; 284 u32 phy_config; 285 u8 valid_tx_ant; 286 u8 valid_rx_ant; 287 288 enum iwl_fw_type type; 289 290 struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS]; 291 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 292 293 u32 sdio_adma_addr; 294 295 struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv; 296 struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX]; 297 size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX]; 298 struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX]; 299 struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv; 300 size_t n_dbg_mem_tlv; 301 size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX]; 302 u8 dbg_dest_reg_num; 303 struct iwl_gscan_capabilities gscan_capa; 304 }; 305 306 static inline const char *get_fw_dbg_mode_string(int mode) 307 { 308 switch (mode) { 309 case SMEM_MODE: 310 return "SMEM"; 311 case EXTERNAL_MODE: 312 return "EXTERNAL_DRAM"; 313 case MARBH_MODE: 314 return "MARBH"; 315 case MIPI_MODE: 316 return "MIPI"; 317 default: 318 return "UNKNOWN"; 319 } 320 } 321 322 static inline bool 323 iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id) 324 { 325 const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id]; 326 327 if (!conf_tlv) 328 return false; 329 330 return conf_tlv->usniffer; 331 } 332 333 static inline const struct fw_img * 334 iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type) 335 { 336 if (ucode_type >= IWL_UCODE_TYPE_MAX) 337 return NULL; 338 339 return &fw->img[ucode_type]; 340 } 341 342 #endif /* __iwl_fw_img_h__ */ 343