xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rtl8188fu/include/hal_intf.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
3  *
4  * Copyright(c) 2007 - 2017 Realtek Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of version 2 of the GNU General Public License as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13  * more details.
14  *
15  *****************************************************************************/
16 #ifndef __HAL_INTF_H__
17 #define __HAL_INTF_H__
18 
19 
20 enum RTL871X_HCI_TYPE {
21 	RTW_PCIE	= BIT0,
22 	RTW_USB	= BIT1,
23 	RTW_SDIO	= BIT2,
24 	RTW_GSPI	= BIT3,
25 };
26 
27 enum _CHIP_TYPE {
28 
29 	NULL_CHIP_TYPE,
30 	RTL8188E,
31 	RTL8192E,
32 	RTL8812,
33 	RTL8821, /* RTL8811 */
34 	RTL8723B,
35 	RTL8814A,
36 	RTL8703B,
37 	RTL8188F,
38 	RTL8188GTV,
39 	RTL8822B,
40 	RTL8723D,
41 	RTL8821C,
42 	RTL8710B,
43 	RTL8192F,
44 	RTL8822C,
45 	MAX_CHIP_TYPE
46 };
47 
48 #ifdef RTW_HALMAC
49 enum fw_mem {
50 	FW_EMEM,
51 	FW_IMEM,
52 	FW_DMEM,
53 };
54 #endif
55 
56 extern const u32 _chip_type_to_odm_ic_type[];
57 #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)])
58 
59 typedef enum _HAL_HW_TIMER_TYPE {
60 	HAL_TIMER_NONE = 0,
61 	HAL_TIMER_TXBF = 1,
62 	HAL_TIMER_EARLYMODE = 2,
63 } HAL_HW_TIMER_TYPE, *PHAL_HW_TIMER_TYPE;
64 
65 
66 typedef enum _HW_VARIABLES {
67 	HW_VAR_MEDIA_STATUS,
68 	HW_VAR_SET_OPMODE,
69 	HW_VAR_MAC_ADDR,
70 	HW_VAR_BSSID,
71 	HW_VAR_INIT_RTS_RATE,
72 	HW_VAR_BASIC_RATE,
73 	HW_VAR_TXPAUSE,
74 	HW_VAR_BCN_FUNC,
75 	HW_VAR_BCN_CTRL_ADDR,
76 	HW_VAR_CORRECT_TSF,
77 	HW_VAR_RCR,
78 	HW_VAR_MLME_DISCONNECT,
79 	HW_VAR_MLME_SITESURVEY,
80 	HW_VAR_MLME_JOIN,
81 	HW_VAR_ON_RCR_AM,
82 	HW_VAR_OFF_RCR_AM,
83 	HW_VAR_BEACON_INTERVAL,
84 	HW_VAR_SLOT_TIME,
85 	HW_VAR_RESP_SIFS,
86 	HW_VAR_ACK_PREAMBLE,
87 	HW_VAR_SEC_CFG,
88 	HW_VAR_SEC_DK_CFG,
89 	HW_VAR_BCN_VALID,
90 	HW_VAR_RF_TYPE,
91 	HW_VAR_FREECNT,
92 
93 	/* PHYDM odm->SupportAbility */
94 	HW_VAR_CAM_EMPTY_ENTRY,
95 	HW_VAR_CAM_INVALID_ALL,
96 	HW_VAR_AC_PARAM_VO,
97 	HW_VAR_AC_PARAM_VI,
98 	HW_VAR_AC_PARAM_BE,
99 	HW_VAR_AC_PARAM_BK,
100 	HW_VAR_ACM_CTRL,
101 #ifdef CONFIG_WMMPS_STA
102 	HW_VAR_UAPSD_TID,
103 #endif /* CONFIG_WMMPS_STA */
104 	HW_VAR_AMPDU_MIN_SPACE,
105 #ifdef CONFIG_80211N_HT
106 	HW_VAR_AMPDU_FACTOR,
107 #endif /* CONFIG_80211N_HT */
108 	HW_VAR_RXDMA_AGG_PG_TH,
109 	HW_VAR_SET_RPWM,
110 	HW_VAR_CPWM,
111 	HW_VAR_H2C_FW_PWRMODE,
112 	HW_VAR_H2C_INACTIVE_IPS,
113 	HW_VAR_H2C_PS_TUNE_PARAM,
114 	HW_VAR_H2C_FW_JOINBSSRPT,
115 	HW_VAR_FWLPS_RF_ON,
116 	HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
117 #ifdef CONFIG_LPS_POFF
118 	HW_VAR_LPS_POFF_INIT,
119 	HW_VAR_LPS_POFF_DEINIT,
120 	HW_VAR_LPS_POFF_SET_MODE,
121 	HW_VAR_LPS_POFF_WOW_EN,
122 #endif
123 #ifdef CONFIG_LPS_PG
124 	HW_VAR_LPS_PG_HANDLE,
125 #endif
126 	HW_VAR_TRIGGER_GPIO_0,
127 	HW_VAR_BT_SET_COEXIST,
128 	HW_VAR_BT_ISSUE_DELBA,
129 	HW_VAR_SWITCH_EPHY_WoWLAN,
130 	HW_VAR_EFUSE_USAGE,
131 	HW_VAR_EFUSE_BYTES,
132 	HW_VAR_EFUSE_BT_USAGE,
133 	HW_VAR_EFUSE_BT_BYTES,
134 	HW_VAR_FIFO_CLEARN_UP,
135 	HW_VAR_RESTORE_HW_SEQ,
136 	HW_VAR_CHECK_TXBUF,
137 	HW_VAR_PCIE_STOP_TX_DMA,
138 	HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, power control for MAC only */
139 	HW_VAR_HCI_SUS_STATE,
140 	/* 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. */
141 	/* Unit in microsecond. 0 means disable this function. */
142 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
143 	HW_VAR_WOWLAN,
144 	HW_VAR_WAKEUP_REASON,
145 #endif
146 	HW_VAR_RPWM_TOG,
147 #ifdef CONFIG_GPIO_WAKEUP
148 	HW_VAR_WOW_OUTPUT_GPIO,
149 	HW_VAR_WOW_INPUT_GPIO,
150 	HW_SET_GPIO_WL_CTRL,
151 #endif
152 	HW_VAR_SYS_CLKR,
153 	HW_VAR_NAV_UPPER,
154 	HW_VAR_RPT_TIMER_SETTING,
155 	HW_VAR_TX_RPT_MAX_MACID,
156 	HW_VAR_CHK_HI_QUEUE_EMPTY,
157 	HW_VAR_CHK_MGQ_CPU_EMPTY,
158 	HW_VAR_DL_BCN_SEL,
159 	HW_VAR_AMPDU_MAX_TIME,
160 	HW_VAR_WIRELESS_MODE,
161 	HW_VAR_USB_MODE,
162 	HW_VAR_PORT_SWITCH,
163 	HW_VAR_PORT_CFG,
164 	HW_VAR_DO_IQK,
165 	HW_VAR_DM_IN_LPS_LCLK,/*flag CONFIG_LPS_LCLK_WD_TIMER*/
166 	HW_VAR_SET_REQ_FW_PS,
167 	HW_VAR_FW_PS_STATE,
168 	HW_VAR_SOUNDING_ENTER,
169 	HW_VAR_SOUNDING_LEAVE,
170 	HW_VAR_SOUNDING_RATE,
171 	HW_VAR_SOUNDING_STATUS,
172 	HW_VAR_SOUNDING_FW_NDPA,
173 	HW_VAR_SOUNDING_CLK,
174 	HW_VAR_SOUNDING_SET_GID_TABLE,
175 	HW_VAR_SOUNDING_CSI_REPORT,
176 	/*Add by YuChen for TXBF HW timer*/
177 	HW_VAR_HW_REG_TIMER_INIT,
178 	HW_VAR_HW_REG_TIMER_RESTART,
179 	HW_VAR_HW_REG_TIMER_START,
180 	HW_VAR_HW_REG_TIMER_STOP,
181 	/*Add by YuChen for TXBF HW timer*/
182 	HW_VAR_DL_RSVD_PAGE,
183 	HW_VAR_MACID_LINK,
184 	HW_VAR_MACID_NOLINK,
185 	HW_VAR_DUMP_MAC_QUEUE_INFO,
186 	HW_VAR_ASIX_IOT,
187 #ifdef CONFIG_MBSSID_CAM
188 	HW_VAR_MBSSID_CAM_WRITE,
189 	HW_VAR_MBSSID_CAM_CLEAR,
190 	HW_VAR_RCR_MBSSID_EN,
191 #endif
192 	HW_VAR_EN_HW_UPDATE_TSF,
193 	HW_VAR_CH_SW_NEED_TO_TAKE_CARE_IQK_INFO,
194 	HW_VAR_CH_SW_IQK_INFO_BACKUP,
195 	HW_VAR_CH_SW_IQK_INFO_RESTORE,
196 
197 	HW_VAR_DBI,
198 	HW_VAR_MDIO,
199 	HW_VAR_L1OFF_CAPABILITY,
200 	HW_VAR_L1OFF_NIC_SUPPORT,
201 #ifdef CONFIG_TDLS
202 #ifdef CONFIG_TDLS_CH_SW
203 	HW_VAR_TDLS_BCN_EARLY_C2H_RPT,
204 #endif
205 #endif
206 	HW_VAR_DUMP_MAC_TXFIFO,
207 	HW_VAR_PWR_CMD,
208 #ifdef CONFIG_FW_HANDLE_TXBCN
209 	HW_VAR_BCN_HEAD_SEL,
210 #endif
211 	HW_VAR_SET_SOML_PARAM,
212 	HW_VAR_ENABLE_RX_BAR,
213 	HW_VAR_TSF_AUTO_SYNC,
214 	HW_VAR_LPS_STATE_CHK,
215 	#ifdef CONFIG_RTS_FULL_BW
216 	HW_VAR_SET_RTS_BW,
217 	#endif
218 #if defined(CONFIG_PCI_HCI)
219 	HW_VAR_ENSWBCN,
220 #endif
221 } HW_VARIABLES;
222 
223 typedef enum _HAL_DEF_VARIABLE {
224 	HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
225 	HAL_DEF_IS_SUPPORT_ANT_DIV,
226 	HAL_DEF_DRVINFO_SZ,
227 	HAL_DEF_MAX_RECVBUF_SZ,
228 	HAL_DEF_RX_PACKET_OFFSET,
229 	HAL_DEF_RX_DMA_SZ_WOW,
230 	HAL_DEF_RX_DMA_SZ,
231 	HAL_DEF_RX_PAGE_SIZE,
232 	HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
233 	HAL_DEF_RA_DECISION_RATE,
234 	HAL_DEF_RA_SGI,
235 	HAL_DEF_PT_PWR_STATUS,
236 	HAL_DEF_TX_LDPC,				/* LDPC support */
237 	HAL_DEF_RX_LDPC,				/* LDPC support */
238 	HAL_DEF_TX_STBC,				/* TX STBC support */
239 	HAL_DEF_RX_STBC,				/* RX STBC support */
240 	HAL_DEF_EXPLICIT_BEAMFORMER,/* Explicit  Compressed Steering Capable */
241 	HAL_DEF_EXPLICIT_BEAMFORMEE,/* Explicit Compressed Beamforming Feedback Capable */
242 	HAL_DEF_VHT_MU_BEAMFORMER,	/* VHT MU Beamformer support */
243 	HAL_DEF_VHT_MU_BEAMFORMEE,	/* VHT MU Beamformee support */
244 	HAL_DEF_BEAMFORMER_CAP,
245 	HAL_DEF_BEAMFORMEE_CAP,
246 	HW_VAR_MAX_RX_AMPDU_FACTOR,
247 	HW_DEF_RA_INFO_DUMP,
248 	HAL_DEF_DBG_DUMP_TXPKT,
249 
250 	HAL_DEF_TX_PAGE_SIZE,
251 	HAL_DEF_TX_PAGE_BOUNDARY,
252 	HAL_DEF_TX_PAGE_BOUNDARY_WOWLAN,
253 	HAL_DEF_ANT_DETECT,/* to do for 8723a */
254 	HAL_DEF_PCI_SUUPORT_L1_BACKDOOR, /* Determine if the L1 Backdoor setting is turned on. */
255 	HAL_DEF_PCI_AMD_L1_SUPPORT,
256 	HAL_DEF_PCI_ASPM_OSC, /* Support for ASPM OSC, added by Roger, 2013.03.27. */
257 	HAL_DEF_EFUSE_USAGE,	/* Get current EFUSE utilization. 2008.12.19. Added by Roger. */
258 	HAL_DEF_EFUSE_BYTES,
259 	HW_VAR_BEST_AMPDU_DENSITY,
260 } HAL_DEF_VARIABLE;
261 
262 typedef enum _HAL_ODM_VARIABLE {
263 	HAL_ODM_STA_INFO,
264 	HAL_ODM_P2P_STATE,
265 	HAL_ODM_WIFI_DISPLAY_STATE,
266 	HAL_ODM_REGULATION,
267 	HAL_ODM_INITIAL_GAIN,
268 	HAL_ODM_RX_INFO_DUMP,
269 	HAL_ODM_RX_Dframe_INFO,
270 #ifdef CONFIG_ANTENNA_DIVERSITY
271 	HAL_ODM_ANTDIV_SELECT
272 #endif
273 } HAL_ODM_VARIABLE;
274 
275 typedef enum _HAL_INTF_PS_FUNC {
276 	HAL_USB_SELECT_SUSPEND,
277 	HAL_MAX_ID,
278 } HAL_INTF_PS_FUNC;
279 
280 typedef s32(*c2h_id_filter)(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
281 
282 struct txpwr_idx_comp;
283 
284 struct hal_ops {
285 	/*** initialize section ***/
286 	void	(*read_chip_version)(_adapter *padapter);
287 	void	(*init_default_value)(_adapter *padapter);
288 	void	(*intf_chip_configure)(_adapter *padapter);
289 	u8	(*read_adapter_info)(_adapter *padapter);
290 	u32(*hal_power_on)(_adapter *padapter);
291 	void	(*hal_power_off)(_adapter *padapter);
292 	u32(*hal_init)(_adapter *padapter);
293 	u32(*hal_deinit)(_adapter *padapter);
294 	void	(*dm_init)(_adapter *padapter);
295 	void	(*dm_deinit)(_adapter *padapter);
296 
297 	/*** xmit section ***/
298 	s32(*init_xmit_priv)(_adapter *padapter);
299 	void	(*free_xmit_priv)(_adapter *padapter);
300 	s32(*hal_xmit)(_adapter *padapter, struct xmit_frame *pxmitframe);
301 	/*
302 	 * mgnt_xmit should be implemented to run in interrupt context
303 	 */
304 	s32(*mgnt_xmit)(_adapter *padapter, struct xmit_frame *pmgntframe);
305 	s32(*hal_xmitframe_enqueue)(_adapter *padapter, struct xmit_frame *pxmitframe);
306 #ifdef CONFIG_XMIT_THREAD_MODE
307 	s32(*xmit_thread_handler)(_adapter *padapter);
308 #endif
309 	void	(*run_thread)(_adapter *padapter);
310 	void	(*cancel_thread)(_adapter *padapter);
311 
312 	/*** recv section ***/
313 	s32(*init_recv_priv)(_adapter *padapter);
314 	void	(*free_recv_priv)(_adapter *padapter);
315 #ifdef CONFIG_RECV_THREAD_MODE
316 	s32 (*recv_hdl)(_adapter *adapter);
317 #endif
318 #if defined(CONFIG_USB_HCI) || defined(CONFIG_PCI_HCI)
319 	u32(*inirp_init)(_adapter *padapter);
320 	u32(*inirp_deinit)(_adapter *padapter);
321 #endif
322 	/*** interrupt hdl section ***/
323 	void	(*enable_interrupt)(_adapter *padapter);
324 	void	(*disable_interrupt)(_adapter *padapter);
325 	u8(*check_ips_status)(_adapter *padapter);
326 #if defined(CONFIG_PCI_HCI)
327 	s32(*interrupt_handler)(_adapter *padapter);
328 	void (*unmap_beacon_icf)(_adapter *padapter);
329 #endif
330 
331 #if defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
332 	void	(*interrupt_handler)(_adapter *padapter, u16 pkt_len, u8 *pbuf);
333 #endif
334 
335 #if defined(CONFIG_PCI_HCI)
336 	void	(*irp_reset)(_adapter *padapter);
337 #endif
338 
339 	/*** DM section ***/
340 #ifdef CONFIG_RTW_SW_LED
341 	void	(*InitSwLeds)(_adapter *padapter);
342 	void	(*DeInitSwLeds)(_adapter *padapter);
343 #endif
344 	void	(*set_chnl_bw_handler)(_adapter *padapter, u8 channel, enum channel_width Bandwidth, u8 Offset40, u8 Offset80);
345 
346 	void (*set_tx_power_level_handler)(_adapter *adapter, u8 channel);
347 	void (*set_txpwr_done)(_adapter *adapter);
348 	void (*set_tx_power_index_handler)(_adapter *adapter, u32 powerindex, enum rf_path rfpath, u8 rate);
349 	u8 (*get_tx_power_index_handler)(_adapter *adapter, enum rf_path rfpath, u8 rate, u8 bandwidth, u8 channel, struct txpwr_idx_comp *tic);
350 
351 	void	(*hal_dm_watchdog)(_adapter *padapter);
352 
353 	u8	(*set_hw_reg_handler)(_adapter *padapter, u8	variable, u8 *val);
354 
355 	void	(*GetHwRegHandler)(_adapter *padapter, u8	variable, u8 *val);
356 
357 
358 
359 	u8 (*get_hal_def_var_handler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void *pValue);
360 
361 	u8(*SetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void *pValue);
362 
363 	void	(*GetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void *pValue1, void *pValue2);
364 	void	(*SetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void *pValue1, BOOLEAN bSet);
365 
366 	void	(*SetBeaconRelatedRegistersHandler)(_adapter *padapter);
367 
368 	u8(*interface_ps_func)(_adapter *padapter, HAL_INTF_PS_FUNC efunc_id, u8 *val);
369 
370 	u32(*read_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask);
371 	void	(*write_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
372 	u32 (*read_rfreg)(_adapter *padapter, enum rf_path eRFPath, u32 RegAddr, u32 BitMask);
373 	void	(*write_rfreg)(_adapter *padapter, enum rf_path eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
374 #ifdef CONFIG_SYSON_INDIRECT_ACCESS
375 	u32 (*read_syson_reg)(_adapter *padapter, u32 RegAddr, u32 BitMask);
376 	void (*write_syson_reg)(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
377 #endif
378 	void (*read_wmmedca_reg)(_adapter *padapter, u16 *vo_params, u16 *vi_params, u16 *be_params, u16 *bk_params);
379 
380 #ifdef CONFIG_HOSTAPD_MLME
381 	s32(*hostap_mgnt_xmit_entry)(_adapter *padapter, _pkt *pkt);
382 #endif
383 
384 	void (*EfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
385 	void (*BTEfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
386 	void (*ReadEFuse)(_adapter *padapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, BOOLEAN bPseudoTest);
387 	void (*EFUSEGetEfuseDefinition)(_adapter *padapter, u8 efuseType, u8 type, void *pOut, BOOLEAN bPseudoTest);
388 	u16(*EfuseGetCurrentSize)(_adapter *padapter, u8 efuseType, BOOLEAN bPseudoTest);
389 	int	(*Efuse_PgPacketRead)(_adapter *padapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
390 	int	(*Efuse_PgPacketWrite)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
391 	u8(*Efuse_WordEnableDataWrite)(_adapter *padapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
392 	BOOLEAN(*Efuse_PgPacketWrite_BT)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
393 #if defined(CONFIG_RTL8710B)
394 	BOOLEAN(*efuse_indirect_read4)(_adapter *padapter, u16 regaddr, u8 *value);
395 #endif
396 
397 #ifdef DBG_CONFIG_ERROR_DETECT
398 	void (*sreset_init_value)(_adapter *padapter);
399 	void (*sreset_reset_value)(_adapter *padapter);
400 	void (*silentreset)(_adapter *padapter);
401 	void (*sreset_xmit_status_check)(_adapter *padapter);
402 	void (*sreset_linked_status_check)(_adapter *padapter);
403 	u8(*sreset_get_wifi_status)(_adapter *padapter);
404 	bool (*sreset_inprogress)(_adapter *padapter);
405 #endif
406 
407 #ifdef CONFIG_IOL
408 	int (*IOL_exec_cmds_sync)(_adapter *padapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
409 #endif
410 
411 	void (*hal_notch_filter)(_adapter *adapter, bool enable);
412 #ifdef RTW_HALMAC
413 	void (*hal_mac_c2h_handler)(_adapter *adapter, u8 *pbuf, u16 length);
414 #else
415 	s32(*c2h_handler)(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
416 #endif
417 	void (*reqtxrpt)(_adapter *padapter, u8 macid);
418 	s32(*fill_h2c_cmd)(PADAPTER, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
419 	void (*fill_fake_txdesc)(PADAPTER, u8 *pDesc, u32 BufferLen,
420 				 u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
421 	s32(*fw_dl)(_adapter *adapter, u8 wowlan);
422 #ifdef RTW_HALMAC
423 	s32 (*fw_mem_dl)(_adapter *adapter, enum fw_mem mem);
424 #endif
425 
426 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) || defined(CONFIG_PCI_HCI)
427 	void (*clear_interrupt)(_adapter *padapter);
428 #endif
429 	u8(*hal_get_tx_buff_rsvd_page_num)(_adapter *adapter, bool wowlan);
430 #ifdef CONFIG_GPIO_API
431 	void (*update_hisr_hsisr_ind)(PADAPTER padapter, u32 flag);
432 	int (*hal_gpio_func_check)(_adapter *padapter, u8 gpio_num);
433 	void (*hal_gpio_multi_func_reset)(_adapter *padapter, u8 gpio_num);
434 #endif
435 #ifdef CONFIG_FW_CORRECT_BCN
436 	void (*fw_correct_bcn)(PADAPTER padapter);
437 #endif
438 
439 #ifdef RTW_HALMAC
440 	u8(*init_mac_register)(PADAPTER);
441 	u8(*init_phy)(PADAPTER);
442 #endif /* RTW_HALMAC */
443 
444 #ifdef CONFIG_PCI_HCI
445 	void (*hal_set_l1ssbackdoor_handler)(_adapter *padapter, u8 enable);
446 #endif
447 
448 #ifdef CONFIG_RFKILL_POLL
449 	bool (*hal_radio_onoff_check)(_adapter *adapter, u8 *valid);
450 #endif
451 #ifdef CONFIG_PCI_TX_POLLING
452 	void (*tx_poll_handler)(_adapter *adapter);
453 #endif
454 };
455 
456 typedef	enum _RT_EEPROM_TYPE {
457 	EEPROM_93C46,
458 	EEPROM_93C56,
459 	EEPROM_BOOT_EFUSE,
460 } RT_EEPROM_TYPE, *PRT_EEPROM_TYPE;
461 
462 
463 
464 #define RF_CHANGE_BY_INIT	0
465 #define RF_CHANGE_BY_IPS	BIT28
466 #define RF_CHANGE_BY_PS	BIT29
467 #define RF_CHANGE_BY_HW	BIT30
468 #define RF_CHANGE_BY_SW	BIT31
469 
470 typedef enum _HARDWARE_TYPE {
471 	HARDWARE_TYPE_RTL8188EE,
472 	HARDWARE_TYPE_RTL8188EU,
473 	HARDWARE_TYPE_RTL8188ES,
474 	/*	NEW_GENERATION_IC */
475 	HARDWARE_TYPE_RTL8192EE,
476 	HARDWARE_TYPE_RTL8192EU,
477 	HARDWARE_TYPE_RTL8192ES,
478 	HARDWARE_TYPE_RTL8812E,
479 	HARDWARE_TYPE_RTL8812AU,
480 	HARDWARE_TYPE_RTL8811AU,
481 	HARDWARE_TYPE_RTL8821E,
482 	HARDWARE_TYPE_RTL8821U,
483 	HARDWARE_TYPE_RTL8821S,
484 	HARDWARE_TYPE_RTL8723BE,
485 	HARDWARE_TYPE_RTL8723BU,
486 	HARDWARE_TYPE_RTL8723BS,
487 	HARDWARE_TYPE_RTL8814AE,
488 	HARDWARE_TYPE_RTL8814AU,
489 	HARDWARE_TYPE_RTL8814AS,
490 	HARDWARE_TYPE_RTL8821BE,
491 	HARDWARE_TYPE_RTL8821BU,
492 	HARDWARE_TYPE_RTL8821BS,
493 	HARDWARE_TYPE_RTL8822BE,
494 	HARDWARE_TYPE_RTL8822BU,
495 	HARDWARE_TYPE_RTL8822BS,
496 	HARDWARE_TYPE_RTL8703BE,
497 	HARDWARE_TYPE_RTL8703BU,
498 	HARDWARE_TYPE_RTL8703BS,
499 	HARDWARE_TYPE_RTL8188FE,
500 	HARDWARE_TYPE_RTL8188FU,
501 	HARDWARE_TYPE_RTL8188FS,
502 	HARDWARE_TYPE_RTL8188GTVU,
503 	HARDWARE_TYPE_RTL8188GTVS,
504 	HARDWARE_TYPE_RTL8723DE,
505 	HARDWARE_TYPE_RTL8723DU,
506 	HARDWARE_TYPE_RTL8723DS,
507 	HARDWARE_TYPE_RTL8821CE,
508 	HARDWARE_TYPE_RTL8821CU,
509 	HARDWARE_TYPE_RTL8821CS,
510 	HARDWARE_TYPE_RTL8710BU,
511 	HARDWARE_TYPE_RTL8192FS,
512 	HARDWARE_TYPE_RTL8192FU,
513 	HARDWARE_TYPE_RTL8192FE,
514 	HARDWARE_TYPE_RTL8822CE,
515 	HARDWARE_TYPE_RTL8822CU,
516 	HARDWARE_TYPE_RTL8822CS,
517 	HARDWARE_TYPE_RTL8814BE,
518 	HARDWARE_TYPE_RTL8814BU,
519 	HARDWARE_TYPE_RTL8814BS,
520 	HARDWARE_TYPE_MAX,
521 } HARDWARE_TYPE;
522 
523 #define IS_NEW_GENERATION_IC(_Adapter)	(rtw_get_hw_type(_Adapter) >= HARDWARE_TYPE_RTL8192EE)
524 /*
525  * RTL8188E Series
526  *   */
527 #define IS_HARDWARE_TYPE_8188EE(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EE)
528 #define IS_HARDWARE_TYPE_8188EU(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EU)
529 #define IS_HARDWARE_TYPE_8188ES(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188ES)
530 #define	IS_HARDWARE_TYPE_8188E(_Adapter)	\
531 	(IS_HARDWARE_TYPE_8188EE(_Adapter) || IS_HARDWARE_TYPE_8188EU(_Adapter) || IS_HARDWARE_TYPE_8188ES(_Adapter))
532 
533 /* RTL8812 Series */
534 #define IS_HARDWARE_TYPE_8812E(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812E)
535 #define IS_HARDWARE_TYPE_8812AU(_Adapter)	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812AU)
536 #define IS_HARDWARE_TYPE_8812(_Adapter)			\
537 	(IS_HARDWARE_TYPE_8812E(_Adapter) || IS_HARDWARE_TYPE_8812AU(_Adapter))
538 
539 /* RTL8821 Series */
540 #define IS_HARDWARE_TYPE_8821E(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821E)
541 #define IS_HARDWARE_TYPE_8811AU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
542 #define IS_HARDWARE_TYPE_8821U(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821U || \
543 		rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
544 #define IS_HARDWARE_TYPE_8821S(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821S)
545 #define IS_HARDWARE_TYPE_8821(_Adapter)			\
546 	(IS_HARDWARE_TYPE_8821E(_Adapter) || IS_HARDWARE_TYPE_8821U(_Adapter) || IS_HARDWARE_TYPE_8821S(_Adapter))
547 
548 #define IS_HARDWARE_TYPE_JAGUAR(_Adapter)		\
549 	(IS_HARDWARE_TYPE_8812(_Adapter) || IS_HARDWARE_TYPE_8821(_Adapter))
550 
551 /* RTL8192E Series */
552 #define IS_HARDWARE_TYPE_8192EE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EE)
553 #define IS_HARDWARE_TYPE_8192EU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EU)
554 #define IS_HARDWARE_TYPE_8192ES(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192ES)
555 
556 #define IS_HARDWARE_TYPE_8192E(_Adapter)		\
557 	(IS_HARDWARE_TYPE_8192EE(_Adapter) || IS_HARDWARE_TYPE_8192EU(_Adapter) || IS_HARDWARE_TYPE_8192ES(_Adapter))
558 
559 #define IS_HARDWARE_TYPE_8723BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BE)
560 #define IS_HARDWARE_TYPE_8723BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BU)
561 #define IS_HARDWARE_TYPE_8723BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BS)
562 
563 #define IS_HARDWARE_TYPE_8723B(_Adapter) \
564 	(IS_HARDWARE_TYPE_8723BE(_Adapter) || IS_HARDWARE_TYPE_8723BU(_Adapter) || IS_HARDWARE_TYPE_8723BS(_Adapter))
565 
566 /* RTL8814A Series */
567 #define IS_HARDWARE_TYPE_8814AE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AE)
568 #define IS_HARDWARE_TYPE_8814AU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AU)
569 #define IS_HARDWARE_TYPE_8814AS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AS)
570 
571 #define IS_HARDWARE_TYPE_8814A(_Adapter)		\
572 	(IS_HARDWARE_TYPE_8814AE(_Adapter) || IS_HARDWARE_TYPE_8814AU(_Adapter) || IS_HARDWARE_TYPE_8814AS(_Adapter))
573 
574 /* RTL8703B Series */
575 #define IS_HARDWARE_TYPE_8703BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BE)
576 #define IS_HARDWARE_TYPE_8703BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BS)
577 #define IS_HARDWARE_TYPE_8703BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BU)
578 #define	IS_HARDWARE_TYPE_8703B(_Adapter)			\
579 	(IS_HARDWARE_TYPE_8703BE(_Adapter) || IS_HARDWARE_TYPE_8703BU(_Adapter) || IS_HARDWARE_TYPE_8703BS(_Adapter))
580 
581 /* RTL8723D Series */
582 #define IS_HARDWARE_TYPE_8723DE(_Adapter)\
583 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DE)
584 #define IS_HARDWARE_TYPE_8723DS(_Adapter)\
585 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DS)
586 #define IS_HARDWARE_TYPE_8723DU(_Adapter)\
587 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DU)
588 #define	IS_HARDWARE_TYPE_8723D(_Adapter)\
589 	(IS_HARDWARE_TYPE_8723DE(_Adapter) || \
590 	 IS_HARDWARE_TYPE_8723DU(_Adapter) || \
591 	 IS_HARDWARE_TYPE_8723DS(_Adapter))
592 
593 /* RTL8192F Series */
594 #define IS_HARDWARE_TYPE_8192FS(_Adapter)\
595 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192FS)
596 #define IS_HARDWARE_TYPE_8192FU(_Adapter)\
597 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192FU)
598 #define IS_HARDWARE_TYPE_8192FE(_Adapter)\
599 	(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192FE)
600 #define	IS_HARDWARE_TYPE_8192F(_Adapter)\
601 	(IS_HARDWARE_TYPE_8192FS(_Adapter) ||\
602 	 IS_HARDWARE_TYPE_8192FU(_Adapter) ||\
603 	 IS_HARDWARE_TYPE_8192FE(_Adapter))
604 
605 /* RTL8188F Series */
606 #define IS_HARDWARE_TYPE_8188FE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FE)
607 #define IS_HARDWARE_TYPE_8188FS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FS)
608 #define IS_HARDWARE_TYPE_8188FU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FU)
609 #define	IS_HARDWARE_TYPE_8188F(_Adapter)			\
610 	(IS_HARDWARE_TYPE_8188FE(_Adapter) || IS_HARDWARE_TYPE_8188FU(_Adapter) || IS_HARDWARE_TYPE_8188FS(_Adapter))
611 
612 #define IS_HARDWARE_TYPE_8188GTVU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188GTVU)
613 #define IS_HARDWARE_TYPE_8188GTVS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188GTVS)
614 #define	IS_HARDWARE_TYPE_8188GTV(_Adapter)			\
615 	(IS_HARDWARE_TYPE_8188GTVU(_Adapter) || IS_HARDWARE_TYPE_8188GTVS(_Adapter))
616 
617 /* RTL8710B Series */
618 #define IS_HARDWARE_TYPE_8710BU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8710BU)
619 #define IS_HARDWARE_TYPE_8710B(_Adapter) (IS_HARDWARE_TYPE_8710BU(_Adapter))
620 
621 #define IS_HARDWARE_TYPE_8821BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BE)
622 #define IS_HARDWARE_TYPE_8821BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BU)
623 #define IS_HARDWARE_TYPE_8821BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BS)
624 
625 #define IS_HARDWARE_TYPE_8821B(_Adapter)		\
626 	(IS_HARDWARE_TYPE_8821BE(_Adapter) || IS_HARDWARE_TYPE_8821BU(_Adapter) || IS_HARDWARE_TYPE_8821BS(_Adapter))
627 
628 #define IS_HARDWARE_TYPE_8822BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BE)
629 #define IS_HARDWARE_TYPE_8822BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BU)
630 #define IS_HARDWARE_TYPE_8822BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BS)
631 #define IS_HARDWARE_TYPE_8822B(_Adapter)		\
632 	(IS_HARDWARE_TYPE_8822BE(_Adapter) || IS_HARDWARE_TYPE_8822BU(_Adapter) || IS_HARDWARE_TYPE_8822BS(_Adapter))
633 
634 #define IS_HARDWARE_TYPE_8821CE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CE)
635 #define IS_HARDWARE_TYPE_8821CU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CU)
636 #define IS_HARDWARE_TYPE_8821CS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CS)
637 #define IS_HARDWARE_TYPE_8821C(_Adapter)		\
638 	(IS_HARDWARE_TYPE_8821CE(_Adapter) || IS_HARDWARE_TYPE_8821CU(_Adapter) || IS_HARDWARE_TYPE_8821CS(_Adapter))
639 
640 #define IS_HARDWARE_TYPE_8822CE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822CE)
641 #define IS_HARDWARE_TYPE_8822CU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822CU)
642 #define IS_HARDWARE_TYPE_8822CS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822CS)
643 #define IS_HARDWARE_TYPE_8822C(_Adapter)		\
644 	(IS_HARDWARE_TYPE_8822CE(_Adapter) || IS_HARDWARE_TYPE_8822CU(_Adapter) || IS_HARDWARE_TYPE_8822CS(_Adapter))
645 
646 #define IS_HARDWARE_TYPE_8814BE(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814BE)
647 #define IS_HARDWARE_TYPE_8814BU(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814BU)
648 #define IS_HARDWARE_TYPE_8814BS(_Adapter)		(rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814BS)
649 #define IS_HARDWARE_TYPE_8814B(_Adapter)		\
650 		(IS_HARDWARE_TYPE_8814BE(_Adapter) || IS_HARDWARE_TYPE_8814BU(_Adapter) || IS_HARDWARE_TYPE_8814BS(_Adapter))
651 
652 #define IS_HARDWARE_TYPE_JAGUAR2(_Adapter)		\
653 	(IS_HARDWARE_TYPE_8814A(_Adapter) || IS_HARDWARE_TYPE_8821B(_Adapter) || IS_HARDWARE_TYPE_8822B(_Adapter) || IS_HARDWARE_TYPE_8821C(_Adapter))
654 
655 #define IS_HARDWARE_TYPE_JAGUAR_AND_JAGUAR2(_Adapter)		\
656 	(IS_HARDWARE_TYPE_JAGUAR(_Adapter) || IS_HARDWARE_TYPE_JAGUAR2(_Adapter))
657 
658 #define IS_HARDWARE_TYPE_JAGUAR3(_Adapter)		\
659 	(IS_HARDWARE_TYPE_8814B(_Adapter) || IS_HARDWARE_TYPE_8822C(_Adapter))
660 
661 #define IS_HARDWARE_TYPE_JAGUAR_ALL(_Adapter)		\
662 	(IS_HARDWARE_TYPE_JAGUAR_AND_JAGUAR2(_Adapter) || IS_HARDWARE_TYPE_JAGUAR3(_Adapter))
663 
664 
665 typedef enum _wowlan_subcode {
666 	WOWLAN_ENABLE			= 0,
667 	WOWLAN_DISABLE			= 1,
668 	WOWLAN_AP_ENABLE		= 2,
669 	WOWLAN_AP_DISABLE		= 3,
670 	WOWLAN_PATTERN_CLEAN		= 4
671 } wowlan_subcode;
672 
673 struct wowlan_ioctl_param {
674 	unsigned int subcode;
675 	unsigned int subcode_value;
676 	unsigned int wakeup_reason;
677 };
678 
679 u8 rtw_hal_data_init(_adapter *padapter);
680 void rtw_hal_data_deinit(_adapter *padapter);
681 
682 void rtw_hal_def_value_init(_adapter *padapter);
683 
684 void	rtw_hal_free_data(_adapter *padapter);
685 
686 void rtw_hal_dm_init(_adapter *padapter);
687 void rtw_hal_dm_deinit(_adapter *padapter);
688 #ifdef CONFIG_RTW_SW_LED
689 void rtw_hal_sw_led_init(_adapter *padapter);
690 void rtw_hal_sw_led_deinit(_adapter *padapter);
691 #endif
692 u32 rtw_hal_power_on(_adapter *padapter);
693 void rtw_hal_power_off(_adapter *padapter);
694 
695 uint rtw_hal_init(_adapter *padapter);
696 #ifdef CONFIG_NEW_NETDEV_HDL
697 uint rtw_hal_iface_init(_adapter *adapter);
698 #endif
699 uint rtw_hal_deinit(_adapter *padapter);
700 void rtw_hal_stop(_adapter *padapter);
701 u8 rtw_hal_set_hwreg(PADAPTER padapter, u8 variable, u8 *val);
702 void rtw_hal_get_hwreg(PADAPTER padapter, u8 variable, u8 *val);
703 
704 void rtw_hal_chip_configure(_adapter *padapter);
705 u8 rtw_hal_read_chip_info(_adapter *padapter);
706 void rtw_hal_read_chip_version(_adapter *padapter);
707 
708 u8 rtw_hal_set_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void *pValue);
709 u8 rtw_hal_get_def_var(_adapter *padapter, HAL_DEF_VARIABLE eVariable, void *pValue);
710 
711 void rtw_hal_set_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void *pValue1, BOOLEAN bSet);
712 void	rtw_hal_get_odm_var(_adapter *padapter, HAL_ODM_VARIABLE eVariable, void *pValue1, void *pValue2);
713 
714 void rtw_hal_enable_interrupt(_adapter *padapter);
715 void rtw_hal_disable_interrupt(_adapter *padapter);
716 
717 u8 rtw_hal_check_ips_status(_adapter *padapter);
718 
719 #if defined(CONFIG_USB_HCI) || defined(CONFIG_PCI_HCI)
720 	u32	rtw_hal_inirp_init(_adapter *padapter);
721 	u32	rtw_hal_inirp_deinit(_adapter *padapter);
722 #endif
723 
724 #if defined(CONFIG_PCI_HCI)
725 	void	rtw_hal_irp_reset(_adapter *padapter);
726 void	rtw_hal_pci_dbi_write(_adapter *padapter, u16 addr, u8 data);
727 u8	rtw_hal_pci_dbi_read(_adapter *padapter, u16 addr);
728 void	rtw_hal_pci_mdio_write(_adapter *padapter, u8 addr, u16 data);
729 u16	rtw_hal_pci_mdio_read(_adapter *padapter, u8 addr);
730 u8	rtw_hal_pci_l1off_nic_support(_adapter *padapter);
731 u8	rtw_hal_pci_l1off_capability(_adapter *padapter);
732 #endif
733 
734 u8	rtw_hal_intf_ps_func(_adapter *padapter, HAL_INTF_PS_FUNC efunc_id, u8 *val);
735 
736 s32	rtw_hal_xmitframe_enqueue(_adapter *padapter, struct xmit_frame *pxmitframe);
737 s32	rtw_hal_xmit(_adapter *padapter, struct xmit_frame *pxmitframe);
738 s32	rtw_hal_mgnt_xmit(_adapter *padapter, struct xmit_frame *pmgntframe);
739 
740 s32	rtw_hal_init_xmit_priv(_adapter *padapter);
741 void	rtw_hal_free_xmit_priv(_adapter *padapter);
742 
743 s32	rtw_hal_init_recv_priv(_adapter *padapter);
744 void	rtw_hal_free_recv_priv(_adapter *padapter);
745 
746 void rtw_hal_update_ra_mask(struct sta_info *psta);
747 
748 void	rtw_hal_start_thread(_adapter *padapter);
749 void	rtw_hal_stop_thread(_adapter *padapter);
750 
751 void rtw_hal_bcn_related_reg_setting(_adapter *padapter);
752 
753 u32	rtw_hal_read_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask);
754 void	rtw_hal_write_bbreg(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
755 u32	rtw_hal_read_rfreg(_adapter *padapter, enum rf_path eRFPath, u32 RegAddr, u32 BitMask);
756 void	rtw_hal_write_rfreg(_adapter *padapter, enum rf_path eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
757 
758 
759 #define phy_query_bb_reg(Adapter, RegAddr, BitMask) rtw_hal_read_bbreg((Adapter), (RegAddr), (BitMask))
760 #define phy_set_bb_reg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_bbreg((Adapter), (RegAddr), (BitMask), (Data))
761 #define phy_query_rf_reg(Adapter, eRFPath, RegAddr, BitMask) rtw_hal_read_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask))
762 #define phy_set_rf_reg(Adapter, eRFPath, RegAddr, BitMask, Data) rtw_hal_write_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask), (Data))
763 
764 #ifdef CONFIG_SYSON_INDIRECT_ACCESS
765 u32 rtw_hal_read_syson_reg(PADAPTER padapter, u32 RegAddr, u32 BitMask);
766 void rtw_hal_write_syson_reg(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
767 #define hal_query_syson_reg(Adapter, RegAddr, BitMask) rtw_hal_read_syson_reg((Adapter), (RegAddr), (BitMask))
768 #define hal_set_syson_reg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_syson_reg((Adapter), (RegAddr), (BitMask), (Data))
769 #endif
770 
771 #define phy_set_mac_reg	phy_set_bb_reg
772 #define phy_query_mac_reg phy_query_bb_reg
773 
774 #if defined(CONFIG_PCI_HCI)
775 	s32	rtw_hal_interrupt_handler(_adapter *padapter);
776 	void	rtw_hal_unmap_beacon_icf(_adapter *padapter);
777 #endif
778 #if  defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
779 	void	rtw_hal_interrupt_handler(_adapter *padapter, u16 pkt_len, u8 *pbuf);
780 #endif
781 
782 void	rtw_hal_set_chnl_bw(_adapter *padapter, u8 channel, enum channel_width Bandwidth, u8 Offset40, u8 Offset80);
783 void	rtw_hal_dm_watchdog(_adapter *padapter);
784 void	rtw_hal_dm_watchdog_in_lps(_adapter *padapter);
785 
786 #ifdef CONFIG_HOSTAPD_MLME
787 	s32	rtw_hal_hostap_mgnt_xmit_entry(_adapter *padapter, _pkt *pkt);
788 #endif
789 
790 #ifdef DBG_CONFIG_ERROR_DETECT
791 void rtw_hal_sreset_init(_adapter *padapter);
792 void rtw_hal_sreset_reset(_adapter *padapter);
793 void rtw_hal_sreset_reset_value(_adapter *padapter);
794 void rtw_hal_sreset_xmit_status_check(_adapter *padapter);
795 void rtw_hal_sreset_linked_status_check(_adapter *padapter);
796 u8   rtw_hal_sreset_get_wifi_status(_adapter *padapter);
797 bool rtw_hal_sreset_inprogress(_adapter *padapter);
798 #endif
799 
800 #ifdef CONFIG_IOL
801 int rtw_hal_iol_cmd(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
802 #endif
803 
804 #ifdef CONFIG_XMIT_THREAD_MODE
805 s32 rtw_hal_xmit_thread_handler(_adapter *padapter);
806 #endif
807 
808 #ifdef CONFIG_RECV_THREAD_MODE
809 s32 rtw_hal_recv_hdl(_adapter *adapter);
810 #endif
811 
812 void rtw_hal_notch_filter(_adapter *adapter, bool enable);
813 
814 #ifdef CONFIG_FW_C2H_REG
815 bool rtw_hal_c2h_reg_hdr_parse(_adapter *adapter, u8 *buf, u8 *id, u8 *seq, u8 *plen, u8 **payload);
816 bool rtw_hal_c2h_valid(_adapter *adapter, u8 *buf);
817 s32 rtw_hal_c2h_evt_read(_adapter *adapter, u8 *buf);
818 #endif
819 
820 #ifdef CONFIG_FW_C2H_PKT
821 bool rtw_hal_c2h_pkt_hdr_parse(_adapter *adapter, u8 *buf, u16 len, u8 *id, u8 *seq, u8 *plen, u8 **payload);
822 #endif
823 
824 s32 c2h_handler(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
825 #ifndef RTW_HALMAC
826 s32 rtw_hal_c2h_handler(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
827 s32 rtw_hal_c2h_id_handle_directly(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
828 #endif
829 
830 s32 rtw_hal_is_disable_sw_channel_plan(PADAPTER padapter);
831 
832 s32 rtw_hal_macid_sleep(_adapter *adapter, u8 macid);
833 s32 rtw_hal_macid_wakeup(_adapter *adapter, u8 macid);
834 s32 rtw_hal_macid_sleep_all_used(_adapter *adapter);
835 s32 rtw_hal_macid_wakeup_all_used(_adapter *adapter);
836 
837 s32 rtw_hal_macid_drop(_adapter *adapter, u8 macid);
838 s32 rtw_hal_macid_undrop(_adapter *adapter, u8 macid);
839 
840 s32 rtw_hal_fill_h2c_cmd(PADAPTER padapter, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
841 void rtw_hal_fill_fake_txdesc(_adapter *padapter, u8 *pDesc, u32 BufferLen,
842 			      u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
843 u8 rtw_hal_get_txbuff_rsvd_page_num(_adapter *adapter, bool wowlan);
844 
845 #ifdef CONFIG_GPIO_API
846 void rtw_hal_update_hisr_hsisr_ind(_adapter *padapter, u32 flag);
847 int rtw_hal_gpio_func_check(_adapter *padapter, u8 gpio_num);
848 void rtw_hal_gpio_multi_func_reset(_adapter *padapter, u8 gpio_num);
849 #endif
850 #ifdef CONFIG_FW_CORRECT_BCN
851 void rtw_hal_fw_correct_bcn(_adapter *padapter);
852 #endif
853 s32 rtw_hal_fw_dl(_adapter *padapter, u8 wowlan);
854 
855 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
856 	void rtw_hal_clear_interrupt(_adapter *padapter);
857 #endif
858 
859 void rtw_hal_set_tx_power_level(_adapter *adapter, u8 channel);
860 void rtw_hal_set_txpwr_done(_adapter *adapter);
861 void rtw_hal_set_tx_power_index(_adapter *adapter, u32 powerindex
862 	, enum rf_path rfpath, u8 rate);
863 u8 rtw_hal_get_tx_power_index(_adapter *adapter, enum rf_path rfpath, u8 rate
864 	, u8 bandwidth, u8 channel, struct txpwr_idx_comp *tic);
865 
866 u8 rtw_hal_ops_check(_adapter *padapter);
867 
868 #ifdef RTW_HALMAC
869 	u8 rtw_hal_init_mac_register(PADAPTER);
870 	u8 rtw_hal_init_phy(PADAPTER);
871 s32 rtw_hal_fw_mem_dl(_adapter *padapter, enum fw_mem mem);
872 #endif /* RTW_HALMAC */
873 
874 #ifdef CONFIG_RFKILL_POLL
875 bool rtw_hal_rfkill_poll(_adapter *adapter, u8 *valid);
876 #endif
877 
878 #endif /* __HAL_INTF_H__ */
879