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