drivers/net/wireless/intel/iwlwifi/fw/img.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
 /*
  * Copyright (C) 2005-2014, 2018-2021 Intel Corporation
  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
  * Copyright (C) 2016 Intel Deutschland GmbH
  */
 #ifndef __iwl_fw_img_h__
 #define __iwl_fw_img_h__
 #include <linux/types.h>

 #include "api/dbg-tlv.h"

 #include "file.h"
 #include "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;
 	u32 error_log_addr;
 	u32 error_log_size;
 	u32 num_stations;
 	unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
 	unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];

 	const struct iwl_fw_cmd_version *cmd_versions;
 	u32 n_cmd_versions;
 };

 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;
 };

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

 /* FW MSB Mask for regions/cache_control */
 #define FW_ADDR_CACHE_CONTROL 0xC0000000UL

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

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

 /**
  * 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_dbg - debug data
  *
  * @dest_tlv: points to debug destination TLV (typically SRAM or DRAM)
  * @n_dest_reg: num of reg_ops in dest_tlv
  * @conf_tlv: array of pointers to configuration HCMDs
  * @trigger_tlv: array of pointers to triggers TLVs
  * @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
  * @mem_tlv: Runtime addresses to dump
  * @n_mem_tlv: number of runtime addresses
  * @dump_mask: bitmask of dump regions
 */
 struct iwl_fw_dbg {
 	struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv;
 	u8 n_dest_reg;
 	struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX];
 	struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX];
 	size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX];
 	struct iwl_fw_dbg_mem_seg_tlv *mem_tlv;
 	size_t n_mem_tlv;
 	u32 dump_mask;
 };

 struct iwl_dump_exclude {
 	u32 addr, size;
 };

 /**
  * 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.
  * @iml_len: length of the image loader image
  * @iml: image loader fw image
  * @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
  *	we get the ALIVE from the uCode
  * @phy_integration_ver: PHY integration version string
  * @phy_integration_ver_len: length of @phy_integration_ver
  * @dump_excl: image dump exclusion areas for RT image
  * @dump_excl_wowlan: image dump exclusion areas for WoWLAN image
  */
 struct iwl_fw {
 	u32 ucode_ver;

 	char fw_version[64];

 	/* ucode images */
 	struct fw_img img[IWL_UCODE_TYPE_MAX];
 	size_t iml_len;
 	u8 *iml;

 	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];

 	struct iwl_fw_dbg dbg;

 	u8 *phy_integration_ver;
 	u32 phy_integration_ver_len;

 	struct iwl_dump_exclude dump_excl[2], dump_excl_wowlan[2];
 };

 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];
 }

 u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);

 u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
 const char *iwl_fw_lookup_assert_desc(u32 num);
 #endif  /* __iwl_fw_img_h__ */
	/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
	/*
	* Copyright (C) 2005-2014, 2018-2021 Intel Corporation
	* Copyright (C) 2013-2015 Intel Mobile Communications GmbH
	* Copyright (C) 2016 Intel Deutschland GmbH
	*/
	#ifndef __iwl_fw_img_h__
	#define __iwl_fw_img_h__
	#include <linux/types.h>

	#include "api/dbg-tlv.h"

	#include "file.h"
	#include "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;
	u32 error_log_addr;
	u32 error_log_size;
	u32 num_stations;
	unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
	unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];

	const struct iwl_fw_cmd_version *cmd_versions;
	u32 n_cmd_versions;
	};

	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;
	};

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

	/* FW MSB Mask for regions/cache_control */
	#define FW_ADDR_CACHE_CONTROL 0xC0000000UL

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

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

	/**
	* 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_dbg - debug data
	*
	* @dest_tlv: points to debug destination TLV (typically SRAM or DRAM)
	* @n_dest_reg: num of reg_ops in dest_tlv
	* @conf_tlv: array of pointers to configuration HCMDs
	* @trigger_tlv: array of pointers to triggers TLVs
	* @trigger_tlv_len: lengths of the @dbg_trigger_tlv entries
	* @mem_tlv: Runtime addresses to dump
	* @n_mem_tlv: number of runtime addresses
	* @dump_mask: bitmask of dump regions
	*/
	struct iwl_fw_dbg {
	struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv;
	u8 n_dest_reg;
	struct iwl_fw_dbg_conf_tlv *conf_tlv[FW_DBG_CONF_MAX];
	struct iwl_fw_dbg_trigger_tlv *trigger_tlv[FW_DBG_TRIGGER_MAX];
	size_t trigger_tlv_len[FW_DBG_TRIGGER_MAX];
	struct iwl_fw_dbg_mem_seg_tlv *mem_tlv;
	size_t n_mem_tlv;
	u32 dump_mask;
	};

	struct iwl_dump_exclude {
	u32 addr, size;
	};

	/**
	* 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.
	* @iml_len: length of the image loader image
	* @iml: image loader fw image
	* @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
	* we get the ALIVE from the uCode
	* @phy_integration_ver: PHY integration version string
	* @phy_integration_ver_len: length of @phy_integration_ver
	* @dump_excl: image dump exclusion areas for RT image
	* @dump_excl_wowlan: image dump exclusion areas for WoWLAN image
	*/
	struct iwl_fw {
	u32 ucode_ver;

	char fw_version[64];

	/* ucode images */
	struct fw_img img[IWL_UCODE_TYPE_MAX];
	size_t iml_len;
	u8 *iml;

	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];

	struct iwl_fw_dbg dbg;

	u8 *phy_integration_ver;
	u32 phy_integration_ver_len;

	struct iwl_dump_exclude dump_excl[2], dump_excl_wowlan[2];
	};

	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];
	}

	u8 iwl_fw_lookup_cmd_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);

	u8 iwl_fw_lookup_notif_ver(const struct iwl_fw *fw, u8 grp, u8 cmd, u8 def);
	const char *iwl_fw_lookup_assert_desc(u32 num);
	#endif /* __iwl_fw_img_h__ */