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