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_file_h__ 68#define __iwl_fw_file_h__ 69 70#include <linux/netdevice.h> 71#include <linux/nl80211.h> 72 73/* v1/v2 uCode file layout */ 74struct iwl_ucode_header { 75 __le32 ver; /* major/minor/API/serial */ 76 union { 77 struct { 78 __le32 inst_size; /* bytes of runtime code */ 79 __le32 data_size; /* bytes of runtime data */ 80 __le32 init_size; /* bytes of init code */ 81 __le32 init_data_size; /* bytes of init data */ 82 __le32 boot_size; /* bytes of bootstrap code */ 83 u8 data[0]; /* in same order as sizes */ 84 } v1; 85 struct { 86 __le32 build; /* build number */ 87 __le32 inst_size; /* bytes of runtime code */ 88 __le32 data_size; /* bytes of runtime data */ 89 __le32 init_size; /* bytes of init code */ 90 __le32 init_data_size; /* bytes of init data */ 91 __le32 boot_size; /* bytes of bootstrap code */ 92 u8 data[0]; /* in same order as sizes */ 93 } v2; 94 } u; 95}; 96 97/* 98 * new TLV uCode file layout 99 * 100 * The new TLV file format contains TLVs, that each specify 101 * some piece of data. 102 */ 103 104enum iwl_ucode_tlv_type { 105 IWL_UCODE_TLV_INVALID = 0, /* unused */ 106 IWL_UCODE_TLV_INST = 1, 107 IWL_UCODE_TLV_DATA = 2, 108 IWL_UCODE_TLV_INIT = 3, 109 IWL_UCODE_TLV_INIT_DATA = 4, 110 IWL_UCODE_TLV_BOOT = 5, 111 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */ 112 IWL_UCODE_TLV_PAN = 7, 113 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8, 114 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9, 115 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10, 116 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11, 117 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12, 118 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13, 119 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14, 120 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15, 121 IWL_UCODE_TLV_WOWLAN_INST = 16, 122 IWL_UCODE_TLV_WOWLAN_DATA = 17, 123 IWL_UCODE_TLV_FLAGS = 18, 124 IWL_UCODE_TLV_SEC_RT = 19, 125 IWL_UCODE_TLV_SEC_INIT = 20, 126 IWL_UCODE_TLV_SEC_WOWLAN = 21, 127 IWL_UCODE_TLV_DEF_CALIB = 22, 128 IWL_UCODE_TLV_PHY_SKU = 23, 129 IWL_UCODE_TLV_SECURE_SEC_RT = 24, 130 IWL_UCODE_TLV_SECURE_SEC_INIT = 25, 131 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26, 132 IWL_UCODE_TLV_NUM_OF_CPU = 27, 133 IWL_UCODE_TLV_CSCHEME = 28, 134 IWL_UCODE_TLV_API_CHANGES_SET = 29, 135 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30, 136 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31, 137 IWL_UCODE_TLV_PAGING = 32, 138 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34, 139 IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35, 140 IWL_UCODE_TLV_FW_VERSION = 36, 141 IWL_UCODE_TLV_FW_DBG_DEST = 38, 142 IWL_UCODE_TLV_FW_DBG_CONF = 39, 143 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40, 144 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50, 145 IWL_UCODE_TLV_FW_MEM_SEG = 51, 146}; 147 148struct iwl_ucode_tlv { 149 __le32 type; /* see above */ 150 __le32 length; /* not including type/length fields */ 151 u8 data[0]; 152}; 153 154#define IWL_TLV_UCODE_MAGIC 0x0a4c5749 155#define FW_VER_HUMAN_READABLE_SZ 64 156 157struct iwl_tlv_ucode_header { 158 /* 159 * The TLV style ucode header is distinguished from 160 * the v1/v2 style header by first four bytes being 161 * zero, as such is an invalid combination of 162 * major/minor/API/serial versions. 163 */ 164 __le32 zero; 165 __le32 magic; 166 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 167 /* major/minor/API/serial or major in new format */ 168 __le32 ver; 169 __le32 build; 170 __le64 ignore; 171 /* 172 * The data contained herein has a TLV layout, 173 * see above for the TLV header and types. 174 * Note that each TLV is padded to a length 175 * that is a multiple of 4 for alignment. 176 */ 177 u8 data[0]; 178}; 179 180/* 181 * ucode TLVs 182 * 183 * ability to get extension for: flags & capabilities from ucode binaries files 184 */ 185struct iwl_ucode_api { 186 __le32 api_index; 187 __le32 api_flags; 188} __packed; 189 190struct iwl_ucode_capa { 191 __le32 api_index; 192 __le32 api_capa; 193} __packed; 194 195/** 196 * enum iwl_ucode_tlv_flag - ucode API flags 197 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously 198 * was a separate TLV but moved here to save space. 199 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID, 200 * treats good CRC threshold as a boolean 201 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w). 202 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD 203 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan 204 * offload profile config command. 205 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six 206 * (rather than two) IPv6 addresses 207 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element 208 * from the probe request template. 209 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version) 210 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version) 211 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD 212 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save 213 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering. 214 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS. 215 */ 216enum iwl_ucode_tlv_flag { 217 IWL_UCODE_TLV_FLAGS_PAN = BIT(0), 218 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1), 219 IWL_UCODE_TLV_FLAGS_MFP = BIT(2), 220 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7), 221 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10), 222 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12), 223 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15), 224 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16), 225 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24), 226 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25), 227 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26), 228 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29), 229}; 230 231typedef unsigned int __bitwise__ iwl_ucode_tlv_api_t; 232 233/** 234 * enum iwl_ucode_tlv_api - ucode api 235 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time 236 * longer than the passive one, which is essential for fragmented scan. 237 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source. 238 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params 239 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format 240 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan 241 * iteration complete notification, and the timestamp reported for RX 242 * received during scan, are reported in TSF of the mac specified in the 243 * scan request. 244 * 245 * @NUM_IWL_UCODE_TLV_API: number of bits used 246 */ 247enum iwl_ucode_tlv_api { 248 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8, 249 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9, 250 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18, 251 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20, 252 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28, 253 254 NUM_IWL_UCODE_TLV_API 255#ifdef __CHECKER__ 256 /* sparse says it cannot increment the previous enum member */ 257 = 128 258#endif 259}; 260 261typedef unsigned int __bitwise__ iwl_ucode_tlv_capa_t; 262 263/** 264 * enum iwl_ucode_tlv_capa - ucode capabilities 265 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3 266 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory 267 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan. 268 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer 269 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM) 270 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality 271 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current 272 * tx power value into TPC Report action frame and Link Measurement Report 273 * action frame 274 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current 275 * channel in DS parameter set element in probe requests. 276 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in 277 * probe requests. 278 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests 279 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA), 280 * which also implies support for the scheduler configuration command 281 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching 282 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image 283 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command 284 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command 285 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload 286 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics 287 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it 288 * is standalone or with a BSS station interface in the same binding. 289 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running 290 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different 291 * sources for the MCC. This TLV bit is a future replacement to 292 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR 293 * is supported. 294 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC 295 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan 296 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement 297 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts 298 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT 299 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA 300 * countdown offloading. Beacon notifications are not sent to the host. 301 * The fw also offloads TBTT alignment. 302 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what 303 * antenna the beacon should be transmitted 304 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon 305 * from AP and will send it upon d0i3 exit. 306 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2 307 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill 308 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature 309 * thresholds reporting 310 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command 311 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in 312 * regular image. 313 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared 314 * memory addresses from the firmware. 315 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement 316 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger 317 * command size (command version 4) that supports toggling ACK TX 318 * power reduction. 319 * 320 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used 321 */ 322enum iwl_ucode_tlv_capa { 323 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0, 324 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1, 325 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2, 326 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3, 327 IWL_UCODE_TLV_CAPA_TOF_SUPPORT = (__force iwl_ucode_tlv_capa_t)5, 328 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6, 329 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8, 330 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9, 331 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10, 332 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11, 333 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12, 334 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13, 335 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17, 336 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18, 337 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19, 338 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21, 339 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22, 340 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26, 341 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28, 342 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29, 343 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30, 344 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31, 345 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64, 346 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65, 347 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67, 348 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68, 349 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70, 350 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71, 351 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72, 352 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2 = (__force iwl_ucode_tlv_capa_t)73, 353 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74, 354 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75, 355 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76, 356 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77, 357 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80, 358 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81, 359 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84, 360 361 NUM_IWL_UCODE_TLV_CAPA 362#ifdef __CHECKER__ 363 /* sparse says it cannot increment the previous enum member */ 364 = 128 365#endif 366}; 367 368/* The default calibrate table size if not specified by firmware file */ 369#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 370#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 371#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 372 373/* The default max probe length if not specified by the firmware file */ 374#define IWL_DEFAULT_MAX_PROBE_LENGTH 200 375 376/* 377 * For 16.0 uCode and above, there is no differentiation between sections, 378 * just an offset to the HW address. 379 */ 380#define IWL_UCODE_SECTION_MAX 16 381#define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC 382#define PAGING_SEPARATOR_SECTION 0xAAAABBBB 383 384/* uCode version contains 4 values: Major/Minor/API/Serial */ 385#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 386#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 387#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 388#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 389 390/* 391 * Calibration control struct. 392 * Sent as part of the phy configuration command. 393 * @flow_trigger: bitmap for which calibrations to perform according to 394 * flow triggers. 395 * @event_trigger: bitmap for which calibrations to perform according to 396 * event triggers. 397 */ 398struct iwl_tlv_calib_ctrl { 399 __le32 flow_trigger; 400 __le32 event_trigger; 401} __packed; 402 403enum iwl_fw_phy_cfg { 404 FW_PHY_CFG_RADIO_TYPE_POS = 0, 405 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS, 406 FW_PHY_CFG_RADIO_STEP_POS = 2, 407 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS, 408 FW_PHY_CFG_RADIO_DASH_POS = 4, 409 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS, 410 FW_PHY_CFG_TX_CHAIN_POS = 16, 411 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS, 412 FW_PHY_CFG_RX_CHAIN_POS = 20, 413 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS, 414}; 415 416#define IWL_UCODE_MAX_CS 1 417 418/** 419 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW. 420 * @cipher: a cipher suite selector 421 * @flags: cipher scheme flags (currently reserved for a future use) 422 * @hdr_len: a size of MPDU security header 423 * @pn_len: a size of PN 424 * @pn_off: an offset of pn from the beginning of the security header 425 * @key_idx_off: an offset of key index byte in the security header 426 * @key_idx_mask: a bit mask of key_idx bits 427 * @key_idx_shift: bit shift needed to get key_idx 428 * @mic_len: mic length in bytes 429 * @hw_cipher: a HW cipher index used in host commands 430 */ 431struct iwl_fw_cipher_scheme { 432 __le32 cipher; 433 u8 flags; 434 u8 hdr_len; 435 u8 pn_len; 436 u8 pn_off; 437 u8 key_idx_off; 438 u8 key_idx_mask; 439 u8 key_idx_shift; 440 u8 mic_len; 441 u8 hw_cipher; 442} __packed; 443 444enum iwl_fw_dbg_reg_operator { 445 CSR_ASSIGN, 446 CSR_SETBIT, 447 CSR_CLEARBIT, 448 449 PRPH_ASSIGN, 450 PRPH_SETBIT, 451 PRPH_CLEARBIT, 452 453 INDIRECT_ASSIGN, 454 INDIRECT_SETBIT, 455 INDIRECT_CLEARBIT, 456 457 PRPH_BLOCKBIT, 458}; 459 460/** 461 * struct iwl_fw_dbg_reg_op - an operation on a register 462 * 463 * @op: %enum iwl_fw_dbg_reg_operator 464 * @addr: offset of the register 465 * @val: value 466 */ 467struct iwl_fw_dbg_reg_op { 468 u8 op; 469 u8 reserved[3]; 470 __le32 addr; 471 __le32 val; 472} __packed; 473 474/** 475 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes 476 * 477 * @SMEM_MODE: monitor stores the data in SMEM 478 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM 479 * @MARBH_MODE: monitor stores the data in MARBH buffer 480 * @MIPI_MODE: monitor outputs the data through the MIPI interface 481 */ 482enum iwl_fw_dbg_monitor_mode { 483 SMEM_MODE = 0, 484 EXTERNAL_MODE = 1, 485 MARBH_MODE = 2, 486 MIPI_MODE = 3, 487}; 488 489/** 490 * enum iwl_fw_mem_seg_type - data types for dumping on error 491 * 492 * @FW_DBG_MEM_SMEM: the data type is SMEM 493 * @FW_DBG_MEM_DCCM_LMAC: the data type is DCCM_LMAC 494 * @FW_DBG_MEM_DCCM_UMAC: the data type is DCCM_UMAC 495 */ 496enum iwl_fw_dbg_mem_seg_type { 497 FW_DBG_MEM_DCCM_LMAC = 0, 498 FW_DBG_MEM_DCCM_UMAC, 499 FW_DBG_MEM_SMEM, 500 501 /* Must be last */ 502 FW_DBG_MEM_MAX, 503}; 504 505/** 506 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments 507 * 508 * @data_type: enum %iwl_fw_mem_seg_type 509 * @ofs: the memory segment offset 510 * @len: the memory segment length, in bytes 511 * 512 * This parses IWL_UCODE_TLV_FW_MEM_SEG 513 */ 514struct iwl_fw_dbg_mem_seg_tlv { 515 __le32 data_type; 516 __le32 ofs; 517 __le32 len; 518} __packed; 519 520/** 521 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data 522 * 523 * @version: version of the TLV - currently 0 524 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode 525 * @size_power: buffer size will be 2^(size_power + 11) 526 * @base_reg: addr of the base addr register (PRPH) 527 * @end_reg: addr of the end addr register (PRPH) 528 * @write_ptr_reg: the addr of the reg of the write pointer 529 * @wrap_count: the addr of the reg of the wrap_count 530 * @base_shift: shift right of the base addr reg 531 * @end_shift: shift right of the end addr reg 532 * @reg_ops: array of registers operations 533 * 534 * This parses IWL_UCODE_TLV_FW_DBG_DEST 535 */ 536struct iwl_fw_dbg_dest_tlv { 537 u8 version; 538 u8 monitor_mode; 539 u8 size_power; 540 u8 reserved; 541 __le32 base_reg; 542 __le32 end_reg; 543 __le32 write_ptr_reg; 544 __le32 wrap_count; 545 u8 base_shift; 546 u8 end_shift; 547 struct iwl_fw_dbg_reg_op reg_ops[0]; 548} __packed; 549 550struct iwl_fw_dbg_conf_hcmd { 551 u8 id; 552 u8 reserved; 553 __le16 len; 554 u8 data[0]; 555} __packed; 556 557/** 558 * enum iwl_fw_dbg_trigger_mode - triggers functionalities 559 * 560 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism 561 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data 562 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to 563 * collect only monitor data 564 */ 565enum iwl_fw_dbg_trigger_mode { 566 IWL_FW_DBG_TRIGGER_START = BIT(0), 567 IWL_FW_DBG_TRIGGER_STOP = BIT(1), 568 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2), 569}; 570 571/** 572 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger 573 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type 574 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode 575 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode 576 * @IWL_FW_DBG_CONF_VIF_AP: AP mode 577 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode 578 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode 579 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device 580 */ 581enum iwl_fw_dbg_trigger_vif_type { 582 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED, 583 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC, 584 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION, 585 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP, 586 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT, 587 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO, 588 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE, 589}; 590 591/** 592 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger 593 * @id: %enum iwl_fw_dbg_trigger 594 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type 595 * @stop_conf_ids: bitmap of configurations this trigger relates to. 596 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding 597 * to the currently running configuration is set, the data should be 598 * collected. 599 * @stop_delay: how many milliseconds to wait before collecting the data 600 * after the STOP trigger fires. 601 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both 602 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what 603 * configuration should be applied when the triggers kicks in. 604 * @occurrences: number of occurrences. 0 means the trigger will never fire. 605 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this 606 * trigger in which another occurrence should be ignored. 607 */ 608struct iwl_fw_dbg_trigger_tlv { 609 __le32 id; 610 __le32 vif_type; 611 __le32 stop_conf_ids; 612 __le32 stop_delay; 613 u8 mode; 614 u8 start_conf_id; 615 __le16 occurrences; 616 __le16 trig_dis_ms; 617 __le16 reserved[3]; 618 619 u8 data[0]; 620} __packed; 621 622#define FW_DBG_START_FROM_ALIVE 0 623#define FW_DBG_CONF_MAX 32 624#define FW_DBG_INVALID 0xff 625 626/** 627 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons 628 * @stop_consec_missed_bcon: stop recording if threshold is crossed. 629 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed. 630 * @start_consec_missed_bcon: start recording if threshold is crossed. 631 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed. 632 * @reserved1: reserved 633 * @reserved2: reserved 634 */ 635struct iwl_fw_dbg_trigger_missed_bcon { 636 __le32 stop_consec_missed_bcon; 637 __le32 stop_consec_missed_bcon_since_rx; 638 __le32 reserved2[2]; 639 __le32 start_consec_missed_bcon; 640 __le32 start_consec_missed_bcon_since_rx; 641 __le32 reserved1[2]; 642} __packed; 643 644/** 645 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW. 646 * cmds: the list of commands to trigger the collection on 647 */ 648struct iwl_fw_dbg_trigger_cmd { 649 struct cmd { 650 u8 cmd_id; 651 u8 group_id; 652 } __packed cmds[16]; 653} __packed; 654 655/** 656 * iwl_fw_dbg_trigger_stats - configures trigger for statistics 657 * @stop_offset: the offset of the value to be monitored 658 * @stop_threshold: the threshold above which to collect 659 * @start_offset: the offset of the value to be monitored 660 * @start_threshold: the threshold above which to start recording 661 */ 662struct iwl_fw_dbg_trigger_stats { 663 __le32 stop_offset; 664 __le32 stop_threshold; 665 __le32 start_offset; 666 __le32 start_threshold; 667} __packed; 668 669/** 670 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI 671 * @rssi: RSSI value to trigger at 672 */ 673struct iwl_fw_dbg_trigger_low_rssi { 674 __le32 rssi; 675} __packed; 676 677/** 678 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events 679 * @stop_auth_denied: number of denied authentication to collect 680 * @stop_auth_timeout: number of authentication timeout to collect 681 * @stop_rx_deauth: number of Rx deauth before to collect 682 * @stop_tx_deauth: number of Tx deauth before to collect 683 * @stop_assoc_denied: number of denied association to collect 684 * @stop_assoc_timeout: number of association timeout to collect 685 * @stop_connection_loss: number of connection loss to collect 686 * @start_auth_denied: number of denied authentication to start recording 687 * @start_auth_timeout: number of authentication timeout to start recording 688 * @start_rx_deauth: number of Rx deauth to start recording 689 * @start_tx_deauth: number of Tx deauth to start recording 690 * @start_assoc_denied: number of denied association to start recording 691 * @start_assoc_timeout: number of association timeout to start recording 692 * @start_connection_loss: number of connection loss to start recording 693 */ 694struct iwl_fw_dbg_trigger_mlme { 695 u8 stop_auth_denied; 696 u8 stop_auth_timeout; 697 u8 stop_rx_deauth; 698 u8 stop_tx_deauth; 699 700 u8 stop_assoc_denied; 701 u8 stop_assoc_timeout; 702 u8 stop_connection_loss; 703 u8 reserved; 704 705 u8 start_auth_denied; 706 u8 start_auth_timeout; 707 u8 start_rx_deauth; 708 u8 start_tx_deauth; 709 710 u8 start_assoc_denied; 711 u8 start_assoc_timeout; 712 u8 start_connection_loss; 713 u8 reserved2; 714} __packed; 715 716/** 717 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer 718 * @command_queue: timeout for the command queue in ms 719 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms 720 * @softap: timeout for the queues of a softAP in ms 721 * @p2p_go: timeout for the queues of a P2P GO in ms 722 * @p2p_client: timeout for the queues of a P2P client in ms 723 * @p2p_device: timeout for the queues of a P2P device in ms 724 * @ibss: timeout for the queues of an IBSS in ms 725 * @tdls: timeout for the queues of a TDLS station in ms 726 */ 727struct iwl_fw_dbg_trigger_txq_timer { 728 __le32 command_queue; 729 __le32 bss; 730 __le32 softap; 731 __le32 p2p_go; 732 __le32 p2p_client; 733 __le32 p2p_device; 734 __le32 ibss; 735 __le32 tdls; 736 __le32 reserved[4]; 737} __packed; 738 739/** 740 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger 741 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a 742 * trigger each time a time event notification that relates to time event 743 * id with one of the actions in the bitmap is received and 744 * BIT(notif->status) is set in status_bitmap. 745 * 746 */ 747struct iwl_fw_dbg_trigger_time_event { 748 struct { 749 __le32 id; 750 __le32 action_bitmap; 751 __le32 status_bitmap; 752 } __packed time_events[16]; 753} __packed; 754 755/** 756 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger 757 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur 758 * when an Rx BlockAck session is started. 759 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur 760 * when an Rx BlockAck session is stopped. 761 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur 762 * when a Tx BlockAck session is started. 763 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur 764 * when a Tx BlockAck session is stopped. 765 * rx_bar: tid bitmap to configure on what tid the trigger should occur 766 * when a BAR is received (for a Tx BlockAck session). 767 * tx_bar: tid bitmap to configure on what tid the trigger should occur 768 * when a BAR is send (for an Rx BlocAck session). 769 * frame_timeout: tid bitmap to configure on what tid the trigger should occur 770 * when a frame times out in the reodering buffer. 771 */ 772struct iwl_fw_dbg_trigger_ba { 773 __le16 rx_ba_start; 774 __le16 rx_ba_stop; 775 __le16 tx_ba_start; 776 __le16 tx_ba_stop; 777 __le16 rx_bar; 778 __le16 tx_bar; 779 __le16 frame_timeout; 780} __packed; 781 782/** 783 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events. 784 * @action_bitmap: the TDLS action to trigger the collection upon 785 * @peer_mode: trigger on specific peer or all 786 * @peer: the TDLS peer to trigger the collection on 787 */ 788struct iwl_fw_dbg_trigger_tdls { 789 u8 action_bitmap; 790 u8 peer_mode; 791 u8 peer[ETH_ALEN]; 792 u8 reserved[4]; 793} __packed; 794 795/** 796 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response 797 * status. 798 * @statuses: the list of statuses to trigger the collection on 799 */ 800struct iwl_fw_dbg_trigger_tx_status { 801 struct tx_status { 802 u8 status; 803 u8 reserved[3]; 804 } __packed statuses[16]; 805 __le32 reserved[2]; 806} __packed; 807 808/** 809 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration. 810 * @id: conf id 811 * @usniffer: should the uSniffer image be used 812 * @num_of_hcmds: how many HCMDs to send are present here 813 * @hcmd: a variable length host command to be sent to apply the configuration. 814 * If there is more than one HCMD to send, they will appear one after the 815 * other and be sent in the order that they appear in. 816 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to 817 * %FW_DBG_CONF_MAX configuration per run. 818 */ 819struct iwl_fw_dbg_conf_tlv { 820 u8 id; 821 u8 usniffer; 822 u8 reserved; 823 u8 num_of_hcmds; 824 struct iwl_fw_dbg_conf_hcmd hcmd; 825} __packed; 826 827/** 828 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW 829 * @max_scan_cache_size: total space allocated for scan results (in bytes). 830 * @max_scan_buckets: maximum number of channel buckets. 831 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan. 832 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI. 833 * @max_scan_reporting_threshold: max possible report threshold. in percentage. 834 * @max_hotlist_aps: maximum number of entries for hotlist APs. 835 * @max_significant_change_aps: maximum number of entries for significant 836 * change APs. 837 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can 838 * hold. 839 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs. 840 * @max_number_epno_networks: max number of epno entries. 841 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is 842 * specified. 843 * @max_number_of_white_listed_ssid: max number of white listed SSIDs. 844 * @max_number_of_black_listed_ssid: max number of black listed SSIDs. 845 */ 846struct iwl_fw_gscan_capabilities { 847 __le32 max_scan_cache_size; 848 __le32 max_scan_buckets; 849 __le32 max_ap_cache_per_scan; 850 __le32 max_rssi_sample_size; 851 __le32 max_scan_reporting_threshold; 852 __le32 max_hotlist_aps; 853 __le32 max_significant_change_aps; 854 __le32 max_bssid_history_entries; 855 __le32 max_hotlist_ssids; 856 __le32 max_number_epno_networks; 857 __le32 max_number_epno_networks_by_ssid; 858 __le32 max_number_of_white_listed_ssid; 859 __le32 max_number_of_black_listed_ssid; 860} __packed; 861 862#endif /* __iwl_fw_file_h__ */ 863