[mirror_ubuntu-artful-kernel.git] / drivers / net / wireless / iwlwifi / iwl-fw-file.h

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called COPYING.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

#ifndef __iwl_fw_file_h__
#define __iwl_fw_file_h__

#include <linux/netdevice.h>

/* v1/v2 uCode file layout */
struct iwl_ucode_header {
	__le32 ver;	/* major/minor/API/serial */
	union {
		struct {
			__le32 inst_size;	/* bytes of runtime code */
			__le32 data_size;	/* bytes of runtime data */
			__le32 init_size;	/* bytes of init code */
			__le32 init_data_size;	/* bytes of init data */
			__le32 boot_size;	/* bytes of bootstrap code */
			u8 data[0];		/* in same order as sizes */
		} v1;
		struct {
			__le32 build;		/* build number */
			__le32 inst_size;	/* bytes of runtime code */
			__le32 data_size;	/* bytes of runtime data */
			__le32 init_size;	/* bytes of init code */
			__le32 init_data_size;	/* bytes of init data */
			__le32 boot_size;	/* bytes of bootstrap code */
			u8 data[0];		/* in same order as sizes */
		} v2;
	} u;
};

/*
 * new TLV uCode file layout
 *
 * The new TLV file format contains TLVs, that each specify
 * some piece of data.
 */

enum iwl_ucode_tlv_type {
	IWL_UCODE_TLV_INVALID		= 0, /* unused */
	IWL_UCODE_TLV_INST		= 1,
	IWL_UCODE_TLV_DATA		= 2,
	IWL_UCODE_TLV_INIT		= 3,
	IWL_UCODE_TLV_INIT_DATA		= 4,
	IWL_UCODE_TLV_BOOT		= 5,
	IWL_UCODE_TLV_PROBE_MAX_LEN	= 6, /* a u32 value */
	IWL_UCODE_TLV_PAN		= 7,
	IWL_UCODE_TLV_RUNT_EVTLOG_PTR	= 8,
	IWL_UCODE_TLV_RUNT_EVTLOG_SIZE	= 9,
	IWL_UCODE_TLV_RUNT_ERRLOG_PTR	= 10,
	IWL_UCODE_TLV_INIT_EVTLOG_PTR	= 11,
	IWL_UCODE_TLV_INIT_EVTLOG_SIZE	= 12,
	IWL_UCODE_TLV_INIT_ERRLOG_PTR	= 13,
	IWL_UCODE_TLV_ENHANCE_SENS_TBL	= 14,
	IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
	IWL_UCODE_TLV_WOWLAN_INST	= 16,
	IWL_UCODE_TLV_WOWLAN_DATA	= 17,
	IWL_UCODE_TLV_FLAGS		= 18,
	IWL_UCODE_TLV_SEC_RT		= 19,
	IWL_UCODE_TLV_SEC_INIT		= 20,
	IWL_UCODE_TLV_SEC_WOWLAN	= 21,
	IWL_UCODE_TLV_DEF_CALIB		= 22,
	IWL_UCODE_TLV_PHY_SKU		= 23,
	IWL_UCODE_TLV_SECURE_SEC_RT	= 24,
	IWL_UCODE_TLV_SECURE_SEC_INIT	= 25,
	IWL_UCODE_TLV_SECURE_SEC_WOWLAN	= 26,
	IWL_UCODE_TLV_NUM_OF_CPU	= 27,
	IWL_UCODE_TLV_CSCHEME		= 28,
	IWL_UCODE_TLV_API_CHANGES_SET	= 29,
	IWL_UCODE_TLV_ENABLED_CAPABILITIES	= 30,
	IWL_UCODE_TLV_N_SCAN_CHANNELS		= 31,
	IWL_UCODE_TLV_SEC_RT_USNIFFER	= 34,
	IWL_UCODE_TLV_SDIO_ADMA_ADDR	= 35,
	IWL_UCODE_TLV_FW_DBG_DEST	= 38,
	IWL_UCODE_TLV_FW_DBG_CONF	= 39,
};

struct iwl_ucode_tlv {
	__le32 type;		/* see above */
	__le32 length;		/* not including type/length fields */
	u8 data[0];
};

#define IWL_TLV_UCODE_MAGIC		0x0a4c5749
#define FW_VER_HUMAN_READABLE_SZ	64

struct iwl_tlv_ucode_header {
	/*
	 * The TLV style ucode header is distinguished from
	 * the v1/v2 style header by first four bytes being
	 * zero, as such is an invalid combination of
	 * major/minor/API/serial versions.
	 */
	__le32 zero;
	__le32 magic;
	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
	__le32 ver;		/* major/minor/API/serial */
	__le32 build;
	__le64 ignore;
	/*
	 * The data contained herein has a TLV layout,
	 * see above for the TLV header and types.
	 * Note that each TLV is padded to a length
	 * that is a multiple of 4 for alignment.
	 */
	u8 data[0];
};

/*
 * ucode TLVs
 *
 * ability to get extension for: flags & capabilities from ucode binaries files
 */
struct iwl_ucode_api {
	__le32 api_index;
	__le32 api_flags;
} __packed;

struct iwl_ucode_capa {
	__le32 api_index;
	__le32 api_capa;
} __packed;

/**
 * enum iwl_ucode_tlv_flag - ucode API flags
 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 *	was a separate TLV but moved here to save space.
 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
 *	treats good CRC threshold as a boolean
 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
 *	offload profile config command.
 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 *	(rather than two) IPv6 addresses
 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 *	from the probe request template.
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
 *	P2P client interfaces simultaneously if they are in different bindings.
 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
 *	P2P client interfaces simultaneously if they are in same bindings.
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
 */
enum iwl_ucode_tlv_flag {
	IWL_UCODE_TLV_FLAGS_PAN			= BIT(0),
	IWL_UCODE_TLV_FLAGS_NEWSCAN		= BIT(1),
	IWL_UCODE_TLV_FLAGS_MFP			= BIT(2),
	IWL_UCODE_TLV_FLAGS_P2P			= BIT(3),
	IWL_UCODE_TLV_FLAGS_DW_BC_TABLE		= BIT(4),
	IWL_UCODE_TLV_FLAGS_SHORT_BL		= BIT(7),
	IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS	= BIT(10),
	IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID	= BIT(12),
	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL	= BIT(15),
	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE	= BIT(16),
	IWL_UCODE_TLV_FLAGS_P2P_PM		= BIT(21),
	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM	= BIT(22),
	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM	= BIT(23),
	IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT	= BIT(24),
	IWL_UCODE_TLV_FLAGS_EBS_SUPPORT		= BIT(25),
	IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD	= BIT(26),
	IWL_UCODE_TLV_FLAGS_BCAST_FILTERING	= BIT(29),
	IWL_UCODE_TLV_FLAGS_GO_UAPSD		= BIT(30),
};

/**
 * enum iwl_ucode_tlv_api - ucode api
 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
 * @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
 * @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
 * @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 *	longer than the passive one, which is essential for fragmented scan.
 * @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
 *	regardless of the band or the number of the probes. FW will calculate
 *	the actual dwell time.
 * @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
 *	through the dedicated host command.
 */
enum iwl_ucode_tlv_api {
	IWL_UCODE_TLV_API_BT_COEX_SPLIT         = BIT(3),
	IWL_UCODE_TLV_API_DISABLE_STA_TX	= BIT(5),
	IWL_UCODE_TLV_API_LMAC_SCAN		= BIT(6),
	IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF	= BIT(7),
	IWL_UCODE_TLV_API_FRAGMENTED_SCAN	= BIT(8),
	IWL_UCODE_TLV_API_BASIC_DWELL		= BIT(13),
	IWL_UCODE_TLV_API_SCD_CFG		= BIT(15),
};

/**
 * enum iwl_ucode_tlv_capa - ucode capabilities
 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 *	tx power value into TPC Report action frame and Link Measurement Report
 *	action frame
 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 *	channel in DS parameter set element in probe requests.
 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 *	probe requests.
 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 *	which also implies support for the scheduler configuration command
 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 */
enum iwl_ucode_tlv_capa {
	IWL_UCODE_TLV_CAPA_D0I3_SUPPORT			= BIT(0),
	IWL_UCODE_TLV_CAPA_LAR_SUPPORT			= BIT(1),
	IWL_UCODE_TLV_CAPA_UMAC_SCAN			= BIT(2),
	IWL_UCODE_TLV_CAPA_TDLS_SUPPORT			= BIT(6),
	IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT	= BIT(8),
	IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT	= BIT(9),
	IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT	= BIT(10),
	IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT		= BIT(11),
	IWL_UCODE_TLV_CAPA_DQA_SUPPORT			= BIT(12),
	IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH		= BIT(13),
	IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT		= BIT(18),
};

/* The default calibrate table size if not specified by firmware file */
#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE	18
#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE		19
#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE			253

/* The default max probe length if not specified by the firmware file */
#define IWL_DEFAULT_MAX_PROBE_LENGTH	200

/*
 * For 16.0 uCode and above, there is no differentiation between sections,
 * just an offset to the HW address.
 */
#define IWL_UCODE_SECTION_MAX 12
#define IWL_API_ARRAY_SIZE	1
#define IWL_CAPABILITIES_ARRAY_SIZE	1
#define CPU1_CPU2_SEPARATOR_SECTION	0xFFFFCCCC

/* uCode version contains 4 values: Major/Minor/API/Serial */
#define IWL_UCODE_MAJOR(ver)	(((ver) & 0xFF000000) >> 24)
#define IWL_UCODE_MINOR(ver)	(((ver) & 0x00FF0000) >> 16)
#define IWL_UCODE_API(ver)	(((ver) & 0x0000FF00) >> 8)
#define IWL_UCODE_SERIAL(ver)	((ver) & 0x000000FF)

/*
 * Calibration control struct.
 * Sent as part of the phy configuration command.
 * @flow_trigger: bitmap for which calibrations to perform according to
 *		flow triggers.
 * @event_trigger: bitmap for which calibrations to perform according to
 *		event triggers.
 */
struct iwl_tlv_calib_ctrl {
	__le32 flow_trigger;
	__le32 event_trigger;
} __packed;

enum iwl_fw_phy_cfg {
	FW_PHY_CFG_RADIO_TYPE_POS = 0,
	FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
	FW_PHY_CFG_RADIO_STEP_POS = 2,
	FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
	FW_PHY_CFG_RADIO_DASH_POS = 4,
	FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
	FW_PHY_CFG_TX_CHAIN_POS = 16,
	FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
	FW_PHY_CFG_RX_CHAIN_POS = 20,
	FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
};

#define IWL_UCODE_MAX_CS		1

/**
 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 * @cipher: a cipher suite selector
 * @flags: cipher scheme flags (currently reserved for a future use)
 * @hdr_len: a size of MPDU security header
 * @pn_len: a size of PN
 * @pn_off: an offset of pn from the beginning of the security header
 * @key_idx_off: an offset of key index byte in the security header
 * @key_idx_mask: a bit mask of key_idx bits
 * @key_idx_shift: bit shift needed to get key_idx
 * @mic_len: mic length in bytes
 * @hw_cipher: a HW cipher index used in host commands
 */
struct iwl_fw_cipher_scheme {
	__le32 cipher;
	u8 flags;
	u8 hdr_len;
	u8 pn_len;
	u8 pn_off;
	u8 key_idx_off;
	u8 key_idx_mask;
	u8 key_idx_shift;
	u8 mic_len;
	u8 hw_cipher;
} __packed;

enum iwl_fw_dbg_reg_operator {
	CSR_ASSIGN,
	CSR_SETBIT,
	CSR_CLEARBIT,

	PRPH_ASSIGN,
	PRPH_SETBIT,
	PRPH_CLEARBIT,
};

/**
 * struct iwl_fw_dbg_reg_op - an operation on a register
 *
 * @op: %enum iwl_fw_dbg_reg_operator
 * @addr: offset of the register
 * @val: value
 */
struct iwl_fw_dbg_reg_op {
	u8 op;
	u8 reserved[3];
	__le32 addr;
	__le32 val;
} __packed;

/**
 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 *
 * @SMEM_MODE: monitor stores the data in SMEM
 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 * @MARBH_MODE: monitor stores the data in MARBH buffer
 */
enum iwl_fw_dbg_monitor_mode {
	SMEM_MODE = 0,
	EXTERNAL_MODE = 1,
	MARBH_MODE = 2,
};

/**
 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
 *
 * @version: version of the TLV - currently 0
 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
 * @base_reg: addr of the base addr register (PRPH)
 * @end_reg:  addr of the end addr register (PRPH)
 * @write_ptr_reg: the addr of the reg of the write pointer
 * @wrap_count: the addr of the reg of the wrap_count
 * @base_shift: shift right of the base addr reg
 * @end_shift: shift right of the end addr reg
 * @reg_ops: array of registers operations
 *
 * This parses IWL_UCODE_TLV_FW_DBG_DEST
 */
struct iwl_fw_dbg_dest_tlv {
	u8 version;
	u8 monitor_mode;
	u8 reserved[2];
	__le32 base_reg;
	__le32 end_reg;
	__le32 write_ptr_reg;
	__le32 wrap_count;
	u8 base_shift;
	u8 end_shift;
	struct iwl_fw_dbg_reg_op reg_ops[0];
} __packed;

struct iwl_fw_dbg_conf_hcmd {
	u8 id;
	u8 reserved;
	__le16 len;
	u8 data[0];
} __packed;

/**
 * struct iwl_fw_dbg_trigger - a TLV that describes a debug configuration
 *
 * @enabled: is this trigger enabled
 * @reserved:
 * @len: length, in bytes, of the %trigger field
 * @trigger: pointer to a trigger struct
 */
struct iwl_fw_dbg_trigger {
	u8 enabled;
	u8 reserved;
	u8 len;
	u8 trigger[0];
} __packed;

/**
 * enum iwl_fw_dbg_conf - configurations available
 *
 * @FW_DBG_CUSTOM: take this configuration from alive
 *	Note that the trigger is NO-OP for this configuration
 */
enum iwl_fw_dbg_conf {
	FW_DBG_CUSTOM = 0,

	/* must be last */
	FW_DBG_MAX,
	FW_DBG_INVALID = 0xff,
};

/**
 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration
 *
 * @id: %enum iwl_fw_dbg_conf
 * @usniffer: should the uSniffer image be used
 * @num_of_hcmds: how many HCMDs to send are present here
 * @hcmd: a variable length host command to be sent to apply the configuration.
 *	If there is more than one HCMD to send, they will appear one after the
 *	other and be sent in the order that they appear in.
 * This parses IWL_UCODE_TLV_FW_DBG_CONF
 */
struct iwl_fw_dbg_conf_tlv {
	u8 id;
	u8 usniffer;
	u8 reserved;
	u8 num_of_hcmds;
	struct iwl_fw_dbg_conf_hcmd hcmd;

	/* struct iwl_fw_dbg_trigger sits after all variable length hcmds */
} __packed;

#endif  /* __iwl_fw_file_h__ */
Commit	Line	Data
edf38334 DF	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	*
51368bf7	8	* Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved.
8b4139dc	9	* Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
edf38334 DF	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
410dc5aa	26	* in the file called COPYING.
edf38334 DF	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	*
51368bf7	34	* Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
8b4139dc	35	* Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
edf38334 DF	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
3995deaf JB	65	#ifndef __iwl_fw_file_h__
3995deaf JB	66	#define __iwl_fw_file_h__
edf38334	67
b1c23d9e DF	68	#include <linux/netdevice.h>
b1c23d9e DF	69
edf38334 DF	70	/* v1/v2 uCode file layout */
	71	struct 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
0479c19d	98	* some piece of data.
edf38334 DF	99	*/
	100
	101	enum 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,
ed8c8365 DS	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,
e2d6f4e7 EH	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,
e36e5433	130	IWL_UCODE_TLV_CSCHEME = 28,
a2978b11 EH	131	IWL_UCODE_TLV_API_CHANGES_SET = 29,
a2978b11 EH	132	IWL_UCODE_TLV_ENABLED_CAPABILITIES = 30,
762533ba	133	IWL_UCODE_TLV_N_SCAN_CHANNELS = 31,
61df750c	134	IWL_UCODE_TLV_SEC_RT_USNIFFER = 34,
b4821767	135	IWL_UCODE_TLV_SDIO_ADMA_ADDR = 35,
490fefeb LK	136	IWL_UCODE_TLV_FW_DBG_DEST = 38,
490fefeb LK	137	IWL_UCODE_TLV_FW_DBG_CONF = 39,
edf38334 DF	138	};
edf38334 DF	139
edf38334	140	struct iwl_ucode_tlv {
0479c19d	141	__le32 type; /* see above */
edf38334 DF	142	__le32 length; /* not including type/length fields */
	143	u8 data[0];
	144	};
	145
06ddbf5a EG	146	#define IWL_TLV_UCODE_MAGIC 0x0a4c5749
06ddbf5a EG	147	#define FW_VER_HUMAN_READABLE_SZ 64
edf38334 DF	148
	149	struct 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;
06ddbf5a	158	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
edf38334 DF	159	__le32 ver; /* major/minor/API/serial */
edf38334 DF	160	__le32 build;
0479c19d	161	__le64 ignore;
edf38334 DF	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
a2978b11 EH	171	/*
	172	* ucode TLVs
	173	*
	174	* ability to get extension for: flags & capabilities from ucode binaries files
	175	*/
	176	struct iwl_ucode_api {
	177	__le32 api_index;
	178	__le32 api_flags;
	179	} __packed;
	180
	181	struct iwl_ucode_capa {
	182	__le32 api_index;
	183	__le32 api_capa;
	184	} __packed;
	185
a52703b2 JB	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	*/
	215	enum 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
a52703b2	238	* @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
a52703b2 JB	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.
3cae0734 DS	244	* @IWL_UCODE_TLV_API_BASIC_DWELL: use only basic dwell time in scan command,
	245	* regardless of the band or the number of the probes. FW will calculate
	246	* the actual dwell time.
0294d9ee EG	247	* @IWL_UCODE_TLV_API_SCD_CFG: This firmware can configure the scheduler
0294d9ee EG	248	* through the dedicated host command.
a52703b2 JB	249	*/
a52703b2 JB	250	enum iwl_ucode_tlv_api {
a52703b2	251	IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
a52703b2 JB	252	IWL_UCODE_TLV_API_DISABLE_STA_TX = BIT(5),
	253	IWL_UCODE_TLV_API_LMAC_SCAN = BIT(6),
	254	IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF = BIT(7),
	255	IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8),
3cae0734	256	IWL_UCODE_TLV_API_BASIC_DWELL = BIT(13),
0294d9ee	257	IWL_UCODE_TLV_API_SCD_CFG = BIT(15),
a52703b2 JB	258	};
	259
	260	/**
	261	* enum iwl_ucode_tlv_capa - ucode capabilities
	262	* @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
	263	* @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
	264	* @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
	265	* @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
	266	* @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
	267	* tx power value into TPC Report action frame and Link Measurement Report
	268	* action frame
	269	* @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
	270	* channel in DS parameter set element in probe requests.
	271	* @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
	272	* probe requests.
	273	* @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
	274	* @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
	275	* which also implies support for the scheduler configuration command
	276	* @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
	277	* @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
	278	*/
	279	enum iwl_ucode_tlv_capa {
	280	IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0),
	281	IWL_UCODE_TLV_CAPA_LAR_SUPPORT = BIT(1),
	282	IWL_UCODE_TLV_CAPA_UMAC_SCAN = BIT(2),
	283	IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = BIT(6),
	284	IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = BIT(8),
	285	IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = BIT(9),
	286	IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = BIT(10),
	287	IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = BIT(11),
	288	IWL_UCODE_TLV_CAPA_DQA_SUPPORT = BIT(12),
	289	IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = BIT(13),
	290	IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = BIT(18),
	291	};
	292
	293	/* The default calibrate table size if not specified by firmware file */
	294	#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
	295	#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
	296	#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
	297
	298	/* The default max probe length if not specified by the firmware file */
	299	#define IWL_DEFAULT_MAX_PROBE_LENGTH 200
	300
	301	/*
	302	* For 16.0 uCode and above, there is no differentiation between sections,
	303	* just an offset to the HW address.
	304	*/
	305	#define IWL_UCODE_SECTION_MAX 12
	306	#define IWL_API_ARRAY_SIZE 1
	307	#define IWL_CAPABILITIES_ARRAY_SIZE 1
	308	#define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
	309
	310	/* uCode version contains 4 values: Major/Minor/API/Serial */
	311	#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
	312	#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
	313	#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
	314	#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
	315
	316	/*
	317	* Calibration control struct.
	318	* Sent as part of the phy configuration command.
	319	* @flow_trigger: bitmap for which calibrations to perform according to
	320	* flow triggers.
	321	* @event_trigger: bitmap for which calibrations to perform according to
322	* event triggers.
323	*/
324	struct iwl_tlv_calib_ctrl {
325	__le32 flow_trigger;
326	__le32 event_trigger;
327	} __packed;
328
329	enum iwl_fw_phy_cfg {
330	FW_PHY_CFG_RADIO_TYPE_POS = 0,
331	FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
332	FW_PHY_CFG_RADIO_STEP_POS = 2,
333	FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
334	FW_PHY_CFG_RADIO_DASH_POS = 4,
335	FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
336	FW_PHY_CFG_TX_CHAIN_POS = 16,
337	FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
338	FW_PHY_CFG_RX_CHAIN_POS = 20,
339	FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
340	};
341
342	#define IWL_UCODE_MAX_CS 1
343
344	/**
345	* struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
346	* @cipher: a cipher suite selector
347	* @flags: cipher scheme flags (currently reserved for a future use)
348	* @hdr_len: a size of MPDU security header
349	* @pn_len: a size of PN
350	* @pn_off: an offset of pn from the beginning of the security header
351	* @key_idx_off: an offset of key index byte in the security header
352	* @key_idx_mask: a bit mask of key_idx bits
353	* @key_idx_shift: bit shift needed to get key_idx
354	* @mic_len: mic length in bytes
355	* @hw_cipher: a HW cipher index used in host commands
356	*/
357	struct iwl_fw_cipher_scheme {
358	__le32 cipher;
359	u8 flags;
360	u8 hdr_len;
361	u8 pn_len;
362	u8 pn_off;
363	u8 key_idx_off;
364	u8 key_idx_mask;
365	u8 key_idx_shift;
366	u8 mic_len;
367	u8 hw_cipher;
368	} __packed;
369
490fefeb LK	370	enum iwl_fw_dbg_reg_operator {
	371	CSR_ASSIGN,
	372	CSR_SETBIT,
	373	CSR_CLEARBIT,
	374
	375	PRPH_ASSIGN,
	376	PRPH_SETBIT,
	377	PRPH_CLEARBIT,
	378	};
	379
	380	/**
	381	* struct iwl_fw_dbg_reg_op - an operation on a register
	382	*
	383	* @op: %enum iwl_fw_dbg_reg_operator
	384	* @addr: offset of the register
	385	* @val: value
	386	*/
	387	struct iwl_fw_dbg_reg_op {
	388	u8 op;
	389	u8 reserved[3];
	390	__le32 addr;
	391	__le32 val;
	392	} __packed;
	393
	394	/**
	395	* enum iwl_fw_dbg_monitor_mode - available monitor recording modes
	396	*
	397	* @SMEM_MODE: monitor stores the data in SMEM
	398	* @EXTERNAL_MODE: monitor stores the data in allocated DRAM
	399	* @MARBH_MODE: monitor stores the data in MARBH buffer
	400	*/
	401	enum iwl_fw_dbg_monitor_mode {
	402	SMEM_MODE = 0,
	403	EXTERNAL_MODE = 1,
	404	MARBH_MODE = 2,
	405	};
	406
	407	/**
	408	* struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
	409	*
	410	* @version: version of the TLV - currently 0
	411	* @monitor_mode: %enum iwl_fw_dbg_monitor_mode
	412	* @base_reg: addr of the base addr register (PRPH)
	413	* @end_reg: addr of the end addr register (PRPH)
	414	* @write_ptr_reg: the addr of the reg of the write pointer
	415	* @wrap_count: the addr of the reg of the wrap_count
	416	* @base_shift: shift right of the base addr reg
	417	* @end_shift: shift right of the end addr reg
	418	* @reg_ops: array of registers operations
	419	*
	420	* This parses IWL_UCODE_TLV_FW_DBG_DEST
	421	*/
	422	struct iwl_fw_dbg_dest_tlv {
	423	u8 version;
	424	u8 monitor_mode;
	425	u8 reserved[2];
	426	__le32 base_reg;
	427	__le32 end_reg;
	428	__le32 write_ptr_reg;
	429	__le32 wrap_count;
	430	u8 base_shift;
	431	u8 end_shift;
	432	struct iwl_fw_dbg_reg_op reg_ops[0];
	433	} __packed;
434
435	struct iwl_fw_dbg_conf_hcmd {
436	u8 id;
437	u8 reserved;
438	__le16 len;
439	u8 data[0];
440	} __packed;
441
442	/**
443	* struct iwl_fw_dbg_trigger - a TLV that describes a debug configuration
444	*
445	* @enabled: is this trigger enabled
446	* @reserved:
447	* @len: length, in bytes, of the %trigger field
448	* @trigger: pointer to a trigger struct
449	*/
450	struct iwl_fw_dbg_trigger {
451	u8 enabled;
452	u8 reserved;
453	u8 len;
454	u8 trigger[0];
455	} __packed;
456
457	/**
458	* enum iwl_fw_dbg_conf - configurations available
459	*
460	* @FW_DBG_CUSTOM: take this configuration from alive
461	* Note that the trigger is NO-OP for this configuration
462	*/
463	enum iwl_fw_dbg_conf {
464	FW_DBG_CUSTOM = 0,
465
466	/* must be last */
467	FW_DBG_MAX,
468	FW_DBG_INVALID = 0xff,
469	};
470
471	/**
472	* struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration
473	*
474	* @id: %enum iwl_fw_dbg_conf
475	* @usniffer: should the uSniffer image be used
476	* @num_of_hcmds: how many HCMDs to send are present here
477	* @hcmd: a variable length host command to be sent to apply the configuration.
478	* If there is more than one HCMD to send, they will appear one after the
479	* other and be sent in the order that they appear in.
480	* This parses IWL_UCODE_TLV_FW_DBG_CONF
481	*/
482	struct iwl_fw_dbg_conf_tlv {
483	u8 id;
484	u8 usniffer;
485	u8 reserved;
486	u8 num_of_hcmds;
487	struct iwl_fw_dbg_conf_hcmd hcmd;
488
489	/* struct iwl_fw_dbg_trigger sits after all variable length hcmds */
490	} __packed;
491
3995deaf	492	#endif /* __iwl_fw_file_h__ */