Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
0002 /*
0003  * Copyright (C) 2008-2014, 2018-2021 Intel Corporation
0004  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
0005  * Copyright (C) 2016-2017 Intel Deutschland GmbH
0006  */
0007 #ifndef __iwl_fw_file_h__
0008 #define __iwl_fw_file_h__
0009 
0010 #include <linux/netdevice.h>
0011 #include <linux/nl80211.h>
0012 
0013 /* v1/v2 uCode file layout */
0014 struct iwl_ucode_header {
0015     __le32 ver; /* major/minor/API/serial */
0016     union {
0017         struct {
0018             __le32 inst_size;   /* bytes of runtime code */
0019             __le32 data_size;   /* bytes of runtime data */
0020             __le32 init_size;   /* bytes of init code */
0021             __le32 init_data_size;  /* bytes of init data */
0022             __le32 boot_size;   /* bytes of bootstrap code */
0023             u8 data[0];     /* in same order as sizes */
0024         } v1;
0025         struct {
0026             __le32 build;       /* build number */
0027             __le32 inst_size;   /* bytes of runtime code */
0028             __le32 data_size;   /* bytes of runtime data */
0029             __le32 init_size;   /* bytes of init code */
0030             __le32 init_data_size;  /* bytes of init data */
0031             __le32 boot_size;   /* bytes of bootstrap code */
0032             u8 data[0];     /* in same order as sizes */
0033         } v2;
0034     } u;
0035 };
0036 
0037 #define IWL_UCODE_TLV_DEBUG_BASE    0x1000005
0038 #define IWL_UCODE_TLV_CONST_BASE    0x100
0039 
0040 /*
0041  * new TLV uCode file layout
0042  *
0043  * The new TLV file format contains TLVs, that each specify
0044  * some piece of data.
0045  */
0046 
0047 enum iwl_ucode_tlv_type {
0048     IWL_UCODE_TLV_INVALID       = 0, /* unused */
0049     IWL_UCODE_TLV_INST      = 1,
0050     IWL_UCODE_TLV_DATA      = 2,
0051     IWL_UCODE_TLV_INIT      = 3,
0052     IWL_UCODE_TLV_INIT_DATA     = 4,
0053     IWL_UCODE_TLV_BOOT      = 5,
0054     IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
0055     IWL_UCODE_TLV_PAN       = 7, /* deprecated -- only used in DVM */
0056     IWL_UCODE_TLV_MEM_DESC      = 7, /* replaces PAN in non-DVM */
0057     IWL_UCODE_TLV_RUNT_EVTLOG_PTR   = 8,
0058     IWL_UCODE_TLV_RUNT_EVTLOG_SIZE  = 9,
0059     IWL_UCODE_TLV_RUNT_ERRLOG_PTR   = 10,
0060     IWL_UCODE_TLV_INIT_EVTLOG_PTR   = 11,
0061     IWL_UCODE_TLV_INIT_EVTLOG_SIZE  = 12,
0062     IWL_UCODE_TLV_INIT_ERRLOG_PTR   = 13,
0063     IWL_UCODE_TLV_ENHANCE_SENS_TBL  = 14,
0064     IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
0065     IWL_UCODE_TLV_WOWLAN_INST   = 16,
0066     IWL_UCODE_TLV_WOWLAN_DATA   = 17,
0067     IWL_UCODE_TLV_FLAGS     = 18,
0068     IWL_UCODE_TLV_SEC_RT        = 19,
0069     IWL_UCODE_TLV_SEC_INIT      = 20,
0070     IWL_UCODE_TLV_SEC_WOWLAN    = 21,
0071     IWL_UCODE_TLV_DEF_CALIB     = 22,
0072     IWL_UCODE_TLV_PHY_SKU       = 23,
0073     IWL_UCODE_TLV_SECURE_SEC_RT = 24,
0074     IWL_UCODE_TLV_SECURE_SEC_INIT   = 25,
0075     IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
0076     IWL_UCODE_TLV_NUM_OF_CPU    = 27,
0077     IWL_UCODE_TLV_CSCHEME       = 28,
0078     IWL_UCODE_TLV_API_CHANGES_SET   = 29,
0079     IWL_UCODE_TLV_ENABLED_CAPABILITIES  = 30,
0080     IWL_UCODE_TLV_N_SCAN_CHANNELS       = 31,
0081     IWL_UCODE_TLV_PAGING        = 32,
0082     IWL_UCODE_TLV_SEC_RT_USNIFFER   = 34,
0083     /* 35 is unused */
0084     IWL_UCODE_TLV_FW_VERSION    = 36,
0085     IWL_UCODE_TLV_FW_DBG_DEST   = 38,
0086     IWL_UCODE_TLV_FW_DBG_CONF   = 39,
0087     IWL_UCODE_TLV_FW_DBG_TRIGGER    = 40,
0088     IWL_UCODE_TLV_CMD_VERSIONS  = 48,
0089     IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
0090     IWL_UCODE_TLV_FW_MEM_SEG    = 51,
0091     IWL_UCODE_TLV_IML       = 52,
0092     IWL_UCODE_TLV_UMAC_DEBUG_ADDRS  = 54,
0093     IWL_UCODE_TLV_LMAC_DEBUG_ADDRS  = 55,
0094     IWL_UCODE_TLV_FW_RECOVERY_INFO  = 57,
0095     IWL_UCODE_TLV_HW_TYPE           = 58,
0096     IWL_UCODE_TLV_FW_FSEQ_VERSION       = 60,
0097     IWL_UCODE_TLV_PHY_INTEGRATION_VERSION   = 61,
0098 
0099     IWL_UCODE_TLV_PNVM_VERSION      = 62,
0100     IWL_UCODE_TLV_PNVM_SKU          = 64,
0101 
0102     IWL_UCODE_TLV_SEC_TABLE_ADDR        = 66,
0103     IWL_UCODE_TLV_D3_KEK_KCK_ADDR       = 67,
0104 
0105     IWL_UCODE_TLV_FW_NUM_STATIONS       = IWL_UCODE_TLV_CONST_BASE + 0,
0106 
0107     IWL_UCODE_TLV_TYPE_DEBUG_INFO       = IWL_UCODE_TLV_DEBUG_BASE + 0,
0108     IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION    = IWL_UCODE_TLV_DEBUG_BASE + 1,
0109     IWL_UCODE_TLV_TYPE_HCMD         = IWL_UCODE_TLV_DEBUG_BASE + 2,
0110     IWL_UCODE_TLV_TYPE_REGIONS      = IWL_UCODE_TLV_DEBUG_BASE + 3,
0111     IWL_UCODE_TLV_TYPE_TRIGGERS     = IWL_UCODE_TLV_DEBUG_BASE + 4,
0112     IWL_UCODE_TLV_TYPE_CONF_SET     = IWL_UCODE_TLV_DEBUG_BASE + 5,
0113     IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_TRIGGERS,
0114 
0115     /* TLVs 0x1000-0x2000 are for internal driver usage */
0116     IWL_UCODE_TLV_FW_DBG_DUMP_LST   = 0x1000,
0117 };
0118 
0119 struct iwl_ucode_tlv {
0120     __le32 type;        /* see above */
0121     __le32 length;      /* not including type/length fields */
0122     u8 data[];
0123 };
0124 
0125 #define IWL_TLV_UCODE_MAGIC     0x0a4c5749
0126 #define FW_VER_HUMAN_READABLE_SZ    64
0127 
0128 struct iwl_tlv_ucode_header {
0129     /*
0130      * The TLV style ucode header is distinguished from
0131      * the v1/v2 style header by first four bytes being
0132      * zero, as such is an invalid combination of
0133      * major/minor/API/serial versions.
0134      */
0135     __le32 zero;
0136     __le32 magic;
0137     u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
0138     /* major/minor/API/serial or major in new format */
0139     __le32 ver;
0140     __le32 build;
0141     __le64 ignore;
0142     /*
0143      * The data contained herein has a TLV layout,
0144      * see above for the TLV header and types.
0145      * Note that each TLV is padded to a length
0146      * that is a multiple of 4 for alignment.
0147      */
0148     u8 data[];
0149 };
0150 
0151 /*
0152  * ucode TLVs
0153  *
0154  * ability to get extension for: flags & capabilities from ucode binaries files
0155  */
0156 struct iwl_ucode_api {
0157     __le32 api_index;
0158     __le32 api_flags;
0159 } __packed;
0160 
0161 struct iwl_ucode_capa {
0162     __le32 api_index;
0163     __le32 api_capa;
0164 } __packed;
0165 
0166 /**
0167  * enum iwl_ucode_tlv_flag - ucode API flags
0168  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
0169  *  was a separate TLV but moved here to save space.
0170  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
0171  *  treats good CRC threshold as a boolean
0172  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
0173  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
0174  * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of block list instead of 64 in scan
0175  *  offload profile config command.
0176  * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
0177  *  (rather than two) IPv6 addresses
0178  * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
0179  *  from the probe request template.
0180  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
0181  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
0182  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
0183  * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
0184  * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
0185  */
0186 enum iwl_ucode_tlv_flag {
0187     IWL_UCODE_TLV_FLAGS_PAN         = BIT(0),
0188     IWL_UCODE_TLV_FLAGS_NEWSCAN     = BIT(1),
0189     IWL_UCODE_TLV_FLAGS_MFP         = BIT(2),
0190     IWL_UCODE_TLV_FLAGS_SHORT_BL        = BIT(7),
0191     IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
0192     IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID   = BIT(12),
0193     IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
0194     IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
0195     IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT   = BIT(24),
0196     IWL_UCODE_TLV_FLAGS_EBS_SUPPORT     = BIT(25),
0197     IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD    = BIT(26),
0198 };
0199 
0200 typedef unsigned int __bitwise iwl_ucode_tlv_api_t;
0201 
0202 /**
0203  * enum iwl_ucode_tlv_api - ucode api
0204  * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
0205  *  longer than the passive one, which is essential for fragmented scan.
0206  * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
0207  * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
0208  * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
0209  * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
0210  *  iteration complete notification, and the timestamp reported for RX
0211  *  received during scan, are reported in TSF of the mac specified in the
0212  *  scan request.
0213  * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
0214  *  ADD_MODIFY_STA_KEY_API_S_VER_2.
0215  * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
0216  * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
0217  * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
0218  * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
0219  *  indicating low latency direction.
0220  * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
0221  *  deprecated.
0222  * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
0223  *  of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
0224  * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS
0225  * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of
0226  *  the REDUCE_TX_POWER_CMD.
0227  * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short
0228  *  version of the beacon notification.
0229  * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of
0230  *  BEACON_FILTER_CONFIG_API_S_VER_4.
0231  * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of
0232  *  REGULATORY_NVM_GET_INFO_RSP_API_S.
0233  * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of
0234  *  LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S.
0235  * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of
0236  *  SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of
0237  *  SCAN_OFFLOAD_PROFILES_QUERY_RSP_S.
0238  * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of
0239  *  STA_CONTEXT_DOT11AX_API_S
0240  * @IWL_UCODE_TLV_API_SAR_TABLE_VER: This ucode supports different sar
0241  *  version tables.
0242  * @IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG: This ucode supports v3 of
0243  *  SCAN_CONFIG_DB_CMD_API_S.
0244  *
0245  * @NUM_IWL_UCODE_TLV_API: number of bits used
0246  */
0247 enum iwl_ucode_tlv_api {
0248     /* API Set 0 */
0249     IWL_UCODE_TLV_API_FRAGMENTED_SCAN   = (__force iwl_ucode_tlv_api_t)8,
0250     IWL_UCODE_TLV_API_WIFI_MCC_UPDATE   = (__force iwl_ucode_tlv_api_t)9,
0251     IWL_UCODE_TLV_API_LQ_SS_PARAMS      = (__force iwl_ucode_tlv_api_t)18,
0252     IWL_UCODE_TLV_API_NEW_VERSION       = (__force iwl_ucode_tlv_api_t)20,
0253     IWL_UCODE_TLV_API_SCAN_TSF_REPORT   = (__force iwl_ucode_tlv_api_t)28,
0254     IWL_UCODE_TLV_API_TKIP_MIC_KEYS     = (__force iwl_ucode_tlv_api_t)29,
0255     IWL_UCODE_TLV_API_STA_TYPE      = (__force iwl_ucode_tlv_api_t)30,
0256     IWL_UCODE_TLV_API_NAN2_VER2     = (__force iwl_ucode_tlv_api_t)31,
0257     /* API Set 1 */
0258     IWL_UCODE_TLV_API_ADAPTIVE_DWELL    = (__force iwl_ucode_tlv_api_t)32,
0259     IWL_UCODE_TLV_API_OCE           = (__force iwl_ucode_tlv_api_t)33,
0260     IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE   = (__force iwl_ucode_tlv_api_t)34,
0261     IWL_UCODE_TLV_API_NEW_RX_STATS      = (__force iwl_ucode_tlv_api_t)35,
0262     IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL   = (__force iwl_ucode_tlv_api_t)36,
0263     IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
0264     IWL_UCODE_TLV_API_DEPRECATE_TTAK    = (__force iwl_ucode_tlv_api_t)41,
0265     IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42,
0266     IWL_UCODE_TLV_API_FRAG_EBS      = (__force iwl_ucode_tlv_api_t)44,
0267     IWL_UCODE_TLV_API_REDUCE_TX_POWER   = (__force iwl_ucode_tlv_api_t)45,
0268     IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF    = (__force iwl_ucode_tlv_api_t)46,
0269     IWL_UCODE_TLV_API_BEACON_FILTER_V4      = (__force iwl_ucode_tlv_api_t)47,
0270     IWL_UCODE_TLV_API_REGULATORY_NVM_INFO   = (__force iwl_ucode_tlv_api_t)48,
0271     IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ     = (__force iwl_ucode_tlv_api_t)49,
0272     IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS    = (__force iwl_ucode_tlv_api_t)50,
0273     IWL_UCODE_TLV_API_MBSSID_HE     = (__force iwl_ucode_tlv_api_t)52,
0274     IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE   = (__force iwl_ucode_tlv_api_t)53,
0275     IWL_UCODE_TLV_API_FTM_RTT_ACCURACY      = (__force iwl_ucode_tlv_api_t)54,
0276     IWL_UCODE_TLV_API_SAR_TABLE_VER         = (__force iwl_ucode_tlv_api_t)55,
0277     IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG   = (__force iwl_ucode_tlv_api_t)56,
0278     IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP    = (__force iwl_ucode_tlv_api_t)57,
0279     IWL_UCODE_TLV_API_SCAN_EXT_CHAN_VER = (__force iwl_ucode_tlv_api_t)58,
0280     IWL_UCODE_TLV_API_BAND_IN_RX_DATA   = (__force iwl_ucode_tlv_api_t)59,
0281 
0282 
0283 #ifdef __CHECKER__
0284     /* sparse says it cannot increment the previous enum member */
0285 #define NUM_IWL_UCODE_TLV_API 128
0286 #else
0287     NUM_IWL_UCODE_TLV_API
0288 #endif
0289 };
0290 
0291 typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;
0292 
0293 /**
0294  * enum iwl_ucode_tlv_capa - ucode capabilities
0295  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
0296  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
0297  * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
0298  * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
0299  * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
0300  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
0301  *  tx power value into TPC Report action frame and Link Measurement Report
0302  *  action frame
0303  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
0304  *  channel in DS parameter set element in probe requests.
0305  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
0306  *  probe requests.
0307  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
0308  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
0309  *  which also implies support for the scheduler configuration command
0310  * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
0311  * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
0312  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
0313  * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
0314  * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
0315  * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
0316  *  is standalone or with a BSS station interface in the same binding.
0317  * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
0318  * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
0319  *  sources for the MCC. This TLV bit is a future replacement to
0320  *  IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
0321  *  is supported.
0322  * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
0323  * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used)
0324  * @IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT: the firmware supports setting
0325  *  stabilization latency for SoCs.
0326  * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
0327  * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
0328  * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
0329  * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2
0330  * IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command
0331  * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band
0332  *  (6 GHz).
0333  * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command
0334  * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
0335  * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
0336  * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
0337  * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
0338  *  countdown offloading. Beacon notifications are not sent to the host.
0339  *  The fw also offloads TBTT alignment.
0340  * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
0341  *  antenna the beacon should be transmitted
0342  * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
0343  *  from AP and will send it upon d0i3 exit.
0344  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3
0345  * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
0346  * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
0347  *  thresholds reporting
0348  * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
0349  * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
0350  *  regular image.
0351  * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
0352  *  memory addresses from the firmware.
0353  * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
0354  * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
0355  *  command size (command version 4) that supports toggling ACK TX
0356  *  power reduction.
0357  * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3
0358  * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax
0359  *  capability.
0360  * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured
0361  *  to report the CSI information with (certain) RX frames
0362  * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both
0363  *  initiator and responder
0364  * @IWL_UCODE_TLV_CAPA_MLME_OFFLOAD: supports MLME offload
0365  * @IWL_UCODE_TLV_CAPA_PROTECTED_TWT: Supports protection of TWT action frames
0366  * @IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE: Supports the firmware handshake in
0367  *  reset flow
0368  * @IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN: Support for passive scan on 6GHz PSC
0369  *      channels even when these are not enabled.
0370  * @IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT: Support for indicating dump collection
0371  *  complete to FW.
0372  *
0373  * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
0374  */
0375 enum iwl_ucode_tlv_capa {
0376     /* set 0 */
0377     IWL_UCODE_TLV_CAPA_D0I3_SUPPORT         = (__force iwl_ucode_tlv_capa_t)0,
0378     IWL_UCODE_TLV_CAPA_LAR_SUPPORT          = (__force iwl_ucode_tlv_capa_t)1,
0379     IWL_UCODE_TLV_CAPA_UMAC_SCAN            = (__force iwl_ucode_tlv_capa_t)2,
0380     IWL_UCODE_TLV_CAPA_BEAMFORMER           = (__force iwl_ucode_tlv_capa_t)3,
0381     IWL_UCODE_TLV_CAPA_TDLS_SUPPORT         = (__force iwl_ucode_tlv_capa_t)6,
0382     IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = (__force iwl_ucode_tlv_capa_t)8,
0383     IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT  = (__force iwl_ucode_tlv_capa_t)9,
0384     IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT   = (__force iwl_ucode_tlv_capa_t)10,
0385     IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT     = (__force iwl_ucode_tlv_capa_t)11,
0386     IWL_UCODE_TLV_CAPA_DQA_SUPPORT          = (__force iwl_ucode_tlv_capa_t)12,
0387     IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH      = (__force iwl_ucode_tlv_capa_t)13,
0388     IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG        = (__force iwl_ucode_tlv_capa_t)17,
0389     IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT      = (__force iwl_ucode_tlv_capa_t)18,
0390     IWL_UCODE_TLV_CAPA_CSUM_SUPPORT         = (__force iwl_ucode_tlv_capa_t)21,
0391     IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS       = (__force iwl_ucode_tlv_capa_t)22,
0392     IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD        = (__force iwl_ucode_tlv_capa_t)26,
0393     IWL_UCODE_TLV_CAPA_BT_COEX_PLCR         = (__force iwl_ucode_tlv_capa_t)28,
0394     IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC        = (__force iwl_ucode_tlv_capa_t)29,
0395     IWL_UCODE_TLV_CAPA_BT_COEX_RRC          = (__force iwl_ucode_tlv_capa_t)30,
0396     IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT        = (__force iwl_ucode_tlv_capa_t)31,
0397 
0398     /* set 1 */
0399     IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT      = (__force iwl_ucode_tlv_capa_t)37,
0400     IWL_UCODE_TLV_CAPA_STA_PM_NOTIF         = (__force iwl_ucode_tlv_capa_t)38,
0401     IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT      = (__force iwl_ucode_tlv_capa_t)39,
0402     IWL_UCODE_TLV_CAPA_CDB_SUPPORT          = (__force iwl_ucode_tlv_capa_t)40,
0403     IWL_UCODE_TLV_CAPA_D0I3_END_FIRST       = (__force iwl_ucode_tlv_capa_t)41,
0404     IWL_UCODE_TLV_CAPA_TLC_OFFLOAD                  = (__force iwl_ucode_tlv_capa_t)43,
0405     IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA                = (__force iwl_ucode_tlv_capa_t)44,
0406     IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2        = (__force iwl_ucode_tlv_capa_t)45,
0407     IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD       = (__force iwl_ucode_tlv_capa_t)46,
0408     IWL_UCODE_TLV_CAPA_FTM_CALIBRATED       = (__force iwl_ucode_tlv_capa_t)47,
0409     IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS        = (__force iwl_ucode_tlv_capa_t)48,
0410     IWL_UCODE_TLV_CAPA_CS_MODIFY            = (__force iwl_ucode_tlv_capa_t)49,
0411     IWL_UCODE_TLV_CAPA_SET_LTR_GEN2         = (__force iwl_ucode_tlv_capa_t)50,
0412     IWL_UCODE_TLV_CAPA_SET_PPAG         = (__force iwl_ucode_tlv_capa_t)52,
0413     IWL_UCODE_TLV_CAPA_TAS_CFG          = (__force iwl_ucode_tlv_capa_t)53,
0414     IWL_UCODE_TLV_CAPA_SESSION_PROT_CMD     = (__force iwl_ucode_tlv_capa_t)54,
0415     IWL_UCODE_TLV_CAPA_PROTECTED_TWT        = (__force iwl_ucode_tlv_capa_t)56,
0416     IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE       = (__force iwl_ucode_tlv_capa_t)57,
0417     IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN        = (__force iwl_ucode_tlv_capa_t)58,
0418     IWL_UCODE_TLV_CAPA_HIDDEN_6GHZ_SCAN     = (__force iwl_ucode_tlv_capa_t)59,
0419     IWL_UCODE_TLV_CAPA_BROADCAST_TWT        = (__force iwl_ucode_tlv_capa_t)60,
0420     IWL_UCODE_TLV_CAPA_COEX_HIGH_PRIO       = (__force iwl_ucode_tlv_capa_t)61,
0421     IWL_UCODE_TLV_CAPA_RFIM_SUPPORT         = (__force iwl_ucode_tlv_capa_t)62,
0422     IWL_UCODE_TLV_CAPA_BAID_ML_SUPPORT      = (__force iwl_ucode_tlv_capa_t)63,
0423 
0424     /* set 2 */
0425     IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE     = (__force iwl_ucode_tlv_capa_t)64,
0426     IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS        = (__force iwl_ucode_tlv_capa_t)65,
0427     IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT     = (__force iwl_ucode_tlv_capa_t)67,
0428     IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT   = (__force iwl_ucode_tlv_capa_t)68,
0429     IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD     = (__force iwl_ucode_tlv_capa_t)70,
0430     IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION     = (__force iwl_ucode_tlv_capa_t)71,
0431     IWL_UCODE_TLV_CAPA_BEACON_STORING       = (__force iwl_ucode_tlv_capa_t)72,
0432     IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3       = (__force iwl_ucode_tlv_capa_t)73,
0433     IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW        = (__force iwl_ucode_tlv_capa_t)74,
0434     IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT  = (__force iwl_ucode_tlv_capa_t)75,
0435     IWL_UCODE_TLV_CAPA_CTDP_SUPPORT         = (__force iwl_ucode_tlv_capa_t)76,
0436     IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED     = (__force iwl_ucode_tlv_capa_t)77,
0437     IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG    = (__force iwl_ucode_tlv_capa_t)80,
0438     IWL_UCODE_TLV_CAPA_LQM_SUPPORT          = (__force iwl_ucode_tlv_capa_t)81,
0439     IWL_UCODE_TLV_CAPA_TX_POWER_ACK         = (__force iwl_ucode_tlv_capa_t)84,
0440     IWL_UCODE_TLV_CAPA_D3_DEBUG         = (__force iwl_ucode_tlv_capa_t)87,
0441     IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT      = (__force iwl_ucode_tlv_capa_t)88,
0442     IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT  = (__force iwl_ucode_tlv_capa_t)89,
0443     IWL_UCODE_TLV_CAPA_CSI_REPORTING        = (__force iwl_ucode_tlv_capa_t)90,
0444     IWL_UCODE_TLV_CAPA_DBG_SUSPEND_RESUME_CMD_SUPP  = (__force iwl_ucode_tlv_capa_t)92,
0445     IWL_UCODE_TLV_CAPA_DBG_BUF_ALLOC_CMD_SUPP   = (__force iwl_ucode_tlv_capa_t)93,
0446 
0447     /* set 3 */
0448     IWL_UCODE_TLV_CAPA_MLME_OFFLOAD         = (__force iwl_ucode_tlv_capa_t)96,
0449 
0450     /*
0451      * @IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT: supports PSC channels
0452      */
0453     IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT     = (__force iwl_ucode_tlv_capa_t)98,
0454 
0455     IWL_UCODE_TLV_CAPA_BIGTK_SUPPORT        = (__force iwl_ucode_tlv_capa_t)100,
0456     IWL_UCODE_TLV_CAPA_DRAM_FRAG_SUPPORT        = (__force iwl_ucode_tlv_capa_t)104,
0457     IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT    = (__force iwl_ucode_tlv_capa_t)105,
0458 
0459 #ifdef __CHECKER__
0460     /* sparse says it cannot increment the previous enum member */
0461 #define NUM_IWL_UCODE_TLV_CAPA 128
0462 #else
0463     NUM_IWL_UCODE_TLV_CAPA
0464 #endif
0465 };
0466 
0467 /* The default calibrate table size if not specified by firmware file */
0468 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
0469 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE     19
0470 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE          253
0471 
0472 /* The default max probe length if not specified by the firmware file */
0473 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
0474 
0475 /*
0476  * For 16.0 uCode and above, there is no differentiation between sections,
0477  * just an offset to the HW address.
0478  */
0479 #define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
0480 #define PAGING_SEPARATOR_SECTION    0xAAAABBBB
0481 
0482 /* uCode version contains 4 values: Major/Minor/API/Serial */
0483 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
0484 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
0485 #define IWL_UCODE_API(ver)  (((ver) & 0x0000FF00) >> 8)
0486 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
0487 
0488 /**
0489  * struct iwl_tlv_calib_ctrl - Calibration control struct.
0490  * Sent as part of the phy configuration command.
0491  * @flow_trigger: bitmap for which calibrations to perform according to
0492  *      flow triggers.
0493  * @event_trigger: bitmap for which calibrations to perform according to
0494  *      event triggers.
0495  */
0496 struct iwl_tlv_calib_ctrl {
0497     __le32 flow_trigger;
0498     __le32 event_trigger;
0499 } __packed;
0500 
0501 enum iwl_fw_phy_cfg {
0502     FW_PHY_CFG_RADIO_TYPE_POS = 0,
0503     FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
0504     FW_PHY_CFG_RADIO_STEP_POS = 2,
0505     FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
0506     FW_PHY_CFG_RADIO_DASH_POS = 4,
0507     FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
0508     FW_PHY_CFG_TX_CHAIN_POS = 16,
0509     FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
0510     FW_PHY_CFG_RX_CHAIN_POS = 20,
0511     FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
0512     FW_PHY_CFG_CHAIN_SAD_POS = 23,
0513     FW_PHY_CFG_CHAIN_SAD_ENABLED = 0x1 << FW_PHY_CFG_CHAIN_SAD_POS,
0514     FW_PHY_CFG_CHAIN_SAD_ANT_A = 0x2 << FW_PHY_CFG_CHAIN_SAD_POS,
0515     FW_PHY_CFG_CHAIN_SAD_ANT_B = 0x4 << FW_PHY_CFG_CHAIN_SAD_POS,
0516     FW_PHY_CFG_SHARED_CLK = BIT(31),
0517 };
0518 
0519 enum iwl_fw_dbg_reg_operator {
0520     CSR_ASSIGN,
0521     CSR_SETBIT,
0522     CSR_CLEARBIT,
0523 
0524     PRPH_ASSIGN,
0525     PRPH_SETBIT,
0526     PRPH_CLEARBIT,
0527 
0528     INDIRECT_ASSIGN,
0529     INDIRECT_SETBIT,
0530     INDIRECT_CLEARBIT,
0531 
0532     PRPH_BLOCKBIT,
0533 };
0534 
0535 /**
0536  * struct iwl_fw_dbg_reg_op - an operation on a register
0537  *
0538  * @op: &enum iwl_fw_dbg_reg_operator
0539  * @addr: offset of the register
0540  * @val: value
0541  */
0542 struct iwl_fw_dbg_reg_op {
0543     u8 op;
0544     u8 reserved[3];
0545     __le32 addr;
0546     __le32 val;
0547 } __packed;
0548 
0549 /**
0550  * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
0551  *
0552  * @SMEM_MODE: monitor stores the data in SMEM
0553  * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
0554  * @MARBH_MODE: monitor stores the data in MARBH buffer
0555  * @MIPI_MODE: monitor outputs the data through the MIPI interface
0556  */
0557 enum iwl_fw_dbg_monitor_mode {
0558     SMEM_MODE = 0,
0559     EXTERNAL_MODE = 1,
0560     MARBH_MODE = 2,
0561     MIPI_MODE = 3,
0562 };
0563 
0564 /**
0565  * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
0566  *
0567  * @data_type: the memory segment type to record
0568  * @ofs: the memory segment offset
0569  * @len: the memory segment length, in bytes
0570  *
0571  * This parses IWL_UCODE_TLV_FW_MEM_SEG
0572  */
0573 struct iwl_fw_dbg_mem_seg_tlv {
0574     __le32 data_type;
0575     __le32 ofs;
0576     __le32 len;
0577 } __packed;
0578 
0579 /**
0580  * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
0581  *
0582  * @version: version of the TLV - currently 0
0583  * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
0584  * @size_power: buffer size will be 2^(size_power + 11)
0585  * @base_reg: addr of the base addr register (PRPH)
0586  * @end_reg:  addr of the end addr register (PRPH)
0587  * @write_ptr_reg: the addr of the reg of the write pointer
0588  * @wrap_count: the addr of the reg of the wrap_count
0589  * @base_shift: shift right of the base addr reg
0590  * @end_shift: shift right of the end addr reg
0591  * @reg_ops: array of registers operations
0592  *
0593  * This parses IWL_UCODE_TLV_FW_DBG_DEST
0594  */
0595 struct iwl_fw_dbg_dest_tlv_v1 {
0596     u8 version;
0597     u8 monitor_mode;
0598     u8 size_power;
0599     u8 reserved;
0600     __le32 base_reg;
0601     __le32 end_reg;
0602     __le32 write_ptr_reg;
0603     __le32 wrap_count;
0604     u8 base_shift;
0605     u8 end_shift;
0606     struct iwl_fw_dbg_reg_op reg_ops[];
0607 } __packed;
0608 
0609 /* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
0610 #define IWL_LDBG_M2S_BUF_SIZE_MSK   0x0fff0000
0611 /* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
0612 #define IWL_LDBG_M2S_BUF_BA_MSK     0x00000fff
0613 /* The smem buffer chunks are in units of 256 bits */
0614 #define IWL_M2S_UNIT_SIZE           0x100
0615 
0616 struct iwl_fw_dbg_dest_tlv {
0617     u8 version;
0618     u8 monitor_mode;
0619     u8 size_power;
0620     u8 reserved;
0621     __le32 cfg_reg;
0622     __le32 write_ptr_reg;
0623     __le32 wrap_count;
0624     u8 base_shift;
0625     u8 size_shift;
0626     struct iwl_fw_dbg_reg_op reg_ops[];
0627 } __packed;
0628 
0629 struct iwl_fw_dbg_conf_hcmd {
0630     u8 id;
0631     u8 reserved;
0632     __le16 len;
0633     u8 data[];
0634 } __packed;
0635 
0636 /**
0637  * enum iwl_fw_dbg_trigger_mode - triggers functionalities
0638  *
0639  * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
0640  * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
0641  * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
0642  *  collect only monitor data
0643  */
0644 enum iwl_fw_dbg_trigger_mode {
0645     IWL_FW_DBG_TRIGGER_START = BIT(0),
0646     IWL_FW_DBG_TRIGGER_STOP = BIT(1),
0647     IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
0648 };
0649 
0650 /**
0651  * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
0652  * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
0653  */
0654 enum iwl_fw_dbg_trigger_flags {
0655     IWL_FW_DBG_FORCE_RESTART = BIT(0),
0656 };
0657 
0658 /**
0659  * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
0660  * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
0661  * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
0662  * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
0663  * @IWL_FW_DBG_CONF_VIF_AP: AP mode
0664  * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
0665  * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
0666  * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
0667  */
0668 enum iwl_fw_dbg_trigger_vif_type {
0669     IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
0670     IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
0671     IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
0672     IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
0673     IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
0674     IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
0675     IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
0676 };
0677 
0678 /**
0679  * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
0680  * @id: &enum iwl_fw_dbg_trigger
0681  * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
0682  * @stop_conf_ids: bitmap of configurations this trigger relates to.
0683  *  if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
0684  *  to the currently running configuration is set, the data should be
0685  *  collected.
0686  * @stop_delay: how many milliseconds to wait before collecting the data
0687  *  after the STOP trigger fires.
0688  * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
0689  * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
0690  *  configuration should be applied when the triggers kicks in.
0691  * @occurrences: number of occurrences. 0 means the trigger will never fire.
0692  * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
0693  *  trigger in which another occurrence should be ignored.
0694  * @flags: &enum iwl_fw_dbg_trigger_flags
0695  */
0696 struct iwl_fw_dbg_trigger_tlv {
0697     __le32 id;
0698     __le32 vif_type;
0699     __le32 stop_conf_ids;
0700     __le32 stop_delay;
0701     u8 mode;
0702     u8 start_conf_id;
0703     __le16 occurrences;
0704     __le16 trig_dis_ms;
0705     u8 flags;
0706     u8 reserved[5];
0707 
0708     u8 data[];
0709 } __packed;
0710 
0711 #define FW_DBG_START_FROM_ALIVE 0
0712 #define FW_DBG_CONF_MAX     32
0713 #define FW_DBG_INVALID      0xff
0714 
0715 /**
0716  * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
0717  * @stop_consec_missed_bcon: stop recording if threshold is crossed.
0718  * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
0719  * @start_consec_missed_bcon: start recording if threshold is crossed.
0720  * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
0721  * @reserved1: reserved
0722  * @reserved2: reserved
0723  */
0724 struct iwl_fw_dbg_trigger_missed_bcon {
0725     __le32 stop_consec_missed_bcon;
0726     __le32 stop_consec_missed_bcon_since_rx;
0727     __le32 reserved2[2];
0728     __le32 start_consec_missed_bcon;
0729     __le32 start_consec_missed_bcon_since_rx;
0730     __le32 reserved1[2];
0731 } __packed;
0732 
0733 /**
0734  * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
0735  * cmds: the list of commands to trigger the collection on
0736  */
0737 struct iwl_fw_dbg_trigger_cmd {
0738     struct cmd {
0739         u8 cmd_id;
0740         u8 group_id;
0741     } __packed cmds[16];
0742 } __packed;
0743 
0744 /**
0745  * iwl_fw_dbg_trigger_stats - configures trigger for statistics
0746  * @stop_offset: the offset of the value to be monitored
0747  * @stop_threshold: the threshold above which to collect
0748  * @start_offset: the offset of the value to be monitored
0749  * @start_threshold: the threshold above which to start recording
0750  */
0751 struct iwl_fw_dbg_trigger_stats {
0752     __le32 stop_offset;
0753     __le32 stop_threshold;
0754     __le32 start_offset;
0755     __le32 start_threshold;
0756 } __packed;
0757 
0758 /**
0759  * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
0760  * @rssi: RSSI value to trigger at
0761  */
0762 struct iwl_fw_dbg_trigger_low_rssi {
0763     __le32 rssi;
0764 } __packed;
0765 
0766 /**
0767  * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
0768  * @stop_auth_denied: number of denied authentication to collect
0769  * @stop_auth_timeout: number of authentication timeout to collect
0770  * @stop_rx_deauth: number of Rx deauth before to collect
0771  * @stop_tx_deauth: number of Tx deauth before to collect
0772  * @stop_assoc_denied: number of denied association to collect
0773  * @stop_assoc_timeout: number of association timeout to collect
0774  * @stop_connection_loss: number of connection loss to collect
0775  * @start_auth_denied: number of denied authentication to start recording
0776  * @start_auth_timeout: number of authentication timeout to start recording
0777  * @start_rx_deauth: number of Rx deauth to start recording
0778  * @start_tx_deauth: number of Tx deauth to start recording
0779  * @start_assoc_denied: number of denied association to start recording
0780  * @start_assoc_timeout: number of association timeout to start recording
0781  * @start_connection_loss: number of connection loss to start recording
0782  */
0783 struct iwl_fw_dbg_trigger_mlme {
0784     u8 stop_auth_denied;
0785     u8 stop_auth_timeout;
0786     u8 stop_rx_deauth;
0787     u8 stop_tx_deauth;
0788 
0789     u8 stop_assoc_denied;
0790     u8 stop_assoc_timeout;
0791     u8 stop_connection_loss;
0792     u8 reserved;
0793 
0794     u8 start_auth_denied;
0795     u8 start_auth_timeout;
0796     u8 start_rx_deauth;
0797     u8 start_tx_deauth;
0798 
0799     u8 start_assoc_denied;
0800     u8 start_assoc_timeout;
0801     u8 start_connection_loss;
0802     u8 reserved2;
0803 } __packed;
0804 
0805 /**
0806  * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
0807  * @command_queue: timeout for the command queue in ms
0808  * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
0809  * @softap: timeout for the queues of a softAP in ms
0810  * @p2p_go: timeout for the queues of a P2P GO in ms
0811  * @p2p_client: timeout for the queues of a P2P client in ms
0812  * @p2p_device: timeout for the queues of a P2P device in ms
0813  * @ibss: timeout for the queues of an IBSS in ms
0814  * @tdls: timeout for the queues of a TDLS station in ms
0815  */
0816 struct iwl_fw_dbg_trigger_txq_timer {
0817     __le32 command_queue;
0818     __le32 bss;
0819     __le32 softap;
0820     __le32 p2p_go;
0821     __le32 p2p_client;
0822     __le32 p2p_device;
0823     __le32 ibss;
0824     __le32 tdls;
0825     __le32 reserved[4];
0826 } __packed;
0827 
0828 /**
0829  * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
0830  * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
0831  *  trigger each time a time event notification that relates to time event
0832  *  id with one of the actions in the bitmap is received and
0833  *  BIT(notif->status) is set in status_bitmap.
0834  *
0835  */
0836 struct iwl_fw_dbg_trigger_time_event {
0837     struct {
0838         __le32 id;
0839         __le32 action_bitmap;
0840         __le32 status_bitmap;
0841     } __packed time_events[16];
0842 } __packed;
0843 
0844 /**
0845  * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
0846  * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
0847  *  when an Rx BlockAck session is started.
0848  * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
0849  *  when an Rx BlockAck session is stopped.
0850  * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
0851  *  when a Tx BlockAck session is started.
0852  * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
0853  *  when a Tx BlockAck session is stopped.
0854  * rx_bar: tid bitmap to configure on what tid the trigger should occur
0855  *  when a BAR is received (for a Tx BlockAck session).
0856  * tx_bar: tid bitmap to configure on what tid the trigger should occur
0857  *  when a BAR is send (for an Rx BlocAck session).
0858  * frame_timeout: tid bitmap to configure on what tid the trigger should occur
0859  *  when a frame times out in the reordering buffer.
0860  */
0861 struct iwl_fw_dbg_trigger_ba {
0862     __le16 rx_ba_start;
0863     __le16 rx_ba_stop;
0864     __le16 tx_ba_start;
0865     __le16 tx_ba_stop;
0866     __le16 rx_bar;
0867     __le16 tx_bar;
0868     __le16 frame_timeout;
0869 } __packed;
0870 
0871 /**
0872  * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
0873  * @action_bitmap: the TDLS action to trigger the collection upon
0874  * @peer_mode: trigger on specific peer or all
0875  * @peer: the TDLS peer to trigger the collection on
0876  */
0877 struct iwl_fw_dbg_trigger_tdls {
0878     u8 action_bitmap;
0879     u8 peer_mode;
0880     u8 peer[ETH_ALEN];
0881     u8 reserved[4];
0882 } __packed;
0883 
0884 /**
0885  * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
0886  *  status.
0887  * @statuses: the list of statuses to trigger the collection on
0888  */
0889 struct iwl_fw_dbg_trigger_tx_status {
0890     struct tx_status {
0891         u8 status;
0892         u8 reserved[3];
0893     } __packed statuses[16];
0894     __le32 reserved[2];
0895 } __packed;
0896 
0897 /**
0898  * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
0899  * @id: conf id
0900  * @usniffer: should the uSniffer image be used
0901  * @num_of_hcmds: how many HCMDs to send are present here
0902  * @hcmd: a variable length host command to be sent to apply the configuration.
0903  *  If there is more than one HCMD to send, they will appear one after the
0904  *  other and be sent in the order that they appear in.
0905  * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
0906  * %FW_DBG_CONF_MAX configuration per run.
0907  */
0908 struct iwl_fw_dbg_conf_tlv {
0909     u8 id;
0910     u8 usniffer;
0911     u8 reserved;
0912     u8 num_of_hcmds;
0913     struct iwl_fw_dbg_conf_hcmd hcmd;
0914 } __packed;
0915 
0916 #define IWL_FW_CMD_VER_UNKNOWN 99
0917 
0918 /**
0919  * struct iwl_fw_cmd_version - firmware command version entry
0920  * @cmd: command ID
0921  * @group: group ID
0922  * @cmd_ver: command version
0923  * @notif_ver: notification version
0924  */
0925 struct iwl_fw_cmd_version {
0926     u8 cmd;
0927     u8 group;
0928     u8 cmd_ver;
0929     u8 notif_ver;
0930 } __packed;
0931 
0932 struct iwl_fw_tcm_error_addr {
0933     __le32 addr;
0934 }; /* FW_TLV_TCM_ERROR_INFO_ADDRS_S */
0935 
0936 struct iwl_fw_dump_exclude {
0937     __le32 addr, size;
0938 };
0939 
0940 static inline size_t _iwl_tlv_array_len(const struct iwl_ucode_tlv *tlv,
0941                     size_t fixed_size, size_t var_size)
0942 {
0943     size_t var_len = le32_to_cpu(tlv->length) - fixed_size;
0944 
0945     if (WARN_ON(var_len % var_size))
0946         return 0;
0947 
0948     return var_len / var_size;
0949 }
0950 
0951 #define iwl_tlv_array_len(_tlv_ptr, _struct_ptr, _memb)         \
0952     _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)),      \
0953                sizeof(_struct_ptr->_memb[0]))
0954 
0955 #endif  /* __iwl_fw_file_h__ */