1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2008-2014, 2018-2024 Intel Corporation 4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016-2017 Intel Deutschland GmbH 6 */ 7 #ifndef __iwl_fw_file_h__ 8 #define __iwl_fw_file_h__ 9 10 #include <linux/netdevice.h> 11 #include <linux/nl80211.h> 12 13 /* v1/v2 uCode file layout */ 14 struct iwl_ucode_header { 15 __le32 ver; /* major/minor/API/serial */ 16 union { 17 struct { 18 __le32 inst_size; /* bytes of runtime code */ 19 __le32 data_size; /* bytes of runtime data */ 20 __le32 init_size; /* bytes of init code */ 21 __le32 init_data_size; /* bytes of init data */ 22 __le32 boot_size; /* bytes of bootstrap code */ 23 u8 data[]; /* in same order as sizes */ 24 } v1; 25 struct { 26 __le32 build; /* build number */ 27 __le32 inst_size; /* bytes of runtime code */ 28 __le32 data_size; /* bytes of runtime data */ 29 __le32 init_size; /* bytes of init code */ 30 __le32 init_data_size; /* bytes of init data */ 31 __le32 boot_size; /* bytes of bootstrap code */ 32 u8 data[]; /* in same order as sizes */ 33 } v2; 34 } u; 35 }; 36 37 #define IWL_UCODE_TLV_DEBUG_BASE 0x1000005 38 #define IWL_UCODE_TLV_CONST_BASE 0x100 39 40 /* 41 * new TLV uCode file layout 42 * 43 * The new TLV file format contains TLVs, that each specify 44 * some piece of data. 45 */ 46 47 enum iwl_ucode_tlv_type { 48 IWL_UCODE_TLV_INVALID = 0, /* unused */ 49 IWL_UCODE_TLV_INST = 1, 50 IWL_UCODE_TLV_DATA = 2, 51 IWL_UCODE_TLV_INIT = 3, 52 IWL_UCODE_TLV_INIT_DATA = 4, 53 IWL_UCODE_TLV_BOOT = 5, 54 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */ 55 IWL_UCODE_TLV_PAN = 7, /* deprecated -- only used in DVM */ 56 IWL_UCODE_TLV_MEM_DESC = 7, /* replaces PAN in non-DVM */ 57 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8, 58 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9, 59 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10, 60 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11, 61 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12, 62 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13, 63 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14, 64 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15, 65 IWL_UCODE_TLV_WOWLAN_INST = 16, 66 IWL_UCODE_TLV_WOWLAN_DATA = 17, 67 IWL_UCODE_TLV_FLAGS = 18, 68 IWL_UCODE_TLV_SEC_RT = 19, 69 IWL_UCODE_TLV_SEC_INIT = 20, 70 IWL_UCODE_TLV_SEC_WOWLAN = 21, 71 IWL_UCODE_TLV_DEF_CALIB = 22, 72 IWL_UCODE_TLV_PHY_SKU = 23, 73 IWL_UCODE_TLV_SECURE_SEC_RT = 24, 74 IWL_UCODE_TLV_SECURE_SEC_INIT = 25, 75 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26, 76 IWL_UCODE_TLV_NUM_OF_CPU = 27, 77 IWL_UCODE_TLV_CSCHEME = 28, 78 IWL_UCODE_TLV_API_CHANGES_SET = 29, 79 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30, 80 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31, 81 IWL_UCODE_TLV_PAGING = 32, 82 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34, 83 /* 35 is unused */ 84 IWL_UCODE_TLV_FW_VERSION = 36, 85 IWL_UCODE_TLV_FW_DBG_DEST = 38, 86 IWL_UCODE_TLV_FW_DBG_CONF = 39, 87 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40, 88 IWL_UCODE_TLV_CMD_VERSIONS = 48, 89 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50, 90 IWL_UCODE_TLV_FW_MEM_SEG = 51, 91 IWL_UCODE_TLV_IML = 52, 92 IWL_UCODE_TLV_UMAC_DEBUG_ADDRS = 54, 93 IWL_UCODE_TLV_LMAC_DEBUG_ADDRS = 55, 94 IWL_UCODE_TLV_FW_RECOVERY_INFO = 57, 95 IWL_UCODE_TLV_HW_TYPE = 58, 96 IWL_UCODE_TLV_FW_FSEQ_VERSION = 60, 97 IWL_UCODE_TLV_PHY_INTEGRATION_VERSION = 61, 98 99 IWL_UCODE_TLV_PNVM_VERSION = 62, 100 IWL_UCODE_TLV_PNVM_SKU = 64, 101 102 IWL_UCODE_TLV_SEC_TABLE_ADDR = 66, 103 IWL_UCODE_TLV_D3_KEK_KCK_ADDR = 67, 104 IWL_UCODE_TLV_CURRENT_PC = 68, 105 IWL_UCODE_TLV_FSEQ_BIN_VERSION = 72, 106 107 IWL_UCODE_TLV_FW_NUM_STATIONS = IWL_UCODE_TLV_CONST_BASE + 0, 108 IWL_UCODE_TLV_FW_NUM_LINKS = IWL_UCODE_TLV_CONST_BASE + 1, 109 IWL_UCODE_TLV_FW_NUM_BEACONS = IWL_UCODE_TLV_CONST_BASE + 2, 110 111 IWL_UCODE_TLV_TYPE_DEBUG_INFO = IWL_UCODE_TLV_DEBUG_BASE + 0, 112 IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION = IWL_UCODE_TLV_DEBUG_BASE + 1, 113 IWL_UCODE_TLV_TYPE_HCMD = IWL_UCODE_TLV_DEBUG_BASE + 2, 114 IWL_UCODE_TLV_TYPE_REGIONS = IWL_UCODE_TLV_DEBUG_BASE + 3, 115 IWL_UCODE_TLV_TYPE_TRIGGERS = IWL_UCODE_TLV_DEBUG_BASE + 4, 116 IWL_UCODE_TLV_TYPE_CONF_SET = IWL_UCODE_TLV_DEBUG_BASE + 5, 117 IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_TRIGGERS, 118 119 /* TLVs 0x1000-0x2000 are for internal driver usage */ 120 IWL_UCODE_TLV_FW_DBG_DUMP_LST = 0x1000, 121 }; 122 123 struct iwl_ucode_tlv { 124 __le32 type; /* see above */ 125 __le32 length; /* not including type/length fields */ 126 u8 data[]; 127 }; 128 129 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749 130 #define FW_VER_HUMAN_READABLE_SZ 64 131 132 struct iwl_tlv_ucode_header { 133 /* 134 * The TLV style ucode header is distinguished from 135 * the v1/v2 style header by first four bytes being 136 * zero, as such is an invalid combination of 137 * major/minor/API/serial versions. 138 */ 139 __le32 zero; 140 __le32 magic; 141 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 142 /* major/minor/API/serial or major in new format */ 143 __le32 ver; 144 __le32 build; 145 __le64 ignore; 146 /* 147 * The data contained herein has a TLV layout, 148 * see above for the TLV header and types. 149 * Note that each TLV is padded to a length 150 * that is a multiple of 4 for alignment. 151 */ 152 u8 data[]; 153 }; 154 155 /* 156 * ucode TLVs 157 * 158 * ability to get extension for: flags & capabilities from ucode binaries files 159 */ 160 struct iwl_ucode_api { 161 __le32 api_index; 162 __le32 api_flags; 163 } __packed; 164 165 struct iwl_ucode_capa { 166 __le32 api_index; 167 __le32 api_capa; 168 } __packed; 169 170 /** 171 * enum iwl_ucode_tlv_flag - ucode API flags 172 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously 173 * was a separate TLV but moved here to save space. 174 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID, 175 * treats good CRC threshold as a boolean 176 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w). 177 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD 178 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of block list instead of 64 in scan 179 * offload profile config command. 180 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six 181 * (rather than two) IPv6 addresses 182 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element 183 * from the probe request template. 184 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version) 185 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version) 186 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD 187 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save 188 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS. 189 */ 190 enum iwl_ucode_tlv_flag { 191 IWL_UCODE_TLV_FLAGS_PAN = BIT(0), 192 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1), 193 IWL_UCODE_TLV_FLAGS_MFP = BIT(2), 194 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7), 195 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10), 196 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12), 197 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15), 198 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16), 199 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24), 200 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25), 201 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26), 202 }; 203 204 typedef unsigned int __bitwise iwl_ucode_tlv_api_t; 205 206 /** 207 * enum iwl_ucode_tlv_api - ucode api 208 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time 209 * longer than the passive one, which is essential for fragmented scan. 210 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source. 211 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params 212 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format 213 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan 214 * iteration complete notification, and the timestamp reported for RX 215 * received during scan, are reported in TSF of the mac specified in the 216 * scan request. 217 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of 218 * ADD_MODIFY_STA_KEY_API_S_VER_2. 219 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement. 220 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2 221 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL: support for adaptive dwell in scanning 222 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used 223 * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field 224 * indicating low latency direction. 225 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is 226 * deprecated. 227 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8 228 * of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8 229 * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS 230 * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of 231 * the REDUCE_TX_POWER_CMD. 232 * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short 233 * version of the beacon notification. 234 * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of 235 * BEACON_FILTER_CONFIG_API_S_VER_4. 236 * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of 237 * REGULATORY_NVM_GET_INFO_RSP_API_S. 238 * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of 239 * LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S. 240 * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of 241 * SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of 242 * SCAN_OFFLOAD_PROFILES_QUERY_RSP_S. 243 * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of 244 * STA_CONTEXT_DOT11AX_API_S 245 * @IWL_UCODE_TLV_API_FTM_RTT_ACCURACY: version 7 of the range response API 246 * is supported by FW, this indicates the RTT confidence value 247 * @IWL_UCODE_TLV_API_SAR_TABLE_VER: This ucode supports different sar 248 * version tables. 249 * @IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG: This ucode supports v3 of 250 * SCAN_CONFIG_DB_CMD_API_S. 251 * @IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP: support for setting adaptive dwell 252 * number of APs in the 5 GHz band 253 * @IWL_UCODE_TLV_API_BAND_IN_RX_DATA: FW reports band number in RX notification 254 * @IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX: Firmware offloaded the station disable tx 255 * logic. 256 * @IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR: Firmware supports clearing the debug 257 * internal buffer 258 * @IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD: Firmware doesn't need the host to 259 * configure the smart fifo 260 * 261 * @NUM_IWL_UCODE_TLV_API: number of bits used 262 */ 263 enum iwl_ucode_tlv_api { 264 /* API Set 0 */ 265 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8, 266 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9, 267 IWL_UCODE_TLV_API_LQ_SS_PARAMS = (__force iwl_ucode_tlv_api_t)18, 268 IWL_UCODE_TLV_API_NEW_VERSION = (__force iwl_ucode_tlv_api_t)20, 269 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28, 270 IWL_UCODE_TLV_API_TKIP_MIC_KEYS = (__force iwl_ucode_tlv_api_t)29, 271 IWL_UCODE_TLV_API_STA_TYPE = (__force iwl_ucode_tlv_api_t)30, 272 IWL_UCODE_TLV_API_NAN2_VER2 = (__force iwl_ucode_tlv_api_t)31, 273 /* API Set 1 */ 274 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32, 275 IWL_UCODE_TLV_API_OCE = (__force iwl_ucode_tlv_api_t)33, 276 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34, 277 IWL_UCODE_TLV_API_NEW_RX_STATS = (__force iwl_ucode_tlv_api_t)35, 278 IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL = (__force iwl_ucode_tlv_api_t)36, 279 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38, 280 IWL_UCODE_TLV_API_DEPRECATE_TTAK = (__force iwl_ucode_tlv_api_t)41, 281 IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42, 282 IWL_UCODE_TLV_API_FRAG_EBS = (__force iwl_ucode_tlv_api_t)44, 283 IWL_UCODE_TLV_API_REDUCE_TX_POWER = (__force iwl_ucode_tlv_api_t)45, 284 IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF = (__force iwl_ucode_tlv_api_t)46, 285 IWL_UCODE_TLV_API_BEACON_FILTER_V4 = (__force iwl_ucode_tlv_api_t)47, 286 IWL_UCODE_TLV_API_REGULATORY_NVM_INFO = (__force iwl_ucode_tlv_api_t)48, 287 IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ = (__force iwl_ucode_tlv_api_t)49, 288 IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS = (__force iwl_ucode_tlv_api_t)50, 289 IWL_UCODE_TLV_API_MBSSID_HE = (__force iwl_ucode_tlv_api_t)52, 290 IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE = (__force iwl_ucode_tlv_api_t)53, 291 IWL_UCODE_TLV_API_FTM_RTT_ACCURACY = (__force iwl_ucode_tlv_api_t)54, 292 IWL_UCODE_TLV_API_SAR_TABLE_VER = (__force iwl_ucode_tlv_api_t)55, 293 IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG = (__force iwl_ucode_tlv_api_t)56, 294 IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP = (__force iwl_ucode_tlv_api_t)57, 295 IWL_UCODE_TLV_API_SCAN_EXT_CHAN_VER = (__force iwl_ucode_tlv_api_t)58, 296 IWL_UCODE_TLV_API_BAND_IN_RX_DATA = (__force iwl_ucode_tlv_api_t)59, 297 /* API Set 2 */ 298 IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX = (__force iwl_ucode_tlv_api_t)66, 299 IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR = (__force iwl_ucode_tlv_api_t)67, 300 IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD = (__force iwl_ucode_tlv_api_t)68, 301 302 NUM_IWL_UCODE_TLV_API 303 /* 304 * This construction make both sparse (which cannot increment the previous 305 * member due to its bitwise type) and kernel-doc (which doesn't understand 306 * the ifdef/else properly) work. 307 */ 308 #ifdef __CHECKER__ 309 #define __CHECKER_NUM_IWL_UCODE_TLV_API 128 310 = (__force iwl_ucode_tlv_api_t)__CHECKER_NUM_IWL_UCODE_TLV_API, 311 #define NUM_IWL_UCODE_TLV_API __CHECKER_NUM_IWL_UCODE_TLV_API 312 #endif 313 }; 314 315 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t; 316 317 /** 318 * enum iwl_ucode_tlv_capa - ucode capabilities 319 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3 320 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory 321 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan. 322 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer 323 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality 324 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current 325 * tx power value into TPC Report action frame and Link Measurement Report 326 * action frame 327 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current 328 * channel in DS parameter set element in probe requests. 329 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in 330 * probe requests. 331 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests 332 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA), 333 * which also implies support for the scheduler configuration command 334 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching 335 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image 336 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command 337 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload 338 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics 339 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it 340 * is standalone or with a BSS station interface in the same binding. 341 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running 342 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different 343 * sources for the MCC. This TLV bit is a future replacement to 344 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR 345 * is supported. 346 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC 347 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used) 348 * @IWL_UCODE_TLV_CAPA_FRAGMENTED_PNVM_IMG: supports fragmented PNVM image 349 * @IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT: the firmware supports setting 350 * stabilization latency for SoCs. 351 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification 352 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm 353 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related 354 * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2 355 * IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command 356 * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band 357 * (6 GHz). 358 * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command 359 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement 360 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts 361 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT 362 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA 363 * countdown offloading. Beacon notifications are not sent to the host. 364 * The fw also offloads TBTT alignment. 365 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what 366 * antenna the beacon should be transmitted 367 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon 368 * from AP and will send it upon d0i3 exit. 369 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3 370 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill 371 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature 372 * thresholds reporting 373 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command 374 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in 375 * regular image. 376 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared 377 * memory addresses from the firmware. 378 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement 379 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger 380 * command size (command version 4) that supports toggling ACK TX 381 * power reduction. 382 * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3 383 * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax 384 * capability. 385 * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured 386 * to report the CSI information with (certain) RX frames 387 * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both 388 * initiator and responder 389 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA: supports (de)activating UNII-4 390 * for US/CA/WW from BIOS 391 * @IWL_UCODE_TLV_CAPA_PROTECTED_TWT: Supports protection of TWT action frames 392 * @IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE: Supports the firmware handshake in 393 * reset flow 394 * @IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN: Support for passive scan on 6GHz PSC 395 * channels even when these are not enabled. 396 * @IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT: Support for indicating dump collection 397 * complete to FW. 398 * @IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT: Support SPP (signaling and payload 399 * protected) A-MSDU. 400 * @IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT: Support secure LTF measurement. 401 * @IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS: Support monitor mode on otherwise 402 * passive channels 403 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA: supports (de)activating 5G9 404 * for CA from BIOS. 405 * @IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT: supports %TAS_UHB_ALLOWED_CANADA 406 * @IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT: external FSEQ image support 407 * 408 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used 409 */ 410 enum iwl_ucode_tlv_capa { 411 /* set 0 */ 412 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = (__force iwl_ucode_tlv_capa_t)0, 413 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = (__force iwl_ucode_tlv_capa_t)1, 414 IWL_UCODE_TLV_CAPA_UMAC_SCAN = (__force iwl_ucode_tlv_capa_t)2, 415 IWL_UCODE_TLV_CAPA_BEAMFORMER = (__force iwl_ucode_tlv_capa_t)3, 416 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = (__force iwl_ucode_tlv_capa_t)6, 417 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8, 418 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9, 419 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10, 420 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = (__force iwl_ucode_tlv_capa_t)11, 421 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = (__force iwl_ucode_tlv_capa_t)12, 422 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = (__force iwl_ucode_tlv_capa_t)13, 423 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG = (__force iwl_ucode_tlv_capa_t)17, 424 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = (__force iwl_ucode_tlv_capa_t)18, 425 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT = (__force iwl_ucode_tlv_capa_t)21, 426 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = (__force iwl_ucode_tlv_capa_t)22, 427 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD = (__force iwl_ucode_tlv_capa_t)26, 428 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = (__force iwl_ucode_tlv_capa_t)28, 429 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = (__force iwl_ucode_tlv_capa_t)29, 430 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = (__force iwl_ucode_tlv_capa_t)30, 431 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)31, 432 433 /* set 1 */ 434 IWL_UCODE_TLV_CAPA_FRAGMENTED_PNVM_IMG = (__force iwl_ucode_tlv_capa_t)32, 435 IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT = (__force iwl_ucode_tlv_capa_t)37, 436 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF = (__force iwl_ucode_tlv_capa_t)38, 437 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)39, 438 IWL_UCODE_TLV_CAPA_CDB_SUPPORT = (__force iwl_ucode_tlv_capa_t)40, 439 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST = (__force iwl_ucode_tlv_capa_t)41, 440 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD = (__force iwl_ucode_tlv_capa_t)43, 441 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA = (__force iwl_ucode_tlv_capa_t)44, 442 IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2 = (__force iwl_ucode_tlv_capa_t)45, 443 IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD = (__force iwl_ucode_tlv_capa_t)46, 444 IWL_UCODE_TLV_CAPA_FTM_CALIBRATED = (__force iwl_ucode_tlv_capa_t)47, 445 IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS = (__force iwl_ucode_tlv_capa_t)48, 446 IWL_UCODE_TLV_CAPA_CS_MODIFY = (__force iwl_ucode_tlv_capa_t)49, 447 IWL_UCODE_TLV_CAPA_SET_LTR_GEN2 = (__force iwl_ucode_tlv_capa_t)50, 448 IWL_UCODE_TLV_CAPA_SET_PPAG = (__force iwl_ucode_tlv_capa_t)52, 449 IWL_UCODE_TLV_CAPA_TAS_CFG = (__force iwl_ucode_tlv_capa_t)53, 450 IWL_UCODE_TLV_CAPA_SESSION_PROT_CMD = (__force iwl_ucode_tlv_capa_t)54, 451 IWL_UCODE_TLV_CAPA_PROTECTED_TWT = (__force iwl_ucode_tlv_capa_t)56, 452 IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE = (__force iwl_ucode_tlv_capa_t)57, 453 IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN = (__force iwl_ucode_tlv_capa_t)58, 454 IWL_UCODE_TLV_CAPA_HIDDEN_6GHZ_SCAN = (__force iwl_ucode_tlv_capa_t)59, 455 IWL_UCODE_TLV_CAPA_BROADCAST_TWT = (__force iwl_ucode_tlv_capa_t)60, 456 IWL_UCODE_TLV_CAPA_COEX_HIGH_PRIO = (__force iwl_ucode_tlv_capa_t)61, 457 IWL_UCODE_TLV_CAPA_RFIM_SUPPORT = (__force iwl_ucode_tlv_capa_t)62, 458 IWL_UCODE_TLV_CAPA_BAID_ML_SUPPORT = (__force iwl_ucode_tlv_capa_t)63, 459 460 /* set 2 */ 461 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE = (__force iwl_ucode_tlv_capa_t)64, 462 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS = (__force iwl_ucode_tlv_capa_t)65, 463 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT = (__force iwl_ucode_tlv_capa_t)67, 464 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68, 465 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD = (__force iwl_ucode_tlv_capa_t)70, 466 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION = (__force iwl_ucode_tlv_capa_t)71, 467 IWL_UCODE_TLV_CAPA_BEACON_STORING = (__force iwl_ucode_tlv_capa_t)72, 468 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3 = (__force iwl_ucode_tlv_capa_t)73, 469 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW = (__force iwl_ucode_tlv_capa_t)74, 470 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75, 471 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT = (__force iwl_ucode_tlv_capa_t)76, 472 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED = (__force iwl_ucode_tlv_capa_t)77, 473 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80, 474 IWL_UCODE_TLV_CAPA_LQM_SUPPORT = (__force iwl_ucode_tlv_capa_t)81, 475 IWL_UCODE_TLV_CAPA_TX_POWER_ACK = (__force iwl_ucode_tlv_capa_t)84, 476 IWL_UCODE_TLV_CAPA_D3_DEBUG = (__force iwl_ucode_tlv_capa_t)87, 477 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT = (__force iwl_ucode_tlv_capa_t)88, 478 IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT = (__force iwl_ucode_tlv_capa_t)89, 479 IWL_UCODE_TLV_CAPA_CSI_REPORTING = (__force iwl_ucode_tlv_capa_t)90, 480 IWL_UCODE_TLV_CAPA_DBG_SUSPEND_RESUME_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)92, 481 IWL_UCODE_TLV_CAPA_DBG_BUF_ALLOC_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)93, 482 483 /* set 3 */ 484 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA = (__force iwl_ucode_tlv_capa_t)96, 485 486 /* 487 * @IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT: supports PSC channels 488 */ 489 IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT = (__force iwl_ucode_tlv_capa_t)98, 490 491 IWL_UCODE_TLV_CAPA_BIGTK_SUPPORT = (__force iwl_ucode_tlv_capa_t)100, 492 IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT = (__force iwl_ucode_tlv_capa_t)103, 493 IWL_UCODE_TLV_CAPA_DRAM_FRAG_SUPPORT = (__force iwl_ucode_tlv_capa_t)104, 494 IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT = (__force iwl_ucode_tlv_capa_t)105, 495 IWL_UCODE_TLV_CAPA_SYNCED_TIME = (__force iwl_ucode_tlv_capa_t)106, 496 IWL_UCODE_TLV_CAPA_TIME_SYNC_BOTH_FTM_TM = (__force iwl_ucode_tlv_capa_t)108, 497 IWL_UCODE_TLV_CAPA_BIGTK_TX_SUPPORT = (__force iwl_ucode_tlv_capa_t)109, 498 IWL_UCODE_TLV_CAPA_MLD_API_SUPPORT = (__force iwl_ucode_tlv_capa_t)110, 499 IWL_UCODE_TLV_CAPA_SCAN_DONT_TOGGLE_ANT = (__force iwl_ucode_tlv_capa_t)111, 500 IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT = (__force iwl_ucode_tlv_capa_t)112, 501 IWL_UCODE_TLV_CAPA_OFFLOAD_BTM_SUPPORT = (__force iwl_ucode_tlv_capa_t)113, 502 IWL_UCODE_TLV_CAPA_STA_EXP_MFP_SUPPORT = (__force iwl_ucode_tlv_capa_t)114, 503 IWL_UCODE_TLV_CAPA_SNIFF_VALIDATE_SUPPORT = (__force iwl_ucode_tlv_capa_t)116, 504 IWL_UCODE_TLV_CAPA_CHINA_22_REG_SUPPORT = (__force iwl_ucode_tlv_capa_t)117, 505 IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT = (__force iwl_ucode_tlv_capa_t)121, 506 IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS = (__force iwl_ucode_tlv_capa_t)122, 507 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA = (__force iwl_ucode_tlv_capa_t)123, 508 IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT = (__force iwl_ucode_tlv_capa_t)124, 509 IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT = (__force iwl_ucode_tlv_capa_t)125, 510 511 /* set 4 */ 512 /** 513 * @IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT: FW reset handshake is needed 514 * during assert handling even if the dump isn't split 515 */ 516 IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT = (__force iwl_ucode_tlv_capa_t)(4 * 32 + 0), 517 NUM_IWL_UCODE_TLV_CAPA 518 /* 519 * This construction make both sparse (which cannot increment the previous 520 * member due to its bitwise type) and kernel-doc (which doesn't understand 521 * the ifdef/else properly) work. 522 */ 523 #ifdef __CHECKER__ 524 #define __CHECKER_NUM_IWL_UCODE_TLV_CAPA 128 525 = (__force iwl_ucode_tlv_capa_t)__CHECKER_NUM_IWL_UCODE_TLV_CAPA, 526 #define NUM_IWL_UCODE_TLV_CAPA __CHECKER_NUM_IWL_UCODE_TLV_CAPA 527 #endif 528 }; 529 530 /* The default calibrate table size if not specified by firmware file */ 531 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 532 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 533 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 534 535 /* The default max probe length if not specified by the firmware file */ 536 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200 537 538 /* 539 * For 16.0 uCode and above, there is no differentiation between sections, 540 * just an offset to the HW address. 541 */ 542 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC 543 #define PAGING_SEPARATOR_SECTION 0xAAAABBBB 544 545 /* uCode version contains 4 values: Major/Minor/API/Serial */ 546 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 547 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 548 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 549 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 550 551 /** 552 * struct iwl_tlv_calib_ctrl - Calibration control struct. 553 * Sent as part of the phy configuration command. 554 * @flow_trigger: bitmap for which calibrations to perform according to 555 * flow triggers. 556 * @event_trigger: bitmap for which calibrations to perform according to 557 * event triggers. 558 */ 559 struct iwl_tlv_calib_ctrl { 560 __le32 flow_trigger; 561 __le32 event_trigger; 562 } __packed; 563 564 enum iwl_fw_phy_cfg { 565 FW_PHY_CFG_RADIO_TYPE_POS = 0, 566 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS, 567 FW_PHY_CFG_RADIO_STEP_POS = 2, 568 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS, 569 FW_PHY_CFG_RADIO_DASH_POS = 4, 570 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS, 571 FW_PHY_CFG_TX_CHAIN_POS = 16, 572 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS, 573 FW_PHY_CFG_RX_CHAIN_POS = 20, 574 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS, 575 FW_PHY_CFG_CHAIN_SAD_POS = 23, 576 FW_PHY_CFG_CHAIN_SAD_ENABLED = 0x1 << FW_PHY_CFG_CHAIN_SAD_POS, 577 FW_PHY_CFG_CHAIN_SAD_ANT_A = 0x2 << FW_PHY_CFG_CHAIN_SAD_POS, 578 FW_PHY_CFG_CHAIN_SAD_ANT_B = 0x4 << FW_PHY_CFG_CHAIN_SAD_POS, 579 FW_PHY_CFG_SHARED_CLK = BIT(31), 580 }; 581 582 enum iwl_fw_dbg_reg_operator { 583 CSR_ASSIGN, 584 CSR_SETBIT, 585 CSR_CLEARBIT, 586 587 PRPH_ASSIGN, 588 PRPH_SETBIT, 589 PRPH_CLEARBIT, 590 591 INDIRECT_ASSIGN, 592 INDIRECT_SETBIT, 593 INDIRECT_CLEARBIT, 594 595 PRPH_BLOCKBIT, 596 }; 597 598 /** 599 * struct iwl_fw_dbg_reg_op - an operation on a register 600 * 601 * @op: &enum iwl_fw_dbg_reg_operator 602 * @reserved: reserved 603 * @addr: offset of the register 604 * @val: value 605 */ 606 struct iwl_fw_dbg_reg_op { 607 u8 op; 608 u8 reserved[3]; 609 __le32 addr; 610 __le32 val; 611 } __packed; 612 613 /** 614 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes 615 * 616 * @SMEM_MODE: monitor stores the data in SMEM 617 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM 618 * @MARBH_MODE: monitor stores the data in MARBH buffer 619 * @MIPI_MODE: monitor outputs the data through the MIPI interface 620 */ 621 enum iwl_fw_dbg_monitor_mode { 622 SMEM_MODE = 0, 623 EXTERNAL_MODE = 1, 624 MARBH_MODE = 2, 625 MIPI_MODE = 3, 626 }; 627 628 /** 629 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments 630 * 631 * @data_type: the memory segment type to record 632 * @ofs: the memory segment offset 633 * @len: the memory segment length, in bytes 634 * 635 * This parses IWL_UCODE_TLV_FW_MEM_SEG 636 */ 637 struct iwl_fw_dbg_mem_seg_tlv { 638 __le32 data_type; 639 __le32 ofs; 640 __le32 len; 641 } __packed; 642 643 /** 644 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data 645 * 646 * @version: version of the TLV - currently 0 647 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode 648 * @size_power: buffer size will be 2^(size_power + 11) 649 * @reserved: reserved 650 * @base_reg: addr of the base addr register (PRPH) 651 * @end_reg: addr of the end addr register (PRPH) 652 * @write_ptr_reg: the addr of the reg of the write pointer 653 * @wrap_count: the addr of the reg of the wrap_count 654 * @base_shift: shift right of the base addr reg 655 * @end_shift: shift right of the end addr reg 656 * @reg_ops: array of registers operations 657 * 658 * This parses IWL_UCODE_TLV_FW_DBG_DEST 659 */ 660 struct iwl_fw_dbg_dest_tlv_v1 { 661 u8 version; 662 u8 monitor_mode; 663 u8 size_power; 664 u8 reserved; 665 __le32 base_reg; 666 __le32 end_reg; 667 __le32 write_ptr_reg; 668 __le32 wrap_count; 669 u8 base_shift; 670 u8 end_shift; 671 struct iwl_fw_dbg_reg_op reg_ops[]; 672 } __packed; 673 674 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */ 675 #define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000 676 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */ 677 #define IWL_LDBG_M2S_BUF_BA_MSK 0x00000fff 678 /* The smem buffer chunks are in units of 256 bits */ 679 #define IWL_M2S_UNIT_SIZE 0x100 680 681 struct iwl_fw_dbg_dest_tlv { 682 u8 version; 683 u8 monitor_mode; 684 u8 size_power; 685 u8 reserved; 686 __le32 cfg_reg; 687 __le32 write_ptr_reg; 688 __le32 wrap_count; 689 u8 base_shift; 690 u8 size_shift; 691 struct iwl_fw_dbg_reg_op reg_ops[]; 692 } __packed; 693 694 struct iwl_fw_dbg_conf_hcmd { 695 u8 id; 696 u8 reserved; 697 __le16 len; 698 u8 data[]; 699 } __packed; 700 701 /** 702 * enum iwl_fw_dbg_trigger_mode - triggers functionalities 703 * 704 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism 705 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data 706 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to 707 * collect only monitor data 708 */ 709 enum iwl_fw_dbg_trigger_mode { 710 IWL_FW_DBG_TRIGGER_START = BIT(0), 711 IWL_FW_DBG_TRIGGER_STOP = BIT(1), 712 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2), 713 }; 714 715 /** 716 * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers 717 * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart 718 */ 719 enum iwl_fw_dbg_trigger_flags { 720 IWL_FW_DBG_FORCE_RESTART = BIT(0), 721 }; 722 723 /** 724 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger 725 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type 726 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode 727 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode 728 * @IWL_FW_DBG_CONF_VIF_AP: AP mode 729 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode 730 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode 731 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device 732 */ 733 enum iwl_fw_dbg_trigger_vif_type { 734 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED, 735 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC, 736 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION, 737 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP, 738 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT, 739 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO, 740 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE, 741 }; 742 743 /** 744 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger 745 * @id: &enum iwl_fw_dbg_trigger 746 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type 747 * @stop_conf_ids: bitmap of configurations this trigger relates to. 748 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding 749 * to the currently running configuration is set, the data should be 750 * collected. 751 * @stop_delay: how many milliseconds to wait before collecting the data 752 * after the STOP trigger fires. 753 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both 754 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what 755 * configuration should be applied when the triggers kicks in. 756 * @occurrences: number of occurrences. 0 means the trigger will never fire. 757 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this 758 * trigger in which another occurrence should be ignored. 759 * @flags: &enum iwl_fw_dbg_trigger_flags 760 * @reserved: reserved (for alignment) 761 * @data: trigger data 762 */ 763 struct iwl_fw_dbg_trigger_tlv { 764 __le32 id; 765 __le32 vif_type; 766 __le32 stop_conf_ids; 767 __le32 stop_delay; 768 u8 mode; 769 u8 start_conf_id; 770 __le16 occurrences; 771 __le16 trig_dis_ms; 772 u8 flags; 773 u8 reserved[5]; 774 775 u8 data[]; 776 } __packed; 777 778 #define FW_DBG_START_FROM_ALIVE 0 779 #define FW_DBG_CONF_MAX 32 780 #define FW_DBG_INVALID 0xff 781 782 /** 783 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons 784 * @stop_consec_missed_bcon: stop recording if threshold is crossed. 785 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed. 786 * @start_consec_missed_bcon: start recording if threshold is crossed. 787 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed. 788 * @reserved1: reserved 789 * @reserved2: reserved 790 */ 791 struct iwl_fw_dbg_trigger_missed_bcon { 792 __le32 stop_consec_missed_bcon; 793 __le32 stop_consec_missed_bcon_since_rx; 794 __le32 reserved2[2]; 795 __le32 start_consec_missed_bcon; 796 __le32 start_consec_missed_bcon_since_rx; 797 __le32 reserved1[2]; 798 } __packed; 799 800 /** 801 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW. 802 * @cmds: the list of commands to trigger the collection on 803 */ 804 struct iwl_fw_dbg_trigger_cmd { 805 struct cmd { 806 u8 cmd_id; 807 u8 group_id; 808 } __packed cmds[16]; 809 } __packed; 810 811 /** 812 * struct iwl_fw_dbg_trigger_stats - configures trigger for statistics 813 * @stop_offset: the offset of the value to be monitored 814 * @stop_threshold: the threshold above which to collect 815 * @start_offset: the offset of the value to be monitored 816 * @start_threshold: the threshold above which to start recording 817 */ 818 struct iwl_fw_dbg_trigger_stats { 819 __le32 stop_offset; 820 __le32 stop_threshold; 821 __le32 start_offset; 822 __le32 start_threshold; 823 } __packed; 824 825 /** 826 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI 827 * @rssi: RSSI value to trigger at 828 */ 829 struct iwl_fw_dbg_trigger_low_rssi { 830 __le32 rssi; 831 } __packed; 832 833 /** 834 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events 835 * @stop_auth_denied: number of denied authentication to collect 836 * @stop_auth_timeout: number of authentication timeout to collect 837 * @stop_rx_deauth: number of Rx deauth before to collect 838 * @stop_tx_deauth: number of Tx deauth before to collect 839 * @stop_assoc_denied: number of denied association to collect 840 * @stop_assoc_timeout: number of association timeout to collect 841 * @stop_connection_loss: number of connection loss to collect 842 * @start_auth_denied: number of denied authentication to start recording 843 * @start_auth_timeout: number of authentication timeout to start recording 844 * @start_rx_deauth: number of Rx deauth to start recording 845 * @start_tx_deauth: number of Tx deauth to start recording 846 * @start_assoc_denied: number of denied association to start recording 847 * @start_assoc_timeout: number of association timeout to start recording 848 * @start_connection_loss: number of connection loss to start recording 849 */ 850 struct iwl_fw_dbg_trigger_mlme { 851 u8 stop_auth_denied; 852 u8 stop_auth_timeout; 853 u8 stop_rx_deauth; 854 u8 stop_tx_deauth; 855 856 u8 stop_assoc_denied; 857 u8 stop_assoc_timeout; 858 u8 stop_connection_loss; 859 u8 reserved; 860 861 u8 start_auth_denied; 862 u8 start_auth_timeout; 863 u8 start_rx_deauth; 864 u8 start_tx_deauth; 865 866 u8 start_assoc_denied; 867 u8 start_assoc_timeout; 868 u8 start_connection_loss; 869 u8 reserved2; 870 } __packed; 871 872 /** 873 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer 874 * @command_queue: timeout for the command queue in ms 875 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms 876 * @softap: timeout for the queues of a softAP in ms 877 * @p2p_go: timeout for the queues of a P2P GO in ms 878 * @p2p_client: timeout for the queues of a P2P client in ms 879 * @p2p_device: timeout for the queues of a P2P device in ms 880 * @ibss: timeout for the queues of an IBSS in ms 881 * @tdls: timeout for the queues of a TDLS station in ms 882 */ 883 struct iwl_fw_dbg_trigger_txq_timer { 884 __le32 command_queue; 885 __le32 bss; 886 __le32 softap; 887 __le32 p2p_go; 888 __le32 p2p_client; 889 __le32 p2p_device; 890 __le32 ibss; 891 __le32 tdls; 892 __le32 reserved[4]; 893 } __packed; 894 895 /** 896 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger 897 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a 898 * trigger each time a time event notification that relates to time event 899 * id with one of the actions in the bitmap is received and 900 * BIT(notif->status) is set in status_bitmap. 901 * 902 */ 903 struct iwl_fw_dbg_trigger_time_event { 904 struct { 905 __le32 id; 906 __le32 action_bitmap; 907 __le32 status_bitmap; 908 } __packed time_events[16]; 909 } __packed; 910 911 /** 912 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger 913 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur 914 * when an Rx BlockAck session is started. 915 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur 916 * when an Rx BlockAck session is stopped. 917 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur 918 * when a Tx BlockAck session is started. 919 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur 920 * when a Tx BlockAck session is stopped. 921 * rx_bar: tid bitmap to configure on what tid the trigger should occur 922 * when a BAR is received (for a Tx BlockAck session). 923 * tx_bar: tid bitmap to configure on what tid the trigger should occur 924 * when a BAR is send (for an Rx BlocAck session). 925 * frame_timeout: tid bitmap to configure on what tid the trigger should occur 926 * when a frame times out in the reordering buffer. 927 */ 928 struct iwl_fw_dbg_trigger_ba { 929 __le16 rx_ba_start; 930 __le16 rx_ba_stop; 931 __le16 tx_ba_start; 932 __le16 tx_ba_stop; 933 __le16 rx_bar; 934 __le16 tx_bar; 935 __le16 frame_timeout; 936 } __packed; 937 938 /** 939 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events. 940 * @action_bitmap: the TDLS action to trigger the collection upon 941 * @peer_mode: trigger on specific peer or all 942 * @peer: the TDLS peer to trigger the collection on 943 */ 944 struct iwl_fw_dbg_trigger_tdls { 945 u8 action_bitmap; 946 u8 peer_mode; 947 u8 peer[ETH_ALEN]; 948 u8 reserved[4]; 949 } __packed; 950 951 /** 952 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response 953 * status. 954 * @statuses: the list of statuses to trigger the collection on 955 */ 956 struct iwl_fw_dbg_trigger_tx_status { 957 struct tx_status { 958 u8 status; 959 u8 reserved[3]; 960 } __packed statuses[16]; 961 __le32 reserved[2]; 962 } __packed; 963 964 /** 965 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration. 966 * @id: conf id 967 * @usniffer: should the uSniffer image be used 968 * @num_of_hcmds: how many HCMDs to send are present here 969 * @hcmd: a variable length host command to be sent to apply the configuration. 970 * If there is more than one HCMD to send, they will appear one after the 971 * other and be sent in the order that they appear in. 972 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to 973 * %FW_DBG_CONF_MAX configuration per run. 974 */ 975 struct iwl_fw_dbg_conf_tlv { 976 u8 id; 977 u8 usniffer; 978 u8 reserved; 979 u8 num_of_hcmds; 980 struct iwl_fw_dbg_conf_hcmd hcmd; 981 } __packed; 982 983 #define IWL_FW_CMD_VER_UNKNOWN 99 984 985 /** 986 * struct iwl_fw_cmd_version - firmware command version entry 987 * @cmd: command ID 988 * @group: group ID 989 * @cmd_ver: command version 990 * @notif_ver: notification version 991 */ 992 struct iwl_fw_cmd_version { 993 u8 cmd; 994 u8 group; 995 u8 cmd_ver; 996 u8 notif_ver; 997 } __packed; 998 999 struct iwl_fw_tcm_error_addr { 1000 __le32 addr; 1001 }; /* FW_TLV_TCM_ERROR_INFO_ADDRS_S */ 1002 1003 struct iwl_fw_dump_exclude { 1004 __le32 addr, size; 1005 }; 1006 1007 struct iwl_fw_fseq_bin_version { 1008 __le32 major, minor; 1009 }; /* FW_TLV_FSEQ_BIN_VERSION_S */ 1010 1011 static inline size_t _iwl_tlv_array_len(const struct iwl_ucode_tlv *tlv, 1012 size_t fixed_size, size_t var_size) 1013 { 1014 size_t var_len = le32_to_cpu(tlv->length) - fixed_size; 1015 1016 if (WARN_ON(var_len % var_size)) 1017 return 0; 1018 1019 return var_len / var_size; 1020 } 1021 1022 #define iwl_tlv_array_len(_tlv_ptr, _struct_ptr, _memb) \ 1023 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)), \ 1024 sizeof(_struct_ptr->_memb[0])) 1025 1026 #define iwl_tlv_array_len_with_size(_tlv_ptr, _struct_ptr, _size) \ 1027 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)), _size) 1028 1029 /* external FSEQ file */ 1030 #define IWL_FSEQ_FILE "intel/fseq-%04x-%04x" 1031 #define IWL_FSEQ_MAGIC "INTEL-CNV-FSEQ\n\0" 1032 1033 struct iwl_fseq_file { 1034 char magic[16]; 1035 char version[16]; 1036 __le32 bt_len; 1037 __le32 wifi_len; 1038 u8 reserved[8]; 1039 u8 data[]; 1040 } __packed; 1041 1042 #endif /* __iwl_fw_file_h__ */ 1043