drivers/net/wireless/rtl8188eu/include/rtl8192e_hal.h

   1 /******************************************************************************\r
   2  *\r
   3  * Copyright(c) 2007 - 2013 Realtek Corporation. All rights reserved.\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or modify it\r
   6  * under the terms of version 2 of the GNU General Public License as\r
   7  * published by the Free Software Foundation.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful, but WITHOUT\r
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for\r
  12  * more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License along with\r
  15  * this program; if not, write to the Free Software Foundation, Inc.,\r
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA\r
  17  *\r
  18  *\r
  19  ******************************************************************************/\r
  20 #ifndef __RTL8192E_HAL_H__\r
  21 #define __RTL8192E_HAL_H__\r
  22 \r
  23 //#include "hal_com.h"\r
  24 \r
  25 #if 1\r
  26 #include "hal_data.h"\r
  27 #else\r
  28 #include "../hal/OUTSRC/odm_precomp.h"\r
  29 #endif\r
  30 \r
  31 //include HAL Related header after HAL Related compiling flags \r
  32 #include "rtl8192e_spec.h"\r
  33 #include "rtl8192e_rf.h"\r
  34 #include "rtl8192e_dm.h"\r
  35 #include "rtl8192e_recv.h"\r
  36 #include "rtl8192e_xmit.h"\r
  37 #include "rtl8192e_cmd.h"\r
  38 #include "rtl8192e_led.h"\r
  39 #include "Hal8192EPwrSeq.h"\r
  40 #include "Hal8192EPhyReg.h"\r
  41 #include "Hal8192EPhyCfg.h"\r
  42 \r
  43 \r
  44 #ifdef DBG_CONFIG_ERROR_DETECT\r
  45 #include "rtl8192e_sreset.h"\r
  46 #endif\r
  47 \r
  48 \r
  49 //---------------------------------------------------------------------\r
  50 //              RTL8192E From header\r
  51 //---------------------------------------------------------------------\r
  52         #define RTL8192E_FW_IMG                                 "rtl8192e/FW_NIC.bin"\r
  53         #define RTL8192E_FW_WW_IMG                              "rtl8192e/FW_WoWLAN.bin"\r
  54         #define RTL8192E_PHY_REG                                        "rtl8192e/PHY_REG.txt" \r
  55         #define RTL8192E_PHY_RADIO_A                            "rtl8192e/RadioA.txt"\r
  56         #define RTL8192E_PHY_RADIO_B                            "rtl8192e/RadioB.txt"\r
  57         #define RTL8192E_TXPWR_TRACK                            "rtl8192e/TxPowerTrack.txt"\r
  58         #define RTL8192E_AGC_TAB                                        "rtl8192e/AGC_TAB.txt"\r
  59         #define RTL8192E_PHY_MACREG                             "rtl8192e/MAC_REG.txt"\r
  60         #define RTL8192E_PHY_REG_PG                             "rtl8192e/PHY_REG_PG.txt"\r
  61         #define RTL8192E_PHY_REG_MP                             "rtl8192e/PHY_REG_MP.txt" \r
  62         #define RTL8192E_TXPWR_LMT                              "rtl8192e/TXPWR_LMT.txt" \r
  63 \r
  64 //---------------------------------------------------------------------\r
  65 //              RTL8192E Power Configuration CMDs for PCIe interface\r
  66 //---------------------------------------------------------------------\r
  67 #define Rtl8192E_NIC_PWR_ON_FLOW                                rtl8192E_power_on_flow\r
  68 #define Rtl8192E_NIC_RF_OFF_FLOW                                rtl8192E_radio_off_flow\r
  69 #define Rtl8192E_NIC_DISABLE_FLOW                               rtl8192E_card_disable_flow\r
  70 #define Rtl8192E_NIC_ENABLE_FLOW                                rtl8192E_card_enable_flow\r
  71 #define Rtl8192E_NIC_SUSPEND_FLOW                               rtl8192E_suspend_flow\r
  72 #define Rtl8192E_NIC_RESUME_FLOW                                rtl8192E_resume_flow\r
  73 #define Rtl8192E_NIC_PDN_FLOW                                   rtl8192E_hwpdn_flow\r
  74 #define Rtl8192E_NIC_LPS_ENTER_FLOW                     rtl8192E_enter_lps_flow\r
  75 #define Rtl8192E_NIC_LPS_LEAVE_FLOW                     rtl8192E_leave_lps_flow \r
  76 \r
  77 \r
  78 #if 1 // download firmware related data structure\r
  79 #define FW_SIZE_8192E                   0x8000 // Compatible with RTL8192e Maximal RAM code size 32k\r
  80 #define FW_START_ADDRESS                0x1000\r
  81 #define FW_END_ADDRESS                  0x5FFF\r
  82 \r
  83 \r
  84 #define IS_FW_HEADER_EXIST_8192E(_pFwHdr)       ((GET_FIRMWARE_HDR_SIGNATURE_8192E(_pFwHdr) &0xFFF0) ==  0x92E0)\r
  85 \r
  86 \r
  87 \r
  88 typedef struct _RT_FIRMWARE_8192E {\r
  89         FIRMWARE_SOURCE eFWSource;\r
  90 #ifdef CONFIG_EMBEDDED_FWIMG\r
  91         u8*                     szFwBuffer;\r
  92 #else\r
  93         u8                      szFwBuffer[FW_SIZE_8192E];\r
  94 #endif\r
  95         u32                     ulFwLength;\r
  96 } RT_FIRMWARE_8192E, *PRT_FIRMWARE_8192E;\r
  97 \r
  98 //\r
  99 // This structure must be cared byte-ordering\r
 100 //\r
 101 // Added by tynli. 2009.12.04.\r
 102 \r
 103 //=====================================================\r
 104 //                                      Firmware Header(8-byte alinment required)\r
 105 //=====================================================\r
 106 //--- LONG WORD 0 ----\r
 107 #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\r
 108 #define GET_FIRMWARE_HDR_CATEGORY_8192E(__FwHdr)                LE_BITS_TO_4BYTE(__FwHdr, 16, 8) // AP/NIC and USB/PCI\r
 109 #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\r
 110 #define GET_FIRMWARE_HDR_VERSION_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)// FW Version\r
 111 #define GET_FIRMWARE_HDR_SUB_VER_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) // FW Subversion, default 0x00\r
 112 #define GET_FIRMWARE_HDR_RSVD1_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8)              \r
 113 \r
 114 //--- LONG WORD 1 ----\r
 115 #define GET_FIRMWARE_HDR_MONTH_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+8, 0, 8) // Release time Month field\r
 116 #define GET_FIRMWARE_HDR_DATE_8192E(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+8, 8, 8) // Release time Date field\r
 117 #define GET_FIRMWARE_HDR_HOUR_8192E(__FwHdr)                    LE_BITS_TO_4BYTE(__FwHdr+8, 16, 8)// Release time Hour field\r
 118 #define GET_FIRMWARE_HDR_MINUTE_8192E(__FwHdr)                  LE_BITS_TO_4BYTE(__FwHdr+8, 24, 8)// Release time Minute field\r
 119 #define GET_FIRMWARE_HDR_ROMCODE_SIZE_8192E(__FwHdr)    LE_BITS_TO_4BYTE(__FwHdr+12, 0, 16)// The size of RAM code\r
 120 #define GET_FIRMWARE_HDR_RSVD2_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+12, 16, 16)\r
 121 \r
 122 //--- LONG WORD 2 ----\r
 123 #define GET_FIRMWARE_HDR_SVN_IDX_8192E(__FwHdr)                 LE_BITS_TO_4BYTE(__FwHdr+16, 0, 32)// The SVN entry index\r
 124 #define GET_FIRMWARE_HDR_RSVD3_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+20, 0, 32)\r
 125 \r
 126 //--- LONG WORD 3 ----\r
 127 #define GET_FIRMWARE_HDR_RSVD4_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+24, 0, 32)\r
 128 #define GET_FIRMWARE_HDR_RSVD5_8192E(__FwHdr)                   LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32)\r
 129 \r
 130 #endif // download firmware related data structure\r
 131 \r
 132 #define DRIVER_EARLY_INT_TIME_8192E             0x05\r
 133 #define BCN_DMA_ATIME_INT_TIME_8192E            0x02\r
 134 \r
 135 #define MAX_RX_DMA_BUFFER_SIZE_8192E            0x3d00 //0x3E80   //0x3FFF      // RX 16K reserved for WOW ?\r
 136 \r
 137 \r
 138 #define TX_TOTAL_PAGE_NUMBER_8192E              243 //0x00~0xF3 totoal pages: F4\r
 139 \r
 140 #define TX_PAGE_BOUNDARY_8192E                  (TX_TOTAL_PAGE_NUMBER_8192E + 1)//0xF4,Rserved 12 pages for BCN/PS-POLL..\r
 141 #define TX_PAGE_LOAD_FW_BOUNDARY_8192E          0x47 //0xA5\r
 142 #define TX_PAGE_BOUNDARY_WOWLAN_8192E           0xE0\r
 143 \r
 144 // For Normal Chip Setting\r
 145 // (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_92C\r
 146 #define NORMAL_PAGE_NUM_PUBQ_8192E                      0xE0\r
 147 #define NORMAL_PAGE_NUM_LPQ_8192E                       0x0C\r
 148 #define NORMAL_PAGE_NUM_HPQ_8192E                       0x08\r
 149 #define NORMAL_PAGE_NUM_NPQ_8192E                       0x00\r
 150 #define NORMAL_PAGE_NUM_EPQ_8192E                       0x00\r
 151 \r
 152 \r
 153 \r
 154 //Note: For WMM Normal Chip Setting ,modify later\r
 155 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192E   TX_PAGE_BOUNDARY_8192E\r
 156 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8192E               (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8192E + 1)\r
 157 \r
 158 #define WMM_NORMAL_PAGE_NUM_PUBQ_8192E  NORMAL_PAGE_NUM_PUBQ_8192E\r
 159 #define WMM_NORMAL_PAGE_NUM_HPQ_8192E           NORMAL_PAGE_NUM_HPQ_8192E\r
 160 #define WMM_NORMAL_PAGE_NUM_LPQ_8192E           NORMAL_PAGE_NUM_LPQ_8192E\r
 161 #define WMM_NORMAL_PAGE_NUM_NPQ_8192E           NORMAL_PAGE_NUM_NPQ_8192E\r
 162 \r
 163 #define USB_JAGUAR_DUMMY_OFFSET_8192EU          2\r
 164 #define USB_JAGUAR_DUMMY_UNIT_8192EU                    8\r
 165 #define USB_JAGUAR_ALL_DUMMY_LENGTH_8192EU                      (USB_JAGUAR_DUMMY_OFFSET_8192EU * USB_JAGUAR_DUMMY_UNIT_8192EU)\r
 166 #define USB_HWDESC_HEADER_LEN_8192EU            (TX_DESC_SIZE_8192E + USB_JAGUAR_ALL_DUMMY_LENGTH_8192EU)\r
 167 \r
 168 \r
 169 //-------------------------------------------------------------------------\r
 170 //      Chip specific\r
 171 //-------------------------------------------------------------------------\r
 172 \r
 173 //-------------------------------------------------------------------------\r
 174 //      Channel Plan\r
 175 //-------------------------------------------------------------------------\r
 176 \r
 177 #define         HWSET_MAX_SIZE_8192E                    512\r
 178 \r
 179 #define         EFUSE_REAL_CONTENT_LEN_8192E    512\r
 180 \r
 181 #define         EFUSE_MAP_LEN_8192E                     512\r
 182 #define         EFUSE_MAX_SECTION_8192E         64\r
 183 #define         EFUSE_MAX_WORD_UNIT_8192E               4\r
 184 #define         EFUSE_IC_ID_OFFSET_8192E                506     //For some inferiority IC purpose. added by Roger, 2009.09.02.\r
 185 #define                 AVAILABLE_EFUSE_ADDR_8192E(addr)        (addr < EFUSE_REAL_CONTENT_LEN_8192E)\r
 186 //\r
 187 // <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section\r
 188 // 9bytes + 1byt + 5bytes and pre 1byte.\r
 189 // For worst case:\r
 190 // | 1byte|----8bytes----|1byte|--5bytes--| \r
 191 // |         |            Reserved(14bytes)           |\r
 192 //\r
 193 #define         EFUSE_OOB_PROTECT_BYTES_8192E           15      // PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte.\r
 194 \r
 195 \r
 196 \r
 197 //========================================================\r
 198 //                      EFUSE for BT definition\r
 199 //========================================================\r
 200 #define         EFUSE_BT_REAL_BANK_CONTENT_LEN_8192E    512\r
 201 #define         EFUSE_BT_REAL_CONTENT_LEN_8192E                 1024    // 512*2\r
 202 #define         EFUSE_BT_MAP_LEN_8192E                                  1024    // 1k bytes\r
 203 #define         EFUSE_BT_MAX_SECTION_8192E                              128             // 1024/8\r
 204 \r
 205 #define         EFUSE_PROTECT_BYTES_BANK_8192E                  16\r
 206 #define         EFUSE_MAX_BANK_8192E                                    3\r
 207 //===========================================================\r
 208 \r
 209 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)\r
 210 #define INCLUDE_MULTI_FUNC_GPS(_Adapter)        (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)\r
 211 \r
 212 //#define IS_MULTI_FUNC_CHIP(_Adapter)  (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE)\r
 213 \r
 214 //#define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) )\r
 215 \r
 216 #define GetDefaultAdapter(padapter)     padapter\r
 217 \r
 218 // rtl8812_hal_init.c\r
 219 void    _8051Reset8192E(PADAPTER padapter);\r
 220 s32     FirmwareDownload8192E(PADAPTER Adapter, BOOLEAN bUsedWoWLANFw);\r
 221 void    InitializeFirmwareVars8192E(PADAPTER padapter);\r
 222 \r
 223 s32     InitLLTTable8192E(PADAPTER padapter, u8 txpktbuf_bndy);\r
 224 \r
 225 // EFuse\r
 226 u8      GetEEPROMSize8192E(PADAPTER padapter);\r
 227 void    hal_InitPGData_8192E(PADAPTER padapter, u8* PROMContent);\r
 228 void    Hal_EfuseParseIDCode8192E(PADAPTER padapter, u8 *hwinfo);\r
 229 void    Hal_ReadPROMVersion8192E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
 230 void    Hal_ReadPowerSavingMode8192E(PADAPTER padapter, u8*     hwinfo, BOOLEAN AutoLoadFail);\r
 231 void    Hal_ReadTxPowerInfo8192E(PADAPTER padapter,u8* hwinfo,BOOLEAN   AutoLoadFail);\r
 232 void    Hal_ReadBoardType8192E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
 233 void    Hal_ReadThermalMeter_8192E(PADAPTER     Adapter,u8* PROMContent,BOOLEAN         AutoloadFail);\r
 234 void    Hal_ReadChannelPlan8192E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);\r
 235 void    Hal_EfuseParseXtal_8192E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail);\r
 236 void    Hal_ReadAntennaDiversity8192E(PADAPTER pAdapter,u8* PROMContent,BOOLEAN AutoLoadFail);\r
 237 void    Hal_ReadPAType_8192E(PADAPTER Adapter,u8* PROMContent, BOOLEAN AutoloadFail);\r
 238 void    Hal_EfuseParseBTCoexistInfo8192E(PADAPTER Adapter, u8* hwinfo, BOOLEAN AutoLoadFail);\r
 239 u8 Hal_CrystalAFEAdjust(_adapter * Adapter);\r
 240 \r
 241 BOOLEAN HalDetectPwrDownMode8192E(PADAPTER Adapter);\r
 242         \r
 243 #ifdef CONFIG_WOWLAN\r
 244 void Hal_DetectWoWMode(PADAPTER pAdapter);\r
 245 #endif //CONFIG_WOWLAN\r
 246 \r
 247 /***********************************************************/\r
 248 // RTL8192E-MAC Setting\r
 249 VOID _InitTxBufferBoundary_8192E(IN PADAPTER Adapter,IN u8 txpktbuf_bndy);\r
 250 VOID _InitPageBoundary_8192E(IN PADAPTER Adapter);\r
 251 //VOID _InitTransferPageSize_8192E(IN PADAPTER Adapter);\r
 252 VOID _InitDriverInfoSize_8192E(IN PADAPTER Adapter,IN u8 drvInfoSize);\r
 253 VOID _InitRxSetting_8192E(PADAPTER Adapter);\r
 254 VOID _InitRDGSetting_8192E(PADAPTER Adapter);\r
 255 void _InitID_8192E(IN  PADAPTER Adapter);\r
 256 VOID _InitNetworkType_8192E(IN  PADAPTER Adapter);\r
 257 VOID _InitWMACSetting_8192E(IN PADAPTER Adapter);\r
 258 VOID _InitAdaptiveCtrl_8192E(IN  PADAPTER Adapter);\r
 259 VOID _InitEDCA_8192E( IN  PADAPTER Adapter);\r
 260 VOID _InitRetryFunction_8192E(  IN  PADAPTER Adapter);\r
 261 VOID _InitBeaconParameters_8192E(IN  PADAPTER Adapter);\r
 262 VOID _InitBeaconMaxError_8192E(\r
 263         IN  PADAPTER    Adapter,\r
 264         IN      BOOLEAN         InfraMode\r
 265         );\r
 266 void _BBTurnOnBlock_8192E(PADAPTER padapter);\r
 267 void SetBeaconRelatedRegisters8192E(PADAPTER padapter);\r
 268 VOID hal_ReadRFType_8192E(PADAPTER      Adapter);\r
 269 // RTL8192E-MAC Setting\r
 270 /***********************************************************/\r
 271 \r
 272 void SetHwReg8192E(PADAPTER Adapter, u8 variable, u8* val);\r
 273 void GetHwReg8192E(PADAPTER Adapter, u8 variable, u8* val);\r
 274 u8\r
 275 SetHalDefVar8192E(\r
 276         IN      PADAPTER                                Adapter,\r
 277         IN      HAL_DEF_VARIABLE                eVariable,\r
 278         IN      PVOID                                   pValue\r
 279         );\r
 280 u8\r
 281 GetHalDefVar8192E(\r
 282         IN      PADAPTER                                Adapter,\r
 283         IN      HAL_DEF_VARIABLE                eVariable,\r
 284         IN      PVOID                                   pValue\r
 285         );\r
 286 \r
 287 void rtl8192e_set_hal_ops(struct hal_ops *pHalFunc);\r
 288 void rtl8192e_init_default_value(_adapter * padapter);\r
 289 // register\r
 290 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);\r
 291 \r
 292 void rtl8192e_start_thread(_adapter *padapter);\r
 293 void rtl8192e_stop_thread(_adapter *padapter);\r
 294 #endif //__RTL8192E_HAL_H__\r
 295 \r