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 - 2014 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 - 2014 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_SEC_RT_USNIFFER   = 34,
 136         IWL_UCODE_TLV_SDIO_ADMA_ADDR    = 35,
 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 };
 142
 143 struct iwl_ucode_tlv {
 144         __le32 type;            /* see above */
 145         __le32 length;          /* not including type/length fields */
 146         u8 data[0];
 147 };
 148
 149 #define IWL_TLV_UCODE_MAGIC             0x0a4c5749
 150 #define FW_VER_HUMAN_READABLE_SZ        64
 151
 152 struct iwl_tlv_ucode_header {
 153         /*
 154          * The TLV style ucode header is distinguished from
 155          * the v1/v2 style header by first four bytes being
 156          * zero, as such is an invalid combination of
 157          * major/minor/API/serial versions.
 158          */
 159         __le32 zero;
 160         __le32 magic;
 161         u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 162         /* major/minor/API/serial or major in new format */
 163         __le32 ver;
 164         __le32 build;
 165         __le64 ignore;
 166         /*
 167          * The data contained herein has a TLV layout,
 168          * see above for the TLV header and types.
 169          * Note that each TLV is padded to a length
 170          * that is a multiple of 4 for alignment.
 171          */
 172         u8 data[0];
 173 };
 174
 175 /*
 176  * ucode TLVs
 177  *
 178  * ability to get extension for: flags & capabilities from ucode binaries files
 179  */
 180 struct iwl_ucode_api {
 181         __le32 api_index;
 182         __le32 api_flags;
 183 } __packed;
 184
 185 struct iwl_ucode_capa {
 186         __le32 api_index;
 187         __le32 api_capa;
 188 } __packed;
 189
 190 /**
 191  * enum iwl_ucode_tlv_flag - ucode API flags
 192  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 193  *      was a separate TLV but moved here to save space.
 194  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
 195  *      treats good CRC threshold as a boolean
 196  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 197  * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 198  * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
 199  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
 200  * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
 201  *      offload profile config command.
 202  * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 203  *      (rather than two) IPv6 addresses
 204  * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 205  *      from the probe request template.
 206  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
 207  * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
 208  * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
 209  * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
 210  *      P2P client interfaces simultaneously if they are in different bindings.
 211  * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
 212  *      P2P client interfaces simultaneously if they are in same bindings.
 213  * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
 214  * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
 215  * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
 216  * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
 217  * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
 218  */
 219 enum iwl_ucode_tlv_flag {
 220         IWL_UCODE_TLV_FLAGS_PAN                 = BIT(0),
 221         IWL_UCODE_TLV_FLAGS_NEWSCAN             = BIT(1),
 222         IWL_UCODE_TLV_FLAGS_MFP                 = BIT(2),
 223         IWL_UCODE_TLV_FLAGS_P2P                 = BIT(3),
 224         IWL_UCODE_TLV_FLAGS_DW_BC_TABLE         = BIT(4),
 225         IWL_UCODE_TLV_FLAGS_SHORT_BL            = BIT(7),
 226         IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS     = BIT(10),
 227         IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID       = BIT(12),
 228         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
 229         IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
 230         IWL_UCODE_TLV_FLAGS_P2P_PM              = BIT(21),
 231         IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM      = BIT(22),
 232         IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM      = BIT(23),
 233         IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT       = BIT(24),
 234         IWL_UCODE_TLV_FLAGS_EBS_SUPPORT         = BIT(25),
 235         IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD        = BIT(26),
 236         IWL_UCODE_TLV_FLAGS_BCAST_FILTERING     = BIT(29),
 237         IWL_UCODE_TLV_FLAGS_GO_UAPSD            = BIT(30),
 238 };
 239
 240 /**
 241  * enum iwl_ucode_tlv_api - ucode api
 242  * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
 243  * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 244  *      longer than the passive one, which is essential for fragmented scan.
 245  * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
 246  * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR
 247  * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
 248  *      regardless of the band or the number of the probes. FW will calculate
 249  *      the actual dwell time.
 250  * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
 251  *      through the dedicated host command.
 252  * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too.
 253  * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported.
 254  * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
 255  * @IWL_UCODE_TLV_API_STATS_V10: uCode supports/uses statistics API version 10
 256  * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
 257  */
 258 enum iwl_ucode_tlv_api {
 259         IWL_UCODE_TLV_API_BT_COEX_SPLIT         = BIT(3),
 260         IWL_UCODE_TLV_API_FRAGMENTED_SCAN       = BIT(8),
 261         IWL_UCODE_TLV_API_WIFI_MCC_UPDATE       = BIT(9),
 262         IWL_UCODE_TLV_API_HDC_PHASE_0           = BIT(10),
 263         IWL_UCODE_TLV_API_BASIC_DWELL           = BIT(13),
 264         IWL_UCODE_TLV_API_SCD_CFG               = BIT(15),
 265         IWL_UCODE_TLV_API_SINGLE_SCAN_EBS       = BIT(16),
 266         IWL_UCODE_TLV_API_ASYNC_DTM             = BIT(17),
 267         IWL_UCODE_TLV_API_LQ_SS_PARAMS          = BIT(18),
 268         IWL_UCODE_TLV_API_STATS_V10             = BIT(19),
 269         IWL_UCODE_TLV_API_NEW_VERSION           = BIT(20),
 270 };
 271
 272 /**
 273  * enum iwl_ucode_tlv_capa - ucode capabilities
 274  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 275  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 276  * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 277  * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
 278  * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 279  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 280  *      tx power value into TPC Report action frame and Link Measurement Report
 281  *      action frame
 282  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 283  *      channel in DS parameter set element in probe requests.
 284  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 285  *      probe requests.
 286  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 287  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 288  *      which also implies support for the scheduler configuration command
 289  * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 290  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 291  * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
 292  * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
 293  * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
 294  *      sources for the MCC. This TLV bit is a future replacement to
 295  *      IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
 296  *      is supported.
 297  * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
 298  */
 299 enum iwl_ucode_tlv_capa {
 300         IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = BIT(0),
 301         IWL_UCODE_TLV_CAPA_LAR_SUPPORT                  = BIT(1),
 302         IWL_UCODE_TLV_CAPA_UMAC_SCAN                    = BIT(2),
 303         IWL_UCODE_TLV_CAPA_BEAMFORMER                   = BIT(3),
 304         IWL_UCODE_TLV_CAPA_TDLS_SUPPORT                 = BIT(6),
 305         IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = BIT(8),
 306         IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = BIT(9),
 307         IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = BIT(10),
 308         IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = BIT(11),
 309         IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = BIT(12),
 310         IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH          = BIT(13),
 311         IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = BIT(18),
 312         IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS           = BIT(22),
 313         IWL_UCODE_TLV_CAPA_BT_COEX_PLCR                 = BIT(28),
 314         IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC                = BIT(29),
 315         IWL_UCODE_TLV_CAPA_BT_COEX_RRC                  = BIT(30),
 316 };
 317
 318 /* The default calibrate table size if not specified by firmware file */
 319 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
 320 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
 321 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
 322
 323 /* The default max probe length if not specified by the firmware file */
 324 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
 325
 326 /*
 327  * For 16.0 uCode and above, there is no differentiation between sections,
 328  * just an offset to the HW address.
 329  */
 330 #define IWL_UCODE_SECTION_MAX 12
 331 #define IWL_API_ARRAY_SIZE      1
 332 #define IWL_CAPABILITIES_ARRAY_SIZE     1
 333 #define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
 334
 335 /* uCode version contains 4 values: Major/Minor/API/Serial */
 336 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 337 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 338 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 339 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 340
 341 /*
 342  * Calibration control struct.
 343  * Sent as part of the phy configuration command.
 344  * @flow_trigger: bitmap for which calibrations to perform according to
 345  *              flow triggers.
 346  * @event_trigger: bitmap for which calibrations to perform according to
 347  *              event triggers.
 348  */
 349 struct iwl_tlv_calib_ctrl {
 350         __le32 flow_trigger;
 351         __le32 event_trigger;
 352 } __packed;
 353
 354 enum iwl_fw_phy_cfg {
 355         FW_PHY_CFG_RADIO_TYPE_POS = 0,
 356         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 357         FW_PHY_CFG_RADIO_STEP_POS = 2,
 358         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 359         FW_PHY_CFG_RADIO_DASH_POS = 4,
 360         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 361         FW_PHY_CFG_TX_CHAIN_POS = 16,
 362         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 363         FW_PHY_CFG_RX_CHAIN_POS = 20,
 364         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 365 };
 366
 367 #define IWL_UCODE_MAX_CS                1
 368
 369 /**
 370  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 371  * @cipher: a cipher suite selector
 372  * @flags: cipher scheme flags (currently reserved for a future use)
 373  * @hdr_len: a size of MPDU security header
 374  * @pn_len: a size of PN
 375  * @pn_off: an offset of pn from the beginning of the security header
 376  * @key_idx_off: an offset of key index byte in the security header
 377  * @key_idx_mask: a bit mask of key_idx bits
 378  * @key_idx_shift: bit shift needed to get key_idx
 379  * @mic_len: mic length in bytes
 380  * @hw_cipher: a HW cipher index used in host commands
 381  */
 382 struct iwl_fw_cipher_scheme {
 383         __le32 cipher;
 384         u8 flags;
 385         u8 hdr_len;
 386         u8 pn_len;
 387         u8 pn_off;
 388         u8 key_idx_off;
 389         u8 key_idx_mask;
 390         u8 key_idx_shift;
 391         u8 mic_len;
 392         u8 hw_cipher;
 393 } __packed;
 394
 395 enum iwl_fw_dbg_reg_operator {
 396         CSR_ASSIGN,
 397         CSR_SETBIT,
 398         CSR_CLEARBIT,
 399
 400         PRPH_ASSIGN,
 401         PRPH_SETBIT,
 402         PRPH_CLEARBIT,
 403 };
 404
 405 /**
 406  * struct iwl_fw_dbg_reg_op - an operation on a register
 407  *
 408  * @op: %enum iwl_fw_dbg_reg_operator
 409  * @addr: offset of the register
 410  * @val: value
 411  */
 412 struct iwl_fw_dbg_reg_op {
 413         u8 op;
 414         u8 reserved[3];
 415         __le32 addr;
 416         __le32 val;
 417 } __packed;
 418
 419 /**
 420  * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 421  *
 422  * @SMEM_MODE: monitor stores the data in SMEM
 423  * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 424  * @MARBH_MODE: monitor stores the data in MARBH buffer
 425  */
 426 enum iwl_fw_dbg_monitor_mode {
 427         SMEM_MODE = 0,
 428         EXTERNAL_MODE = 1,
 429         MARBH_MODE = 2,
 430 };
 431
 432 /**
 433  * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
 434  *
 435  * @version: version of the TLV - currently 0
 436  * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
 437  * @base_reg: addr of the base addr register (PRPH)
 438  * @end_reg:  addr of the end addr register (PRPH)
 439  * @write_ptr_reg: the addr of the reg of the write pointer
 440  * @wrap_count: the addr of the reg of the wrap_count
 441  * @base_shift: shift right of the base addr reg
 442  * @end_shift: shift right of the end addr reg
 443  * @reg_ops: array of registers operations
 444  *
 445  * This parses IWL_UCODE_TLV_FW_DBG_DEST
 446  */
 447 struct iwl_fw_dbg_dest_tlv {
 448         u8 version;
 449         u8 monitor_mode;
 450         u8 reserved[2];
 451         __le32 base_reg;
 452         __le32 end_reg;
 453         __le32 write_ptr_reg;
 454         __le32 wrap_count;
 455         u8 base_shift;
 456         u8 end_shift;
 457         struct iwl_fw_dbg_reg_op reg_ops[0];
 458 } __packed;
 459
 460 struct iwl_fw_dbg_conf_hcmd {
 461         u8 id;
 462         u8 reserved;
 463         __le16 len;
 464         u8 data[0];
 465 } __packed;
 466
 467 /**
 468  * enum iwl_fw_dbg_trigger_mode - triggers functionalities
 469  *
 470  * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
 471  * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
 472  */
 473 enum iwl_fw_dbg_trigger_mode {
 474         IWL_FW_DBG_TRIGGER_START = BIT(0),
 475         IWL_FW_DBG_TRIGGER_STOP = BIT(1),
 476 };
 477
 478 /**
 479  * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
 480  * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
 481  * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
 482  * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
 483  * @IWL_FW_DBG_CONF_VIF_AP: AP mode
 484  * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
 485  * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
 486  * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
 487  */
 488 enum iwl_fw_dbg_trigger_vif_type {
 489         IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
 490         IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
 491         IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
 492         IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
 493         IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
 494         IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
 495         IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
 496 };
 497
 498 /**
 499  * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
 500  * @id: %enum iwl_fw_dbg_trigger
 501  * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
 502  * @stop_conf_ids: bitmap of configurations this trigger relates to.
 503  *      if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
 504  *      to the currently running configuration is set, the data should be
 505  *      collected.
 506  * @stop_delay: how many milliseconds to wait before collecting the data
 507  *      after the STOP trigger fires.
 508  * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
 509  * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
 510  *      configuration should be applied when the triggers kicks in.
 511  * @occurrences: number of occurrences. 0 means the trigger will never fire.
 512  */
 513 struct iwl_fw_dbg_trigger_tlv {
 514         __le32 id;
 515         __le32 vif_type;
 516         __le32 stop_conf_ids;
 517         __le32 stop_delay;
 518         u8 mode;
 519         u8 start_conf_id;
 520         __le16 occurrences;
 521         __le32 reserved[2];
 522
 523         u8 data[0];
 524 } __packed;
 525
 526 #define FW_DBG_START_FROM_ALIVE 0
 527 #define FW_DBG_CONF_MAX         32
 528 #define FW_DBG_INVALID          0xff
 529
 530 /**
 531  * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
 532  * @stop_consec_missed_bcon: stop recording if threshold is crossed.
 533  * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
 534  * @start_consec_missed_bcon: start recording if threshold is crossed.
 535  * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
 536  * @reserved1: reserved
 537  * @reserved2: reserved
 538  */
 539 struct iwl_fw_dbg_trigger_missed_bcon {
 540         __le32 stop_consec_missed_bcon;
 541         __le32 stop_consec_missed_bcon_since_rx;
 542         __le32 reserved2[2];
 543         __le32 start_consec_missed_bcon;
 544         __le32 start_consec_missed_bcon_since_rx;
 545         __le32 reserved1[2];
 546 } __packed;
 547
 548 /**
 549  * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
 550  * cmds: the list of commands to trigger the collection on
 551  */
 552 struct iwl_fw_dbg_trigger_cmd {
 553         struct cmd {
 554                 u8 cmd_id;
 555                 u8 group_id;
 556         } __packed cmds[16];
 557 } __packed;
 558
 559 /**
 560  * iwl_fw_dbg_trigger_stats - configures trigger for statistics
 561  * @stop_offset: the offset of the value to be monitored
 562  * @stop_threshold: the threshold above which to collect
 563  * @start_offset: the offset of the value to be monitored
 564  * @start_threshold: the threshold above which to start recording
 565  */
 566 struct iwl_fw_dbg_trigger_stats {
 567         __le32 stop_offset;
 568         __le32 stop_threshold;
 569         __le32 start_offset;
 570         __le32 start_threshold;
 571 } __packed;
 572
 573 /**
 574  * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
 575  * @rssi: RSSI value to trigger at
 576  */
 577 struct iwl_fw_dbg_trigger_low_rssi {
 578         __le32 rssi;
 579 } __packed;
 580
 581 /**
 582  * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
 583  * @stop_auth_denied: number of denied authentication to collect
 584  * @stop_auth_timeout: number of authentication timeout to collect
 585  * @stop_rx_deauth: number of Rx deauth before to collect
 586  * @stop_tx_deauth: number of Tx deauth before to collect
 587  * @stop_assoc_denied: number of denied association to collect
 588  * @stop_assoc_timeout: number of association timeout to collect
 589  * @stop_connection_loss: number of connection loss to collect
 590  * @start_auth_denied: number of denied authentication to start recording
 591  * @start_auth_timeout: number of authentication timeout to start recording
 592  * @start_rx_deauth: number of Rx deauth to start recording
 593  * @start_tx_deauth: number of Tx deauth to start recording
 594  * @start_assoc_denied: number of denied association to start recording
 595  * @start_assoc_timeout: number of association timeout to start recording
 596  * @start_connection_loss: number of connection loss to start recording
 597  */
 598 struct iwl_fw_dbg_trigger_mlme {
 599         u8 stop_auth_denied;
 600         u8 stop_auth_timeout;
 601         u8 stop_rx_deauth;
 602         u8 stop_tx_deauth;
 603
 604         u8 stop_assoc_denied;
 605         u8 stop_assoc_timeout;
 606         u8 stop_connection_loss;
 607         u8 reserved;
 608
 609         u8 start_auth_denied;
 610         u8 start_auth_timeout;
 611         u8 start_rx_deauth;
 612         u8 start_tx_deauth;
 613
 614         u8 start_assoc_denied;
 615         u8 start_assoc_timeout;
 616         u8 start_connection_loss;
 617         u8 reserved2;
 618 } __packed;
 619
 620 /**
 621  * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
 622  * @command_queue: timeout for the command queue in ms
 623  * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
 624  * @softap: timeout for the queues of a softAP in ms
 625  * @p2p_go: timeout for the queues of a P2P GO in ms
 626  * @p2p_client: timeout for the queues of a P2P client in ms
 627  * @p2p_device: timeout for the queues of a P2P device in ms
 628  * @ibss: timeout for the queues of an IBSS in ms
 629  * @tdls: timeout for the queues of a TDLS station in ms
 630  */
 631 struct iwl_fw_dbg_trigger_txq_timer {
 632         __le32 command_queue;
 633         __le32 bss;
 634         __le32 softap;
 635         __le32 p2p_go;
 636         __le32 p2p_client;
 637         __le32 p2p_device;
 638         __le32 ibss;
 639         __le32 tdls;
 640         __le32 reserved[4];
 641 } __packed;
 642
 643 /**
 644  * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
 645  * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
 646  *      trigger each time a time event notification that relates to time event
 647  *      id with one of the actions in the bitmap is received and
 648  *      BIT(notif->status) is set in status_bitmap.
 649  *
 650  */
 651 struct iwl_fw_dbg_trigger_time_event {
 652         struct {
 653                 __le32 id;
 654                 __le32 action_bitmap;
 655                 __le32 status_bitmap;
 656         } __packed time_events[16];
 657 } __packed;
 658
 659 /**
 660  * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
 661  * @id: conf id
 662  * @usniffer: should the uSniffer image be used
 663  * @num_of_hcmds: how many HCMDs to send are present here
 664  * @hcmd: a variable length host command to be sent to apply the configuration.
 665  *      If there is more than one HCMD to send, they will appear one after the
 666  *      other and be sent in the order that they appear in.
 667  * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
 668  * %FW_DBG_CONF_MAX configuration per run.
 669  */
 670 struct iwl_fw_dbg_conf_tlv {
 671         u8 id;
 672         u8 usniffer;
 673         u8 reserved;
 674         u8 num_of_hcmds;
 675         struct iwl_fw_dbg_conf_hcmd hcmd;
 676 } __packed;
 677
 678 #endif  /* __iwl_fw_file_h__ */