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 */ 74 struct 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 104 enum 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 148 struct 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 157 struct 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 */ 185 struct iwl_ucode_api { 186 __le32 api_index; 187 __le32 api_flags; 188 } __packed; 189 190 struct 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 */ 216 enum 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 231 typedef 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 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of 245 * ADD_MODIFY_STA_KEY_API_S_VER_2. 246 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement. 247 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2 248 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used 249 * @IWL_UCODE_TLV_API_ATS_COEX_EXTERNAL: the coex notification is enlared to 250 * include information about ACL time sharing. 251 * 252 * @NUM_IWL_UCODE_TLV_API: number of bits used 253 */ 254 enum iwl_ucode_tlv_api { 255 /* API Set 0 */ 256 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8, 257 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9, 258 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18, 259 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20, 260 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28, 261 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29, 262 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30, 263 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31, 264 /* API Set 1 */ 265 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34, 266 IWL_UCODE_TLV_API_NEW_RX_STATS = (__force iwl_ucode_tlv_api_t)35, 267 IWL_UCODE_TLV_API_COEX_ATS_EXTERNAL = (__force iwl_ucode_tlv_api_t)37, 268 269 NUM_IWL_UCODE_TLV_API 270 #ifdef __CHECKER__ 271 /* sparse says it cannot increment the previous enum member */ 272 = 128 273 #endif 274 }; 275 276 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t; 277 278 /** 279 * enum iwl_ucode_tlv_capa - ucode capabilities 280 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3 281 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory 282 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan. 283 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer 284 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM) 285 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality 286 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current 287 * tx power value into TPC Report action frame and Link Measurement Report 288 * action frame 289 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current 290 * channel in DS parameter set element in probe requests. 291 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in 292 * probe requests. 293 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests 294 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA), 295 * which also implies support for the scheduler configuration command 296 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching 297 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image 298 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command 299 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command 300 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload 301 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics 302 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it 303 * is standalone or with a BSS station interface in the same binding. 304 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running 305 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different 306 * sources for the MCC. This TLV bit is a future replacement to 307 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR 308 * is supported. 309 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC 310 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan 311 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification 312 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement 313 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts 314 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT 315 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA 316 * countdown offloading. Beacon notifications are not sent to the host. 317 * The fw also offloads TBTT alignment. 318 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what 319 * antenna the beacon should be transmitted 320 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon 321 * from AP and will send it upon d0i3 exit. 322 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2: support LAR API V2 323 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill 324 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature 325 * thresholds reporting 326 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command 327 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in 328 * regular image. 329 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared 330 * memory addresses from the firmware. 331 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement 332 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger 333 * command size (command version 4) that supports toggling ACK TX 334 * power reduction. 335 * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload 336 * 337 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used 338 */ 339 enum iwl_ucode_tlv_capa { 340 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0, 341 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1, 342 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2, 343 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3, 344 IWL_UCODE_TLV_CAPA_TOF_SUPPORT = (__force iwl_ucode_tlv_capa_t)5, 345 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6, 346 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8, 347 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9, 348 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10, 349 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11, 350 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12, 351 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13, 352 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17, 353 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18, 354 IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT = (__force iwl_ucode_tlv_capa_t)19, 355 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21, 356 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22, 357 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26, 358 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28, 359 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29, 360 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30, 361 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31, 362 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38, 363 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39, 364 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40, 365 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41, 366 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64, 367 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65, 368 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67, 369 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68, 370 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70, 371 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71, 372 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72, 373 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V2 = (__force iwl_ucode_tlv_capa_t)73, 374 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74, 375 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75, 376 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76, 377 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77, 378 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80, 379 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81, 380 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84, 381 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)86, 382 IWL_UCODE_TLV_CAPA_MLME_OFFLOAD = (__force iwl_ucode_tlv_capa_t)96, 383 384 NUM_IWL_UCODE_TLV_CAPA 385 #ifdef __CHECKER__ 386 /* sparse says it cannot increment the previous enum member */ 387 = 128 388 #endif 389 }; 390 391 /* The default calibrate table size if not specified by firmware file */ 392 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 393 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 394 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 395 396 /* The default max probe length if not specified by the firmware file */ 397 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200 398 399 /* 400 * For 16.0 uCode and above, there is no differentiation between sections, 401 * just an offset to the HW address. 402 */ 403 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC 404 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB 405 406 /* uCode version contains 4 values: Major/Minor/API/Serial */ 407 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 408 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 409 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 410 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 411 412 /** 413 * struct iwl_tlv_calib_ctrl - Calibration control struct. 414 * Sent as part of the phy configuration command. 415 * @flow_trigger: bitmap for which calibrations to perform according to 416 * flow triggers. 417 * @event_trigger: bitmap for which calibrations to perform according to 418 * event triggers. 419 */ 420 struct iwl_tlv_calib_ctrl { 421 __le32 flow_trigger; 422 __le32 event_trigger; 423 } __packed; 424 425 enum iwl_fw_phy_cfg { 426 FW_PHY_CFG_RADIO_TYPE_POS = 0, 427 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS, 428 FW_PHY_CFG_RADIO_STEP_POS = 2, 429 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS, 430 FW_PHY_CFG_RADIO_DASH_POS = 4, 431 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS, 432 FW_PHY_CFG_TX_CHAIN_POS = 16, 433 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS, 434 FW_PHY_CFG_RX_CHAIN_POS = 20, 435 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS, 436 }; 437 438 #define IWL_UCODE_MAX_CS 1 439 440 /** 441 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW. 442 * @cipher: a cipher suite selector 443 * @flags: cipher scheme flags (currently reserved for a future use) 444 * @hdr_len: a size of MPDU security header 445 * @pn_len: a size of PN 446 * @pn_off: an offset of pn from the beginning of the security header 447 * @key_idx_off: an offset of key index byte in the security header 448 * @key_idx_mask: a bit mask of key_idx bits 449 * @key_idx_shift: bit shift needed to get key_idx 450 * @mic_len: mic length in bytes 451 * @hw_cipher: a HW cipher index used in host commands 452 */ 453 struct iwl_fw_cipher_scheme { 454 __le32 cipher; 455 u8 flags; 456 u8 hdr_len; 457 u8 pn_len; 458 u8 pn_off; 459 u8 key_idx_off; 460 u8 key_idx_mask; 461 u8 key_idx_shift; 462 u8 mic_len; 463 u8 hw_cipher; 464 } __packed; 465 466 enum iwl_fw_dbg_reg_operator { 467 CSR_ASSIGN, 468 CSR_SETBIT, 469 CSR_CLEARBIT, 470 471 PRPH_ASSIGN, 472 PRPH_SETBIT, 473 PRPH_CLEARBIT, 474 475 INDIRECT_ASSIGN, 476 INDIRECT_SETBIT, 477 INDIRECT_CLEARBIT, 478 479 PRPH_BLOCKBIT, 480 }; 481 482 /** 483 * struct iwl_fw_dbg_reg_op - an operation on a register 484 * 485 * @op: &enum iwl_fw_dbg_reg_operator 486 * @addr: offset of the register 487 * @val: value 488 */ 489 struct iwl_fw_dbg_reg_op { 490 u8 op; 491 u8 reserved[3]; 492 __le32 addr; 493 __le32 val; 494 } __packed; 495 496 /** 497 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes 498 * 499 * @SMEM_MODE: monitor stores the data in SMEM 500 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM 501 * @MARBH_MODE: monitor stores the data in MARBH buffer 502 * @MIPI_MODE: monitor outputs the data through the MIPI interface 503 */ 504 enum iwl_fw_dbg_monitor_mode { 505 SMEM_MODE = 0, 506 EXTERNAL_MODE = 1, 507 MARBH_MODE = 2, 508 MIPI_MODE = 3, 509 }; 510 511 /** 512 * enum iwl_fw_mem_seg_type - memory segment type 513 * @FW_DBG_MEM_TYPE_MASK: mask for the type indication 514 * @FW_DBG_MEM_TYPE_REGULAR: regular memory 515 * @FW_DBG_MEM_TYPE_PRPH: periphery memory (requires special reading) 516 */ 517 enum iwl_fw_mem_seg_type { 518 FW_DBG_MEM_TYPE_MASK = 0xff000000, 519 FW_DBG_MEM_TYPE_REGULAR = 0x00000000, 520 FW_DBG_MEM_TYPE_PRPH = 0x01000000, 521 }; 522 523 /** 524 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments 525 * 526 * @data_type: the memory segment type to record, see &enum iwl_fw_mem_seg_type 527 * for what we care about 528 * @ofs: the memory segment offset 529 * @len: the memory segment length, in bytes 530 * 531 * This parses IWL_UCODE_TLV_FW_MEM_SEG 532 */ 533 struct iwl_fw_dbg_mem_seg_tlv { 534 __le32 data_type; 535 __le32 ofs; 536 __le32 len; 537 } __packed; 538 539 /** 540 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data 541 * 542 * @version: version of the TLV - currently 0 543 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode 544 * @size_power: buffer size will be 2^(size_power + 11) 545 * @base_reg: addr of the base addr register (PRPH) 546 * @end_reg: addr of the end addr register (PRPH) 547 * @write_ptr_reg: the addr of the reg of the write pointer 548 * @wrap_count: the addr of the reg of the wrap_count 549 * @base_shift: shift right of the base addr reg 550 * @end_shift: shift right of the end addr reg 551 * @reg_ops: array of registers operations 552 * 553 * This parses IWL_UCODE_TLV_FW_DBG_DEST 554 */ 555 struct iwl_fw_dbg_dest_tlv { 556 u8 version; 557 u8 monitor_mode; 558 u8 size_power; 559 u8 reserved; 560 __le32 base_reg; 561 __le32 end_reg; 562 __le32 write_ptr_reg; 563 __le32 wrap_count; 564 u8 base_shift; 565 u8 end_shift; 566 struct iwl_fw_dbg_reg_op reg_ops[0]; 567 } __packed; 568 569 struct iwl_fw_dbg_conf_hcmd { 570 u8 id; 571 u8 reserved; 572 __le16 len; 573 u8 data[0]; 574 } __packed; 575 576 /** 577 * enum iwl_fw_dbg_trigger_mode - triggers functionalities 578 * 579 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism 580 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data 581 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to 582 * collect only monitor data 583 */ 584 enum iwl_fw_dbg_trigger_mode { 585 IWL_FW_DBG_TRIGGER_START = BIT(0), 586 IWL_FW_DBG_TRIGGER_STOP = BIT(1), 587 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2), 588 }; 589 590 /** 591 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger 592 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type 593 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode 594 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode 595 * @IWL_FW_DBG_CONF_VIF_AP: AP mode 596 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode 597 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode 598 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device 599 */ 600 enum iwl_fw_dbg_trigger_vif_type { 601 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED, 602 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC, 603 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION, 604 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP, 605 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT, 606 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO, 607 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE, 608 }; 609 610 /** 611 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger 612 * @id: &enum iwl_fw_dbg_trigger 613 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type 614 * @stop_conf_ids: bitmap of configurations this trigger relates to. 615 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding 616 * to the currently running configuration is set, the data should be 617 * collected. 618 * @stop_delay: how many milliseconds to wait before collecting the data 619 * after the STOP trigger fires. 620 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both 621 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what 622 * configuration should be applied when the triggers kicks in. 623 * @occurrences: number of occurrences. 0 means the trigger will never fire. 624 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this 625 * trigger in which another occurrence should be ignored. 626 */ 627 struct iwl_fw_dbg_trigger_tlv { 628 __le32 id; 629 __le32 vif_type; 630 __le32 stop_conf_ids; 631 __le32 stop_delay; 632 u8 mode; 633 u8 start_conf_id; 634 __le16 occurrences; 635 __le16 trig_dis_ms; 636 __le16 reserved[3]; 637 638 u8 data[0]; 639 } __packed; 640 641 #define FW_DBG_START_FROM_ALIVE 0 642 #define FW_DBG_CONF_MAX 32 643 #define FW_DBG_INVALID 0xff 644 645 /** 646 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons 647 * @stop_consec_missed_bcon: stop recording if threshold is crossed. 648 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed. 649 * @start_consec_missed_bcon: start recording if threshold is crossed. 650 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed. 651 * @reserved1: reserved 652 * @reserved2: reserved 653 */ 654 struct iwl_fw_dbg_trigger_missed_bcon { 655 __le32 stop_consec_missed_bcon; 656 __le32 stop_consec_missed_bcon_since_rx; 657 __le32 reserved2[2]; 658 __le32 start_consec_missed_bcon; 659 __le32 start_consec_missed_bcon_since_rx; 660 __le32 reserved1[2]; 661 } __packed; 662 663 /** 664 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW. 665 * cmds: the list of commands to trigger the collection on 666 */ 667 struct iwl_fw_dbg_trigger_cmd { 668 struct cmd { 669 u8 cmd_id; 670 u8 group_id; 671 } __packed cmds[16]; 672 } __packed; 673 674 /** 675 * iwl_fw_dbg_trigger_stats - configures trigger for statistics 676 * @stop_offset: the offset of the value to be monitored 677 * @stop_threshold: the threshold above which to collect 678 * @start_offset: the offset of the value to be monitored 679 * @start_threshold: the threshold above which to start recording 680 */ 681 struct iwl_fw_dbg_trigger_stats { 682 __le32 stop_offset; 683 __le32 stop_threshold; 684 __le32 start_offset; 685 __le32 start_threshold; 686 } __packed; 687 688 /** 689 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI 690 * @rssi: RSSI value to trigger at 691 */ 692 struct iwl_fw_dbg_trigger_low_rssi { 693 __le32 rssi; 694 } __packed; 695 696 /** 697 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events 698 * @stop_auth_denied: number of denied authentication to collect 699 * @stop_auth_timeout: number of authentication timeout to collect 700 * @stop_rx_deauth: number of Rx deauth before to collect 701 * @stop_tx_deauth: number of Tx deauth before to collect 702 * @stop_assoc_denied: number of denied association to collect 703 * @stop_assoc_timeout: number of association timeout to collect 704 * @stop_connection_loss: number of connection loss to collect 705 * @start_auth_denied: number of denied authentication to start recording 706 * @start_auth_timeout: number of authentication timeout to start recording 707 * @start_rx_deauth: number of Rx deauth to start recording 708 * @start_tx_deauth: number of Tx deauth to start recording 709 * @start_assoc_denied: number of denied association to start recording 710 * @start_assoc_timeout: number of association timeout to start recording 711 * @start_connection_loss: number of connection loss to start recording 712 */ 713 struct iwl_fw_dbg_trigger_mlme { 714 u8 stop_auth_denied; 715 u8 stop_auth_timeout; 716 u8 stop_rx_deauth; 717 u8 stop_tx_deauth; 718 719 u8 stop_assoc_denied; 720 u8 stop_assoc_timeout; 721 u8 stop_connection_loss; 722 u8 reserved; 723 724 u8 start_auth_denied; 725 u8 start_auth_timeout; 726 u8 start_rx_deauth; 727 u8 start_tx_deauth; 728 729 u8 start_assoc_denied; 730 u8 start_assoc_timeout; 731 u8 start_connection_loss; 732 u8 reserved2; 733 } __packed; 734 735 /** 736 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer 737 * @command_queue: timeout for the command queue in ms 738 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms 739 * @softap: timeout for the queues of a softAP in ms 740 * @p2p_go: timeout for the queues of a P2P GO in ms 741 * @p2p_client: timeout for the queues of a P2P client in ms 742 * @p2p_device: timeout for the queues of a P2P device in ms 743 * @ibss: timeout for the queues of an IBSS in ms 744 * @tdls: timeout for the queues of a TDLS station in ms 745 */ 746 struct iwl_fw_dbg_trigger_txq_timer { 747 __le32 command_queue; 748 __le32 bss; 749 __le32 softap; 750 __le32 p2p_go; 751 __le32 p2p_client; 752 __le32 p2p_device; 753 __le32 ibss; 754 __le32 tdls; 755 __le32 reserved[4]; 756 } __packed; 757 758 /** 759 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger 760 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a 761 * trigger each time a time event notification that relates to time event 762 * id with one of the actions in the bitmap is received and 763 * BIT(notif->status) is set in status_bitmap. 764 * 765 */ 766 struct iwl_fw_dbg_trigger_time_event { 767 struct { 768 __le32 id; 769 __le32 action_bitmap; 770 __le32 status_bitmap; 771 } __packed time_events[16]; 772 } __packed; 773 774 /** 775 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger 776 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur 777 * when an Rx BlockAck session is started. 778 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur 779 * when an Rx BlockAck session is stopped. 780 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur 781 * when a Tx BlockAck session is started. 782 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur 783 * when a Tx BlockAck session is stopped. 784 * rx_bar: tid bitmap to configure on what tid the trigger should occur 785 * when a BAR is received (for a Tx BlockAck session). 786 * tx_bar: tid bitmap to configure on what tid the trigger should occur 787 * when a BAR is send (for an Rx BlocAck session). 788 * frame_timeout: tid bitmap to configure on what tid the trigger should occur 789 * when a frame times out in the reodering buffer. 790 */ 791 struct iwl_fw_dbg_trigger_ba { 792 __le16 rx_ba_start; 793 __le16 rx_ba_stop; 794 __le16 tx_ba_start; 795 __le16 tx_ba_stop; 796 __le16 rx_bar; 797 __le16 tx_bar; 798 __le16 frame_timeout; 799 } __packed; 800 801 /** 802 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events. 803 * @action_bitmap: the TDLS action to trigger the collection upon 804 * @peer_mode: trigger on specific peer or all 805 * @peer: the TDLS peer to trigger the collection on 806 */ 807 struct iwl_fw_dbg_trigger_tdls { 808 u8 action_bitmap; 809 u8 peer_mode; 810 u8 peer[ETH_ALEN]; 811 u8 reserved[4]; 812 } __packed; 813 814 /** 815 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response 816 * status. 817 * @statuses: the list of statuses to trigger the collection on 818 */ 819 struct iwl_fw_dbg_trigger_tx_status { 820 struct tx_status { 821 u8 status; 822 u8 reserved[3]; 823 } __packed statuses[16]; 824 __le32 reserved[2]; 825 } __packed; 826 827 /** 828 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration. 829 * @id: conf id 830 * @usniffer: should the uSniffer image be used 831 * @num_of_hcmds: how many HCMDs to send are present here 832 * @hcmd: a variable length host command to be sent to apply the configuration. 833 * If there is more than one HCMD to send, they will appear one after the 834 * other and be sent in the order that they appear in. 835 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to 836 * %FW_DBG_CONF_MAX configuration per run. 837 */ 838 struct iwl_fw_dbg_conf_tlv { 839 u8 id; 840 u8 usniffer; 841 u8 reserved; 842 u8 num_of_hcmds; 843 struct iwl_fw_dbg_conf_hcmd hcmd; 844 } __packed; 845 846 /** 847 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW 848 * @max_scan_cache_size: total space allocated for scan results (in bytes). 849 * @max_scan_buckets: maximum number of channel buckets. 850 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan. 851 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI. 852 * @max_scan_reporting_threshold: max possible report threshold. in percentage. 853 * @max_hotlist_aps: maximum number of entries for hotlist APs. 854 * @max_significant_change_aps: maximum number of entries for significant 855 * change APs. 856 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can 857 * hold. 858 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs. 859 * @max_number_epno_networks: max number of epno entries. 860 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is 861 * specified. 862 * @max_number_of_white_listed_ssid: max number of white listed SSIDs. 863 * @max_number_of_black_listed_ssid: max number of black listed SSIDs. 864 */ 865 struct iwl_fw_gscan_capabilities { 866 __le32 max_scan_cache_size; 867 __le32 max_scan_buckets; 868 __le32 max_ap_cache_per_scan; 869 __le32 max_rssi_sample_size; 870 __le32 max_scan_reporting_threshold; 871 __le32 max_hotlist_aps; 872 __le32 max_significant_change_aps; 873 __le32 max_bssid_history_entries; 874 __le32 max_hotlist_ssids; 875 __le32 max_number_epno_networks; 876 __le32 max_number_epno_networks_by_ssid; 877 __le32 max_number_of_white_listed_ssid; 878 __le32 max_number_of_black_listed_ssid; 879 } __packed; 880 881 #endif /* __iwl_fw_file_h__ */ 882