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__
24 #include <osdep_service.h>
25 #include <drv_types.h>
32 enum RTL871X_HCI_TYPE {
42 RTL8712_8188S_8191S_8192S,
51 typedef enum _HW_VARIABLES{
58 HW_VAR_INIT_DATA_RATE,
64 HW_VAR_MLME_DISCONNECT,
65 HW_VAR_MLME_SITESURVEY,
69 HW_VAR_BEACON_INTERVAL,
81 HW_VAR_CAM_EMPTY_ENTRY,
82 HW_VAR_CAM_INVALID_ALL,
90 HW_VAR_AMPDU_MIN_SPACE,
92 HW_VAR_RXDMA_AGG_PG_TH,
94 HW_VAR_H2C_FW_PWRMODE,
95 HW_VAR_H2C_FW_JOINBSSRPT,
97 HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
99 HW_VAR_TDLS_INIT_CH_SEN,
101 HW_VAR_TDLS_DONE_CH_SEN,
103 HW_VAR_TRIGGER_GPIO_0,
104 HW_VAR_BT_SET_COEXIST,
105 HW_VAR_BT_ISSUE_DELBA,
106 HW_VAR_CURRENT_ANTENNA,
107 HW_VAR_ANTENNA_DIVERSITY_LINK,
108 HW_VAR_ANTENNA_DIVERSITY_SELECT,
109 HW_VAR_SWITCH_EPHY_WoWLAN,
111 HW_VAR_FIFO_CLEARN_UP,
113 HW_VAR_APFM_ON_MAC, //Auto FSM to Turn On, include clock, isolation, power control for MAC only
117 HW_VAR_MBSSID_CAM_WRITE,
118 HW_VAR_MBSSID_CAM_CLEAR,
119 HW_VAR_RCR_MBSSID_EN,
120 HW_VAR_USB_RXAGG_PAGE_TO,
123 typedef enum _HAL_DEF_VARIABLE{
124 HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
125 HAL_DEF_IS_SUPPORT_ANT_DIV,
126 HAL_DEF_CURRENT_ANTENNA,
128 HAL_DEF_MAX_RECVBUF_SZ,
129 HAL_DEF_RX_PACKET_OFFSET,
130 HAL_DEF_DBG_DUMP_RXPKT,//for dbg
131 HAL_DEF_DBG_DM_FUNC,//for dbg
132 HAL_DEF_DUAL_MAC_MODE,
135 typedef enum _HAL_INTF_PS_FUNC{
136 HAL_USB_SELECT_SUSPEND,
140 typedef s32 (*c2h_id_filter)(u8 id);
143 u32 (*hal_init)(PADAPTER Adapter);
144 u32 (*hal_deinit)(PADAPTER Adapter);
146 void (*free_hal_data)(PADAPTER Adapter);
148 u32 (*inirp_init)(PADAPTER Adapter);
149 u32 (*inirp_deinit)(PADAPTER Adapter);
151 s32 (*init_xmit_priv)(PADAPTER Adapter);
152 void (*free_xmit_priv)(PADAPTER Adapter);
154 s32 (*init_recv_priv)(PADAPTER Adapter);
155 void (*free_recv_priv)(PADAPTER Adapter);
157 void (*InitSwLeds)(PADAPTER Adapter);
158 void (*DeInitSwLeds)(PADAPTER Adapter);
160 void (*dm_init)(PADAPTER Adapter);
161 void (*dm_deinit)(PADAPTER Adapter);
162 void (*read_chip_version)(PADAPTER Adapter);
164 void (*init_default_value)(PADAPTER Adapter);
166 void (*intf_chip_configure)(PADAPTER Adapter);
168 void (*read_adapter_info)(PADAPTER Adapter);
170 void (*enable_interrupt)(PADAPTER Adapter);
171 void (*disable_interrupt)(PADAPTER Adapter);
172 s32 (*interrupt_handler)(PADAPTER Adapter);
174 void (*set_bwmode_handler)(PADAPTER Adapter, HT_CHANNEL_WIDTH Bandwidth, u8 Offset);
175 void (*set_channel_handler)(PADAPTER Adapter, u8 channel);
177 void (*hal_dm_watchdog)(PADAPTER Adapter);
179 void (*SetHwRegHandler)(PADAPTER Adapter, u8 variable,u8* val);
180 void (*GetHwRegHandler)(PADAPTER Adapter, u8 variable,u8* val);
182 u8 (*GetHalDefVarHandler)(PADAPTER Adapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
183 u8 (*SetHalDefVarHandler)(PADAPTER Adapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
185 void (*UpdateRAMaskHandler)(PADAPTER Adapter, u32 mac_id);
186 void (*SetBeaconRelatedRegistersHandler)(PADAPTER Adapter);
188 void (*Add_RateATid)(PADAPTER Adapter, u32 bitmap, u8 arg);
190 #ifdef CONFIG_ANTENNA_DIVERSITY
191 u8 (*AntDivBeforeLinkHandler)(PADAPTER Adapter);
192 void (*AntDivCompareHandler)(PADAPTER Adapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
194 u8 (*interface_ps_func)(PADAPTER Adapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
196 s32 (*hal_xmit)(PADAPTER Adapter, struct xmit_frame *pxmitframe);
197 s32 (*mgnt_xmit)(PADAPTER Adapter, struct xmit_frame *pmgntframe);
198 s32 (*hal_xmitframe_enqueue)(_adapter *padapter, struct xmit_frame *pxmitframe);
200 u32 (*read_bbreg)(PADAPTER Adapter, u32 RegAddr, u32 BitMask);
201 void (*write_bbreg)(PADAPTER Adapter, u32 RegAddr, u32 BitMask, u32 Data);
202 u32 (*read_rfreg)(PADAPTER Adapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
203 void (*write_rfreg)(PADAPTER Adapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
205 #ifdef CONFIG_HOSTAPD_MLME
206 s32 (*hostap_mgnt_xmit_entry)(PADAPTER Adapter, _pkt *pkt);
208 void (*EfusePowerSwitch)(PADAPTER pAdapter, u8 bWrite, u8 PwrState);
209 void (*ReadEFuse)(PADAPTER Adapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, BOOLEAN bPseudoTest);
210 void (*EFUSEGetEfuseDefinition)(PADAPTER pAdapter, u8 efuseType, u8 type, PVOID *pOut, BOOLEAN bPseudoTest);
211 u16 (*EfuseGetCurrentSize)(PADAPTER pAdapter, u8 efuseType, BOOLEAN bPseudoTest);
212 int (*Efuse_PgPacketRead)(PADAPTER pAdapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
213 int (*Efuse_PgPacketWrite)(PADAPTER pAdapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
214 u8 (*Efuse_WordEnableDataWrite)(PADAPTER pAdapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
216 #ifdef DBG_CONFIG_ERROR_DETECT
217 void (*sreset_init_value)(_adapter *padapter);
218 void (*sreset_reset_value)(_adapter *padapter);
219 void (*silentreset)(_adapter *padapter);
220 void (*sreset_xmit_status_check)(_adapter *padapter);
221 void (*sreset_linked_status_check) (_adapter *padapter);
222 u8 (*sreset_get_wifi_status)(_adapter *padapter);
223 bool (*sreset_inprogress)(_adapter *padapter);
227 int (*IOL_exec_cmds_sync)(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms);
229 void (*hal_notch_filter)(_adapter * adapter, bool enable);
230 void (*hal_reset_security_engine)(_adapter * adapter);
232 s32 (*c2h_handler)(_adapter *padapter, struct c2h_evt_hdr *c2h_evt);
233 c2h_id_filter c2h_id_filter_ccx;
236 typedef enum _RT_EEPROM_TYPE{
240 }RT_EEPROM_TYPE,*PRT_EEPROM_TYPE;
242 #define USB_HIGH_SPEED_BULK_SIZE 512
243 #define USB_FULL_SPEED_BULK_SIZE 64
245 #define RF_CHANGE_BY_INIT 0
246 #define RF_CHANGE_BY_IPS BIT28
247 #define RF_CHANGE_BY_PS BIT29
248 #define RF_CHANGE_BY_HW BIT30
249 #define RF_CHANGE_BY_SW BIT31
251 typedef enum _HARDWARE_TYPE{
252 HARDWARE_TYPE_RTL8180,
253 HARDWARE_TYPE_RTL8185,
254 HARDWARE_TYPE_RTL8187,
255 HARDWARE_TYPE_RTL8188,
256 HARDWARE_TYPE_RTL8190P,
257 HARDWARE_TYPE_RTL8192E,
258 HARDWARE_TYPE_RTL819xU,
259 HARDWARE_TYPE_RTL8192SE,
260 HARDWARE_TYPE_RTL8192SU,
261 HARDWARE_TYPE_RTL8192CE,
262 HARDWARE_TYPE_RTL8192CU,
263 HARDWARE_TYPE_RTL8192DE,
264 HARDWARE_TYPE_RTL8192DU,
265 HARDWARE_TYPE_RTL8723AE,
266 HARDWARE_TYPE_RTL8723AU,
267 HARDWARE_TYPE_RTL8723AS,
268 HARDWARE_TYPE_RTL8188EE,
269 HARDWARE_TYPE_RTL8188EU,
270 HARDWARE_TYPE_RTL8188ES,
277 #define IS_HARDWARE_TYPE_8192CE(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8192CE)
278 #define IS_HARDWARE_TYPE_8192CU(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8192CU)
279 #define IS_HARDWARE_TYPE_8192C(_Adapter) \
280 (IS_HARDWARE_TYPE_8192CE(_Adapter) || IS_HARDWARE_TYPE_8192CU(_Adapter))
285 #define IS_HARDWARE_TYPE_8192DE(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8192DE)
286 #define IS_HARDWARE_TYPE_8192DU(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8192DU)
287 #define IS_HARDWARE_TYPE_8192D(_Adapter) \
288 (IS_HARDWARE_TYPE_8192DE(_Adapter) || IS_HARDWARE_TYPE_8192DU(_Adapter))
293 #define IS_HARDWARE_TYPE_8723AE(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8723AE)
294 #define IS_HARDWARE_TYPE_8723AU(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8723AU)
295 #define IS_HARDWARE_TYPE_8723AS(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8723AS)
296 #define IS_HARDWARE_TYPE_8723A(_Adapter) \
297 (IS_HARDWARE_TYPE_8723AE(_Adapter) || IS_HARDWARE_TYPE_8723AU(_Adapter) || IS_HARDWARE_TYPE_8723AS(_Adapter))
302 #define IS_HARDWARE_TYPE_8188EE(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8188EE)
303 #define IS_HARDWARE_TYPE_8188EU(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8188EU)
304 #define IS_HARDWARE_TYPE_8188ES(_Adapter) (((PADAPTER)_Adapter)->HardwareType==HARDWARE_TYPE_RTL8188ES)
305 #define IS_HARDWARE_TYPE_8188E(_Adapter) \
306 (IS_HARDWARE_TYPE_8188EE(_Adapter) || IS_HARDWARE_TYPE_8188EU(_Adapter) || IS_HARDWARE_TYPE_8188ES(_Adapter))
309 typedef struct eeprom_priv EEPROM_EFUSE_PRIV, *PEEPROM_EFUSE_PRIV;
310 #define GET_EEPROM_EFUSE_PRIV(priv) (&priv->eeprompriv)
313 typedef enum _wowlan_subcode{
314 WOWLAN_PATTERN_MATCH = 1,
315 WOWLAN_MAGIC_PACKET = 2,
317 WOWLAN_SET_PATTERN = 4,
322 WOWLAN_DEBUG_RELOAD_FW = 9,
327 struct wowlan_ioctl_param{
328 unsigned int subcode;
329 unsigned int subcode_value;
330 unsigned int wakeup_reason;
332 unsigned char pattern[0];
335 #define Rx_Pairwisekey BIT(0)
336 #define Rx_GTK BIT(1)
337 #define Rx_DisAssoc BIT(2)
338 #define Rx_DeAuth BIT(3)
339 #define FWDecisionDisconnect BIT(4)
340 #define Rx_MagicPkt BIT(5)
341 #define FinishBtFwPatch BIT(7)
343 #endif // CONFIG_WOWLAN
345 void rtw_hal_def_value_init(_adapter *padapter);
346 void rtw_hal_free_data(_adapter *padapter);
348 void rtw_hal_dm_init(_adapter *padapter);
349 void rtw_hal_dm_deinit(_adapter *padapter);
350 void rtw_hal_sw_led_init(_adapter *padapter);
351 void rtw_hal_sw_led_deinit(_adapter *padapter);
353 uint rtw_hal_init(_adapter *padapter);
354 uint rtw_hal_deinit(_adapter *padapter);
355 void rtw_hal_stop(_adapter *padapter);
357 void rtw_hal_set_hwreg(PADAPTER padapter, u8 variable, u8 *val);
358 void rtw_hal_get_hwreg(PADAPTER padapter, u8 variable, u8 *val);
360 void rtw_hal_chip_configure(_adapter *padapter);
361 void rtw_hal_read_chip_info(_adapter *padapter);
362 void rtw_hal_read_chip_version(_adapter *padapter);
364 u8 rtw_hal_set_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
365 u8 rtw_hal_get_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
367 void rtw_hal_enable_interrupt(_adapter *padapter);
368 void rtw_hal_disable_interrupt(_adapter *padapter);
370 u32 rtw_hal_inirp_init(_adapter *padapter);
371 u32 rtw_hal_inirp_deinit(_adapter *padapter);
373 u8 rtw_hal_intf_ps_func(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
375 s32 rtw_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
376 s32 rtw_hal_xmit(_adapter *padapter, struct xmit_frame *pxmitframe);
377 s32 rtw_hal_mgnt_xmit(_adapter *padapter, struct xmit_frame *pmgntframe);
379 s32 rtw_hal_init_xmit_priv(_adapter *padapter);
380 void rtw_hal_free_xmit_priv(_adapter *padapter);
382 s32 rtw_hal_init_recv_priv(_adapter *padapter);
383 void rtw_hal_free_recv_priv(_adapter *padapter);
385 void rtw_hal_update_ra_mask(_adapter *padapter, u32 mac_id);
386 void rtw_hal_add_ra_tid(_adapter *padapter, u32 bitmap, u8 arg);
388 void rtw_hal_bcn_related_reg_setting(_adapter *padapter);
390 u32 rtw_hal_read_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask);
391 void rtw_hal_write_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
392 u32 rtw_hal_read_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
393 void rtw_hal_write_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
395 s32 rtw_hal_interrupt_handler(_adapter *padapter);
397 void rtw_hal_set_bwmode(_adapter *padapter, HT_CHANNEL_WIDTH Bandwidth, u8 Offset);
398 void rtw_hal_set_chan(_adapter *padapter, u8 channel);
400 void rtw_hal_dm_watchdog(_adapter *padapter);
402 #ifdef CONFIG_ANTENNA_DIVERSITY
403 u8 rtw_hal_antdiv_before_linked(_adapter *padapter);
404 void rtw_hal_antdiv_rssi_compared(_adapter *padapter, WLAN_BSSID_EX *dst, WLAN_BSSID_EX *src);
407 #ifdef CONFIG_HOSTAPD_MLME
408 s32 rtw_hal_hostap_mgnt_xmit_entry(_adapter *padapter, _pkt *pkt);
411 #ifdef DBG_CONFIG_ERROR_DETECT
412 void rtw_hal_sreset_init(_adapter *padapter);
413 void rtw_hal_sreset_reset(_adapter *padapter);
414 void rtw_hal_sreset_reset_value(_adapter *padapter);
415 void rtw_hal_sreset_xmit_status_check(_adapter *padapter);
416 void rtw_hal_sreset_linked_status_check(_adapter *padapter);
417 u8 rtw_hal_sreset_get_wifi_status(_adapter *padapter);
418 bool rtw_hal_sreset_inprogress(_adapter *padapter);
422 int rtw_hal_iol_cmd(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms);
425 void rtw_hal_notch_filter(_adapter * adapter, bool enable);
426 void rtw_hal_reset_security_engine(_adapter * adapter);
428 s32 rtw_hal_c2h_handler(_adapter *adapter, struct c2h_evt_hdr *c2h_evt);
429 c2h_id_filter rtw_hal_c2h_id_filter_ccx(_adapter *adapter);
431 #endif //__HAL_INTF_H__