/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
/*
 * Copyright (C) 2008-2014, 2018-2024 Intel Corporation
 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
 * Copyright (C) 2016-2017 Intel Deutschland GmbH
 */
#ifndef __iwl_fw_file_h__
#define __iwl_fw_file_h__

#include <linux/netdevice.h>
#include <linux/nl80211.h>

/* v1/v2 uCode file layout */
struct iwl_ucode_header {
 __le32 ver; /* major/minor/API/serial */
 union {
  struct {
   __le32 inst_size; /* bytes of runtime code */
   __le32 data_size; /* bytes of runtime data */
   __le32 init_size; /* bytes of init code */
   __le32 init_data_size; /* bytes of init data */
   __le32 boot_size; /* bytes of bootstrap code */
   u8 data[];  /* in same order as sizes */
  } v1;
  struct {
   __le32 build;  /* build number */
   __le32 inst_size; /* bytes of runtime code */
   __le32 data_size; /* bytes of runtime data */
   __le32 init_size; /* bytes of init code */
   __le32 init_data_size; /* bytes of init data */
   __le32 boot_size; /* bytes of bootstrap code */
   u8 data[];  /* in same order as sizes */
  } v2;
 } u;
};

#define IWL_UCODE_TLV_DEBUG_BASE 0x1000005
#define IWL_UCODE_TLV_CONST_BASE 0x100

/*
 * new TLV uCode file layout
 *
 * The new TLV file format contains TLVs, that each specify
 * some piece of data.
 */

enum iwl_ucode_tlv_type {
 IWL_UCODE_TLV_INVALID  = 0, /* unused */
 IWL_UCODE_TLV_INST  = 1,
 IWL_UCODE_TLV_DATA  = 2,
 IWL_UCODE_TLV_INIT  = 3,
 IWL_UCODE_TLV_INIT_DATA  = 4,
 IWL_UCODE_TLV_BOOT  = 5,
 IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
 IWL_UCODE_TLV_PAN  = 7, /* deprecated -- only used in DVM */
 IWL_UCODE_TLV_MEM_DESC  = 7, /* replaces PAN in non-DVM */
 IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
 IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
 IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
 IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
 IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
 IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
 IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
 IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
 IWL_UCODE_TLV_WOWLAN_INST = 16,
 IWL_UCODE_TLV_WOWLAN_DATA = 17,
 IWL_UCODE_TLV_FLAGS  = 18,
 IWL_UCODE_TLV_SEC_RT  = 19,
 IWL_UCODE_TLV_SEC_INIT  = 20,
 IWL_UCODE_TLV_SEC_WOWLAN = 21,
 IWL_UCODE_TLV_DEF_CALIB  = 22,
 IWL_UCODE_TLV_PHY_SKU  = 23,
 IWL_UCODE_TLV_SECURE_SEC_RT = 24,
 IWL_UCODE_TLV_SECURE_SEC_INIT = 25,
 IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
 IWL_UCODE_TLV_NUM_OF_CPU = 27,
 IWL_UCODE_TLV_CSCHEME  = 28,
 IWL_UCODE_TLV_API_CHANGES_SET = 29,
 IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
 IWL_UCODE_TLV_N_SCAN_CHANNELS  = 31,
 IWL_UCODE_TLV_PAGING  = 32,
 IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
 /* 35 is unused */
 IWL_UCODE_TLV_FW_VERSION = 36,
 IWL_UCODE_TLV_FW_DBG_DEST = 38,
 IWL_UCODE_TLV_FW_DBG_CONF = 39,
 IWL_UCODE_TLV_FW_DBG_TRIGGER = 40,
 IWL_UCODE_TLV_CMD_VERSIONS = 48,
 IWL_UCODE_TLV_FW_GSCAN_CAPA = 50,
 IWL_UCODE_TLV_FW_MEM_SEG = 51,
 IWL_UCODE_TLV_IML  = 52,
 IWL_UCODE_TLV_UMAC_DEBUG_ADDRS = 54,
 IWL_UCODE_TLV_LMAC_DEBUG_ADDRS = 55,
 IWL_UCODE_TLV_FW_RECOVERY_INFO = 57,
 IWL_UCODE_TLV_HW_TYPE   = 58,
 IWL_UCODE_TLV_FW_FSEQ_VERSION  = 60,
 IWL_UCODE_TLV_PHY_INTEGRATION_VERSION = 61,

 IWL_UCODE_TLV_PNVM_VERSION  = 62,
 IWL_UCODE_TLV_PNVM_SKU   = 64,

 IWL_UCODE_TLV_SEC_TABLE_ADDR  = 66,
 IWL_UCODE_TLV_D3_KEK_KCK_ADDR  = 67,
 IWL_UCODE_TLV_CURRENT_PC  = 68,
 IWL_UCODE_TLV_FSEQ_BIN_VERSION  = 72,

 /* contains sub-sections like PNVM file does (did) */
 IWL_UCODE_TLV_PNVM_DATA   = 74,

 IWL_UCODE_TLV_FW_NUM_STATIONS  = IWL_UCODE_TLV_CONST_BASE + 0,
 IWL_UCODE_TLV_FW_NUM_LINKS  = IWL_UCODE_TLV_CONST_BASE + 1,
 IWL_UCODE_TLV_FW_NUM_BEACONS  = IWL_UCODE_TLV_CONST_BASE + 2,

 IWL_UCODE_TLV_TYPE_DEBUG_INFO  = IWL_UCODE_TLV_DEBUG_BASE + 0,
 IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION = IWL_UCODE_TLV_DEBUG_BASE + 1,
 IWL_UCODE_TLV_TYPE_HCMD   = IWL_UCODE_TLV_DEBUG_BASE + 2,
 IWL_UCODE_TLV_TYPE_REGIONS  = IWL_UCODE_TLV_DEBUG_BASE + 3,
 IWL_UCODE_TLV_TYPE_TRIGGERS  = IWL_UCODE_TLV_DEBUG_BASE + 4,
 IWL_UCODE_TLV_TYPE_CONF_SET  = IWL_UCODE_TLV_DEBUG_BASE + 5,
 IWL_UCODE_TLV_DEBUG_MAX = IWL_UCODE_TLV_TYPE_TRIGGERS,

 /* TLVs 0x1000-0x2000 are for internal driver usage */
 IWL_UCODE_TLV_FW_DBG_DUMP_LST = 0x1000,
};

struct iwl_ucode_tlv {
 __le32 type;  /* see above */
 __le32 length;  /* not including type/length fields */
 u8 data[];
};

#define IWL_TLV_UCODE_MAGIC  0x0a4c5749
#define FW_VER_HUMAN_READABLE_SZ 64

struct iwl_tlv_ucode_header {
 /*
  * The TLV style ucode header is distinguished from
  * the v1/v2 style header by first four bytes being
  * zero, as such is an invalid combination of
  * major/minor/API/serial versions.
 */
 __le32 zero;
 __le32 magic;
 u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 /* major/minor/API/serial or major in new format */
 __le32 ver;
 __le32 build;
 __le64 ignore;
 /*
  * The data contained herein has a TLV layout,
  * see above for the TLV header and types.
  * Note that each TLV is padded to a length
  * that is a multiple of 4 for alignment.
 */
 u8 data[];
};

/*
 * ucode TLVs
 *
 * ability to get extension for: flags & capabilities from ucode binaries files
 */
struct iwl_ucode_api {
 __le32 api_index;
 __le32 api_flags;
} __packed;

struct iwl_ucode_capa {
 __le32 api_index;
 __le32 api_capa;
} __packed;

/**
 * enum iwl_ucode_tlv_flag - ucode API flags
 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 * was a separate TLV but moved here to save space.
 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
 * treats good CRC threshold as a boolean
 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of block list instead of 64 in scan
 * offload profile config command.
 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 * (rather than two) IPv6 addresses
 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 * from the probe request template.
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
 */
enum iwl_ucode_tlv_flag {
 IWL_UCODE_TLV_FLAGS_PAN   = BIT(0),
 IWL_UCODE_TLV_FLAGS_NEWSCAN  = BIT(1),
 IWL_UCODE_TLV_FLAGS_MFP   = BIT(2),
 IWL_UCODE_TLV_FLAGS_SHORT_BL  = BIT(7),
 IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
 IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
 IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
 IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
 IWL_UCODE_TLV_FLAGS_EBS_SUPPORT  = BIT(25),
 IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
};

typedef unsigned int __bitwise iwl_ucode_tlv_api_t;

/**
 * enum iwl_ucode_tlv_api - ucode api
 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 * longer than the passive one, which is essential for fragmented scan.
 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
 * @IWL_UCODE_TLV_API_SCAN_TSF_REPORT: Scan start time reported in scan
 * iteration complete notification, and the timestamp reported for RX
 * received during scan, are reported in TSF of the mac specified in the
 * scan request.
 * @IWL_UCODE_TLV_API_TKIP_MIC_KEYS: This ucode supports version 2 of
 * ADD_MODIFY_STA_KEY_API_S_VER_2.
 * @IWL_UCODE_TLV_API_STA_TYPE: This ucode supports station type assignement.
 * @IWL_UCODE_TLV_API_NAN2_VER2: This ucode supports NAN API version 2
 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL: support for adaptive dwell in scanning
 * @IWL_UCODE_TLV_API_NEW_RX_STATS: should new RX STATISTICS API be used
 * @IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY: Quota command includes a field
 * indicating low latency direction.
 * @IWL_UCODE_TLV_API_DEPRECATE_TTAK: RX status flag TTAK ok (bit 7) is
 * deprecated.
 * @IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2: This ucode supports version 8
 * of scan request: SCAN_REQUEST_CMD_UMAC_API_S_VER_8
 * @IWL_UCODE_TLV_API_FRAG_EBS: This ucode supports fragmented EBS
 * @IWL_UCODE_TLV_API_REDUCE_TX_POWER: This ucode supports v5 of
 * the REDUCE_TX_POWER_CMD.
 * @IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF: This ucode supports the short
 * version of the beacon notification.
 * @IWL_UCODE_TLV_API_BEACON_FILTER_V4: This ucode supports v4 of
 * BEACON_FILTER_CONFIG_API_S_VER_4.
 * @IWL_UCODE_TLV_API_REGULATORY_NVM_INFO: This ucode supports v4 of
 * REGULATORY_NVM_GET_INFO_RSP_API_S.
 * @IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ: This ucode supports v7 of
 * LOCATION_RANGE_REQ_CMD_API_S and v6 of LOCATION_RANGE_RESP_NTFY_API_S.
 * @IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS: This ucode supports v2 of
 * SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S and v3 of
 * SCAN_OFFLOAD_PROFILES_QUERY_RSP_S.
 * @IWL_UCODE_TLV_API_MBSSID_HE: This ucode supports v2 of
 * STA_CONTEXT_DOT11AX_API_S
 * @IWL_UCODE_TLV_API_FTM_RTT_ACCURACY: version 7 of the range response API
 * is supported by FW, this indicates the RTT confidence value
 * @IWL_UCODE_TLV_API_SAR_TABLE_VER: This ucode supports different sar
 * version tables.
 * @IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG: This ucode supports v3 of
 * SCAN_CONFIG_DB_CMD_API_S.
 * @IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP: support for setting adaptive dwell
 * number of APs in the 5 GHz band
 * @IWL_UCODE_TLV_API_BAND_IN_RX_DATA: FW reports band number in RX notification
 * @IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX: Firmware offloaded the station disable tx
 * logic.
 * @IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR: Firmware supports clearing the debug
 * internal buffer
 * @IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD: Firmware doesn't need the host to
 * configure the smart fifo
 *
 * @NUM_IWL_UCODE_TLV_API: number of bits used
 */
enum iwl_ucode_tlv_api {
 /* API Set 0 */
 IWL_UCODE_TLV_API_FRAGMENTED_SCAN = (__force iwl_ucode_tlv_api_t)8,
 IWL_UCODE_TLV_API_WIFI_MCC_UPDATE = (__force iwl_ucode_tlv_api_t)9,
 IWL_UCODE_TLV_API_LQ_SS_PARAMS  = (__force iwl_ucode_tlv_api_t)18,
 IWL_UCODE_TLV_API_NEW_VERSION  = (__force iwl_ucode_tlv_api_t)20,
 IWL_UCODE_TLV_API_SCAN_TSF_REPORT = (__force iwl_ucode_tlv_api_t)28,
 IWL_UCODE_TLV_API_TKIP_MIC_KEYS  = (__force iwl_ucode_tlv_api_t)29,
 IWL_UCODE_TLV_API_STA_TYPE  = (__force iwl_ucode_tlv_api_t)30,
 IWL_UCODE_TLV_API_NAN2_VER2  = (__force iwl_ucode_tlv_api_t)31,
 /* API Set 1 */
 IWL_UCODE_TLV_API_ADAPTIVE_DWELL = (__force iwl_ucode_tlv_api_t)32,
 IWL_UCODE_TLV_API_OCE   = (__force iwl_ucode_tlv_api_t)33,
 IWL_UCODE_TLV_API_NEW_BEACON_TEMPLATE = (__force iwl_ucode_tlv_api_t)34,
 IWL_UCODE_TLV_API_NEW_RX_STATS  = (__force iwl_ucode_tlv_api_t)35,
 IWL_UCODE_TLV_API_WOWLAN_KEY_MATERIAL = (__force iwl_ucode_tlv_api_t)36,
 IWL_UCODE_TLV_API_QUOTA_LOW_LATENCY = (__force iwl_ucode_tlv_api_t)38,
 IWL_UCODE_TLV_API_DEPRECATE_TTAK = (__force iwl_ucode_tlv_api_t)41,
 IWL_UCODE_TLV_API_ADAPTIVE_DWELL_V2 = (__force iwl_ucode_tlv_api_t)42,
 IWL_UCODE_TLV_API_FRAG_EBS  = (__force iwl_ucode_tlv_api_t)44,
 IWL_UCODE_TLV_API_REDUCE_TX_POWER = (__force iwl_ucode_tlv_api_t)45,
 IWL_UCODE_TLV_API_SHORT_BEACON_NOTIF = (__force iwl_ucode_tlv_api_t)46,
 IWL_UCODE_TLV_API_BEACON_FILTER_V4      = (__force iwl_ucode_tlv_api_t)47,
 IWL_UCODE_TLV_API_REGULATORY_NVM_INFO   = (__force iwl_ucode_tlv_api_t)48,
 IWL_UCODE_TLV_API_FTM_NEW_RANGE_REQ     = (__force iwl_ucode_tlv_api_t)49,
 IWL_UCODE_TLV_API_SCAN_OFFLOAD_CHANS    = (__force iwl_ucode_tlv_api_t)50,
 IWL_UCODE_TLV_API_MBSSID_HE  = (__force iwl_ucode_tlv_api_t)52,
 IWL_UCODE_TLV_API_WOWLAN_TCP_SYN_WAKE = (__force iwl_ucode_tlv_api_t)53,
 IWL_UCODE_TLV_API_FTM_RTT_ACCURACY      = (__force iwl_ucode_tlv_api_t)54,
 IWL_UCODE_TLV_API_SAR_TABLE_VER         = (__force iwl_ucode_tlv_api_t)55,
 IWL_UCODE_TLV_API_REDUCED_SCAN_CONFIG   = (__force iwl_ucode_tlv_api_t)56,
 IWL_UCODE_TLV_API_ADWELL_HB_DEF_N_AP = (__force iwl_ucode_tlv_api_t)57,
 IWL_UCODE_TLV_API_SCAN_EXT_CHAN_VER = (__force iwl_ucode_tlv_api_t)58,
 IWL_UCODE_TLV_API_BAND_IN_RX_DATA = (__force iwl_ucode_tlv_api_t)59,
 /* API Set 2 */
 IWL_UCODE_TLV_API_NO_HOST_DISABLE_TX = (__force iwl_ucode_tlv_api_t)66,
 IWL_UCODE_TLV_API_INT_DBG_BUF_CLEAR     = (__force iwl_ucode_tlv_api_t)67,
 IWL_UCODE_TLV_API_SMART_FIFO_OFFLOAD    = (__force iwl_ucode_tlv_api_t)68,

 NUM_IWL_UCODE_TLV_API
/*
 * This construction make both sparse (which cannot increment the previous
 * member due to its bitwise type) and kernel-doc (which doesn't understand
 * the ifdef/else properly) work.
 */
#ifdef __CHECKER__
#define __CHECKER_NUM_IWL_UCODE_TLV_API 128
  = (__force iwl_ucode_tlv_api_t)__CHECKER_NUM_IWL_UCODE_TLV_API,
#define NUM_IWL_UCODE_TLV_API __CHECKER_NUM_IWL_UCODE_TLV_API
#endif
};

typedef unsigned int __bitwise iwl_ucode_tlv_capa_t;

/**
 * enum iwl_ucode_tlv_capa - ucode capabilities
 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 * tx power value into TPC Report action frame and Link Measurement Report
 * action frame
 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 * channel in DS parameter set element in probe requests.
 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 * probe requests.
 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 * which also implies support for the scheduler configuration command
 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 * @IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG: Consolidated D3-D0 image
 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
 * @IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD: supports U-APSD on p2p interface when it
 * is standalone or with a BSS station interface in the same binding.
 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
 * sources for the MCC. This TLV bit is a future replacement to
 * IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
 * is supported.
 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan (no longer used)
 * @IWL_UCODE_TLV_CAPA_FRAGMENTED_PNVM_IMG: supports fragmented PNVM image
 * @IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT: the firmware supports setting
 * stabilization latency for SoCs.
 * @IWL_UCODE_TLV_CAPA_STA_PM_NOTIF: firmware will send STA PM notification
 * @IWL_UCODE_TLV_CAPA_TLC_OFFLOAD: firmware implements rate scaling algorithm
 * @IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA: firmware implements quota related
 * @IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2: firmware implements Coex Schema 2
 * IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD: firmware supports CSA command
 * @IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS: firmware supports ultra high band
 * (6 GHz).
 * @IWL_UCODE_TLV_CAPA_CS_MODIFY: firmware supports modify action CSA command
 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
 * @IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT: supports bt-coex Multi-priority LUT
 * @IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD: the firmware supports CSA
 * countdown offloading. Beacon notifications are not sent to the host.
 * The fw also offloads TBTT alignment.
 * @IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION: firmware will decide on what
 * antenna the beacon should be transmitted
 * @IWL_UCODE_TLV_CAPA_BEACON_STORING: firmware will store the latest beacon
 * from AP and will send it upon d0i3 exit.
 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3: support LAR API V3
 * @IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW: firmware responsible for CT-kill
 * @IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT: supports temperature
 * thresholds reporting
 * @IWL_UCODE_TLV_CAPA_CTDP_SUPPORT: supports cTDP command
 * @IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED: supports usniffer enabled in
 * regular image.
 * @IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG: support getting more shared
 * memory addresses from the firmware.
 * @IWL_UCODE_TLV_CAPA_LQM_SUPPORT: supports Link Quality Measurement
 * @IWL_UCODE_TLV_CAPA_TX_POWER_ACK: reduced TX power API has larger
 * command size (command version 4) that supports toggling ACK TX
 * power reduction.
 * @IWL_UCODE_TLV_CAPA_D3_DEBUG: supports debug recording during D3
 * @IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT: MCC response support 11ax
 * capability.
 * @IWL_UCODE_TLV_CAPA_CSI_REPORTING: firmware is capable of being configured
 * to report the CSI information with (certain) RX frames
 * @IWL_UCODE_TLV_CAPA_FTM_CALIBRATED: has FTM calibrated and thus supports both
 * initiator and responder
 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA: supports (de)activating UNII-4
 * for US/CA/WW from BIOS
 * @IWL_UCODE_TLV_CAPA_PROTECTED_TWT: Supports protection of TWT action frames
 * @IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE: Supports the firmware handshake in
 * reset flow
 * @IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN: Support for passive scan on 6GHz PSC
 *      channels even when these are not enabled.
 * @IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT: Support for indicating dump collection
 * complete to FW.
 * @IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT: Support SPP (signaling and payload
 * protected) A-MSDU.
 * @IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT: Support secure LTF measurement.
 * @IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS: Support monitor mode on otherwise
 * passive channels
 * @IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA: supports (de)activating 5G9
 * for CA from BIOS.
 * @IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT: supports %TAS_UHB_ALLOWED_CANADA
 * @IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT: external FSEQ image support
 * @IWL_UCODE_TLV_CAPA_FW_ACCEPTS_RAW_DSM_TABLE: Firmware has capability of
 * handling raw DSM table data.
 *
 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
 */
enum iwl_ucode_tlv_capa {
 /* set 0 */
 IWL_UCODE_TLV_CAPA_D0I3_SUPPORT   = (__force iwl_ucode_tlv_capa_t)0,
 IWL_UCODE_TLV_CAPA_LAR_SUPPORT   = (__force iwl_ucode_tlv_capa_t)1,
 IWL_UCODE_TLV_CAPA_UMAC_SCAN   = (__force iwl_ucode_tlv_capa_t)2,
 IWL_UCODE_TLV_CAPA_BEAMFORMER   = (__force iwl_ucode_tlv_capa_t)3,
 IWL_UCODE_TLV_CAPA_TDLS_SUPPORT   = (__force iwl_ucode_tlv_capa_t)6,
 IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = (__force iwl_ucode_tlv_capa_t)8,
 IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)9,
 IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = (__force iwl_ucode_tlv_capa_t)10,
 IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT  = (__force iwl_ucode_tlv_capa_t)11,
 IWL_UCODE_TLV_CAPA_DQA_SUPPORT   = (__force iwl_ucode_tlv_capa_t)12,
 IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH  = (__force iwl_ucode_tlv_capa_t)13,
 IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG  = (__force iwl_ucode_tlv_capa_t)17,
 IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT  = (__force iwl_ucode_tlv_capa_t)18,
 IWL_UCODE_TLV_CAPA_CSUM_SUPPORT   = (__force iwl_ucode_tlv_capa_t)21,
 IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS  = (__force iwl_ucode_tlv_capa_t)22,
 IWL_UCODE_TLV_CAPA_P2P_SCM_UAPSD  = (__force iwl_ucode_tlv_capa_t)26,
 IWL_UCODE_TLV_CAPA_BT_COEX_PLCR   = (__force iwl_ucode_tlv_capa_t)28,
 IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC  = (__force iwl_ucode_tlv_capa_t)29,
 IWL_UCODE_TLV_CAPA_BT_COEX_RRC   = (__force iwl_ucode_tlv_capa_t)30,
 IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT  = (__force iwl_ucode_tlv_capa_t)31,

 /* set 1 */
 IWL_UCODE_TLV_CAPA_FRAGMENTED_PNVM_IMG  = (__force iwl_ucode_tlv_capa_t)32,
 IWL_UCODE_TLV_CAPA_SOC_LATENCY_SUPPORT  = (__force iwl_ucode_tlv_capa_t)37,
 IWL_UCODE_TLV_CAPA_STA_PM_NOTIF   = (__force iwl_ucode_tlv_capa_t)38,
 IWL_UCODE_TLV_CAPA_BINDING_CDB_SUPPORT  = (__force iwl_ucode_tlv_capa_t)39,
 IWL_UCODE_TLV_CAPA_CDB_SUPPORT   = (__force iwl_ucode_tlv_capa_t)40,
 IWL_UCODE_TLV_CAPA_D0I3_END_FIRST  = (__force iwl_ucode_tlv_capa_t)41,
 IWL_UCODE_TLV_CAPA_TLC_OFFLOAD                  = (__force iwl_ucode_tlv_capa_t)43,
 IWL_UCODE_TLV_CAPA_DYNAMIC_QUOTA                = (__force iwl_ucode_tlv_capa_t)44,
 IWL_UCODE_TLV_CAPA_COEX_SCHEMA_2  = (__force iwl_ucode_tlv_capa_t)45,
 IWL_UCODE_TLV_CAPA_CHANNEL_SWITCH_CMD  = (__force iwl_ucode_tlv_capa_t)46,
 IWL_UCODE_TLV_CAPA_FTM_CALIBRATED  = (__force iwl_ucode_tlv_capa_t)47,
 IWL_UCODE_TLV_CAPA_ULTRA_HB_CHANNELS  = (__force iwl_ucode_tlv_capa_t)48,
 IWL_UCODE_TLV_CAPA_CS_MODIFY   = (__force iwl_ucode_tlv_capa_t)49,
 IWL_UCODE_TLV_CAPA_SET_LTR_GEN2   = (__force iwl_ucode_tlv_capa_t)50,
 IWL_UCODE_TLV_CAPA_SET_PPAG   = (__force iwl_ucode_tlv_capa_t)52,
 IWL_UCODE_TLV_CAPA_TAS_CFG   = (__force iwl_ucode_tlv_capa_t)53,
 IWL_UCODE_TLV_CAPA_SESSION_PROT_CMD  = (__force iwl_ucode_tlv_capa_t)54,
 IWL_UCODE_TLV_CAPA_PROTECTED_TWT  = (__force iwl_ucode_tlv_capa_t)56,
 IWL_UCODE_TLV_CAPA_FW_RESET_HANDSHAKE  = (__force iwl_ucode_tlv_capa_t)57,
 IWL_UCODE_TLV_CAPA_PASSIVE_6GHZ_SCAN  = (__force iwl_ucode_tlv_capa_t)58,
 IWL_UCODE_TLV_CAPA_HIDDEN_6GHZ_SCAN  = (__force iwl_ucode_tlv_capa_t)59,
 IWL_UCODE_TLV_CAPA_BROADCAST_TWT  = (__force iwl_ucode_tlv_capa_t)60,
 IWL_UCODE_TLV_CAPA_COEX_HIGH_PRIO  = (__force iwl_ucode_tlv_capa_t)61,
 IWL_UCODE_TLV_CAPA_RFIM_SUPPORT   = (__force iwl_ucode_tlv_capa_t)62,
 IWL_UCODE_TLV_CAPA_BAID_ML_SUPPORT  = (__force iwl_ucode_tlv_capa_t)63,

 /* set 2 */
 IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE  = (__force iwl_ucode_tlv_capa_t)64,
 IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS  = (__force iwl_ucode_tlv_capa_t)65,
 IWL_UCODE_TLV_CAPA_BT_MPLUT_SUPPORT  = (__force iwl_ucode_tlv_capa_t)67,
 IWL_UCODE_TLV_CAPA_MULTI_QUEUE_RX_SUPPORT = (__force iwl_ucode_tlv_capa_t)68,
 IWL_UCODE_TLV_CAPA_CSA_AND_TBTT_OFFLOAD  = (__force iwl_ucode_tlv_capa_t)70,
 IWL_UCODE_TLV_CAPA_BEACON_ANT_SELECTION  = (__force iwl_ucode_tlv_capa_t)71,
 IWL_UCODE_TLV_CAPA_BEACON_STORING  = (__force iwl_ucode_tlv_capa_t)72,
 IWL_UCODE_TLV_CAPA_LAR_SUPPORT_V3  = (__force iwl_ucode_tlv_capa_t)73,
 IWL_UCODE_TLV_CAPA_CT_KILL_BY_FW  = (__force iwl_ucode_tlv_capa_t)74,
 IWL_UCODE_TLV_CAPA_TEMP_THS_REPORT_SUPPORT = (__force iwl_ucode_tlv_capa_t)75,
 IWL_UCODE_TLV_CAPA_CTDP_SUPPORT   = (__force iwl_ucode_tlv_capa_t)76,
 IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED  = (__force iwl_ucode_tlv_capa_t)77,
 IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG = (__force iwl_ucode_tlv_capa_t)80,
 IWL_UCODE_TLV_CAPA_LQM_SUPPORT   = (__force iwl_ucode_tlv_capa_t)81,
 IWL_UCODE_TLV_CAPA_TX_POWER_ACK   = (__force iwl_ucode_tlv_capa_t)84,
 IWL_UCODE_TLV_CAPA_D3_DEBUG   = (__force iwl_ucode_tlv_capa_t)87,
 IWL_UCODE_TLV_CAPA_LED_CMD_SUPPORT  = (__force iwl_ucode_tlv_capa_t)88,
 IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT = (__force iwl_ucode_tlv_capa_t)89,
 IWL_UCODE_TLV_CAPA_CSI_REPORTING  = (__force iwl_ucode_tlv_capa_t)90,
 IWL_UCODE_TLV_CAPA_DBG_SUSPEND_RESUME_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)92,
 IWL_UCODE_TLV_CAPA_DBG_BUF_ALLOC_CMD_SUPP = (__force iwl_ucode_tlv_capa_t)93,

 /* set 3 */
 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_UNII4_US_CA = (__force iwl_ucode_tlv_capa_t)96,

 /*
  * @IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT: supports PSC channels
 */
 IWL_UCODE_TLV_CAPA_PSC_CHAN_SUPPORT  = (__force iwl_ucode_tlv_capa_t)98,

 IWL_UCODE_TLV_CAPA_BIGTK_SUPPORT  = (__force iwl_ucode_tlv_capa_t)100,
 IWL_UCODE_TLV_CAPA_SPP_AMSDU_SUPPORT  = (__force iwl_ucode_tlv_capa_t)103,
 IWL_UCODE_TLV_CAPA_DRAM_FRAG_SUPPORT  = (__force iwl_ucode_tlv_capa_t)104,
 IWL_UCODE_TLV_CAPA_DUMP_COMPLETE_SUPPORT = (__force iwl_ucode_tlv_capa_t)105,
 IWL_UCODE_TLV_CAPA_SYNCED_TIME   = (__force iwl_ucode_tlv_capa_t)106,
 IWL_UCODE_TLV_CAPA_TIME_SYNC_BOTH_FTM_TM        = (__force iwl_ucode_tlv_capa_t)108,
 IWL_UCODE_TLV_CAPA_BIGTK_TX_SUPPORT  = (__force iwl_ucode_tlv_capa_t)109,
 IWL_UCODE_TLV_CAPA_MLD_API_SUPPORT  = (__force iwl_ucode_tlv_capa_t)110,
 IWL_UCODE_TLV_CAPA_SCAN_DONT_TOGGLE_ANT         = (__force iwl_ucode_tlv_capa_t)111,
 IWL_UCODE_TLV_CAPA_PPAG_CHINA_BIOS_SUPPORT = (__force iwl_ucode_tlv_capa_t)112,
 IWL_UCODE_TLV_CAPA_OFFLOAD_BTM_SUPPORT  = (__force iwl_ucode_tlv_capa_t)113,
 IWL_UCODE_TLV_CAPA_STA_EXP_MFP_SUPPORT  = (__force iwl_ucode_tlv_capa_t)114,
 IWL_UCODE_TLV_CAPA_SNIFF_VALIDATE_SUPPORT = (__force iwl_ucode_tlv_capa_t)116,
 IWL_UCODE_TLV_CAPA_CHINA_22_REG_SUPPORT  = (__force iwl_ucode_tlv_capa_t)117,
 IWL_UCODE_TLV_CAPA_SECURE_LTF_SUPPORT  = (__force iwl_ucode_tlv_capa_t)121,
 IWL_UCODE_TLV_CAPA_MONITOR_PASSIVE_CHANS = (__force iwl_ucode_tlv_capa_t)122,
 IWL_UCODE_TLV_CAPA_BIOS_OVERRIDE_5G9_FOR_CA = (__force iwl_ucode_tlv_capa_t)123,
 IWL_UCODE_TLV_CAPA_UHB_CANADA_TAS_SUPPORT = (__force iwl_ucode_tlv_capa_t)124,
 IWL_UCODE_TLV_CAPA_EXT_FSEQ_IMAGE_SUPPORT = (__force iwl_ucode_tlv_capa_t)125,

 /* set 4 */
 /**
  * @IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT: FW reset handshake is needed
  * during assert handling even if the dump isn't split
 */
 IWL_UCODE_TLV_CAPA_RESET_DURING_ASSERT  = (__force iwl_ucode_tlv_capa_t)(4 * 32 +  0),
 IWL_UCODE_TLV_CAPA_FW_ACCEPTS_RAW_DSM_TABLE  = (__force iwl_ucode_tlv_capa_t)(4 * 32 + 1),
 NUM_IWL_UCODE_TLV_CAPA
/*
 * This construction make both sparse (which cannot increment the previous
 * member due to its bitwise type) and kernel-doc (which doesn't understand
 * the ifdef/else properly) work.
 */
#ifdef __CHECKER__
#define __CHECKER_NUM_IWL_UCODE_TLV_CAPA 128
  = (__force iwl_ucode_tlv_capa_t)__CHECKER_NUM_IWL_UCODE_TLV_CAPA,
#define NUM_IWL_UCODE_TLV_CAPA __CHECKER_NUM_IWL_UCODE_TLV_CAPA
#endif
};

/* The default calibrate table size if not specified by firmware file */
#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE  19
#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE   253

/* The default max probe length if not specified by the firmware file */
#define IWL_DEFAULT_MAX_PROBE_LENGTH 200

/*
 * For 16.0 uCode and above, there is no differentiation between sections,
 * just an offset to the HW address.
 */
#define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
#define PAGING_SEPARATOR_SECTION 0xAAAABBBB

/* uCode version contains 4 values: Major/Minor/API/Serial */
#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)

/**
 * struct iwl_tlv_calib_ctrl - Calibration control struct.
 * Sent as part of the phy configuration command.
 * @flow_trigger: bitmap for which calibrations to perform according to
 *  flow triggers.
 * @event_trigger: bitmap for which calibrations to perform according to
 *  event triggers.
 */
struct iwl_tlv_calib_ctrl {
 __le32 flow_trigger;
 __le32 event_trigger;
} __packed;

enum iwl_fw_phy_cfg {
 FW_PHY_CFG_RADIO_TYPE_POS = 0,
 FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 FW_PHY_CFG_RADIO_STEP_POS = 2,
 FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 FW_PHY_CFG_RADIO_DASH_POS = 4,
 FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 FW_PHY_CFG_TX_CHAIN_POS = 16,
 FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 FW_PHY_CFG_RX_CHAIN_POS = 20,
 FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 FW_PHY_CFG_CHAIN_SAD_POS = 23,
 FW_PHY_CFG_CHAIN_SAD_ENABLED = 0x1 << FW_PHY_CFG_CHAIN_SAD_POS,
 FW_PHY_CFG_CHAIN_SAD_ANT_A = 0x2 << FW_PHY_CFG_CHAIN_SAD_POS,
 FW_PHY_CFG_CHAIN_SAD_ANT_B = 0x4 << FW_PHY_CFG_CHAIN_SAD_POS,
 FW_PHY_CFG_SHARED_CLK = BIT(31),
};

enum iwl_fw_dbg_reg_operator {
 CSR_ASSIGN,
 CSR_SETBIT,
 CSR_CLEARBIT,

 PRPH_ASSIGN,
 PRPH_SETBIT,
 PRPH_CLEARBIT,

 INDIRECT_ASSIGN,
 INDIRECT_SETBIT,
 INDIRECT_CLEARBIT,

 PRPH_BLOCKBIT,
};

/**
 * struct iwl_fw_dbg_reg_op - an operation on a register
 *
 * @op: &enum iwl_fw_dbg_reg_operator
 * @reserved: reserved
 * @addr: offset of the register
 * @val: value
 */
struct iwl_fw_dbg_reg_op {
 u8 op;
 u8 reserved[3];
 __le32 addr;
 __le32 val;
} __packed;

/**
 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 *
 * @SMEM_MODE: monitor stores the data in SMEM
 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 * @MARBH_MODE: monitor stores the data in MARBH buffer
 * @MIPI_MODE: monitor outputs the data through the MIPI interface
 */
enum iwl_fw_dbg_monitor_mode {
 SMEM_MODE = 0,
 EXTERNAL_MODE = 1,
 MARBH_MODE = 2,
 MIPI_MODE = 3,
};

/**
 * struct iwl_fw_dbg_mem_seg_tlv - configures the debug data memory segments
 *
 * @data_type: the memory segment type to record
 * @ofs: the memory segment offset
 * @len: the memory segment length, in bytes
 *
 * This parses IWL_UCODE_TLV_FW_MEM_SEG
 */
struct iwl_fw_dbg_mem_seg_tlv {
 __le32 data_type;
 __le32 ofs;
 __le32 len;
} __packed;

/**
 * struct iwl_fw_dbg_dest_tlv_v1 - configures the destination of the debug data
 *
 * @version: version of the TLV - currently 0
 * @monitor_mode: &enum iwl_fw_dbg_monitor_mode
 * @size_power: buffer size will be 2^(size_power + 11)
 * @reserved: reserved
 * @base_reg: addr of the base addr register (PRPH)
 * @end_reg:  addr of the end addr register (PRPH)
 * @write_ptr_reg: the addr of the reg of the write pointer
 * @wrap_count: the addr of the reg of the wrap_count
 * @base_shift: shift right of the base addr reg
 * @end_shift: shift right of the end addr reg
 * @reg_ops: array of registers operations
 *
 * This parses IWL_UCODE_TLV_FW_DBG_DEST
 */
struct iwl_fw_dbg_dest_tlv_v1 {
 u8 version;
 u8 monitor_mode;
 u8 size_power;
 u8 reserved;
 __le32 base_reg;
 __le32 end_reg;
 __le32 write_ptr_reg;
 __le32 wrap_count;
 u8 base_shift;
 u8 end_shift;
 struct iwl_fw_dbg_reg_op reg_ops[];
} __packed;

/* Mask of the register for defining the LDBG MAC2SMEM buffer SMEM size */
#define IWL_LDBG_M2S_BUF_SIZE_MSK 0x0fff0000
/* Mask of the register for defining the LDBG MAC2SMEM SMEM base address */
#define IWL_LDBG_M2S_BUF_BA_MSK  0x00000fff
/* The smem buffer chunks are in units of 256 bits */
#define IWL_M2S_UNIT_SIZE   0x100

struct iwl_fw_dbg_dest_tlv {
 u8 version;
 u8 monitor_mode;
 u8 size_power;
 u8 reserved;
 __le32 cfg_reg;
 __le32 write_ptr_reg;
 __le32 wrap_count;
 u8 base_shift;
 u8 size_shift;
 struct iwl_fw_dbg_reg_op reg_ops[];
} __packed;

struct iwl_fw_dbg_conf_hcmd {
 u8 id;
 u8 reserved;
 __le16 len;
 u8 data[];
} __packed;

/**
 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
 *
 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
 * collect only monitor data
 */
enum iwl_fw_dbg_trigger_mode {
 IWL_FW_DBG_TRIGGER_START = BIT(0),
 IWL_FW_DBG_TRIGGER_STOP = BIT(1),
 IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
};

/**
 * enum iwl_fw_dbg_trigger_flags - the flags supported by wrt triggers
 * @IWL_FW_DBG_FORCE_RESTART: force a firmware restart
 */
enum iwl_fw_dbg_trigger_flags {
 IWL_FW_DBG_FORCE_RESTART = BIT(0),
};

/**
 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
 */
enum iwl_fw_dbg_trigger_vif_type {
 IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
 IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
 IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
 IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
 IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
 IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
 IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
};

/**
 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
 * @id: &enum iwl_fw_dbg_trigger
 * @vif_type: &enum iwl_fw_dbg_trigger_vif_type
 * @stop_conf_ids: bitmap of configurations this trigger relates to.
 * if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
 * to the currently running configuration is set, the data should be
 * collected.
 * @stop_delay: how many milliseconds to wait before collecting the data
 * after the STOP trigger fires.
 * @mode: &enum iwl_fw_dbg_trigger_mode - can be stop / start of both
 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
 * configuration should be applied when the triggers kicks in.
 * @occurrences: number of occurrences. 0 means the trigger will never fire.
 * @trig_dis_ms: the time, in milliseconds, after an occurrence of this
 * trigger in which another occurrence should be ignored.
 * @flags: &enum iwl_fw_dbg_trigger_flags
 * @reserved: reserved (for alignment)
 * @data: trigger data
 */
struct iwl_fw_dbg_trigger_tlv {
 __le32 id;
 __le32 vif_type;
 __le32 stop_conf_ids;
 __le32 stop_delay;
 u8 mode;
 u8 start_conf_id;
 __le16 occurrences;
 __le16 trig_dis_ms;
 u8 flags;
 u8 reserved[5];

 u8 data[];
} __packed;

#define FW_DBG_START_FROM_ALIVE 0
#define FW_DBG_CONF_MAX  32
#define FW_DBG_INVALID  0xff

/**
 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
 * @start_consec_missed_bcon: start recording if threshold is crossed.
 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
 * @reserved1: reserved
 * @reserved2: reserved
 */
struct iwl_fw_dbg_trigger_missed_bcon {
 __le32 stop_consec_missed_bcon;
 __le32 stop_consec_missed_bcon_since_rx;
 __le32 reserved2[2];
 __le32 start_consec_missed_bcon;
 __le32 start_consec_missed_bcon_since_rx;
 __le32 reserved1[2];
} __packed;

/**
 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
 * @cmds: the list of commands to trigger the collection on
 */
struct iwl_fw_dbg_trigger_cmd {
 struct cmd {
  u8 cmd_id;
  u8 group_id;
 } __packed cmds[16];
} __packed;

/**
 * struct iwl_fw_dbg_trigger_stats - configures trigger for statistics
 * @stop_offset: the offset of the value to be monitored
 * @stop_threshold: the threshold above which to collect
 * @start_offset: the offset of the value to be monitored
 * @start_threshold: the threshold above which to start recording
 */
struct iwl_fw_dbg_trigger_stats {
 __le32 stop_offset;
 __le32 stop_threshold;
 __le32 start_offset;
 __le32 start_threshold;
} __packed;

/**
 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
 * @rssi: RSSI value to trigger at
 */
struct iwl_fw_dbg_trigger_low_rssi {
 __le32 rssi;
} __packed;

/**
 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
 * @stop_auth_denied: number of denied authentication to collect
 * @stop_auth_timeout: number of authentication timeout to collect
 * @stop_rx_deauth: number of Rx deauth before to collect
 * @stop_tx_deauth: number of Tx deauth before to collect
 * @stop_assoc_denied: number of denied association to collect
 * @stop_assoc_timeout: number of association timeout to collect
 * @stop_connection_loss: number of connection loss to collect
 * @start_auth_denied: number of denied authentication to start recording
 * @start_auth_timeout: number of authentication timeout to start recording
 * @start_rx_deauth: number of Rx deauth to start recording
 * @start_tx_deauth: number of Tx deauth to start recording
 * @start_assoc_denied: number of denied association to start recording
 * @start_assoc_timeout: number of association timeout to start recording
 * @start_connection_loss: number of connection loss to start recording
 */
struct iwl_fw_dbg_trigger_mlme {
 u8 stop_auth_denied;
 u8 stop_auth_timeout;
 u8 stop_rx_deauth;
 u8 stop_tx_deauth;

 u8 stop_assoc_denied;
 u8 stop_assoc_timeout;
 u8 stop_connection_loss;
 u8 reserved;

 u8 start_auth_denied;
 u8 start_auth_timeout;
 u8 start_rx_deauth;
 u8 start_tx_deauth;

 u8 start_assoc_denied;
 u8 start_assoc_timeout;
 u8 start_connection_loss;
 u8 reserved2;
} __packed;

/**
 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
 * @command_queue: timeout for the command queue in ms
 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
 * @softap: timeout for the queues of a softAP in ms
 * @p2p_go: timeout for the queues of a P2P GO in ms
 * @p2p_client: timeout for the queues of a P2P client in ms
 * @p2p_device: timeout for the queues of a P2P device in ms
 * @ibss: timeout for the queues of an IBSS in ms
 * @tdls: timeout for the queues of a TDLS station in ms
 */
struct iwl_fw_dbg_trigger_txq_timer {
 __le32 command_queue;
 __le32 bss;
 __le32 softap;
 __le32 p2p_go;
 __le32 p2p_client;
 __le32 p2p_device;
 __le32 ibss;
 __le32 tdls;
 __le32 reserved[4];
} __packed;

/**
 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
 * trigger each time a time event notification that relates to time event
 * id with one of the actions in the bitmap is received and
 * BIT(notif->status) is set in status_bitmap.
 *
 */
struct iwl_fw_dbg_trigger_time_event {
 struct {
  __le32 id;
  __le32 action_bitmap;
  __le32 status_bitmap;
 } __packed time_events[16];
} __packed;

/**
 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
 * when an Rx BlockAck session is started.
 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
 * when an Rx BlockAck session is stopped.
 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
 * when a Tx BlockAck session is started.
 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
 * when a Tx BlockAck session is stopped.
 * rx_bar: tid bitmap to configure on what tid the trigger should occur
 * when a BAR is received (for a Tx BlockAck session).
 * tx_bar: tid bitmap to configure on what tid the trigger should occur
 * when a BAR is send (for an Rx BlocAck session).
 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
 * when a frame times out in the reordering buffer.
 */
struct iwl_fw_dbg_trigger_ba {
 __le16 rx_ba_start;
 __le16 rx_ba_stop;
 __le16 tx_ba_start;
 __le16 tx_ba_stop;
 __le16 rx_bar;
 __le16 tx_bar;
 __le16 frame_timeout;
} __packed;

/**
 * struct iwl_fw_dbg_trigger_tdls - configures trigger for TDLS events.
 * @action_bitmap: the TDLS action to trigger the collection upon
 * @peer_mode: trigger on specific peer or all
 * @peer: the TDLS peer to trigger the collection on
 */
struct iwl_fw_dbg_trigger_tdls {
 u8 action_bitmap;
 u8 peer_mode;
 u8 peer[ETH_ALEN];
 u8 reserved[4];
} __packed;

/**
 * struct iwl_fw_dbg_trigger_tx_status - configures trigger for tx response
 *  status.
 * @statuses: the list of statuses to trigger the collection on
 */
struct iwl_fw_dbg_trigger_tx_status {
 struct tx_status {
  u8 status;
  u8 reserved[3];
 } __packed statuses[16];
 __le32 reserved[2];
} __packed;

/**
 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
 * @id: conf id
 * @usniffer: should the uSniffer image be used
 * @num_of_hcmds: how many HCMDs to send are present here
 * @hcmd: a variable length host command to be sent to apply the configuration.
 * If there is more than one HCMD to send, they will appear one after the
 * other and be sent in the order that they appear in.
 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
 * %FW_DBG_CONF_MAX configuration per run.
 */
struct iwl_fw_dbg_conf_tlv {
 u8 id;
 u8 usniffer;
 u8 reserved;
 u8 num_of_hcmds;
 struct iwl_fw_dbg_conf_hcmd hcmd;
} __packed;

#define IWL_FW_CMD_VER_UNKNOWN 99

/**
 * struct iwl_fw_cmd_version - firmware command version entry
 * @cmd: command ID
 * @group: group ID
 * @cmd_ver: command version
 * @notif_ver: notification version
 */
struct iwl_fw_cmd_version {
 u8 cmd;
 u8 group;
 u8 cmd_ver;
 u8 notif_ver;
} __packed;

struct iwl_fw_tcm_error_addr {
 __le32 addr;
}; /* FW_TLV_TCM_ERROR_INFO_ADDRS_S */

struct iwl_fw_dump_exclude {
 __le32 addr, size;
};

struct iwl_fw_fseq_bin_version {
 __le32 major, minor;
}; /* FW_TLV_FSEQ_BIN_VERSION_S */

static inline size_t _iwl_tlv_array_len(const struct iwl_ucode_tlv *tlv,
     size_t fixed_size, size_t var_size)
{
 size_t var_len = le32_to_cpu(tlv->length) - fixed_size;

 if (WARN_ON(var_len % var_size))
  return 0;

 return var_len / var_size;
}

#define iwl_tlv_array_len(_tlv_ptr, _struct_ptr, _memb)   \
 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)),  \
      sizeof(_struct_ptr->_memb[0]))

#define iwl_tlv_array_len_with_size(_tlv_ptr, _struct_ptr, _size) \
 _iwl_tlv_array_len((_tlv_ptr), sizeof(*(_struct_ptr)), _size)

/* external FSEQ file */
#define IWL_FSEQ_FILE "intel/fseq-%04x-%04x"
#define IWL_FSEQ_MAGIC "INTEL-CNV-FSEQ\n\0"

struct iwl_fseq_file {
 char magic[16];
 char version[16];
 __le32 bt_len;
 __le32 wifi_len;
 u8 reserved[8];
 u8 data[];
} __packed;

#endif  /* __iwl_fw_file_h__ */