[linux-block.git] / drivers / net / wireless / intel / 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
 * Copyright(c) 2016        Intel Deutschland 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 <linuxwifi@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
 * Copyright(c) 2016        Intel Deutschland 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 "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(NUM_IWL_UCODE_TLV_API)];
	unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
};

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;
	int num_sec;
	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)

/* Virtual address signature */
#define PAGING_ADDR_SIG 0xAA000000

#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.
 * @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
 * @max_number_epno_networks: max number of epno entries.
 * @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
 *	specified.
 * @max_number_of_white_listed_ssid: max number of white listed SSIDs.
 * @max_number_of_black_listed_ssid: max number of black listed SSIDs.
 */
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;
	u32 max_hotlist_ssids;
	u32 max_number_epno_networks;
	u32 max_number_epno_networks_by_ssid;
	u32 max_number_of_white_listed_ssid;
	u32 max_number_of_black_listed_ssid;
};

/**
 * enum iwl_fw_type - iwlwifi firmware type
 * @IWL_FW_DVM: DVM firmware
 * @IWL_FW_MVM: MVM firmware
 */
enum iwl_fw_type {
	IWL_FW_DVM,
	IWL_FW_MVM,
};

/**
 * 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.
 * @type: firmware type (&enum iwl_fw_type)
 * @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;

	enum iwl_fw_type type;

	struct iwl_fw_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];
	struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv;
	size_t n_dbg_mem_tlv;
	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;
}

static inline const struct fw_img *
iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type)
{
	if (ucode_type >= IWL_UCODE_TYPE_MAX)
		return NULL;

	return &fw->img[ucode_type];
}

#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
5ed47226	10	* Copyright(c) 2016 Intel Deutschland GmbH
0692fe41 JB	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of version 2 of the GNU General Public License as
	14	* published by the Free Software Foundation.
	15	*
	16	* This program is distributed in the hope that it will be useful, but
	17	* WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
	24	* USA
	25	*
	26	* The full GNU General Public License is included in this distribution
410dc5aa	27	* in the file called COPYING.
0692fe41 JB	28	*
0692fe41 JB	29	* Contact Information:
d01c5366	30	* Intel Linux Wireless <linuxwifi@intel.com>
0692fe41 JB	31	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	32	*
	33	* BSD LICENSE
	34	*
51368bf7	35	* Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
859d914c	36	* Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
5ed47226	37	* Copyright(c) 2016 Intel Deutschland GmbH
0692fe41 JB	38	* All rights reserved.
	39	*
	40	* Redistribution and use in source and binary forms, with or without
	41	* modification, are permitted provided that the following conditions
	42	* are met:
	43	*
	44	* * Redistributions of source code must retain the above copyright
	45	* notice, this list of conditions and the following disclaimer.
	46	* * Redistributions in binary form must reproduce the above copyright
	47	* notice, this list of conditions and the following disclaimer in
	48	* the documentation and/or other materials provided with the
	49	* distribution.
	50	* * Neither the name Intel Corporation nor the names of its
	51	* contributors may be used to endorse or promote products derived
	52	* from this software without specific prior written permission.
	53	*
	54	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	55	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	56	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	57	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	58	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	59	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	60	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	61	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	62	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	63	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	64	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	65	*****************************************************************************/
	66
	67	#ifndef __iwl_fw_h__
	68	#define __iwl_fw_h__
	69	#include <linux/types.h>
	70
06ddbf5a	71	#include "iwl-fw-file.h"
d2709ad7	72	#include "iwl-fw-error-dump.h"
06ddbf5a	73
ed8c8365 DS	74	/**
	75	* enum iwl_ucode_type
	76	*
	77	* The type of ucode.
	78	*
	79	* @IWL_UCODE_REGULAR: Normal runtime ucode
	80	* @IWL_UCODE_INIT: Initial ucode
	81	* @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
61df750c	82	* @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
ed8c8365 DS	83	*/
	84	enum iwl_ucode_type {
	85	IWL_UCODE_REGULAR,
	86	IWL_UCODE_INIT,
	87	IWL_UCODE_WOWLAN,
61df750c	88	IWL_UCODE_REGULAR_USNIFFER,
ed8c8365 DS	89	IWL_UCODE_TYPE_MAX,
	90	};
	91
6dfa8d01 DS	92	/*
6dfa8d01 DS	93	* enumeration of ucode section.
0db53d00 JB	94	* This enumeration is used directly for older firmware (before 16.0).
	95	* For new firmware, there can be up to 4 sections (see below) but the
	96	* first one packaged into the firmware file is the DATA section and
	97	* some debugging code accesses that.
6dfa8d01 DS	98	*/
6dfa8d01 DS	99	enum iwl_ucode_sec {
6dfa8d01	100	IWL_UCODE_SECTION_DATA,
0db53d00	101	IWL_UCODE_SECTION_INST,
6dfa8d01	102	};
6dfa8d01	103
0692fe41 JB	104	struct iwl_ucode_capabilities {
0692fe41 JB	105	u32 max_probe_length;
762533ba	106	u32 n_scan_channels;
0692fe41 JB	107	u32 standard_phy_calibration_size;
0692fe41 JB	108	u32 flags;
d3f555f4 JB	109	unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
d3f555f4 JB	110	unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
0692fe41 JB	111	};
0692fe41 JB	112
859d914c JB	113	static inline bool
	114	fw_has_api(const struct iwl_ucode_capabilities *capabilities,
	115	iwl_ucode_tlv_api_t api)
	116	{
	117	return test_bit((__force long)api, capabilities->_api);
	118	}
	119
	120	static inline bool
	121	fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
	122	iwl_ucode_tlv_capa_t capa)
	123	{
	124	return test_bit((__force long)capa, capabilities->_capa);
	125	}
	126
0cedacc5	127	/* one for each uCode image (inst/data, init/runtime/wowlan) */
0692fe41	128	struct fw_desc {
83f84d7b	129	const void data; / vmalloc'ed data */
0692fe41	130	u32 len; /* size in bytes */
0cedacc5	131	u32 offset; /* offset in the device */
0692fe41 JB	132	};
	133
	134	struct fw_img {
eef187a7 SS	135	struct fw_desc *sec;
eef187a7 SS	136	int num_sec;
e2d6f4e7	137	bool is_dual_cpus;
a6c4fb44	138	u32 paging_mem_size;
0692fe41 JB	139	};
0692fe41 JB	140
91479b64 EH	141	struct iwl_sf_region {
	142	u32 addr;
	143	u32 size;
	144	};
	145
a6c4fb44 MG	146	/*
	147	* Block paging calculations
	148	*/
	149	#define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
	150	#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
	151	#define PAGE_PER_GROUP_2_EXP_SIZE 3
	152	/* 8 pages per group */
	153	#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
	154	/* don't change, support only 32KB size */
	155	#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
	156	/* 32K == 2^15 */
	157	#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)
	158
	159	/*
	160	* Image paging calculations
	161	*/
	162	#define BLOCK_PER_IMAGE_2_EXP_SIZE 5
	163	/* 2^5 == 32 blocks per image */
	164	#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
	165	/* maximum image size 1024KB */
	166	#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)
	167
e1120187 MG	168	/* Virtual address signature */
	169	#define PAGING_ADDR_SIG 0xAA000000
	170
a6c4fb44 MG	171	#define PAGING_CMD_IS_SECURED BIT(9)
	172	#define PAGING_CMD_IS_ENABLED BIT(8)
	173	#define PAGING_CMD_NUM_OF_PAGES_IN_LAST_GRP_POS 0
	174	#define PAGING_TLV_SECURE_MASK 1
	175
	176	/**
	177	* struct iwl_fw_paging
	178	* @fw_paging_phys: page phy pointer
	179	* @fw_paging_block: pointer to the allocated block
	180	* @fw_paging_size: page size
	181	*/
	182	struct iwl_fw_paging {
	183	dma_addr_t fw_paging_phys;
	184	struct page *fw_paging_block;
	185	u32 fw_paging_size;
	186	};
	187
e36e5433 MS	188	/**
	189	* struct iwl_fw_cscheme_list - a cipher scheme list
	190	* @size: a number of entries
	191	* @cs: cipher scheme entries
	192	*/
	193	struct iwl_fw_cscheme_list {
	194	u8 size;
	195	struct iwl_fw_cipher_scheme cs[];
	196	} __packed;
	197
17564dde AS	198	/**
	199	* struct iwl_gscan_capabilities - gscan capabilities supported by FW
	200	* @max_scan_cache_size: total space allocated for scan results (in bytes).
	201	* @max_scan_buckets: maximum number of channel buckets.
	202	* @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
	203	* @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
	204	* @max_scan_reporting_threshold: max possible report threshold. in percentage.
	205	* @max_hotlist_aps: maximum number of entries for hotlist APs.
	206	* @max_significant_change_aps: maximum number of entries for significant
	207	* change APs.
	208	* @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
	209	* hold.
5ed47226 AB	210	* @max_hotlist_ssids: maximum number of entries for hotlist SSIDs.
	211	* @max_number_epno_networks: max number of epno entries.
	212	* @max_number_epno_networks_by_ssid: max number of epno entries if ssid is
	213	* specified.
	214	* @max_number_of_white_listed_ssid: max number of white listed SSIDs.
	215	* @max_number_of_black_listed_ssid: max number of black listed SSIDs.
17564dde AS	216	*/
	217	struct iwl_gscan_capabilities {
	218	u32 max_scan_cache_size;
	219	u32 max_scan_buckets;
	220	u32 max_ap_cache_per_scan;
	221	u32 max_rssi_sample_size;
	222	u32 max_scan_reporting_threshold;
	223	u32 max_hotlist_aps;
	224	u32 max_significant_change_aps;
	225	u32 max_bssid_history_entries;
5ed47226 AB	226	u32 max_hotlist_ssids;
	227	u32 max_number_epno_networks;
	228	u32 max_number_epno_networks_by_ssid;
	229	u32 max_number_of_white_listed_ssid;
	230	u32 max_number_of_black_listed_ssid;
17564dde AS	231	};
17564dde AS	232
ca221c9b JB	233	/**
	234	* enum iwl_fw_type - iwlwifi firmware type
	235	* @IWL_FW_DVM: DVM firmware
	236	* @IWL_FW_MVM: MVM firmware
	237	*/
	238	enum iwl_fw_type {
	239	IWL_FW_DVM,
	240	IWL_FW_MVM,
	241	};
	242
0692fe41 JB	243	/**
	244	* struct iwl_fw - variables associated with the firmware
	245	*
	246	* @ucode_ver: ucode version from the ucode file
	247	* @fw_version: firmware version string
6dfa8d01	248	* @img: ucode image like ucode_rt, ucode_init, ucode_wowlan.
0692fe41 JB	249	* @ucode_capa: capabilities parsed from the ucode file.
	250	* @enhance_sensitivity_table: device can do enhanced sensitivity.
	251	* @init_evtlog_ptr: event log offset for init ucode.
	252	* @init_evtlog_size: event log size for init ucode.
	253	* @init_errlog_ptr: error log offfset for init ucode.
	254	* @inst_evtlog_ptr: event log offset for runtime ucode.
	255	* @inst_evtlog_size: event log size for runtime ucode.
	256	* @inst_errlog_ptr: error log offfset for runtime ucode.
ca221c9b	257	* @type: firmware type (&enum iwl_fw_type)
e36e5433	258	* @cipher_scheme: optional external cipher scheme.
a52703b2	259	* @human_readable: human readable version
b4821767 LK	260	* @sdio_adma_addr: the default address to set for the ADMA in SDIO mode until
b4821767 LK	261	* we get the ALIVE from the uCode
490fefeb LK	262	* @dbg_dest_tlv: points to the destination TLV for debug
	263	* @dbg_conf_tlv: array of pointers to configuration TLVs for debug
	264	* @dbg_conf_tlv_len: lengths of the @dbg_conf_tlv entries
d2709ad7 EG	265	* @dbg_trigger_tlv: array of pointers to triggers TLVs
d2709ad7 EG	266	* @dbg_trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
490fefeb	267	* @dbg_dest_reg_num: num of reg_ops in %dbg_dest_tlv
0692fe41 JB	268	*/
	269	struct iwl_fw {
	270	u32 ucode_ver;
	271
81135548	272	char fw_version[ETHTOOL_FWVERS_LEN];
0692fe41 JB	273
0692fe41 JB	274	/* ucode images */
6dfa8d01	275	struct fw_img img[IWL_UCODE_TYPE_MAX];
0692fe41 JB	276
	277	struct iwl_ucode_capabilities ucode_capa;
	278	bool enhance_sensitivity_table;
	279
	280	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
	281	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
ed8c8365	282
aa2b1770	283	struct iwl_tlv_calib_ctrl default_calib[IWL_UCODE_TYPE_MAX];
ed8c8365	284	u32 phy_config;
77db0a3c EH	285	u8 valid_tx_ant;
77db0a3c EH	286	u8 valid_rx_ant;
4db2c9ae	287
ca221c9b	288	enum iwl_fw_type type;
e36e5433	289
24ddddf3	290	struct iwl_fw_cipher_scheme cs[IWL_UCODE_MAX_CS];
06ddbf5a	291	u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
490fefeb	292
b4821767 LK	293	u32 sdio_adma_addr;
b4821767 LK	294
490fefeb	295	struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
d2709ad7 EG	296	struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
	297	size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
	298	struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
2ed1e019 JB	299	struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv;
2ed1e019 JB	300	size_t n_dbg_mem_tlv;
d2709ad7	301	size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
490fefeb	302	u8 dbg_dest_reg_num;
17564dde	303	struct iwl_gscan_capabilities gscan_capa;
0692fe41 JB	304	};
0692fe41 JB	305
490fefeb LK	306	static inline const char *get_fw_dbg_mode_string(int mode)
	307	{
	308	switch (mode) {
	309	case SMEM_MODE:
	310	return "SMEM";
	311	case EXTERNAL_MODE:
	312	return "EXTERNAL_DRAM";
	313	case MARBH_MODE:
	314	return "MARBH";
6a8ac59c LK	315	case MIPI_MODE:
6a8ac59c LK	316	return "MIPI";
490fefeb LK	317	default:
	318	return "UNKNOWN";
	319	}
	320	}
	321
d2709ad7 EG	322	static inline bool
d2709ad7 EG	323	iwl_fw_dbg_conf_usniffer(const struct iwl_fw *fw, u8 id)
490fefeb LK	324	{
490fefeb LK	325	const struct iwl_fw_dbg_conf_tlv *conf_tlv = fw->dbg_conf_tlv[id];
490fefeb LK	326
490fefeb LK	327	if (!conf_tlv)
490fefeb LK	328	return false;
490fefeb LK	329
d2709ad7	330	return conf_tlv->usniffer;
490fefeb LK	331	}
490fefeb LK	332
612da1ef SD	333	static inline const struct fw_img *
	334	iwl_get_ucode_image(const struct iwl_fw *fw, enum iwl_ucode_type ucode_type)
	335	{
	336	if (ucode_type >= IWL_UCODE_TYPE_MAX)
	337	return NULL;
	338
	339	return &fw->img[ucode_type];
	340	}
	341
0692fe41	342	#endif /* __iwl_fw_h__ */