drivers/net/wireless/iwlwifi/iwl-fw.h - maze/linux - Git at Google

 /******************************************************************************
  *
  * 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 - 2013 Intel Corporation. All rights reserved.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of version 2 of the GNU General Public License as
  * published by the Free Software Foundation.
  *
  * This program is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  * USA
  *
  * The full GNU General Public License is included in this distribution
  * in the file called LICENSE.GPL.
  *
  * 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 - 2013 Intel Corporation. All rights reserved.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  *  * Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *  * Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *  * Neither the name Intel Corporation nor the names of its
  *    contributors may be used to endorse or promote products derived
  *    from this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *****************************************************************************/

 #ifndef __iwl_fw_h__
 #define __iwl_fw_h__
 #include <linux/types.h>
 #include <net/mac80211.h>

 /**
  * enum iwl_ucode_tlv_flag - ucode API flags
  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
  *	was a separate TLV but moved here to save space.
  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
  *	treats good CRC threshold as a boolean
  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
  * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
  */
 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),
 };

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

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

 /*
  * enumeration of ucode section.
  * This enumeration is used for legacy tlv style (before 16.0 uCode).
  */
 enum iwl_ucode_sec {
 	IWL_UCODE_SECTION_INST,
 	IWL_UCODE_SECTION_DATA,
 };
 /*
  * For 16.0 uCode and above, there is no differentiation between sections,
  * just an offset to the HW address.
  */
 #define IWL_UCODE_SECTION_MAX 4

 struct iwl_ucode_capabilities {
 	u32 max_probe_length;
 	u32 standard_phy_calibration_size;
 	u32 flags;
 };

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

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

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

 	bool mvm_fw;
 };

 #endif  /* __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 - 2013 Intel Corporation. All rights reserved.
	*
	* This program is free software; you can redistribute it and/or modify
	* it under the terms of version 2 of the GNU General Public License as
	* published by the Free Software Foundation.
	*
	* This program is distributed in the hope that it will be useful, but
	* WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with this program; if not, write to the Free Software
	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
	* USA
	*
	* The full GNU General Public License is included in this distribution
	* in the file called LICENSE.GPL.
	*
	* 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 - 2013 Intel Corporation. All rights reserved.
	* All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* * Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* * Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	* * Neither the name Intel Corporation nor the names of its
	* contributors may be used to endorse or promote products derived
	* from this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*****************************************************************************/

	#ifndef __iwl_fw_h__
	#define __iwl_fw_h__
	#include <linux/types.h>
	#include <net/mac80211.h>

	/**
	* enum iwl_ucode_tlv_flag - ucode API flags
	* @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
	* was a separate TLV but moved here to save space.
	* @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
	* treats good CRC threshold as a boolean
	* @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
	* @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
	*/
	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),
	};

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

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

	/*
	* enumeration of ucode section.
	* This enumeration is used for legacy tlv style (before 16.0 uCode).
	*/
	enum iwl_ucode_sec {
	IWL_UCODE_SECTION_INST,
	IWL_UCODE_SECTION_DATA,
	};
	/*
	* For 16.0 uCode and above, there is no differentiation between sections,
	* just an offset to the HW address.
	*/
	#define IWL_UCODE_SECTION_MAX 4

	struct iwl_ucode_capabilities {
	u32 max_probe_length;
	u32 standard_phy_calibration_size;
	u32 flags;
	};

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

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

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

	bool mvm_fw;
	};

	#endif /* __iwl_fw_h__ */