[mirror_ubuntu-hirsute-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,
};

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_WOWLAN_CONFIG_TID: wowlan config includes tid field.
 * @IWL_UCODE_TLV_CAPA_EXTENDED_BEACON: Support Extended beacon notification
 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
 * @IWL_UCODE_TLV_API_CSA_FLOW: ucode can do unbind-bind flow for CSA.
 * @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.
 */
enum iwl_ucode_tlv_api {
	IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID	= BIT(0),
	IWL_UCODE_TLV_CAPA_EXTENDED_BEACON	= BIT(1),
	IWL_UCODE_TLV_API_BT_COEX_SPLIT         = BIT(3),
	IWL_UCODE_TLV_API_CSA_FLOW		= BIT(4),
	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),
};

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

#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,
edf38334 DF	134	};
edf38334 DF	135
edf38334	136	struct iwl_ucode_tlv {
0479c19d	137	__le32 type; /* see above */
edf38334 DF	138	__le32 length; /* not including type/length fields */
	139	u8 data[0];
	140	};
	141
06ddbf5a EG	142	#define IWL_TLV_UCODE_MAGIC 0x0a4c5749
06ddbf5a EG	143	#define FW_VER_HUMAN_READABLE_SZ 64
edf38334 DF	144
	145	struct iwl_tlv_ucode_header {
	146	/*
	147	* The TLV style ucode header is distinguished from
	148	* the v1/v2 style header by first four bytes being
	149	* zero, as such is an invalid combination of
	150	* major/minor/API/serial versions.
	151	*/
	152	__le32 zero;
	153	__le32 magic;
06ddbf5a	154	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
edf38334 DF	155	__le32 ver; /* major/minor/API/serial */
edf38334 DF	156	__le32 build;
0479c19d	157	__le64 ignore;
edf38334 DF	158	/*
	159	* The data contained herein has a TLV layout,
	160	* see above for the TLV header and types.
	161	* Note that each TLV is padded to a length
	162	* that is a multiple of 4 for alignment.
	163	*/
	164	u8 data[0];
	165	};
	166
a2978b11 EH	167	/*
	168	* ucode TLVs
	169	*
	170	* ability to get extension for: flags & capabilities from ucode binaries files
	171	*/
	172	struct iwl_ucode_api {
	173	__le32 api_index;
	174	__le32 api_flags;
	175	} __packed;
	176
	177	struct iwl_ucode_capa {
	178	__le32 api_index;
	179	__le32 api_capa;
	180	} __packed;
	181
a52703b2 JB	182	/**
	183	* enum iwl_ucode_tlv_flag - ucode API flags
	184	* @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
	185	* was a separate TLV but moved here to save space.
	186	* @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
	187	* treats good CRC threshold as a boolean
	188	* @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
	189	* @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
	190	* @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
	191	* @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
	192	* @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
	193	* offload profile config command.
	194	* @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
	195	* (rather than two) IPv6 addresses
	196	* @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
	197	* from the probe request template.
	198	* @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
	199	* @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
	200	* @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
	201	* @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
	202	* P2P client interfaces simultaneously if they are in different bindings.
	203	* @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
	204	* P2P client interfaces simultaneously if they are in same bindings.
	205	* @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
	206	* @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
	207	* @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
	208	* @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
	209	* @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
	210	*/
	211	enum iwl_ucode_tlv_flag {
	212	IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
	213	IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
	214	IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
	215	IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
	216	IWL_UCODE_TLV_FLAGS_DW_BC_TABLE = BIT(4),
	217	IWL_UCODE_TLV_FLAGS_SHORT_BL = BIT(7),
	218	IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS = BIT(10),
	219	IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID = BIT(12),
	220	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL = BIT(15),
	221	IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE = BIT(16),
	222	IWL_UCODE_TLV_FLAGS_P2P_PM = BIT(21),
	223	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM = BIT(22),
	224	IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM = BIT(23),
	225	IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT = BIT(24),
	226	IWL_UCODE_TLV_FLAGS_EBS_SUPPORT = BIT(25),
	227	IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD = BIT(26),
	228	IWL_UCODE_TLV_FLAGS_BCAST_FILTERING = BIT(29),
	229	IWL_UCODE_TLV_FLAGS_GO_UAPSD = BIT(30),
	230	};
	231
	232	/**
	233	* enum iwl_ucode_tlv_api - ucode api
	234	* @IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID: wowlan config includes tid field.
	235	* @IWL_UCODE_TLV_CAPA_EXTENDED_BEACON: Support Extended beacon notification
	236	* @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
	237	* @IWL_UCODE_TLV_API_CSA_FLOW: ucode can do unbind-bind flow for CSA.
	238	* @IWL_UCODE_TLV_API_DISABLE_STA_TX: ucode supports tx_disable bit.
	239	* @IWL_UCODE_TLV_API_LMAC_SCAN: This ucode uses LMAC unified scan API.
	240	* @IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF: ucode supports disabling dummy notif.
	241	* @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
	242	* longer than the passive one, which is essential for fragmented scan.
	243	*/
	244	enum iwl_ucode_tlv_api {
	245	IWL_UCODE_TLV_API_WOWLAN_CONFIG_TID = BIT(0),
246	IWL_UCODE_TLV_CAPA_EXTENDED_BEACON = BIT(1),
247	IWL_UCODE_TLV_API_BT_COEX_SPLIT = BIT(3),
248	IWL_UCODE_TLV_API_CSA_FLOW = BIT(4),
249	IWL_UCODE_TLV_API_DISABLE_STA_TX = BIT(5),
250	IWL_UCODE_TLV_API_LMAC_SCAN = BIT(6),
251	IWL_UCODE_TLV_API_SF_NO_DUMMY_NOTIF = BIT(7),
252	IWL_UCODE_TLV_API_FRAGMENTED_SCAN = BIT(8),
253	};
254
255	/**
256	* enum iwl_ucode_tlv_capa - ucode capabilities
257	* @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
258	* @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
259	* @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
260	* @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
261	* @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
262	* tx power value into TPC Report action frame and Link Measurement Report
263	* action frame
264	* @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
265	* channel in DS parameter set element in probe requests.
266	* @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
267	* probe requests.
268	* @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
269	* @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
270	* which also implies support for the scheduler configuration command
271	* @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
272	* @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
273	*/
274	enum iwl_ucode_tlv_capa {
275	IWL_UCODE_TLV_CAPA_D0I3_SUPPORT = BIT(0),
276	IWL_UCODE_TLV_CAPA_LAR_SUPPORT = BIT(1),
277	IWL_UCODE_TLV_CAPA_UMAC_SCAN = BIT(2),
278	IWL_UCODE_TLV_CAPA_TDLS_SUPPORT = BIT(6),
279	IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT = BIT(8),
280	IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT = BIT(9),
281	IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT = BIT(10),
282	IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT = BIT(11),
283	IWL_UCODE_TLV_CAPA_DQA_SUPPORT = BIT(12),
284	IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH = BIT(13),
285	IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT = BIT(18),
286	};
287
288	/* The default calibrate table size if not specified by firmware file */
289	#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
290	#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
291	#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
292
293	/* The default max probe length if not specified by the firmware file */
294	#define IWL_DEFAULT_MAX_PROBE_LENGTH 200
295
296	/*
297	* For 16.0 uCode and above, there is no differentiation between sections,
298	* just an offset to the HW address.
299	*/
300	#define IWL_UCODE_SECTION_MAX 12
301	#define IWL_API_ARRAY_SIZE 1
302	#define IWL_CAPABILITIES_ARRAY_SIZE 1
303	#define CPU1_CPU2_SEPARATOR_SECTION 0xFFFFCCCC
304
305	/* uCode version contains 4 values: Major/Minor/API/Serial */
306	#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
307	#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
308	#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
309	#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
310
311	/*
312	* Calibration control struct.
313	* Sent as part of the phy configuration command.
314	* @flow_trigger: bitmap for which calibrations to perform according to
315	* flow triggers.
316	* @event_trigger: bitmap for which calibrations to perform according to
317	* event triggers.
318	*/
319	struct iwl_tlv_calib_ctrl {
320	__le32 flow_trigger;
321	__le32 event_trigger;
322	} __packed;
323
324	enum iwl_fw_phy_cfg {
325	FW_PHY_CFG_RADIO_TYPE_POS = 0,
326	FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
327	FW_PHY_CFG_RADIO_STEP_POS = 2,
328	FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
329	FW_PHY_CFG_RADIO_DASH_POS = 4,
330	FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
331	FW_PHY_CFG_TX_CHAIN_POS = 16,
332	FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
333	FW_PHY_CFG_RX_CHAIN_POS = 20,
334	FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
335	};
336
337	#define IWL_UCODE_MAX_CS 1
338
339	/**
340	* struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
341	* @cipher: a cipher suite selector
342	* @flags: cipher scheme flags (currently reserved for a future use)
343	* @hdr_len: a size of MPDU security header
344	* @pn_len: a size of PN
345	* @pn_off: an offset of pn from the beginning of the security header
346	* @key_idx_off: an offset of key index byte in the security header
347	* @key_idx_mask: a bit mask of key_idx bits
348	* @key_idx_shift: bit shift needed to get key_idx
349	* @mic_len: mic length in bytes
350	* @hw_cipher: a HW cipher index used in host commands
351	*/
352	struct iwl_fw_cipher_scheme {
353	__le32 cipher;
354	u8 flags;
355	u8 hdr_len;
356	u8 pn_len;
357	u8 pn_off;
358	u8 key_idx_off;
359	u8 key_idx_mask;
360	u8 key_idx_shift;
361	u8 mic_len;
362	u8 hw_cipher;
363	} __packed;
364
3995deaf	365	#endif /* __iwl_fw_file_h__ */