Pileus Git - ~andy/linux/blob - drivers/staging/rtl8188eu/include/hal_intf.h

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