[linux-block.git] / drivers / net / wireless / iwlwifi / iwl-fw.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.
 *
 * 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.
 * 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_h__
#define __iwl_fw_h__
#include <linux/types.h>
#include <net/mac80211.h>

/**
 * 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: 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_RX_ENERGY_API: supports rx signal strength api
 * @IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2: using the new time event API.
 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 *	(rather than two) IPv6 addresses
 * @IWL_UCODE_TLV_FLAGS_BF_UPDATED: new beacon filtering API
 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 *	from the probe request template.
 * @IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API: modified D3 API to allow keeping
 *	connection when going back to D0
 * @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_SCHED_SCAN: this uCode image supports scheduled scan.
 * @IWL_UCODE_TLV_FLAGS_STA_KEY_CMD: new ADD_STA and ADD_STA_KEY command API
 * @IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD: support device wide power command
 *	containing CAM (Continuous Active Mode) indication.
 * @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_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
 */
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_NEWBT_COEX		= BIT(5),
	IWL_UCODE_TLV_FLAGS_PM_CMD_SUPPORT	= BIT(6),
	IWL_UCODE_TLV_FLAGS_SHORT_BL		= BIT(7),
	IWL_UCODE_TLV_FLAGS_RX_ENERGY_API	= BIT(8),
	IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2	= BIT(9),
	IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS	= BIT(10),
	IWL_UCODE_TLV_FLAGS_BF_UPDATED		= BIT(11),
	IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID	= BIT(12),
	IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API	= BIT(14),
	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL	= BIT(15),
	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE	= BIT(16),
	IWL_UCODE_TLV_FLAGS_SCHED_SCAN		= BIT(17),
	IWL_UCODE_TLV_FLAGS_STA_KEY_CMD		= BIT(19),
	IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD	= BIT(20),
	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM	= BIT(22),
	IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT	= BIT(24),
	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),
};

/* 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

/**
 * enum iwl_ucode_type
 *
 * The type of ucode.
 *
 * @IWL_UCODE_REGULAR: Normal runtime ucode
 * @IWL_UCODE_INIT: Initial ucode
 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
 */
enum iwl_ucode_type {
	IWL_UCODE_REGULAR,
	IWL_UCODE_INIT,
	IWL_UCODE_WOWLAN,
	IWL_UCODE_TYPE_MAX,
};

/*
 * enumeration of ucode section.
 * This enumeration is used directly for older firmware (before 16.0).
 * For new firmware, there can be up to 4 sections (see below) but the
 * first one packaged into the firmware file is the DATA section and
 * some debugging code accesses that.
 */
enum iwl_ucode_sec {
	IWL_UCODE_SECTION_DATA,
	IWL_UCODE_SECTION_INST,
};
/*
 * 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

struct iwl_ucode_capabilities {
	u32 max_probe_length;
	u32 standard_phy_calibration_size;
	u32 flags;
	u32 api[IWL_API_ARRAY_SIZE];
	u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
};

/* one for each uCode image (inst/data, init/runtime/wowlan) */
struct fw_desc {
	const void *data;	/* vmalloc'ed data */
	u32 len;		/* size in bytes */
	u32 offset;		/* offset in the device */
};

struct fw_img {
	struct fw_desc sec[IWL_UCODE_SECTION_MAX];
	bool is_secure;
	bool is_dual_cpus;
};

/* 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;

/**
 * struct iwl_fw_cscheme_list - a cipher scheme list
 * @size: a number of entries
 * @cs: cipher scheme entries
 */
struct iwl_fw_cscheme_list {
	u8 size;
	struct iwl_fw_cipher_scheme cs[];
} __packed;

/**
 * struct iwl_fw - variables associated with the firmware
 *
 * @ucode_ver: ucode version from the ucode file
 * @fw_version: firmware version string
 * @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
 * @ucode_capa: capabilities parsed from the ucode file.
 * @enhance_sensitivity_table: device can do enhanced sensitivity.
 * @init_evtlog_ptr: event log offset for init ucode.
 * @init_evtlog_size: event log size for init ucode.
 * @init_errlog_ptr: error log offfset for init ucode.
 * @inst_evtlog_ptr: event log offset for runtime ucode.
 * @inst_evtlog_size: event log size for runtime ucode.
 * @inst_errlog_ptr: error log offfset for runtime ucode.
 * @mvm_fw: indicates this is MVM firmware
 * @cipher_scheme: optional external cipher scheme.
 */
struct iwl_fw {
	u32 ucode_ver;

	char fw_version[ETHTOOL_FWVERS_LEN];

	/* ucode images */
	struct fw_img img[IWL_UCODE_TYPE_MAX];

	struct iwl_ucode_capabilities ucode_capa;
	bool enhance_sensitivity_table;

	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;

	struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
	u32 phy_config;
	u8 valid_tx_ant;
	u8 valid_rx_ant;

	bool mvm_fw;

	struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
};

#endif  /* __iwl_fw_h__ */
Commit	Line	Data
0692fe41 JB	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.
0692fe41 JB	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of version 2 of the GNU General Public License as
	12	* published by the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
	22	* USA
	23	*
	24	* The full GNU General Public License is included in this distribution
410dc5aa	25	* in the file called COPYING.
0692fe41 JB	26	*
	27	* Contact Information:
	28	* Intel Linux Wireless <ilw@linux.intel.com>
	29	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	30	*
	31	* BSD LICENSE
	32	*
51368bf7	33	* Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
0692fe41 JB	34	* All rights reserved.
	35	*
	36	* Redistribution and use in source and binary forms, with or without
	37	* modification, are permitted provided that the following conditions
	38	* are met:
	39	*
	40	* * Redistributions of source code must retain the above copyright
	41	* notice, this list of conditions and the following disclaimer.
	42	* * Redistributions in binary form must reproduce the above copyright
	43	* notice, this list of conditions and the following disclaimer in
	44	* the documentation and/or other materials provided with the
	45	* distribution.
	46	* * Neither the name Intel Corporation nor the names of its
	47	* contributors may be used to endorse or promote products derived
	48	* from this software without specific prior written permission.
	49	*
	50	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	51	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	52	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	53	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	54	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	55	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	56	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	57	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	58	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	59	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	60	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	61	*****************************************************************************/
	62
	63	#ifndef __iwl_fw_h__
	64	#define __iwl_fw_h__
	65	#include <linux/types.h>
bb982e3a	66	#include <net/mac80211.h>
0692fe41 JB	67
	68	/**
	69	* enum iwl_ucode_tlv_flag - ucode API flags
	70	* @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
	71	* was a separate TLV but moved here to save space.
	72	* @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
	73	* treats good CRC threshold as a boolean
	74	* @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
	75	* @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
25b9ea5c	76	* @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
e811ada7	77	* @IWL_UCODE_TLV_FLAGS_UAPSD: This uCode image supports uAPSD
35a000b7 DS	78	* @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
35a000b7 DS	79	* offload profile config command.
a2d7b870	80	* @IWL_UCODE_TLV_FLAGS_RX_ENERGY_API: supports rx signal strength api
f8f03c3e	81	* @IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2: using the new time event API.
5369d6c1 JB	82	* @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
5369d6c1 JB	83	* (rather than two) IPv6 addresses
5dca7c24	84	* @IWL_UCODE_TLV_FLAGS_BF_UPDATED: new beacon filtering API
20f1a5de DS	85	* @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
20f1a5de DS	86	* from the probe request template.
6d9d32b8 JB	87	* @IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API: modified D3 API to allow keeping
6d9d32b8 JB	88	* connection when going back to D0
f7fc5989 JB	89	* @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
f7fc5989 JB	90	* @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
35a000b7	91	* @IWL_UCODE_TLV_FLAGS_SCHED_SCAN: this uCode image supports scheduled scan.
5a258aae	92	* @IWL_UCODE_TLV_FLAGS_STA_KEY_CMD: new ADD_STA and ADD_STA_KEY command API
64b928c4 AB	93	* @IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD: support device wide power command
64b928c4 AB	94	* containing CAM (Continuous Active Mode) indication.
7303dd7f AB	95	* @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
7303dd7f AB	96	* P2P client interfaces simultaneously if they are in different bindings.
75209672	97	* @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
c87163b9	98	* @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
3e56eadf	99	* @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
0692fe41 JB	100	*/
0692fe41 JB	101	enum iwl_ucode_tlv_flag {
a2d7b870 AA	102	IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
	103	IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
	104	IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
	105	IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
	106	IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
dac94da8	107	IWL_UCODE_TLV_FLAGS_NEWBT_COEX = BIT(5),
e8e626ad	108	IWL_UCODE_TLV_FLAGS_PM_CMD_SUPPORT = BIT(6),
35a000b7	109	IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
a2d7b870	110	IWL_UCODE_TLV_FLAGS_RX_ENERGY_API = BIT(8),
f8f03c3e	111	IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2 = BIT(9),
5369d6c1	112	IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
5dca7c24	113	IWL_UCODE_TLV_FLAGS_BF_UPDATED = BIT(11),
20f1a5de	114	IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
6d9d32b8	115	IWL_UCODE_TLV_FLAGS_D3_CONTINUITY_API = BIT(14),
f7fc5989 JB	116	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
f7fc5989 JB	117	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
35a000b7	118	IWL_UCODE_TLV_FLAGS_SCHED_SCAN = BIT(17),
5a258aae	119	IWL_UCODE_TLV_FLAGS_STA_KEY_CMD = BIT(19),
64b928c4	120	IWL_UCODE_TLV_FLAGS_DEVICE_PS_CMD = BIT(20),
7303dd7f	121	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
e8e626ad	122	IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
75209672	123	IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
c87163b9	124	IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
3e56eadf	125	IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
0692fe41 JB	126	};
	127
	128	/* The default calibrate table size if not specified by firmware file */
	129	#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
	130	#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
	131	#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
	132
66140adc LC	133	/* The default max probe length if not specified by the firmware file */
	134	#define IWL_DEFAULT_MAX_PROBE_LENGTH 200
	135
ed8c8365 DS	136	/**
	137	* enum iwl_ucode_type
	138	*
	139	* The type of ucode.
	140	*
	141	* @IWL_UCODE_REGULAR: Normal runtime ucode
	142	* @IWL_UCODE_INIT: Initial ucode
	143	* @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
	144	*/
	145	enum iwl_ucode_type {
	146	IWL_UCODE_REGULAR,
	147	IWL_UCODE_INIT,
	148	IWL_UCODE_WOWLAN,
	149	IWL_UCODE_TYPE_MAX,
	150	};
	151
6dfa8d01 DS	152	/*
6dfa8d01 DS	153	* enumeration of ucode section.
0db53d00 JB	154	* This enumeration is used directly for older firmware (before 16.0).
	155	* For new firmware, there can be up to 4 sections (see below) but the
	156	* first one packaged into the firmware file is the DATA section and
	157	* some debugging code accesses that.
6dfa8d01 DS	158	*/
6dfa8d01 DS	159	enum iwl_ucode_sec {
6dfa8d01	160	IWL_UCODE_SECTION_DATA,
0db53d00	161	IWL_UCODE_SECTION_INST,
6dfa8d01 DS	162	};
	163	/*
	164	* For 16.0 uCode and above, there is no differentiation between sections,
	165	* just an offset to the HW address.
	166	*/
034846cf	167	#define IWL_UCODE_SECTION_MAX 12
a2978b11 EH	168	#define IWL_API_ARRAY_SIZE 1
a2978b11 EH	169	#define IWL_CAPABILITIES_ARRAY_SIZE 1
6dfa8d01	170
0692fe41 JB	171	struct iwl_ucode_capabilities {
	172	u32 max_probe_length;
	173	u32 standard_phy_calibration_size;
	174	u32 flags;
a2978b11 EH	175	u32 api[IWL_API_ARRAY_SIZE];
a2978b11 EH	176	u32 capa[IWL_CAPABILITIES_ARRAY_SIZE];
0692fe41 JB	177	};
0692fe41 JB	178
0cedacc5	179	/* one for each uCode image (inst/data, init/runtime/wowlan) */
0692fe41	180	struct fw_desc {
83f84d7b	181	const void data; / vmalloc'ed data */
0692fe41	182	u32 len; /* size in bytes */
0cedacc5	183	u32 offset; /* offset in the device */
0692fe41 JB	184	};
	185
	186	struct fw_img {
6dfa8d01	187	struct fw_desc sec[IWL_UCODE_SECTION_MAX];
e2d6f4e7 EH	188	bool is_secure;
e2d6f4e7 EH	189	bool is_dual_cpus;
0692fe41 JB	190	};
	191
	192	/* uCode version contains 4 values: Major/Minor/API/Serial */
	193	#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
	194	#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
	195	#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
	196	#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
	197
aa2b1770 JB	198	/*
	199	* Calibration control struct.
	200	* Sent as part of the phy configuration command.
	201	* @flow_trigger: bitmap for which calibrations to perform according to
	202	* flow triggers.
	203	* @event_trigger: bitmap for which calibrations to perform according to
	204	* event triggers.
	205	*/
	206	struct iwl_tlv_calib_ctrl {
	207	__le32 flow_trigger;
	208	__le32 event_trigger;
	209	} __packed;
	210
d110cb51 EG	211	enum iwl_fw_phy_cfg {
	212	FW_PHY_CFG_RADIO_TYPE_POS = 0,
	213	FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
	214	FW_PHY_CFG_RADIO_STEP_POS = 2,
	215	FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
	216	FW_PHY_CFG_RADIO_DASH_POS = 4,
	217	FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
	218	FW_PHY_CFG_TX_CHAIN_POS = 16,
	219	FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
	220	FW_PHY_CFG_RX_CHAIN_POS = 20,
	221	FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
	222	};
	223
e36e5433 MS	224	#define IWL_UCODE_MAX_CS 1
	225
	226	/**
	227	* struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
	228	* @cipher: a cipher suite selector
	229	* @flags: cipher scheme flags (currently reserved for a future use)
	230	* @hdr_len: a size of MPDU security header
	231	* @pn_len: a size of PN
	232	* @pn_off: an offset of pn from the beginning of the security header
	233	* @key_idx_off: an offset of key index byte in the security header
	234	* @key_idx_mask: a bit mask of key_idx bits
	235	* @key_idx_shift: bit shift needed to get key_idx
	236	* @mic_len: mic length in bytes
	237	* @hw_cipher: a HW cipher index used in host commands
	238	*/
	239	struct iwl_fw_cipher_scheme {
	240	__le32 cipher;
	241	u8 flags;
	242	u8 hdr_len;
	243	u8 pn_len;
	244	u8 pn_off;
	245	u8 key_idx_off;
	246	u8 key_idx_mask;
	247	u8 key_idx_shift;
	248	u8 mic_len;
	249	u8 hw_cipher;
	250	} __packed;
	251
	252	/**
	253	* struct iwl_fw_cscheme_list - a cipher scheme list
	254	* @size: a number of entries
	255	* @cs: cipher scheme entries
	256	*/
	257	struct iwl_fw_cscheme_list {
	258	u8 size;
	259	struct iwl_fw_cipher_scheme cs[];
	260	} __packed;
	261
0692fe41 JB	262	/**
	263	* struct iwl_fw - variables associated with the firmware
	264	*
	265	* @ucode_ver: ucode version from the ucode file
	266	* @fw_version: firmware version string
6dfa8d01	267	* @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
0692fe41 JB	268	* @ucode_capa: capabilities parsed from the ucode file.
	269	* @enhance_sensitivity_table: device can do enhanced sensitivity.
	270	* @init_evtlog_ptr: event log offset for init ucode.
	271	* @init_evtlog_size: event log size for init ucode.
	272	* @init_errlog_ptr: error log offfset for init ucode.
	273	* @inst_evtlog_ptr: event log offset for runtime ucode.
	274	* @inst_evtlog_size: event log size for runtime ucode.
	275	* @inst_errlog_ptr: error log offfset for runtime ucode.
8ca151b5	276	* @mvm_fw: indicates this is MVM firmware
e36e5433	277	* @cipher_scheme: optional external cipher scheme.
0692fe41 JB	278	*/
	279	struct iwl_fw {
	280	u32 ucode_ver;
	281
81135548	282	char fw_version[ETHTOOL_FWVERS_LEN];
0692fe41 JB	283
0692fe41 JB	284	/* ucode images */
6dfa8d01	285	struct fw_img img[IWL_UCODE_TYPE_MAX];
0692fe41 JB	286
	287	struct iwl_ucode_capabilities ucode_capa;
	288	bool enhance_sensitivity_table;
	289
	290	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
	291	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
ed8c8365	292
aa2b1770	293	struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
ed8c8365	294	u32 phy_config;
77db0a3c EH	295	u8 valid_tx_ant;
77db0a3c EH	296	u8 valid_rx_ant;
4db2c9ae DS	297
4db2c9ae DS	298	bool mvm_fw;
e36e5433 MS	299
e36e5433 MS	300	struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
0692fe41 JB	301	};
	302
	303	#endif /* __iwl_fw_h__ */