drivers/net/wireless/rockchip_wlan/rtl8723ds/include/rtl8192e_hal.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2007 - 2013 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 __RTL8192E_HAL_H__
  21 #define __RTL8192E_HAL_H__
  22
  23 /* #include "hal_com.h" */
  24
  25 #include "hal_data.h"
  26
  27 /* include HAL Related header after HAL Related compiling flags */
  28 #include "rtl8192e_spec.h"
  29 #include "rtl8192e_rf.h"
  30 #include "rtl8192e_dm.h"
  31 #include "rtl8192e_recv.h"
  32 #include "rtl8192e_xmit.h"
  33 #include "rtl8192e_cmd.h"
  34 #include "rtl8192e_led.h"
  35 #include "Hal8192EPwrSeq.h"
  36 #include "Hal8192EPhyReg.h"
  37 #include "Hal8192EPhyCfg.h"
  38
  39
  40 #ifdef DBG_CONFIG_ERROR_DETECT
  41         #include "rtl8192e_sreset.h"
  42 #endif
  43
  44 /* ---------------------------------------------------------------------
  45  *              RTL8192E Power Configuration CMDs for PCIe interface
  46  * --------------------------------------------------------------------- */
  47 #define Rtl8192E_NIC_PWR_ON_FLOW                                rtl8192E_power_on_flow
  48 #define Rtl8192E_NIC_RF_OFF_FLOW                                rtl8192E_radio_off_flow
  49 #define Rtl8192E_NIC_DISABLE_FLOW                               rtl8192E_card_disable_flow
  50 #define Rtl8192E_NIC_ENABLE_FLOW                                rtl8192E_card_enable_flow
  51 #define Rtl8192E_NIC_SUSPEND_FLOW                               rtl8192E_suspend_flow
  52 #define Rtl8192E_NIC_RESUME_FLOW                                rtl8192E_resume_flow
  53 #define Rtl8192E_NIC_PDN_FLOW                                   rtl8192E_hwpdn_flow
  54 #define Rtl8192E_NIC_LPS_ENTER_FLOW                     rtl8192E_enter_lps_flow
  55 #define Rtl8192E_NIC_LPS_LEAVE_FLOW                     rtl8192E_leave_lps_flow
  56
  57
  58 #if 1 /* download firmware related data structure */
  59 #define FW_SIZE_8192E                   0x8000 /* Compatible with RTL8192e Maximal RAM code size 32k */
  60 #define FW_START_ADDRESS                0x1000
  61 #define FW_END_ADDRESS                  0x5FFF
  62
  63
  64 #define IS_FW_HEADER_EXIST_8192E(_pFwHdr)       ((GET_FIRMWARE_HDR_SIGNATURE_8192E(_pFwHdr) & 0xFFF0) == 0x92E0)
  65
  66
  67
  68 typedef struct _RT_FIRMWARE_8192E {
  69         FIRMWARE_SOURCE eFWSource;
  70 #ifdef CONFIG_EMBEDDED_FWIMG
  71         u8                      *szFwBuffer;
  72 #else
  73         u8                      szFwBuffer[FW_SIZE_8192E];
  74 #endif
  75         u32                     ulFwLength;
  76 } RT_FIRMWARE_8192E, *PRT_FIRMWARE_8192E;
  77
  78 /*
  79  * This structure must be cared byte-ordering
  80  *
  81  * Added by tynli. 2009.12.04. */
  82
  83 /* *****************************************************
  84  *                                      Firmware Header(8-byte alinment required)
  85  * *****************************************************
  86  * --- LONG WORD 0 ---- */
  87 #define GET_FIRMWARE_HDR_SIGNATURE_8192E(__FwHdr)               LE_BITS_TO_4BYTE(__FwHdr, 0, 16) /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */
  88 #define GET_FIRMWARE_HDR_CATEGORY_8192E(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr, 16, 8) /* AP/NIC and USB/PCI */
  89 #define GET_FIRMWARE_HDR_FUNCTION_8192E(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr, 24, 8) /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */
  90 #define GET_FIRMWARE_HDR_VERSION_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)/* FW Version */
  91 #define GET_FIRMWARE_HDR_SUB_VER_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) /* FW Subversion, default 0x00 */
  92 #define GET_FIRMWARE_HDR_RSVD1_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8)
  93
  94 /* --- LONG WORD 1 ---- */
  95 #define GET_FIRMWARE_HDR_MONTH_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+8, 0, 8) /* Release time Month field */
  96 #define GET_FIRMWARE_HDR_DATE_8192E(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+8, 8, 8) /* Release time Date field */
  97 #define GET_FIRMWARE_HDR_HOUR_8192E(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+8, 16, 8)/* Release time Hour field */
  98 #define GET_FIRMWARE_HDR_MINUTE_8192E(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+8, 24, 8)/* Release time Minute field */
  99 #define GET_FIRMWARE_HDR_ROMCODE_SIZE_8192E(__FwHdr)    LE_BITS_TO_4BYTE(__FwHdr+12, 0, 16)/* The size of RAM code */
 100 #define GET_FIRMWARE_HDR_RSVD2_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+12, 16, 16)
 101
 102 /* --- LONG WORD 2 ---- */
 103 #define GET_FIRMWARE_HDR_SVN_IDX_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+16, 0, 32)/* The SVN entry index */
 104 #define GET_FIRMWARE_HDR_RSVD3_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+20, 0, 32)
 105
 106 /* --- LONG WORD 3 ---- */
 107 #define GET_FIRMWARE_HDR_RSVD4_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+24, 0, 32)
 108 #define GET_FIRMWARE_HDR_RSVD5_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32)
 109
 110 #endif /* download firmware related data structure */
 111
 112 #define DRIVER_EARLY_INT_TIME_8192E             0x05
 113 #define BCN_DMA_ATIME_INT_TIME_8192E            0x02
 114 #define RX_DMA_SIZE_8192E                                       0x4000  /* 16K*/
 115
 116 #ifdef CONFIG_WOWLAN
 117         #define RESV_FMWF       (WKFMCAM_SIZE * MAX_WKFM_NUM) /* 16 entries, for each is 24 bytes*/
 118 #else
 119         #define RESV_FMWF       0
 120 #endif
 121
 122 #ifdef CONFIG_FW_C2H_DEBUG
 123         #define RX_DMA_RESERVED_SIZE_8192E      0x100   /* 256B, reserved for c2h debug message*/
 124 #else
 125         #define RX_DMA_RESERVED_SIZE_8192E      0x40    /* 64B, reserved for c2h event(16bytes) or ccx(8 Bytes)*/
 126 #endif
 127 #define MAX_RX_DMA_BUFFER_SIZE_8192E            (RX_DMA_SIZE_8192E-RX_DMA_RESERVED_SIZE_8192E)  /*RX 16K*/
 128
 129 /* For General Reserved Page Number(Beacon Queue is reserved page)
 130  * if (CONFIG_2BCN_EN) Beacon:4, PS-Poll:1, Null Data:1,Prob Rsp:1,Qos Null Data:1
 131  * Beacon:2, PS-Poll:1, Null Data:1,Prob Rsp:1,Qos Null Data:1 */
 132 #define RSVD_PAGE_NUM_8192E             0x08
 133 /* For WoWLan , more reserved page
 134  * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:2,GTK EXT MEM:2, PNO: 6 */
 135 #ifdef CONFIG_WOWLAN
 136         #define WOWLAN_PAGE_NUM_8192E   0x07
 137 #else
 138         #define WOWLAN_PAGE_NUM_8192E   0x00
 139 #endif
 140
 141 #ifdef CONFIG_PNO_SUPPORT
 142         #undef WOWLAN_PAGE_NUM_8192E
 143         #define WOWLAN_PAGE_NUM_8192E   0x0d
 144 #endif
 145
 146 /* Note:
 147 Tx FIFO Size : 64KB
 148 Tx page Size : 256B
 149 Total page numbers : 256(0x100)
 150 */
 151
 152 #define TOTAL_RSVD_PAGE_NUMBER_8192E    (RSVD_PAGE_NUM_8192E + WOWLAN_PAGE_NUM_8192E)
 153
 154 #define TOTAL_PAGE_NUMBER_8192E (0x100)
 155 #define TX_TOTAL_PAGE_NUMBER_8192E      (TOTAL_PAGE_NUMBER_8192E - TOTAL_RSVD_PAGE_NUMBER_8192E)
 156
 157 #define TX_PAGE_BOUNDARY_8192E  (TX_TOTAL_PAGE_NUMBER_8192E) /* beacon header start address */
 158
 159
 160 #define PAGE_SIZE_TX_92E        PAGE_SIZE_256
 161 #define RSVD_PKT_LEN_92E        (TOTAL_RSVD_PAGE_NUMBER_8192E * PAGE_SIZE_TX_92E)
 162
 163 #define TX_PAGE_LOAD_FW_BOUNDARY_8192E          0x47 /* 0xA5 */
 164 #define TX_PAGE_BOUNDARY_WOWLAN_8192E           0xE0
 165
 166 /* For Normal Chip Setting
 167  * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_92C */
 168
 169 #define NORMAL_PAGE_NUM_HPQ_8192E                       0x10
 170 #define NORMAL_PAGE_NUM_LPQ_8192E                       0x10
 171 #define NORMAL_PAGE_NUM_NPQ_8192E                       0x10
 172 #define NORMAL_PAGE_NUM_EPQ_8192E                       0x00
 173
 174
 175 /* Note: For WMM Normal Chip Setting ,modify later */
 176 #define WMM_NORMAL_PAGE_NUM_HPQ_8192E           NORMAL_PAGE_NUM_HPQ_8192E
 177 #define WMM_NORMAL_PAGE_NUM_LPQ_8192E           NORMAL_PAGE_NUM_LPQ_8192E
 178 #define WMM_NORMAL_PAGE_NUM_NPQ_8192E           NORMAL_PAGE_NUM_NPQ_8192E
 179
 180
 181 /* -------------------------------------------------------------------------
 182  *      Chip specific
 183  * ------------------------------------------------------------------------- */
 184
 185 /* pic buffer descriptor */
 186 #define RTL8192EE_SEG_NUM                       TX_BUFFER_SEG_NUM
 187 #define TX_DESC_NUM_92E                 128
 188 #define RX_DESC_NUM_92E                 128
 189
 190 /* -------------------------------------------------------------------------
 191  *      Channel Plan
 192  * ------------------------------------------------------------------------- */
 193
 194 #define         HWSET_MAX_SIZE_8192E                    512
 195
 196 #define         EFUSE_REAL_CONTENT_LEN_8192E    512
 197
 198 #define         EFUSE_MAP_LEN_8192E                     512
 199 #define         EFUSE_MAX_SECTION_8192E         64
 200 #define         EFUSE_MAX_WORD_UNIT_8192E               4
 201 #define         EFUSE_IC_ID_OFFSET_8192E                506     /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
 202 #define         AVAILABLE_EFUSE_ADDR_8192E(addr)        (addr < EFUSE_REAL_CONTENT_LEN_8192E)
 203 /*
 204  * <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section
 205  * 9bytes + 1byt + 5bytes and pre 1byte.
 206  * For worst case:
 207  * | 1byte|----8bytes----|1byte|--5bytes--|
 208  * |         |            Reserved(14bytes)           |
 209  *   */
 210 #define         EFUSE_OOB_PROTECT_BYTES_8192E           15      /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */
 211
 212
 213
 214 /* ********************************************************
 215  *                      EFUSE for BT definition
 216  * ******************************************************** */
 217 #define         EFUSE_BT_REAL_BANK_CONTENT_LEN_8192E    512
 218 #define         EFUSE_BT_REAL_CONTENT_LEN_8192E                 1024    /* 512*2 */
 219 #define         EFUSE_BT_MAP_LEN_8192E                                  1024    /* 1k bytes */
 220 #define         EFUSE_BT_MAX_SECTION_8192E                              128             /* 1024/8 */
 221
 222 #define         EFUSE_PROTECT_BYTES_BANK_8192E                  16
 223 #define         EFUSE_MAX_BANK_8192E                                    3
 224 /* *********************************************************** */
 225
 226 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
 227 #define INCLUDE_MULTI_FUNC_GPS(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
 228
 229 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */
 230
 231 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */
 232
 233 /* rtl8812_hal_init.c */
 234 void    _8051Reset8192E(PADAPTER padapter);
 235 s32     FirmwareDownload8192E(PADAPTER Adapter, BOOLEAN bUsedWoWLANFw);
 236 void    InitializeFirmwareVars8192E(PADAPTER padapter);
 237
 238 s32     InitLLTTable8192E(PADAPTER padapter, u8 txpktbuf_bndy);
 239
 240 /* EFuse */
 241 u8      GetEEPROMSize8192E(PADAPTER padapter);
 242 void    hal_InitPGData_8192E(PADAPTER padapter, u8 *PROMContent);
 243 void    Hal_EfuseParseIDCode8192E(PADAPTER padapter, u8 *hwinfo);
 244 void    Hal_ReadPROMVersion8192E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 245 void    Hal_ReadPowerSavingMode8192E(PADAPTER padapter, u8      *hwinfo, BOOLEAN        AutoLoadFail);
 246 void    Hal_ReadTxPowerInfo8192E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 247 void    Hal_ReadBoardType8192E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 248 void    Hal_ReadThermalMeter_8192E(PADAPTER     Adapter, u8 *PROMContent, BOOLEAN       AutoloadFail);
 249 void    Hal_ReadChannelPlan8192E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 250 void    Hal_EfuseParseXtal_8192E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 251 void    Hal_ReadAntennaDiversity8192E(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
 252 void    Hal_ReadPAType_8192E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 253 void    Hal_ReadAmplifierType_8192E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 254 void    Hal_ReadRFEType_8192E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
 255 void    Hal_EfuseParseBTCoexistInfo8192E(PADAPTER Adapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 256 void    Hal_EfuseParseKFreeData_8192E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
 257
 258 u8 Hal_CrystalAFEAdjust(_adapter *Adapter);
 259
 260 BOOLEAN HalDetectPwrDownMode8192E(PADAPTER Adapter);
 261
 262 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN)
 263         void Hal_DetectWoWMode(PADAPTER pAdapter);
 264 #endif /* CONFIG_WOWLAN */
 265
 266 /***********************************************************/
 267 /* RTL8192E-MAC Setting */
 268 VOID _InitQueueReservedPage_8192E(IN  PADAPTER Adapter);
 269 VOID _InitQueuePriority_8192E(IN        PADAPTER Adapter);
 270 VOID _InitTxBufferBoundary_8192E(IN PADAPTER Adapter, IN u8 txpktbuf_bndy);
 271 VOID _InitPageBoundary_8192E(IN PADAPTER Adapter);
 272 /* VOID _InitTransferPageSize_8192E(IN PADAPTER Adapter); */
 273 VOID _InitDriverInfoSize_8192E(IN PADAPTER Adapter, IN u8 drvInfoSize);
 274 VOID _InitRDGSetting_8192E(PADAPTER Adapter);
 275 void _InitID_8192E(IN  PADAPTER Adapter);
 276 VOID _InitNetworkType_8192E(IN  PADAPTER Adapter);
 277 VOID _InitWMACSetting_8192E(IN PADAPTER Adapter);
 278 VOID _InitAdaptiveCtrl_8192E(IN  PADAPTER Adapter);
 279 VOID _InitRateFallback_8192E(IN  PADAPTER Adapter);
 280 VOID _InitEDCA_8192E(IN  PADAPTER Adapter);
 281 VOID _InitRetryFunction_8192E(IN  PADAPTER Adapter);
 282 VOID _BBTurnOnBlock_8192E(IN    PADAPTER Adapter);
 283 VOID _InitBeaconParameters_8192E(IN  PADAPTER Adapter);
 284 VOID _InitBeaconMaxError_8192E(
 285         IN  PADAPTER    Adapter,
 286         IN      BOOLEAN         InfraMode
 287 );
 288 void SetBeaconRelatedRegisters8192E(PADAPTER padapter);
 289 VOID hal_ReadRFType_8192E(PADAPTER      Adapter);
 290 /* RTL8192E-MAC Setting
 291  ***********************************************************/
 292
 293 void SetHwReg8192E(PADAPTER Adapter, u8 variable, u8 *val);
 294 void GetHwReg8192E(PADAPTER Adapter, u8 variable, u8 *val);
 295 u8
 296 SetHalDefVar8192E(
 297         IN      PADAPTER                                Adapter,
 298         IN      HAL_DEF_VARIABLE                eVariable,
 299         IN      PVOID                                   pValue
 300 );
 301 u8
 302 GetHalDefVar8192E(
 303         IN      PADAPTER                                Adapter,
 304         IN      HAL_DEF_VARIABLE                eVariable,
 305         IN      PVOID                                   pValue
 306 );
 307
 308 void rtl8192e_set_hal_ops(struct hal_ops *pHalFunc);
 309 void init_hal_spec_8192e(_adapter *adapter);
 310 void rtl8192e_init_default_value(_adapter *padapter);
 311 /* register */
 312 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
 313
 314 void rtl8192e_start_thread(_adapter *padapter);
 315 void rtl8192e_stop_thread(_adapter *padapter);
 316
 317 #ifdef CONFIG_PCI_HCI
 318         BOOLEAN InterruptRecognized8192EE(PADAPTER Adapter);
 319         u16     get_txdesc_buf_addr(u16 ff_hwaddr);
 320 #endif
 321
 322 #ifdef CONFIG_SDIO_HCI
 323         #ifdef CONFIG_SDIO_TX_ENABLE_AVAL_INT
 324                 void _init_available_page_threshold(PADAPTER padapter, u8 numHQ, u8 numNQ, u8 numLQ, u8 numPubQ);
 325         #endif
 326 #endif
 327
 328 #ifdef CONFIG_BT_COEXIST
 329         void rtl8192e_combo_card_WifiOnlyHwInit(PADAPTER Adapter);
 330 #endif
 331
 332 #endif /* __RTL8192E_HAL_H__ */