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 - 2014 Intel Mobile Communications GmbH 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 23 * USA 24 * 25 * The full GNU General Public License is included in this distribution 26 * in the file called COPYING. 27 * 28 * Contact Information: 29 * Intel Linux Wireless <ilw@linux.intel.com> 30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 31 * 32 * BSD LICENSE 33 * 34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. 35 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 42 * * Redistributions of source code must retain the above copyright 43 * notice, this list of conditions and the following disclaimer. 44 * * Redistributions in binary form must reproduce the above copyright 45 * notice, this list of conditions and the following disclaimer in 46 * the documentation and/or other materials provided with the 47 * distribution. 48 * * Neither the name Intel Corporation nor the names of its 49 * contributors may be used to endorse or promote products derived 50 * from this software without specific prior written permission. 51 * 52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 63 *****************************************************************************/ 64 65 #ifndef __iwl_fw_file_h__ 66 #define __iwl_fw_file_h__ 67 68 #include <linux/netdevice.h> 69 #include <linux/nl80211.h> 70 71 /* v1/v2 uCode file layout */ 72 struct iwl_ucode_header { 73 __le32 ver; /* major/minor/API/serial */ 74 union { 75 struct { 76 __le32 inst_size; /* bytes of runtime code */ 77 __le32 data_size; /* bytes of runtime data */ 78 __le32 init_size; /* bytes of init code */ 79 __le32 init_data_size; /* bytes of init data */ 80 __le32 boot_size; /* bytes of bootstrap code */ 81 u8 data[0]; /* in same order as sizes */ 82 } v1; 83 struct { 84 __le32 build; /* build number */ 85 __le32 inst_size; /* bytes of runtime code */ 86 __le32 data_size; /* bytes of runtime data */ 87 __le32 init_size; /* bytes of init code */ 88 __le32 init_data_size; /* bytes of init data */ 89 __le32 boot_size; /* bytes of bootstrap code */ 90 u8 data[0]; /* in same order as sizes */ 91 } v2; 92 } u; 93 }; 94 95 /* 96 * new TLV uCode file layout 97 * 98 * The new TLV file format contains TLVs, that each specify 99 * some piece of data. 100 */ 101 102 enum iwl_ucode_tlv_type { 103 IWL_UCODE_TLV_INVALID = 0, /* unused */ 104 IWL_UCODE_TLV_INST = 1, 105 IWL_UCODE_TLV_DATA = 2, 106 IWL_UCODE_TLV_INIT = 3, 107 IWL_UCODE_TLV_INIT_DATA = 4, 108 IWL_UCODE_TLV_BOOT = 5, 109 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */ 110 IWL_UCODE_TLV_PAN = 7, 111 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8, 112 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9, 113 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10, 114 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11, 115 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12, 116 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13, 117 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14, 118 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15, 119 IWL_UCODE_TLV_WOWLAN_INST = 16, 120 IWL_UCODE_TLV_WOWLAN_DATA = 17, 121 IWL_UCODE_TLV_FLAGS = 18, 122 IWL_UCODE_TLV_SEC_RT = 19, 123 IWL_UCODE_TLV_SEC_INIT = 20, 124 IWL_UCODE_TLV_SEC_WOWLAN = 21, 125 IWL_UCODE_TLV_DEF_CALIB = 22, 126 IWL_UCODE_TLV_PHY_SKU = 23, 127 IWL_UCODE_TLV_SECURE_SEC_RT = 24, 128 IWL_UCODE_TLV_SECURE_SEC_INIT = 25, 129 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26, 130 IWL_UCODE_TLV_NUM_OF_CPU = 27, 131 IWL_UCODE_TLV_CSCHEME = 28, 132 IWL_UCODE_TLV_API_CHANGES_SET = 29, 133 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30, 134 IWL_UCODE_TLV_N_SCAN_CHANNELS = 31, 135 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34, 136 IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35, 137 IWL_UCODE_TLV_FW_VERSION = 36, 138 IWL_UCODE_TLV_FW_DBG_DEST = 38, 139 IWL_UCODE_TLV_FW_DBG_CONF = 39, 140 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40, 141 }; 142 143 struct iwl_ucode_tlv { 144 __le32 type; /* see above */ 145 __le32 length; /* not including type/length fields */ 146 u8 data[0]; 147 }; 148 149 #define IWL_TLV_UCODE_MAGIC 0x0a4c5749 150 #define FW_VER_HUMAN_READABLE_SZ 64 151 152 struct iwl_tlv_ucode_header { 153 /* 154 * The TLV style ucode header is distinguished from 155 * the v1/v2 style header by first four bytes being 156 * zero, as such is an invalid combination of 157 * major/minor/API/serial versions. 158 */ 159 __le32 zero; 160 __le32 magic; 161 u8 human_readable[FW_VER_HUMAN_READABLE_SZ]; 162 /* major/minor/API/serial or major in new format */ 163 __le32 ver; 164 __le32 build; 165 __le64 ignore; 166 /* 167 * The data contained herein has a TLV layout, 168 * see above for the TLV header and types. 169 * Note that each TLV is padded to a length 170 * that is a multiple of 4 for alignment. 171 */ 172 u8 data[0]; 173 }; 174 175 /* 176 * ucode TLVs 177 * 178 * ability to get extension for: flags & capabilities from ucode binaries files 179 */ 180 struct iwl_ucode_api { 181 __le32 api_index; 182 __le32 api_flags; 183 } __packed; 184 185 struct iwl_ucode_capa { 186 __le32 api_index; 187 __le32 api_capa; 188 } __packed; 189 190 /** 191 * enum iwl_ucode_tlv_flag - ucode API flags 192 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously 193 * was a separate TLV but moved here to save space. 194 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID, 195 * treats good CRC threshold as a boolean 196 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w). 197 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P. 198 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS 199 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD 200 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan 201 * offload profile config command. 202 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six 203 * (rather than two) IPv6 addresses 204 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element 205 * from the probe request template. 206 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version) 207 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version) 208 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC 209 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and 210 * P2P client interfaces simultaneously if they are in different bindings. 211 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and 212 * P2P client interfaces simultaneously if they are in same bindings. 213 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD 214 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save 215 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering. 216 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients 217 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS. 218 */ 219 enum iwl_ucode_tlv_flag { 220 IWL_UCODE_TLV_FLAGS_PAN = BIT(0), 221 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1), 222 IWL_UCODE_TLV_FLAGS_MFP = BIT(2), 223 IWL_UCODE_TLV_FLAGS_P2P = BIT(3), 224 IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4), 225 IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7), 226 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10), 227 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12), 228 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15), 229 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16), 230 IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21), 231 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22), 232 IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23), 233 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24), 234 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25), 235 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26), 236 IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29), 237 IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30), 238 }; 239 240 /** 241 * enum iwl_ucode_tlv_api - ucode api 242 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex 243 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time 244 * longer than the passive one, which is essential for fragmented scan. 245 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source. 246 * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR 247 * @IWL_UCODE_TLV_API_TX_POWER_DEV: new API for tx power. 248 * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command, 249 * regardless of the band or the number of the probes. FW will calculate 250 * the actual dwell time. 251 * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler 252 * through the dedicated host command. 253 * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too. 254 * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported. 255 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params 256 * @IWL_UCODE_TLV_API_STATS_V10: uCode supports/uses statistics API version 10 257 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format 258 */ 259 enum iwl_ucode_tlv_api { 260 IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3), 261 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8), 262 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = BIT(9), 263 IWL_UCODE_TLV_API_HDC_PHASE_0 = BIT(10), 264 IWL_UCODE_TLV_API_TX_POWER_DEV = BIT(11), 265 IWL_UCODE_TLV_API_BASIC_DWELL = BIT(13), 266 IWL_UCODE_TLV_API_SCD_CFG = BIT(15), 267 IWL_UCODE_TLV_API_SINGLE_SCAN_EBS = BIT(16), 268 IWL_UCODE_TLV_API_ASYNC_DTM = BIT(17), 269 IWL_UCODE_TLV_API_LQ_SS_PARAMS = BIT(18), 270 IWL_UCODE_TLV_API_STATS_V10 = BIT(19), 271 IWL_UCODE_TLV_API_NEW_VERSION = BIT(20), 272 }; 273 274 /** 275 * enum iwl_ucode_tlv_capa - ucode capabilities 276 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3 277 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory 278 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan. 279 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer 280 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality 281 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current 282 * tx power value into TPC Report action frame and Link Measurement Report 283 * action frame 284 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current 285 * channel in DS parameter set element in probe requests. 286 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in 287 * probe requests. 288 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests 289 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA), 290 * which also implies support for the scheduler configuration command 291 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching 292 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command 293 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics 294 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running 295 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different 296 * sources for the MCC. This TLV bit is a future replacement to 297 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR 298 * is supported. 299 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC 300 */ 301 enum iwl_ucode_tlv_capa { 302 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0), 303 IWL_UCODE_TLV_CAPA_LAR_SUPPORT = BIT(1), 304 IWL_UCODE_TLV_CAPA_UMAC_SCAN = BIT(2), 305 IWL_UCODE_TLV_CAPA_BEAMFORMER = BIT(3), 306 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = BIT(6), 307 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = BIT(8), 308 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = BIT(9), 309 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = BIT(10), 310 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = BIT(11), 311 IWL_UCODE_TLV_CAPA_DQA_SUPPORT = BIT(12), 312 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = BIT(13), 313 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = BIT(18), 314 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS = BIT(22), 315 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR = BIT(28), 316 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC = BIT(29), 317 IWL_UCODE_TLV_CAPA_BT_COEX_RRC = BIT(30), 318 }; 319 320 /* The default calibrate table size if not specified by firmware file */ 321 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 322 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19 323 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253 324 325 /* The default max probe length if not specified by the firmware file */ 326 #define IWL_DEFAULT_MAX_PROBE_LENGTH 200 327 328 /* 329 * For 16.0 uCode and above, there is no differentiation between sections, 330 * just an offset to the HW address. 331 */ 332 #define IWL_UCODE_SECTION_MAX 12 333 #define IWL_API_ARRAY_SIZE 1 334 #define IWL_CAPABILITIES_ARRAY_SIZE 1 335 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC 336 337 /* uCode version contains 4 values: Major/Minor/API/Serial */ 338 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24) 339 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16) 340 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8) 341 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF) 342 343 /* 344 * Calibration control struct. 345 * Sent as part of the phy configuration command. 346 * @flow_trigger: bitmap for which calibrations to perform according to 347 * flow triggers. 348 * @event_trigger: bitmap for which calibrations to perform according to 349 * event triggers. 350 */ 351 struct iwl_tlv_calib_ctrl { 352 __le32 flow_trigger; 353 __le32 event_trigger; 354 } __packed; 355 356 enum iwl_fw_phy_cfg { 357 FW_PHY_CFG_RADIO_TYPE_POS = 0, 358 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS, 359 FW_PHY_CFG_RADIO_STEP_POS = 2, 360 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS, 361 FW_PHY_CFG_RADIO_DASH_POS = 4, 362 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS, 363 FW_PHY_CFG_TX_CHAIN_POS = 16, 364 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS, 365 FW_PHY_CFG_RX_CHAIN_POS = 20, 366 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS, 367 }; 368 369 #define IWL_UCODE_MAX_CS 1 370 371 /** 372 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW. 373 * @cipher: a cipher suite selector 374 * @flags: cipher scheme flags (currently reserved for a future use) 375 * @hdr_len: a size of MPDU security header 376 * @pn_len: a size of PN 377 * @pn_off: an offset of pn from the beginning of the security header 378 * @key_idx_off: an offset of key index byte in the security header 379 * @key_idx_mask: a bit mask of key_idx bits 380 * @key_idx_shift: bit shift needed to get key_idx 381 * @mic_len: mic length in bytes 382 * @hw_cipher: a HW cipher index used in host commands 383 */ 384 struct iwl_fw_cipher_scheme { 385 __le32 cipher; 386 u8 flags; 387 u8 hdr_len; 388 u8 pn_len; 389 u8 pn_off; 390 u8 key_idx_off; 391 u8 key_idx_mask; 392 u8 key_idx_shift; 393 u8 mic_len; 394 u8 hw_cipher; 395 } __packed; 396 397 enum iwl_fw_dbg_reg_operator { 398 CSR_ASSIGN, 399 CSR_SETBIT, 400 CSR_CLEARBIT, 401 402 PRPH_ASSIGN, 403 PRPH_SETBIT, 404 PRPH_CLEARBIT, 405 }; 406 407 /** 408 * struct iwl_fw_dbg_reg_op - an operation on a register 409 * 410 * @op: %enum iwl_fw_dbg_reg_operator 411 * @addr: offset of the register 412 * @val: value 413 */ 414 struct iwl_fw_dbg_reg_op { 415 u8 op; 416 u8 reserved[3]; 417 __le32 addr; 418 __le32 val; 419 } __packed; 420 421 /** 422 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes 423 * 424 * @SMEM_MODE: monitor stores the data in SMEM 425 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM 426 * @MARBH_MODE: monitor stores the data in MARBH buffer 427 */ 428 enum iwl_fw_dbg_monitor_mode { 429 SMEM_MODE = 0, 430 EXTERNAL_MODE = 1, 431 MARBH_MODE = 2, 432 }; 433 434 /** 435 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data 436 * 437 * @version: version of the TLV - currently 0 438 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode 439 * @base_reg: addr of the base addr register (PRPH) 440 * @end_reg: addr of the end addr register (PRPH) 441 * @write_ptr_reg: the addr of the reg of the write pointer 442 * @wrap_count: the addr of the reg of the wrap_count 443 * @base_shift: shift right of the base addr reg 444 * @end_shift: shift right of the end addr reg 445 * @reg_ops: array of registers operations 446 * 447 * This parses IWL_UCODE_TLV_FW_DBG_DEST 448 */ 449 struct iwl_fw_dbg_dest_tlv { 450 u8 version; 451 u8 monitor_mode; 452 u8 reserved[2]; 453 __le32 base_reg; 454 __le32 end_reg; 455 __le32 write_ptr_reg; 456 __le32 wrap_count; 457 u8 base_shift; 458 u8 end_shift; 459 struct iwl_fw_dbg_reg_op reg_ops[0]; 460 } __packed; 461 462 struct iwl_fw_dbg_conf_hcmd { 463 u8 id; 464 u8 reserved; 465 __le16 len; 466 u8 data[0]; 467 } __packed; 468 469 /** 470 * enum iwl_fw_dbg_trigger_mode - triggers functionalities 471 * 472 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism 473 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data 474 */ 475 enum iwl_fw_dbg_trigger_mode { 476 IWL_FW_DBG_TRIGGER_START = BIT(0), 477 IWL_FW_DBG_TRIGGER_STOP = BIT(1), 478 }; 479 480 /** 481 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger 482 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type 483 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode 484 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode 485 * @IWL_FW_DBG_CONF_VIF_AP: AP mode 486 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode 487 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode 488 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device 489 */ 490 enum iwl_fw_dbg_trigger_vif_type { 491 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED, 492 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC, 493 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION, 494 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP, 495 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT, 496 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO, 497 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE, 498 }; 499 500 /** 501 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger 502 * @id: %enum iwl_fw_dbg_trigger 503 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type 504 * @stop_conf_ids: bitmap of configurations this trigger relates to. 505 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding 506 * to the currently running configuration is set, the data should be 507 * collected. 508 * @stop_delay: how many milliseconds to wait before collecting the data 509 * after the STOP trigger fires. 510 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both 511 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what 512 * configuration should be applied when the triggers kicks in. 513 * @occurrences: number of occurrences. 0 means the trigger will never fire. 514 */ 515 struct iwl_fw_dbg_trigger_tlv { 516 __le32 id; 517 __le32 vif_type; 518 __le32 stop_conf_ids; 519 __le32 stop_delay; 520 u8 mode; 521 u8 start_conf_id; 522 __le16 occurrences; 523 __le32 reserved[2]; 524 525 u8 data[0]; 526 } __packed; 527 528 #define FW_DBG_START_FROM_ALIVE 0 529 #define FW_DBG_CONF_MAX 32 530 #define FW_DBG_INVALID 0xff 531 532 /** 533 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons 534 * @stop_consec_missed_bcon: stop recording if threshold is crossed. 535 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed. 536 * @start_consec_missed_bcon: start recording if threshold is crossed. 537 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed. 538 * @reserved1: reserved 539 * @reserved2: reserved 540 */ 541 struct iwl_fw_dbg_trigger_missed_bcon { 542 __le32 stop_consec_missed_bcon; 543 __le32 stop_consec_missed_bcon_since_rx; 544 __le32 reserved2[2]; 545 __le32 start_consec_missed_bcon; 546 __le32 start_consec_missed_bcon_since_rx; 547 __le32 reserved1[2]; 548 } __packed; 549 550 /** 551 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW. 552 * cmds: the list of commands to trigger the collection on 553 */ 554 struct iwl_fw_dbg_trigger_cmd { 555 struct cmd { 556 u8 cmd_id; 557 u8 group_id; 558 } __packed cmds[16]; 559 } __packed; 560 561 /** 562 * iwl_fw_dbg_trigger_stats - configures trigger for statistics 563 * @stop_offset: the offset of the value to be monitored 564 * @stop_threshold: the threshold above which to collect 565 * @start_offset: the offset of the value to be monitored 566 * @start_threshold: the threshold above which to start recording 567 */ 568 struct iwl_fw_dbg_trigger_stats { 569 __le32 stop_offset; 570 __le32 stop_threshold; 571 __le32 start_offset; 572 __le32 start_threshold; 573 } __packed; 574 575 /** 576 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI 577 * @rssi: RSSI value to trigger at 578 */ 579 struct iwl_fw_dbg_trigger_low_rssi { 580 __le32 rssi; 581 } __packed; 582 583 /** 584 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events 585 * @stop_auth_denied: number of denied authentication to collect 586 * @stop_auth_timeout: number of authentication timeout to collect 587 * @stop_rx_deauth: number of Rx deauth before to collect 588 * @stop_tx_deauth: number of Tx deauth before to collect 589 * @stop_assoc_denied: number of denied association to collect 590 * @stop_assoc_timeout: number of association timeout to collect 591 * @stop_connection_loss: number of connection loss to collect 592 * @start_auth_denied: number of denied authentication to start recording 593 * @start_auth_timeout: number of authentication timeout to start recording 594 * @start_rx_deauth: number of Rx deauth to start recording 595 * @start_tx_deauth: number of Tx deauth to start recording 596 * @start_assoc_denied: number of denied association to start recording 597 * @start_assoc_timeout: number of association timeout to start recording 598 * @start_connection_loss: number of connection loss to start recording 599 */ 600 struct iwl_fw_dbg_trigger_mlme { 601 u8 stop_auth_denied; 602 u8 stop_auth_timeout; 603 u8 stop_rx_deauth; 604 u8 stop_tx_deauth; 605 606 u8 stop_assoc_denied; 607 u8 stop_assoc_timeout; 608 u8 stop_connection_loss; 609 u8 reserved; 610 611 u8 start_auth_denied; 612 u8 start_auth_timeout; 613 u8 start_rx_deauth; 614 u8 start_tx_deauth; 615 616 u8 start_assoc_denied; 617 u8 start_assoc_timeout; 618 u8 start_connection_loss; 619 u8 reserved2; 620 } __packed; 621 622 /** 623 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer 624 * @command_queue: timeout for the command queue in ms 625 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms 626 * @softap: timeout for the queues of a softAP in ms 627 * @p2p_go: timeout for the queues of a P2P GO in ms 628 * @p2p_client: timeout for the queues of a P2P client in ms 629 * @p2p_device: timeout for the queues of a P2P device in ms 630 * @ibss: timeout for the queues of an IBSS in ms 631 * @tdls: timeout for the queues of a TDLS station in ms 632 */ 633 struct iwl_fw_dbg_trigger_txq_timer { 634 __le32 command_queue; 635 __le32 bss; 636 __le32 softap; 637 __le32 p2p_go; 638 __le32 p2p_client; 639 __le32 p2p_device; 640 __le32 ibss; 641 __le32 tdls; 642 __le32 reserved[4]; 643 } __packed; 644 645 /** 646 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger 647 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a 648 * trigger each time a time event notification that relates to time event 649 * id with one of the actions in the bitmap is received and 650 * BIT(notif->status) is set in status_bitmap. 651 * 652 */ 653 struct iwl_fw_dbg_trigger_time_event { 654 struct { 655 __le32 id; 656 __le32 action_bitmap; 657 __le32 status_bitmap; 658 } __packed time_events[16]; 659 } __packed; 660 661 /** 662 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration. 663 * @id: conf id 664 * @usniffer: should the uSniffer image be used 665 * @num_of_hcmds: how many HCMDs to send are present here 666 * @hcmd: a variable length host command to be sent to apply the configuration. 667 * If there is more than one HCMD to send, they will appear one after the 668 * other and be sent in the order that they appear in. 669 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to 670 * %FW_DBG_CONF_MAX configuration per run. 671 */ 672 struct iwl_fw_dbg_conf_tlv { 673 u8 id; 674 u8 usniffer; 675 u8 reserved; 676 u8 num_of_hcmds; 677 struct iwl_fw_dbg_conf_hcmd hcmd; 678 } __packed; 679 680 #endif /* __iwl_fw_file_h__ */ 681