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