/******************************************************************************
 *
 * Copyright(c) 2007 - 2012 Realtek 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.
 *
 ******************************************************************************/
#ifndef __HAL_INTF_H__
#define __HAL_INTF_H__

#include <osdep_service.h>
#include <drv_types.h>

enum RTL871X_HCI_TYPE {
	RTW_PCIE	= BIT0,
	RTW_USB		= BIT1,
	RTW_SDIO	= BIT2,
	RTW_GSPI	= BIT3,
};

enum _CHIP_TYPE {
	NULL_CHIP_TYPE,
	RTL8712_8188S_8191S_8192S,
	RTL8188C_8192C,
	RTL8192D,
	RTL8723A,
	RTL8188E,
	MAX_CHIP_TYPE
};

enum HW_VARIABLES {
	HW_VAR_MEDIA_STATUS,
	HW_VAR_MEDIA_STATUS1,
	HW_VAR_SET_OPMODE,
	HW_VAR_MAC_ADDR,
	HW_VAR_BSSID,
	HW_VAR_INIT_RTS_RATE,
	HW_VAR_BASIC_RATE,
	HW_VAR_TXPAUSE,
	HW_VAR_BCN_FUNC,
	HW_VAR_CORRECT_TSF,
	HW_VAR_CHECK_BSSID,
	HW_VAR_MLME_DISCONNECT,
	HW_VAR_MLME_SITESURVEY,
	HW_VAR_MLME_JOIN,
	HW_VAR_ON_RCR_AM,
	HW_VAR_OFF_RCR_AM,
	HW_VAR_BEACON_INTERVAL,
	HW_VAR_SLOT_TIME,
	HW_VAR_RESP_SIFS,
	HW_VAR_ACK_PREAMBLE,
	HW_VAR_SEC_CFG,
	HW_VAR_BCN_VALID,
	HW_VAR_RF_TYPE,
	HW_VAR_DM_FLAG,
	HW_VAR_DM_FUNC_OP,
	HW_VAR_DM_FUNC_SET,
	HW_VAR_DM_FUNC_CLR,
	HW_VAR_CAM_EMPTY_ENTRY,
	HW_VAR_CAM_INVALID_ALL,
	HW_VAR_CAM_WRITE,
	HW_VAR_CAM_READ,
	HW_VAR_AC_PARAM_VO,
	HW_VAR_AC_PARAM_VI,
	HW_VAR_AC_PARAM_BE,
	HW_VAR_AC_PARAM_BK,
	HW_VAR_ACM_CTRL,
	HW_VAR_AMPDU_MIN_SPACE,
	HW_VAR_AMPDU_FACTOR,
	HW_VAR_RXDMA_AGG_PG_TH,
	HW_VAR_SET_RPWM,
	HW_VAR_H2C_FW_PWRMODE,
	HW_VAR_H2C_FW_JOINBSSRPT,
	HW_VAR_FWLPS_RF_ON,
	HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
	HW_VAR_TDLS_WRCR,
	HW_VAR_TDLS_INIT_CH_SEN,
	HW_VAR_TDLS_RS_RCR,
	HW_VAR_TDLS_DONE_CH_SEN,
	HW_VAR_INITIAL_GAIN,
	HW_VAR_TRIGGER_GPIO_0,
	HW_VAR_BT_SET_COEXIST,
	HW_VAR_BT_ISSUE_DELBA,
	HW_VAR_CURRENT_ANTENNA,
	HW_VAR_ANTENNA_DIVERSITY_LINK,
	HW_VAR_ANTENNA_DIVERSITY_SELECT,
	HW_VAR_SWITCH_EPHY_WoWLAN,
	HW_VAR_EFUSE_BYTES,
	HW_VAR_EFUSE_BT_BYTES,
	HW_VAR_FIFO_CLEARN_UP,
	HW_VAR_CHECK_TXBUF,
	HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, power control for MAC only */
	/*  The valid upper nav range for the HW updating, if the true value is larger than the upper range, the HW won't update it. */
	/*  Unit in microsecond. 0 means disable this function. */
	HW_VAR_NAV_UPPER,
	HW_VAR_RPT_TIMER_SETTING,
	HW_VAR_TX_RPT_MAX_MACID,
	HW_VAR_H2C_MEDIA_STATUS_RPT,
	HW_VAR_CHK_HI_QUEUE_EMPTY,
	HW_VAR_READ_LLT_TAB,
};

enum hal_def_variable {
	HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
	HAL_DEF_IS_SUPPORT_ANT_DIV,
	HAL_DEF_CURRENT_ANTENNA,
	HAL_DEF_DRVINFO_SZ,
	HAL_DEF_MAX_RECVBUF_SZ,
	HAL_DEF_RX_PACKET_OFFSET,
	HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
	HAL_DEF_DBG_DM_FUNC,/* for dbg */
	HAL_DEF_RA_DECISION_RATE,
	HAL_DEF_RA_SGI,
	HAL_DEF_PT_PWR_STATUS,
	HW_VAR_MAX_RX_AMPDU_FACTOR,
	HW_DEF_RA_INFO_DUMP,
	HAL_DEF_DBG_DUMP_TXPKT,
	HW_DEF_FA_CNT_DUMP,
	HW_DEF_ODM_DBG_FLAG,
};

enum hal_odm_variable {
	HAL_ODM_STA_INFO,
	HAL_ODM_P2P_STATE,
	HAL_ODM_WIFI_DISPLAY_STATE,
};

enum hal_intf_ps_func {
	HAL_USB_SELECT_SUSPEND,
	HAL_MAX_ID,
};

struct hal_ops {
	u32 (*hal_power_on)(struct rtw_adapter *padapter);
	u32 (*hal_init)(struct rtw_adapter *padapter);
	u32 (*hal_deinit)(struct rtw_adapter *padapter);

	void (*free_hal_data)(struct rtw_adapter *padapter);

	u32 (*inirp_init)(struct rtw_adapter *padapter);
	u32 (*inirp_deinit)(struct rtw_adapter *padapter);

	s32 (*init_xmit_priv)(struct rtw_adapter *padapter);
	void (*free_xmit_priv)(struct rtw_adapter *padapter);

	s32 (*init_recv_priv)(struct rtw_adapter *padapter);
	void (*free_recv_priv)(struct rtw_adapter *padapter);

	void (*InitSwLeds)(struct rtw_adapter *padapter);
	void (*DeInitSwLeds)(struct rtw_adapter *padapter);

	void (*dm_init)(struct rtw_adapter *padapter);
	void (*dm_deinit)(struct rtw_adapter *padapter);
	void (*read_chip_version)(struct rtw_adapter *padapter);

	void (*init_default_value)(struct rtw_adapter *padapter);

	void (*intf_chip_configure)(struct rtw_adapter *padapter);

	void (*read_adapter_info)(struct rtw_adapter *padapter);

	void (*enable_interrupt)(struct rtw_adapter *padapter);
	void (*disable_interrupt)(struct rtw_adapter *padapter);
	s32 (*interrupt_handler)(struct rtw_adapter *padapter);
	void (*set_bwmode_handler)(struct rtw_adapter *padapter,
				   enum ht_channel_width Bandwidth, u8 Offset);
	void (*set_channel_handler)(struct rtw_adapter *padapter, u8 channel);

	void (*hal_dm_watchdog)(struct rtw_adapter *padapter);

	void (*SetHwRegHandler)(struct rtw_adapter *padapter,
				u8 variable, u8 *val);
	void (*GetHwRegHandler)(struct rtw_adapter *padapter,
				u8 variable, u8 *val);

	u8 (*GetHalDefVarHandler)(struct rtw_adapter *padapter,
				  enum hal_def_variable eVariable,
				  void *pValue);
	u8 (*SetHalDefVarHandler)(struct rtw_adapter *padapter,
				  enum hal_def_variable eVariable,
				  void *pValue);

	void (*GetHalODMVarHandler)(struct rtw_adapter *padapter,
				    enum hal_odm_variable eVariable,
				    void *pValue1, bool bSet);
	void (*SetHalODMVarHandler)(struct rtw_adapter *padapter,
				    enum hal_odm_variable eVariable,
				    void *pValue1, bool bSet);

	void (*UpdateRAMaskHandler)(struct rtw_adapter *padapter,
				    u32 mac_id, u8 rssi_level);
	void (*SetBeaconRelatedRegistersHandler)(struct rtw_adapter *padapter);

	void (*Add_RateATid)(struct rtw_adapter *padapter, u32 bitmap,
			     u8 arg, u8 rssi_level);
	void (*run_thread)(struct rtw_adapter *padapter);
	void (*cancel_thread)(struct rtw_adapter *padapter);

	u8 (*interface_ps_func)(struct rtw_adapter *padapter,
				enum hal_intf_ps_func efunc_id, u8 *val);

	s32 (*hal_xmit)(struct rtw_adapter *padapter,
			struct xmit_frame *pxmitframe);
	s32 (*mgnt_xmit)(struct rtw_adapter *padapter,
			 struct xmit_frame *pmgntframe);
	s32 (*hal_xmitframe_enqueue)(struct rtw_adapter *padapter,
				     struct xmit_frame *pxmitframe);

	u32 (*read_bbreg)(struct rtw_adapter *padapter, u32 RegAddr,
			  u32 BitMask);
	void (*write_bbreg)(struct rtw_adapter *padapter, u32 RegAddr,
			    u32 BitMask, u32 Data);
	u32 (*read_rfreg)(struct rtw_adapter *padapter, u32 eRFPath,
			  u32 RegAddr, u32 BitMask);
	void (*write_rfreg)(struct rtw_adapter *padapter, u32 eRFPath,
			    u32 RegAddr, u32 BitMask, u32 Data);

	void (*EfusePowerSwitch)(struct rtw_adapter *padapter, u8 bWrite,
				 u8 PwrState);
	void (*ReadEFuse)(struct rtw_adapter *padapter, u8 efuseType,
			  u16 _offset, u16 _size_byte, u8 *pbuf);
	void (*EFUSEGetEfuseDefinition)(struct rtw_adapter *padapter,
					u8 efuseType, u8 type, void *pOut);
	u16 (*EfuseGetCurrentSize)(struct rtw_adapter *padapter, u8 efuseType);
	int (*Efuse_PgPacketRead23a)(struct rtw_adapter *padapter,
				     u8 offset, u8 *data);
	int (*Efuse_PgPacketWrite23a)(struct rtw_adapter *padapter,
				      u8 offset, u8 word_en, u8 *data);
	u8 (*Efuse_WordEnableDataWrite23a)(struct rtw_adapter *padapter,
					   u16 efuse_addr, u8 word_en,
					   u8 *data);
	bool (*Efuse_PgPacketWrite23a_BT)(struct rtw_adapter *padapter,
					  u8 offset, u8 word_en, u8 *data);

	void (*sreset_init_value23a)(struct rtw_adapter *padapter);
	void (*sreset_reset_value23a)(struct rtw_adapter *padapter);
	void (*silentreset)(struct rtw_adapter *padapter);
	void (*sreset_xmit_status_check)(struct rtw_adapter *padapter);
	void (*sreset_linked_status_check) (struct rtw_adapter *padapter);
	u8 (*sreset_get_wifi_status23a)(struct rtw_adapter *padapter);
	bool (*sreset_inprogress)(struct rtw_adapter *padapter);

	void (*hal_notch_filter)(struct rtw_adapter *adapter, bool enable);
	void (*hal_reset_security_engine)(struct rtw_adapter *adapter);
	s32 (*c2h_handler)(struct rtw_adapter *padapter, struct c2h_evt_hdr *c2h_evt);
	c2h_id_filter c2h_id_filter_ccx;
};

enum rt_eeprom_type {
	EEPROM_93C46,
	EEPROM_93C56,
	EEPROM_BOOT_EFUSE,
};


#define RF_CHANGE_BY_INIT	0
#define RF_CHANGE_BY_IPS	BIT28
#define RF_CHANGE_BY_PS		BIT29
#define RF_CHANGE_BY_HW		BIT30
#define RF_CHANGE_BY_SW		BIT31

enum hardware_type {
	HARDWARE_TYPE_RTL8180,
	HARDWARE_TYPE_RTL8185,
	HARDWARE_TYPE_RTL8187,
	HARDWARE_TYPE_RTL8188,
	HARDWARE_TYPE_RTL8190P,
	HARDWARE_TYPE_RTL8192E,
	HARDWARE_TYPE_RTL819xU,
	HARDWARE_TYPE_RTL8192SE,
	HARDWARE_TYPE_RTL8192SU,
	HARDWARE_TYPE_RTL8192CE,
	HARDWARE_TYPE_RTL8192CU,
	HARDWARE_TYPE_RTL8192DE,
	HARDWARE_TYPE_RTL8192DU,
	HARDWARE_TYPE_RTL8723AE,
	HARDWARE_TYPE_RTL8723AU,
	HARDWARE_TYPE_RTL8723AS,
	HARDWARE_TYPE_RTL8188EE,
	HARDWARE_TYPE_RTL8188EU,
	HARDWARE_TYPE_RTL8188ES,
	HARDWARE_TYPE_MAX,
};

#define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)
#define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)

extern int rtw_ht_enable23A;
extern int rtw_cbw40_enable23A;
extern int rtw_ampdu_enable23A;/* for enable tx_ampdu */

void rtw_hal_def_value_init23a(struct rtw_adapter *padapter);
int pm_netdev_open23a(struct net_device *pnetdev, u8 bnormal);
int rtw_resume_process23a(struct rtw_adapter *padapter);

void	rtw_hal_free_data23a(struct rtw_adapter *padapter);

void rtw_hal_dm_init23a(struct rtw_adapter *padapter);
void rtw_hal_dm_deinit23a(struct rtw_adapter *padapter);
void rtw_hal_sw_led_init23a(struct rtw_adapter *padapter);
void rtw_hal_sw_led_deinit23a(struct rtw_adapter *padapter);

u32 rtw_hal_power_on23a(struct rtw_adapter *padapter);
uint rtw_hal_init23a(struct rtw_adapter *padapter);
uint rtw_hal_deinit23a(struct rtw_adapter *padapter);
void rtw_hal_stop(struct rtw_adapter *padapter);
void rtw_hal_set_hwreg23a(struct rtw_adapter *padapter, u8 variable, u8 *val);
void rtw23a_hal_get_hwreg(struct rtw_adapter *padapter, u8 variable, u8 *val);

void rtw_hal_chip_configure23a(struct rtw_adapter *padapter);
void rtw_hal_read_chip_info23a(struct rtw_adapter *padapter);
void rtw_hal_read_chip_version23a(struct rtw_adapter *padapter);

u8 rtw_hal_set_def_var23a(struct rtw_adapter *padapter,
			  enum hal_def_variable eVariable,
			  void *pValue);
u8 rtw_hal_get_def_var23a(struct rtw_adapter *padapter,
			  enum hal_def_variable eVariable,
			  void *pValue);

void rtw_hal_set_odm_var23a(struct rtw_adapter *padapter,
			    enum hal_odm_variable eVariable,
			    void *pValue1, bool bSet);
void rtw_hal_get_odm_var23a(struct rtw_adapter *padapter,
			    enum hal_odm_variable eVariable,
			    void *pValue1, bool bSet);

void rtw_hal_enable_interrupt23a(struct rtw_adapter *padapter);
void rtw_hal_disable_interrupt23a(struct rtw_adapter *padapter);

u32 rtw_hal_inirp_init23a(struct rtw_adapter *padapter);
u32 rtw_hal_inirp_deinit23a(struct rtw_adapter *padapter);

u8 rtw_hal_intf_ps_func23a(struct rtw_adapter *padapter,
			   enum hal_intf_ps_func efunc_id, u8 *val);

s32 rtw_hal_xmit23aframe_enqueue(struct rtw_adapter *padapter,
				 struct xmit_frame *pxmitframe);
s32 rtw_hal_xmit23a(struct rtw_adapter *padapter,
		    struct xmit_frame *pxmitframe);
s32 rtw_hal_mgnt_xmit23a(struct rtw_adapter *padapter,
			 struct xmit_frame *pmgntframe);

s32	rtw_hal_init23a_xmit_priv(struct rtw_adapter *padapter);
void	rtw_hal_free_xmit_priv23a(struct rtw_adapter *padapter);

s32	rtw_hal_init23a_recv_priv(struct rtw_adapter *padapter);
void	rtw_hal_free_recv_priv23a(struct rtw_adapter *padapter);

void rtw_hal_update_ra_mask23a(struct sta_info *psta, u8 rssi_level);
void	rtw_hal_add_ra_tid23a(struct rtw_adapter *padapter, u32 bitmap, u8 arg, u8 rssi_level);
void	rtw_hal_clone_data(struct rtw_adapter *dst_padapter, struct rtw_adapter *src_padapter);
void	rtw_hal_start_thread23a(struct rtw_adapter *padapter);
void	rtw_hal_stop_thread23a(struct rtw_adapter *padapter);

void rtw_hal_bcn_related_reg_setting23a(struct rtw_adapter *padapter);

u32	rtw_hal_read_bbreg23a(struct rtw_adapter *padapter, u32 RegAddr, u32 BitMask);
void	rtw_hal_write_bbreg23a(struct rtw_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
u32	rtw_hal_read_rfreg23a(struct rtw_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
void	rtw_hal_write_rfreg23a(struct rtw_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);

s32	rtw_hal_interrupt_handler23a(struct rtw_adapter *padapter);

void	rtw_hal_set_bwmode23a(struct rtw_adapter *padapter,
			   enum ht_channel_width Bandwidth, u8 Offset);
void	rtw_hal_set_chan23a(struct rtw_adapter *padapter, u8 channel);
void	rtw_hal_dm_watchdog23a(struct rtw_adapter *padapter);

void rtw_hal_sreset_init23a(struct rtw_adapter *padapter);
void rtw_hal_sreset_reset23a(struct rtw_adapter *padapter);
void rtw_hal_sreset_reset23a_value23a(struct rtw_adapter *padapter);
void rtw_hal_sreset_xmit_status_check23a(struct rtw_adapter *padapter);
void rtw_hal_sreset_linked_status_check23a (struct rtw_adapter *padapter);
u8   rtw_hal_sreset_get_wifi_status23a(struct rtw_adapter *padapter);
bool rtw_hal_sreset_inprogress(struct rtw_adapter *padapter);

void rtw_hal_notch_filter23a(struct rtw_adapter *adapter, bool enable);
void rtw_hal_reset_security_engine23a(struct rtw_adapter *adapter);

s32 rtw_hal_c2h_handler23a(struct rtw_adapter *adapter, struct c2h_evt_hdr *c2h_evt);
c2h_id_filter rtw_hal_c2h_id_filter_ccx23a(struct rtw_adapter *adapter);

#endif /* __HAL_INTF_H__ */