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 __RTL8812A_HAL_H__ 16 #define __RTL8812A_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 "rtl8812a_spec.h" 23 #include "rtl8812a_rf.h" 24 #include "rtl8812a_dm.h" 25 #include "rtl8812a_recv.h" 26 #include "rtl8812a_xmit.h" 27 #include "rtl8812a_cmd.h" 28 #include "rtl8812a_led.h" 29 #include "Hal8812PwrSeq.h" 30 #include "Hal8821APwrSeq.h" /* for 8821A/8811A */ 31 #include "Hal8812PhyReg.h" 32 #include "Hal8812PhyCfg.h" 33 #ifdef DBG_CONFIG_ERROR_DETECT 34 #include "rtl8812a_sreset.h" 35 #endif 36 37 /* --------------------------------------------------------------------- 38 * RTL8812 Power Configuration CMDs for PCIe interface 39 * --------------------------------------------------------------------- */ 40 #define Rtl8812_NIC_PWR_ON_FLOW rtl8812_power_on_flow 41 #define Rtl8812_NIC_RF_OFF_FLOW rtl8812_radio_off_flow 42 #define Rtl8812_NIC_DISABLE_FLOW rtl8812_card_disable_flow 43 #define Rtl8812_NIC_ENABLE_FLOW rtl8812_card_enable_flow 44 #define Rtl8812_NIC_SUSPEND_FLOW rtl8812_suspend_flow 45 #define Rtl8812_NIC_RESUME_FLOW rtl8812_resume_flow 46 #define Rtl8812_NIC_PDN_FLOW rtl8812_hwpdn_flow 47 #define Rtl8812_NIC_LPS_ENTER_FLOW rtl8812_enter_lps_flow 48 #define Rtl8812_NIC_LPS_LEAVE_FLOW rtl8812_leave_lps_flow 49 50 /* --------------------------------------------------------------------- 51 * RTL8821 Power Configuration CMDs for PCIe interface 52 * --------------------------------------------------------------------- */ 53 #define Rtl8821A_NIC_PWR_ON_FLOW rtl8821A_power_on_flow 54 #define Rtl8821A_NIC_RF_OFF_FLOW rtl8821A_radio_off_flow 55 #define Rtl8821A_NIC_DISABLE_FLOW rtl8821A_card_disable_flow 56 #define Rtl8821A_NIC_ENABLE_FLOW rtl8821A_card_enable_flow 57 #define Rtl8821A_NIC_SUSPEND_FLOW rtl8821A_suspend_flow 58 #define Rtl8821A_NIC_RESUME_FLOW rtl8821A_resume_flow 59 #define Rtl8821A_NIC_PDN_FLOW rtl8821A_hwpdn_flow 60 #define Rtl8821A_NIC_LPS_ENTER_FLOW rtl8821A_enter_lps_flow 61 #define Rtl8821A_NIC_LPS_LEAVE_FLOW rtl8821A_leave_lps_flow 62 63 64 #if 1 /* download firmware related data structure */ 65 #define FW_SIZE_8812 0x8000 /* Compatible with RTL8723 Maximal RAM code size 24K. modified to 32k, TO compatible with 92d maximal fw size 32k */ 66 #define FW_START_ADDRESS 0x1000 67 #define FW_END_ADDRESS 0x5FFF 68 69 70 71 typedef struct _RT_FIRMWARE_8812 { 72 FIRMWARE_SOURCE eFWSource; 73 #ifdef CONFIG_EMBEDDED_FWIMG 74 u8 *szFwBuffer; 75 #else 76 u8 szFwBuffer[FW_SIZE_8812]; 77 #endif 78 u32 ulFwLength; 79 } RT_FIRMWARE_8812, *PRT_FIRMWARE_8812; 80 81 /* 82 * This structure must be cared byte-ordering 83 * 84 * Added by tynli. 2009.12.04. */ 85 #define IS_FW_HEADER_EXIST_8812(_pFwHdr) ((GET_FIRMWARE_HDR_SIGNATURE_8812(_pFwHdr) & 0xFFF0) == 0x9500) 86 87 #define IS_FW_HEADER_EXIST_8821(_pFwHdr) ((GET_FIRMWARE_HDR_SIGNATURE_8812(_pFwHdr) & 0xFFF0) == 0x2100) 88 /* ***************************************************** 89 * Firmware Header(8-byte alinment required) 90 * ***************************************************** 91 * --- LONG WORD 0 ---- */ 92 #define GET_FIRMWARE_HDR_SIGNATURE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 0, 16) /* 92C0: test chip; 92C, 88C0: test chip; 88C1: MP A-cut; 92C1: MP A-cut */ 93 #define GET_FIRMWARE_HDR_CATEGORY_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 16, 8) /* AP/NIC and USB/PCI */ 94 #define GET_FIRMWARE_HDR_FUNCTION_8812(__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 */ 95 #define GET_FIRMWARE_HDR_VERSION_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)/* FW Version */ 96 #define GET_FIRMWARE_HDR_SUB_VER_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) /* FW Subversion, default 0x00 */ 97 #define GET_FIRMWARE_HDR_RSVD1_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8) 98 99 /* --- LONG WORD 1 ---- */ 100 #define GET_FIRMWARE_HDR_MONTH_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 0, 8) /* Release time Month field */ 101 #define GET_FIRMWARE_HDR_DATE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 8, 8) /* Release time Date field */ 102 #define GET_FIRMWARE_HDR_HOUR_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 16, 8)/* Release time Hour field */ 103 #define GET_FIRMWARE_HDR_MINUTE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 24, 8)/* Release time Minute field */ 104 #define GET_FIRMWARE_HDR_ROMCODE_SIZE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 0, 16)/* The size of RAM code */ 105 #define GET_FIRMWARE_HDR_RSVD2_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 16, 16) 106 107 /* --- LONG WORD 2 ---- */ 108 #define GET_FIRMWARE_HDR_SVN_IDX_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 0, 32)/* The SVN entry index */ 109 #define GET_FIRMWARE_HDR_RSVD3_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 0, 32) 110 111 /* --- LONG WORD 3 ---- */ 112 #define GET_FIRMWARE_HDR_RSVD4_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 0, 32) 113 #define GET_FIRMWARE_HDR_RSVD5_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32) 114 115 #endif /* download firmware related data structure */ 116 117 118 #define DRIVER_EARLY_INT_TIME_8812 0x05 119 #define BCN_DMA_ATIME_INT_TIME_8812 0x02 120 121 /* for 8812 122 * TX 128K, RX 16K, Page size 512B for TX, 128B for RX */ 123 #define MAX_RX_DMA_BUFFER_SIZE_8812 0x3E80 /* RX 16K */ 124 125 #ifdef CONFIG_WOWLAN 126 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_CAM_NUM) /* 16 entries, for each is 24 bytes*/ 127 #else 128 #define RESV_FMWF 0 129 #endif 130 131 #ifdef CONFIG_FW_C2H_DEBUG 132 #define RX_DMA_RESERVED_SIZE_8812 0x100 /* 256B, reserved for c2h debug message */ 133 #else 134 #define RX_DMA_RESERVED_SIZE_8812 0x0 /* 0B */ 135 #endif 136 #define RX_DMA_BOUNDARY_8812 (MAX_RX_DMA_BUFFER_SIZE_8812 - RX_DMA_RESERVED_SIZE_8812 - 1) 137 138 #define BCNQ_PAGE_NUM_8812 0x07 139 140 /* For WoWLan , more reserved page 141 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:1,GTK EXT MEM:1, AOAC rpt: 1,PNO: 6 142 * NS offload: 1 NDP info: 1 143 */ 144 #ifdef CONFIG_WOWLAN 145 #define WOWLAN_PAGE_NUM_8812 0x08 146 #else 147 #define WOWLAN_PAGE_NUM_8812 0x00 148 #endif 149 150 151 #ifdef CONFIG_BEAMFORMER_FW_NDPA 152 #define FW_NDPA_PAGE_NUM 0x02 153 #else 154 #define FW_NDPA_PAGE_NUM 0x00 155 #endif 156 157 #define TX_TOTAL_PAGE_NUMBER_8812 (0xFF - BCNQ_PAGE_NUM_8812 - WOWLAN_PAGE_NUM_8812-FW_NDPA_PAGE_NUM) 158 #define TX_PAGE_BOUNDARY_8812 (TX_TOTAL_PAGE_NUMBER_8812 + 1) 159 160 #define TX_PAGE_BOUNDARY_WOWLAN_8812 (0xFF - BCNQ_PAGE_NUM_8812 - WOWLAN_PAGE_NUM_8812 + 1) 161 162 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8812 TX_TOTAL_PAGE_NUMBER_8812 163 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8812 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8812 + 1) 164 165 /* For Normal Chip Setting 166 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8812 */ 167 #define NORMAL_PAGE_NUM_LPQ_8812 0x10 168 #define NORMAL_PAGE_NUM_HPQ_8812 0x10 169 #define NORMAL_PAGE_NUM_NPQ_8812 0x00 170 171 #define WMM_NORMAL_PAGE_NUM_HPQ_8812 0x30 172 #define WMM_NORMAL_PAGE_NUM_LPQ_8812 0x20 173 #define WMM_NORMAL_PAGE_NUM_NPQ_8812 0x20 174 175 176 /* for 8821A 177 * TX 64K, RX 16K, Page size 256B for TX, 128B for RX */ 178 #define PAGE_SIZE_TX_8821A 256 179 #define PAGE_SIZE_RX_8821A 128 180 181 #define MAX_RX_DMA_BUFFER_SIZE_8821 0x3E80 /* RX 16K */ 182 183 #ifdef CONFIG_FW_C2H_DEBUG 184 #define RX_DMA_RESERVED_SIZE_8821 0x100 /* 256B, reserved for c2h debug message */ 185 #else 186 #define RX_DMA_RESERVED_SIZE_8821 0x0 /* 0B */ 187 #endif 188 #define RX_DMA_BOUNDARY_8821 (MAX_RX_DMA_BUFFER_SIZE_8821 - RX_DMA_RESERVED_SIZE_8821 - 1) 189 190 #define BCNQ_PAGE_NUM_8821 0x08 191 #ifdef CONFIG_CONCURRENT_MODE 192 #define BCNQ1_PAGE_NUM_8821 0x04 193 #else 194 #define BCNQ1_PAGE_NUM_8821 0x00 195 #endif 196 197 /* For WoWLan , more reserved page 198 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:1,GTK EXT MEM:1, PNO: 6 */ 199 #ifdef CONFIG_WOWLAN 200 #define WOWLAN_PAGE_NUM_8821 0x06 201 #else 202 #define WOWLAN_PAGE_NUM_8821 0x00 203 #endif 204 205 #define TX_TOTAL_PAGE_NUMBER_8821 (0xFF - BCNQ_PAGE_NUM_8821 - BCNQ1_PAGE_NUM_8821 - WOWLAN_PAGE_NUM_8821) 206 #define TX_PAGE_BOUNDARY_8821 (TX_TOTAL_PAGE_NUMBER_8821 + 1) 207 /* #define TX_PAGE_BOUNDARY_WOWLAN_8821 0xE0 */ 208 209 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8821 TX_TOTAL_PAGE_NUMBER_8821 210 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8821 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8821 + 1) 211 212 213 /* (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER */ 214 #define NORMAL_PAGE_NUM_LPQ_8821 0x08/* 0x10 */ 215 #define NORMAL_PAGE_NUM_HPQ_8821 0x08/* 0x10 */ 216 #define NORMAL_PAGE_NUM_NPQ_8821 0x00 217 #define NORMAL_PAGE_NUM_EPQ_8821 0x04 218 219 #define WMM_NORMAL_PAGE_NUM_HPQ_8821 0x30 220 #define WMM_NORMAL_PAGE_NUM_LPQ_8821 0x20 221 #define WMM_NORMAL_PAGE_NUM_NPQ_8821 0x20 222 #define WMM_NORMAL_PAGE_NUM_EPQ_8821 0x00 223 224 #define MCC_NORMAL_PAGE_NUM_HPQ_8821 0x10 225 #define MCC_NORMAL_PAGE_NUM_LPQ_8821 0x10 226 #define MCC_NORMAL_PAGE_NUM_NPQ_8821 0x10 227 228 #define EFUSE_HIDDEN_812AU 0 229 #define EFUSE_HIDDEN_812AU_VS 1 230 #define EFUSE_HIDDEN_812AU_VL 2 231 #define EFUSE_HIDDEN_812AU_VN 3 232 233 #if 0 234 #define EFUSE_REAL_CONTENT_LEN_JAGUAR 1024 235 #define HWSET_MAX_SIZE_JAGUAR 1024 236 #else 237 #define EFUSE_REAL_CONTENT_LEN_JAGUAR 512 238 #define HWSET_MAX_SIZE_JAGUAR 512 239 #endif 240 241 #define EFUSE_MAX_BANK_8812A 2 242 #define EFUSE_MAP_LEN_JAGUAR 512 243 #define EFUSE_MAX_SECTION_JAGUAR 64 244 #define EFUSE_MAX_WORD_UNIT_JAGUAR 4 245 #define EFUSE_IC_ID_OFFSET_JAGUAR 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */ 246 #define AVAILABLE_EFUSE_ADDR_8812(addr) (addr < EFUSE_REAL_CONTENT_LEN_JAGUAR) 247 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section 248 * 9bytes + 1byt + 5bytes and pre 1byte. 249 * For worst case: 250 * | 2byte|----8bytes----|1byte|--7bytes--| */ /* 92D */ 251 #define EFUSE_OOB_PROTECT_BYTES_JAGUAR 18 /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */ 252 #define EFUSE_PROTECT_BYTES_BANK_JAGUAR 16 253 254 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT) 255 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS) 256 257 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */ 258 259 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */ 260 #define HAL_EFUSE_MEMORY 261 262 /* ******************************************************** 263 * EFUSE for BT definition 264 * ******************************************************** */ 265 #define BANK_NUM 2 266 #define EFUSE_BT_REAL_BANK_CONTENT_LEN 512 267 #define EFUSE_BT_REAL_CONTENT_LEN \ 268 (EFUSE_BT_REAL_BANK_CONTENT_LEN * BANK_NUM) 269 #define EFUSE_BT_MAP_LEN 1024 /* 1k bytes */ 270 #define EFUSE_BT_MAX_SECTION (EFUSE_BT_MAP_LEN / 8) 271 #define EFUSE_PROTECT_BYTES_BANK 16 272 273 #define AVAILABLE_EFUSE_ADDR(addr) (addr < EFUSE_BT_REAL_CONTENT_LEN) 274 275 #ifdef CONFIG_FILE_FWIMG 276 extern char *rtw_fw_file_path; 277 #ifdef CONFIG_WOWLAN 278 extern char *rtw_fw_wow_file_path; 279 #endif 280 #ifdef CONFIG_MP_INCLUDED 281 extern char *rtw_fw_mp_bt_file_path; 282 #endif 283 #endif 284 285 286 /* rtl8812_hal_init.c */ 287 void _8051Reset8812(PADAPTER padapter); 288 s32 FirmwareDownload8812(PADAPTER Adapter, BOOLEAN bUsedWoWLANFw); 289 void InitializeFirmwareVars8812(PADAPTER padapter); 290 291 s32 _LLTWrite_8812A(PADAPTER Adapter, u32 address, u32 data); 292 s32 InitLLTTable8812A(PADAPTER padapter, u8 txpktbuf_bndy); 293 void InitRDGSetting8812A(PADAPTER padapter); 294 295 void CheckAutoloadState8812A(PADAPTER padapter); 296 297 /* EFuse */ 298 u8 GetEEPROMSize8812A(PADAPTER padapter); 299 void InitPGData8812A(PADAPTER padapter); 300 void Hal_EfuseParseIDCode8812A(PADAPTER padapter, u8 *hwinfo); 301 void Hal_ReadPROMVersion8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 302 void Hal_ReadTxPowerInfo8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 303 void Hal_ReadBoardType8812A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 304 void Hal_ReadThermalMeter_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 305 void Hal_ReadChannelPlan8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 306 void Hal_EfuseParseXtal_8812A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 307 void Hal_ReadAntennaDiversity8812A(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail); 308 void Hal_ReadAmplifierType_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 309 void Hal_ReadPAType_8821A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 310 void Hal_ReadRFEType_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 311 void Hal_EfuseParseBTCoexistInfo8812A(PADAPTER Adapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 312 void hal_ReadUsbType_8812AU(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 313 #ifdef CONFIG_MP_INCLUDED 314 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware); 315 #endif 316 void Hal_ReadRemoteWakeup_8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail); 317 318 BOOLEAN HalDetectPwrDownMode8812(PADAPTER Adapter); 319 void Hal_EfuseParseKFreeData_8821A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail); 320 321 #ifdef CONFIG_WOWLAN 322 void Hal_DetectWoWMode(PADAPTER pAdapter); 323 #endif /* CONFIG_WOWLAN */ 324 325 void _InitBeaconParameters_8812A(PADAPTER padapter); 326 void SetBeaconRelatedRegisters8812A(PADAPTER padapter); 327 328 void ReadRFType8812A(PADAPTER padapter); 329 void InitDefaultValue8821A(PADAPTER padapter); 330 331 u8 SetHwReg8812A(PADAPTER padapter, u8 variable, u8 *pval); 332 void GetHwReg8812A(PADAPTER padapter, u8 variable, u8 *pval); 333 u8 SetHalDefVar8812A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 334 u8 GetHalDefVar8812A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval); 335 void rtl8812_set_hal_ops(struct hal_ops *pHalFunc); 336 void init_hal_spec_8812a(_adapter *adapter); 337 void init_hal_spec_8821a(_adapter *adapter); 338 339 u32 upload_txpktbuf_8812au(_adapter *adapter, u8 *buf, u32 buflen); 340 341 /* register */ 342 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits); 343 344 void rtl8812_start_thread(PADAPTER padapter); 345 void rtl8812_stop_thread(PADAPTER padapter); 346 347 #ifdef CONFIG_PCI_HCI 348 BOOLEAN InterruptRecognized8812AE(PADAPTER Adapter); 349 VOID UpdateInterruptMask8812AE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1); 350 VOID InitTRXDescHwAddress8812AE(PADAPTER Adapter); 351 #endif 352 353 #ifdef CONFIG_BT_COEXIST 354 void rtl8812a_combo_card_WifiOnlyHwInit(PADAPTER Adapter); 355 #endif 356 357 VOID 358 Hal_PatchwithJaguar_8812( 359 IN PADAPTER Adapter, 360 IN RT_MEDIA_STATUS MediaStatus 361 ); 362 363 #endif /* __RTL8188E_HAL_H__ */ 364