[deliverable/linux.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.
 * Copyright(c) 2013 - 2015 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 - 2015 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_h__
#define __iwl_fw_h__
#include <linux/types.h>
#include <net/mac80211.h>

#include "iwl-fw-file.h"
#include "iwl-fw-error-dump.h"

/**
 * 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
 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
 */
enum iwl_ucode_type {
	IWL_UCODE_REGULAR,
	IWL_UCODE_INIT,
	IWL_UCODE_WOWLAN,
	IWL_UCODE_REGULAR_USNIFFER,
	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,
};

struct iwl_ucode_capabilities {
	u32 max_probe_length;
	u32 n_scan_channels;
	u32 standard_phy_calibration_size;
	u32 flags;
	unsigned long _api[BITS_TO_LONGS(IWL_API_MAX_BITS)];
	unsigned long _capa[BITS_TO_LONGS(IWL_CAPABILITIES_MAX_BITS)];
};

static inline bool
fw_has_api(const struct iwl_ucode_capabilities *capabilities,
	   iwl_ucode_tlv_api_t api)
{
	return test_bit((__force long)api, capabilities->_api);
}

static inline bool
fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
	    iwl_ucode_tlv_capa_t capa)
{
	return test_bit((__force long)capa, capabilities->_capa);
}

/* 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_dual_cpus;
	u32 paging_mem_size;
};

struct iwl_sf_region {
	u32 addr;
	u32 size;
};

/*
 * Block paging calculations
 */
#define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
#define PAGE_PER_GROUP_2_EXP_SIZE 3
/* 8 pages per group */
#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
/* don't change, support only 32KB size */
#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
/* 32K == 2^15 */
#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)

/*
 * Image paging calculations
 */
#define BLOCK_PER_IMAGE_2_EXP_SIZE 5
/* 2^5 == 32 blocks per image */
#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
/* maximum image size 1024KB */
#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)

#define PAGING_CMD_IS_SECURED BIT(9)
#define PAGING_CMD_IS_ENABLED BIT(8)
#define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS	0
#define PAGING_TLV_SECURE_MASK 1

/**
 * struct iwl_fw_paging
 * @fw_paging_phys: page phy pointer
 * @fw_paging_block: pointer to the allocated block
 * @fw_paging_size: page size
 */
struct iwl_fw_paging {
	dma_addr_t fw_paging_phys;
	struct page *fw_paging_block;
	u32 fw_paging_size;
};

/**
 * 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_gscan_capabilities - gscan capabilities supported by FW
 * @max_scan_cache_size: total space allocated for scan results (in bytes).
 * @max_scan_buckets: maximum number of channel buckets.
 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
 * @max_hotlist_aps: maximum number of entries for hotlist APs.
 * @max_significant_change_aps: maximum number of entries for significant
 *	change APs.
 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
 *	hold.
 */
struct iwl_gscan_capabilities {
	u32 max_scan_cache_size;
	u32 max_scan_buckets;
	u32 max_ap_cache_per_scan;
	u32 max_rssi_sample_size;
	u32 max_scan_reporting_threshold;
	u32 max_hotlist_aps;
	u32 max_significant_change_aps;
	u32 max_bssid_history_entries;
};

/**
 * 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.
 * @human_readable: human readable version
 * @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
 *	we get the ALIVE from the uCode
 * @dbg_dest_tlv: points to the destination TLV for debug
 * @dbg_conf_tlv: array of pointers to configuration TLVs for debug
 * @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries
 * @dbg_trigger_tlv: array of pointers to triggers TLVs
 * @dbg_trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
 * @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
 */
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];
	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];

	u32 sdio_adma_addr;

	struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
	struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
	size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
	struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
	size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
	u8 dbg_dest_reg_num;
	struct iwl_gscan_capabilities gscan_capa;
};

static inline const char *get_fw_dbg_mode_string(int mode)
{
	switch (mode) {
	case SMEM_MODE:
		return "SMEM";
	case EXTERNAL_MODE:
		return "EXTERNAL_DRAM";
	case MARBH_MODE:
		return "MARBH";
	case MIPI_MODE:
		return "MIPI";
	default:
		return "UNKNOWN";
	}
}

static inline bool
iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
{
	const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];

	if (!conf_tlv)
		return false;

	return conf_tlv->usniffer;
}

#define iwl_fw_dbg_trigger_enabled(fw, id) ({			\
	void *__dbg_trigger = (fw)->dbg_trigger_tlv[(id)];	\
	unlikely(__dbg_trigger);				\
})

static inline struct iwl_fw_dbg_trigger_tlv*
iwl_fw_dbg_get_trigger(const struct iwl_fw *fw, u8 id)
{
	if (WARN_ON(id >= ARRAY_SIZE(fw->dbg_trigger_tlv)))
		return NULL;

	return fw->dbg_trigger_tlv[id];
}

#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.
6a8ac59c	9	* Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
0692fe41 JB	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.
0692fe41 JB	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.
859d914c	35	* Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
0692fe41 JB	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_h__
	66	#define __iwl_fw_h__
	67	#include <linux/types.h>
bb982e3a	68	#include <net/mac80211.h>
0692fe41	69
06ddbf5a	70	#include "iwl-fw-file.h"
d2709ad7	71	#include "iwl-fw-error-dump.h"
06ddbf5a	72
ed8c8365 DS	73	/**
	74	* enum iwl_ucode_type
	75	*
	76	* The type of ucode.
	77	*
	78	* @IWL_UCODE_REGULAR: Normal runtime ucode
	79	* @IWL_UCODE_INIT: Initial ucode
	80	* @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
61df750c	81	* @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
ed8c8365 DS	82	*/
	83	enum iwl_ucode_type {
	84	IWL_UCODE_REGULAR,
	85	IWL_UCODE_INIT,
	86	IWL_UCODE_WOWLAN,
61df750c	87	IWL_UCODE_REGULAR_USNIFFER,
ed8c8365 DS	88	IWL_UCODE_TYPE_MAX,
	89	};
	90
6dfa8d01 DS	91	/*
6dfa8d01 DS	92	* enumeration of ucode section.
0db53d00 JB	93	* This enumeration is used directly for older firmware (before 16.0).
	94	* For new firmware, there can be up to 4 sections (see below) but the
	95	* first one packaged into the firmware file is the DATA section and
	96	* some debugging code accesses that.
6dfa8d01 DS	97	*/
6dfa8d01 DS	98	enum iwl_ucode_sec {
6dfa8d01	99	IWL_UCODE_SECTION_DATA,
0db53d00	100	IWL_UCODE_SECTION_INST,
6dfa8d01	101	};
6dfa8d01	102
0692fe41 JB	103	struct iwl_ucode_capabilities {
0692fe41 JB	104	u32 max_probe_length;
762533ba	105	u32 n_scan_channels;
0692fe41 JB	106	u32 standard_phy_calibration_size;
0692fe41 JB	107	u32 flags;
859d914c JB	108	unsigned long _api[BITS_TO_LONGS(IWL_API_MAX_BITS)];
859d914c JB	109	unsigned long _capa[BITS_TO_LONGS(IWL_CAPABILITIES_MAX_BITS)];
0692fe41 JB	110	};
0692fe41 JB	111
859d914c JB	112	static inline bool
	113	fw_has_api(const struct iwl_ucode_capabilities *capabilities,
	114	iwl_ucode_tlv_api_t api)
	115	{
	116	return test_bit((__force long)api, capabilities->_api);
	117	}
	118
	119	static inline bool
	120	fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
	121	iwl_ucode_tlv_capa_t capa)
	122	{
	123	return test_bit((__force long)capa, capabilities->_capa);
	124	}
	125
0cedacc5	126	/* one for each uCode image (inst/data, init/runtime/wowlan) */
0692fe41	127	struct fw_desc {
83f84d7b	128	const void data; / vmalloc'ed data */
0692fe41	129	u32 len; /* size in bytes */
0cedacc5	130	u32 offset; /* offset in the device */
0692fe41 JB	131	};
	132
	133	struct fw_img {
6dfa8d01	134	struct fw_desc sec[IWL_UCODE_SECTION_MAX];
e2d6f4e7	135	bool is_dual_cpus;
a6c4fb44	136	u32 paging_mem_size;
0692fe41 JB	137	};
0692fe41 JB	138
91479b64 EH	139	struct iwl_sf_region {
	140	u32 addr;
	141	u32 size;
	142	};
	143
a6c4fb44 MG	144	/*
	145	* Block paging calculations
	146	*/
	147	#define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
	148	#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
	149	#define PAGE_PER_GROUP_2_EXP_SIZE 3
	150	/* 8 pages per group */
	151	#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
	152	/* don't change, support only 32KB size */
	153	#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
	154	/* 32K == 2^15 */
	155	#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
	156
	157	/*
	158	* Image paging calculations
	159	*/
	160	#define BLOCK_PER_IMAGE_2_EXP_SIZE 5
	161	/* 2^5 == 32 blocks per image */
	162	#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
	163	/* maximum image size 1024KB */
	164	#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
	165
	166	#define PAGING_CMD_IS_SECURED BIT(9)
	167	#define PAGING_CMD_IS_ENABLED BIT(8)
	168	#define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
	169	#define PAGING_TLV_SECURE_MASK 1
	170
	171	/**
	172	* struct iwl_fw_paging
	173	* @fw_paging_phys: page phy pointer
	174	* @fw_paging_block: pointer to the allocated block
	175	* @fw_paging_size: page size
	176	*/
	177	struct iwl_fw_paging {
	178	dma_addr_t fw_paging_phys;
	179	struct page *fw_paging_block;
	180	u32 fw_paging_size;
	181	};
	182
e36e5433 MS	183	/**
	184	* struct iwl_fw_cscheme_list - a cipher scheme list
	185	* @size: a number of entries
	186	* @cs: cipher scheme entries
	187	*/
	188	struct iwl_fw_cscheme_list {
	189	u8 size;
	190	struct iwl_fw_cipher_scheme cs[];
	191	} __packed;
	192
17564dde AS	193	/**
	194	* struct iwl_gscan_capabilities - gscan capabilities supported by FW
	195	* @max_scan_cache_size: total space allocated for scan results (in bytes).
	196	* @max_scan_buckets: maximum number of channel buckets.
	197	* @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
	198	* @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
	199	* @max_scan_reporting_threshold: max possible report threshold. in percentage.
	200	* @max_hotlist_aps: maximum number of entries for hotlist APs.
	201	* @max_significant_change_aps: maximum number of entries for significant
	202	* change APs.
	203	* @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
	204	* hold.
	205	*/
	206	struct iwl_gscan_capabilities {
	207	u32 max_scan_cache_size;
	208	u32 max_scan_buckets;
	209	u32 max_ap_cache_per_scan;
	210	u32 max_rssi_sample_size;
	211	u32 max_scan_reporting_threshold;
	212	u32 max_hotlist_aps;
	213	u32 max_significant_change_aps;
	214	u32 max_bssid_history_entries;
	215	};
	216
0692fe41 JB	217	/**
	218	* struct iwl_fw - variables associated with the firmware
	219	*
	220	* @ucode_ver: ucode version from the ucode file
	221	* @fw_version: firmware version string
6dfa8d01	222	* @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
0692fe41 JB	223	* @ucode_capa: capabilities parsed from the ucode file.
	224	* @enhance_sensitivity_table: device can do enhanced sensitivity.
	225	* @init_evtlog_ptr: event log offset for init ucode.
	226	* @init_evtlog_size: event log size for init ucode.
	227	* @init_errlog_ptr: error log offfset for init ucode.
	228	* @inst_evtlog_ptr: event log offset for runtime ucode.
	229	* @inst_evtlog_size: event log size for runtime ucode.
	230	* @inst_errlog_ptr: error log offfset for runtime ucode.
8ca151b5	231	* @mvm_fw: indicates this is MVM firmware
e36e5433	232	* @cipher_scheme: optional external cipher scheme.
a52703b2	233	* @human_readable: human readable version
b4821767 LK	234	* @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
b4821767 LK	235	* we get the ALIVE from the uCode
490fefeb LK	236	* @dbg_dest_tlv: points to the destination TLV for debug
	237	* @dbg_conf_tlv: array of pointers to configuration TLVs for debug
	238	* @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries
d2709ad7 EG	239	* @dbg_trigger_tlv: array of pointers to triggers TLVs
d2709ad7 EG	240	* @dbg_trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
490fefeb	241	* @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
0692fe41 JB	242	*/
	243	struct iwl_fw {
	244	u32 ucode_ver;
	245
81135548	246	char fw_version[ETHTOOL_FWVERS_LEN];
0692fe41 JB	247
0692fe41 JB	248	/* ucode images */
6dfa8d01	249	struct fw_img img[IWL_UCODE_TYPE_MAX];
0692fe41 JB	250
	251	struct iwl_ucode_capabilities ucode_capa;
	252	bool enhance_sensitivity_table;
	253
	254	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
	255	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
ed8c8365	256
aa2b1770	257	struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
ed8c8365	258	u32 phy_config;
77db0a3c EH	259	u8 valid_tx_ant;
77db0a3c EH	260	u8 valid_rx_ant;
4db2c9ae DS	261
4db2c9ae DS	262	bool mvm_fw;
e36e5433 MS	263
e36e5433 MS	264	struct ieee80211_cipher_scheme cs[IWL_UCODE_MAX_CS];
06ddbf5a	265	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
490fefeb	266
b4821767 LK	267	u32 sdio_adma_addr;
b4821767 LK	268
490fefeb	269	struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
d2709ad7 EG	270	struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
	271	size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
	272	struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
	273	size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
490fefeb	274	u8 dbg_dest_reg_num;
17564dde	275	struct iwl_gscan_capabilities gscan_capa;
0692fe41 JB	276	};
0692fe41 JB	277
490fefeb LK	278	static inline const char *get_fw_dbg_mode_string(int mode)
	279	{
	280	switch (mode) {
	281	case SMEM_MODE:
	282	return "SMEM";
	283	case EXTERNAL_MODE:
	284	return "EXTERNAL_DRAM";
	285	case MARBH_MODE:
	286	return "MARBH";
6a8ac59c LK	287	case MIPI_MODE:
6a8ac59c LK	288	return "MIPI";
490fefeb LK	289	default:
	290	return "UNKNOWN";
	291	}
	292	}
	293
d2709ad7 EG	294	static inline bool
d2709ad7 EG	295	iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
490fefeb LK	296	{
490fefeb LK	297	const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];
490fefeb LK	298
490fefeb LK	299	if (!conf_tlv)
490fefeb LK	300	return false;
490fefeb LK	301
d2709ad7	302	return conf_tlv->usniffer;
490fefeb LK	303	}
490fefeb LK	304
d2709ad7 EG	305	#define iwl_fw_dbg_trigger_enabled(fw, id) ({ \
	306	void *__dbg_trigger = (fw)->dbg_trigger_tlv[(id)]; \
	307	unlikely(__dbg_trigger); \
	308	})
61df750c	309
d2709ad7 EG	310	static inline struct iwl_fw_dbg_trigger_tlv*
	311	iwl_fw_dbg_get_trigger(const struct iwl_fw *fw, u8 id)
	312	{
	313	if (WARN_ON(id >= ARRAY_SIZE(fw->dbg_trigger_tlv)))
	314	return NULL;
61df750c	315
d2709ad7	316	return fw->dbg_trigger_tlv[id];
61df750c EH	317	}
61df750c EH	318
0692fe41	319	#endif /* __iwl_fw_h__ */