xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/rkwifi/bcmdhd/include/sbconfig.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Broadcom SiliconBackplane hardware register definitions.
3  *
4  * Copyright (C) 2020, Broadcom.
5  *
6  *      Unless you and Broadcom execute a separate written software license
7  * agreement governing use of this software, this software is licensed to you
8  * under the terms of the GNU General Public License version 2 (the "GPL"),
9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10  * following added to such license:
11  *
12  *      As a special exception, the copyright holders of this software give you
13  * permission to link this software with independent modules, and to copy and
14  * distribute the resulting executable under terms of your choice, provided that
15  * you also meet, for each linked independent module, the terms and conditions of
16  * the license of that module.  An independent module is a module which is not
17  * derived from this software.  The special exception does not apply to any
18  * modifications of the software.
19  *
20  *
21  * <<Broadcom-WL-IPTag/Dual:>>
22  */
23 
24 #ifndef	_SBCONFIG_H
25 #define	_SBCONFIG_H
26 
27 /* cpp contortions to concatenate w/arg prescan */
28 #ifndef PAD
29 #define	_PADLINE(line)	pad ## line
30 #define	_XSTR(line)	_PADLINE(line)
31 #define	PAD		_XSTR(__LINE__)
32 #endif
33 
34 /* enumeration in SB is based on the premise that cores are contiguous in the
35  * enumeration space.
36  */
37 #define SB_BUS_SIZE		0x10000		/**< Each bus gets 64Kbytes for cores */
38 #define SB_BUS_BASE(sih, b)		(SI_ENUM_BASE(sih) + (b) * SB_BUS_SIZE)
39 #define	SB_BUS_MAXCORES		(SB_BUS_SIZE / SI_CORE_SIZE)	/**< Max cores per bus */
40 
41 /*
42  * Sonics Configuration Space Registers.
43  */
44 #define	SBCONFIGOFF		0xf00		/**< core sbconfig regs are top 256bytes of regs */
45 #define	SBCONFIGSIZE		256		/**< sizeof (sbconfig_t) */
46 
47 #define SBIPSFLAG		0x08
48 #define SBTPSFLAG		0x18
49 #define	SBTMERRLOGA		0x48		/**< sonics >= 2.3 */
50 #define	SBTMERRLOG		0x50		/**< sonics >= 2.3 */
51 #define SBADMATCH3		0x60
52 #define SBADMATCH2		0x68
53 #define SBADMATCH1		0x70
54 #define SBIMSTATE		0x90
55 #define SBINTVEC		0x94
56 #define SBTMSTATELOW		0x98
57 #define SBTMSTATEHIGH		0x9c
58 #define SBBWA0			0xa0
59 #define SBIMCONFIGLOW		0xa8
60 #define SBIMCONFIGHIGH		0xac
61 #define SBADMATCH0		0xb0
62 #define SBTMCONFIGLOW		0xb8
63 #define SBTMCONFIGHIGH		0xbc
64 #define SBBCONFIG		0xc0
65 #define SBBSTATE		0xc8
66 #define SBACTCNFG		0xd8
67 #define	SBFLAGST		0xe8
68 #define SBIDLOW			0xf8
69 #define SBIDHIGH		0xfc
70 
71 /* All the previous registers are above SBCONFIGOFF, but with Sonics 2.3, we have
72  * a few registers *below* that line. I think it would be very confusing to try
73  * and change the value of SBCONFIGOFF, so I'm definig them as absolute offsets here,
74  */
75 
76 #define SBIMERRLOGA		0xea8
77 #define SBIMERRLOG		0xeb0
78 #define SBTMPORTCONNID0		0xed8
79 #define SBTMPORTLOCK0		0xef8
80 
81 #if !defined(_LANGUAGE_ASSEMBLY) && !defined(__ASSEMBLY__)
82 
83 typedef volatile struct _sbconfig {
84 	uint32	PAD[2];
85 	uint32	sbipsflag;		/**< initiator port ocp slave flag */
86 	uint32	PAD[3];
87 	uint32	sbtpsflag;		/**< target port ocp slave flag */
88 	uint32	PAD[11];
89 	uint32	sbtmerrloga;		/**< (sonics >= 2.3) */
90 	uint32	PAD;
91 	uint32	sbtmerrlog;		/**< (sonics >= 2.3) */
92 	uint32	PAD[3];
93 	uint32	sbadmatch3;		/**< address match3 */
94 	uint32	PAD;
95 	uint32	sbadmatch2;		/**< address match2 */
96 	uint32	PAD;
97 	uint32	sbadmatch1;		/**< address match1 */
98 	uint32	PAD[7];
99 	uint32	sbimstate;		/**< initiator agent state */
100 	uint32	sbintvec;		/**< interrupt mask */
101 	uint32	sbtmstatelow;		/**< target state */
102 	uint32	sbtmstatehigh;		/**< target state */
103 	uint32	sbbwa0;			/**< bandwidth allocation table0 */
104 	uint32	PAD;
105 	uint32	sbimconfiglow;		/**< initiator configuration */
106 	uint32	sbimconfighigh;		/**< initiator configuration */
107 	uint32	sbadmatch0;		/**< address match0 */
108 	uint32	PAD;
109 	uint32	sbtmconfiglow;		/**< target configuration */
110 	uint32	sbtmconfighigh;		/**< target configuration */
111 	uint32	sbbconfig;		/**< broadcast configuration */
112 	uint32	PAD;
113 	uint32	sbbstate;		/**< broadcast state */
114 	uint32	PAD[3];
115 	uint32	sbactcnfg;		/**< activate configuration */
116 	uint32	PAD[3];
117 	uint32	sbflagst;		/**< current sbflags */
118 	uint32	PAD[3];
119 	uint32	sbidlow;		/**< identification */
120 	uint32	sbidhigh;		/**< identification */
121 } sbconfig_t;
122 
123 #endif /* !_LANGUAGE_ASSEMBLY && !__ASSEMBLY__ */
124 
125 /* sbipsflag */
126 #define	SBIPS_INT1_MASK		0x3f		/**< which sbflags get routed to mips interrupt 1 */
127 #define	SBIPS_INT1_SHIFT	0
128 #define	SBIPS_INT2_MASK		0x3f00		/**< which sbflags get routed to mips interrupt 2 */
129 #define	SBIPS_INT2_SHIFT	8
130 #define	SBIPS_INT3_MASK		0x3f0000	/**< which sbflags get routed to mips interrupt 3 */
131 #define	SBIPS_INT3_SHIFT	16
132 #define	SBIPS_INT4_MASK		0x3f000000	/**< which sbflags get routed to mips interrupt 4 */
133 #define	SBIPS_INT4_SHIFT	24
134 
135 /* sbtpsflag */
136 #define	SBTPS_NUM0_MASK		0x3f		/**< interrupt sbFlag # generated by this core */
137 #define	SBTPS_F0EN0		0x40		/**< interrupt is always sent on the backplane */
138 
139 /* sbtmerrlog */
140 #define	SBTMEL_CM		0x00000007	/**< command */
141 #define	SBTMEL_CI		0x0000ff00	/**< connection id */
142 #define	SBTMEL_EC		0x0f000000	/**< error code */
143 #define	SBTMEL_ME		0x80000000	/**< multiple error */
144 
145 /* sbimstate */
146 #define	SBIM_PC			0xf		/**< pipecount */
147 #define	SBIM_AP_MASK		0x30		/**< arbitration policy */
148 #define	SBIM_AP_BOTH		0x00		/**< use both timeslaces and token */
149 #define	SBIM_AP_TS		0x10		/**< use timesliaces only */
150 #define	SBIM_AP_TK		0x20		/**< use token only */
151 #define	SBIM_AP_RSV		0x30		/**< reserved */
152 #define	SBIM_IBE		0x20000		/**< inbanderror */
153 #define	SBIM_TO			0x40000		/**< timeout */
154 #define	SBIM_BY			0x01800000	/**< busy (sonics >= 2.3) */
155 #define	SBIM_RJ			0x02000000	/**< reject (sonics >= 2.3) */
156 
157 /* sbtmstatelow */
158 #define	SBTML_RESET		0x0001		/**< reset */
159 #define	SBTML_REJ_MASK		0x0006		/**< reject field */
160 #define	SBTML_REJ		0x0002		/**< reject */
161 #define	SBTML_TMPREJ		0x0004		/**< temporary reject, for error recovery */
162 
163 #define	SBTML_SICF_SHIFT	16	/**< Shift to locate the SI control flags in sbtml */
164 
165 /* sbtmstatehigh */
166 #define	SBTMH_SERR		0x0001		/**< serror */
167 #define	SBTMH_INT		0x0002		/**< interrupt */
168 #define	SBTMH_BUSY		0x0004		/**< busy */
169 #define	SBTMH_TO		0x0020		/**< timeout (sonics >= 2.3) */
170 
171 #define	SBTMH_SISF_SHIFT	16		/**< Shift to locate the SI status flags in sbtmh */
172 
173 /* sbbwa0 */
174 #define	SBBWA_TAB0_MASK		0xffff		/**< lookup table 0 */
175 #define	SBBWA_TAB1_MASK		0xffff		/**< lookup table 1 */
176 #define	SBBWA_TAB1_SHIFT	16
177 
178 /* sbimconfiglow */
179 #define	SBIMCL_STO_MASK		0x7		/**< service timeout */
180 #define	SBIMCL_RTO_MASK		0x70		/**< request timeout */
181 #define	SBIMCL_RTO_SHIFT	4
182 #define	SBIMCL_CID_MASK		0xff0000	/**< connection id */
183 #define	SBIMCL_CID_SHIFT	16
184 
185 /* sbimconfighigh */
186 #define	SBIMCH_IEM_MASK		0xc		/**< inband error mode */
187 #define	SBIMCH_TEM_MASK		0x30		/**< timeout error mode */
188 #define	SBIMCH_TEM_SHIFT	4
189 #define	SBIMCH_BEM_MASK		0xc0		/**< bus error mode */
190 #define	SBIMCH_BEM_SHIFT	6
191 
192 /* sbadmatch0 */
193 #define	SBAM_TYPE_MASK		0x3		/**< address type */
194 #define	SBAM_AD64		0x4		/**< reserved */
195 #define	SBAM_ADINT0_MASK	0xf8		/**< type0 size */
196 #define	SBAM_ADINT0_SHIFT	3
197 #define	SBAM_ADINT1_MASK	0x1f8		/**< type1 size */
198 #define	SBAM_ADINT1_SHIFT	3
199 #define	SBAM_ADINT2_MASK	0x1f8		/**< type2 size */
200 #define	SBAM_ADINT2_SHIFT	3
201 #define	SBAM_ADEN		0x400		/**< enable */
202 #define	SBAM_ADNEG		0x800		/**< negative decode */
203 #define	SBAM_BASE0_MASK		0xffffff00	/**< type0 base address */
204 #define	SBAM_BASE0_SHIFT	8
205 #define	SBAM_BASE1_MASK		0xfffff000	/**< type1 base address for the core */
206 #define	SBAM_BASE1_SHIFT	12
207 #define	SBAM_BASE2_MASK		0xffff0000	/**< type2 base address for the core */
208 #define	SBAM_BASE2_SHIFT	16
209 
210 /* sbtmconfiglow */
211 #define	SBTMCL_CD_MASK		0xff		/**< clock divide */
212 #define	SBTMCL_CO_MASK		0xf800		/**< clock offset */
213 #define	SBTMCL_CO_SHIFT		11
214 #define	SBTMCL_IF_MASK		0xfc0000	/**< interrupt flags */
215 #define	SBTMCL_IF_SHIFT		18
216 #define	SBTMCL_IM_MASK		0x3000000	/**< interrupt mode */
217 #define	SBTMCL_IM_SHIFT		24
218 
219 /* sbtmconfighigh */
220 #define	SBTMCH_BM_MASK		0x3		/**< busy mode */
221 #define	SBTMCH_RM_MASK		0x3		/**< retry mode */
222 #define	SBTMCH_RM_SHIFT		2
223 #define	SBTMCH_SM_MASK		0x30		/**< stop mode */
224 #define	SBTMCH_SM_SHIFT		4
225 #define	SBTMCH_EM_MASK		0x300		/**< sb error mode */
226 #define	SBTMCH_EM_SHIFT		8
227 #define	SBTMCH_IM_MASK		0xc00		/**< int mode */
228 #define	SBTMCH_IM_SHIFT		10
229 
230 /* sbbconfig */
231 #define	SBBC_LAT_MASK		0x3		/**< sb latency */
232 #define	SBBC_MAX0_MASK		0xf0000		/**< maxccntr0 */
233 #define	SBBC_MAX0_SHIFT		16
234 #define	SBBC_MAX1_MASK		0xf00000	/**< maxccntr1 */
235 #define	SBBC_MAX1_SHIFT		20
236 
237 /* sbbstate */
238 #define	SBBS_SRD		0x1		/**< st reg disable */
239 #define	SBBS_HRD		0x2		/**< hold reg disable */
240 
241 /* sbidlow */
242 #define	SBIDL_CS_MASK		0x3		/**< config space */
243 #define	SBIDL_AR_MASK		0x38		/**< # address ranges supported */
244 #define	SBIDL_AR_SHIFT		3
245 #define	SBIDL_SYNCH		0x40		/**< sync */
246 #define	SBIDL_INIT		0x80		/**< initiator */
247 #define	SBIDL_MINLAT_MASK	0xf00		/**< minimum backplane latency */
248 #define	SBIDL_MINLAT_SHIFT	8
249 #define	SBIDL_MAXLAT		0xf000		/**< maximum backplane latency */
250 #define	SBIDL_MAXLAT_SHIFT	12
251 #define	SBIDL_FIRST		0x10000		/**< this initiator is first */
252 #define	SBIDL_CW_MASK		0xc0000		/**< cycle counter width */
253 #define	SBIDL_CW_SHIFT		18
254 #define	SBIDL_TP_MASK		0xf00000	/**< target ports */
255 #define	SBIDL_TP_SHIFT		20
256 #define	SBIDL_IP_MASK		0xf000000	/**< initiator ports */
257 #define	SBIDL_IP_SHIFT		24
258 #define	SBIDL_RV_MASK		0xf0000000	/**< sonics backplane revision code */
259 #define	SBIDL_RV_SHIFT		28
260 #define	SBIDL_RV_2_2		0x00000000	/**< version 2.2 or earlier */
261 #define	SBIDL_RV_2_3		0x10000000	/**< version 2.3 */
262 
263 /* sbidhigh */
264 #define	SBIDH_RC_MASK		0x000f		/**< revision code */
265 #define	SBIDH_RCE_MASK		0x7000		/**< revision code extension field */
266 #define	SBIDH_RCE_SHIFT		8
267 #define	SBCOREREV(sbidh) \
268 	((((sbidh) & SBIDH_RCE_MASK) >> SBIDH_RCE_SHIFT) | ((sbidh) & SBIDH_RC_MASK))
269 #define	SBIDH_CC_MASK		0x8ff0		/**< core code */
270 #define	SBIDH_CC_SHIFT		4
271 #define	SBIDH_VC_MASK		0xffff0000	/**< vendor code */
272 #define	SBIDH_VC_SHIFT		16
273 
274 #define	SB_COMMIT		0xfd8		/**< update buffered registers value */
275 
276 /* vendor codes */
277 #define	SB_VEND_BCM		0x4243		/**< Broadcom's SB vendor code */
278 
279 #endif	/* _SBCONFIG_H */
280