1 /****************************************************************************** 2 * 3 * Copyright(c) 2007 - 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 __RTL8814A_HAL_H__ 16 #define __RTL8814A_HAL_H__ 17 18 /* #include "hal_com.h" */ 19 #include "hal_data.h" 20 21 /* include HAL Related header after HAL Related compiling flags */ 22 #include "rtl8814a_spec.h" 23 #include "rtl8814a_rf.h" 24 #include "rtl8814a_dm.h" 25 #include "rtl8814a_recv.h" 26 #include "rtl8814a_xmit.h" 27 #include "rtl8814a_cmd.h" 28 #include "rtl8814a_led.h" 29 #include "Hal8814PwrSeq.h" 30 #include "Hal8814PhyReg.h" 31 #include "Hal8814PhyCfg.h" 32 #ifdef DBG_CONFIG_ERROR_DETECT 33 #include "rtl8814a_sreset.h" 34 #endif /* DBG_CONFIG_ERROR_DETECT */ 35 36 enum { 37 VOLTAGE_V25 = 0x03, 38 LDOE25_SHIFT = 28 , 39 }; 40 /* max. iram is 64k , max dmen is 32k. Total = 96k = 0x18000*/ 41 #define FW_SIZE 0x18000 42 #define FW_START_ADDRESS 0x1000 43 typedef struct _RT_FIRMWARE_8814 { 44 FIRMWARE_SOURCE eFWSource; 45 #ifdef CONFIG_EMBEDDED_FWIMG 46 u8 *szFwBuffer; 47 #else 48 u8 szFwBuffer[FW_SIZE]; 49 #endif 50 u32 ulFwLength; 51 } RT_FIRMWARE_8814, *PRT_FIRMWARE_8814; 52 53 #define PAGE_SIZE_TX_8814 PAGE_SIZE_128 54 /* BCN rsvd_page_num = MAX_BEACON_LEN / PAGE_SIZE_TX_8814 55 * PS-Poll:1, Null Data:1,Qos Null Data:1,BT Qos Null Data:1,CTS-2-SELF,LTE QoS Null*/ 56 57 #define BCNQ_PAGE_NUM_8814 (MAX_BEACON_LEN / PAGE_SIZE_TX_8814 + 6) /*0x08*/ 58 59 #define Rtl8814A_NIC_PWR_ON_FLOW rtl8814A_power_on_flow 60 #define Rtl8814A_NIC_RF_OFF_FLOW rtl8814A_radio_off_flow 61 #define Rtl8814A_NIC_DISABLE_FLOW rtl8814A_card_disable_flow 62 #define Rtl8814A_NIC_ENABLE_FLOW rtl8814A_card_enable_flow 63 #define Rtl8814A_NIC_SUSPEND_FLOW rtl8814A_suspend_flow 64 #define Rtl8814A_NIC_RESUME_FLOW rtl8814A_resume_flow 65 #define Rtl8814A_NIC_PDN_FLOW rtl8814A_hwpdn_flow 66 #define Rtl8814A_NIC_LPS_ENTER_FLOW rtl8814A_enter_lps_flow 67 #define Rtl8814A_NIC_LPS_LEAVE_FLOW rtl8814A_leave_lps_flow 68 69 /* ***************************************************** 70 * New Firmware Header(8-byte alinment required) 71 * ***************************************************** 72 * --- LONG WORD 0 ---- */ 73 #define GET_FIRMWARE_HDR_SIGNATURE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 0, 16) 74 #define GET_FIRMWARE_HDR_CATEGORY_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 16, 8) /* AP/NIC and USB/PCI */ 75 #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 */ 76 #define GET_FIRMWARE_HDR_VERSION_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)/* FW Version */ 77 #define GET_FIRMWARE_HDR_SUB_VER_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) /* FW Subversion, default 0x00 */ 78 #define GET_FIRMWARE_HDR_SUB_IDX_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8) /* FW Subversion Index */ 79 80 /* --- LONG WORD 1 ---- */ 81 #define GET_FIRMWARE_HDR_SVN_IDX_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 0, 32)/* The SVN entry index */ 82 #define GET_FIRMWARE_HDR_RSVD1_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 0, 32) 83 84 /* --- LONG WORD 2 ---- */ 85 #define GET_FIRMWARE_HDR_MONTH_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 0, 8) /* Release time Month field */ 86 #define GET_FIRMWARE_HDR_DATE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 8, 8) /* Release time Date field */ 87 #define GET_FIRMWARE_HDR_HOUR_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 16, 8)/* Release time Hour field */ 88 #define GET_FIRMWARE_HDR_MINUTE_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 24, 8)/* Release time Minute field */ 89 #define GET_FIRMWARE_HDR_YEAR_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 0, 16)/* Release time Year field */ 90 #define GET_FIRMWARE_HDR_FOUNDRY_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 16, 8)/* Release time Foundry field */ 91 #define GET_FIRMWARE_HDR_RSVD2_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 24, 8) 92 93 /* --- LONG WORD 3 ---- */ 94 #define GET_FIRMWARE_HDR_MEM_UASGE_DL_FROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 0, 1) 95 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_FROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 1, 1) 96 #define GET_FIRMWARE_HDR_MEM_UASGE_BOOT_LOADER_3081(__FwHdr)LE_BITS_TO_4BYTE(__FwHdr+24, 2, 1) 97 #define GET_FIRMWARE_HDR_MEM_UASGE_IRAM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 3, 1) 98 #define GET_FIRMWARE_HDR_MEM_UASGE_ERAM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 4, 1) 99 #define GET_FIRMWARE_HDR_MEM_UASGE_RSVD4_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 5, 3) 100 #define GET_FIRMWARE_HDR_RSVD3_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 8, 8) 101 #define GET_FIRMWARE_HDR_BOOT_LOADER_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 16, 16) 102 #define GET_FIRMWARE_HDR_RSVD5_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32) 103 104 /* --- LONG WORD 4 ---- */ 105 #define GET_FIRMWARE_HDR_TOTAL_DMEM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 0, 32) 106 #define GET_FIRMWARE_HDR_FW_CFG_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 0, 16) 107 #define GET_FIRMWARE_HDR_FW_ATTR_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+36, 16, 16) 108 109 /* --- LONG WORD 5 ---- */ 110 #define GET_FIRMWARE_HDR_IROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+40, 0, 32) 111 #define GET_FIRMWARE_HDR_EROM_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+44, 0, 32) 112 113 /* --- LONG WORD 6 ---- */ 114 #define GET_FIRMWARE_HDR_IRAM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+48, 0, 32) 115 #define GET_FIRMWARE_HDR_ERAM_SZ_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+52, 0, 32) 116 117 /* --- LONG WORD 7 ---- */ 118 #define GET_FIRMWARE_HDR_RSVD6_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+56, 0, 32) 119 #define GET_FIRMWARE_HDR_RSVD7_3081(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+60, 0, 32) 120 121 122 123 /* 124 * 2013/08/16 MH MOve from SDIO.h for common use. 125 * */ 126 #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) 127 #define TRX_SHARE_MODE_8814A 0 /* TRX Buffer Share Index */ 128 #define BASIC_RXFF_SIZE_8814A 24576/* Basic RXFF Size is 24K = 24*1024 Unit: Byte */ 129 #define TRX_SHARE_BUFF_UNIT_8814A 65536/* TRX Share Buffer unit Size 64K = 64*1024 Unit: Byte */ 130 #define TRX_SHARE_BUFF_UNIT_PAGE_8814A (TRX_SHARE_BUFF_UNIT_8814A/PAGE_SIZE_8814A)/* 512 Pages */ 131 132 /* Origin: */ 133 #define HPQ_PGNUM_8814A 0x20 /* High Queue */ 134 #define LPQ_PGNUM_8814A 0x20 /* Low Queue */ 135 #define NPQ_PGNUM_8814A 0x20 /* Normal Queue */ 136 #define EPQ_PGNUM_8814A 0x20 /* Extra Queue */ 137 138 #else /* #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) */ 139 140 #define HPQ_PGNUM_8814A 20 141 #define NPQ_PGNUM_8814A 20 142 #define LPQ_PGNUM_8814A 20 /* 1972 */ 143 #define EPQ_PGNUM_8814A 20 144 #define BCQ_PGNUM_8814A 32 145 146 #endif /* #if defined(CONFIG_SDIO_HCI) || defined(CONFIG_USB_HCI) */ 147 148 #ifdef CONFIG_WOWLAN 149 #define WOWLAN_PAGE_NUM_8814 0x06 150 #else 151 #define WOWLAN_PAGE_NUM_8814 0x00 152 #endif 153 154 #define PAGE_SIZE_8814A 128/* TXFF Page Size, Unit: Byte */ 155 #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 */ 156 #define TX_PAGE_BOUNDARY_8814A TXPKT_PGNUM_8814A /* Need to enlarge boundary, by KaiYuan */ 157 #define TX_PAGE_BOUNDARY_WOWLAN_8814A TXPKT_PGNUM_8814A /* TODO: 20130415 KaiYuan Check this value later */ 158 159 #ifdef CONFIG_FW_C2H_DEBUG 160 #define RX_DMA_RESERVED_SIZE_8814A 0x100 /* 256B, reserved for c2h debug message */ 161 #else 162 #define RX_DMA_RESERVED_SIZE_8814A 0x0 /* 0B */ 163 #endif 164 #define RX_DMA_BOUNDARY_8814A (MAX_RX_DMA_BUFFER_SIZE_8814A - RX_DMA_RESERVED_SIZE_8814A - 1) 165 166 #define TOTAL_PGNUM_8814A 2048 167 #define TXPKT_PGNUM_8814A (2048 - BCNQ_PAGE_NUM_8814-WOWLAN_PAGE_NUM_8814) 168 #define PUB_PGNUM_8814A (TXPKT_PGNUM_8814A-HPQ_PGNUM_8814A-NPQ_PGNUM_8814A-LPQ_PGNUM_8814A-EPQ_PGNUM_8814A) 169 170 /* Note: For WMM Normal Chip Setting ,modify later */ 171 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A TX_PAGE_BOUNDARY_8814A 172 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8814A (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8814A + 1) 173 174 #define DRIVER_EARLY_INT_TIME_8814 0x05 175 #define BCN_DMA_ATIME_INT_TIME_8814 0x02 176 177 178 #define MAX_PAGE_SIZE 4096 /* @ page : 4k bytes */ 179 180 #define EFUSE_MAX_SECTION_JAGUAR 64 181 182 #define HWSET_MAX_SIZE_8814A 512 183 184 #define EFUSE_REAL_CONTENT_LEN_8814A 1024 185 #define EFUSE_MAX_BANK_8814A 2 186 187 #define EFUSE_MAP_LEN_8814A 512 188 #define EFUSE_MAX_SECTION_8814A 64 189 #define EFUSE_MAX_WORD_UNIT_8814A 4 190 #define EFUSE_PROTECT_BYTES_BANK_8814A 16 191 192 #define EFUSE_IC_ID_OFFSET_8814A 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 193 #define AVAILABLE_EFUSE_ADDR_8814A(addr) (addr < EFUSE_REAL_CONTENT_LEN_8814A) 194 195 /*------------------------------------------------------------------------- 196 Chip specific 197 -------------------------------------------------------------------------*/ 198 199 /* pic buffer descriptor */ 200 #if 1 /* according to the define in the rtw_xmit.h, rtw_recv.h */ 201 #define RTL8814AE_SEG_NUM TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */ 202 #define TX_DESC_NUM_8814A TX_BD_NUM /* 128 */ 203 #define RX_DESC_NUM_8814A PCI_MAX_RX_COUNT /* 128 */ 204 #ifdef CONFIG_CONCURRENT_MODE 205 #define BE_QUEUE_TX_DESC_NUM_8814A (TX_BD_NUM<<1) /* 256 */ 206 #else 207 #define BE_QUEUE_TX_DESC_NUM_8814A (TX_BD_NUM+(TX_BD_NUM>>1)) /* 192 */ 208 #endif 209 #else 210 #define RTL8814AE_SEG_NUM TX_BUFFER_SEG_NUM /* 0:2 seg, 1: 4 seg, 2: 8 seg */ 211 #define TX_DESC_NUM_8814A 128 /* 1024//2048 change by ylb 20130624 */ 212 #define RX_DESC_NUM_8814A 128 /* 1024 //512 change by ylb 20130624 */ 213 #endif 214 215 /* <Roger_Notes> To prevent out of boundary programming case, 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 #ifdef CONFIG_FILE_FWIMG 224 extern char *rtw_fw_file_path; 225 #ifdef CONFIG_WOWLAN 226 extern char *rtw_fw_wow_file_path; 227 #endif 228 #ifdef CONFIG_MP_INCLUDED 229 extern char *rtw_fw_mp_bt_file_path; 230 #endif /* CONFIG_MP_INCLUDED */ 231 #endif /* CONFIG_FILE_FWIMG */ 232 233 /* rtl8814_hal_init.c */ 234 s32 FirmwareDownload8814A(PADAPTER Adapter, BOOLEAN bUsedWoWLANFw); 235 void InitializeFirmwareVars8814(PADAPTER padapter); 236 237 void 238 Hal_InitEfuseVars_8814A( 239 PADAPTER Adapter 240 ); 241 242 s32 InitLLTTable8814A( 243 PADAPTER Adapter 244 ); 245 246 247 void InitRDGSetting8814A(PADAPTER padapter); 248 249 /* void CheckAutoloadState8812A(PADAPTER padapter); */ 250 251 /* EFuse */ 252 u8 GetEEPROMSize8814A(PADAPTER padapter); 253 void hal_InitPGData_8814A( 254 PADAPTER padapter, 255 u8 *PROMContent 256 ); 257 258 void hal_ReadPROMVersion8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 259 void hal_ReadTxPowerInfo8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 260 void hal_ReadBoardType8814A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 261 void hal_ReadThermalMeter_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 262 void hal_ReadChannelPlan8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 263 void hal_EfuseParseXtal_8814A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 264 void hal_ReadAntennaDiversity8814A(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 265 void hal_Read_TRX_antenna_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 266 void hal_ReadAmplifierType_8814A( 267 PADAPTER Adapter 268 ); 269 void hal_ReadPAType_8814A( 270 PADAPTER Adapter, 271 u8 *PROMContent, 272 BOOLEAN AutoloadFail, 273 u8 *pPAType, 274 u8 *pLNAType 275 ); 276 277 void hal_GetRxGainOffset_8814A( 278 PADAPTER Adapter, 279 u8 *PROMContent, 280 BOOLEAN AutoloadFail 281 ); 282 void Hal_EfuseParseKFreeData_8814A( 283 PADAPTER Adapter, 284 u8 *PROMContent, 285 BOOLEAN AutoloadFail); 286 void hal_ReadRFEType_8814A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 287 void hal_EfuseParseBTCoexistInfo8814A(PADAPTER Adapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 288 289 /* void hal_ReadUsbType_8812AU(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 290 * int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); */ 291 void hal_ReadRemoteWakeup_8814A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 292 u8 MgntQuery_NssTxRate(u16 Rate); 293 294 /* BOOLEAN HalDetectPwrDownMode8812(PADAPTER Adapter); */ 295 296 #ifdef CONFIG_WOWLAN 297 void Hal_DetectWoWMode(PADAPTER pAdapter); 298 #endif /* CONFIG_WOWLAN */ 299 300 void _InitBeaconParameters_8814A(PADAPTER padapter); 301 void SetBeaconRelatedRegisters8814A(PADAPTER padapter); 302 303 void ReadRFType8814A(PADAPTER padapter); 304 void InitDefaultValue8814A(PADAPTER padapter); 305 306 u8 SetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval); 307 void GetHwReg8814A(PADAPTER padapter, u8 variable, u8 *pval); 308 u8 SetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 309 u8 GetHalDefVar8814A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 310 void rtl8814_set_hal_ops(struct hal_ops *pHalFunc); 311 void init_hal_spec_8814a(_adapter *adapter); 312 313 void rtl8814_start_thread(PADAPTER padapter); 314 void rtl8814_stop_thread(PADAPTER padapter); 315 316 317 #ifdef CONFIG_PCI_HCI 318 BOOLEAN InterruptRecognized8814AE(PADAPTER Adapter); 319 void UpdateInterruptMask8814AE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 320 void InitMAC_TRXBD_8814AE(PADAPTER Adapter); 321 void rtl8814ae_reset_desc_ring(_adapter *padapter); 322 u16 get_txbd_rw_reg(u16 ff_hwaddr); 323 #endif 324 325 #ifdef CONFIG_BT_COEXIST 326 void rtl8814a_combo_card_WifiOnlyHwInit(PADAPTER Adapter); 327 #endif 328 329 void rtl8814ae_hci_flush(PADAPTER Adapter, u32 queue); 330 331 #endif /* __RTL8188E_HAL_H__ */ 332