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 /* 8-byte alinment required */ 106 107 /* --- LONG WORD 0 ---- */ 108 u16 Signature; /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 109 u8 Category; /* AP/NIC and USB/PCI */ 110 u8 Function; /* Reserved for different FW function indcation, for further use when driver needs to download different FW in different conditions */ 111 u16 Version; /* FW Version */ 112 u8 Subversion; /* FW Subversion, default 0x00 */ 113 u16 Rsvd1; 114 115 116 /* --- LONG WORD 1 ---- */ 117 u8 Month; /* Release time Month field */ 118 u8 Date; /* Release time Date field */ 119 u8 Hour; /* Release time Hour field */ 120 u8 Minute; /* Release time Minute field */ 121 u16 RamCodeSize; /* The size of RAM code */ 122 u8 Foundry; 123 u8 Rsvd2; 124 125 /* --- LONG WORD 2 ---- */ 126 u32 SvnIdx; /* The SVN entry index */ 127 u32 Rsvd3; 128 129 /* --- LONG WORD 3 ---- */ 130 u32 Rsvd4; 131 u32 Rsvd5; 132 } RT_8188E_FIRMWARE_HDR, *PRT_8188E_FIRMWARE_HDR; 133 #endif /* download firmware related data structure */ 134 135 136 #define DRIVER_EARLY_INT_TIME_8188E 0x05 137 #define BCN_DMA_ATIME_INT_TIME_8188E 0x02 138 139 140 /* #define MAX_RX_DMA_BUFFER_SIZE_88E 0x2400 */ /* 9k for 88E nornal chip , */ /* MaxRxBuff=10k-max(TxReportSize(64*8), WOLPattern(16*24)) */ 141 #ifdef CONFIG_USB_HCI 142 #define RX_DMA_SIZE_88E(__Adapter) 0x2800 /* no cut difference */ 143 #else 144 #define RX_DMA_SIZE_88E(__Adapter) ((!IS_VENDOR_8188E_I_CUT_SERIES(__Adapter)) ? 0x2800 : 0x4000) 145 #endif 146 147 #ifdef CONFIG_WOWLAN 148 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_NUM) /* 16 entries, for each is 24 bytes*/ 149 #else 150 #define RESV_FMWF 0 151 #endif 152 153 #define RX_DMA_RESERVD_FW_FEATURE 0x200 /* for tx report (64*8) */ 154 155 #define MAX_RX_DMA_BUFFER_SIZE_88E(__Adapter) (RX_DMA_SIZE_88E(__Adapter)-RX_DMA_RESERVD_FW_FEATURE) 156 157 #define MAX_TX_REPORT_BUFFER_SIZE 0x0400 /* 1k */ 158 159 /* Note: We will divide number of page equally for each queue other than public queue! 160 * 22k = 22528 bytes = 176 pages (@page = 128 bytes) 161 * must reserved about 7 pages for LPS => 176-7 = 169 (0xA9) 162 * 2*BCN / 1*ps-poll / 1*null-data /1*prob_rsp /1*QOS null-data /1*BT QOS null-data */ 163 164 #define BCNQ_PAGE_NUM_88E 0x08 165 166 /* For WoWLan , more reserved page */ 167 #ifdef CONFIG_WOWLAN 168 #define WOWLAN_PAGE_NUM_88E 0x00 169 #else 170 #define WOWLAN_PAGE_NUM_88E 0x00 171 #endif 172 173 /* Note: 174 Tx FIFO Size : previous CUT:22K /I_CUT after:32KB 175 Tx page Size : 128B 176 Total page numbers : 176(0xB0) / 256(0x100) 177 */ 178 #ifdef CONFIG_USB_HCI 179 #define TOTAL_PAGE_NUMBER_88E(_Adapter) (0xB0 - 1) /* no cut difference */ 180 #else 181 #define TOTAL_PAGE_NUMBER_88E(_Adapter) ((IS_VENDOR_8188E_I_CUT_SERIES(_Adapter) ? 0x100 : 0xB0) - 1)/* must reserved 1 page for dma issue */ 182 #endif 183 #define TX_TOTAL_PAGE_NUMBER_88E(_Adapter) (TOTAL_PAGE_NUMBER_88E(_Adapter) - BCNQ_PAGE_NUM_88E - WOWLAN_PAGE_NUM_88E) 184 #define TX_PAGE_BOUNDARY_88E(_Adapter) (TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) /* beacon header start address */ 185 186 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) TX_TOTAL_PAGE_NUMBER_88E(_Adapter) 187 #define WMM_NORMAL_TX_PAGE_BOUNDARY_88E(_Adapter) (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_88E(_Adapter) + 1) 188 189 /* For Normal Chip Setting 190 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8723B */ 191 #define NORMAL_PAGE_NUM_HPQ_88E 0x0 192 #define NORMAL_PAGE_NUM_LPQ_88E 0x09 193 #define NORMAL_PAGE_NUM_NPQ_88E 0x0 194 195 /* Note: For Normal Chip Setting, modify later */ 196 #define WMM_NORMAL_PAGE_NUM_HPQ_88E 0x29 197 #define WMM_NORMAL_PAGE_NUM_LPQ_88E 0x1C 198 #define WMM_NORMAL_PAGE_NUM_NPQ_88E 0x1C 199 200 201 /* ------------------------------------------------------------------------- 202 * Chip specific 203 * ------------------------------------------------------------------------- */ 204 #define CHIP_BONDING_IDENTIFIER(_value) (((_value)>>22) & 0x3) 205 #define CHIP_BONDING_92C_1T2R 0x1 206 #define CHIP_BONDING_88C_USB_MCARD 0x2 207 #define CHIP_BONDING_88C_USB_HP 0x1 208 209 /* ------------------------------------------------------------------------- 210 * Channel Plan 211 * ------------------------------------------------------------------------- */ 212 213 214 #define EFUSE_REAL_CONTENT_LEN 512 215 #define EFUSE_MAP_LEN 128 216 #define EFUSE_MAX_SECTION 16 217 #define EFUSE_IC_ID_OFFSET 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 218 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_REAL_CONTENT_LEN) 219 /* 220 * <Roger_Notes> 221 * To prevent out of boundary programming case, 222 * leave 1byte and program full section 223 * 9bytes + 1byt + 5bytes and pre 1byte. 224 * For worst case: 225 * | 1byte|----8bytes----|1byte|--5bytes--| 226 * | | Reserved(14bytes) | 227 * */ 228 #define EFUSE_OOB_PROTECT_BYTES 15 /* PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. */ 229 230 #define EFUSE_REAL_CONTENT_LEN_88E 256 231 #define EFUSE_MAP_LEN_88E 512 232 #define EFUSE_MAX_SECTION_88E 64 233 #define EFUSE_MAX_WORD_UNIT_88E 4 234 #define EFUSE_IC_ID_OFFSET_88E 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 235 #define AVAILABLE_EFUSE_ADDR_88E(addr) (addr < EFUSE_REAL_CONTENT_LEN_88E) 236 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section 237 * 9bytes + 1byt + 5bytes and pre 1byte. 238 * For worst case: 239 * | 2byte|----8bytes----|1byte|--7bytes--| */ /* 92D */ 240 #define EFUSE_OOB_PROTECT_BYTES_88E 18 /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */ 241 #define EFUSE_PROTECT_BYTES_BANK_88E 16 242 243 244 /* ******************************************************** 245 * EFUSE for BT definition 246 * ******************************************************** */ 247 #define EFUSE_BT_REAL_CONTENT_LEN 1536 /* 512*3 */ 248 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 249 #define EFUSE_BT_MAX_SECTION 128 /* 1024/8 */ 250 251 #define EFUSE_PROTECT_BYTES_BANK 16 252 253 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 254 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 255 256 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */ 257 258 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */ 259 260 #ifdef CONFIG_PCI_HCI 261 /* according to the define in the rtw_xmit.h, rtw_recv.h */ 262 #define TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 263 #ifdef CONFIG_CONCURRENT_MODE 264 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM<<1)*/ /* 256 */ 265 #define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+(TXDESC_NUM>>1)) /* 320 */ 266 /*#define BE_QUEUE_TX_DESC_NUM_8188EE ((TXDESC_NUM<<1)+TXDESC_NUM)*/ /* 384 */ 267 #else 268 #define BE_QUEUE_TX_DESC_NUM_8188EE TXDESC_NUM /* 128 */ 269 /*#define BE_QUEUE_TX_DESC_NUM_8188EE (TXDESC_NUM+(TXDESC_NUM>>1)) */ /* 192 */ 270 #endif 271 272 void InterruptRecognized8188EE(PADAPTER Adapter, PRT_ISR_CONTENT pIsrContent); 273 void UpdateInterruptMask8188EE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 274 #endif /* CONFIG_PCI_HCI */ 275 276 /* rtl8188e_hal_init.c */ 277 278 s32 rtl8188e_FirmwareDownload(PADAPTER padapter, BOOLEAN bUsedWoWLANFw); 279 void _8051Reset88E(PADAPTER padapter); 280 void rtl8188e_InitializeFirmwareVars(PADAPTER padapter); 281 282 283 s32 InitLLTTable(PADAPTER padapter, u8 txpktbuf_bndy); 284 285 /* EFuse */ 286 u8 GetEEPROMSize8188E(PADAPTER padapter); 287 void Hal_InitPGData88E(PADAPTER padapter); 288 void Hal_EfuseParseIDCode88E(PADAPTER padapter, u8 *hwinfo); 289 void Hal_ReadTxPowerInfo88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 290 291 void Hal_EfuseParseEEPROMVer88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 292 void rtl8188e_EfuseParseChnlPlan(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 293 void Hal_EfuseParseCustomerID88E(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 294 void Hal_ReadAntennaDiversity88E(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 295 void Hal_ReadThermalMeter_88E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 296 void Hal_EfuseParseXtal_8188E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 297 void Hal_EfuseParseBoardType88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 298 void Hal_ReadPowerSavingMode88E(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 299 void Hal_ReadPAType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 300 void Hal_ReadAmplifierType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 301 void Hal_ReadRFEType_8188E(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 302 303 BOOLEAN HalDetectPwrDownMode88E(PADAPTER Adapter); 304 305 #if defined(CONFIG_WOWLAN) || defined(CONFIG_AP_WOWLAN) 306 void Hal_DetectWoWMode(PADAPTER pAdapter); 307 #endif /* CONFIG_WOWLAN */ 308 309 310 #ifdef CONFIG_RF_POWER_TRIM 311 void Hal_ReadRFGainOffset(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 312 #endif /*CONFIG_RF_POWER_TRIM*/ 313 314 void rtl8188e_init_default_value(_adapter *adapter); 315 316 void rtl8188e_set_hal_ops(struct hal_ops *pHalFunc); 317 void init_hal_spec_8188e(_adapter *adapter); 318 319 /* register */ 320 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits); 321 322 void rtl8188e_start_thread(_adapter *padapter); 323 void rtl8188e_stop_thread(_adapter *padapter); 324 325 void rtw_IOL_cmd_tx_pkt_buf_dump(ADAPTER *Adapter, int data_len); 326 #ifdef CONFIG_IOL_EFUSE_PATCH 327 s32 rtl8188e_iol_efuse_patch(PADAPTER padapter); 328 #endif/* CONFIG_IOL_EFUSE_PATCH */ 329 void _InitTransferPageSize(PADAPTER padapter); 330 331 void SetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 332 void GetHwReg8188E(PADAPTER padapter, u8 variable, u8 *val); 333 334 u8 335 GetHalDefVar8188E( 336 IN PADAPTER Adapter, 337 IN HAL_DEF_VARIABLE eVariable, 338 IN PVOID pValue 339 ); 340 #ifdef CONFIG_GPIO_API 341 int rtl8188e_GpioFuncCheck(PADAPTER adapter, u8 gpio_num); 342 #endif 343 #endif /* __RTL8188E_HAL_H__ */ 344