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 ******************************************************************************/
15 #ifndef __HAL_INTF_H__
16 #define __HAL_INTF_H__
19 enum RTL871X_HCI_TYPE {
38 HW_VAR_MLME_DISCONNECT,
39 HW_VAR_MLME_SITESURVEY,
43 HW_VAR_BEACON_INTERVAL,
55 HW_VAR_CAM_EMPTY_ENTRY,
56 HW_VAR_CAM_INVALID_ALL,
64 HW_VAR_AMPDU_MIN_SPACE,
66 HW_VAR_RXDMA_AGG_PG_TH,
69 HW_VAR_H2C_FW_PWRMODE,
70 HW_VAR_H2C_PS_TUNE_PARAM,
71 HW_VAR_H2C_FW_JOINBSSRPT,
73 HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
75 HW_VAR_TDLS_INIT_CH_SEN,
77 HW_VAR_TDLS_DONE_CH_SEN,
79 HW_VAR_TRIGGER_GPIO_0,
80 HW_VAR_BT_SET_COEXIST,
81 HW_VAR_BT_ISSUE_DELBA,
82 HW_VAR_CURRENT_ANTENNA,
83 HW_VAR_ANTENNA_DIVERSITY_LINK,
84 HW_VAR_ANTENNA_DIVERSITY_SELECT,
85 HW_VAR_SWITCH_EPHY_WoWLAN,
88 HW_VAR_EFUSE_BT_USAGE,
89 HW_VAR_EFUSE_BT_BYTES,
90 HW_VAR_FIFO_CLEARN_UP,
92 HW_VAR_PCIE_STOP_TX_DMA,
93 HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, power control for MAC only */
94 /* 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. */
95 /* Unit in microsecond. 0 means disable this function. */
101 #ifdef CONFIG_AP_WOWLAN
107 HW_VAR_RPT_TIMER_SETTING,
108 HW_VAR_TX_RPT_MAX_MACID,
109 HW_VAR_H2C_MEDIA_STATUS_RPT,
110 HW_VAR_CHK_HI_QUEUE_EMPTY,
112 HW_VAR_AMPDU_MAX_TIME,
113 HW_VAR_WIRELESS_MODE,
118 HW_VAR_SET_REQ_FW_PS,
120 HW_VAR_SOUNDING_ENTER,
121 HW_VAR_SOUNDING_LEAVE,
122 HW_VAR_SOUNDING_RATE,
123 HW_VAR_SOUNDING_STATUS,
124 HW_VAR_SOUNDING_FW_NDPA,
131 enum HAL_DEF_VARIABLE {
132 HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
133 HAL_DEF_IS_SUPPORT_ANT_DIV,
134 HAL_DEF_CURRENT_ANTENNA,
136 HAL_DEF_MAX_RECVBUF_SZ,
137 HAL_DEF_RX_PACKET_OFFSET,
138 HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
139 HAL_DEF_DBG_DM_FUNC,/* for dbg */
140 HAL_DEF_RA_DECISION_RATE,
142 HAL_DEF_PT_PWR_STATUS,
143 HAL_DEF_TX_LDPC, /* LDPC support */
144 HAL_DEF_RX_LDPC, /* LDPC support */
145 HAL_DEF_TX_STBC, /* TX STBC support */
146 HAL_DEF_RX_STBC, /* RX STBC support */
147 HAL_DEF_EXPLICIT_BEAMFORMER,/* Explicit Compressed Steering Capable */
148 HAL_DEF_EXPLICIT_BEAMFORMEE,/* Explicit Compressed Beamforming Feedback Capable */
149 HW_VAR_MAX_RX_AMPDU_FACTOR,
151 HAL_DEF_DBG_DUMP_TXPKT,
154 HW_DEF_ODM_DBG_LEVEL,
155 HAL_DEF_TX_PAGE_SIZE,
156 HAL_DEF_TX_PAGE_BOUNDARY,
157 HAL_DEF_TX_PAGE_BOUNDARY_WOWLAN,
158 HAL_DEF_ANT_DETECT,/* to do for 8723a */
159 HAL_DEF_PCI_SUUPORT_L1_BACKDOOR, /* Determine if the L1 Backdoor setting is turned on. */
160 HAL_DEF_PCI_AMD_L1_SUPPORT,
161 HAL_DEF_PCI_ASPM_OSC, /* Support for ASPM OSC, added by Roger, 2013.03.27. */
162 HAL_DEF_MACID_SLEEP, /* Support for MACID sleep */
163 HAL_DEF_DBG_RX_INFO_DUMP,
166 enum HAL_ODM_VARIABLE {
169 HAL_ODM_WIFI_DISPLAY_STATE,
170 HAL_ODM_NOISE_MONITOR,
173 enum HAL_INTF_PS_FUNC {
174 HAL_USB_SELECT_SUSPEND,
178 typedef s32 (*c2h_id_filter)(u8 *c2h_evt);
181 u32 (*hal_power_on)(struct adapter *padapter);
182 void (*hal_power_off)(struct adapter *padapter);
183 u32 (*hal_init)(struct adapter *padapter);
184 u32 (*hal_deinit)(struct adapter *padapter);
186 void (*free_hal_data)(struct adapter *padapter);
188 u32 (*inirp_init)(struct adapter *padapter);
189 u32 (*inirp_deinit)(struct adapter *padapter);
190 void (*irp_reset)(struct adapter *padapter);
192 s32 (*init_xmit_priv)(struct adapter *padapter);
193 void (*free_xmit_priv)(struct adapter *padapter);
195 s32 (*init_recv_priv)(struct adapter *padapter);
196 void (*free_recv_priv)(struct adapter *padapter);
198 void (*dm_init)(struct adapter *padapter);
199 void (*dm_deinit)(struct adapter *padapter);
200 void (*read_chip_version)(struct adapter *padapter);
202 void (*init_default_value)(struct adapter *padapter);
204 void (*intf_chip_configure)(struct adapter *padapter);
206 void (*read_adapter_info)(struct adapter *padapter);
208 void (*enable_interrupt)(struct adapter *padapter);
209 void (*disable_interrupt)(struct adapter *padapter);
210 u8 (*check_ips_status)(struct adapter *padapter);
211 s32 (*interrupt_handler)(struct adapter *padapter);
212 void (*clear_interrupt)(struct adapter *padapter);
213 void (*set_bwmode_handler)(struct adapter *padapter, enum CHANNEL_WIDTH Bandwidth, u8 Offset);
214 void (*set_channel_handler)(struct adapter *padapter, u8 channel);
215 void (*set_chnl_bw_handler)(struct adapter *padapter, u8 channel, enum CHANNEL_WIDTH Bandwidth, u8 Offset40, u8 Offset80);
217 void (*set_tx_power_level_handler)(struct adapter *padapter, u8 channel);
218 void (*get_tx_power_level_handler)(struct adapter *padapter, s32 *powerlevel);
220 void (*hal_dm_watchdog)(struct adapter *padapter);
221 void (*hal_dm_watchdog_in_lps)(struct adapter *padapter);
224 void (*SetHwRegHandler)(struct adapter *padapter, u8 variable, u8 *val);
225 void (*GetHwRegHandler)(struct adapter *padapter, u8 variable, u8 *val);
227 void (*SetHwRegHandlerWithBuf)(struct adapter *padapter, u8 variable, u8 *pbuf, int len);
229 u8 (*GetHalDefVarHandler)(struct adapter *padapter, enum HAL_DEF_VARIABLE eVariable, void *pValue);
230 u8 (*SetHalDefVarHandler)(struct adapter *padapter, enum HAL_DEF_VARIABLE eVariable, void *pValue);
232 void (*GetHalODMVarHandler)(struct adapter *padapter, enum HAL_ODM_VARIABLE eVariable, void *pValue1, void *pValue2);
233 void (*SetHalODMVarHandler)(struct adapter *padapter, enum HAL_ODM_VARIABLE eVariable, void *pValue1, bool bSet);
235 void (*UpdateRAMaskHandler)(struct adapter *padapter, u32 mac_id, u8 rssi_level);
236 void (*SetBeaconRelatedRegistersHandler)(struct adapter *padapter);
238 void (*Add_RateATid)(struct adapter *padapter, u32 bitmap, u8 *arg, u8 rssi_level);
240 void (*run_thread)(struct adapter *padapter);
241 void (*cancel_thread)(struct adapter *padapter);
243 u8 (*interface_ps_func)(struct adapter *padapter, enum HAL_INTF_PS_FUNC efunc_id, u8 *val);
245 s32 (*hal_xmit)(struct adapter *padapter, struct xmit_frame *pxmitframe);
247 * mgnt_xmit should be implemented to run in interrupt context
249 s32 (*mgnt_xmit)(struct adapter *padapter, struct xmit_frame *pmgntframe);
250 s32 (*hal_xmitframe_enqueue)(struct adapter *padapter, struct xmit_frame *pxmitframe);
252 u32 (*read_bbreg)(struct adapter *padapter, u32 RegAddr, u32 BitMask);
253 void (*write_bbreg)(struct adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
254 u32 (*read_rfreg)(struct adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask);
255 void (*write_rfreg)(struct adapter *padapter, u8 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
257 void (*EfusePowerSwitch)(struct adapter *padapter, u8 bWrite, u8 PwrState);
258 void (*BTEfusePowerSwitch)(struct adapter *padapter, u8 bWrite, u8 PwrState);
259 void (*ReadEFuse)(struct adapter *padapter, u8 efuseType, u16 _offset, u16 _size_byte, u8 *pbuf, bool bPseudoTest);
260 void (*EFUSEGetEfuseDefinition)(struct adapter *padapter, u8 efuseType, u8 type, void *pOut, bool bPseudoTest);
261 u16 (*EfuseGetCurrentSize)(struct adapter *padapter, u8 efuseType, bool bPseudoTest);
262 int (*Efuse_PgPacketRead)(struct adapter *padapter, u8 offset, u8 *data, bool bPseudoTest);
263 int (*Efuse_PgPacketWrite)(struct adapter *padapter, u8 offset, u8 word_en, u8 *data, bool bPseudoTest);
264 u8 (*Efuse_WordEnableDataWrite)(struct adapter *padapter, u16 efuse_addr, u8 word_en, u8 *data, bool bPseudoTest);
265 bool (*Efuse_PgPacketWrite_BT)(struct adapter *padapter, u8 offset, u8 word_en, u8 *data, bool bPseudoTest);
267 s32 (*xmit_thread_handler)(struct adapter *padapter);
268 void (*hal_notch_filter)(struct adapter * adapter, bool enable);
269 void (*hal_reset_security_engine)(struct adapter * adapter);
270 s32 (*c2h_handler)(struct adapter *padapter, u8 *c2h_evt);
271 c2h_id_filter c2h_id_filter_ccx;
273 s32 (*fill_h2c_cmd)(struct adapter *, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
276 enum RT_EEPROM_TYPE {
282 #define RF_CHANGE_BY_INIT 0
283 #define RF_CHANGE_BY_IPS BIT28
284 #define RF_CHANGE_BY_PS BIT29
285 #define RF_CHANGE_BY_HW BIT30
286 #define RF_CHANGE_BY_SW BIT31
288 #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)
289 #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)
291 enum wowlan_subcode {
292 WOWLAN_PATTERN_MATCH = 1,
293 WOWLAN_MAGIC_PACKET = 2,
295 WOWLAN_SET_PATTERN = 4,
300 WOWLAN_DEBUG_RELOAD_FW = 9,
303 WOWLAN_AP_ENABLE = 12,
304 WOWLAN_AP_DISABLE = 13
307 struct wowlan_ioctl_param{
308 unsigned int subcode;
309 unsigned int subcode_value;
310 unsigned int wakeup_reason;
312 unsigned char pattern[0];
315 #define Rx_Pairwisekey 0x01
317 #define Rx_DisAssoc 0x04
318 #define Rx_DeAuth 0x08
319 #define Rx_ARPReq 0x09
320 #define FWDecisionDisconnect 0x10
321 #define Rx_MagicPkt 0x21
322 #define Rx_UnicastPkt 0x22
323 #define Rx_PatternPkt 0x23
324 #define RX_PNOWakeUp 0x55
325 #define AP_WakeUp 0x66
327 void rtw_hal_def_value_init(struct adapter *padapter);
329 void rtw_hal_free_data(struct adapter *padapter);
331 void rtw_hal_dm_init(struct adapter *padapter);
332 void rtw_hal_dm_deinit(struct adapter *padapter);
334 uint rtw_hal_init(struct adapter *padapter);
335 uint rtw_hal_deinit(struct adapter *padapter);
336 void rtw_hal_stop(struct adapter *padapter);
337 void rtw_hal_set_hwreg(struct adapter *padapter, u8 variable, u8 *val);
338 void rtw_hal_get_hwreg(struct adapter *padapter, u8 variable, u8 *val);
340 void rtw_hal_set_hwreg_with_buf(struct adapter *padapter, u8 variable, u8 *pbuf, int len);
342 void rtw_hal_chip_configure(struct adapter *padapter);
343 void rtw_hal_read_chip_info(struct adapter *padapter);
344 void rtw_hal_read_chip_version(struct adapter *padapter);
346 u8 rtw_hal_set_def_var(struct adapter *padapter, enum HAL_DEF_VARIABLE eVariable, void *pValue);
347 u8 rtw_hal_get_def_var(struct adapter *padapter, enum HAL_DEF_VARIABLE eVariable, void *pValue);
349 void rtw_hal_set_odm_var(struct adapter *padapter, enum HAL_ODM_VARIABLE eVariable, void *pValue1, bool bSet);
350 void rtw_hal_get_odm_var(struct adapter *padapter, enum HAL_ODM_VARIABLE eVariable, void *pValue1, void *pValue2);
352 void rtw_hal_enable_interrupt(struct adapter *padapter);
353 void rtw_hal_disable_interrupt(struct adapter *padapter);
355 u8 rtw_hal_check_ips_status(struct adapter *padapter);
357 s32 rtw_hal_xmitframe_enqueue(struct adapter *padapter, struct xmit_frame *pxmitframe);
358 s32 rtw_hal_xmit(struct adapter *padapter, struct xmit_frame *pxmitframe);
359 s32 rtw_hal_mgnt_xmit(struct adapter *padapter, struct xmit_frame *pmgntframe);
361 s32 rtw_hal_init_xmit_priv(struct adapter *padapter);
362 void rtw_hal_free_xmit_priv(struct adapter *padapter);
364 s32 rtw_hal_init_recv_priv(struct adapter *padapter);
365 void rtw_hal_free_recv_priv(struct adapter *padapter);
367 void rtw_hal_update_ra_mask(struct sta_info *psta, u8 rssi_level);
368 void rtw_hal_add_ra_tid(struct adapter *padapter, u32 bitmap, u8 *arg, u8 rssi_level);
370 void rtw_hal_start_thread(struct adapter *padapter);
371 void rtw_hal_stop_thread(struct adapter *padapter);
373 void rtw_hal_bcn_related_reg_setting(struct adapter *padapter);
375 u32 rtw_hal_read_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask);
376 void rtw_hal_write_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask, u32 Data);
377 u32 rtw_hal_read_rfreg(struct adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask);
378 void rtw_hal_write_rfreg(struct adapter *padapter, u32 eRFPath, u32 RegAddr, u32 BitMask, u32 Data);
380 #define PHY_QueryBBReg(Adapter, RegAddr, BitMask) rtw_hal_read_bbreg((Adapter), (RegAddr), (BitMask))
381 #define PHY_SetBBReg(Adapter, RegAddr, BitMask, Data) rtw_hal_write_bbreg((Adapter), (RegAddr), (BitMask), (Data))
382 #define PHY_QueryRFReg(Adapter, eRFPath, RegAddr, BitMask) rtw_hal_read_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask))
383 #define PHY_SetRFReg(Adapter, eRFPath, RegAddr, BitMask, Data) rtw_hal_write_rfreg((Adapter), (eRFPath), (RegAddr), (BitMask), (Data))
385 #define PHY_SetMacReg PHY_SetBBReg
386 #define PHY_QueryMacReg PHY_QueryBBReg
388 void rtw_hal_set_chan(struct adapter *padapter, u8 channel);
389 void rtw_hal_set_chnl_bw(struct adapter *padapter, u8 channel, enum CHANNEL_WIDTH Bandwidth, u8 Offset40, u8 Offset80);
390 void rtw_hal_dm_watchdog(struct adapter *padapter);
391 void rtw_hal_dm_watchdog_in_lps(struct adapter *padapter);
393 s32 rtw_hal_xmit_thread_handler(struct adapter *padapter);
395 void rtw_hal_notch_filter(struct adapter * adapter, bool enable);
396 void rtw_hal_reset_security_engine(struct adapter * adapter);
398 bool rtw_hal_c2h_valid(struct adapter *adapter, u8 *buf);
399 s32 rtw_hal_c2h_evt_read(struct adapter *adapter, u8 *buf);
400 s32 rtw_hal_c2h_handler(struct adapter *adapter, u8 *c2h_evt);
401 c2h_id_filter rtw_hal_c2h_id_filter_ccx(struct adapter *adapter);
403 s32 rtw_hal_is_disable_sw_channel_plan(struct adapter *padapter);
405 s32 rtw_hal_macid_sleep(struct adapter *padapter, u32 macid);
406 s32 rtw_hal_macid_wakeup(struct adapter *padapter, u32 macid);
408 s32 rtw_hal_fill_h2c_cmd(struct adapter *, u8 ElementID, u32 CmdLen, u8 *pCmdBuffer);
410 #endif /* __HAL_INTF_H__ */