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