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