xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8723bu/include/hal_intf.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
4  *
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.
8  *
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
12  * more details.
13  *
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
17  *
18  *
19  ******************************************************************************/
20 #ifndef __HAL_INTF_H__
21 #define __HAL_INTF_H__
22 
23 
24 enum RTL871X_HCI_TYPE {
25 	RTW_PCIE	= BIT0,
26 	RTW_USB 	= BIT1,
27 	RTW_SDIO 	= BIT2,
28 	RTW_GSPI	= BIT3,
29 };
30 
31 enum _CHIP_TYPE {
32 
33 	NULL_CHIP_TYPE,
34 	RTL8188E,
35 	RTL8192E,
36 	RTL8812,
37 	RTL8821, //RTL8811
38 	RTL8723B,
39 	RTL8814A,
40 	RTL8703B,
41 	RTL8188F,
42 	MAX_CHIP_TYPE
43 };
44 
45 extern const u32 _chip_type_to_odm_ic_type[];
46 #define chip_type_to_odm_ic_type(chip_type) (((chip_type) >= MAX_CHIP_TYPE) ? _chip_type_to_odm_ic_type[MAX_CHIP_TYPE] : _chip_type_to_odm_ic_type[(chip_type)])
47 
48 typedef enum _HAL_HW_TIMER_TYPE {
49 	HAL_TIMER_NONE = 0,
50 	HAL_TIMER_TXBF = 1,
51 	HAL_TIMER_EARLYMODE = 2,
52 } HAL_HW_TIMER_TYPE, *PHAL_HW_TIMER_TYPE;
53 
54 
55 typedef enum _HW_VARIABLES{
56 	HW_VAR_MEDIA_STATUS,
57 	HW_VAR_MEDIA_STATUS1,
58 	HW_VAR_SET_OPMODE,
59 	HW_VAR_MAC_ADDR,
60 	HW_VAR_BSSID,
61 	HW_VAR_INIT_RTS_RATE,
62 	HW_VAR_BASIC_RATE,
63 	HW_VAR_TXPAUSE,
64 	HW_VAR_BCN_FUNC,
65 	HW_VAR_CORRECT_TSF,
66 	HW_VAR_CHECK_BSSID,
67 	HW_VAR_MLME_DISCONNECT,
68 	HW_VAR_MLME_SITESURVEY,
69 	HW_VAR_MLME_JOIN,
70 	HW_VAR_ON_RCR_AM,
71        HW_VAR_OFF_RCR_AM,
72 	HW_VAR_BEACON_INTERVAL,
73 	HW_VAR_SLOT_TIME,
74 	HW_VAR_RESP_SIFS,
75 	HW_VAR_ACK_PREAMBLE,
76 	HW_VAR_SEC_CFG,
77 	HW_VAR_SEC_DK_CFG,
78 	HW_VAR_BCN_VALID,
79 	HW_VAR_RF_TYPE,
80 	/* PHYDM odm->SupportAbility */
81 	HW_VAR_CAM_EMPTY_ENTRY,
82 	HW_VAR_CAM_INVALID_ALL,
83 	HW_VAR_AC_PARAM_VO,
84 	HW_VAR_AC_PARAM_VI,
85 	HW_VAR_AC_PARAM_BE,
86 	HW_VAR_AC_PARAM_BK,
87 	HW_VAR_ACM_CTRL,
88 	HW_VAR_AMPDU_MIN_SPACE,
89 	HW_VAR_AMPDU_FACTOR,
90 	HW_VAR_RXDMA_AGG_PG_TH,
91 	HW_VAR_SET_RPWM,
92 	HW_VAR_CPWM,
93 	HW_VAR_H2C_FW_PWRMODE,
94 	HW_VAR_H2C_PS_TUNE_PARAM,
95 	HW_VAR_H2C_FW_JOINBSSRPT,
96 	HW_VAR_FWLPS_RF_ON,
97 	HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
98 	HW_VAR_TRIGGER_GPIO_0,
99 	HW_VAR_BT_SET_COEXIST,
100 	HW_VAR_BT_ISSUE_DELBA,
101 	HW_VAR_SWITCH_EPHY_WoWLAN,
102 	HW_VAR_EFUSE_USAGE,
103 	HW_VAR_EFUSE_BYTES,
104 	HW_VAR_EFUSE_BT_USAGE,
105 	HW_VAR_EFUSE_BT_BYTES,
106 	HW_VAR_FIFO_CLEARN_UP,
107 	HW_VAR_RESTORE_HW_SEQ,
108 	HW_VAR_CHECK_TXBUF,
109 	HW_VAR_PCIE_STOP_TX_DMA,
110 	HW_VAR_APFM_ON_MAC, //Auto FSM to Turn On, include clock, isolation, power control for MAC only
111 	HW_VAR_HCI_SUS_STATE,
112 	// 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.
113 	// Unit in microsecond. 0 means disable this function.
114 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
115 	HW_VAR_WOWLAN,
116 	HW_VAR_WAKEUP_REASON,
117 	HW_VAR_RPWM_TOG,
118 #endif
119 #ifdef CONFIG_GPIO_WAKEUP
120 	HW_SET_GPIO_WL_CTRL,
121 #endif
122 	HW_VAR_SYS_CLKR,
123 	HW_VAR_NAV_UPPER,
124 	HW_VAR_C2H_HANDLE,
125 	HW_VAR_RPT_TIMER_SETTING,
126 	HW_VAR_TX_RPT_MAX_MACID,
127 	HW_VAR_CHK_HI_QUEUE_EMPTY,
128 	HW_VAR_DL_BCN_SEL,
129 	HW_VAR_AMPDU_MAX_TIME,
130 	HW_VAR_WIRELESS_MODE,
131 	HW_VAR_USB_MODE,
132 	HW_VAR_PORT_SWITCH,
133 	HW_VAR_DO_IQK,
134 	HW_VAR_DM_IN_LPS,
135 	HW_VAR_SET_REQ_FW_PS,
136 	HW_VAR_FW_PS_STATE,
137 	HW_VAR_SOUNDING_ENTER,
138 	HW_VAR_SOUNDING_LEAVE,
139 	HW_VAR_SOUNDING_RATE,
140 	HW_VAR_SOUNDING_STATUS,
141 	HW_VAR_SOUNDING_FW_NDPA,
142 	HW_VAR_SOUNDING_CLK,
143 /*Add by YuChen for TXBF HW timer*/
144 	HW_VAR_HW_REG_TIMER_INIT,
145 	HW_VAR_HW_REG_TIMER_RESTART,
146 	HW_VAR_HW_REG_TIMER_START,
147 	HW_VAR_HW_REG_TIMER_STOP,
148 /*Add by YuChen for TXBF HW timer*/
149 	HW_VAR_DL_RSVD_PAGE,
150 	HW_VAR_MACID_LINK,
151 	HW_VAR_MACID_NOLINK,
152 	HW_VAR_MACID_SLEEP,
153 	HW_VAR_MACID_WAKEUP,
154 	HW_VAR_DUMP_MAC_QUEUE_INFO,
155 	HW_VAR_ASIX_IOT,
156 	HW_VAR_EN_HW_UPDATE_TSF,
157 	HW_VAR_CH_SW_NEED_TO_TAKE_CARE_IQK_INFO,
158 	HW_VAR_CH_SW_IQK_INFO_BACKUP,
159 	HW_VAR_CH_SW_IQK_INFO_RESTORE,
160 #ifdef CONFIG_TDLS
161 	HW_VAR_TDLS_WRCR,
162 	HW_VAR_TDLS_RS_RCR,
163 #ifdef CONFIG_TDLS_CH_SW
164 	HW_VAR_TDLS_BCN_EARLY_C2H_RPT
165 #endif
166 #endif
167 }HW_VARIABLES;
168 
169 typedef enum _HAL_DEF_VARIABLE{
170 	HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
171 	HAL_DEF_IS_SUPPORT_ANT_DIV,
172 	HAL_DEF_DRVINFO_SZ,
173 	HAL_DEF_MAX_RECVBUF_SZ,
174 	HAL_DEF_RX_PACKET_OFFSET,
175 	HAL_DEF_RX_DMA_SZ_WOW,
176 	HAL_DEF_RX_DMA_SZ,
177 	HAL_DEF_RX_PAGE_SIZE,
178 	HAL_DEF_DBG_DUMP_RXPKT,//for dbg
179 	HAL_DEF_RA_DECISION_RATE,
180 	HAL_DEF_RA_SGI,
181 	HAL_DEF_PT_PWR_STATUS,
182 	HAL_DEF_TX_LDPC, 				// LDPC support
183 	HAL_DEF_RX_LDPC, 				// LDPC support
184 	HAL_DEF_TX_STBC, 				// TX STBC support
185 	HAL_DEF_RX_STBC, 				// RX STBC support
186 	HAL_DEF_EXPLICIT_BEAMFORMER,// Explicit  Compressed Steering Capable
187 	HAL_DEF_EXPLICIT_BEAMFORMEE,// Explicit Compressed Beamforming Feedback Capable
188 	HAL_DEF_BEAMFORMER_CAP,
189 	HAL_DEF_BEAMFORMEE_CAP,
190 	HW_VAR_MAX_RX_AMPDU_FACTOR,
191 	HW_DEF_RA_INFO_DUMP,
192 	HAL_DEF_DBG_DUMP_TXPKT,
193 
194 	HAL_DEF_TX_PAGE_SIZE,
195 	HAL_DEF_TX_PAGE_BOUNDARY,
196 	HAL_DEF_TX_PAGE_BOUNDARY_WOWLAN,
197 	HAL_DEF_ANT_DETECT,//to do for 8723a
198 	HAL_DEF_PCI_SUUPORT_L1_BACKDOOR, // Determine if the L1 Backdoor setting is turned on.
199 	HAL_DEF_PCI_AMD_L1_SUPPORT,
200 	HAL_DEF_PCI_ASPM_OSC, // Support for ASPM OSC, added by Roger, 2013.03.27.
201 	HAL_DEF_MACID_SLEEP, // Support for MACID sleep
202 	HAL_DEF_DBG_DIS_PWT, //disable Tx power training or not.
203 	HAL_DEF_EFUSE_USAGE,	/* Get current EFUSE utilization. 2008.12.19. Added by Roger. */
204 	HAL_DEF_EFUSE_BYTES,
205 	HW_VAR_BEST_AMPDU_DENSITY,
206 }HAL_DEF_VARIABLE;
207 
208 typedef enum _HAL_ODM_VARIABLE{
209 	HAL_ODM_STA_INFO,
210 	HAL_ODM_P2P_STATE,
211 	HAL_ODM_WIFI_DISPLAY_STATE,
212 	HAL_ODM_NOISE_MONITOR,
213 	HAL_ODM_REGULATION,
214 	HAL_ODM_INITIAL_GAIN,
215 	HAL_ODM_FA_CNT_DUMP,
216 	HAL_ODM_DBG_FLAG,
217 	HAL_ODM_DBG_LEVEL,
218 	HAL_ODM_RX_INFO_DUMP,
219 #ifdef CONFIG_AUTO_CHNL_SEL_NHM
220 	HAL_ODM_AUTO_CHNL_SEL,
221 #endif
222 #ifdef CONFIG_ANTENNA_DIVERSITY
223 	HAL_ODM_ANTDIV_SELECT
224 #endif
225 }HAL_ODM_VARIABLE;
226 
227 typedef enum _HAL_INTF_PS_FUNC{
228 	HAL_USB_SELECT_SUSPEND,
229 	HAL_MAX_ID,
230 }HAL_INTF_PS_FUNC;
231 
232 typedef s32 (*c2h_id_filter)(u8 *c2h_evt);
233 
234 struct hal_ops {
235 	/*** initialize section ***/
236 	void	(*read_chip_version)(_adapter *padapter);
237 	void	(*init_default_value)(_adapter *padapter);
238 	void	(*intf_chip_configure)(_adapter *padapter);
239 	void	(*read_adapter_info)(_adapter *padapter);
240 	u32	(*hal_power_on)(_adapter *padapter);
241 	void	(*hal_power_off)(_adapter *padapter);
242 	u32	(*hal_init)(_adapter *padapter);
243 	u32	(*hal_deinit)(_adapter *padapter);
244 	void	(*dm_init)(_adapter *padapter);
245 	void	(*dm_deinit)(_adapter *padapter);
246 
247 	/*** xmit section ***/
248 	s32	(*init_xmit_priv)(_adapter *padapter);
249 	void	(*free_xmit_priv)(_adapter *padapter);
250 	s32	(*hal_xmit)(_adapter *padapter, struct xmit_frame *pxmitframe);
251 	/*
252 	 * mgnt_xmit should be implemented to run in interrupt context
253 	 */
254 	s32 (*mgnt_xmit)(_adapter *padapter, struct xmit_frame *pmgntframe);
255 	s32	(*hal_xmitframe_enqueue)(_adapter *padapter, struct xmit_frame *pxmitframe);
256 #ifdef CONFIG_XMIT_THREAD_MODE
257 	s32 (*xmit_thread_handler)(_adapter *padapter);
258 #endif
259 	void	(*run_thread)(_adapter *padapter);
260 	void	(*cancel_thread)(_adapter *padapter);
261 
262 	/*** recv section ***/
263 	s32	(*init_recv_priv)(_adapter *padapter);
264 	void	(*free_recv_priv)(_adapter *padapter);
265 #if defined(CONFIG_USB_HCI)||defined(CONFIG_PCI_HCI)
266 	u32	(*inirp_init)(_adapter *padapter);
267 	u32	(*inirp_deinit)(_adapter *padapter);
268 #endif
269 	/*** interrupt hdl section ***/
270 	void	(*enable_interrupt)(_adapter *padapter);
271 	void	(*disable_interrupt)(_adapter *padapter);
272 	u8	(*check_ips_status)(_adapter *padapter);
273 #if defined(CONFIG_PCI_HCI)
274 	s32	(*interrupt_handler)(_adapter *padapter);
275 #endif
276 
277 #if defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
278 	void	(*interrupt_handler)(_adapter *padapter, u16 pkt_len, u8 *pbuf);
279 #endif
280 
281 #if defined(CONFIG_PCI_HCI)
282 	void	(*irp_reset)(_adapter *padapter);
283 #endif
284 
285 	/*** DM section ***/
286 
287 	void	(*InitSwLeds)(_adapter *padapter);
288 	void	(*DeInitSwLeds)(_adapter *padapter);
289 
290 
291 	void	(*set_bwmode_handler)(_adapter *padapter, CHANNEL_WIDTH Bandwidth, u8 Offset);
292 	void	(*set_channel_handler)(_adapter *padapter, u8 channel);
293 	void	(*set_chnl_bw_handler)(_adapter *padapter, u8 channel, CHANNEL_WIDTH Bandwidth, u8 Offset40, u8 Offset80);
294 
295 	void	(*set_tx_power_level_handler)(_adapter *padapter, u8 channel);
296 	void	(*get_tx_power_level_handler)(_adapter *padapter, s32 *powerlevel);
297 
298 	void	(*hal_dm_watchdog)(_adapter *padapter);
299 #ifdef CONFIG_LPS_LCLK_WD_TIMER
300 	void	(*hal_dm_watchdog_in_lps)(_adapter *padapter);
301 #endif
302 
303 	void	(*SetHwRegHandler)(_adapter *padapter, u8	variable,u8* val);
304 	void	(*GetHwRegHandler)(_adapter *padapter, u8	variable,u8* val);
305 
306 #ifdef CONFIG_C2H_PACKET_EN
307 	void	(*SetHwRegHandlerWithBuf)(_adapter *padapter, u8 variable, u8 * pbuf, int len);
308 #endif
309 
310 	u8	(*GetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
311 	u8	(*SetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
312 
313 	void	(*GetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1,PVOID pValue2);
314 	void	(*SetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1,BOOLEAN bSet);
315 
316 	void	(*UpdateRAMaskHandler)(_adapter *padapter, u32 mac_id, u8 rssi_level);
317 	void	(*SetBeaconRelatedRegistersHandler)(_adapter *padapter);
318 
319 	void	(*Add_RateATid)(_adapter *padapter, u64 bitmap, u8 *arg, u8 rssi_level);
320 	u8	(*interface_ps_func)(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
321 
322 	u32	(*read_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask);
323 	void	(*write_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
324 	u32	(*read_rfreg)(_adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask);
325 	void	(*write_rfreg)(_adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
326 
327 #ifdef CONFIG_HOSTAPD_MLME
328 	s32	(*hostap_mgnt_xmit_entry)(_adapter *padapter, _pkt *pkt);
329 #endif
330 
331 	void (*EfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
332 	void (*BTEfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
333 	void (*ReadEFuse)(_adapter *padapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, BOOLEAN bPseudoTest);
334 	void (*EFUSEGetEfuseDefinition)(_adapter *padapter, u8 efuseType, u8 type, void *pOut, BOOLEAN bPseudoTest);
335 	u16	(*EfuseGetCurrentSize)(_adapter *padapter, u8 efuseType, BOOLEAN bPseudoTest);
336 	int 	(*Efuse_PgPacketRead)(_adapter *padapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
337 	int 	(*Efuse_PgPacketWrite)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
338 	u8	(*Efuse_WordEnableDataWrite)(_adapter *padapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
339 	BOOLEAN	(*Efuse_PgPacketWrite_BT)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
340 
341 #ifdef DBG_CONFIG_ERROR_DETECT
342 	void (*sreset_init_value)(_adapter *padapter);
343 	void (*sreset_reset_value)(_adapter *padapter);
344 	void (*silentreset)(_adapter *padapter);
345 	void (*sreset_xmit_status_check)(_adapter *padapter);
346 	void (*sreset_linked_status_check) (_adapter *padapter);
347 	u8 (*sreset_get_wifi_status)(_adapter *padapter);
348 	bool (*sreset_inprogress)(_adapter *padapter);
349 #endif
350 
351 #ifdef CONFIG_IOL
352 	int (*IOL_exec_cmds_sync)(_adapter *padapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
353 #endif
354 
355 	void (*hal_notch_filter)(_adapter * adapter, bool enable);
356 	s32 (*c2h_handler)(_adapter *padapter, u8 *c2h_evt);
357 	c2h_id_filter c2h_id_filter_ccx;
358 	s32 (*fill_h2c_cmd)(PADAPTER, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
359 	void (*fill_fake_txdesc)(PADAPTER, u8 *pDesc, u32 BufferLen,
360 			u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
361 	s32 (*fw_dl)(_adapter *adapter, u8 wowlan);
362 
363 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
364 	void (*clear_interrupt)(_adapter *padapter);
365 #endif
366 	u8 (*hal_get_tx_buff_rsvd_page_num)(_adapter *adapter, bool wowlan);
367 #ifdef CONFIG_GPIO_API
368 	void (*update_hisr_hsisr_ind)(PADAPTER padapter, u32 flag);
369 	int (*hal_gpio_func_check)(_adapter *padapter, u8 gpio_num);
370 	void (*hal_gpio_multi_func_reset)(_adapter *padapter, u8 gpio_num);
371 #endif
372 	void (*fw_correct_bcn)(PADAPTER padapter);
373 };
374 
375 typedef	enum _RT_EEPROM_TYPE{
376 	EEPROM_93C46,
377 	EEPROM_93C56,
378 	EEPROM_BOOT_EFUSE,
379 }RT_EEPROM_TYPE,*PRT_EEPROM_TYPE;
380 
381 
382 
383 #define RF_CHANGE_BY_INIT	0
384 #define RF_CHANGE_BY_IPS 	BIT28
385 #define RF_CHANGE_BY_PS 	BIT29
386 #define RF_CHANGE_BY_HW 	BIT30
387 #define RF_CHANGE_BY_SW 	BIT31
388 
389 typedef enum _HARDWARE_TYPE{
390 	HARDWARE_TYPE_RTL8188EE,
391 	HARDWARE_TYPE_RTL8188EU,
392 	HARDWARE_TYPE_RTL8188ES,
393 //	NEW_GENERATION_IC
394 	HARDWARE_TYPE_RTL8192EE,
395 	HARDWARE_TYPE_RTL8192EU,
396 	HARDWARE_TYPE_RTL8192ES,
397 	HARDWARE_TYPE_RTL8812E,
398 	HARDWARE_TYPE_RTL8812AU,
399 	HARDWARE_TYPE_RTL8811AU,
400 	HARDWARE_TYPE_RTL8821E,
401 	HARDWARE_TYPE_RTL8821U,
402 	HARDWARE_TYPE_RTL8821S,
403 	HARDWARE_TYPE_RTL8723BE,
404 	HARDWARE_TYPE_RTL8723BU,
405 	HARDWARE_TYPE_RTL8723BS,
406 	HARDWARE_TYPE_RTL8814AE,
407 	HARDWARE_TYPE_RTL8814AU,
408 	HARDWARE_TYPE_RTL8814AS,
409 	HARDWARE_TYPE_RTL8821BE,
410 	HARDWARE_TYPE_RTL8821BU,
411 	HARDWARE_TYPE_RTL8821BS,
412 	HARDWARE_TYPE_RTL8822BE,
413 	HARDWARE_TYPE_RTL8822BU,
414 	HARDWARE_TYPE_RTL8822BS,
415 	HARDWARE_TYPE_RTL8703BE,
416 	HARDWARE_TYPE_RTL8703BU,
417 	HARDWARE_TYPE_RTL8703BS,
418 	HARDWARE_TYPE_RTL8188FE,
419 	HARDWARE_TYPE_RTL8188FU,
420 	HARDWARE_TYPE_RTL8188FS,
421 	HARDWARE_TYPE_MAX,
422 }HARDWARE_TYPE;
423 
424 #define IS_NEW_GENERATION_IC(_Adapter)	(rtw_get_hw_type(_Adapter) >= HARDWARE_TYPE_RTL8192EE)
425 //
426 // RTL8188E Series
427 //
428 #define IS_HARDWARE_TYPE_8188EE(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EE)
429 #define IS_HARDWARE_TYPE_8188EU(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EU)
430 #define IS_HARDWARE_TYPE_8188ES(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188ES)
431 #define	IS_HARDWARE_TYPE_8188E(_Adapter)	\
432 (IS_HARDWARE_TYPE_8188EE(_Adapter) || IS_HARDWARE_TYPE_8188EU(_Adapter) || IS_HARDWARE_TYPE_8188ES(_Adapter))
433 
434 // RTL8812 Series
435 #define IS_HARDWARE_TYPE_8812E(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812E)
436 #define IS_HARDWARE_TYPE_8812AU(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812AU)
437 #define IS_HARDWARE_TYPE_8812(_Adapter)			\
438 (IS_HARDWARE_TYPE_8812E(_Adapter) || IS_HARDWARE_TYPE_8812AU(_Adapter))
439 
440 // RTL8821 Series
441 #define IS_HARDWARE_TYPE_8821E(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821E)
442 #define IS_HARDWARE_TYPE_8811AU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
443 #define IS_HARDWARE_TYPE_8821U(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821U ||	\
444 													rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
445 #define IS_HARDWARE_TYPE_8821S(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821S)
446 #define IS_HARDWARE_TYPE_8821(_Adapter)			\
447 (IS_HARDWARE_TYPE_8821E(_Adapter) || IS_HARDWARE_TYPE_8821U(_Adapter)|| IS_HARDWARE_TYPE_8821S(_Adapter))
448 
449 #define IS_HARDWARE_TYPE_JAGUAR(_Adapter)		\
450 (IS_HARDWARE_TYPE_8812(_Adapter) || IS_HARDWARE_TYPE_8821(_Adapter))
451 
452 //RTL8192E Series
453 #define IS_HARDWARE_TYPE_8192EE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EE)
454 #define IS_HARDWARE_TYPE_8192EU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EU)
455 #define IS_HARDWARE_TYPE_8192ES(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192ES)
456 
457 #define IS_HARDWARE_TYPE_8192E(_Adapter)		\
458 (IS_HARDWARE_TYPE_8192EE(_Adapter) || IS_HARDWARE_TYPE_8192EU(_Adapter) ||IS_HARDWARE_TYPE_8192ES(_Adapter))
459 
460 #define IS_HARDWARE_TYPE_8723BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BE)
461 #define IS_HARDWARE_TYPE_8723BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BU)
462 #define IS_HARDWARE_TYPE_8723BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BS)
463 
464 #define IS_HARDWARE_TYPE_8723B(_Adapter) \
465 	(IS_HARDWARE_TYPE_8723BE(_Adapter) || IS_HARDWARE_TYPE_8723BU(_Adapter) ||IS_HARDWARE_TYPE_8723BS(_Adapter))
466 
467 /* RTL8814A Series */
468 #define IS_HARDWARE_TYPE_8814AE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AE)
469 #define IS_HARDWARE_TYPE_8814AU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AU)
470 #define IS_HARDWARE_TYPE_8814AS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AS)
471 
472 #define IS_HARDWARE_TYPE_8814A(_Adapter)		\
473 (IS_HARDWARE_TYPE_8814AE(_Adapter) || IS_HARDWARE_TYPE_8814AU(_Adapter) || IS_HARDWARE_TYPE_8814AS(_Adapter))
474 
475 #define IS_HARDWARE_TYPE_JAGUAR2(_Adapter)		\
476 (IS_HARDWARE_TYPE_8814A(_Adapter) || IS_HARDWARE_TYPE_8821B(_Adapter) || IS_HARDWARE_TYPE_8822B(_Adapter))
477 
478 #define IS_HARDWARE_TYPE_JAGUAR_AND_JAGUAR2(_Adapter)		\
479 (IS_HARDWARE_TYPE_JAGUAR(_Adapter) || IS_HARDWARE_TYPE_JAGUAR2(_Adapter))
480 
481 /* RTL8703B Series */
482 #define IS_HARDWARE_TYPE_8703BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BE)
483 #define IS_HARDWARE_TYPE_8703BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BS)
484 #define IS_HARDWARE_TYPE_8703BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BU)
485 #define	IS_HARDWARE_TYPE_8703B(_Adapter)			\
486 (IS_HARDWARE_TYPE_8703BE(_Adapter) || IS_HARDWARE_TYPE_8703BU(_Adapter) || IS_HARDWARE_TYPE_8703BS(_Adapter))
487 
488 /* RTL8188F Series */
489 #define IS_HARDWARE_TYPE_8188FE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FE)
490 #define IS_HARDWARE_TYPE_8188FS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FS)
491 #define IS_HARDWARE_TYPE_8188FU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FU)
492 #define	IS_HARDWARE_TYPE_8188F(_Adapter)			\
493 (IS_HARDWARE_TYPE_8188FE(_Adapter) || IS_HARDWARE_TYPE_8188FU(_Adapter) || IS_HARDWARE_TYPE_8188FS(_Adapter))
494 
495 #define IS_HARDWARE_TYPE_8821BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BE)
496 #define IS_HARDWARE_TYPE_8821BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BU)
497 #define IS_HARDWARE_TYPE_8821BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BS)
498 
499 #define IS_HARDWARE_TYPE_8821B(_Adapter)		\
500 (IS_HARDWARE_TYPE_8821BE(_Adapter) || IS_HARDWARE_TYPE_8821BU(_Adapter) || IS_HARDWARE_TYPE_8821BS(_Adapter))
501 
502 #define IS_HARDWARE_TYPE_8822BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BE)
503 #define IS_HARDWARE_TYPE_8822BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BU)
504 #define IS_HARDWARE_TYPE_8822BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BS)
505 #define IS_HARDWARE_TYPE_8822B(_Adapter)		\
506 (IS_HARDWARE_TYPE_8822BE(_Adapter) || IS_HARDWARE_TYPE_8822BU(_Adapter) || IS_HARDWARE_TYPE_8822BS(_Adapter))
507 
508 
509 
510 typedef enum _wowlan_subcode {
511 	WOWLAN_ENABLE			= 0,
512 	WOWLAN_DISABLE			= 1,
513 	WOWLAN_AP_ENABLE		= 2,
514 	WOWLAN_AP_DISABLE		= 3,
515 	WOWLAN_PATTERN_CLEAN		= 4
516 } wowlan_subcode;
517 
518 struct wowlan_ioctl_param{
519 	unsigned int subcode;
520 	unsigned int subcode_value;
521 	unsigned int wakeup_reason;
522 };
523 
524 #define Rx_Pairwisekey			0x01
525 #define Rx_GTK					0x02
526 #define Rx_DisAssoc				0x04
527 #define Rx_DeAuth				0x08
528 #define Rx_ARPReq				0x09
529 #define FWDecisionDisconnect	0x10
530 #define Rx_MagicPkt				0x21
531 #define Rx_UnicastPkt			0x22
532 #define Rx_PatternPkt			0x23
533 #define	RX_PNOWakeUp			0x55
534 #define	AP_WakeUp			0x66
535 
536 u8 rtw_hal_data_init(_adapter *padapter);
537 void rtw_hal_data_deinit(_adapter *padapter);
538 
539 void rtw_hal_def_value_init(_adapter *padapter);
540 
541 void	rtw_hal_free_data(_adapter *padapter);
542 
543 void rtw_hal_dm_init(_adapter *padapter);
544 void rtw_hal_dm_deinit(_adapter *padapter);
545 void rtw_hal_sw_led_init(_adapter *padapter);
546 void rtw_hal_sw_led_deinit(_adapter *padapter);
547 
548 u32 rtw_hal_power_on(_adapter *padapter);
549 void rtw_hal_power_off(_adapter *padapter);
550 
551 uint rtw_hal_init(_adapter *padapter);
552 uint rtw_hal_deinit(_adapter *padapter);
553 void rtw_hal_stop(_adapter *padapter);
554 void rtw_hal_set_hwreg(PADAPTER padapter, u8 variable, u8 *val);
555 void rtw_hal_get_hwreg(PADAPTER padapter, u8 variable, u8 *val);
556 
557 #ifdef CONFIG_C2H_PACKET_EN
558 void rtw_hal_set_hwreg_with_buf(_adapter *padapter, u8 variable, u8 *pbuf, int len);
559 #endif
560 
561 void rtw_hal_chip_configure(_adapter *padapter);
562 void rtw_hal_read_chip_info(_adapter *padapter);
563 void rtw_hal_read_chip_version(_adapter *padapter);
564 
565 u8 rtw_hal_set_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
566 u8 rtw_hal_get_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
567 
568 void rtw_hal_set_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1,BOOLEAN bSet);
569 void	rtw_hal_get_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1,PVOID pValue2);
570 
571 void rtw_hal_enable_interrupt(_adapter *padapter);
572 void rtw_hal_disable_interrupt(_adapter *padapter);
573 
574 u8 rtw_hal_check_ips_status(_adapter *padapter);
575 
576 #if defined(CONFIG_USB_HCI)||defined(CONFIG_PCI_HCI)
577 u32	rtw_hal_inirp_init(_adapter *padapter);
578 u32	rtw_hal_inirp_deinit(_adapter *padapter);
579 #endif
580 
581 #if defined(CONFIG_PCI_HCI)
582 void	rtw_hal_irp_reset(_adapter *padapter);
583 #endif
584 
585 u8	rtw_hal_intf_ps_func(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id, u8* val);
586 
587 s32	rtw_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
588 s32	rtw_hal_xmit(_adapter *padapter, struct xmit_frame *pxmitframe);
589 s32	rtw_hal_mgnt_xmit(_adapter *padapter, struct xmit_frame *pmgntframe);
590 
591 s32	rtw_hal_init_xmit_priv(_adapter *padapter);
592 void	rtw_hal_free_xmit_priv(_adapter *padapter);
593 
594 s32	rtw_hal_init_recv_priv(_adapter *padapter);
595 void	rtw_hal_free_recv_priv(_adapter *padapter);
596 
597 void rtw_hal_update_ra_mask(struct sta_info *psta, u8 rssi_level);
598 void	rtw_hal_add_ra_tid(_adapter *padapter, u64 bitmap, u8 *arg, u8 rssi_level);
599 
600 void	rtw_hal_start_thread(_adapter *padapter);
601 void	rtw_hal_stop_thread(_adapter *padapter);
602 
603 void rtw_hal_bcn_related_reg_setting(_adapter *padapter);
604 
605 u32	rtw_hal_read_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask);
606 void	rtw_hal_write_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
607 u32	rtw_hal_read_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
608 void	rtw_hal_write_rfreg(_adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
609 
610 #define PHY_QueryBBReg(Adapter, RegAddr, BitMask) rtw_hal_read_bbreg((Adapter), (RegAddr), (BitMask))
611 #define PHY_SetBBReg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_bbreg((Adapter), (RegAddr), (BitMask), (Data))
612 #define PHY_QueryRFReg(Adapter, eRFPath, RegAddr, BitMask) rtw_hal_read_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask))
613 #define PHY_SetRFReg(Adapter, eRFPath, RegAddr, BitMask, Data) rtw_hal_write_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask), (Data))
614 
615 #define PHY_SetMacReg	PHY_SetBBReg
616 #define PHY_QueryMacReg PHY_QueryBBReg
617 
618 #if defined(CONFIG_PCI_HCI)
619 s32	rtw_hal_interrupt_handler(_adapter *padapter);
620 #endif
621 #if  defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
622 void	rtw_hal_interrupt_handler(_adapter *padapter, u16 pkt_len, u8 *pbuf);
623 #endif
624 
625 void	rtw_hal_set_bwmode(_adapter *padapter, CHANNEL_WIDTH Bandwidth, u8 Offset);
626 void	rtw_hal_set_chan(_adapter *padapter, u8 channel);
627 void	rtw_hal_set_chnl_bw(_adapter *padapter, u8 channel, CHANNEL_WIDTH Bandwidth, u8 Offset40, u8 Offset80);
628 void	rtw_hal_dm_watchdog(_adapter *padapter);
629 void	rtw_hal_dm_watchdog_in_lps(_adapter *padapter);
630 
631 void	rtw_hal_set_tx_power_level(_adapter *padapter, u8 channel);
632 void	rtw_hal_get_tx_power_level(_adapter *padapter, s32 *powerlevel);
633 
634 #ifdef CONFIG_HOSTAPD_MLME
635 s32	rtw_hal_hostap_mgnt_xmit_entry(_adapter *padapter, _pkt *pkt);
636 #endif
637 
638 #ifdef DBG_CONFIG_ERROR_DETECT
639 void rtw_hal_sreset_init(_adapter *padapter);
640 void rtw_hal_sreset_reset(_adapter *padapter);
641 void rtw_hal_sreset_reset_value(_adapter *padapter);
642 void rtw_hal_sreset_xmit_status_check(_adapter *padapter);
643 void rtw_hal_sreset_linked_status_check (_adapter *padapter);
644 u8   rtw_hal_sreset_get_wifi_status(_adapter *padapter);
645 bool rtw_hal_sreset_inprogress(_adapter *padapter);
646 #endif
647 
648 #ifdef CONFIG_IOL
649 int rtw_hal_iol_cmd(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
650 #endif
651 
652 #ifdef CONFIG_XMIT_THREAD_MODE
653 s32 rtw_hal_xmit_thread_handler(_adapter *padapter);
654 #endif
655 
656 void rtw_hal_notch_filter(_adapter * adapter, bool enable);
657 
658 bool rtw_hal_c2h_valid(_adapter *adapter, u8 *buf);
659 s32 rtw_hal_c2h_evt_read(_adapter *adapter, u8 *buf);
660 s32 rtw_hal_c2h_handler(_adapter *adapter, u8 *c2h_evt);
661 c2h_id_filter rtw_hal_c2h_id_filter_ccx(_adapter *adapter);
662 
663 s32 rtw_hal_is_disable_sw_channel_plan(PADAPTER padapter);
664 
665 s32 rtw_hal_macid_sleep(PADAPTER padapter, u8 macid);
666 s32 rtw_hal_macid_wakeup(PADAPTER padapter, u8 macid);
667 
668 s32 rtw_hal_fill_h2c_cmd(PADAPTER padapter, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
669 void rtw_hal_fill_fake_txdesc(_adapter *padapter, u8 *pDesc, u32 BufferLen,
670 		u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
671 u8 rtw_hal_get_txbuff_rsvd_page_num(_adapter *adapter, bool wowlan);
672 
673 #ifdef CONFIG_GPIO_API
674 void rtw_hal_update_hisr_hsisr_ind(_adapter *padapter, u32 flag);
675 int rtw_hal_gpio_func_check(_adapter *padapter, u8 gpio_num);
676 void rtw_hal_gpio_multi_func_reset(_adapter *padapter, u8 gpio_num);
677 #endif
678 
679 void rtw_hal_fw_correct_bcn(_adapter *padapter);
680 s32 rtw_hal_fw_dl(_adapter *padapter, u8 wowlan);
681 
682 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
683 void rtw_hal_clear_interrupt(_adapter *padapter);
684 #endif
685 u8 rtw_hal_ops_check(_adapter *padapter);
686 
687 #endif //__HAL_INTF_H__
688 
689