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 __RTL8814A_HAL_H__ 21 #define __RTL8814A_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 "rtl8814a_spec.h" 28 #include "rtl8814a_rf.h" 29 #include "rtl8814a_dm.h" 30 #include "rtl8814a_recv.h" 31 #include "rtl8814a_xmit.h" 32 #include "rtl8814a_cmd.h" 33 #include "rtl8814a_led.h" 34 #include "Hal8814PwrSeq.h" 35 #include "Hal8814PhyReg.h" 36 #include "Hal8814PhyCfg.h" 37 #ifdef DBG_CONFIG_ERROR_DETECT 38 #include "rtl8814a_sreset.h" 39 #endif //DBG_CONFIG_ERROR_DETECT 40 41 42 typedef enum _TX_PWR_PERCENTAGE{ 43 TX_PWR_PERCENTAGE_0 = 0x01, // 12.5% 44 TX_PWR_PERCENTAGE_1 = 0x02, // 25% 45 TX_PWR_PERCENTAGE_2 = 0x04, // 50% 46 TX_PWR_PERCENTAGE_3 = 0x08, //100%, default target output power. 47 } TX_PWR_PERCENTAGE; 48 49 50 enum{ 51 VOLTAGE_V25 = 0x03, 52 LDOE25_SHIFT = 28 , 53 }; 54 #define FW_SIZE 0x10000 // Compatible with RTL8723 Maximal RAM code size 24K. modified to 32k, TO compatible with 92d maximal fw size 32k 55 #define FW_START_ADDRESS 0x1000 56 typedef struct _RT_FIRMWARE_8814 { 57 FIRMWARE_SOURCE eFWSource; 58 #ifdef CONFIG_EMBEDDED_FWIMG 59 u8* szFwBuffer; 60 #else 61 u8 szFwBuffer[FW_SIZE]; 62 #endif 63 u32 ulFwLength; 64 } RT_FIRMWARE_8814, *PRT_FIRMWARE_8814; 65 66 #define PAGE_SIZE_TX_8814 PAGE_SIZE_128 67 #define BCNQ_PAGE_NUM_8814 0x08 68 69 //--------------------------------------------------------------------- 70 // RTL8814AU From header 71 //--------------------------------------------------------------------- 72 #define RTL8814A_FW_IMG "rtl8814a/FW_NIC.bin" 73 #define RTL8814A_FW_WW_IMG "rtl8814a/FW_WoWLAN.bin" 74 #define RTL8814A_PHY_REG "rtl8814a/PHY_REG.txt" 75 #define RTL8814A_PHY_RADIO_A "rtl8814a/RadioA.txt" 76 #define RTL8814A_PHY_RADIO_B "rtl8814a/RadioB.txt" 77 #define RTL8814A_PHY_RADIO_C "rtl8814a/RadioC.txt" 78 #define RTL8814A_PHY_RADIO_D "rtl8814a/RadioD.txt" 79 #define RTL8814A_TXPWR_TRACK "rtl8814a/TxPowerTrack.txt" 80 #define RTL8814A_AGC_TAB "rtl8814a/AGC_TAB.txt" 81 #define RTL8814A_PHY_MACREG "rtl8814a/MAC_REG.txt" 82 #define RTL8814A_PHY_REG_PG "rtl8814a/PHY_REG_PG.txt" 83 #define RTL8814A_PHY_REG_MP "rtl8814a/PHY_REG_MP.txt" 84 #define RTL8814A_TXPWR_LMT "rtl8814a/TXPWR_LMT.txt" 85 #define RTL8814A_WIFI_ANT_ISOLATION "rtl8814a/wifi_ant_isolation.txt" 86 87 #define Rtl8814A_NIC_PWR_ON_FLOW rtl8814A_power_on_flow 88 #define Rtl8814A_NIC_RF_OFF_FLOW rtl8814A_radio_off_flow 89 #define Rtl8814A_NIC_DISABLE_FLOW rtl8814A_card_disable_flow 90 #define Rtl8814A_NIC_ENABLE_FLOW rtl8814A_card_enable_flow 91 #define Rtl8814A_NIC_SUSPEND_FLOW rtl8814A_suspend_flow 92 #define Rtl8814A_NIC_RESUME_FLOW rtl8814A_resume_flow 93 #define Rtl8814A_NIC_PDN_FLOW rtl8814A_hwpdn_flow 94 #define Rtl8814A_NIC_LPS_ENTER_FLOW rtl8814A_enter_lps_flow 95 #define Rtl8814A_NIC_LPS_LEAVE_FLOW rtl8814A_leave_lps_flow 96 97 //===================================================== 98 // New Firmware Header(8-byte alinment required) 99 //===================================================== 100 //--- LONG WORD 0 ---- 101 #define GET_FIRMWARE_HDR_SIGNATURE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 0, 16) 102 #define GET_FIRMWARE_HDR_CATEGORY_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 16, 8) // AP/NIC and USB/PCI 103 #define GET_FIRMWARE_HDR_FUNCTION_3081(__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 104 #define GET_FIRMWARE_HDR_VERSION_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)// FW Version 105 #define GET_FIRMWARE_HDR_SUB_VER_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) // FW Subversion, default 0x00 106 #define GET_FIRMWARE_HDR_SUB_IDX_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8) // FW Subversion Index 107 108 //--- LONG WORD 1 ---- 109 #define GET_FIRMWARE_HDR_SVN_IDX_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 0, 32)// The SVN entry index 110 #define GET_FIRMWARE_HDR_RSVD1_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 0, 32) 111 112 //--- LONG WORD 2 ---- 113 #define GET_FIRMWARE_HDR_MONTH_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 0, 8) // Release time Month field 114 #define GET_FIRMWARE_HDR_DATE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 8, 8) // Release time Date field 115 #define GET_FIRMWARE_HDR_HOUR_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 16, 8)// Release time Hour field 116 #define GET_FIRMWARE_HDR_MINUTE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 24, 8)// Release time Minute field 117 #define GET_FIRMWARE_HDR_YEAR_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 0, 16)// Release time Year field 118 #define GET_FIRMWARE_HDR_FOUNDRY_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 16, 8)// Release time Foundry field 119 #define GET_FIRMWARE_HDR_RSVD2_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 24, 8) 120 121 //--- LONG WORD 3 ---- 122 #define GET_FIRMWARE_HDR_MEM_UASGE_DL_FROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 0, 1) 123 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_FROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 1, 1) 124 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_LOADER_3081(__FwHdr)LE_BITS_TO_4BYTE(__FwHdr+24, 2, 1) 125 #define GET_FIRMWARE_HDR_MEM_UASGE_IRAM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 3, 1) 126 #define GET_FIRMWARE_HDR_MEM_UASGE_ERAM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 4, 1) 127 #define GET_FIRMWARE_HDR_MEM_UASGE_RSVD4_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 5, 3) 128 #define GET_FIRMWARE_HDR_RSVD3_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 8, 8) 129 #define GET_FIRMWARE_HDR_BOOT_LOADER_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 16, 16) 130 #define GET_FIRMWARE_HDR_RSVD5_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32) 131 132 //--- LONG WORD 4 ---- 133 #define GET_FIRMWARE_HDR_TOTAL_DMEM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 0, 32) 134 #define GET_FIRMWARE_HDR_FW_CFG_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 0, 16) 135 #define GET_FIRMWARE_HDR_FW_ATTR_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 16, 16) 136 137 //--- LONG WORD 5 ---- 138 #define GET_FIRMWARE_HDR_IROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+40, 0, 32) 139 #define GET_FIRMWARE_HDR_EROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+44, 0, 32) 140 141 //--- LONG WORD 6 ---- 142 #define GET_FIRMWARE_HDR_IRAM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+48, 0, 32) 143 #define GET_FIRMWARE_HDR_ERAM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+52, 0, 32) 144 145 //--- LONG WORD 7 ---- 146 #define GET_FIRMWARE_HDR_RSVD6_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+56, 0, 32) 147 #define GET_FIRMWARE_HDR_RSVD7_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+60, 0, 32) 148 149 150 151 // 152 // 2013/08/16 MH MOve from SDIO.h for common use. 153 // 154 #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) 155 #define TRX_SHARE_MODE_8814A 0 //TRX Buffer Share Index 156 #define BASIC_RXFF_SIZE_8814A 24576//Basic RXFF Size is 24K = 24*1024 Unit: Byte 157 #define TRX_SHARE_BUFF_UNIT_8814A 65536//TRX Share Buffer unit Size 64K = 64*1024 Unit: Byte 158 #define TRX_SHARE_BUFF_UNIT_PAGE_8814A TRX_SHARE_BUFF_UNIT_8814A/PAGE_SIZE_8814A//512 Pages 159 160 //Origin: 161 #define HPQ_PGNUM_8814A 0x20 //High Queue 162 #define LPQ_PGNUM_8814A 0x20 //Low Queue 163 #define NPQ_PGNUM_8814A 0x20 //Normal Queue 164 #define EPQ_PGNUM_8814A 0x20 //Extra Queue 165 166 #else // #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) 167 168 #define HPQ_PGNUM_8814A 20 169 #define NPQ_PGNUM_8814A 20 170 #define LPQ_PGNUM_8814A 20 //1972 171 #define EPQ_PGNUM_8814A 20 172 #define BCQ_PGNUM_8814A 32 173 174 #endif //#if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) 175 176 #define PAGE_SIZE_8814A 128//TXFF Page Size, Unit: Byte 177 #define MAX_RX_DMA_BUFFER_SIZE_8814A 0x5C00 //BASIC_RXFF_SIZE_8814A+TRX_SHARE_MODE_8814A*TRX_SHARE_BUFF_UNIT_8814A //Basic RXFF Size + ShareBuffer Size 178 #define TX_PAGE_BOUNDARY_8814A TXPKT_PGNUM_8814A // Need to enlarge boundary, by KaiYuan 179 #define TX_PAGE_BOUNDARY_WOWLAN_8814A TXPKT_PGNUM_8814A //TODO: 20130415 KaiYuan Check this value later 180 181 182 #define TOTAL_PGNUM_8814A 2048 183 #define TXPKT_PGNUM_8814A 2032 184 #define PUB_PGNUM_8814A (TXPKT_PGNUM_8814A-HPQ_PGNUM_8814A-NPQ_PGNUM_8814A-LPQ_PGNUM_8814A-EPQ_PGNUM_8814A) 185 186 //Note: For WMM Normal Chip Setting ,modify later 187 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A TX_PAGE_BOUNDARY_8814A 188 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8814A (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A + 1) 189 190 #define DRIVER_EARLY_INT_TIME_8814 0x05 191 #define BCN_DMA_ATIME_INT_TIME_8814 0x02 192 193 194 #define MAX_PAGE_SIZE 4096 // @ page : 4k bytes 195 196 #define EFUSE_MAX_SECTION_JAGUAR 64 197 198 #define HWSET_MAX_SIZE_8814A 512 199 200 #define EFUSE_REAL_CONTENT_LEN_8814A 1024 201 #define EFUSE_MAX_BANK_8814A 2 202 203 #define EFUSE_MAP_LEN_8814A 512 204 #define EFUSE_MAX_SECTION_8814A 64 205 #define EFUSE_MAX_WORD_UNIT_8814A 4 206 #define EFUSE_PROTECT_BYTES_BANK_8814A 16 207 208 #define EFUSE_IC_ID_OFFSET_8814A 506 //For some inferiority IC purpose. added by Roger, 2009.09.02. 209 #define AVAILABLE_EFUSE_ADDR_8814A(addr) (addr < EFUSE_REAL_CONTENT_LEN_8814A) 210 211 /*------------------------------------------------------------------------- 212 Chip specific 213 -------------------------------------------------------------------------*/ 214 215 /* pic buffer descriptor */ 216 #if 1 /* according to the define in the rtw_xmit.h, rtw_recv.h */ 217 #define RTL8814AE_SEG_NUM TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */ 218 #define TX_DESC_NUM_8814A TXDESC_NUM /* 128 */ 219 #define RX_DESC_NUM_8814A PCI_MAX_RX_COUNT /* 128 */ 220 #ifdef CONFIG_CONCURRENT_MODE 221 #define BE_QUEUE_TX_DESC_NUM_8814A (TXDESC_NUM<<1) /* 256 */ 222 #else 223 #define BE_QUEUE_TX_DESC_NUM_8814A (TXDESC_NUM+(TXDESC_NUM>>1)) /* 192 */ 224 #endif 225 #else 226 #define RTL8814AE_SEG_NUM TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */ 227 #define TX_DESC_NUM_8814A 128 /* 1024//2048 change by ylb 20130624 */ 228 #define RX_DESC_NUM_8814A 128 /* 1024 //512 change by ylb 20130624 */ 229 #endif 230 231 // <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section 232 // 9bytes + 1byt + 5bytes and pre 1byte. 233 // For worst case: 234 // | 1byte|----8bytes----|1byte|--5bytes--| 235 // | | Reserved(14bytes) | 236 // 237 #define EFUSE_OOB_PROTECT_BYTES 15 // PG data exclude header, dummy 6 bytes frome CP test and reserved 1byte. 238 239 /* rtl8814_hal_init.c */ 240 s32 FirmwareDownload8814A( PADAPTER Adapter, BOOLEAN bUsedWoWLANFw); 241 void InitializeFirmwareVars8814(PADAPTER padapter); 242 243 VOID 244 Hal_InitEfuseVars_8814A( 245 IN PADAPTER Adapter 246 ); 247 248 s32 InitLLTTable8814A( 249 IN PADAPTER Adapter 250 ); 251 252 253 void InitRDGSetting8814A(PADAPTER padapter); 254 255 //void CheckAutoloadState8812A(PADAPTER padapter); 256 257 // EFuse 258 u8 GetEEPROMSize8814A(PADAPTER padapter); 259 void InitPGData8814A(PADAPTER padapter); 260 261 void hal_ReadPROMVersion8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 262 void hal_ReadTxPowerInfo8814A(PADAPTER padapter, u8* hwinfo,BOOLEAN AutoLoadFail); 263 void hal_ReadBoardType8814A(PADAPTER pAdapter, u8* hwinfo,BOOLEAN AutoLoadFail); 264 void hal_ReadThermalMeter_8814A(PADAPTER Adapter, u8* PROMContent,BOOLEAN AutoloadFail); 265 void hal_ReadChannelPlan8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 266 void hal_EfuseParseXtal_8814A(PADAPTER pAdapter, u8* hwinfo,BOOLEAN AutoLoadFail); 267 void hal_ReadAntennaDiversity8814A(PADAPTER pAdapter,u8* PROMContent,BOOLEAN AutoLoadFail); 268 void hal_Read_TRX_antenna_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 269 VOID hal_ReadAmplifierType_8814A( 270 IN PADAPTER Adapter 271 ); 272 VOID hal_ReadPAType_8814A( 273 IN PADAPTER Adapter, 274 IN u8* PROMContent, 275 IN BOOLEAN AutoloadFail, 276 OUT u8* pPAType, 277 OUT u8* pLNAType 278 ); 279 void hal_ReadRFEType_8814A(PADAPTER Adapter,u8* PROMContent, BOOLEAN AutoloadFail); 280 void hal_EfuseParseBTCoexistInfo8814A(PADAPTER Adapter, u8* hwinfo, BOOLEAN AutoLoadFail); 281 282 //void hal_ReadUsbType_8812AU(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 283 //int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 284 void hal_ReadRemoteWakeup_8814A(PADAPTER padapter, u8* hwinfo, BOOLEAN AutoLoadFail); 285 u8 MgntQuery_NssTxRate(u16 Rate); 286 287 //BOOLEAN HalDetectPwrDownMode8812(PADAPTER Adapter); 288 289 #ifdef CONFIG_WOWLAN 290 void Hal_DetectWoWMode(PADAPTER pAdapter); 291 #endif //CONFIG_WOWLAN 292 293 void _InitBeaconParameters_8814A(PADAPTER padapter); 294 void SetBeaconRelatedRegisters8814A(PADAPTER padapter); 295 296 void ReadRFType8814A(PADAPTER padapter); 297 void InitDefaultValue8814A(PADAPTER padapter); 298 299 void SetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval); 300 void GetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval); 301 u8 SetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 302 u8 GetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 303 s32 c2h_id_filter_ccx_8814a(u8 *buf); 304 void rtl8814_set_hal_ops(struct hal_ops *pHalFunc); 305 306 // register 307 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits); 308 void SetBcnCtrlReg(PADAPTER Adapter, u8 SetBits, u8 ClearBits); 309 void rtl8814_start_thread(PADAPTER padapter); 310 void rtl8814_stop_thread(PADAPTER padapter); 311 312 313 #ifdef CONFIG_PCI_HCI 314 BOOLEAN InterruptRecognized8814AE(PADAPTER Adapter); 315 VOID UpdateInterruptMask8814AE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 316 u16 get_txbd_idx_addr(u16 ff_hwaddr); 317 #endif 318 319 #ifdef CONFIG_BT_COEXIST 320 void rtl8812a_combo_card_WifiOnlyHwInit(PADAPTER Adapter); 321 #endif 322 323 #endif //__RTL8188E_HAL_H__ 324 325