drivers/staging/r8188eu/include/hal_intf.h

   1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
   2 /* Copyright(c) 2007 - 2012 Realtek Corporation. */
   3
   4 #ifndef __HAL_INTF_H__
   5 #define __HAL_INTF_H__
   6
   7 #include "osdep_service.h"
   8 #include "drv_types.h"
   9 #include "Hal8188EPhyCfg.h"
  10
  11 enum RTL871X_HCI_TYPE {
  12         RTW_PCIE        = BIT0,
  13         RTW_USB         = BIT1,
  14         RTW_SDIO        = BIT2,
  15         RTW_GSPI        = BIT3,
  16 };
  17
  18 enum _CHIP_TYPE {
  19         NULL_CHIP_TYPE,
  20         RTL8712_8188S_8191S_8192S,
  21         RTL8188C_8192C,
  22         RTL8192D,
  23         RTL8723A,
  24         RTL8188E,
  25         MAX_CHIP_TYPE
  26 };
  27
  28 enum hw_variables {
  29         HW_VAR_MEDIA_STATUS,
  30         HW_VAR_MEDIA_STATUS1,
  31         HW_VAR_SET_OPMODE,
  32         HW_VAR_MAC_ADDR,
  33         HW_VAR_BSSID,
  34         HW_VAR_INIT_RTS_RATE,
  35         HW_VAR_BASIC_RATE,
  36         HW_VAR_TXPAUSE,
  37         HW_VAR_BCN_FUNC,
  38         HW_VAR_CORRECT_TSF,
  39         HW_VAR_CHECK_BSSID,
  40         HW_VAR_MLME_DISCONNECT,
  41         HW_VAR_MLME_SITESURVEY,
  42         HW_VAR_MLME_JOIN,
  43         HW_VAR_BEACON_INTERVAL,
  44         HW_VAR_SLOT_TIME,
  45         HW_VAR_RESP_SIFS,
  46         HW_VAR_ACK_PREAMBLE,
  47         HW_VAR_SEC_CFG,
  48         HW_VAR_BCN_VALID,
  49         HW_VAR_RF_TYPE,
  50         HW_VAR_DM_FLAG,
  51         HW_VAR_DM_FUNC_OP,
  52         HW_VAR_DM_FUNC_SET,
  53         HW_VAR_DM_FUNC_CLR,
  54         HW_VAR_CAM_EMPTY_ENTRY,
  55         HW_VAR_CAM_INVALID_ALL,
  56         HW_VAR_CAM_WRITE,
  57         HW_VAR_CAM_READ,
  58         HW_VAR_AC_PARAM_VO,
  59         HW_VAR_AC_PARAM_VI,
  60         HW_VAR_AC_PARAM_BE,
  61         HW_VAR_AC_PARAM_BK,
  62         HW_VAR_ACM_CTRL,
  63         HW_VAR_AMPDU_MIN_SPACE,
  64         HW_VAR_AMPDU_FACTOR,
  65         HW_VAR_RXDMA_AGG_PG_TH,
  66         HW_VAR_SET_RPWM,
  67         HW_VAR_H2C_FW_PWRMODE,
  68         HW_VAR_H2C_FW_JOINBSSRPT,
  69         HW_VAR_FWLPS_RF_ON,
  70         HW_VAR_H2C_FW_P2P_PS_OFFLOAD,
  71         HW_VAR_TDLS_WRCR,
  72         HW_VAR_TDLS_INIT_CH_SEN,
  73         HW_VAR_TDLS_RS_RCR,
  74         HW_VAR_TDLS_DONE_CH_SEN,
  75         HW_VAR_INITIAL_GAIN,
  76         HW_VAR_TRIGGER_GPIO_0,
  77         HW_VAR_BT_SET_COEXIST,
  78         HW_VAR_BT_ISSUE_DELBA,
  79         HW_VAR_CURRENT_ANTENNA,
  80         HW_VAR_ANTENNA_DIVERSITY_LINK,
  81         HW_VAR_ANTENNA_DIVERSITY_SELECT,
  82         HW_VAR_SWITCH_EPHY_WoWLAN,
  83         HW_VAR_EFUSE_USAGE,
  84         HW_VAR_EFUSE_BYTES,
  85         HW_VAR_EFUSE_BT_USAGE,
  86         HW_VAR_EFUSE_BT_BYTES,
  87         HW_VAR_FIFO_CLEARN_UP,
  88         HW_VAR_CHECK_TXBUF,
  89         HW_VAR_APFM_ON_MAC, /* Auto FSM to Turn On, include clock, isolation,
  90                              * power control for MAC only */
  91         /*  The valid upper nav range for the HW updating, if the true value is
  92          *  larger than the upper range, the HW won't update it. */
  93         /*  Unit in microsecond. 0 means disable this function. */
  94         HW_VAR_NAV_UPPER,
  95         HW_VAR_RPT_TIMER_SETTING,
  96         HW_VAR_TX_RPT_MAX_MACID,
  97         HW_VAR_H2C_MEDIA_STATUS_RPT,
  98         HW_VAR_CHK_HI_QUEUE_EMPTY,
  99 };
 100
 101 enum hal_def_variable {
 102         HAL_DEF_UNDERCORATEDSMOOTHEDPWDB,
 103         HAL_DEF_IS_SUPPORT_ANT_DIV,
 104         HAL_DEF_CURRENT_ANTENNA,
 105         HAL_DEF_DRVINFO_SZ,
 106         HAL_DEF_MAX_RECVBUF_SZ,
 107         HAL_DEF_RX_PACKET_OFFSET,
 108         HAL_DEF_DBG_DUMP_RXPKT,/* for dbg */
 109         HAL_DEF_DBG_DM_FUNC,/* for dbg */
 110         HAL_DEF_RA_DECISION_RATE,
 111         HAL_DEF_RA_SGI,
 112         HAL_DEF_PT_PWR_STATUS,
 113         HW_VAR_MAX_RX_AMPDU_FACTOR,
 114         HW_DEF_RA_INFO_DUMP,
 115         HAL_DEF_DBG_DUMP_TXPKT,
 116 };
 117
 118 enum hal_odm_variable {
 119         HAL_ODM_STA_INFO,
 120         HAL_ODM_P2P_STATE,
 121         HAL_ODM_WIFI_DISPLAY_STATE,
 122 };
 123
 124 enum hal_intf_ps_func {
 125         HAL_USB_SELECT_SUSPEND,
 126         HAL_MAX_ID,
 127 };
 128
 129 typedef s32 (*c2h_id_filter)(u8 id);
 130
 131 struct hal_ops {
 132         u32     (*hal_power_on)(struct adapter *padapter);
 133         u32     (*hal_init)(struct adapter *padapter);
 134         u32     (*hal_deinit)(struct adapter *padapter);
 135
 136         void    (*free_hal_data)(struct adapter *padapter);
 137
 138         u32     (*inirp_init)(struct adapter *padapter);
 139         u32     (*inirp_deinit)(struct adapter *padapter);
 140
 141         s32     (*init_xmit_priv)(struct adapter *padapter);
 142         void    (*free_xmit_priv)(struct adapter *padapter);
 143
 144         s32     (*init_recv_priv)(struct adapter *padapter);
 145         void    (*free_recv_priv)(struct adapter *padapter);
 146
 147         void    (*InitSwLeds)(struct adapter *padapter);
 148         void    (*DeInitSwLeds)(struct adapter *padapter);
 149
 150         void    (*dm_init)(struct adapter *padapter);
 151         void    (*dm_deinit)(struct adapter *padapter);
 152         void    (*read_chip_version)(struct adapter *padapter);
 153
 154         void    (*init_default_value)(struct adapter *padapter);
 155
 156         void    (*intf_chip_configure)(struct adapter *padapter);
 157
 158         void    (*read_adapter_info)(struct adapter *padapter);
 159
 160         void    (*enable_interrupt)(struct adapter *padapter);
 161         void    (*disable_interrupt)(struct adapter *padapter);
 162         s32     (*interrupt_handler)(struct adapter *padapter);
 163
 164         void    (*set_bwmode_handler)(struct adapter *padapter,
 165                                       enum ht_channel_width Bandwidth,
 166                                       u8 Offset);
 167         void    (*set_channel_handler)(struct adapter *padapter, u8 channel);
 168
 169         void    (*hal_dm_watchdog)(struct adapter *padapter);
 170
 171         void    (*SetHwRegHandler)(struct adapter *padapter, u8 variable,
 172                                    u8 *val);
 173         void    (*GetHwRegHandler)(struct adapter *padapter, u8 variable,
 174                                    u8 *val);
 175
 176         u8      (*GetHalDefVarHandler)(struct adapter *padapter,
 177                                        enum hal_def_variable eVariable,
 178                                        void *pValue);
 179         u8      (*SetHalDefVarHandler)(struct adapter *padapter,
 180                                        enum hal_def_variable eVariable,
 181                                        void *pValue);
 182
 183         void    (*GetHalODMVarHandler)(struct adapter *padapter,
 184                                        enum hal_odm_variable eVariable,
 185                                        void *pValue1, bool bSet);
 186         void    (*SetHalODMVarHandler)(struct adapter *padapter,
 187                                        enum hal_odm_variable eVariable,
 188                                        void *pValue1, bool bSet);
 189
 190         void    (*UpdateRAMaskHandler)(struct adapter *padapter,
 191                                        u32 mac_id, u8 rssi_level);
 192         void    (*SetBeaconRelatedRegistersHandler)(struct adapter *padapter);
 193
 194         void    (*Add_RateATid)(struct adapter *adapter, u32 bitmap, u8 arg,
 195                                 u8 rssi_level);
 196         void    (*run_thread)(struct adapter *adapter);
 197         void    (*cancel_thread)(struct adapter *adapter);
 198
 199         u8      (*AntDivBeforeLinkHandler)(struct adapter *adapter);
 200         void    (*AntDivCompareHandler)(struct adapter *adapter,
 201                                         struct wlan_bssid_ex *dst,
 202                                         struct wlan_bssid_ex *src);
 203         u8      (*interface_ps_func)(struct adapter *padapter,
 204                                      enum hal_intf_ps_func efunc_id, u8 *val);
 205
 206         s32     (*hal_xmit)(struct adapter *padapter,
 207                             struct xmit_frame *pxmitframe);
 208         s32 (*mgnt_xmit)(struct adapter *padapter,
 209                          struct xmit_frame *pmgntframe);
 210         s32 (*hal_xmitframe_enqueue)(struct adapter *padapter,
 211                                      struct xmit_frame *pxmitframe);
 212
 213         u32     (*read_bbreg)(struct adapter *padapter, u32 RegAddr,
 214                               u32 BitMask);
 215         void    (*write_bbreg)(struct adapter *padapter, u32 RegAddr,
 216                                u32 BitMask, u32 Data);
 217         u32     (*read_rfreg)(struct adapter *padapter,
 218                               enum rf_radio_path eRFPath, u32 RegAddr,
 219                               u32 BitMask);
 220         void    (*write_rfreg)(struct adapter *padapter,
 221                                enum rf_radio_path eRFPath, u32 RegAddr,
 222                                u32 BitMask, u32 Data);
 223
 224         void (*EfusePowerSwitch)(struct adapter *padapter, u8 bWrite,
 225                                  u8 PwrState);
 226         void (*ReadEFuse)(struct adapter *padapter, u8 efuseType, u16 _offset,
 227                           u16 _size_byte, u8 *pbuf, bool bPseudoTest);
 228         void (*EFUSEGetEfuseDefinition)(struct adapter *padapter, u8 efuseType,
 229                                         u8 type, void *pOut, bool bPseudoTest);
 230         u16     (*EfuseGetCurrentSize)(struct adapter *padapter, u8 efuseType,
 231                                        bool bPseudoTest);
 232         int     (*Efuse_PgPacketRead)(struct adapter *adapter, u8 offset,
 233                                       u8 *data, bool bPseudoTest);
 234         int     (*Efuse_PgPacketWrite)(struct adapter *padapter, u8 offset,
 235                                        u8 word_en, u8 *data, bool bPseudoTest);
 236         u8      (*Efuse_WordEnableDataWrite)(struct adapter *padapter,
 237                                              u16 efuse_addr, u8 word_en,
 238                                              u8 *data, bool bPseudoTest);
 239         bool    (*Efuse_PgPacketWrite_BT)(struct adapter *padapter, u8 offset,
 240                                           u8 word_en, u8 *data, bool test);
 241
 242         void (*sreset_init_value)(struct adapter *padapter);
 243         void (*sreset_reset_value)(struct adapter *padapter);
 244         void (*silentreset)(struct adapter *padapter);
 245         void (*sreset_xmit_status_check)(struct adapter *padapter);
 246         void (*sreset_linked_status_check) (struct adapter *padapter);
 247         u8 (*sreset_get_wifi_status)(struct adapter *padapter);
 248
 249         int (*IOL_exec_cmds_sync)(struct adapter *padapter,
 250                                   struct xmit_frame *frame, u32 max_wait,
 251                                   u32 bndy_cnt);
 252
 253         void (*hal_notch_filter)(struct adapter *adapter, bool enable);
 254         void (*hal_reset_security_engine)(struct adapter *adapter);
 255         s32 (*c2h_handler)(struct adapter *padapter,
 256                            struct c2h_evt_hdr *c2h_evt);
 257         c2h_id_filter c2h_id_filter_ccx;
 258 };
 259
 260 enum rt_eeprom_type {
 261         EEPROM_93C46,
 262         EEPROM_93C56,
 263         EEPROM_BOOT_EFUSE,
 264 };
 265
 266 #define RF_CHANGE_BY_INIT       0
 267 #define RF_CHANGE_BY_IPS        BIT28
 268 #define RF_CHANGE_BY_PS         BIT29
 269 #define RF_CHANGE_BY_HW         BIT30
 270 #define RF_CHANGE_BY_SW         BIT31
 271
 272 enum hardware_type {
 273         HARDWARE_TYPE_RTL8180,
 274         HARDWARE_TYPE_RTL8185,
 275         HARDWARE_TYPE_RTL8187,
 276         HARDWARE_TYPE_RTL8188,
 277         HARDWARE_TYPE_RTL8190P,
 278         HARDWARE_TYPE_RTL8192E,
 279         HARDWARE_TYPE_RTL819xU,
 280         HARDWARE_TYPE_RTL8192SE,
 281         HARDWARE_TYPE_RTL8192SU,
 282         HARDWARE_TYPE_RTL8192CE,
 283         HARDWARE_TYPE_RTL8192CU,
 284         HARDWARE_TYPE_RTL8192DE,
 285         HARDWARE_TYPE_RTL8192DU,
 286         HARDWARE_TYPE_RTL8723AE,
 287         HARDWARE_TYPE_RTL8723AU,
 288         HARDWARE_TYPE_RTL8723AS,
 289         HARDWARE_TYPE_RTL8188EE,
 290         HARDWARE_TYPE_RTL8188EU,
 291         HARDWARE_TYPE_RTL8188ES,
 292         HARDWARE_TYPE_MAX,
 293 };
 294
 295 /*  RTL8188E Series */
 296 #define IS_HARDWARE_TYPE_8188EE(_Adapter)                       \
 297 (((struct adapter *)_Adapter)->HardwareType == HARDWARE_TYPE_RTL8188EE)
 298 #define IS_HARDWARE_TYPE_8188EU(_Adapter)                       \
 299 (((struct adapter *)_Adapter)->HardwareType == HARDWARE_TYPE_RTL8188EU)
 300 #define IS_HARDWARE_TYPE_8188ES(_Adapter)                       \
 301 (((struct adapter *)_Adapter)->HardwareType == HARDWARE_TYPE_RTL8188ES)
 302 #define IS_HARDWARE_TYPE_8188E(_Adapter)        \
 303 (IS_HARDWARE_TYPE_8188EE(_Adapter) || IS_HARDWARE_TYPE_8188EU(_Adapter) || \
 304  IS_HARDWARE_TYPE_8188ES(_Adapter))
 305
 306 #define GET_EEPROM_EFUSE_PRIV(adapter) (&adapter->eeprompriv)
 307
 308 #define is_boot_from_eeprom(adapter) (adapter->eeprompriv.EepromOrEfuse)
 309
 310 void rtl8188eu_set_hal_ops(struct adapter *padapter);
 311 void rtw_hal_def_value_init(struct adapter *padapter);
 312
 313 void    rtw_hal_free_data(struct adapter *padapter);
 314
 315 void rtw_hal_dm_init(struct adapter *padapter);
 316 void rtw_hal_dm_deinit(struct adapter *padapter);
 317 void rtw_hal_sw_led_init(struct adapter *padapter);
 318 void rtw_hal_sw_led_deinit(struct adapter *padapter);
 319
 320 u32 rtw_hal_power_on(struct adapter *padapter);
 321 uint rtw_hal_init(struct adapter *padapter);
 322 uint rtw_hal_deinit(struct adapter *padapter);
 323 void rtw_hal_stop(struct adapter *padapter);
 324 void rtw_hal_set_hwreg(struct adapter *padapter, u8 variable, u8 *val);
 325 void rtw_hal_get_hwreg(struct adapter *padapter, u8 variable, u8 *val);
 326
 327 void rtw_hal_chip_configure(struct adapter *padapter);
 328 void rtw_hal_read_chip_info(struct adapter *padapter);
 329 void rtw_hal_read_chip_version(struct adapter *padapter);
 330
 331 u8 rtw_hal_set_def_var(struct adapter *padapter,
 332                        enum hal_def_variable eVariable, void *pValue);
 333 u8 rtw_hal_get_def_var(struct adapter *padapter,
 334                        enum hal_def_variable eVariable, void *pValue);
 335
 336 void rtw_hal_set_odm_var(struct adapter *padapter,
 337                          enum hal_odm_variable eVariable, void *pValue1,
 338                          bool bSet);
 339 void rtw_hal_get_odm_var(struct adapter *padapter,
 340                          enum hal_odm_variable eVariable,
 341                          void *pValue1, bool bSet);
 342
 343 void rtw_hal_enable_interrupt(struct adapter *padapter);
 344 void rtw_hal_disable_interrupt(struct adapter *padapter);
 345
 346 u32     rtw_hal_inirp_init(struct adapter *padapter);
 347 u32     rtw_hal_inirp_deinit(struct adapter *padapter);
 348
 349 u8      rtw_hal_intf_ps_func(struct adapter *padapter,
 350                              enum hal_intf_ps_func efunc_id, u8 *val);
 351 s32 rtw_hal_xmitframe_enqueue(struct adapter *padapter,
 352                               struct xmit_frame *pxmitframe);
 353
 354 s32     rtw_hal_xmit(struct adapter *padapter, struct xmit_frame *pxmitframe);
 355 s32     rtw_hal_mgnt_xmit(struct adapter *padapter,
 356                           struct xmit_frame *pmgntframe);
 357
 358 s32     rtw_hal_init_xmit_priv(struct adapter *padapter);
 359 void    rtw_hal_free_xmit_priv(struct adapter *padapter);
 360
 361 s32     rtw_hal_init_recv_priv(struct adapter *padapter);
 362 void    rtw_hal_free_recv_priv(struct adapter *padapter);
 363
 364 void rtw_hal_update_ra_mask(struct adapter *padapter, u32 mac_id, u8 level);
 365 void    rtw_hal_add_ra_tid(struct adapter *adapt, u32 bitmap, u8 arg, u8 level);
 366 void    rtw_hal_clone_data(struct adapter *dst_adapt,
 367                            struct adapter *src_adapt);
 368 void    rtw_hal_start_thread(struct adapter *padapter);
 369 void    rtw_hal_stop_thread(struct adapter *padapter);
 370
 371 void rtw_hal_bcn_related_reg_setting(struct adapter *padapter);
 372
 373 u32     rtw_hal_read_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask);
 374 void    rtw_hal_write_bbreg(struct adapter *padapter, u32 RegAddr, u32 BitMask,
 375                             u32 Data);
 376 u32     rtw_hal_read_rfreg(struct adapter *padapter, enum rf_radio_path eRFPath,
 377                            u32 RegAddr, u32 BitMask);
 378 void    rtw_hal_write_rfreg(struct adapter *padapter,
 379                             enum rf_radio_path eRFPath, u32 RegAddr,
 380                             u32 BitMask, u32 Data);
 381
 382 s32     rtw_hal_interrupt_handler(struct adapter *padapter);
 383
 384 void    rtw_hal_set_bwmode(struct adapter *padapter,
 385                            enum ht_channel_width Bandwidth, u8 Offset);
 386 void    rtw_hal_set_chan(struct adapter *padapter, u8 channel);
 387 void    rtw_hal_dm_watchdog(struct adapter *padapter);
 388
 389 u8      rtw_hal_antdiv_before_linked(struct adapter *padapter);
 390 void    rtw_hal_antdiv_rssi_compared(struct adapter *padapter,
 391                                      struct wlan_bssid_ex *dst,
 392                                      struct wlan_bssid_ex *src);
 393
 394 void rtw_hal_sreset_init(struct adapter *padapter);
 395 void rtw_hal_sreset_reset(struct adapter *padapter);
 396 void rtw_hal_sreset_reset_value(struct adapter *padapter);
 397 void rtw_hal_sreset_xmit_status_check(struct adapter *padapter);
 398 void rtw_hal_sreset_linked_status_check(struct adapter *padapter);
 399 u8   rtw_hal_sreset_get_wifi_status(struct adapter *padapter);
 400
 401 int rtw_hal_iol_cmd(struct adapter  *adapter, struct xmit_frame *xmit_frame,
 402                     u32 max_wating_ms, u32 bndy_cnt);
 403
 404 void rtw_hal_notch_filter(struct adapter *adapter, bool enable);
 405 void rtw_hal_reset_security_engine(struct adapter *adapter);
 406
 407 s32 rtw_hal_c2h_handler(struct adapter *adapter,
 408                         struct c2h_evt_hdr *c2h_evt);
 409 c2h_id_filter rtw_hal_c2h_id_filter_ccx(struct adapter *adapter);
 410 void indicate_wx_scan_complete_event(struct adapter *padapter);
 411 u8 rtw_do_join(struct adapter *padapter);
 412
 413 #endif /* __HAL_INTF_H__ */