linux/drivers/net/wireless/iwlwifi/iwl-fw-file.h
<<
>>
Prefs
   1/******************************************************************************
   2 *
   3 * This file is provided under a dual BSD/GPLv2 license.  When using or
   4 * redistributing this file, you may do so under either license.
   5 *
   6 * GPL LICENSE SUMMARY
   7 *
   8 * Copyright(c) 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
  70/* v1/v2 uCode file layout */
  71struct iwl_ucode_header {
  72        __le32 ver;     /* major/minor/API/serial */
  73        union {
  74                struct {
  75                        __le32 inst_size;       /* bytes of runtime code */
  76                        __le32 data_size;       /* bytes of runtime data */
  77                        __le32 init_size;       /* bytes of init code */
  78                        __le32 init_data_size;  /* bytes of init data */
  79                        __le32 boot_size;       /* bytes of bootstrap code */
  80                        u8 data[0];             /* in same order as sizes */
  81                } v1;
  82                struct {
  83                        __le32 build;           /* build number */
  84                        __le32 inst_size;       /* bytes of runtime code */
  85                        __le32 data_size;       /* bytes of runtime data */
  86                        __le32 init_size;       /* bytes of init code */
  87                        __le32 init_data_size;  /* bytes of init data */
  88                        __le32 boot_size;       /* bytes of bootstrap code */
  89                        u8 data[0];             /* in same order as sizes */
  90                } v2;
  91        } u;
  92};
  93
  94/*
  95 * new TLV uCode file layout
  96 *
  97 * The new TLV file format contains TLVs, that each specify
  98 * some piece of data.
  99 */
 100
 101enum iwl_ucode_tlv_type {
 102        IWL_UCODE_TLV_INVALID           = 0, /* unused */
 103        IWL_UCODE_TLV_INST              = 1,
 104        IWL_UCODE_TLV_DATA              = 2,
 105        IWL_UCODE_TLV_INIT              = 3,
 106        IWL_UCODE_TLV_INIT_DATA         = 4,
 107        IWL_UCODE_TLV_BOOT              = 5,
 108        IWL_UCODE_TLV_PROBE_MAX_LEN     = 6, /* a u32 value */
 109        IWL_UCODE_TLV_PAN               = 7,
 110        IWL_UCODE_TLV_RUNT_EVTLOG_PTR   = 8,
 111        IWL_UCODE_TLV_RUNT_EVTLOG_SIZE  = 9,
 112        IWL_UCODE_TLV_RUNT_ERRLOG_PTR   = 10,
 113        IWL_UCODE_TLV_INIT_EVTLOG_PTR   = 11,
 114        IWL_UCODE_TLV_INIT_EVTLOG_SIZE  = 12,
 115        IWL_UCODE_TLV_INIT_ERRLOG_PTR   = 13,
 116        IWL_UCODE_TLV_ENHANCE_SENS_TBL  = 14,
 117        IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
 118        IWL_UCODE_TLV_WOWLAN_INST       = 16,
 119        IWL_UCODE_TLV_WOWLAN_DATA       = 17,
 120        IWL_UCODE_TLV_FLAGS             = 18,
 121        IWL_UCODE_TLV_SEC_RT            = 19,
 122        IWL_UCODE_TLV_SEC_INIT          = 20,
 123        IWL_UCODE_TLV_SEC_WOWLAN        = 21,
 124        IWL_UCODE_TLV_DEF_CALIB         = 22,
 125        IWL_UCODE_TLV_PHY_SKU           = 23,
 126        IWL_UCODE_TLV_SECURE_SEC_RT     = 24,
 127        IWL_UCODE_TLV_SECURE_SEC_INIT   = 25,
 128        IWL_UCODE_TLV_SECURE_SEC_WOWLAN = 26,
 129        IWL_UCODE_TLV_NUM_OF_CPU        = 27,
 130        IWL_UCODE_TLV_CSCHEME           = 28,
 131        IWL_UCODE_TLV_API_CHANGES_SET   = 29,
 132        IWL_UCODE_TLV_ENABLED_CAPABILITIES      = 30,
 133        IWL_UCODE_TLV_N_SCAN_CHANNELS           = 31,
 134        IWL_UCODE_TLV_SEC_RT_USNIFFER   = 34,
 135        IWL_UCODE_TLV_SDIO_ADMA_ADDR    = 35,
 136        IWL_UCODE_TLV_FW_DBG_DEST       = 38,
 137        IWL_UCODE_TLV_FW_DBG_CONF       = 39,
 138};
 139
 140struct iwl_ucode_tlv {
 141        __le32 type;            /* see above */
 142        __le32 length;          /* not including type/length fields */
 143        u8 data[0];
 144};
 145
 146#define IWL_TLV_UCODE_MAGIC             0x0a4c5749
 147#define FW_VER_HUMAN_READABLE_SZ        64
 148
 149struct iwl_tlv_ucode_header {
 150        /*
 151         * The TLV style ucode header is distinguished from
 152         * the v1/v2 style header by first four bytes being
 153         * zero, as such is an invalid combination of
 154         * major/minor/API/serial versions.
 155         */
 156        __le32 zero;
 157        __le32 magic;
 158        u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
 159        __le32 ver;             /* major/minor/API/serial */
 160        __le32 build;
 161        __le64 ignore;
 162        /*
 163         * The data contained herein has a TLV layout,
 164         * see above for the TLV header and types.
 165         * Note that each TLV is padded to a length
 166         * that is a multiple of 4 for alignment.
 167         */
 168        u8 data[0];
 169};
 170
 171/*
 172 * ucode TLVs
 173 *
 174 * ability to get extension for: flags & capabilities from ucode binaries files
 175 */
 176struct iwl_ucode_api {
 177        __le32 api_index;
 178        __le32 api_flags;
 179} __packed;
 180
 181struct iwl_ucode_capa {
 182        __le32 api_index;
 183        __le32 api_capa;
 184} __packed;
 185
 186/**
 187 * enum iwl_ucode_tlv_flag - ucode API flags
 188 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 189 *      was a separate TLV but moved here to save space.
 190 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
 191 *      treats good CRC threshold as a boolean
 192 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 193 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 194 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
 195 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
 196 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
 197 *      offload profile config command.
 198 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 199 *      (rather than two) IPv6 addresses
 200 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 201 *      from the probe request template.
 202 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
 203 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
 204 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
 205 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
 206 *      P2P client interfaces simultaneously if they are in different bindings.
 207 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
 208 *      P2P client interfaces simultaneously if they are in same bindings.
 209 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
 210 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
 211 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
 212 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
 213 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
 214 */
 215enum iwl_ucode_tlv_flag {
 216        IWL_UCODE_TLV_FLAGS_PAN                 = BIT(0),
 217        IWL_UCODE_TLV_FLAGS_NEWSCAN             = BIT(1),
 218        IWL_UCODE_TLV_FLAGS_MFP                 = BIT(2),
 219        IWL_UCODE_TLV_FLAGS_P2P                 = BIT(3),
 220        IWL_UCODE_TLV_FLAGS_DW_BC_TABLE         = BIT(4),
 221        IWL_UCODE_TLV_FLAGS_SHORT_BL            = BIT(7),
 222        IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS     = BIT(10),
 223        IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID       = BIT(12),
 224        IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL    = BIT(15),
 225        IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE    = BIT(16),
 226        IWL_UCODE_TLV_FLAGS_P2P_PM              = BIT(21),
 227        IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM      = BIT(22),
 228        IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM      = BIT(23),
 229        IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT       = BIT(24),
 230        IWL_UCODE_TLV_FLAGS_EBS_SUPPORT         = BIT(25),
 231        IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD        = BIT(26),
 232        IWL_UCODE_TLV_FLAGS_BCAST_FILTERING     = BIT(29),
 233        IWL_UCODE_TLV_FLAGS_GO_UAPSD            = BIT(30),
 234};
 235
 236/**
 237 * enum iwl_ucode_tlv_api - ucode api
 238 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
 239 * @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
 240 * @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
 241 * @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
 242 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 243 *      longer than the passive one, which is essential for fragmented scan.
 244 * IWL_UCODE_TLV_API_HDC_PHASE_0: ucode supports finer configuration of LTR
 245 * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
 246 *      regardless of the band or the number of the probes. FW will calculate
 247 *      the actual dwell time.
 248 * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
 249 *      through the dedicated host command.
 250 * @IWL_UCODE_TLV_API_SINGLE_SCAN_EBS: EBS is supported for single scans too.
 251 * @IWL_UCODE_TLV_API_ASYNC_DTM: Async temperature notifications are supported.
 252 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
 253 */
 254enum iwl_ucode_tlv_api {
 255        IWL_UCODE_TLV_API_BT_COEX_SPLIT         = BIT(3),
 256        IWL_UCODE_TLV_API_DISABLE_STA_TX        = BIT(5),
 257        IWL_UCODE_TLV_API_LMAC_SCAN             = BIT(6),
 258        IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF     = BIT(7),
 259        IWL_UCODE_TLV_API_FRAGMENTED_SCAN       = BIT(8),
 260        IWL_UCODE_TLV_API_HDC_PHASE_0           = BIT(10),
 261        IWL_UCODE_TLV_API_BASIC_DWELL           = BIT(13),
 262        IWL_UCODE_TLV_API_SCD_CFG               = BIT(15),
 263        IWL_UCODE_TLV_API_SINGLE_SCAN_EBS       = BIT(16),
 264        IWL_UCODE_TLV_API_ASYNC_DTM             = BIT(17),
 265        IWL_UCODE_TLV_API_LQ_SS_PARAMS          = BIT(18),
 266};
 267
 268/**
 269 * enum iwl_ucode_tlv_capa - ucode capabilities
 270 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 271 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 272 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 273 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
 274 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 275 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 276 *      tx power value into TPC Report action frame and Link Measurement Report
 277 *      action frame
 278 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 279 *      channel in DS parameter set element in probe requests.
 280 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 281 *      probe requests.
 282 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 283 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 284 *      which also implies support for the scheduler configuration command
 285 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 286 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 287 */
 288enum iwl_ucode_tlv_capa {
 289        IWL_UCODE_TLV_CAPA_D0I3_SUPPORT                 = BIT(0),
 290        IWL_UCODE_TLV_CAPA_LAR_SUPPORT                  = BIT(1),
 291        IWL_UCODE_TLV_CAPA_UMAC_SCAN                    = BIT(2),
 292        IWL_UCODE_TLV_CAPA_BEAMFORMER                   = BIT(3),
 293        IWL_UCODE_TLV_CAPA_TDLS_SUPPORT                 = BIT(6),
 294        IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT    = BIT(8),
 295        IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT      = BIT(9),
 296        IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT       = BIT(10),
 297        IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT         = BIT(11),
 298        IWL_UCODE_TLV_CAPA_DQA_SUPPORT                  = BIT(12),
 299        IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH          = BIT(13),
 300        IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT              = BIT(18),
 301};
 302
 303/* The default calibrate table size if not specified by firmware file */
 304#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
 305#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE         19
 306#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE                  253
 307
 308/* The default max probe length if not specified by the firmware file */
 309#define IWL_DEFAULT_MAX_PROBE_LENGTH    200
 310
 311/*
 312 * For 16.0 uCode and above, there is no differentiation between sections,
 313 * just an offset to the HW address.
 314 */
 315#define IWL_UCODE_SECTION_MAX 12
 316#define IWL_API_ARRAY_SIZE      1
 317#define IWL_CAPABILITIES_ARRAY_SIZE     1
 318#define CPU1_CPU2_SEPARATOR_SECTION     0xFFFFCCCC
 319
 320/* uCode version contains 4 values: Major/Minor/API/Serial */
 321#define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 322#define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 323#define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 324#define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 325
 326/*
 327 * Calibration control struct.
 328 * Sent as part of the phy configuration command.
 329 * @flow_trigger: bitmap for which calibrations to perform according to
 330 *              flow triggers.
 331 * @event_trigger: bitmap for which calibrations to perform according to
 332 *              event triggers.
 333 */
 334struct iwl_tlv_calib_ctrl {
 335        __le32 flow_trigger;
 336        __le32 event_trigger;
 337} __packed;
 338
 339enum iwl_fw_phy_cfg {
 340        FW_PHY_CFG_RADIO_TYPE_POS = 0,
 341        FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
 342        FW_PHY_CFG_RADIO_STEP_POS = 2,
 343        FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
 344        FW_PHY_CFG_RADIO_DASH_POS = 4,
 345        FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
 346        FW_PHY_CFG_TX_CHAIN_POS = 16,
 347        FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
 348        FW_PHY_CFG_RX_CHAIN_POS = 20,
 349        FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
 350};
 351
 352#define IWL_UCODE_MAX_CS                1
 353
 354/**
 355 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 356 * @cipher: a cipher suite selector
 357 * @flags: cipher scheme flags (currently reserved for a future use)
 358 * @hdr_len: a size of MPDU security header
 359 * @pn_len: a size of PN
 360 * @pn_off: an offset of pn from the beginning of the security header
 361 * @key_idx_off: an offset of key index byte in the security header
 362 * @key_idx_mask: a bit mask of key_idx bits
 363 * @key_idx_shift: bit shift needed to get key_idx
 364 * @mic_len: mic length in bytes
 365 * @hw_cipher: a HW cipher index used in host commands
 366 */
 367struct iwl_fw_cipher_scheme {
 368        __le32 cipher;
 369        u8 flags;
 370        u8 hdr_len;
 371        u8 pn_len;
 372        u8 pn_off;
 373        u8 key_idx_off;
 374        u8 key_idx_mask;
 375        u8 key_idx_shift;
 376        u8 mic_len;
 377        u8 hw_cipher;
 378} __packed;
 379
 380enum iwl_fw_dbg_reg_operator {
 381        CSR_ASSIGN,
 382        CSR_SETBIT,
 383        CSR_CLEARBIT,
 384
 385        PRPH_ASSIGN,
 386        PRPH_SETBIT,
 387        PRPH_CLEARBIT,
 388};
 389
 390/**
 391 * struct iwl_fw_dbg_reg_op - an operation on a register
 392 *
 393 * @op: %enum iwl_fw_dbg_reg_operator
 394 * @addr: offset of the register
 395 * @val: value
 396 */
 397struct iwl_fw_dbg_reg_op {
 398        u8 op;
 399        u8 reserved[3];
 400        __le32 addr;
 401        __le32 val;
 402} __packed;
 403
 404/**
 405 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 406 *
 407 * @SMEM_MODE: monitor stores the data in SMEM
 408 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 409 * @MARBH_MODE: monitor stores the data in MARBH buffer
 410 */
 411enum iwl_fw_dbg_monitor_mode {
 412        SMEM_MODE = 0,
 413        EXTERNAL_MODE = 1,
 414        MARBH_MODE = 2,
 415};
 416
 417/**
 418 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
 419 *
 420 * @version: version of the TLV - currently 0
 421 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
 422 * @base_reg: addr of the base addr register (PRPH)
 423 * @end_reg:  addr of the end addr register (PRPH)
 424 * @write_ptr_reg: the addr of the reg of the write pointer
 425 * @wrap_count: the addr of the reg of the wrap_count
 426 * @base_shift: shift right of the base addr reg
 427 * @end_shift: shift right of the end addr reg
 428 * @reg_ops: array of registers operations
 429 *
 430 * This parses IWL_UCODE_TLV_FW_DBG_DEST
 431 */
 432struct iwl_fw_dbg_dest_tlv {
 433        u8 version;
 434        u8 monitor_mode;
 435        u8 reserved[2];
 436        __le32 base_reg;
 437        __le32 end_reg;
 438        __le32 write_ptr_reg;
 439        __le32 wrap_count;
 440        u8 base_shift;
 441        u8 end_shift;
 442        struct iwl_fw_dbg_reg_op reg_ops[0];
 443} __packed;
 444
 445struct iwl_fw_dbg_conf_hcmd {
 446        u8 id;
 447        u8 reserved;
 448        __le16 len;
 449        u8 data[0];
 450} __packed;
 451
 452/**
 453 * struct iwl_fw_dbg_trigger - a TLV that describes a debug configuration
 454 *
 455 * @enabled: is this trigger enabled
 456 * @reserved:
 457 * @len: length, in bytes, of the %trigger field
 458 * @trigger: pointer to a trigger struct
 459 */
 460struct iwl_fw_dbg_trigger {
 461        u8 enabled;
 462        u8 reserved;
 463        u8 len;
 464        u8 trigger[0];
 465} __packed;
 466
 467/**
 468 * enum iwl_fw_dbg_conf - configurations available
 469 *
 470 * @FW_DBG_CUSTOM: take this configuration from alive
 471 *      Note that the trigger is NO-OP for this configuration
 472 */
 473enum iwl_fw_dbg_conf {
 474        FW_DBG_CUSTOM = 0,
 475
 476        /* must be last */
 477        FW_DBG_MAX,
 478        FW_DBG_INVALID = 0xff,
 479};
 480
 481/**
 482 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration
 483 *
 484 * @id: %enum iwl_fw_dbg_conf
 485 * @usniffer: should the uSniffer image be used
 486 * @num_of_hcmds: how many HCMDs to send are present here
 487 * @hcmd: a variable length host command to be sent to apply the configuration.
 488 *      If there is more than one HCMD to send, they will appear one after the
 489 *      other and be sent in the order that they appear in.
 490 * This parses IWL_UCODE_TLV_FW_DBG_CONF
 491 */
 492struct iwl_fw_dbg_conf_tlv {
 493        u8 id;
 494        u8 usniffer;
 495        u8 reserved;
 496        u8 num_of_hcmds;
 497        struct iwl_fw_dbg_conf_hcmd hcmd;
 498
 499        /* struct iwl_fw_dbg_trigger sits after all variable length hcmds */
 500} __packed;
 501
 502#endif  /* __iwl_fw_file_h__ */
 503