1 /****************************************************************************** 2 * 3 * Copyright(c) 2007 - 2011 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 __RTL8188E_HAL_H__ 21 #define __RTL8188E_HAL_H__ 22 23 //#include "hal_com.h" 24 #include "hal_data.h" 25 26 //include HAL Related header after HAL Related compiling flags 27 #include "rtl8188e_spec.h" 28 #include "Hal8188EPhyReg.h" 29 #include "Hal8188EPhyCfg.h" 30 #include "rtl8188e_rf.h" 31 #include "rtl8188e_dm.h" 32 #include "rtl8188e_recv.h" 33 #include "rtl8188e_xmit.h" 34 #include "rtl8188e_cmd.h" 35 #include "rtl8188e_led.h" 36 #include "Hal8188EPwrSeq.h" 37 #ifdef DBG_CONFIG_ERROR_DETECT 38 #include "rtl8188e_sreset.h" 39 #endif 40 41 #if 0 42 // Fw Array 43 #define Rtl8188E_FwImageArray Rtl8188EFwImgArray 44 #define Rtl8188E_FWImgArrayLength Rtl8188EFWImgArrayLength 45 #ifdef CONFIG_WOWLAN 46 #define Rtl8188E_FwWoWImageArray Array_MP_8188E_FW_WoWLAN 47 #define Rtl8188E_FwWoWImgArrayLength ArrayLength_MP_8188E_FW_WoWLAN 48 #endif //CONFIG_WOWLAN 49 #endif 50 51 52 #define RTL8188E_FW_IMG "rtl8188e/FW_NIC.bin" 53 #define RTL8188E_FW_WW_IMG "rtl8188e/FW_WoWLAN.bin" 54 #define RTL8188E_PHY_REG "rtl8188e/PHY_REG.txt" 55 #define RTL8188E_PHY_RADIO_A "rtl8188e/RadioA.txt" 56 #define RTL8188E_PHY_RADIO_B "rtl8188e/RadioB.txt" 57 #define RTL8188E_TXPWR_TRACK "rtl8188e/TxPowerTrack.txt" 58 #define RTL8188E_AGC_TAB "rtl8188e/AGC_TAB.txt" 59 #define RTL8188E_PHY_MACREG "rtl8188e/MAC_REG.txt" 60 #define RTL8188E_PHY_REG_PG "rtl8188e/PHY_REG_PG.txt" 61 #define RTL8188E_PHY_REG_MP "rtl8188e/PHY_REG_MP.txt" 62 #define RTL8188E_TXPWR_LMT "rtl8188e/TXPWR_LMT.txt" 63 64 //--------------------------------------------------------------------- 65 // RTL8188E Power Configuration CMDs for USB/SDIO/PCIE interfaces 66 //--------------------------------------------------------------------- 67 #define Rtl8188E_NIC_PWR_ON_FLOW rtl8188E_power_on_flow 68 #define Rtl8188E_NIC_RF_OFF_FLOW rtl8188E_radio_off_flow 69 #define Rtl8188E_NIC_DISABLE_FLOW rtl8188E_card_disable_flow 70 #define Rtl8188E_NIC_ENABLE_FLOW rtl8188E_card_enable_flow 71 #define Rtl8188E_NIC_SUSPEND_FLOW rtl8188E_suspend_flow 72 #define Rtl8188E_NIC_RESUME_FLOW rtl8188E_resume_flow 73 #define Rtl8188E_NIC_PDN_FLOW rtl8188E_hwpdn_flow 74 #define Rtl8188E_NIC_LPS_ENTER_FLOW rtl8188E_enter_lps_flow 75 #define Rtl8188E_NIC_LPS_LEAVE_FLOW rtl8188E_leave_lps_flow 76 77 78 #if 1 // download firmware related data structure 79 #define MAX_FW_8188E_SIZE 0x8000 //32768,32k / 16384,16k 80 81 #define FW_8188E_SIZE 0x4000 //16384,16k 82 #define FW_8188E_SIZE_2 0x8000 //32768,32k 83 84 #define FW_8188E_START_ADDRESS 0x1000 85 #define FW_8188E_END_ADDRESS 0x1FFF //0x5FFF 86 87 88 #define IS_FW_HEADER_EXIST_88E(_pFwHdr) ((le16_to_cpu(_pFwHdr->Signature)&0xFFF0) == 0x88E0) 89 90 typedef struct _RT_FIRMWARE_8188E { 91 FIRMWARE_SOURCE eFWSource; 92 #ifdef CONFIG_EMBEDDED_FWIMG 93 u8* szFwBuffer; 94 #else 95 u8 szFwBuffer[MAX_FW_8188E_SIZE]; 96 #endif 97 u32 ulFwLength; 98 } RT_FIRMWARE_8188E, *PRT_FIRMWARE_8188E; 99 100 // 101 // This structure must be cared byte-ordering 102 // 103 104 typedef struct _RT_8188E_FIRMWARE_HDR 105 { 106 // 8-byte alinment required 107 108 //--- LONG WORD 0 ---- 109 u16 Signature; // 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut 110 u8 Category; // AP/NIC and USB/PCI 111 u8 Function; // Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions 112 u16 Version; // FW Version 113 u8 Subversion; // FW Subversion, default 0x00 114 u16 Rsvd1; 115 116 117 //--- LONG WORD 1 ---- 118 u8 Month; // Release time Month field 119 u8 Date; // Release time Date field 120 u8 Hour; // Release time Hour field 121 u8 Minute; // Release time Minute field 122 u16 RamCodeSize; // The size of RAM code 123 u8 Foundry; 124 u8 Rsvd2; 125 126 //--- LONG WORD 2 ---- 127 u32 SvnIdx; // The SVN entry index 128 u32 Rsvd3; 129 130 //--- LONG WORD 3 ---- 131 u32 Rsvd4; 132 u32 Rsvd5; 133 }RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR; 134 #endif // download firmware related data structure 135 136 137 #define DRIVER_EARLY_INT_TIME_8188E 0x05 138 #define BCN_DMA_ATIME_INT_TIME_8188E 0x02 139 140 141 //#define MAX_RX_DMA_BUFFER_SIZE_88E 0x2400 //9k for 88E nornal chip , //MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24)) 142 #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter))?0x2800:0x4000) 143 144 #ifdef CONFIG_WOWLAN 145 #define RESV_FMWF WKFMCAM_SIZE*MAX_WKFM_NUM /* 16 entries, for each is 24 bytes*/ 146 #else 147 #define RESV_FMWF 0 148 #endif 149 150 #define RX_DMA_RESERVD_FW_FEATURE 0x200 /* for tx report (64*8) */ 151 152 #define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE 153 154 #define MAX_TX_REPORT_BUFFER_SIZE 0x0400 /* 1k */ 155 156 // Note: We will divide number of page equally for each queue other than public queue! 157 // 22k = 22528 bytes = 176 pages (@page = 128 bytes) 158 // must reserved about 7 pages for LPS => 176-7 = 169 (0xA9) 159 // 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data 160 161 #define BCNQ_PAGE_NUM_88E 0x08 162 163 //For WoWLan , more reserved page 164 #ifdef CONFIG_WOWLAN 165 #define WOWLAN_PAGE_NUM_88E 0x00 166 #else 167 #define WOWLAN_PAGE_NUM_88E 0x00 168 #endif 169 170 /* Note: 171 Tx FIFO Size : previous CUT:22K /I_CUT after:32KB 172 Tx page Size : 128B 173 Total page numbers : 176(0xB0) / 256(0x100) 174 */ 175 #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter)?0x100:0xB0) - 1)/* must reserved 1 page for dma issue */ 176 #define TX_TOTAL_PAGE_NUMBER_88E(_Adapter) (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E) 177 #define TX_PAGE_BOUNDARY_88E(_Adapter) (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */ 178 179 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) TX_TOTAL_PAGE_NUMBER_88E(_Adapter) 180 #define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter) (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) 181 182 // For Normal Chip Setting 183 // (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B 184 #define NORMAL_PAGE_NUM_HPQ_88E 0x0 185 #define NORMAL_PAGE_NUM_LPQ_88E 0x09 186 #define NORMAL_PAGE_NUM_NPQ_88E 0x0 187 188 // Note: For Normal Chip Setting, modify later 189 #define WMM_NORMAL_PAGE_NUM_HPQ_88E 0x29 190 #define WMM_NORMAL_PAGE_NUM_LPQ_88E 0x1C 191 #define WMM_NORMAL_PAGE_NUM_NPQ_88E 0x1C 192 193 194 //------------------------------------------------------------------------- 195 // Chip specific 196 //------------------------------------------------------------------------- 197 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22)&0x3) 198 #define CHIP_BONDING_92C_1T2R 0x1 199 #define CHIP_BONDING_88C_USB_MCARD 0x2 200 #define CHIP_BONDING_88C_USB_HP 0x1 201 202 //------------------------------------------------------------------------- 203 // Channel Plan 204 //------------------------------------------------------------------------- 205 206 207 #define EFUSE_REAL_CONTENT_LEN 512 208 #define EFUSE_MAP_LEN 128 209 #define EFUSE_MAX_SECTION 16 210 #define EFUSE_IC_ID_OFFSET 506 //For some inferiority IC purpose. added by Roger, 2009.09.02. 211 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN) 212 // 213 // <Roger_Notes> 214 // To prevent out of boundary programming case, 215 // leave 1byte and program full section 216 // 9bytes + 1byt + 5bytes and pre 1byte. 217 // For worst case: 218 // | 1byte|----8bytes----|1byte|--5bytes--| 219 // | | Reserved(14bytes) | 220 // 221 #define EFUSE_OOB_PROTECT_BYTES 15 // PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. 222 223 #define EFUSE_REAL_CONTENT_LEN_88E 256 224 #define EFUSE_MAP_LEN_88E 512 225 #define EFUSE_MAX_SECTION_88E 64 226 #define EFUSE_MAX_WORD_UNIT_88E 4 227 #define EFUSE_IC_ID_OFFSET_88E 506 //For some inferiority IC purpose. added by Roger, 2009.09.02. 228 #define AVAILABLE_EFUSE_ADDR_88E(addr) (addr < EFUSE_REAL_CONTENT_LEN_88E) 229 // <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section 230 // 9bytes + 1byt + 5bytes and pre 1byte. 231 // For worst case: 232 // | 2byte|----8bytes----|1byte|--7bytes--| //92D 233 #define EFUSE_OOB_PROTECT_BYTES_88E 18 // PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. 234 #define EFUSE_PROTECT_BYTES_BANK_88E 16 235 236 237 //======================================================== 238 // EFUSE for BT definition 239 //======================================================== 240 #define EFUSE_BT_REAL_CONTENT_LEN 1536 // 512*3 241 #define EFUSE_BT_MAP_LEN 1024 // 1k bytes 242 #define EFUSE_BT_MAX_SECTION 128 // 1024/8 243 244 #define EFUSE_PROTECT_BYTES_BANK 16 245 246 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 247 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 248 249 //#define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) 250 251 //#define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) 252 253 #ifdef CONFIG_PCI_HCI 254 /* according to the define in the rtw_xmit.h, rtw_recv.h */ 255 #define TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 256 #ifdef CONFIG_CONCURRENT_MODE 257 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM<<1)*/ /* 256 */ 258 #define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+(TXDESC_NUM>>1)) /* 320 */ 259 /*#define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+TXDESC_NUM)*/ /* 384 */ 260 #else 261 #define BE_QUEUE_TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 262 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM+(TXDESC_NUM>>1)) *//* 192 */ 263 #endif 264 265 void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent); 266 void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 267 #endif //CONFIG_PCI_HCI 268 269 // rtl8188e_hal_init.c 270 271 s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 272 void _8051Reset88E(PADAPTER padapter); 273 void rtl8188e_InitializeFirmwareVars(PADAPTER padapter); 274 275 276 s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy); 277 278 // EFuse 279 u8 GetEEPROMSize8188E(PADAPTER padapter); 280 void Hal_InitPGData88E(PADAPTER padapter); 281 void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo); 282 void Hal_ReadTxPowerInfo88E(PADAPTER padapter,u8* hwinfo,BOOLEAN AutoLoadFail); 283 284 void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 285 void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 286 void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 287 void Hal_ReadAntennaDiversity88E (PADAPTER pAdapter,u8*PROMContent,BOOLEAN AutoLoadFail); 288 void Hal_ReadThermalMeter_88E(PADAPTER Adapter,u8* PROMContent,BOOLEAN AutoloadFail); 289 void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 290 void Hal_EfuseParseBoardType88E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 291 void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 292 void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 293 void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 294 void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 295 296 BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter); 297 298 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) 299 void Hal_DetectWoWMode(PADAPTER pAdapter); 300 #endif //CONFIG_WOWLAN 301 302 303 #ifdef CONFIG_RF_GAIN_OFFSET 304 void Hal_ReadRFGainOffset(PADAPTER pAdapter,u8* hwinfo,BOOLEAN AutoLoadFail); 305 #endif //CONFIG_RF_GAIN_OFFSET 306 307 void rtl8188e_init_default_value(_adapter *adapter); 308 309 void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc); 310 void init_hal_spec_8188e(_adapter *adapter); 311 312 // register 313 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits); 314 315 void rtl8188e_start_thread(_adapter *padapter); 316 void rtl8188e_stop_thread(_adapter *padapter); 317 318 void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter,int data_len); 319 #ifdef CONFIG_IOL_EFUSE_PATCH 320 s32 rtl8188e_iol_efuse_patch(PADAPTER padapter); 321 #endif//CONFIG_IOL_EFUSE_PATCH 322 void _InitTransferPageSize(PADAPTER padapter); 323 324 void SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 325 void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 326 void ResumeTxBeacon(PADAPTER padapter); 327 void StopTxBeacon(PADAPTER padapter); 328 u8 329 GetHalDefVar8188E( 330 IN PADAPTER Adapter, 331 IN HAL_DEF_VARIABLE eVariable, 332 IN PVOID pValue 333 ); 334 #endif //__RTL8188E_HAL_H__ 335 336