1 /******************************************************************************
3 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19 ******************************************************************************/
20 #ifndef __HAL_INTF_H__
21 #define __HAL_INTF_H__
24 enum RTL871X_HCI_TYPE {
37 RTL8821, /* RTL8811 */
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)])
51 typedef enum _HAL_HW_TIMER_TYPE {
54 HAL_TIMER_EARLYMODE = 2,
55 } HAL_HW_TIMER_TYPE, *PHAL_HW_TIMER_TYPE;
58 typedef enum _HW_VARIABLES {
69 HW_VAR_MLME_DISCONNECT,
70 HW_VAR_MLME_SITESURVEY,
74 HW_VAR_BEACON_INTERVAL,
82 /* PHYDM odm->SupportAbility */
83 HW_VAR_CAM_EMPTY_ENTRY,
84 HW_VAR_CAM_INVALID_ALL,
93 HW_VAR_AMPDU_MIN_SPACE,
95 HW_VAR_RXDMA_AGG_PG_TH,
98 HW_VAR_H2C_FW_PWRMODE,
99 HW_VAR_H2C_PS_TUNE_PARAM,
100 HW_VAR_H2C_FW_JOINBSSRPT,
102 HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
103 #ifdef CONFIG_LPS_POFF
104 HW_VAR_LPS_POFF_INIT,
105 HW_VAR_LPS_POFF_DEINIT,
106 HW_VAR_LPS_POFF_SET_MODE,
107 HW_VAR_LPS_POFF_WOW_EN,
110 HW_VAR_LPS_PG_HANDLE,
112 HW_VAR_TRIGGER_GPIO_0,
113 HW_VAR_BT_SET_COEXIST,
114 HW_VAR_BT_ISSUE_DELBA,
115 HW_VAR_SWITCH_EPHY_WoWLAN,
118 HW_VAR_EFUSE_BT_USAGE,
119 HW_VAR_EFUSE_BT_BYTES,
120 HW_VAR_FIFO_CLEARN_UP,
121 HW_VAR_RESTORE_HW_SEQ,
123 HW_VAR_PCIE_STOP_TX_DMA,
124 HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, power control for MAC only */
125 HW_VAR_HCI_SUS_STATE,
126 /* 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. */
127 /* Unit in microsecond. 0 means disable this function. */
128 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
130 HW_VAR_WAKEUP_REASON,
133 #ifdef CONFIG_GPIO_WAKEUP
138 HW_VAR_RPT_TIMER_SETTING,
139 HW_VAR_TX_RPT_MAX_MACID,
140 HW_VAR_CHK_HI_QUEUE_EMPTY,
142 HW_VAR_AMPDU_MAX_TIME,
143 HW_VAR_WIRELESS_MODE,
148 HW_VAR_SET_REQ_FW_PS,
150 HW_VAR_SOUNDING_ENTER,
151 HW_VAR_SOUNDING_LEAVE,
152 HW_VAR_SOUNDING_RATE,
153 HW_VAR_SOUNDING_STATUS,
154 HW_VAR_SOUNDING_FW_NDPA,
156 HW_VAR_SOUNDING_SET_GID_TABLE,
157 HW_VAR_SOUNDING_CSI_REPORT,
158 /*Add by YuChen for TXBF HW timer*/
159 HW_VAR_HW_REG_TIMER_INIT,
160 HW_VAR_HW_REG_TIMER_RESTART,
161 HW_VAR_HW_REG_TIMER_START,
162 HW_VAR_HW_REG_TIMER_STOP,
163 /*Add by YuChen for TXBF HW timer*/
169 HW_VAR_DUMP_MAC_QUEUE_INFO,
171 #ifdef CONFIG_MBSSID_CAM
172 HW_VAR_MBSSID_CAM_WRITE,
173 HW_VAR_MBSSID_CAM_CLEAR,
174 HW_VAR_RCR_MBSSID_EN,
176 HW_VAR_EN_HW_UPDATE_TSF,
177 HW_VAR_CH_SW_NEED_TO_TAKE_CARE_IQK_INFO,
178 HW_VAR_CH_SW_IQK_INFO_BACKUP,
179 HW_VAR_CH_SW_IQK_INFO_RESTORE,
183 #ifdef CONFIG_TDLS_CH_SW
184 HW_VAR_TDLS_BCN_EARLY_C2H_RPT
189 typedef enum _HAL_DEF_VARIABLE {
190 HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
191 HAL_DEF_IS_SUPPORT_ANT_DIV,
193 HAL_DEF_MAX_RECVBUF_SZ,
194 HAL_DEF_RX_PACKET_OFFSET,
195 HAL_DEF_RX_DMA_SZ_WOW,
197 HAL_DEF_RX_PAGE_SIZE,
198 HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
199 HAL_DEF_RA_DECISION_RATE,
201 HAL_DEF_PT_PWR_STATUS,
202 HAL_DEF_TX_LDPC, /* LDPC support */
203 HAL_DEF_RX_LDPC, /* LDPC support */
204 HAL_DEF_TX_STBC, /* TX STBC support */
205 HAL_DEF_RX_STBC, /* RX STBC support */
206 HAL_DEF_EXPLICIT_BEAMFORMER,/* Explicit Compressed Steering Capable */
207 HAL_DEF_EXPLICIT_BEAMFORMEE,/* Explicit Compressed Beamforming Feedback Capable */
208 HAL_DEF_VHT_MU_BEAMFORMER, /* VHT MU Beamformer support */
209 HAL_DEF_VHT_MU_BEAMFORMEE, /* VHT MU Beamformee support */
210 HAL_DEF_BEAMFORMER_CAP,
211 HAL_DEF_BEAMFORMEE_CAP,
212 HW_VAR_MAX_RX_AMPDU_FACTOR,
214 HAL_DEF_DBG_DUMP_TXPKT,
216 HAL_DEF_TX_PAGE_SIZE,
217 HAL_DEF_TX_PAGE_BOUNDARY,
218 HAL_DEF_TX_PAGE_BOUNDARY_WOWLAN,
219 HAL_DEF_ANT_DETECT,/* to do for 8723a */
220 HAL_DEF_PCI_SUUPORT_L1_BACKDOOR, /* Determine if the L1 Backdoor setting is turned on. */
221 HAL_DEF_PCI_AMD_L1_SUPPORT,
222 HAL_DEF_PCI_ASPM_OSC, /* Support for ASPM OSC, added by Roger, 2013.03.27. */
223 HAL_DEF_MACID_SLEEP, /* Support for MACID sleep */
224 HAL_DEF_DBG_DIS_PWT, /* disable Tx power training or not. */
225 HAL_DEF_EFUSE_USAGE, /* Get current EFUSE utilization. 2008.12.19. Added by Roger. */
227 HW_VAR_BEST_AMPDU_DENSITY,
230 typedef enum _HAL_ODM_VARIABLE {
233 HAL_ODM_WIFI_DISPLAY_STATE,
234 HAL_ODM_NOISE_MONITOR,
236 HAL_ODM_INITIAL_GAIN,
240 HAL_ODM_RX_INFO_DUMP,
241 HAL_ODM_RX_Dframe_INFO,
242 #ifdef CONFIG_AUTO_CHNL_SEL_NHM
243 HAL_ODM_AUTO_CHNL_SEL,
245 #ifdef CONFIG_ANTENNA_DIVERSITY
246 HAL_ODM_ANTDIV_SELECT
250 typedef enum _HAL_INTF_PS_FUNC {
251 HAL_USB_SELECT_SUSPEND,
255 typedef s32(*c2h_id_filter)(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
257 struct txpwr_idx_comp;
271 /*** initialize section ***/
272 void (*read_chip_version)(_adapter *padapter);
273 void (*init_default_value)(_adapter *padapter);
274 void (*intf_chip_configure)(_adapter *padapter);
275 u8 (*read_adapter_info)(_adapter *padapter);
276 u32(*hal_power_on)(_adapter *padapter);
277 void (*hal_power_off)(_adapter *padapter);
278 u32(*hal_init)(_adapter *padapter);
279 u32(*hal_deinit)(_adapter *padapter);
280 void (*dm_init)(_adapter *padapter);
281 void (*dm_deinit)(_adapter *padapter);
283 /*** xmit section ***/
284 s32(*init_xmit_priv)(_adapter *padapter);
285 void (*free_xmit_priv)(_adapter *padapter);
286 s32(*hal_xmit)(_adapter *padapter, struct xmit_frame *pxmitframe);
288 * mgnt_xmit should be implemented to run in interrupt context
290 s32(*mgnt_xmit)(_adapter *padapter, struct xmit_frame *pmgntframe);
291 s32(*hal_xmitframe_enqueue)(_adapter *padapter, struct xmit_frame *pxmitframe);
292 #ifdef CONFIG_XMIT_THREAD_MODE
293 s32(*xmit_thread_handler)(_adapter *padapter);
295 void (*run_thread)(_adapter *padapter);
296 void (*cancel_thread)(_adapter *padapter);
298 /*** recv section ***/
299 s32(*init_recv_priv)(_adapter *padapter);
300 void (*free_recv_priv)(_adapter *padapter);
301 #ifdef CONFIG_RECV_THREAD_MODE
302 s32 (*recv_hdl)(_adapter *adapter);
304 #if defined(CONFIG_USB_HCI) || defined(CONFIG_PCI_HCI)
305 u32(*inirp_init)(_adapter *padapter);
306 u32(*inirp_deinit)(_adapter *padapter);
308 /*** interrupt hdl section ***/
309 void (*enable_interrupt)(_adapter *padapter);
310 void (*disable_interrupt)(_adapter *padapter);
311 u8(*check_ips_status)(_adapter *padapter);
312 #if defined(CONFIG_PCI_HCI)
313 s32(*interrupt_handler)(_adapter *padapter);
316 #if defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
317 void (*interrupt_handler)(_adapter *padapter, u16 pkt_len, u8 *pbuf);
320 #if defined(CONFIG_PCI_HCI)
321 void (*irp_reset)(_adapter *padapter);
326 void (*InitSwLeds)(_adapter *padapter);
327 void (*DeInitSwLeds)(_adapter *padapter);
329 void (*set_chnl_bw_handler)(_adapter *padapter, u8 channel, CHANNEL_WIDTH Bandwidth, u8 Offset40, u8 Offset80);
331 void (*set_tx_power_level_handler)(_adapter *padapter, u8 channel);
332 void (*get_tx_power_level_handler)(_adapter *padapter, s32 *powerlevel);
334 void (*set_tx_power_index_handler)(_adapter *padapter, u32 powerindex, u8 rfpath, u8 rate);
335 u8(*get_tx_power_index_handler)(_adapter *padapter, u8 rfpath, u8 rate, u8 bandwidth, u8 channel, struct txpwr_idx_comp *tic);
337 void (*hal_dm_watchdog)(_adapter *padapter);
338 #ifdef CONFIG_LPS_LCLK_WD_TIMER
339 void (*hal_dm_watchdog_in_lps)(_adapter *padapter);
343 void (*set_hw_reg_handler)(_adapter *padapter, u8 variable, u8 *val);
345 void (*GetHwRegHandler)(_adapter *padapter, u8 variable, u8 *val);
349 u8 (*get_hal_def_var_handler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
351 u8(*SetHalDefVarHandler)(_adapter *padapter, HAL_DEF_VARIABLE eVariable, PVOID pValue);
353 void (*GetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1, PVOID pValue2);
354 void (*SetHalODMVarHandler)(_adapter *padapter, HAL_ODM_VARIABLE eVariable, PVOID pValue1, BOOLEAN bSet);
356 void (*update_ra_mask_handler)(_adapter *padapter, struct sta_info *psta, struct macid_cfg *h2c_macid_cfg);
357 void (*SetBeaconRelatedRegistersHandler)(_adapter *padapter);
359 u8(*interface_ps_func)(_adapter *padapter, HAL_INTF_PS_FUNC efunc_id, u8 *val);
361 u32(*read_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask);
362 void (*write_bbreg)(_adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
363 u32(*read_rfreg)(_adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask);
364 void (*write_rfreg)(_adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
366 #ifdef CONFIG_HOSTAPD_MLME
367 s32(*hostap_mgnt_xmit_entry)(_adapter *padapter, _pkt *pkt);
370 void (*EfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
371 void (*BTEfusePowerSwitch)(_adapter *padapter, u8 bWrite, u8 PwrState);
372 void (*ReadEFuse)(_adapter *padapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, BOOLEAN bPseudoTest);
373 void (*EFUSEGetEfuseDefinition)(_adapter *padapter, u8 efuseType, u8 type, void *pOut, BOOLEAN bPseudoTest);
374 u16(*EfuseGetCurrentSize)(_adapter *padapter, u8 efuseType, BOOLEAN bPseudoTest);
375 int (*Efuse_PgPacketRead)(_adapter *padapter, u8 offset, u8 *data, BOOLEAN bPseudoTest);
376 int (*Efuse_PgPacketWrite)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
377 u8(*Efuse_WordEnableDataWrite)(_adapter *padapter, u16 efuse_addr, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
378 BOOLEAN(*Efuse_PgPacketWrite_BT)(_adapter *padapter, u8 offset, u8 word_en, u8 *data, BOOLEAN bPseudoTest);
380 #ifdef DBG_CONFIG_ERROR_DETECT
381 void (*sreset_init_value)(_adapter *padapter);
382 void (*sreset_reset_value)(_adapter *padapter);
383 void (*silentreset)(_adapter *padapter);
384 void (*sreset_xmit_status_check)(_adapter *padapter);
385 void (*sreset_linked_status_check)(_adapter *padapter);
386 u8(*sreset_get_wifi_status)(_adapter *padapter);
387 bool (*sreset_inprogress)(_adapter *padapter);
391 int (*IOL_exec_cmds_sync)(_adapter *padapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
394 void (*hal_notch_filter)(_adapter *adapter, bool enable);
396 void (*hal_mac_c2h_handler)(_adapter *adapter, u8 *pbuf, u16 length);
398 s32(*c2h_handler)(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
400 void (*reqtxrpt)(_adapter *padapter, u8 macid);
401 s32(*fill_h2c_cmd)(PADAPTER, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
402 void (*fill_fake_txdesc)(PADAPTER, u8 *pDesc, u32 BufferLen,
403 u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
404 s32(*fw_dl)(_adapter *adapter, u8 wowlan);
406 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) || defined(CONFIG_PCI_HCI)
407 void (*clear_interrupt)(_adapter *padapter);
409 u8(*hal_get_tx_buff_rsvd_page_num)(_adapter *adapter, bool wowlan);
410 #ifdef CONFIG_GPIO_API
411 void (*update_hisr_hsisr_ind)(PADAPTER padapter, u32 flag);
412 int (*hal_gpio_func_check)(_adapter *padapter, u8 gpio_num);
413 void (*hal_gpio_multi_func_reset)(_adapter *padapter, u8 gpio_num);
415 void (*fw_correct_bcn)(PADAPTER padapter);
418 u8(*init_mac_register)(PADAPTER);
419 u8(*init_phy)(PADAPTER);
420 #endif /* RTW_HALMAC */
423 typedef enum _RT_EEPROM_TYPE {
427 } RT_EEPROM_TYPE, *PRT_EEPROM_TYPE;
431 #define RF_CHANGE_BY_INIT 0
432 #define RF_CHANGE_BY_IPS BIT28
433 #define RF_CHANGE_BY_PS BIT29
434 #define RF_CHANGE_BY_HW BIT30
435 #define RF_CHANGE_BY_SW BIT31
437 typedef enum _HARDWARE_TYPE {
438 HARDWARE_TYPE_RTL8188EE,
439 HARDWARE_TYPE_RTL8188EU,
440 HARDWARE_TYPE_RTL8188ES,
441 /* NEW_GENERATION_IC */
442 HARDWARE_TYPE_RTL8192EE,
443 HARDWARE_TYPE_RTL8192EU,
444 HARDWARE_TYPE_RTL8192ES,
445 HARDWARE_TYPE_RTL8812E,
446 HARDWARE_TYPE_RTL8812AU,
447 HARDWARE_TYPE_RTL8811AU,
448 HARDWARE_TYPE_RTL8821E,
449 HARDWARE_TYPE_RTL8821U,
450 HARDWARE_TYPE_RTL8821S,
451 HARDWARE_TYPE_RTL8723BE,
452 HARDWARE_TYPE_RTL8723BU,
453 HARDWARE_TYPE_RTL8723BS,
454 HARDWARE_TYPE_RTL8814AE,
455 HARDWARE_TYPE_RTL8814AU,
456 HARDWARE_TYPE_RTL8814AS,
457 HARDWARE_TYPE_RTL8821BE,
458 HARDWARE_TYPE_RTL8821BU,
459 HARDWARE_TYPE_RTL8821BS,
460 HARDWARE_TYPE_RTL8822BE,
461 HARDWARE_TYPE_RTL8822BU,
462 HARDWARE_TYPE_RTL8822BS,
463 HARDWARE_TYPE_RTL8703BE,
464 HARDWARE_TYPE_RTL8703BU,
465 HARDWARE_TYPE_RTL8703BS,
466 HARDWARE_TYPE_RTL8188FE,
467 HARDWARE_TYPE_RTL8188FU,
468 HARDWARE_TYPE_RTL8188FS,
469 HARDWARE_TYPE_RTL8723DE,
470 HARDWARE_TYPE_RTL8723DU,
471 HARDWARE_TYPE_RTL8723DS,
472 HARDWARE_TYPE_RTL8821CE,
473 HARDWARE_TYPE_RTL8821CU,
474 HARDWARE_TYPE_RTL8821CS,
478 #define IS_NEW_GENERATION_IC(_Adapter) (rtw_get_hw_type(_Adapter) >= HARDWARE_TYPE_RTL8192EE)
482 #define IS_HARDWARE_TYPE_8188EE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EE)
483 #define IS_HARDWARE_TYPE_8188EU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188EU)
484 #define IS_HARDWARE_TYPE_8188ES(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188ES)
485 #define IS_HARDWARE_TYPE_8188E(_Adapter) \
486 (IS_HARDWARE_TYPE_8188EE(_Adapter) || IS_HARDWARE_TYPE_8188EU(_Adapter) || IS_HARDWARE_TYPE_8188ES(_Adapter))
489 #define IS_HARDWARE_TYPE_8812E(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812E)
490 #define IS_HARDWARE_TYPE_8812AU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8812AU)
491 #define IS_HARDWARE_TYPE_8812(_Adapter) \
492 (IS_HARDWARE_TYPE_8812E(_Adapter) || IS_HARDWARE_TYPE_8812AU(_Adapter))
495 #define IS_HARDWARE_TYPE_8821E(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821E)
496 #define IS_HARDWARE_TYPE_8811AU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
497 #define IS_HARDWARE_TYPE_8821U(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821U || \
498 rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8811AU)
499 #define IS_HARDWARE_TYPE_8821S(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821S)
500 #define IS_HARDWARE_TYPE_8821(_Adapter) \
501 (IS_HARDWARE_TYPE_8821E(_Adapter) || IS_HARDWARE_TYPE_8821U(_Adapter) || IS_HARDWARE_TYPE_8821S(_Adapter))
503 #define IS_HARDWARE_TYPE_JAGUAR(_Adapter) \
504 (IS_HARDWARE_TYPE_8812(_Adapter) || IS_HARDWARE_TYPE_8821(_Adapter))
506 /* RTL8192E Series */
507 #define IS_HARDWARE_TYPE_8192EE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EE)
508 #define IS_HARDWARE_TYPE_8192EU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192EU)
509 #define IS_HARDWARE_TYPE_8192ES(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8192ES)
511 #define IS_HARDWARE_TYPE_8192E(_Adapter) \
512 (IS_HARDWARE_TYPE_8192EE(_Adapter) || IS_HARDWARE_TYPE_8192EU(_Adapter) || IS_HARDWARE_TYPE_8192ES(_Adapter))
514 #define IS_HARDWARE_TYPE_8723BE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BE)
515 #define IS_HARDWARE_TYPE_8723BU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BU)
516 #define IS_HARDWARE_TYPE_8723BS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723BS)
518 #define IS_HARDWARE_TYPE_8723B(_Adapter) \
519 (IS_HARDWARE_TYPE_8723BE(_Adapter) || IS_HARDWARE_TYPE_8723BU(_Adapter) || IS_HARDWARE_TYPE_8723BS(_Adapter))
521 /* RTL8814A Series */
522 #define IS_HARDWARE_TYPE_8814AE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AE)
523 #define IS_HARDWARE_TYPE_8814AU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AU)
524 #define IS_HARDWARE_TYPE_8814AS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8814AS)
526 #define IS_HARDWARE_TYPE_8814A(_Adapter) \
527 (IS_HARDWARE_TYPE_8814AE(_Adapter) || IS_HARDWARE_TYPE_8814AU(_Adapter) || IS_HARDWARE_TYPE_8814AS(_Adapter))
529 /* RTL8703B Series */
530 #define IS_HARDWARE_TYPE_8703BE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BE)
531 #define IS_HARDWARE_TYPE_8703BS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BS)
532 #define IS_HARDWARE_TYPE_8703BU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8703BU)
533 #define IS_HARDWARE_TYPE_8703B(_Adapter) \
534 (IS_HARDWARE_TYPE_8703BE(_Adapter) || IS_HARDWARE_TYPE_8703BU(_Adapter) || IS_HARDWARE_TYPE_8703BS(_Adapter))
536 /* RTL8723D Series */
537 #define IS_HARDWARE_TYPE_8723DE(_Adapter)\
538 (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DE)
539 #define IS_HARDWARE_TYPE_8723DS(_Adapter)\
540 (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DS)
541 #define IS_HARDWARE_TYPE_8723DU(_Adapter)\
542 (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8723DU)
543 #define IS_HARDWARE_TYPE_8723D(_Adapter)\
544 (IS_HARDWARE_TYPE_8723DE(_Adapter) || \
545 IS_HARDWARE_TYPE_8723DU(_Adapter) || \
546 IS_HARDWARE_TYPE_8723DS(_Adapter))
548 /* RTL8188F Series */
549 #define IS_HARDWARE_TYPE_8188FE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FE)
550 #define IS_HARDWARE_TYPE_8188FS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FS)
551 #define IS_HARDWARE_TYPE_8188FU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8188FU)
552 #define IS_HARDWARE_TYPE_8188F(_Adapter) \
553 (IS_HARDWARE_TYPE_8188FE(_Adapter) || IS_HARDWARE_TYPE_8188FU(_Adapter) || IS_HARDWARE_TYPE_8188FS(_Adapter))
555 #define IS_HARDWARE_TYPE_8821BE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BE)
556 #define IS_HARDWARE_TYPE_8821BU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BU)
557 #define IS_HARDWARE_TYPE_8821BS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821BS)
559 #define IS_HARDWARE_TYPE_8821B(_Adapter) \
560 (IS_HARDWARE_TYPE_8821BE(_Adapter) || IS_HARDWARE_TYPE_8821BU(_Adapter) || IS_HARDWARE_TYPE_8821BS(_Adapter))
562 #define IS_HARDWARE_TYPE_8822BE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BE)
563 #define IS_HARDWARE_TYPE_8822BU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BU)
564 #define IS_HARDWARE_TYPE_8822BS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8822BS)
565 #define IS_HARDWARE_TYPE_8822B(_Adapter) \
566 (IS_HARDWARE_TYPE_8822BE(_Adapter) || IS_HARDWARE_TYPE_8822BU(_Adapter) || IS_HARDWARE_TYPE_8822BS(_Adapter))
568 #define IS_HARDWARE_TYPE_8821CE(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CE)
569 #define IS_HARDWARE_TYPE_8821CU(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CU)
570 #define IS_HARDWARE_TYPE_8821CS(_Adapter) (rtw_get_hw_type(_Adapter) == HARDWARE_TYPE_RTL8821CS)
571 #define IS_HARDWARE_TYPE_8821C(_Adapter) \
572 (IS_HARDWARE_TYPE_8821CE(_Adapter) || IS_HARDWARE_TYPE_8821CU(_Adapter) || IS_HARDWARE_TYPE_8821CS(_Adapter))
574 #define IS_HARDWARE_TYPE_JAGUAR2(_Adapter) \
575 (IS_HARDWARE_TYPE_8814A(_Adapter) || IS_HARDWARE_TYPE_8821B(_Adapter) || IS_HARDWARE_TYPE_8822B(_Adapter) || IS_HARDWARE_TYPE_8821C(_Adapter))
577 #define IS_HARDWARE_TYPE_JAGUAR_AND_JAGUAR2(_Adapter) \
578 (IS_HARDWARE_TYPE_JAGUAR(_Adapter) || IS_HARDWARE_TYPE_JAGUAR2(_Adapter))
582 typedef enum _wowlan_subcode {
585 WOWLAN_AP_ENABLE = 2,
586 WOWLAN_AP_DISABLE = 3,
587 WOWLAN_PATTERN_CLEAN = 4
590 struct wowlan_ioctl_param {
591 unsigned int subcode;
592 unsigned int subcode_value;
593 unsigned int wakeup_reason;
596 u8 rtw_hal_data_init(_adapter *padapter);
597 void rtw_hal_data_deinit(_adapter *padapter);
599 void rtw_hal_def_value_init(_adapter *padapter);
601 void rtw_hal_free_data(_adapter *padapter);
603 void rtw_hal_dm_init(_adapter *padapter);
604 void rtw_hal_dm_deinit(_adapter *padapter);
605 void rtw_hal_sw_led_init(_adapter *padapter);
606 void rtw_hal_sw_led_deinit(_adapter *padapter);
608 u32 rtw_hal_power_on(_adapter *padapter);
609 void rtw_hal_power_off(_adapter *padapter);
611 uint rtw_hal_init(_adapter *padapter);
612 uint rtw_hal_deinit(_adapter *padapter);
613 void rtw_hal_stop(_adapter *padapter);
614 void rtw_hal_set_hwreg(PADAPTER padapter, u8 variable, u8 *val);
615 void rtw_hal_get_hwreg(PADAPTER padapter, u8 variable, u8 *val);
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);
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);
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);
627 void rtw_hal_enable_interrupt(_adapter *padapter);
628 void rtw_hal_disable_interrupt(_adapter *padapter);
630 u8 rtw_hal_check_ips_status(_adapter *padapter);
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);
637 #if defined(CONFIG_PCI_HCI)
638 void rtw_hal_irp_reset(_adapter *padapter);
641 u8 rtw_hal_intf_ps_func(_adapter *padapter, HAL_INTF_PS_FUNC efunc_id, u8 *val);
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);
647 s32 rtw_hal_init_xmit_priv(_adapter *padapter);
648 void rtw_hal_free_xmit_priv(_adapter *padapter);
650 s32 rtw_hal_init_recv_priv(_adapter *padapter);
651 void rtw_hal_free_recv_priv(_adapter *padapter);
653 void rtw_hal_update_ra_mask(struct sta_info *psta, u8 rssi_level, u8 is_update_bw);
654 void rtw_update_ramask(_adapter *padapter, struct sta_info *psta, u32 mac_id, u8 rssi_level, u8 is_update_bw);
656 void rtw_hal_start_thread(_adapter *padapter);
657 void rtw_hal_stop_thread(_adapter *padapter);
659 void rtw_hal_bcn_related_reg_setting(_adapter *padapter);
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);
667 #define phy_query_bb_reg(Adapter, RegAddr, BitMask) rtw_hal_read_bbreg((Adapter), (RegAddr), (BitMask))
668 #define phy_set_bb_reg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_bbreg((Adapter), (RegAddr), (BitMask), (Data))
669 #define phy_query_rf_reg(Adapter, eRFPath, RegAddr, BitMask) rtw_hal_read_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask))
670 #define phy_set_rf_reg(Adapter, eRFPath, RegAddr, BitMask, Data) rtw_hal_write_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask), (Data))
672 #define phy_set_mac_reg phy_set_bb_reg
673 #define phy_query_mac_reg phy_query_bb_reg
676 #if defined(CONFIG_PCI_HCI)
677 s32 rtw_hal_interrupt_handler(_adapter *padapter);
679 #if defined(CONFIG_USB_HCI) && defined(CONFIG_SUPPORT_USB_INT)
680 void rtw_hal_interrupt_handler(_adapter *padapter, u16 pkt_len, u8 *pbuf);
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);
687 void rtw_hal_set_tx_power_level(_adapter *padapter, u8 channel);
688 void rtw_hal_get_tx_power_level(_adapter *padapter, s32 *powerlevel);
690 #ifdef CONFIG_HOSTAPD_MLME
691 s32 rtw_hal_hostap_mgnt_xmit_entry(_adapter *padapter, _pkt *pkt);
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);
705 int rtw_hal_iol_cmd(ADAPTER *adapter, struct xmit_frame *xmit_frame, u32 max_wating_ms, u32 bndy_cnt);
708 #ifdef CONFIG_XMIT_THREAD_MODE
709 s32 rtw_hal_xmit_thread_handler(_adapter *padapter);
712 #ifdef CONFIG_RECV_THREAD_MODE
713 s32 rtw_hal_recv_hdl(_adapter *adapter);
716 void rtw_hal_notch_filter(_adapter *adapter, bool enable);
718 #ifdef CONFIG_FW_C2H_REG
719 bool rtw_hal_c2h_reg_hdr_parse(_adapter *adapter, u8 *buf, u8 *id, u8 *seq, u8 *plen, u8 **payload);
720 bool rtw_hal_c2h_valid(_adapter *adapter, u8 *buf);
721 s32 rtw_hal_c2h_evt_read(_adapter *adapter, u8 *buf);
724 #ifdef CONFIG_FW_C2H_PKT
725 bool rtw_hal_c2h_pkt_hdr_parse(_adapter *adapter, u8 *buf, u16 len, u8 *id, u8 *seq, u8 *plen, u8 **payload);
728 s32 c2h_handler(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
730 s32 rtw_hal_c2h_handler(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
731 s32 rtw_hal_c2h_id_handle_directly(_adapter *adapter, u8 id, u8 seq, u8 plen, u8 *payload);
734 s32 rtw_hal_is_disable_sw_channel_plan(PADAPTER padapter);
736 s32 rtw_hal_macid_sleep(PADAPTER padapter, u8 macid);
737 s32 rtw_hal_macid_wakeup(PADAPTER padapter, u8 macid);
739 s32 rtw_hal_fill_h2c_cmd(PADAPTER padapter, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
740 void rtw_hal_fill_fake_txdesc(_adapter *padapter, u8 *pDesc, u32 BufferLen,
741 u8 IsPsPoll, u8 IsBTQosNull, u8 bDataFrame);
742 u8 rtw_hal_get_txbuff_rsvd_page_num(_adapter *adapter, bool wowlan);
744 #ifdef CONFIG_GPIO_API
745 void rtw_hal_update_hisr_hsisr_ind(_adapter *padapter, u32 flag);
746 int rtw_hal_gpio_func_check(_adapter *padapter, u8 gpio_num);
747 void rtw_hal_gpio_multi_func_reset(_adapter *padapter, u8 gpio_num);
750 void rtw_hal_fw_correct_bcn(_adapter *padapter);
751 s32 rtw_hal_fw_dl(_adapter *padapter, u8 wowlan);
753 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
754 void rtw_hal_clear_interrupt(_adapter *padapter);
757 void rtw_hal_set_tx_power_index(PADAPTER, u32 powerindex, u8 rfpath, u8 rate);
758 u8 rtw_hal_get_tx_power_index(PADAPTER, u8 rfpath, u8 rate, u8 bandwidth, u8 channel,struct txpwr_idx_comp *tic);
760 u8 rtw_hal_ops_check(_adapter *padapter);
763 u8 rtw_hal_init_mac_register(PADAPTER);
764 u8 rtw_hal_init_phy(PADAPTER);
765 #endif /* RTW_HALMAC */
767 #endif /* __HAL_INTF_H__ */