Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 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 | * |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 14 | ******************************************************************************/ |
| 15 | #ifndef __HAL_INTF_H__ |
| 16 | #define __HAL_INTF_H__ |
| 17 | |
| 18 | #include <osdep_service.h> |
| 19 | #include <drv_types.h> |
| 20 | #include <Hal8188EPhyCfg.h> |
| 21 | |
| 22 | enum RTL871X_HCI_TYPE { |
Anish Bhatt | 9c68ed0 | 2015-10-18 22:51:41 -0700 | [diff] [blame] | 23 | RTW_PCIE = BIT(0), |
| 24 | RTW_USB = BIT(1), |
| 25 | RTW_SDIO = BIT(2), |
| 26 | RTW_GSPI = BIT(3), |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 27 | }; |
| 28 | |
| 29 | enum _CHIP_TYPE { |
| 30 | NULL_CHIP_TYPE, |
| 31 | RTL8712_8188S_8191S_8192S, |
| 32 | RTL8188C_8192C, |
| 33 | RTL8192D, |
| 34 | RTL8723A, |
| 35 | RTL8188E, |
| 36 | MAX_CHIP_TYPE |
| 37 | }; |
| 38 | |
| 39 | enum hw_variables { |
| 40 | HW_VAR_MEDIA_STATUS, |
| 41 | HW_VAR_MEDIA_STATUS1, |
| 42 | HW_VAR_SET_OPMODE, |
| 43 | HW_VAR_MAC_ADDR, |
| 44 | HW_VAR_BSSID, |
| 45 | HW_VAR_INIT_RTS_RATE, |
| 46 | HW_VAR_BASIC_RATE, |
| 47 | HW_VAR_TXPAUSE, |
| 48 | HW_VAR_BCN_FUNC, |
| 49 | HW_VAR_CORRECT_TSF, |
| 50 | HW_VAR_CHECK_BSSID, |
| 51 | HW_VAR_MLME_DISCONNECT, |
| 52 | HW_VAR_MLME_SITESURVEY, |
| 53 | HW_VAR_MLME_JOIN, |
| 54 | HW_VAR_BEACON_INTERVAL, |
| 55 | HW_VAR_SLOT_TIME, |
| 56 | HW_VAR_RESP_SIFS, |
| 57 | HW_VAR_ACK_PREAMBLE, |
| 58 | HW_VAR_SEC_CFG, |
| 59 | HW_VAR_BCN_VALID, |
| 60 | HW_VAR_RF_TYPE, |
| 61 | HW_VAR_DM_FLAG, |
| 62 | HW_VAR_DM_FUNC_OP, |
| 63 | HW_VAR_DM_FUNC_SET, |
| 64 | HW_VAR_DM_FUNC_CLR, |
| 65 | HW_VAR_CAM_EMPTY_ENTRY, |
| 66 | HW_VAR_CAM_INVALID_ALL, |
| 67 | HW_VAR_CAM_WRITE, |
| 68 | HW_VAR_CAM_READ, |
| 69 | HW_VAR_AC_PARAM_VO, |
| 70 | HW_VAR_AC_PARAM_VI, |
| 71 | HW_VAR_AC_PARAM_BE, |
| 72 | HW_VAR_AC_PARAM_BK, |
| 73 | HW_VAR_ACM_CTRL, |
| 74 | HW_VAR_AMPDU_MIN_SPACE, |
| 75 | HW_VAR_AMPDU_FACTOR, |
| 76 | HW_VAR_RXDMA_AGG_PG_TH, |
| 77 | HW_VAR_SET_RPWM, |
| 78 | HW_VAR_H2C_FW_PWRMODE, |
| 79 | HW_VAR_H2C_FW_JOINBSSRPT, |
| 80 | HW_VAR_FWLPS_RF_ON, |
| 81 | HW_VAR_H2C_FW_P2P_PS_OFFLOAD, |
| 82 | HW_VAR_TDLS_WRCR, |
| 83 | HW_VAR_TDLS_INIT_CH_SEN, |
| 84 | HW_VAR_TDLS_RS_RCR, |
| 85 | HW_VAR_TDLS_DONE_CH_SEN, |
| 86 | HW_VAR_INITIAL_GAIN, |
| 87 | HW_VAR_TRIGGER_GPIO_0, |
| 88 | HW_VAR_BT_SET_COEXIST, |
| 89 | HW_VAR_BT_ISSUE_DELBA, |
| 90 | HW_VAR_CURRENT_ANTENNA, |
| 91 | HW_VAR_ANTENNA_DIVERSITY_LINK, |
| 92 | HW_VAR_ANTENNA_DIVERSITY_SELECT, |
| 93 | HW_VAR_SWITCH_EPHY_WoWLAN, |
| 94 | HW_VAR_EFUSE_USAGE, |
| 95 | HW_VAR_EFUSE_BYTES, |
| 96 | HW_VAR_EFUSE_BT_USAGE, |
| 97 | HW_VAR_EFUSE_BT_BYTES, |
| 98 | HW_VAR_FIFO_CLEARN_UP, |
| 99 | HW_VAR_CHECK_TXBUF, |
| 100 | HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation, |
| 101 | * power control for MAC only */ |
| 102 | /* The valid upper nav range for the HW updating, if the true value is |
| 103 | * larger than the upper range, the HW won't update it. */ |
| 104 | /* Unit in microsecond. 0 means disable this function. */ |
| 105 | HW_VAR_NAV_UPPER, |
| 106 | HW_VAR_RPT_TIMER_SETTING, |
| 107 | HW_VAR_TX_RPT_MAX_MACID, |
| 108 | HW_VAR_H2C_MEDIA_STATUS_RPT, |
| 109 | HW_VAR_CHK_HI_QUEUE_EMPTY, |
| 110 | }; |
| 111 | |
| 112 | enum hal_def_variable { |
| 113 | HAL_DEF_UNDERCORATEDSMOOTHEDPWDB, |
| 114 | HAL_DEF_IS_SUPPORT_ANT_DIV, |
| 115 | HAL_DEF_CURRENT_ANTENNA, |
| 116 | HAL_DEF_DRVINFO_SZ, |
| 117 | HAL_DEF_MAX_RECVBUF_SZ, |
| 118 | HAL_DEF_RX_PACKET_OFFSET, |
| 119 | HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */ |
| 120 | HAL_DEF_DBG_DM_FUNC,/* for dbg */ |
| 121 | HAL_DEF_RA_DECISION_RATE, |
| 122 | HAL_DEF_RA_SGI, |
| 123 | HAL_DEF_PT_PWR_STATUS, |
| 124 | HW_VAR_MAX_RX_AMPDU_FACTOR, |
| 125 | HW_DEF_RA_INFO_DUMP, |
| 126 | HAL_DEF_DBG_DUMP_TXPKT, |
| 127 | HW_DEF_FA_CNT_DUMP, |
| 128 | HW_DEF_ODM_DBG_FLAG, |
| 129 | }; |
| 130 | |
| 131 | enum hal_odm_variable { |
| 132 | HAL_ODM_STA_INFO, |
| 133 | HAL_ODM_P2P_STATE, |
| 134 | HAL_ODM_WIFI_DISPLAY_STATE, |
| 135 | }; |
| 136 | |
| 137 | enum hal_intf_ps_func { |
| 138 | HAL_USB_SELECT_SUSPEND, |
| 139 | HAL_MAX_ID, |
| 140 | }; |
| 141 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 142 | struct hal_ops { |
| 143 | u32 (*hal_power_on)(struct adapter *padapter); |
| 144 | u32 (*hal_init)(struct adapter *padapter); |
| 145 | u32 (*hal_deinit)(struct adapter *padapter); |
| 146 | |
| 147 | void (*free_hal_data)(struct adapter *padapter); |
| 148 | |
| 149 | u32 (*inirp_init)(struct adapter *padapter); |
| 150 | u32 (*inirp_deinit)(struct adapter *padapter); |
| 151 | |
| 152 | s32 (*init_xmit_priv)(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 153 | |
| 154 | s32 (*init_recv_priv)(struct adapter *padapter); |
| 155 | void (*free_recv_priv)(struct adapter *padapter); |
| 156 | |
| 157 | void (*InitSwLeds)(struct adapter *padapter); |
| 158 | void (*DeInitSwLeds)(struct adapter *padapter); |
| 159 | |
| 160 | void (*dm_init)(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 161 | void (*read_chip_version)(struct adapter *padapter); |
| 162 | |
| 163 | void (*init_default_value)(struct adapter *padapter); |
| 164 | |
| 165 | void (*intf_chip_configure)(struct adapter *padapter); |
| 166 | |
| 167 | void (*read_adapter_info)(struct adapter *padapter); |
| 168 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 169 | s32 (*interrupt_handler)(struct adapter *padapter); |
| 170 | |
| 171 | void (*set_bwmode_handler)(struct adapter *padapter, |
| 172 | enum ht_channel_width Bandwidth, |
| 173 | u8 Offset); |
| 174 | void (*set_channel_handler)(struct adapter *padapter, u8 channel); |
| 175 | |
| 176 | void (*hal_dm_watchdog)(struct adapter *padapter); |
| 177 | |
| 178 | void (*SetHwRegHandler)(struct adapter *padapter, u8 variable, |
| 179 | u8 *val); |
| 180 | void (*GetHwRegHandler)(struct adapter *padapter, u8 variable, |
| 181 | u8 *val); |
| 182 | |
| 183 | u8 (*GetHalDefVarHandler)(struct adapter *padapter, |
| 184 | enum hal_def_variable eVariable, |
| 185 | void *pValue); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 186 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 187 | void (*SetHalODMVarHandler)(struct adapter *padapter, |
| 188 | enum hal_odm_variable eVariable, |
| 189 | void *pValue1, bool bSet); |
| 190 | |
| 191 | void (*UpdateRAMaskHandler)(struct adapter *padapter, |
| 192 | u32 mac_id, u8 rssi_level); |
| 193 | void (*SetBeaconRelatedRegistersHandler)(struct adapter *padapter); |
| 194 | |
| 195 | void (*Add_RateATid)(struct adapter *adapter, u32 bitmap, u8 arg, |
| 196 | u8 rssi_level); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 197 | |
| 198 | u8 (*AntDivBeforeLinkHandler)(struct adapter *adapter); |
| 199 | void (*AntDivCompareHandler)(struct adapter *adapter, |
| 200 | struct wlan_bssid_ex *dst, |
| 201 | struct wlan_bssid_ex *src); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 202 | s32 (*hal_xmit)(struct adapter *padapter, |
| 203 | struct xmit_frame *pxmitframe); |
| 204 | s32 (*mgnt_xmit)(struct adapter *padapter, |
| 205 | struct xmit_frame *pmgntframe); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 206 | u32 (*read_rfreg)(struct adapter *padapter, |
| 207 | enum rf_radio_path eRFPath, u32 RegAddr, |
| 208 | u32 BitMask); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 209 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 210 | void (*sreset_init_value)(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 211 | u8 (*sreset_get_wifi_status)(struct adapter *padapter); |
| 212 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 213 | void (*hal_notch_filter)(struct adapter *adapter, bool enable); |
| 214 | void (*hal_reset_security_engine)(struct adapter *adapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 215 | }; |
| 216 | |
| 217 | enum rt_eeprom_type { |
| 218 | EEPROM_93C46, |
| 219 | EEPROM_93C56, |
| 220 | EEPROM_BOOT_EFUSE, |
| 221 | }; |
| 222 | |
| 223 | #define RF_CHANGE_BY_INIT 0 |
Anish Bhatt | 9c68ed0 | 2015-10-18 22:51:41 -0700 | [diff] [blame] | 224 | #define RF_CHANGE_BY_IPS BIT(28) |
| 225 | #define RF_CHANGE_BY_PS BIT(29) |
| 226 | #define RF_CHANGE_BY_HW BIT(30) |
| 227 | #define RF_CHANGE_BY_SW BIT(31) |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 228 | |
| 229 | enum hardware_type { |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 230 | HARDWARE_TYPE_RTL8188EU, |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 231 | HARDWARE_TYPE_MAX, |
| 232 | }; |
| 233 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 234 | #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv) |
| 235 | |
| 236 | #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse) |
| 237 | |
| 238 | void rtw_hal_def_value_init(struct adapter *padapter); |
| 239 | |
| 240 | void rtw_hal_free_data(struct adapter *padapter); |
| 241 | |
| 242 | void rtw_hal_dm_init(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 243 | void rtw_hal_sw_led_init(struct adapter *padapter); |
| 244 | void rtw_hal_sw_led_deinit(struct adapter *padapter); |
| 245 | |
| 246 | u32 rtw_hal_power_on(struct adapter *padapter); |
| 247 | uint rtw_hal_init(struct adapter *padapter); |
| 248 | uint rtw_hal_deinit(struct adapter *padapter); |
| 249 | void rtw_hal_stop(struct adapter *padapter); |
| 250 | void rtw_hal_set_hwreg(struct adapter *padapter, u8 variable, u8 *val); |
| 251 | void rtw_hal_get_hwreg(struct adapter *padapter, u8 variable, u8 *val); |
| 252 | |
| 253 | void rtw_hal_chip_configure(struct adapter *padapter); |
| 254 | void rtw_hal_read_chip_info(struct adapter *padapter); |
| 255 | void rtw_hal_read_chip_version(struct adapter *padapter); |
| 256 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 257 | u8 rtw_hal_get_def_var(struct adapter *padapter, |
| 258 | enum hal_def_variable eVariable, void *pValue); |
| 259 | |
| 260 | void rtw_hal_set_odm_var(struct adapter *padapter, |
| 261 | enum hal_odm_variable eVariable, void *pValue1, |
| 262 | bool bSet); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 263 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 264 | u32 rtw_hal_inirp_init(struct adapter *padapter); |
| 265 | u32 rtw_hal_inirp_deinit(struct adapter *padapter); |
| 266 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 267 | s32 rtw_hal_xmit(struct adapter *padapter, struct xmit_frame *pxmitframe); |
| 268 | s32 rtw_hal_mgnt_xmit(struct adapter *padapter, |
| 269 | struct xmit_frame *pmgntframe); |
| 270 | |
| 271 | s32 rtw_hal_init_xmit_priv(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 272 | |
| 273 | s32 rtw_hal_init_recv_priv(struct adapter *padapter); |
| 274 | void rtw_hal_free_recv_priv(struct adapter *padapter); |
| 275 | |
| 276 | void rtw_hal_update_ra_mask(struct adapter *padapter, u32 mac_id, u8 level); |
| 277 | void rtw_hal_add_ra_tid(struct adapter *adapt, u32 bitmap, u8 arg, u8 level); |
| 278 | void rtw_hal_clone_data(struct adapter *dst_adapt, |
| 279 | struct adapter *src_adapt); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 280 | |
| 281 | void rtw_hal_bcn_related_reg_setting(struct adapter *padapter); |
| 282 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 283 | u32 rtw_hal_read_rfreg(struct adapter *padapter, enum rf_radio_path eRFPath, |
| 284 | u32 RegAddr, u32 BitMask); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 285 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 286 | void rtw_hal_set_bwmode(struct adapter *padapter, |
| 287 | enum ht_channel_width Bandwidth, u8 Offset); |
| 288 | void rtw_hal_set_chan(struct adapter *padapter, u8 channel); |
| 289 | void rtw_hal_dm_watchdog(struct adapter *padapter); |
| 290 | |
| 291 | u8 rtw_hal_antdiv_before_linked(struct adapter *padapter); |
| 292 | void rtw_hal_antdiv_rssi_compared(struct adapter *padapter, |
| 293 | struct wlan_bssid_ex *dst, |
| 294 | struct wlan_bssid_ex *src); |
| 295 | |
| 296 | void rtw_hal_sreset_init(struct adapter *padapter); |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 297 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 298 | void rtw_hal_notch_filter(struct adapter *adapter, bool enable); |
| 299 | void rtw_hal_reset_security_engine(struct adapter *adapter); |
| 300 | |
Larry Finger | a7c947b | 2013-08-21 22:34:03 -0500 | [diff] [blame] | 301 | void indicate_wx_scan_complete_event(struct adapter *padapter); |
| 302 | u8 rtw_do_join(struct adapter *padapter); |
| 303 | |
| 304 | #endif /* __HAL_INTF_H__ */ |