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 behaviour 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_DISABLE_STA_TX: ucode supports tx_disable bit.
 244  * @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
 245  * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 246  *      longer than the passive one, which is essential for fragmented scan.
 247  * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR
 248  * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
 249  *      regardless of the band or the number of the probes. FW will calculate
 250  *      the actual dwell time.
 251  * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
 252  *      through the dedicated host command.
 253  * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too.
 254  * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported.
 255  * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
 256  * @IWL_UCODE_TLV_API_STATS_V10: uCode supports/uses statistics API version 10
 257  * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
 258  */
 259 enum iwl_ucode_tlv_api {
 260         IWL_UCODE_TLV_API_BT_COEX_SPLIT         = BIT(3),
 261         IWL_UCODE_TLV_API_DISABLE_STA_TX        = BIT(5),
 262         IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF     = BIT(7),
 263         IWL_UCODE_TLV_API_FRAGMENTED_SCAN       = BIT(8),
 264         IWL_UCODE_TLV_API_HDC_PHASE_0           = BIT(10),
 265         IWL_UCODE_TLV_API_BASIC_DWELL           = BIT(13),
 266         IWL_UCODE_TLV_API_SCD_CFG               = BIT(15),
 267         IWL_UCODE_TLV_API_SINGLE_SCAN_EBS       = BIT(16),
 268         IWL_UCODE_TLV_API_ASYNC_DTM             = BIT(17),
 269         IWL_UCODE_TLV_API_LQ_SS_PARAMS          = BIT(18),
 270         IWL_UCODE_TLV_API_STATS_V10             = BIT(19),
 271         IWL_UCODE_TLV_API_NEW_VERSION           = BIT(20),
 272 };
 273
 274 /**
 275  * enum iwl_ucode_tlv_capa - ucode capabilities
 276  * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 277  * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 278  * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 279  * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
 280  * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 281  * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 282  *      tx power value into TPC Report action frame and Link Measurement Report
 283  *      action frame
 284  * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 285  *      channel in DS parameter set element in probe requests.
 286  * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 287  *      probe requests.
 288  * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 289  * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 290  *      which also implies support for the scheduler configuration command
 291  * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 292  * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 293  * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
 294  * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
 295  */
 296 enum iwl_ucode_tlv_capa {
 297         IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = BIT(0),
 298         IWL_UCODE_TLV_CAPA_LAR_SUPPORT                  = BIT(1),
 299         IWL_UCODE_TLV_CAPA_UMAC_SCAN                    = BIT(2),
 300         IWL_UCODE_TLV_CAPA_BEAMFORMER                   = BIT(3),
 301         IWL_UCODE_TLV_CAPA_TDLS_SUPPORT                 = BIT(6),
 302         IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = BIT(8),
 303         IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = BIT(9),
 304         IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = BIT(10),
 305         IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = BIT(11),
 306         IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = BIT(12),
 307         IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH          = BIT(13),
 308         IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = BIT(18),
 309         IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS           = BIT(22),
 310         IWL_UCODE_TLV_CAPA_BT_COEX_PLCR                 = BIT(28),
 311 };
 312
 313 /* The default calibrate table size if not specified by firmware file */
 314 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
 315 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
 316 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
 317
 318 /* The default max probe length if not specified by the firmware file */
 319 #define IWL_DEFAULT_MAX_PROBE_LENGTH    200
 320
 321 /*
 322  * For 16.0 uCode and above, there is no differentiation between sections,
 323  * just an offset to the HW address.
 324  */
 325 #define IWL_UCODE_SECTION_MAX 12
 326 #define IWL_API_ARRAY_SIZE      1
 327 #define IWL_CAPABILITIES_ARRAY_SIZE     1
 328 #define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
 329
 330 /* uCode version contains 4 values: Major/Minor/API/Serial */
 331 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 332 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 333 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 334 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 335
 336 /*
 337  * Calibration control struct.
 338  * Sent as part of the phy configuration command.
 339  * @flow_trigger: bitmap for which calibrations to perform according to
 340  *              flow triggers.
 341  * @event_trigger: bitmap for which calibrations to perform according to
 342  *              event triggers.
 343  */
 344 struct iwl_tlv_calib_ctrl {
 345         __le32 flow_trigger;
 346         __le32 event_trigger;
 347 } __packed;
 348
 349 enum iwl_fw_phy_cfg {
 350         FW_PHY_CFG_RADIO_TYPE_POS = 0,
 351         FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 352         FW_PHY_CFG_RADIO_STEP_POS = 2,
 353         FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 354         FW_PHY_CFG_RADIO_DASH_POS = 4,
 355         FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 356         FW_PHY_CFG_TX_CHAIN_POS = 16,
 357         FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 358         FW_PHY_CFG_RX_CHAIN_POS = 20,
 359         FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 360 };
 361
 362 #define IWL_UCODE_MAX_CS                1
 363
 364 /**
 365  * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 366  * @cipher: a cipher suite selector
 367  * @flags: cipher scheme flags (currently reserved for a future use)
 368  * @hdr_len: a size of MPDU security header
 369  * @pn_len: a size of PN
 370  * @pn_off: an offset of pn from the beginning of the security header
 371  * @key_idx_off: an offset of key index byte in the security header
 372  * @key_idx_mask: a bit mask of key_idx bits
 373  * @key_idx_shift: bit shift needed to get key_idx
 374  * @mic_len: mic length in bytes
 375  * @hw_cipher: a HW cipher index used in host commands
 376  */
 377 struct iwl_fw_cipher_scheme {
 378         __le32 cipher;
 379         u8 flags;
 380         u8 hdr_len;
 381         u8 pn_len;
 382         u8 pn_off;
 383         u8 key_idx_off;
 384         u8 key_idx_mask;
 385         u8 key_idx_shift;
 386         u8 mic_len;
 387         u8 hw_cipher;
 388 } __packed;
 389
 390 enum iwl_fw_dbg_reg_operator {
 391         CSR_ASSIGN,
 392         CSR_SETBIT,
 393         CSR_CLEARBIT,
 394
 395         PRPH_ASSIGN,
 396         PRPH_SETBIT,
 397         PRPH_CLEARBIT,
 398 };
 399
 400 /**
 401  * struct iwl_fw_dbg_reg_op - an operation on a register
 402  *
 403  * @op: %enum iwl_fw_dbg_reg_operator
 404  * @addr: offset of the register
 405  * @val: value
 406  */
 407 struct iwl_fw_dbg_reg_op {
 408         u8 op;
 409         u8 reserved[3];
 410         __le32 addr;
 411         __le32 val;
 412 } __packed;
 413
 414 /**
 415  * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 416  *
 417  * @SMEM_MODE: monitor stores the data in SMEM
 418  * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 419  * @MARBH_MODE: monitor stores the data in MARBH buffer
 420  */
 421 enum iwl_fw_dbg_monitor_mode {
 422         SMEM_MODE = 0,
 423         EXTERNAL_MODE = 1,
 424         MARBH_MODE = 2,
 425 };
 426
 427 /**
 428  * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
 429  *
 430  * @version: version of the TLV - currently 0
 431  * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
 432  * @base_reg: addr of the base addr register (PRPH)
 433  * @end_reg:  addr of the end addr register (PRPH)
 434  * @write_ptr_reg: the addr of the reg of the write pointer
 435  * @wrap_count: the addr of the reg of the wrap_count
 436  * @base_shift: shift right of the base addr reg
 437  * @end_shift: shift right of the end addr reg
 438  * @reg_ops: array of registers operations
 439  *
 440  * This parses IWL_UCODE_TLV_FW_DBG_DEST
 441  */
 442 struct iwl_fw_dbg_dest_tlv {
 443         u8 version;
 444         u8 monitor_mode;
 445         u8 reserved[2];
 446         __le32 base_reg;
 447         __le32 end_reg;
 448         __le32 write_ptr_reg;
 449         __le32 wrap_count;
 450         u8 base_shift;
 451         u8 end_shift;
 452         struct iwl_fw_dbg_reg_op reg_ops[0];
 453 } __packed;
 454
 455 struct iwl_fw_dbg_conf_hcmd {
 456         u8 id;
 457         u8 reserved;
 458         __le16 len;
 459         u8 data[0];
 460 } __packed;
 461
 462 /**
 463  * enum iwl_fw_dbg_trigger_mode - triggers functionalities
 464  *
 465  * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
 466  * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
 467  */
 468 enum iwl_fw_dbg_trigger_mode {
 469         IWL_FW_DBG_TRIGGER_START = BIT(0),
 470         IWL_FW_DBG_TRIGGER_STOP = BIT(1),
 471 };
 472
 473 /**
 474  * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
 475  * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
 476  * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
 477  * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
 478  * @IWL_FW_DBG_CONF_VIF_AP: AP mode
 479  * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
 480  * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
 481  * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
 482  */
 483 enum iwl_fw_dbg_trigger_vif_type {
 484         IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
 485         IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
 486         IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
 487         IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
 488         IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
 489         IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
 490         IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
 491 };
 492
 493 /**
 494  * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
 495  * @id: %enum iwl_fw_dbg_trigger
 496  * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
 497  * @stop_conf_ids: bitmap of configurations this trigger relates to.
 498  *      if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
 499  *      to the currently running configuration is set, the data should be
 500  *      collected.
 501  * @stop_delay: how many milliseconds to wait before collecting the data
 502  *      after the STOP trigger fires.
 503  * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
 504  * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
 505  *      configuration should be applied when the triggers kicks in.
 506  * @occurrences: number of occurrences. 0 means the trigger will never fire.
 507  */
 508 struct iwl_fw_dbg_trigger_tlv {
 509         __le32 id;
 510         __le32 vif_type;
 511         __le32 stop_conf_ids;
 512         __le32 stop_delay;
 513         u8 mode;
 514         u8 start_conf_id;
 515         __le16 occurrences;
 516         __le32 reserved[2];
 517
 518         u8 data[0];
 519 } __packed;
 520
 521 #define FW_DBG_START_FROM_ALIVE 0
 522 #define FW_DBG_CONF_MAX         32
 523 #define FW_DBG_INVALID          0xff
 524
 525 /**
 526  * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
 527  * @stop_consec_missed_bcon: stop recording if threshold is crossed.
 528  * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
 529  * @start_consec_missed_bcon: start recording if threshold is crossed.
 530  * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
 531  * @reserved1: reserved
 532  * @reserved2: reserved
 533  */
 534 struct iwl_fw_dbg_trigger_missed_bcon {
 535         __le32 stop_consec_missed_bcon;
 536         __le32 stop_consec_missed_bcon_since_rx;
 537         __le32 reserved2[2];
 538         __le32 start_consec_missed_bcon;
 539         __le32 start_consec_missed_bcon_since_rx;
 540         __le32 reserved1[2];
 541 } __packed;
 542
 543 /**
 544  * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
 545  * cmds: the list of commands to trigger the collection on
 546  */
 547 struct iwl_fw_dbg_trigger_cmd {
 548         struct cmd {
 549                 u8 cmd_id;
 550                 u8 group_id;
 551         } __packed cmds[16];
 552 } __packed;
 553
 554 /**
 555  * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
 556  * @id: conf id
 557  * @usniffer: should the uSniffer image be used
 558  * @num_of_hcmds: how many HCMDs to send are present here
 559  * @hcmd: a variable length host command to be sent to apply the configuration.
 560  *      If there is more than one HCMD to send, they will appear one after the
 561  *      other and be sent in the order that they appear in.
 562  * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
 563  * %FW_DBG_CONF_MAX configuration per run.
 564  */
 565 struct iwl_fw_dbg_conf_tlv {
 566         u8 id;
 567         u8 usniffer;
 568         u8 reserved;
 569         u8 num_of_hcmds;
 570         struct iwl_fw_dbg_conf_hcmd hcmd;
 571 } __packed;
 572
 573 #endif  /* __iwl_fw_file_h__ */