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