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