1 /******************************************************************************
3 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19 ******************************************************************************/
20 #ifndef __HAL_INTF_H__
21 #define __HAL_INTF_H__
23 #include <osdep_service.h>
24 #include <drv_types.h>
25 #include <Hal8188EPhyCfg.h>
27 enum RTL871X_HCI_TYPE {
36 RTL8712_8188S_8191S_8192S,
56 HW_VAR_MLME_DISCONNECT,
57 HW_VAR_MLME_SITESURVEY,
59 HW_VAR_BEACON_INTERVAL,
70 HW_VAR_CAM_EMPTY_ENTRY,
71 HW_VAR_CAM_INVALID_ALL,
79 HW_VAR_AMPDU_MIN_SPACE,
81 HW_VAR_RXDMA_AGG_PG_TH,
83 HW_VAR_H2C_FW_PWRMODE,
84 HW_VAR_H2C_FW_JOINBSSRPT,
86 HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
88 HW_VAR_TDLS_INIT_CH_SEN,
90 HW_VAR_TDLS_DONE_CH_SEN,
92 HW_VAR_TRIGGER_GPIO_0,
93 HW_VAR_BT_SET_COEXIST,
94 HW_VAR_BT_ISSUE_DELBA,
95 HW_VAR_CURRENT_ANTENNA,
96 HW_VAR_ANTENNA_DIVERSITY_LINK,
97 HW_VAR_ANTENNA_DIVERSITY_SELECT,
98 HW_VAR_SWITCH_EPHY_WoWLAN,
101 HW_VAR_EFUSE_BT_USAGE,
102 HW_VAR_EFUSE_BT_BYTES,
103 HW_VAR_FIFO_CLEARN_UP,
105 HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation,
106 * power control for MAC only */
107 /* The valid upper nav range for the HW updating, if the true value is
108 * larger than the upper range, the HW won't update it. */
109 /* Unit in microsecond. 0 means disable this function. */
111 HW_VAR_RPT_TIMER_SETTING,
112 HW_VAR_TX_RPT_MAX_MACID,
113 HW_VAR_H2C_MEDIA_STATUS_RPT,
114 HW_VAR_CHK_HI_QUEUE_EMPTY,
117 enum hal_def_variable {
118 HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
119 HAL_DEF_IS_SUPPORT_ANT_DIV,
120 HAL_DEF_CURRENT_ANTENNA,
122 HAL_DEF_MAX_RECVBUF_SZ,
123 HAL_DEF_RX_PACKET_OFFSET,
124 HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
125 HAL_DEF_DBG_DM_FUNC,/* for dbg */
126 HAL_DEF_RA_DECISION_RATE,
128 HAL_DEF_PT_PWR_STATUS,
129 HW_VAR_MAX_RX_AMPDU_FACTOR,
131 HAL_DEF_DBG_DUMP_TXPKT,
136 enum hal_odm_variable {
139 HAL_ODM_WIFI_DISPLAY_STATE,
142 enum hal_intf_ps_func {
143 HAL_USB_SELECT_SUSPEND,
148 u32 (*hal_power_on)(struct adapter *padapter);
149 u32 (*hal_init)(struct adapter *padapter);
150 u32 (*hal_deinit)(struct adapter *padapter);
152 void (*free_hal_data)(struct adapter *padapter);
154 u32 (*inirp_init)(struct adapter *padapter);
155 u32 (*inirp_deinit)(struct adapter *padapter);
157 s32 (*init_xmit_priv)(struct adapter *padapter);
159 s32 (*init_recv_priv)(struct adapter *padapter);
160 void (*free_recv_priv)(struct adapter *padapter);
162 void (*InitSwLeds)(struct adapter *padapter);
163 void (*DeInitSwLeds)(struct adapter *padapter);
165 void (*dm_init)(struct adapter *padapter);
166 void (*read_chip_version)(struct adapter *padapter);
168 void (*init_default_value)(struct adapter *padapter);
170 void (*intf_chip_configure)(struct adapter *padapter);
172 void (*read_adapter_info)(struct adapter *padapter);
174 s32 (*interrupt_handler)(struct adapter *padapter);
176 void (*set_bwmode_handler)(struct adapter *padapter,
177 enum ht_channel_width Bandwidth,
179 void (*set_channel_handler)(struct adapter *padapter, u8 channel);
181 void (*hal_dm_watchdog)(struct adapter *padapter);
183 void (*SetHwRegHandler)(struct adapter *padapter, u8 variable,
185 void (*GetHwRegHandler)(struct adapter *padapter, u8 variable,
188 u8 (*GetHalDefVarHandler)(struct adapter *padapter,
189 enum hal_def_variable eVariable,
192 void (*SetHalODMVarHandler)(struct adapter *padapter,
193 enum hal_odm_variable eVariable,
194 void *pValue1, bool bSet);
196 void (*UpdateRAMaskHandler)(struct adapter *padapter,
197 u32 mac_id, u8 rssi_level);
198 void (*SetBeaconRelatedRegistersHandler)(struct adapter *padapter);
200 void (*Add_RateATid)(struct adapter *adapter, u32 bitmap, u8 arg,
203 u8 (*AntDivBeforeLinkHandler)(struct adapter *adapter);
204 void (*AntDivCompareHandler)(struct adapter *adapter,
205 struct wlan_bssid_ex *dst,
206 struct wlan_bssid_ex *src);
207 s32 (*hal_xmit)(struct adapter *padapter,
208 struct xmit_frame *pxmitframe);
209 s32 (*mgnt_xmit)(struct adapter *padapter,
210 struct xmit_frame *pmgntframe);
211 u32 (*read_rfreg)(struct adapter *padapter,
212 enum rf_radio_path eRFPath, u32 RegAddr,
215 void (*sreset_init_value)(struct adapter *padapter);
216 u8 (*sreset_get_wifi_status)(struct adapter *padapter);
218 void (*hal_notch_filter)(struct adapter *adapter, bool enable);
219 void (*hal_reset_security_engine)(struct adapter *adapter);
222 enum rt_eeprom_type {
228 #define RF_CHANGE_BY_INIT 0
229 #define RF_CHANGE_BY_IPS BIT(28)
230 #define RF_CHANGE_BY_PS BIT(29)
231 #define RF_CHANGE_BY_HW BIT(30)
232 #define RF_CHANGE_BY_SW BIT(31)
235 HARDWARE_TYPE_RTL8188EU,
239 #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)
241 #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)
243 void rtw_hal_def_value_init(struct adapter *padapter);
245 void rtw_hal_free_data(struct adapter *padapter);
247 void rtw_hal_dm_init(struct adapter *padapter);
248 void rtw_hal_sw_led_init(struct adapter *padapter);
249 void rtw_hal_sw_led_deinit(struct adapter *padapter);
251 u32 rtw_hal_power_on(struct adapter *padapter);
252 uint rtw_hal_init(struct adapter *padapter);
253 uint rtw_hal_deinit(struct adapter *padapter);
254 void rtw_hal_stop(struct adapter *padapter);
255 void rtw_hal_set_hwreg(struct adapter *padapter, u8 variable, u8 *val);
256 void rtw_hal_get_hwreg(struct adapter *padapter, u8 variable, u8 *val);
258 void rtw_hal_chip_configure(struct adapter *padapter);
259 void rtw_hal_read_chip_info(struct adapter *padapter);
260 void rtw_hal_read_chip_version(struct adapter *padapter);
262 u8 rtw_hal_get_def_var(struct adapter *padapter,
263 enum hal_def_variable eVariable, void *pValue);
265 void rtw_hal_set_odm_var(struct adapter *padapter,
266 enum hal_odm_variable eVariable, void *pValue1,
269 u32 rtw_hal_inirp_init(struct adapter *padapter);
270 u32 rtw_hal_inirp_deinit(struct adapter *padapter);
272 s32 rtw_hal_xmit(struct adapter *padapter, struct xmit_frame *pxmitframe);
273 s32 rtw_hal_mgnt_xmit(struct adapter *padapter,
274 struct xmit_frame *pmgntframe);
276 s32 rtw_hal_init_xmit_priv(struct adapter *padapter);
278 s32 rtw_hal_init_recv_priv(struct adapter *padapter);
279 void rtw_hal_free_recv_priv(struct adapter *padapter);
281 void rtw_hal_update_ra_mask(struct adapter *padapter, u32 mac_id, u8 level);
282 void rtw_hal_add_ra_tid(struct adapter *adapt, u32 bitmap, u8 arg, u8 level);
283 void rtw_hal_clone_data(struct adapter *dst_adapt,
284 struct adapter *src_adapt);
286 void rtw_hal_bcn_related_reg_setting(struct adapter *padapter);
288 u32 rtw_hal_read_rfreg(struct adapter *padapter, enum rf_radio_path eRFPath,
289 u32 RegAddr, u32 BitMask);
291 void rtw_hal_set_bwmode(struct adapter *padapter,
292 enum ht_channel_width Bandwidth, u8 Offset);
293 void rtw_hal_set_chan(struct adapter *padapter, u8 channel);
294 void rtw_hal_dm_watchdog(struct adapter *padapter);
296 u8 rtw_hal_antdiv_before_linked(struct adapter *padapter);
297 void rtw_hal_antdiv_rssi_compared(struct adapter *padapter,
298 struct wlan_bssid_ex *dst,
299 struct wlan_bssid_ex *src);
301 void rtw_hal_sreset_init(struct adapter *padapter);
303 void rtw_hal_notch_filter(struct adapter *adapter, bool enable);
304 void rtw_hal_reset_security_engine(struct adapter *adapter);
306 void indicate_wx_scan_complete_event(struct adapter *padapter);
307 u8 rtw_do_join(struct adapter *padapter);
309 #endif /* __HAL_INTF_H__ */