1 /******************************************************************************
3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
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.
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
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
19 ******************************************************************************/
20 #ifndef __RTL8812A_HAL_H__
21 #define __RTL8812A_HAL_H__
23 /* #include "hal_com.h" */
26 /* include HAL Related header after HAL Related compiling flags */
27 #include "rtl8812a_spec.h"
28 #include "rtl8812a_rf.h"
29 #include "rtl8812a_dm.h"
30 #include "rtl8812a_recv.h"
31 #include "rtl8812a_xmit.h"
32 #include "rtl8812a_cmd.h"
33 #include "rtl8812a_led.h"
34 #include "Hal8812PwrSeq.h"
35 #include "Hal8821APwrSeq.h" /* for 8821A/8811A */
36 #include "Hal8812PhyReg.h"
37 #include "Hal8812PhyCfg.h"
38 #ifdef DBG_CONFIG_ERROR_DETECT
39 #include "rtl8812a_sreset.h"
42 /* ---------------------------------------------------------------------
43 * RTL8812 Power Configuration CMDs for PCIe interface
44 * --------------------------------------------------------------------- */
45 #define Rtl8812_NIC_PWR_ON_FLOW rtl8812_power_on_flow
46 #define Rtl8812_NIC_RF_OFF_FLOW rtl8812_radio_off_flow
47 #define Rtl8812_NIC_DISABLE_FLOW rtl8812_card_disable_flow
48 #define Rtl8812_NIC_ENABLE_FLOW rtl8812_card_enable_flow
49 #define Rtl8812_NIC_SUSPEND_FLOW rtl8812_suspend_flow
50 #define Rtl8812_NIC_RESUME_FLOW rtl8812_resume_flow
51 #define Rtl8812_NIC_PDN_FLOW rtl8812_hwpdn_flow
52 #define Rtl8812_NIC_LPS_ENTER_FLOW rtl8812_enter_lps_flow
53 #define Rtl8812_NIC_LPS_LEAVE_FLOW rtl8812_leave_lps_flow
55 /* ---------------------------------------------------------------------
56 * RTL8821 Power Configuration CMDs for PCIe interface
57 * --------------------------------------------------------------------- */
58 #define Rtl8821A_NIC_PWR_ON_FLOW rtl8821A_power_on_flow
59 #define Rtl8821A_NIC_RF_OFF_FLOW rtl8821A_radio_off_flow
60 #define Rtl8821A_NIC_DISABLE_FLOW rtl8821A_card_disable_flow
61 #define Rtl8821A_NIC_ENABLE_FLOW rtl8821A_card_enable_flow
62 #define Rtl8821A_NIC_SUSPEND_FLOW rtl8821A_suspend_flow
63 #define Rtl8821A_NIC_RESUME_FLOW rtl8821A_resume_flow
64 #define Rtl8821A_NIC_PDN_FLOW rtl8821A_hwpdn_flow
65 #define Rtl8821A_NIC_LPS_ENTER_FLOW rtl8821A_enter_lps_flow
66 #define Rtl8821A_NIC_LPS_LEAVE_FLOW rtl8821A_leave_lps_flow
69 #if 1 /* download firmware related data structure */
70 #define FW_SIZE_8812 0x8000 /* Compatible with RTL8723 Maximal RAM code size 24K. modified to 32k, TO compatible with 92d maximal fw size 32k */
71 #define FW_START_ADDRESS 0x1000
72 #define FW_END_ADDRESS 0x5FFF
76 typedef struct _RT_FIRMWARE_8812 {
77 FIRMWARE_SOURCE eFWSource;
78 #ifdef CONFIG_EMBEDDED_FWIMG
81 u8 szFwBuffer[FW_SIZE_8812];
84 } RT_FIRMWARE_8812, *PRT_FIRMWARE_8812;
87 * This structure must be cared byte-ordering
89 * Added by tynli. 2009.12.04. */
90 #define IS_FW_HEADER_EXIST_8812(_pFwHdr) ((GET_FIRMWARE_HDR_SIGNATURE_8812(_pFwHdr) & 0xFFF0) == 0x9500)
92 #define IS_FW_HEADER_EXIST_8821(_pFwHdr) ((GET_FIRMWARE_HDR_SIGNATURE_8812(_pFwHdr) & 0xFFF0) == 0x2100)
93 /* *****************************************************
94 * Firmware Header(8-byte alinment required)
95 * *****************************************************
96 * --- LONG WORD 0 ---- */
97 #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 */
98 #define GET_FIRMWARE_HDR_CATEGORY_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr, 16, 8) /* AP/NIC and USB/PCI */
99 #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 */
100 #define GET_FIRMWARE_HDR_VERSION_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 0, 16)/* FW Version */
101 #define GET_FIRMWARE_HDR_SUB_VER_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 16, 8) /* FW Subversion, default 0x00 */
102 #define GET_FIRMWARE_HDR_RSVD1_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+4, 24, 8)
104 /* --- LONG WORD 1 ---- */
105 #define GET_FIRMWARE_HDR_MONTH_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 0, 8) /* Release time Month field */
106 #define GET_FIRMWARE_HDR_DATE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 8, 8) /* Release time Date field */
107 #define GET_FIRMWARE_HDR_HOUR_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 16, 8)/* Release time Hour field */
108 #define GET_FIRMWARE_HDR_MINUTE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+8, 24, 8)/* Release time Minute field */
109 #define GET_FIRMWARE_HDR_ROMCODE_SIZE_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 0, 16)/* The size of RAM code */
110 #define GET_FIRMWARE_HDR_RSVD2_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+12, 16, 16)
112 /* --- LONG WORD 2 ---- */
113 #define GET_FIRMWARE_HDR_SVN_IDX_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+16, 0, 32)/* The SVN entry index */
114 #define GET_FIRMWARE_HDR_RSVD3_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+20, 0, 32)
116 /* --- LONG WORD 3 ---- */
117 #define GET_FIRMWARE_HDR_RSVD4_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+24, 0, 32)
118 #define GET_FIRMWARE_HDR_RSVD5_8812(__FwHdr) LE_BITS_TO_4BYTE(__FwHdr+28, 0, 32)
120 #endif /* download firmware related data structure */
123 #define DRIVER_EARLY_INT_TIME_8812 0x05
124 #define BCN_DMA_ATIME_INT_TIME_8812 0x02
127 * TX 128K, RX 16K, Page size 512B for TX, 128B for RX */
128 #define MAX_RX_DMA_BUFFER_SIZE_8812 0x3E80 /* RX 16K */
131 #define RESV_FMWF (WKFMCAM_SIZE * MAX_WKFM_NUM) /* 16 entries, for each is 24 bytes*/
136 #ifdef CONFIG_FW_C2H_DEBUG
137 #define RX_DMA_RESERVED_SIZE_8812 0x100 /* 256B, reserved for c2h debug message */
139 #define RX_DMA_RESERVED_SIZE_8812 0x0 /* 0B */
141 #define RX_DMA_BOUNDARY_8812 (MAX_RX_DMA_BUFFER_SIZE_8812 - RX_DMA_RESERVED_SIZE_8812 - 1)
143 #define BCNQ_PAGE_NUM_8812 0x07
145 /* For WoWLan , more reserved page
146 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:1,GTK EXT MEM:1, PNO: 6 */
148 #define WOWLAN_PAGE_NUM_8812 0x05
150 #define WOWLAN_PAGE_NUM_8812 0x00
154 #ifdef CONFIG_BEAMFORMER_FW_NDPA
155 #define FW_NDPA_PAGE_NUM 0x02
157 #define FW_NDPA_PAGE_NUM 0x00
160 #define TX_TOTAL_PAGE_NUMBER_8812 (0xFF - BCNQ_PAGE_NUM_8812 - WOWLAN_PAGE_NUM_8812-FW_NDPA_PAGE_NUM)
161 #define TX_PAGE_BOUNDARY_8812 (TX_TOTAL_PAGE_NUMBER_8812 + 1)
163 #define TX_PAGE_BOUNDARY_WOWLAN_8812 (0xFF - BCNQ_PAGE_NUM_8812 - WOWLAN_PAGE_NUM_8812 + 1)
165 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8812 TX_TOTAL_PAGE_NUMBER_8812
166 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8812 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8812 + 1)
168 /* For Normal Chip Setting
169 * (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER_8812 */
170 #define NORMAL_PAGE_NUM_LPQ_8812 0x10
171 #define NORMAL_PAGE_NUM_HPQ_8812 0x10
172 #define NORMAL_PAGE_NUM_NPQ_8812 0x00
174 #define WMM_NORMAL_PAGE_NUM_HPQ_8812 0x30
175 #define WMM_NORMAL_PAGE_NUM_LPQ_8812 0x20
176 #define WMM_NORMAL_PAGE_NUM_NPQ_8812 0x20
180 * TX 64K, RX 16K, Page size 256B for TX, 128B for RX */
181 #define PAGE_SIZE_TX_8821A 256
182 #define PAGE_SIZE_RX_8821A 128
184 #define MAX_RX_DMA_BUFFER_SIZE_8821 0x3E80 /* RX 16K */
186 #ifdef CONFIG_FW_C2H_DEBUG
187 #define RX_DMA_RESERVED_SIZE_8821 0x100 /* 256B, reserved for c2h debug message */
189 #define RX_DMA_RESERVED_SIZE_8821 0x0 /* 0B */
191 #define RX_DMA_BOUNDARY_8821 (MAX_RX_DMA_BUFFER_SIZE_8821 - RX_DMA_RESERVED_SIZE_8821 - 1)
193 #define BCNQ_PAGE_NUM_8821 0x08
194 #ifdef CONFIG_CONCURRENT_MODE
195 #define BCNQ1_PAGE_NUM_8821 0x04
197 #define BCNQ1_PAGE_NUM_8821 0x00
200 /* For WoWLan , more reserved page
201 * ARP Rsp:1, RWC:1, GTK Info:1,GTK RSP:1,GTK EXT MEM:1, PNO: 6 */
203 #define WOWLAN_PAGE_NUM_8821 0x06
205 #define WOWLAN_PAGE_NUM_8821 0x00
208 #define TX_TOTAL_PAGE_NUMBER_8821 (0xFF - BCNQ_PAGE_NUM_8821 - BCNQ1_PAGE_NUM_8821 - WOWLAN_PAGE_NUM_8821)
209 #define TX_PAGE_BOUNDARY_8821 (TX_TOTAL_PAGE_NUMBER_8821 + 1)
210 /* #define TX_PAGE_BOUNDARY_WOWLAN_8821 0xE0 */
212 #define WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8821 TX_TOTAL_PAGE_NUMBER_8821
213 #define WMM_NORMAL_TX_PAGE_BOUNDARY_8821 (WMM_NORMAL_TX_TOTAL_PAGE_NUMBER_8821 + 1)
216 /* (HPQ + LPQ + NPQ + PUBQ) shall be TX_TOTAL_PAGE_NUMBER */
217 #define NORMAL_PAGE_NUM_LPQ_8821 0x08/* 0x10 */
218 #define NORMAL_PAGE_NUM_HPQ_8821 0x08/* 0x10 */
219 #define NORMAL_PAGE_NUM_NPQ_8821 0x00
221 #define WMM_NORMAL_PAGE_NUM_HPQ_8821 0x30
222 #define WMM_NORMAL_PAGE_NUM_LPQ_8821 0x20
223 #define WMM_NORMAL_PAGE_NUM_NPQ_8821 0x20
225 #define MCC_NORMAL_PAGE_NUM_HPQ_8821 0x10
226 #define MCC_NORMAL_PAGE_NUM_LPQ_8821 0x10
227 #define MCC_NORMAL_PAGE_NUM_NPQ_8821 0x10
229 #define EFUSE_HIDDEN_812AU 0
230 #define EFUSE_HIDDEN_812AU_VS 1
231 #define EFUSE_HIDDEN_812AU_VL 2
232 #define EFUSE_HIDDEN_812AU_VN 3
235 #define EFUSE_REAL_CONTENT_LEN_JAGUAR 1024
236 #define HWSET_MAX_SIZE_JAGUAR 1024
238 #define EFUSE_REAL_CONTENT_LEN_JAGUAR 512
239 #define HWSET_MAX_SIZE_JAGUAR 512
242 #define EFUSE_MAX_BANK_8812A 2
243 #define EFUSE_MAP_LEN_JAGUAR 512
244 #define EFUSE_MAX_SECTION_JAGUAR 64
245 #define EFUSE_MAX_WORD_UNIT_JAGUAR 4
246 #define EFUSE_IC_ID_OFFSET_JAGUAR 506 /* For some inferiority IC purpose. added by Roger, 2009.09.02. */
247 #define AVAILABLE_EFUSE_ADDR_8812(addr) (addr < EFUSE_REAL_CONTENT_LEN_JAGUAR)
248 /* <Roger_Notes> To prevent out of boundary programming case, leave 1byte and program full section
249 * 9bytes + 1byt + 5bytes and pre 1byte.
251 * | 2byte|----8bytes----|1byte|--7bytes--| */ /* 92D */
252 #define EFUSE_OOB_PROTECT_BYTES_JAGUAR 18 /* PG data exclude header, dummy 7 bytes frome CP test and reserved 1byte. */
253 #define EFUSE_PROTECT_BYTES_BANK_JAGUAR 16
255 #define INCLUDE_MULTI_FUNC_BT(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_BT)
256 #define INCLUDE_MULTI_FUNC_GPS(_Adapter) (GET_HAL_DATA(_Adapter)->MultiFunc & RT_MULTI_FUNC_GPS)
258 /* #define IS_MULTI_FUNC_CHIP(_Adapter) (((((PHAL_DATA_TYPE)(_Adapter->HalData))->MultiFunc) & (RT_MULTI_FUNC_BT|RT_MULTI_FUNC_GPS)) ? _TRUE : _FALSE) */
260 /* #define RT_IS_FUNC_DISABLED(__pAdapter, __FuncBits) ( (__pAdapter)->DisabledFunctions & (__FuncBits) ) */
263 #ifdef CONFIG_FILE_FWIMG
264 extern char *rtw_fw_file_path;
266 extern char *rtw_fw_wow_file_path;
268 #ifdef CONFIG_MP_INCLUDED
269 extern char *rtw_fw_mp_bt_file_path;
274 /* rtl8812_hal_init.c */
275 void _8051Reset8812(PADAPTER padapter);
276 s32 FirmwareDownload8812(PADAPTER Adapter, BOOLEAN bUsedWoWLANFw);
277 void InitializeFirmwareVars8812(PADAPTER padapter);
279 s32 _LLTWrite_8812A(PADAPTER Adapter, u32 address, u32 data);
280 s32 InitLLTTable8812A(PADAPTER padapter, u8 txpktbuf_bndy);
281 void InitRDGSetting8812A(PADAPTER padapter);
283 void CheckAutoloadState8812A(PADAPTER padapter);
286 u8 GetEEPROMSize8812A(PADAPTER padapter);
287 void InitPGData8812A(PADAPTER padapter);
288 void Hal_EfuseParseIDCode8812A(PADAPTER padapter, u8 *hwinfo);
289 void Hal_ReadPROMVersion8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
290 void Hal_ReadTxPowerInfo8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
291 void Hal_ReadBoardType8812A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
292 void Hal_ReadThermalMeter_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
293 void Hal_ReadChannelPlan8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
294 void Hal_EfuseParseXtal_8812A(PADAPTER pAdapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
295 void Hal_ReadAntennaDiversity8812A(PADAPTER pAdapter, u8 *PROMContent, BOOLEAN AutoLoadFail);
296 void Hal_ReadAmplifierType_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
297 void Hal_ReadPAType_8821A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
298 void Hal_ReadRFEType_8812A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
299 void Hal_EfuseParseBTCoexistInfo8812A(PADAPTER Adapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
300 void hal_ReadUsbType_8812AU(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
301 #ifdef CONFIG_MP_INCLUDED
302 int FirmwareDownloadBT(PADAPTER Adapter, PRT_MP_FIRMWARE pFirmware);
304 void Hal_ReadRemoteWakeup_8812A(PADAPTER padapter, u8 *hwinfo, BOOLEAN AutoLoadFail);
306 BOOLEAN HalDetectPwrDownMode8812(PADAPTER Adapter);
307 void Hal_EfuseParseKFreeData_8821A(PADAPTER Adapter, u8 *PROMContent, BOOLEAN AutoloadFail);
310 void Hal_DetectWoWMode(PADAPTER pAdapter);
311 #endif /* CONFIG_WOWLAN */
313 void _InitBeaconParameters_8812A(PADAPTER padapter);
314 void SetBeaconRelatedRegisters8812A(PADAPTER padapter);
316 void ReadRFType8812A(PADAPTER padapter);
317 void InitDefaultValue8821A(PADAPTER padapter);
319 void SetHwReg8812A(PADAPTER padapter, u8 variable, u8 *pval);
320 void GetHwReg8812A(PADAPTER padapter, u8 variable, u8 *pval);
321 u8 SetHalDefVar8812A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
322 u8 GetHalDefVar8812A(PADAPTER padapter, HAL_DEF_VARIABLE variable, void *pval);
323 void rtl8812_set_hal_ops(struct hal_ops *pHalFunc);
324 void init_hal_spec_8812a(_adapter *adapter);
325 void init_hal_spec_8821a(_adapter *adapter);
328 void SetBcnCtrlReg(PADAPTER padapter, u8 SetBits, u8 ClearBits);
330 void rtl8812_start_thread(PADAPTER padapter);
331 void rtl8812_stop_thread(PADAPTER padapter);
333 #ifdef CONFIG_PCI_HCI
334 BOOLEAN InterruptRecognized8812AE(PADAPTER Adapter);
335 VOID UpdateInterruptMask8812AE(PADAPTER Adapter, u32 AddMSR, u32 AddMSR1, u32 RemoveMSR, u32 RemoveMSR1);
338 #ifdef CONFIG_BT_COEXIST
339 void rtl8812a_combo_card_WifiOnlyHwInit(PADAPTER Adapter);
343 Hal_PatchwithJaguar_8812(
345 IN RT_MEDIA_STATUS MediaStatus
348 #endif /* __RTL8188E_HAL_H__ */