xref: /OK3568_Linux_fs/external/rkwifibt/drivers/rtl8723ds/include/rtl8822b_hal.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /******************************************************************************
2*4882a593Smuzhiyun  *
3*4882a593Smuzhiyun  * Copyright(c) 2015 - 2017 Realtek Corporation.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * This program is free software; you can redistribute it and/or modify it
6*4882a593Smuzhiyun  * under the terms of version 2 of the GNU General Public License as
7*4882a593Smuzhiyun  * published by the Free Software Foundation.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * This program is distributed in the hope that it will be useful, but WITHOUT
10*4882a593Smuzhiyun  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11*4882a593Smuzhiyun  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12*4882a593Smuzhiyun  * more details.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *****************************************************************************/
15*4882a593Smuzhiyun #ifndef _RTL8822B_HAL_H_
16*4882a593Smuzhiyun #define _RTL8822B_HAL_H_
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include <osdep_service.h>		/* BIT(x) */
19*4882a593Smuzhiyun #include <drv_types.h>			/* PADAPTER */
20*4882a593Smuzhiyun #include "../hal/halmac/halmac_api.h"	/* MAC REG definition */
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #ifdef CONFIG_SUPPORT_TRX_SHARED
24*4882a593Smuzhiyun #define MAX_RECVBUF_SZ		46080	/* 45KB, TX: (256-64)KB */
25*4882a593Smuzhiyun #else /* !CONFIG_SUPPORT_TRX_SHARED */
26*4882a593Smuzhiyun #ifdef CONFIG_PCI_HCI
27*4882a593Smuzhiyun #define MAX_RECVBUF_SZ		12288	/* 12KB */
28*4882a593Smuzhiyun #else
29*4882a593Smuzhiyun #define MAX_RECVBUF_SZ		24576	/* 24KB, TX: 256KB */
30*4882a593Smuzhiyun #endif /* !CONFIG_PCI_HCI */
31*4882a593Smuzhiyun #endif /* !CONFIG_SUPPORT_TRX_SHARED */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /*
34*4882a593Smuzhiyun  * MAC Register definition
35*4882a593Smuzhiyun  */
36*4882a593Smuzhiyun #define REG_AFE_XTAL_CTRL	REG_AFE_CTRL1_8822B	/* hal_com.c & phydm */
37*4882a593Smuzhiyun #define REG_AFE_PLL_CTRL	REG_AFE_CTRL2_8822B	/* hal_com.c & phydm */
38*4882a593Smuzhiyun #define REG_MAC_PHY_CTRL	REG_AFE_CTRL3_8822B	/* phydm only */
39*4882a593Smuzhiyun #define REG_LEDCFG0		REG_LED_CFG_8822B	/* rtw_mp.c */
40*4882a593Smuzhiyun #define MSR			(REG_CR_8822B + 2)	/* rtw_mp.c & hal_com.c */
41*4882a593Smuzhiyun #define MSR1			REG_CR_EXT_8822B	/* rtw_mp.c & hal_com.c */
42*4882a593Smuzhiyun #define REG_C2HEVT_MSG_NORMAL	0x1A0			/* hal_com.c */
43*4882a593Smuzhiyun #define REG_C2HEVT_CLEAR	0x1AF			/* hal_com.c */
44*4882a593Smuzhiyun #define REG_BCN_CTRL_1		REG_BCN_CTRL_CLINT0_8822B	/* hal_com.c */
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun #define REG_WOWLAN_WAKE_REASON	0x01C7 /* hal_com.c */
47*4882a593Smuzhiyun #define REG_GPIO_PIN_CTRL_2		REG_GPIO_EXT_CTRL_8822B		/* hal_com.c */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun /* RXERR_RPT, for rtw_mp.c */
50*4882a593Smuzhiyun #define RXERR_TYPE_OFDM_PPDU		0
51*4882a593Smuzhiyun #define RXERR_TYPE_OFDM_FALSE_ALARM	2
52*4882a593Smuzhiyun #define RXERR_TYPE_OFDM_MPDU_OK		0
53*4882a593Smuzhiyun #define RXERR_TYPE_OFDM_MPDU_FAIL	1
54*4882a593Smuzhiyun #define RXERR_TYPE_CCK_PPDU		3
55*4882a593Smuzhiyun #define RXERR_TYPE_CCK_FALSE_ALARM	5
56*4882a593Smuzhiyun #define RXERR_TYPE_CCK_MPDU_OK		3
57*4882a593Smuzhiyun #define RXERR_TYPE_CCK_MPDU_FAIL	4
58*4882a593Smuzhiyun #define RXERR_TYPE_HT_PPDU		8
59*4882a593Smuzhiyun #define RXERR_TYPE_HT_FALSE_ALARM	9
60*4882a593Smuzhiyun #define RXERR_TYPE_HT_MPDU_TOTAL	6
61*4882a593Smuzhiyun #define RXERR_TYPE_HT_MPDU_OK		6
62*4882a593Smuzhiyun #define RXERR_TYPE_HT_MPDU_FAIL		7
63*4882a593Smuzhiyun #define RXERR_TYPE_RX_FULL_DROP		10
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #define RXERR_COUNTER_MASK		BIT_MASK_RPT_COUNTER_8822B
66*4882a593Smuzhiyun #define RXERR_RPT_RST			BIT_RXERR_RPT_RST_8822B
67*4882a593Smuzhiyun #define _RXERR_RPT_SEL(type)		(BIT_RXERR_RPT_SEL_V1_3_0_8822B(type) \
68*4882a593Smuzhiyun 					| ((type & 0x10) ? BIT_RXERR_RPT_SEL_V1_4_8822B : 0))
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /*
71*4882a593Smuzhiyun  * BB Register definition
72*4882a593Smuzhiyun  */
73*4882a593Smuzhiyun #define rPMAC_Reset			0x100	/* hal_mp.c */
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #define	rFPGA0_RFMOD			0x800
76*4882a593Smuzhiyun #define rFPGA0_TxInfo			0x804
77*4882a593Smuzhiyun #define rOFDMCCKEN_Jaguar		0x808	/* hal_mp.c */
78*4882a593Smuzhiyun #define rFPGA0_TxGainStage		0x80C	/* phydm only */
79*4882a593Smuzhiyun #define rFPGA0_XA_HSSIParameter1	0x820	/* hal_mp.c */
80*4882a593Smuzhiyun #define rFPGA0_XA_HSSIParameter2	0x824	/* hal_mp.c */
81*4882a593Smuzhiyun #define rFPGA0_XB_HSSIParameter1	0x828	/* hal_mp.c */
82*4882a593Smuzhiyun #define rFPGA0_XB_HSSIParameter2	0x82C	/* hal_mp.c */
83*4882a593Smuzhiyun #define rTxAGC_B_Rate18_06		0x830
84*4882a593Smuzhiyun #define rTxAGC_B_Rate54_24		0x834
85*4882a593Smuzhiyun #define rTxAGC_B_CCK1_55_Mcs32		0x838
86*4882a593Smuzhiyun #define rCCAonSec_Jaguar		0x838	/* hal_mp.c */
87*4882a593Smuzhiyun #define rTxAGC_B_Mcs03_Mcs00		0x83C
88*4882a593Smuzhiyun #define rTxAGC_B_Mcs07_Mcs04		0x848
89*4882a593Smuzhiyun #define rTxAGC_B_Mcs11_Mcs08		0x84C
90*4882a593Smuzhiyun #define rFPGA0_XA_RFInterfaceOE		0x860
91*4882a593Smuzhiyun #define rFPGA0_XB_RFInterfaceOE		0x864
92*4882a593Smuzhiyun #define rTxAGC_B_Mcs15_Mcs12		0x868
93*4882a593Smuzhiyun #define rTxAGC_B_CCK11_A_CCK2_11	0x86C
94*4882a593Smuzhiyun #define rFPGA0_XAB_RFInterfaceSW	0x870
95*4882a593Smuzhiyun #define rFPGA0_XAB_RFParameter		0x878
96*4882a593Smuzhiyun #define rFPGA0_AnalogParameter4		0x88C	/* hal_mp.c & phydm */
97*4882a593Smuzhiyun #define rFPGA0_XB_LSSIReadBack		0x8A4	/* phydm */
98*4882a593Smuzhiyun #define rHSSIRead_Jaguar		0x8B0	/* RF read addr (rtl8822b_phy.c) */
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun #define	rC_TxScale_Jaguar2		0x181C  /* Pah_C TX scaling factor (hal_mp.c) */
101*4882a593Smuzhiyun #define	rC_IGI_Jaguar2			0x1850	/* Initial Gain for path-C (hal_mp.c) */
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun #define rFPGA1_TxInfo			0x90C	/* hal_mp.c */
104*4882a593Smuzhiyun #define rSingleTone_ContTx_Jaguar	0x914	/* hal_mp.c */
105*4882a593Smuzhiyun /* TX BeamForming */
106*4882a593Smuzhiyun #define REG_BB_TX_PATH_SEL_1_8822B	0x93C	/* rtl8822b_phy.c */
107*4882a593Smuzhiyun #define REG_BB_TX_PATH_SEL_2_8822B	0x940	/* rtl8822b_phy.c */
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun /* TX BeamForming */
110*4882a593Smuzhiyun #define REG_BB_TXBF_ANT_SET_BF1_8822B	0x19AC	/* rtl8822b_phy.c */
111*4882a593Smuzhiyun #define REG_BB_TXBF_ANT_SET_BF0_8822B	0x19B4	/* rtl8822b_phy.c */
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun #define rCCK0_System			0xA00
114*4882a593Smuzhiyun #define rCCK0_AFESetting		0xA04
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun #define rCCK0_DSPParameter2		0xA1C
117*4882a593Smuzhiyun #define rCCK0_TxFilter1			0xA20
118*4882a593Smuzhiyun #define rCCK0_TxFilter2			0xA24
119*4882a593Smuzhiyun #define rCCK0_DebugPort			0xA28
120*4882a593Smuzhiyun #define rCCK0_FalseAlarmReport		0xA2C
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun #define	rD_TxScale_Jaguar2		0x1A1C  /* Path_D TX scaling factor (hal_mp.c) */
123*4882a593Smuzhiyun #define	rD_IGI_Jaguar2			0x1A50	/* Initial Gain for path-D (hal_mp.c) */
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun #define rOFDM0_TRxPathEnable		0xC04
126*4882a593Smuzhiyun #define rOFDM0_TRMuxPar			0xC08
127*4882a593Smuzhiyun #define rA_TxScale_Jaguar		0xC1C	/* Pah_A TX scaling factor (hal_mp.c) */
128*4882a593Smuzhiyun #define rOFDM0_RxDetector1		0xC30	/* rtw_mp.c */
129*4882a593Smuzhiyun #define rOFDM0_ECCAThreshold		0xC4C	/* phydm only */
130*4882a593Smuzhiyun #define rOFDM0_XAAGCCore1		0xC50	/* phydm only */
131*4882a593Smuzhiyun #define rA_IGI_Jaguar			0xC50	/* Initial Gain for path-A (hal_mp.c) */
132*4882a593Smuzhiyun #define rOFDM0_XBAGCCore1		0xC58	/* phydm only */
133*4882a593Smuzhiyun #define rOFDM0_XATxIQImbalance		0xC80	/* phydm only */
134*4882a593Smuzhiyun #define rA_LSSIWrite_Jaguar		0xC90	/* RF write addr, LSSI Parameter (rtl8822b_phy.c) */
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun #define rOFDM1_LSTF			0xD00
137*4882a593Smuzhiyun #define rOFDM1_TRxPathEnable		0xD04	/* hal_mp.c */
138*4882a593Smuzhiyun #define rA_PIRead_Jaguar		0xD04	/* RF readback with PI (rtl8822b_phy.c) */
139*4882a593Smuzhiyun #define rA_SIRead_Jaguar		0xD08	/* RF readback with SI (rtl8822b_phy.c) */
140*4882a593Smuzhiyun #define rB_PIRead_Jaguar		0xD44	/* RF readback with PI (rtl8822b_phy.c) */
141*4882a593Smuzhiyun #define rB_SIRead_Jaguar		0xD48	/* RF readback with SI (rtl8822b_phy.c) */
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun #define rTxAGC_A_Rate18_06		0xE00
144*4882a593Smuzhiyun #define rTxAGC_A_Rate54_24		0xE04
145*4882a593Smuzhiyun #define rTxAGC_A_CCK1_Mcs32		0xE08
146*4882a593Smuzhiyun #define rTxAGC_A_Mcs03_Mcs00		0xE10
147*4882a593Smuzhiyun #define rTxAGC_A_Mcs07_Mcs04		0xE14
148*4882a593Smuzhiyun #define rTxAGC_A_Mcs11_Mcs08		0xE18
149*4882a593Smuzhiyun #define rTxAGC_A_Mcs15_Mcs12		0xE1C
150*4882a593Smuzhiyun #define rB_TxScale_Jaguar		0xE1C	/* Path_B TX scaling factor (hal_mp.c) */
151*4882a593Smuzhiyun #define rB_IGI_Jaguar			0xE50	/* Initial Gain for path-B (hal_mp.c) */
152*4882a593Smuzhiyun #define rB_LSSIWrite_Jaguar		0xE90	/* RF write addr, LSSI Parameter (rtl8822b_phy.c) */
153*4882a593Smuzhiyun /* RFE */
154*4882a593Smuzhiyun #define rA_RFE_Pinmux_Jaguar	0xCB0	/* hal_mp.c */
155*4882a593Smuzhiyun #define	rB_RFE_Pinmux_Jaguar	0xEB0	/* Path_B RFE control pinmux */
156*4882a593Smuzhiyun #define	rA_RFE_Inv_Jaguar		0xCB4	/* Path_A RFE cotrol */
157*4882a593Smuzhiyun #define	rB_RFE_Inv_Jaguar		0xEB4	/* Path_B RFE control */
158*4882a593Smuzhiyun #define	rA_RFE_Jaguar			0xCB8 	/* Path_A RFE cotrol */
159*4882a593Smuzhiyun #define	rB_RFE_Jaguar			0xEB8	/* Path_B RFE control */
160*4882a593Smuzhiyun #define	rA_RFE_Inverse_Jaguar	0xCBC	/* Path_A RFE control inverse */
161*4882a593Smuzhiyun #define	rB_RFE_Inverse_Jaguar	0xEBC	/* Path_B RFE control inverse */
162*4882a593Smuzhiyun #define	r_ANTSEL_SW_Jaguar		0x900	/* ANTSEL SW Control */
163*4882a593Smuzhiyun #define	bMask_RFEInv_Jaguar	0x3FF00000
164*4882a593Smuzhiyun #define	bMask_AntselPathFollow_Jaguar 0x00030000
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun #define		rC_RFE_Pinmux_Jaguar	0x18B4	/* Path_C RFE cotrol pinmux*/
167*4882a593Smuzhiyun #define		rD_RFE_Pinmux_Jaguar	0x1AB4	/* Path_D RFE cotrol pinmux*/
168*4882a593Smuzhiyun #define		rA_RFE_Sel_Jaguar2		0x1990
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun /* Page1(0x100) */
171*4882a593Smuzhiyun #define bBBResetB			0x100
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun /* Page8(0x800) */
174*4882a593Smuzhiyun #define bCCKEn				0x1000000
175*4882a593Smuzhiyun #define bOFDMEn				0x2000000
176*4882a593Smuzhiyun /* Reg 0x80C rFPGA0_TxGainStage */
177*4882a593Smuzhiyun #define bXBTxAGC			0xF00
178*4882a593Smuzhiyun #define bXCTxAGC			0xF000
179*4882a593Smuzhiyun #define bXDTxAGC			0xF0000
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun /* PageA(0xA00) */
182*4882a593Smuzhiyun #define bCCKBBMode			0x3
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun #define bCCKScramble			0x8
185*4882a593Smuzhiyun #define bCCKTxRate			0x3000
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun /* General */
188*4882a593Smuzhiyun #define bMaskByte0		0xFF		/* mp, rtw_odm.c & phydm */
189*4882a593Smuzhiyun #define bMaskByte1		0xFF00		/* hal_mp.c & phydm */
190*4882a593Smuzhiyun #define bMaskByte2		0xFF0000	/* hal_mp.c & phydm */
191*4882a593Smuzhiyun #define bMaskByte3		0xFF000000	/* hal_mp.c & phydm */
192*4882a593Smuzhiyun #define bMaskHWord		0xFFFF0000	/* hal_com.c, rtw_mp.c */
193*4882a593Smuzhiyun #define bMaskLWord		0x0000FFFF	/* mp, hal_com.c & phydm */
194*4882a593Smuzhiyun #define bMaskDWord		0xFFFFFFFF	/* mp, hal, rtw_odm.c & phydm */
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun #define bEnable			0x1		/* hal_mp.c, rtw_mp.c */
197*4882a593Smuzhiyun #define bDisable		0x0		/* rtw_mp.c */
198*4882a593Smuzhiyun 
199*4882a593Smuzhiyun #define MAX_STALL_TIME		50		/* unit: us, hal_com_phycfg.c */
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun #define Rx_Smooth_Factor	20		/* phydm only */
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun /*
204*4882a593Smuzhiyun  * RF Register definition
205*4882a593Smuzhiyun  */
206*4882a593Smuzhiyun #define RF_AC			0x00
207*4882a593Smuzhiyun #define RF_AC_Jaguar		0x00	/* hal_mp.c */
208*4882a593Smuzhiyun #define RF_CHNLBW		0x18	/* rtl8822b_phy.c */
209*4882a593Smuzhiyun #define RF_ModeTableAddr	0x30	/* rtl8822b_phy.c */
210*4882a593Smuzhiyun #define RF_ModeTableData0	0x31	/* rtl8822b_phy.c */
211*4882a593Smuzhiyun #define RF_ModeTableData1	0x32	/* rtl8822b_phy.c */
212*4882a593Smuzhiyun #define RF_0x52			0x52
213*4882a593Smuzhiyun #define RF_WeLut_Jaguar		0xEF	/* rtl8822b_phy.c */
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun /* General Functions */
216*4882a593Smuzhiyun void rtl8822b_init_hal_spec(PADAPTER);				/* hal/hal_com.c */
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun #ifdef CONFIG_MP_INCLUDED
219*4882a593Smuzhiyun /* MP Functions */
220*4882a593Smuzhiyun #include <rtw_mp.h>		/* struct mp_priv */
221*4882a593Smuzhiyun void rtl8822b_prepare_mp_txdesc(PADAPTER, struct mp_priv *);	/* rtw_mp.c */
222*4882a593Smuzhiyun void rtl8822b_mp_config_rfpath(PADAPTER);			/* hal_mp.c */
223*4882a593Smuzhiyun #endif
224*4882a593Smuzhiyun void hw_var_set_dl_rsvd_page(PADAPTER adapter, u8 mstatus);
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun #ifdef CONFIG_USB_HCI
227*4882a593Smuzhiyun #include <rtl8822bu_hal.h>
228*4882a593Smuzhiyun #elif defined(CONFIG_SDIO_HCI)
229*4882a593Smuzhiyun #include <rtl8822bs_hal.h>
230*4882a593Smuzhiyun #elif defined(CONFIG_PCI_HCI)
231*4882a593Smuzhiyun #include <rtl8822be_hal.h>
232*4882a593Smuzhiyun #endif
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun #endif /* _RTL8822B_HAL_H_ */
235