/******************************************************************************
   *
   * 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) 2007 - 2014 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 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.
   * 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_CONFIG_H__
  #define __IWL_CONFIG_H__
  
  #include <linux/types.h>
  #include <net/mac80211.h>
  
  
  enum iwl_device_family {
  	IWL_DEVICE_FAMILY_UNDEFINED,
  	IWL_DEVICE_FAMILY_1000,
  	IWL_DEVICE_FAMILY_100,
  	IWL_DEVICE_FAMILY_2000,
  	IWL_DEVICE_FAMILY_2030,
  	IWL_DEVICE_FAMILY_105,
  	IWL_DEVICE_FAMILY_135,
  	IWL_DEVICE_FAMILY_5000,
  	IWL_DEVICE_FAMILY_5150,
  	IWL_DEVICE_FAMILY_6000,
  	IWL_DEVICE_FAMILY_6000i,
  	IWL_DEVICE_FAMILY_6005,
  	IWL_DEVICE_FAMILY_6030,
  	IWL_DEVICE_FAMILY_6050,
  	IWL_DEVICE_FAMILY_6150,
  	IWL_DEVICE_FAMILY_7000,
  	IWL_DEVICE_FAMILY_8000,
  };
  
  static inline bool iwl_has_secure_boot(u32 hw_rev,
  				       enum iwl_device_family family)
  {
  	/* return 1 only for family 8000 B0 */
  	if ((family == IWL_DEVICE_FAMILY_8000) && (hw_rev & 0xC))
  		return true;
  
  	return false;
  }
  
  /*
   * LED mode
   *    IWL_LED_DEFAULT:  use device default
   *    IWL_LED_RF_STATE: turn LED on/off based on RF state
   *			LED ON  = RF ON
   *			LED OFF = RF OFF
   *    IWL_LED_BLINK:    adjust led blink rate based on blink table
   *    IWL_LED_DISABLE:	led disabled
   */
  enum iwl_led_mode {
  	IWL_LED_DEFAULT,
  	IWL_LED_RF_STATE,
  	IWL_LED_BLINK,
  	IWL_LED_DISABLE,
  };
  
  /*
   * This is the threshold value of plcp error rate per 100mSecs.  It is
   * used to set and check for the validity of plcp_delta.
   */
  #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN		1
  #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF		50
  #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF	100
  #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF	200
  #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX		255
  #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE	0
  
  /* TX queue watchdog timeouts in mSecs */
  #define IWL_WATCHDOG_DISABLED	0
  #define IWL_DEF_WD_TIMEOUT	2500
  #define IWL_LONG_WD_TIMEOUT	10000
  #define IWL_MAX_WD_TIMEOUT	120000
  
  #define IWL_DEFAULT_MAX_TX_POWER 22
  
  /* Antenna presence definitions */
  #define	ANT_NONE	0x0
  #define	ANT_A		BIT(0)
  #define	ANT_B		BIT(1)
  #define ANT_C		BIT(2)
  #define	ANT_AB		(ANT_A | ANT_B)
  #define	ANT_AC		(ANT_A | ANT_C)
  #define ANT_BC		(ANT_B | ANT_C)
  #define ANT_ABC		(ANT_A | ANT_B | ANT_C)
  
  static inline u8 num_of_ant(u8 mask)
  {
  	return  !!((mask) & ANT_A) +
  		!!((mask) & ANT_B) +
  		!!((mask) & ANT_C);
  }
  
  /*
   * @max_ll_items: max number of OTP blocks
   * @shadow_ram_support: shadow support for OTP memory
   * @led_compensation: compensate on the led on/off time per HW according
   *	to the deviation to achieve the desired led frequency.
   *	The detail algorithm is described in iwl-led.c
   * @wd_timeout: TX queues watchdog timeout
   * @max_event_log_size: size of event log buffer size for ucode event logging
   * @shadow_reg_enable: HW shadow register support
   * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
   *	is in flight. This is due to a HW bug in 7260, 3160 and 7265.
   * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
   */
  struct iwl_base_params {
  	int eeprom_size;
  	int num_of_queues;	/* def: HW dependent */
  	/* for iwl_pcie_apm_init() */
  	u32 pll_cfg_val;
  
  	const u16 max_ll_items;
  	const bool shadow_ram_support;
  	u16 led_compensation;
  	unsigned int wd_timeout;
  	u32 max_event_log_size;
  	const bool shadow_reg_enable;
  	const bool pcie_l1_allowed;
  	const bool apmg_wake_up_wa;
  	const bool scd_chain_ext_wa;
  };
  
  /*
   * @stbc: support Tx STBC and 1*SS Rx STBC
   * @ldpc: support Tx/Rx with LDPC
   * @use_rts_for_aggregation: use rts/cts protection for HT traffic
   * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
   */
  struct iwl_ht_params {
  	enum ieee80211_smps_mode smps_mode;
  	const bool ht_greenfield_support; /* if used set to true */
  	const bool stbc;
  	const bool ldpc;
  	bool use_rts_for_aggregation;
  	u8 ht40_bands;
  };
  
  /*
   * Tx-backoff threshold
   * @temperature: The threshold in Celsius
   * @backoff: The tx-backoff in uSec
   */
  struct iwl_tt_tx_backoff {
  	s32 temperature;
  	u32 backoff;
  };
  
  #define TT_TX_BACKOFF_SIZE 6
  
  /**
   * struct iwl_tt_params - thermal throttling parameters
   * @ct_kill_entry: CT Kill entry threshold
   * @ct_kill_exit: CT Kill exit threshold
   * @ct_kill_duration: The time  intervals (in uSec) in which the driver needs
   *	to checks whether to exit CT Kill.
   * @dynamic_smps_entry: Dynamic SMPS entry threshold
   * @dynamic_smps_exit: Dynamic SMPS exit threshold
   * @tx_protection_entry: TX protection entry threshold
   * @tx_protection_exit: TX protection exit threshold
   * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
   * @support_ct_kill: Support CT Kill?
   * @support_dynamic_smps: Support dynamic SMPS?
   * @support_tx_protection: Support tx protection?
   * @support_tx_backoff: Support tx-backoff?
   */
  struct iwl_tt_params {
  	u32 ct_kill_entry;
  	u32 ct_kill_exit;
  	u32 ct_kill_duration;
  	u32 dynamic_smps_entry;
  	u32 dynamic_smps_exit;
  	u32 tx_protection_entry;
  	u32 tx_protection_exit;
  	struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
  	bool support_ct_kill;
  	bool support_dynamic_smps;
  	bool support_tx_protection;
  	bool support_tx_backoff;
  };
  
  /*
   * information on how to parse the EEPROM
   */
  #define EEPROM_REG_BAND_1_CHANNELS		0x08
  #define EEPROM_REG_BAND_2_CHANNELS		0x26
  #define EEPROM_REG_BAND_3_CHANNELS		0x42
  #define EEPROM_REG_BAND_4_CHANNELS		0x5C
  #define EEPROM_REG_BAND_5_CHANNELS		0x74
  #define EEPROM_REG_BAND_24_HT40_CHANNELS	0x82
  #define EEPROM_REG_BAND_52_HT40_CHANNELS	0x92
  #define EEPROM_6000_REG_BAND_24_HT40_CHANNELS	0x80
  #define EEPROM_REGULATORY_BAND_NO_HT40		0
  
  /* lower blocks contain EEPROM image and calibration data */
  #define OTP_LOW_IMAGE_SIZE		(2 * 512 * sizeof(u16)) /* 2 KB */
  #define OTP_LOW_IMAGE_SIZE_FAMILY_7000	(16 * 512 * sizeof(u16)) /* 16 KB */
  #define OTP_LOW_IMAGE_SIZE_FAMILY_8000	(32 * 512 * sizeof(u16)) /* 32 KB */
  
  struct iwl_eeprom_params {
  	const u8 regulatory_bands[7];
  	bool enhanced_txpower;
  };
  
  /* Tx-backoff power threshold
   * @pwr: The power limit in mw
   * @backoff: The tx-backoff in uSec
   */
  struct iwl_pwr_tx_backoff {
  	u32 pwr;
  	u32 backoff;
  };
  
  /**
   * struct iwl_cfg
   * @name: Official name of the device
   * @fw_name_pre: Firmware filename prefix. The api version and extension
   *	(.ucode) will be added to filename before loading from disk. The
   *	filename is constructed as fw_name_pre<api>.ucode.
   * @ucode_api_max: Highest version of uCode API supported by driver.
   * @ucode_api_ok: oldest version of the uCode API that is OK to load
   *	without a warning, for use in transitions
   * @ucode_api_min: Lowest version of uCode API supported by driver.
   * @max_inst_size: The maximal length of the fw inst section
   * @max_data_size: The maximal length of the fw data section
   * @valid_tx_ant: valid transmit antenna
   * @valid_rx_ant: valid receive antenna
   * @non_shared_ant: the antenna that is for WiFi only
   * @nvm_ver: NVM version
   * @nvm_calib_ver: NVM calibration version
   * @lib: pointer to the lib ops
   * @base_params: pointer to basic parameters
   * @ht_params: point to ht parameters
   * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
   * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
   * @internal_wimax_coex: internal wifi/wimax combo device
   * @high_temp: Is this NIC is designated to be in high temperature.
   * @host_interrupt_operation_mode: device needs host interrupt operation
   *	mode set
   * @d0i3: device uses d0i3 instead of d3
   * @nvm_hw_section_num: the ID of the HW NVM section
   * @features: hw features, any combination of feature_whitelist
   * @pwr_tx_backoffs: translation table between power limits and backoffs
   * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
   * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
   * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
   *	station can receive in HT
   * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
   *	station can receive in VHT
   * @dccm_offset: offset from which DCCM begins
   * @dccm_len: length of DCCM (including runtime stack CCM)
   * @dccm2_offset: offset from which the second DCCM begins
   * @dccm2_len: length of the second DCCM
   * @smem_offset: offset from which the SMEM begins
   * @smem_len: the length of SMEM
   *
   * We enable the driver to be backward compatible wrt. hardware features.
   * API differences in uCode shouldn't be handled here but through TLVs
   * and/or the uCode API version instead.
   */
  struct iwl_cfg {
  	/* params specific to an individual device within a device family */
  	const char *name;
  	const char *fw_name_pre;
  	const unsigned int ucode_api_max;
  	const unsigned int ucode_api_ok;
  	const unsigned int ucode_api_min;
  	const enum iwl_device_family device_family;
  	const u32 max_data_size;
  	const u32 max_inst_size;
  	u8   valid_tx_ant;
  	u8   valid_rx_ant;
  	u8   non_shared_ant;
  	bool bt_shared_single_ant;
  	u16  nvm_ver;
  	u16  nvm_calib_ver;
  	/* params not likely to change within a device family */
  	const struct iwl_base_params *base_params;
  	/* params likely to change within a device family */
  	const struct iwl_ht_params *ht_params;
  	const struct iwl_eeprom_params *eeprom_params;
  	enum iwl_led_mode led_mode;
  	const bool rx_with_siso_diversity;
  	const bool internal_wimax_coex;
  	const bool host_interrupt_operation_mode;
  	bool high_temp;
  	bool d0i3;
  	u8   nvm_hw_section_num;
  	bool lp_xtal_workaround;
  	const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
  	bool no_power_up_nic_in_init;
  	const char *default_nvm_file_B_step;
  	const char *default_nvm_file_C_step;
  	netdev_features_t features;
  	unsigned int max_rx_agg_size;
  	bool disable_dummy_notification;
  	unsigned int max_tx_agg_size;
  	unsigned int max_ht_ampdu_exponent;
  	unsigned int max_vht_ampdu_exponent;
  	const u32 dccm_offset;
  	const u32 dccm_len;
  	const u32 dccm2_offset;
  	const u32 dccm2_len;
  	const u32 smem_offset;
  	const u32 smem_len;
  	const struct iwl_tt_params *thermal_params;
  	bool apmg_not_supported;
  };
  
  /*
   * This list declares the config structures for all devices.
   */
  #if IS_ENABLED(CONFIG_IWLDVM)
  extern const struct iwl_cfg iwl5300_agn_cfg;
  extern const struct iwl_cfg iwl5100_agn_cfg;
  extern const struct iwl_cfg iwl5350_agn_cfg;
  extern const struct iwl_cfg iwl5100_bgn_cfg;
  extern const struct iwl_cfg iwl5100_abg_cfg;
  extern const struct iwl_cfg iwl5150_agn_cfg;
  extern const struct iwl_cfg iwl5150_abg_cfg;
  extern const struct iwl_cfg iwl6005_2agn_cfg;
  extern const struct iwl_cfg iwl6005_2abg_cfg;
  extern const struct iwl_cfg iwl6005_2bg_cfg;
  extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
  extern const struct iwl_cfg iwl6005_2agn_d_cfg;
  extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
  extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
  extern const struct iwl_cfg iwl1030_bgn_cfg;
  extern const struct iwl_cfg iwl1030_bg_cfg;
  extern const struct iwl_cfg iwl6030_2agn_cfg;
  extern const struct iwl_cfg iwl6030_2abg_cfg;
  extern const struct iwl_cfg iwl6030_2bgn_cfg;
  extern const struct iwl_cfg iwl6030_2bg_cfg;
  extern const struct iwl_cfg iwl6000i_2agn_cfg;
  extern const struct iwl_cfg iwl6000i_2abg_cfg;
  extern const struct iwl_cfg iwl6000i_2bg_cfg;
  extern const struct iwl_cfg iwl6000_3agn_cfg;
  extern const struct iwl_cfg iwl6050_2agn_cfg;
  extern const struct iwl_cfg iwl6050_2abg_cfg;
  extern const struct iwl_cfg iwl6150_bgn_cfg;
  extern const struct iwl_cfg iwl6150_bg_cfg;
  extern const struct iwl_cfg iwl1000_bgn_cfg;
  extern const struct iwl_cfg iwl1000_bg_cfg;
  extern const struct iwl_cfg iwl100_bgn_cfg;
  extern const struct iwl_cfg iwl100_bg_cfg;
  extern const struct iwl_cfg iwl130_bgn_cfg;
  extern const struct iwl_cfg iwl130_bg_cfg;
  extern const struct iwl_cfg iwl2000_2bgn_cfg;
  extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
  extern const struct iwl_cfg iwl2030_2bgn_cfg;
  extern const struct iwl_cfg iwl6035_2agn_cfg;
  extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
  extern const struct iwl_cfg iwl105_bgn_cfg;
  extern const struct iwl_cfg iwl105_bgn_d_cfg;
  extern const struct iwl_cfg iwl135_bgn_cfg;
  #endif /* CONFIG_IWLDVM */
  #if IS_ENABLED(CONFIG_IWLMVM)
  extern const struct iwl_cfg iwl7260_2ac_cfg;
  extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
  extern const struct iwl_cfg iwl7260_2n_cfg;
  extern const struct iwl_cfg iwl7260_n_cfg;
  extern const struct iwl_cfg iwl3160_2ac_cfg;
  extern const struct iwl_cfg iwl3160_2n_cfg;
  extern const struct iwl_cfg iwl3160_n_cfg;
  extern const struct iwl_cfg iwl3165_2ac_cfg;
  extern const struct iwl_cfg iwl7265_2ac_cfg;
  extern const struct iwl_cfg iwl7265_2n_cfg;
  extern const struct iwl_cfg iwl7265_n_cfg;
  extern const struct iwl_cfg iwl7265d_2ac_cfg;
  extern const struct iwl_cfg iwl7265d_2n_cfg;
  extern const struct iwl_cfg iwl7265d_n_cfg;
  extern const struct iwl_cfg iwl8260_2n_cfg;
  extern const struct iwl_cfg iwl8260_2ac_cfg;
  extern const struct iwl_cfg iwl4165_2ac_cfg;
  extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
  extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
  #endif /* CONFIG_IWLMVM */
  
  #endif /* __IWL_CONFIG_H__ */