drivers/net/wireless/intel/iwlwifi/fw/file.h

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