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

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