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