xref: /aosp_15_r20/external/arm-trusted-firmware/include/drivers/arm/gicv3.h (revision 54fd6939e177f8ff529b10183254802c76df6d08)
1*54fd6939SJiyong Park /*
2*54fd6939SJiyong Park  * Copyright (c) 2015-2020, ARM Limited and Contributors. All rights reserved.
3*54fd6939SJiyong Park  *
4*54fd6939SJiyong Park  * SPDX-License-Identifier: BSD-3-Clause
5*54fd6939SJiyong Park  */
6*54fd6939SJiyong Park 
7*54fd6939SJiyong Park #ifndef GICV3_H
8*54fd6939SJiyong Park #define GICV3_H
9*54fd6939SJiyong Park 
10*54fd6939SJiyong Park /*******************************************************************************
11*54fd6939SJiyong Park  * GICv3 and 3.1 miscellaneous definitions
12*54fd6939SJiyong Park  ******************************************************************************/
13*54fd6939SJiyong Park /* Interrupt group definitions */
14*54fd6939SJiyong Park #define INTR_GROUP1S		U(0)
15*54fd6939SJiyong Park #define INTR_GROUP0		U(1)
16*54fd6939SJiyong Park #define INTR_GROUP1NS		U(2)
17*54fd6939SJiyong Park 
18*54fd6939SJiyong Park /* Interrupt IDs reported by the HPPIR and IAR registers */
19*54fd6939SJiyong Park #define PENDING_G1S_INTID	U(1020)
20*54fd6939SJiyong Park #define PENDING_G1NS_INTID	U(1021)
21*54fd6939SJiyong Park 
22*54fd6939SJiyong Park /* Constant to categorize LPI interrupt */
23*54fd6939SJiyong Park #define MIN_LPI_ID		U(8192)
24*54fd6939SJiyong Park 
25*54fd6939SJiyong Park /* GICv3 can only target up to 16 PEs with SGI */
26*54fd6939SJiyong Park #define GICV3_MAX_SGI_TARGETS	U(16)
27*54fd6939SJiyong Park 
28*54fd6939SJiyong Park /* PPIs INTIDs 16-31 */
29*54fd6939SJiyong Park #define MAX_PPI_ID		U(31)
30*54fd6939SJiyong Park 
31*54fd6939SJiyong Park #if GIC_EXT_INTID
32*54fd6939SJiyong Park 
33*54fd6939SJiyong Park /* GICv3.1 extended PPIs INTIDs 1056-1119 */
34*54fd6939SJiyong Park #define MIN_EPPI_ID		U(1056)
35*54fd6939SJiyong Park #define MAX_EPPI_ID		U(1119)
36*54fd6939SJiyong Park 
37*54fd6939SJiyong Park /* Total number of GICv3.1 EPPIs */
38*54fd6939SJiyong Park #define TOTAL_EPPI_INTR_NUM	(MAX_EPPI_ID - MIN_EPPI_ID + U(1))
39*54fd6939SJiyong Park 
40*54fd6939SJiyong Park /* Total number of GICv3.1 PPIs and EPPIs */
41*54fd6939SJiyong Park #define TOTAL_PRIVATE_INTR_NUM	(TOTAL_PCPU_INTR_NUM + TOTAL_EPPI_INTR_NUM)
42*54fd6939SJiyong Park 
43*54fd6939SJiyong Park /* GICv3.1 extended SPIs INTIDs 4096 - 5119 */
44*54fd6939SJiyong Park #define MIN_ESPI_ID		U(4096)
45*54fd6939SJiyong Park #define MAX_ESPI_ID		U(5119)
46*54fd6939SJiyong Park 
47*54fd6939SJiyong Park /* Total number of GICv3.1 ESPIs */
48*54fd6939SJiyong Park #define TOTAL_ESPI_INTR_NUM	(MAX_ESPI_ID - MIN_ESPI_ID + U(1))
49*54fd6939SJiyong Park 
50*54fd6939SJiyong Park /* Total number of GICv3.1 SPIs and ESPIs */
51*54fd6939SJiyong Park #define	TOTAL_SHARED_INTR_NUM	(TOTAL_SPI_INTR_NUM + TOTAL_ESPI_INTR_NUM)
52*54fd6939SJiyong Park 
53*54fd6939SJiyong Park /* SGIs: 0-15, PPIs: 16-31, EPPIs: 1056-1119 */
54*54fd6939SJiyong Park #define	IS_SGI_PPI(id)		(((id) <= MAX_PPI_ID)  || \
55*54fd6939SJiyong Park 				(((id) >= MIN_EPPI_ID) && \
56*54fd6939SJiyong Park 				 ((id) <= MAX_EPPI_ID)))
57*54fd6939SJiyong Park 
58*54fd6939SJiyong Park /* SPIs: 32-1019, ESPIs: 4096-5119 */
59*54fd6939SJiyong Park #define	IS_SPI(id)		((((id) >= MIN_SPI_ID)  && \
60*54fd6939SJiyong Park 				  ((id) <= MAX_SPI_ID)) || \
61*54fd6939SJiyong Park 				 (((id) >= MIN_ESPI_ID) && \
62*54fd6939SJiyong Park 				  ((id) <= MAX_ESPI_ID)))
63*54fd6939SJiyong Park #else	/* GICv3 */
64*54fd6939SJiyong Park 
65*54fd6939SJiyong Park /* Total number of GICv3 PPIs */
66*54fd6939SJiyong Park #define TOTAL_PRIVATE_INTR_NUM	TOTAL_PCPU_INTR_NUM
67*54fd6939SJiyong Park 
68*54fd6939SJiyong Park /* Total number of GICv3 SPIs */
69*54fd6939SJiyong Park #define	TOTAL_SHARED_INTR_NUM	TOTAL_SPI_INTR_NUM
70*54fd6939SJiyong Park 
71*54fd6939SJiyong Park /* SGIs: 0-15, PPIs: 16-31 */
72*54fd6939SJiyong Park #define	IS_SGI_PPI(id)		((id) <= MAX_PPI_ID)
73*54fd6939SJiyong Park 
74*54fd6939SJiyong Park /* SPIs: 32-1019 */
75*54fd6939SJiyong Park #define	IS_SPI(id)		(((id) >= MIN_SPI_ID) && ((id) <= MAX_SPI_ID))
76*54fd6939SJiyong Park 
77*54fd6939SJiyong Park #endif	/* GIC_EXT_INTID */
78*54fd6939SJiyong Park 
79*54fd6939SJiyong Park /*******************************************************************************
80*54fd6939SJiyong Park  * GICv3 and 3.1 specific Distributor interface register offsets and constants
81*54fd6939SJiyong Park  ******************************************************************************/
82*54fd6939SJiyong Park #define GICD_TYPER2		U(0x0c)
83*54fd6939SJiyong Park #define GICD_STATUSR		U(0x10)
84*54fd6939SJiyong Park #define GICD_SETSPI_NSR		U(0x40)
85*54fd6939SJiyong Park #define GICD_CLRSPI_NSR		U(0x48)
86*54fd6939SJiyong Park #define GICD_SETSPI_SR		U(0x50)
87*54fd6939SJiyong Park #define GICD_CLRSPI_SR		U(0x58)
88*54fd6939SJiyong Park #define GICD_IGRPMODR		U(0xd00)
89*54fd6939SJiyong Park #define GICD_IGROUPRE		U(0x1000)
90*54fd6939SJiyong Park #define GICD_ISENABLERE		U(0x1200)
91*54fd6939SJiyong Park #define GICD_ICENABLERE		U(0x1400)
92*54fd6939SJiyong Park #define GICD_ISPENDRE		U(0x1600)
93*54fd6939SJiyong Park #define GICD_ICPENDRE		U(0x1800)
94*54fd6939SJiyong Park #define GICD_ISACTIVERE		U(0x1a00)
95*54fd6939SJiyong Park #define GICD_ICACTIVERE		U(0x1c00)
96*54fd6939SJiyong Park #define GICD_IPRIORITYRE	U(0x2000)
97*54fd6939SJiyong Park #define GICD_ICFGRE		U(0x3000)
98*54fd6939SJiyong Park #define GICD_IGRPMODRE		U(0x3400)
99*54fd6939SJiyong Park #define GICD_NSACRE		U(0x3600)
100*54fd6939SJiyong Park /*
101*54fd6939SJiyong Park  * GICD_IROUTER<n> register is at 0x6000 + 8n, where n is the interrupt ID
102*54fd6939SJiyong Park  * and n >= 32, making the effective offset as 0x6100
103*54fd6939SJiyong Park  */
104*54fd6939SJiyong Park #define GICD_IROUTER		U(0x6000)
105*54fd6939SJiyong Park #define GICD_IROUTERE		U(0x8000)
106*54fd6939SJiyong Park 
107*54fd6939SJiyong Park #define GICD_PIDR0_GICV3	U(0xffe0)
108*54fd6939SJiyong Park #define GICD_PIDR1_GICV3	U(0xffe4)
109*54fd6939SJiyong Park #define GICD_PIDR2_GICV3	U(0xffe8)
110*54fd6939SJiyong Park 
111*54fd6939SJiyong Park #define IGRPMODR_SHIFT		5
112*54fd6939SJiyong Park 
113*54fd6939SJiyong Park /* GICD_CTLR bit definitions */
114*54fd6939SJiyong Park #define CTLR_ENABLE_G1NS_SHIFT		1
115*54fd6939SJiyong Park #define CTLR_ENABLE_G1S_SHIFT		2
116*54fd6939SJiyong Park #define CTLR_ARE_S_SHIFT		4
117*54fd6939SJiyong Park #define CTLR_ARE_NS_SHIFT		5
118*54fd6939SJiyong Park #define CTLR_DS_SHIFT			6
119*54fd6939SJiyong Park #define CTLR_E1NWF_SHIFT		7
120*54fd6939SJiyong Park #define GICD_CTLR_RWP_SHIFT		31
121*54fd6939SJiyong Park 
122*54fd6939SJiyong Park #define CTLR_ENABLE_G1NS_MASK		U(0x1)
123*54fd6939SJiyong Park #define CTLR_ENABLE_G1S_MASK		U(0x1)
124*54fd6939SJiyong Park #define CTLR_ARE_S_MASK			U(0x1)
125*54fd6939SJiyong Park #define CTLR_ARE_NS_MASK		U(0x1)
126*54fd6939SJiyong Park #define CTLR_DS_MASK			U(0x1)
127*54fd6939SJiyong Park #define CTLR_E1NWF_MASK			U(0x1)
128*54fd6939SJiyong Park #define GICD_CTLR_RWP_MASK		U(0x1)
129*54fd6939SJiyong Park 
130*54fd6939SJiyong Park #define CTLR_ENABLE_G1NS_BIT		BIT_32(CTLR_ENABLE_G1NS_SHIFT)
131*54fd6939SJiyong Park #define CTLR_ENABLE_G1S_BIT		BIT_32(CTLR_ENABLE_G1S_SHIFT)
132*54fd6939SJiyong Park #define CTLR_ARE_S_BIT			BIT_32(CTLR_ARE_S_SHIFT)
133*54fd6939SJiyong Park #define CTLR_ARE_NS_BIT			BIT_32(CTLR_ARE_NS_SHIFT)
134*54fd6939SJiyong Park #define CTLR_DS_BIT			BIT_32(CTLR_DS_SHIFT)
135*54fd6939SJiyong Park #define CTLR_E1NWF_BIT			BIT_32(CTLR_E1NWF_SHIFT)
136*54fd6939SJiyong Park #define GICD_CTLR_RWP_BIT		BIT_32(GICD_CTLR_RWP_SHIFT)
137*54fd6939SJiyong Park 
138*54fd6939SJiyong Park /* GICD_IROUTER shifts and masks */
139*54fd6939SJiyong Park #define IROUTER_SHIFT		0
140*54fd6939SJiyong Park #define IROUTER_IRM_SHIFT	31
141*54fd6939SJiyong Park #define IROUTER_IRM_MASK	U(0x1)
142*54fd6939SJiyong Park 
143*54fd6939SJiyong Park #define GICV3_IRM_PE		U(0)
144*54fd6939SJiyong Park #define GICV3_IRM_ANY		U(1)
145*54fd6939SJiyong Park 
146*54fd6939SJiyong Park #define NUM_OF_DIST_REGS	30
147*54fd6939SJiyong Park 
148*54fd6939SJiyong Park /* GICD_TYPER shifts and masks */
149*54fd6939SJiyong Park #define	TYPER_ESPI		U(1 << 8)
150*54fd6939SJiyong Park #define	TYPER_DVIS		U(1 << 18)
151*54fd6939SJiyong Park #define	TYPER_ESPI_RANGE_MASK	U(0x1f)
152*54fd6939SJiyong Park #define	TYPER_ESPI_RANGE_SHIFT	U(27)
153*54fd6939SJiyong Park #define	TYPER_ESPI_RANGE	U(TYPER_ESPI_MASK << TYPER_ESPI_SHIFT)
154*54fd6939SJiyong Park 
155*54fd6939SJiyong Park /*******************************************************************************
156*54fd6939SJiyong Park  * Common GIC Redistributor interface registers & constants
157*54fd6939SJiyong Park  ******************************************************************************/
158*54fd6939SJiyong Park #define GICR_V4_PCPUBASE_SHIFT	0x12
159*54fd6939SJiyong Park #define GICR_V3_PCPUBASE_SHIFT	0x11
160*54fd6939SJiyong Park #define GICR_SGIBASE_OFFSET	U(65536)	/* 64 KB */
161*54fd6939SJiyong Park #define GICR_CTLR		U(0x0)
162*54fd6939SJiyong Park #define GICR_IIDR		U(0x04)
163*54fd6939SJiyong Park #define GICR_TYPER		U(0x08)
164*54fd6939SJiyong Park #define GICR_STATUSR		U(0x10)
165*54fd6939SJiyong Park #define GICR_WAKER		U(0x14)
166*54fd6939SJiyong Park #define GICR_PROPBASER		U(0x70)
167*54fd6939SJiyong Park #define GICR_PENDBASER		U(0x78)
168*54fd6939SJiyong Park #define GICR_IGROUPR0		(GICR_SGIBASE_OFFSET + U(0x80))
169*54fd6939SJiyong Park #define GICR_ISENABLER0		(GICR_SGIBASE_OFFSET + U(0x100))
170*54fd6939SJiyong Park #define GICR_ICENABLER0		(GICR_SGIBASE_OFFSET + U(0x180))
171*54fd6939SJiyong Park #define GICR_ISPENDR0		(GICR_SGIBASE_OFFSET + U(0x200))
172*54fd6939SJiyong Park #define GICR_ICPENDR0		(GICR_SGIBASE_OFFSET + U(0x280))
173*54fd6939SJiyong Park #define GICR_ISACTIVER0		(GICR_SGIBASE_OFFSET + U(0x300))
174*54fd6939SJiyong Park #define GICR_ICACTIVER0		(GICR_SGIBASE_OFFSET + U(0x380))
175*54fd6939SJiyong Park #define GICR_IPRIORITYR		(GICR_SGIBASE_OFFSET + U(0x400))
176*54fd6939SJiyong Park #define GICR_ICFGR0		(GICR_SGIBASE_OFFSET + U(0xc00))
177*54fd6939SJiyong Park #define GICR_ICFGR1		(GICR_SGIBASE_OFFSET + U(0xc04))
178*54fd6939SJiyong Park #define GICR_IGRPMODR0		(GICR_SGIBASE_OFFSET + U(0xd00))
179*54fd6939SJiyong Park #define GICR_NSACR		(GICR_SGIBASE_OFFSET + U(0xe00))
180*54fd6939SJiyong Park 
181*54fd6939SJiyong Park #define GICR_IGROUPR		GICR_IGROUPR0
182*54fd6939SJiyong Park #define GICR_ISENABLER		GICR_ISENABLER0
183*54fd6939SJiyong Park #define GICR_ICENABLER		GICR_ICENABLER0
184*54fd6939SJiyong Park #define GICR_ISPENDR		GICR_ISPENDR0
185*54fd6939SJiyong Park #define GICR_ICPENDR		GICR_ICPENDR0
186*54fd6939SJiyong Park #define GICR_ISACTIVER		GICR_ISACTIVER0
187*54fd6939SJiyong Park #define GICR_ICACTIVER		GICR_ICACTIVER0
188*54fd6939SJiyong Park #define GICR_ICFGR		GICR_ICFGR0
189*54fd6939SJiyong Park #define GICR_IGRPMODR		GICR_IGRPMODR0
190*54fd6939SJiyong Park 
191*54fd6939SJiyong Park /* GICR_CTLR bit definitions */
192*54fd6939SJiyong Park #define GICR_CTLR_UWP_SHIFT	31
193*54fd6939SJiyong Park #define GICR_CTLR_UWP_MASK	U(0x1)
194*54fd6939SJiyong Park #define GICR_CTLR_UWP_BIT	BIT_32(GICR_CTLR_UWP_SHIFT)
195*54fd6939SJiyong Park #define GICR_CTLR_RWP_SHIFT	3
196*54fd6939SJiyong Park #define GICR_CTLR_RWP_MASK	U(0x1)
197*54fd6939SJiyong Park #define GICR_CTLR_RWP_BIT	BIT_32(GICR_CTLR_RWP_SHIFT)
198*54fd6939SJiyong Park #define GICR_CTLR_EN_LPIS_BIT	BIT_32(0)
199*54fd6939SJiyong Park 
200*54fd6939SJiyong Park /* GICR_WAKER bit definitions */
201*54fd6939SJiyong Park #define WAKER_CA_SHIFT		2
202*54fd6939SJiyong Park #define WAKER_PS_SHIFT		1
203*54fd6939SJiyong Park 
204*54fd6939SJiyong Park #define WAKER_CA_MASK		U(0x1)
205*54fd6939SJiyong Park #define WAKER_PS_MASK		U(0x1)
206*54fd6939SJiyong Park 
207*54fd6939SJiyong Park #define WAKER_CA_BIT		BIT_32(WAKER_CA_SHIFT)
208*54fd6939SJiyong Park #define WAKER_PS_BIT		BIT_32(WAKER_PS_SHIFT)
209*54fd6939SJiyong Park 
210*54fd6939SJiyong Park /* GICR_TYPER bit definitions */
211*54fd6939SJiyong Park #define TYPER_AFF_VAL_SHIFT	32
212*54fd6939SJiyong Park #define TYPER_PROC_NUM_SHIFT	8
213*54fd6939SJiyong Park #define TYPER_LAST_SHIFT	4
214*54fd6939SJiyong Park #define TYPER_VLPI_SHIFT	1
215*54fd6939SJiyong Park 
216*54fd6939SJiyong Park #define TYPER_AFF_VAL_MASK	U(0xffffffff)
217*54fd6939SJiyong Park #define TYPER_PROC_NUM_MASK	U(0xffff)
218*54fd6939SJiyong Park #define TYPER_LAST_MASK		U(0x1)
219*54fd6939SJiyong Park 
220*54fd6939SJiyong Park #define TYPER_LAST_BIT		BIT_32(TYPER_LAST_SHIFT)
221*54fd6939SJiyong Park #define TYPER_VLPI_BIT		BIT_32(TYPER_VLPI_SHIFT)
222*54fd6939SJiyong Park 
223*54fd6939SJiyong Park #define TYPER_PPI_NUM_SHIFT	U(27)
224*54fd6939SJiyong Park #define TYPER_PPI_NUM_MASK	U(0x1f)
225*54fd6939SJiyong Park 
226*54fd6939SJiyong Park /* GICR_IIDR bit definitions */
227*54fd6939SJiyong Park #define IIDR_PRODUCT_ID_MASK	U(0xff000000)
228*54fd6939SJiyong Park #define IIDR_VARIANT_MASK	U(0x000f0000)
229*54fd6939SJiyong Park #define IIDR_REVISION_MASK	U(0x0000f000)
230*54fd6939SJiyong Park #define IIDR_IMPLEMENTER_MASK	U(0x00000fff)
231*54fd6939SJiyong Park #define IIDR_MODEL_MASK		(IIDR_PRODUCT_ID_MASK | \
232*54fd6939SJiyong Park 				 IIDR_IMPLEMENTER_MASK)
233*54fd6939SJiyong Park 
234*54fd6939SJiyong Park /*******************************************************************************
235*54fd6939SJiyong Park  * GICv3 and 3.1 CPU interface registers & constants
236*54fd6939SJiyong Park  ******************************************************************************/
237*54fd6939SJiyong Park /* ICC_SRE bit definitions */
238*54fd6939SJiyong Park #define ICC_SRE_EN_BIT		BIT_32(3)
239*54fd6939SJiyong Park #define ICC_SRE_DIB_BIT		BIT_32(2)
240*54fd6939SJiyong Park #define ICC_SRE_DFB_BIT		BIT_32(1)
241*54fd6939SJiyong Park #define ICC_SRE_SRE_BIT		BIT_32(0)
242*54fd6939SJiyong Park 
243*54fd6939SJiyong Park /* ICC_IGRPEN1_EL3 bit definitions */
244*54fd6939SJiyong Park #define IGRPEN1_EL3_ENABLE_G1NS_SHIFT	0
245*54fd6939SJiyong Park #define IGRPEN1_EL3_ENABLE_G1S_SHIFT	1
246*54fd6939SJiyong Park 
247*54fd6939SJiyong Park #define IGRPEN1_EL3_ENABLE_G1NS_BIT	BIT_32(IGRPEN1_EL3_ENABLE_G1NS_SHIFT)
248*54fd6939SJiyong Park #define IGRPEN1_EL3_ENABLE_G1S_BIT	BIT_32(IGRPEN1_EL3_ENABLE_G1S_SHIFT)
249*54fd6939SJiyong Park 
250*54fd6939SJiyong Park /* ICC_IGRPEN0_EL1 bit definitions */
251*54fd6939SJiyong Park #define IGRPEN1_EL1_ENABLE_G0_SHIFT	0
252*54fd6939SJiyong Park #define IGRPEN1_EL1_ENABLE_G0_BIT	BIT_32(IGRPEN1_EL1_ENABLE_G0_SHIFT)
253*54fd6939SJiyong Park 
254*54fd6939SJiyong Park /* ICC_HPPIR0_EL1 bit definitions */
255*54fd6939SJiyong Park #define HPPIR0_EL1_INTID_SHIFT		0
256*54fd6939SJiyong Park #define HPPIR0_EL1_INTID_MASK		U(0xffffff)
257*54fd6939SJiyong Park 
258*54fd6939SJiyong Park /* ICC_HPPIR1_EL1 bit definitions */
259*54fd6939SJiyong Park #define HPPIR1_EL1_INTID_SHIFT		0
260*54fd6939SJiyong Park #define HPPIR1_EL1_INTID_MASK		U(0xffffff)
261*54fd6939SJiyong Park 
262*54fd6939SJiyong Park /* ICC_IAR0_EL1 bit definitions */
263*54fd6939SJiyong Park #define IAR0_EL1_INTID_SHIFT		0
264*54fd6939SJiyong Park #define IAR0_EL1_INTID_MASK		U(0xffffff)
265*54fd6939SJiyong Park 
266*54fd6939SJiyong Park /* ICC_IAR1_EL1 bit definitions */
267*54fd6939SJiyong Park #define IAR1_EL1_INTID_SHIFT		0
268*54fd6939SJiyong Park #define IAR1_EL1_INTID_MASK		U(0xffffff)
269*54fd6939SJiyong Park 
270*54fd6939SJiyong Park /* ICC SGI macros */
271*54fd6939SJiyong Park #define SGIR_TGT_MASK			ULL(0xffff)
272*54fd6939SJiyong Park #define SGIR_AFF1_SHIFT			16
273*54fd6939SJiyong Park #define SGIR_INTID_SHIFT		24
274*54fd6939SJiyong Park #define SGIR_INTID_MASK			ULL(0xf)
275*54fd6939SJiyong Park #define SGIR_AFF2_SHIFT			32
276*54fd6939SJiyong Park #define SGIR_IRM_SHIFT			40
277*54fd6939SJiyong Park #define SGIR_IRM_MASK			ULL(0x1)
278*54fd6939SJiyong Park #define SGIR_AFF3_SHIFT			48
279*54fd6939SJiyong Park #define SGIR_AFF_MASK			ULL(0xf)
280*54fd6939SJiyong Park 
281*54fd6939SJiyong Park #define SGIR_IRM_TO_AFF			U(0)
282*54fd6939SJiyong Park 
283*54fd6939SJiyong Park #define GICV3_SGIR_VALUE(_aff3, _aff2, _aff1, _intid, _irm, _tgt)	\
284*54fd6939SJiyong Park 	((((uint64_t) (_aff3) & SGIR_AFF_MASK) << SGIR_AFF3_SHIFT) |	\
285*54fd6939SJiyong Park 	 (((uint64_t) (_irm) & SGIR_IRM_MASK) << SGIR_IRM_SHIFT) |	\
286*54fd6939SJiyong Park 	 (((uint64_t) (_aff2) & SGIR_AFF_MASK) << SGIR_AFF2_SHIFT) |	\
287*54fd6939SJiyong Park 	 (((_intid) & SGIR_INTID_MASK) << SGIR_INTID_SHIFT) |		\
288*54fd6939SJiyong Park 	 (((_aff1) & SGIR_AFF_MASK) << SGIR_AFF1_SHIFT) |		\
289*54fd6939SJiyong Park 	 ((_tgt) & SGIR_TGT_MASK))
290*54fd6939SJiyong Park 
291*54fd6939SJiyong Park /*****************************************************************************
292*54fd6939SJiyong Park  * GICv3 and 3.1 ITS registers and constants
293*54fd6939SJiyong Park  *****************************************************************************/
294*54fd6939SJiyong Park #define GITS_CTLR			U(0x0)
295*54fd6939SJiyong Park #define GITS_IIDR			U(0x4)
296*54fd6939SJiyong Park #define GITS_TYPER			U(0x8)
297*54fd6939SJiyong Park #define GITS_CBASER			U(0x80)
298*54fd6939SJiyong Park #define GITS_CWRITER			U(0x88)
299*54fd6939SJiyong Park #define GITS_CREADR			U(0x90)
300*54fd6939SJiyong Park #define GITS_BASER			U(0x100)
301*54fd6939SJiyong Park 
302*54fd6939SJiyong Park /* GITS_CTLR bit definitions */
303*54fd6939SJiyong Park #define GITS_CTLR_ENABLED_BIT		BIT_32(0)
304*54fd6939SJiyong Park #define GITS_CTLR_QUIESCENT_BIT		BIT_32(1)
305*54fd6939SJiyong Park 
306*54fd6939SJiyong Park #define GITS_TYPER_VSGI			BIT_64(39)
307*54fd6939SJiyong Park 
308*54fd6939SJiyong Park #ifndef __ASSEMBLER__
309*54fd6939SJiyong Park 
310*54fd6939SJiyong Park #include <stdbool.h>
311*54fd6939SJiyong Park #include <stdint.h>
312*54fd6939SJiyong Park 
313*54fd6939SJiyong Park #include <arch_helpers.h>
314*54fd6939SJiyong Park #include <common/interrupt_props.h>
315*54fd6939SJiyong Park #include <drivers/arm/gic_common.h>
316*54fd6939SJiyong Park #include <lib/utils_def.h>
317*54fd6939SJiyong Park 
gicv3_redist_size(uint64_t typer_val)318*54fd6939SJiyong Park static inline uintptr_t gicv3_redist_size(uint64_t typer_val)
319*54fd6939SJiyong Park {
320*54fd6939SJiyong Park #if GIC_ENABLE_V4_EXTN
321*54fd6939SJiyong Park 	if ((typer_val & TYPER_VLPI_BIT) != 0U) {
322*54fd6939SJiyong Park 		return 1U << GICR_V4_PCPUBASE_SHIFT;
323*54fd6939SJiyong Park 	} else {
324*54fd6939SJiyong Park 		return 1U << GICR_V3_PCPUBASE_SHIFT;
325*54fd6939SJiyong Park 	}
326*54fd6939SJiyong Park #else
327*54fd6939SJiyong Park 	return 1U << GICR_V3_PCPUBASE_SHIFT;
328*54fd6939SJiyong Park #endif
329*54fd6939SJiyong Park }
330*54fd6939SJiyong Park 
331*54fd6939SJiyong Park unsigned int gicv3_get_component_partnum(const uintptr_t gic_frame);
332*54fd6939SJiyong Park 
gicv3_is_intr_id_special_identifier(unsigned int id)333*54fd6939SJiyong Park static inline bool gicv3_is_intr_id_special_identifier(unsigned int id)
334*54fd6939SJiyong Park {
335*54fd6939SJiyong Park 	return (id >= PENDING_G1S_INTID) && (id <= GIC_SPURIOUS_INTERRUPT);
336*54fd6939SJiyong Park }
337*54fd6939SJiyong Park 
338*54fd6939SJiyong Park /*******************************************************************************
339*54fd6939SJiyong Park  * Helper GICv3 and 3.1 macros for SEL1
340*54fd6939SJiyong Park  ******************************************************************************/
gicv3_acknowledge_interrupt_sel1(void)341*54fd6939SJiyong Park static inline uint32_t gicv3_acknowledge_interrupt_sel1(void)
342*54fd6939SJiyong Park {
343*54fd6939SJiyong Park 	return (uint32_t)read_icc_iar1_el1() & IAR1_EL1_INTID_MASK;
344*54fd6939SJiyong Park }
345*54fd6939SJiyong Park 
gicv3_get_pending_interrupt_id_sel1(void)346*54fd6939SJiyong Park static inline uint32_t gicv3_get_pending_interrupt_id_sel1(void)
347*54fd6939SJiyong Park {
348*54fd6939SJiyong Park 	return (uint32_t)read_icc_hppir1_el1() & HPPIR1_EL1_INTID_MASK;
349*54fd6939SJiyong Park }
350*54fd6939SJiyong Park 
gicv3_end_of_interrupt_sel1(unsigned int id)351*54fd6939SJiyong Park static inline void gicv3_end_of_interrupt_sel1(unsigned int id)
352*54fd6939SJiyong Park {
353*54fd6939SJiyong Park 	/*
354*54fd6939SJiyong Park 	 * Interrupt request deassertion from peripheral to GIC happens
355*54fd6939SJiyong Park 	 * by clearing interrupt condition by a write to the peripheral
356*54fd6939SJiyong Park 	 * register. It is desired that the write transfer is complete
357*54fd6939SJiyong Park 	 * before the core tries to change GIC state from 'AP/Active' to
358*54fd6939SJiyong Park 	 * a new state on seeing 'EOI write'.
359*54fd6939SJiyong Park 	 * Since ICC interface writes are not ordered against Device
360*54fd6939SJiyong Park 	 * memory writes, a barrier is required to ensure the ordering.
361*54fd6939SJiyong Park 	 * The dsb will also ensure *completion* of previous writes with
362*54fd6939SJiyong Park 	 * DEVICE nGnRnE attribute.
363*54fd6939SJiyong Park 	 */
364*54fd6939SJiyong Park 	dsbishst();
365*54fd6939SJiyong Park 	write_icc_eoir1_el1(id);
366*54fd6939SJiyong Park }
367*54fd6939SJiyong Park 
368*54fd6939SJiyong Park /*******************************************************************************
369*54fd6939SJiyong Park  * Helper GICv3 macros for EL3
370*54fd6939SJiyong Park  ******************************************************************************/
gicv3_acknowledge_interrupt(void)371*54fd6939SJiyong Park static inline uint32_t gicv3_acknowledge_interrupt(void)
372*54fd6939SJiyong Park {
373*54fd6939SJiyong Park 	return (uint32_t)read_icc_iar0_el1() & IAR0_EL1_INTID_MASK;
374*54fd6939SJiyong Park }
375*54fd6939SJiyong Park 
gicv3_end_of_interrupt(unsigned int id)376*54fd6939SJiyong Park static inline void gicv3_end_of_interrupt(unsigned int id)
377*54fd6939SJiyong Park {
378*54fd6939SJiyong Park 	/*
379*54fd6939SJiyong Park 	 * Interrupt request deassertion from peripheral to GIC happens
380*54fd6939SJiyong Park 	 * by clearing interrupt condition by a write to the peripheral
381*54fd6939SJiyong Park 	 * register. It is desired that the write transfer is complete
382*54fd6939SJiyong Park 	 * before the core tries to change GIC state from 'AP/Active' to
383*54fd6939SJiyong Park 	 * a new state on seeing 'EOI write'.
384*54fd6939SJiyong Park 	 * Since ICC interface writes are not ordered against Device
385*54fd6939SJiyong Park 	 * memory writes, a barrier is required to ensure the ordering.
386*54fd6939SJiyong Park 	 * The dsb will also ensure *completion* of previous writes with
387*54fd6939SJiyong Park 	 * DEVICE nGnRnE attribute.
388*54fd6939SJiyong Park 	 */
389*54fd6939SJiyong Park 	dsbishst();
390*54fd6939SJiyong Park 	return write_icc_eoir0_el1(id);
391*54fd6939SJiyong Park }
392*54fd6939SJiyong Park 
393*54fd6939SJiyong Park /*
394*54fd6939SJiyong Park  * This macro returns the total number of GICD/GICR registers corresponding to
395*54fd6939SJiyong Park  * the register name
396*54fd6939SJiyong Park  */
397*54fd6939SJiyong Park #define GICD_NUM_REGS(reg_name)	\
398*54fd6939SJiyong Park 	DIV_ROUND_UP_2EVAL(TOTAL_SHARED_INTR_NUM, (1 << reg_name##_SHIFT))
399*54fd6939SJiyong Park 
400*54fd6939SJiyong Park #define GICR_NUM_REGS(reg_name)	\
401*54fd6939SJiyong Park 	DIV_ROUND_UP_2EVAL(TOTAL_PRIVATE_INTR_NUM, (1 << reg_name##_SHIFT))
402*54fd6939SJiyong Park 
403*54fd6939SJiyong Park /* Interrupt ID mask for HPPIR, AHPPIR, IAR and AIAR CPU Interface registers */
404*54fd6939SJiyong Park #define INT_ID_MASK	U(0xffffff)
405*54fd6939SJiyong Park 
406*54fd6939SJiyong Park /*******************************************************************************
407*54fd6939SJiyong Park  * This structure describes some of the implementation defined attributes of the
408*54fd6939SJiyong Park  * GICv3 IP. It is used by the platform port to specify these attributes in order
409*54fd6939SJiyong Park  * to initialise the GICV3 driver. The attributes are described below.
410*54fd6939SJiyong Park  *
411*54fd6939SJiyong Park  * The 'gicd_base' field contains the base address of the Distributor interface
412*54fd6939SJiyong Park  * programmer's view.
413*54fd6939SJiyong Park  *
414*54fd6939SJiyong Park  * The 'gicr_base' field contains the base address of the Re-distributor
415*54fd6939SJiyong Park  * interface programmer's view.
416*54fd6939SJiyong Park  *
417*54fd6939SJiyong Park  * The 'interrupt_props' field is a pointer to an array that enumerates secure
418*54fd6939SJiyong Park  * interrupts and their properties. If this field is not NULL, both
419*54fd6939SJiyong Park  * 'g0_interrupt_array' and 'g1s_interrupt_array' fields are ignored.
420*54fd6939SJiyong Park  *
421*54fd6939SJiyong Park  * The 'interrupt_props_num' field contains the number of entries in the
422*54fd6939SJiyong Park  * 'interrupt_props' array. If this field is non-zero, both 'g0_interrupt_num'
423*54fd6939SJiyong Park  * and 'g1s_interrupt_num' are ignored.
424*54fd6939SJiyong Park  *
425*54fd6939SJiyong Park  * The 'rdistif_num' field contains the number of Redistributor interfaces the
426*54fd6939SJiyong Park  * GIC implements. This is equal to the number of CPUs or CPU interfaces
427*54fd6939SJiyong Park  * instantiated in the GIC.
428*54fd6939SJiyong Park  *
429*54fd6939SJiyong Park  * The 'rdistif_base_addrs' field is a pointer to an array that has an entry for
430*54fd6939SJiyong Park  * storing the base address of the Redistributor interface frame of each CPU in
431*54fd6939SJiyong Park  * the system. The size of the array = 'rdistif_num'. The base addresses are
432*54fd6939SJiyong Park  * detected during driver initialisation.
433*54fd6939SJiyong Park  *
434*54fd6939SJiyong Park  * The 'mpidr_to_core_pos' field is a pointer to a hash function which the
435*54fd6939SJiyong Park  * driver will use to convert an MPIDR value to a linear core index. This index
436*54fd6939SJiyong Park  * will be used for accessing the 'rdistif_base_addrs' array. This is an
437*54fd6939SJiyong Park  * optional field. A GICv3 implementation maps each MPIDR to a linear core index
438*54fd6939SJiyong Park  * as well. This mapping can be found by reading the "Affinity Value" and
439*54fd6939SJiyong Park  * "Processor Number" fields in the GICR_TYPER. It is IMP. DEF. if the
440*54fd6939SJiyong Park  * "Processor Numbers" are suitable to index into an array to access core
441*54fd6939SJiyong Park  * specific information. If this not the case, the platform port must provide a
442*54fd6939SJiyong Park  * hash function. Otherwise, the "Processor Number" field will be used to access
443*54fd6939SJiyong Park  * the array elements.
444*54fd6939SJiyong Park  ******************************************************************************/
445*54fd6939SJiyong Park typedef unsigned int (*mpidr_hash_fn)(u_register_t mpidr);
446*54fd6939SJiyong Park 
447*54fd6939SJiyong Park typedef struct gicv3_driver_data {
448*54fd6939SJiyong Park 	uintptr_t gicd_base;
449*54fd6939SJiyong Park 	uintptr_t gicr_base;
450*54fd6939SJiyong Park 	const interrupt_prop_t *interrupt_props;
451*54fd6939SJiyong Park 	unsigned int interrupt_props_num;
452*54fd6939SJiyong Park 	unsigned int rdistif_num;
453*54fd6939SJiyong Park 	uintptr_t *rdistif_base_addrs;
454*54fd6939SJiyong Park 	mpidr_hash_fn mpidr_to_core_pos;
455*54fd6939SJiyong Park } gicv3_driver_data_t;
456*54fd6939SJiyong Park 
457*54fd6939SJiyong Park typedef struct gicv3_redist_ctx {
458*54fd6939SJiyong Park 	/* 64 bits registers */
459*54fd6939SJiyong Park 	uint64_t gicr_propbaser;
460*54fd6939SJiyong Park 	uint64_t gicr_pendbaser;
461*54fd6939SJiyong Park 
462*54fd6939SJiyong Park 	/* 32 bits registers */
463*54fd6939SJiyong Park 	uint32_t gicr_ctlr;
464*54fd6939SJiyong Park 	uint32_t gicr_igroupr[GICR_NUM_REGS(IGROUPR)];
465*54fd6939SJiyong Park 	uint32_t gicr_isenabler[GICR_NUM_REGS(ISENABLER)];
466*54fd6939SJiyong Park 	uint32_t gicr_ispendr[GICR_NUM_REGS(ISPENDR)];
467*54fd6939SJiyong Park 	uint32_t gicr_isactiver[GICR_NUM_REGS(ISACTIVER)];
468*54fd6939SJiyong Park 	uint32_t gicr_ipriorityr[GICR_NUM_REGS(IPRIORITYR)];
469*54fd6939SJiyong Park 	uint32_t gicr_icfgr[GICR_NUM_REGS(ICFGR)];
470*54fd6939SJiyong Park 	uint32_t gicr_igrpmodr[GICR_NUM_REGS(IGRPMODR)];
471*54fd6939SJiyong Park 	uint32_t gicr_nsacr;
472*54fd6939SJiyong Park } gicv3_redist_ctx_t;
473*54fd6939SJiyong Park 
474*54fd6939SJiyong Park typedef struct gicv3_dist_ctx {
475*54fd6939SJiyong Park 	/* 64 bits registers */
476*54fd6939SJiyong Park 	uint64_t gicd_irouter[TOTAL_SHARED_INTR_NUM];
477*54fd6939SJiyong Park 
478*54fd6939SJiyong Park 	/* 32 bits registers */
479*54fd6939SJiyong Park 	uint32_t gicd_ctlr;
480*54fd6939SJiyong Park 	uint32_t gicd_igroupr[GICD_NUM_REGS(IGROUPR)];
481*54fd6939SJiyong Park 	uint32_t gicd_isenabler[GICD_NUM_REGS(ISENABLER)];
482*54fd6939SJiyong Park 	uint32_t gicd_ispendr[GICD_NUM_REGS(ISPENDR)];
483*54fd6939SJiyong Park 	uint32_t gicd_isactiver[GICD_NUM_REGS(ISACTIVER)];
484*54fd6939SJiyong Park 	uint32_t gicd_ipriorityr[GICD_NUM_REGS(IPRIORITYR)];
485*54fd6939SJiyong Park 	uint32_t gicd_icfgr[GICD_NUM_REGS(ICFGR)];
486*54fd6939SJiyong Park 	uint32_t gicd_igrpmodr[GICD_NUM_REGS(IGRPMODR)];
487*54fd6939SJiyong Park 	uint32_t gicd_nsacr[GICD_NUM_REGS(NSACR)];
488*54fd6939SJiyong Park } gicv3_dist_ctx_t;
489*54fd6939SJiyong Park 
490*54fd6939SJiyong Park typedef struct gicv3_its_ctx {
491*54fd6939SJiyong Park 	/* 64 bits registers */
492*54fd6939SJiyong Park 	uint64_t gits_cbaser;
493*54fd6939SJiyong Park 	uint64_t gits_cwriter;
494*54fd6939SJiyong Park 	uint64_t gits_baser[8];
495*54fd6939SJiyong Park 
496*54fd6939SJiyong Park 	/* 32 bits registers */
497*54fd6939SJiyong Park 	uint32_t gits_ctlr;
498*54fd6939SJiyong Park } gicv3_its_ctx_t;
499*54fd6939SJiyong Park 
500*54fd6939SJiyong Park /*******************************************************************************
501*54fd6939SJiyong Park  * GICv3 EL3 driver API
502*54fd6939SJiyong Park  ******************************************************************************/
503*54fd6939SJiyong Park void gicv3_driver_init(const gicv3_driver_data_t *plat_driver_data);
504*54fd6939SJiyong Park int gicv3_rdistif_probe(const uintptr_t gicr_frame);
505*54fd6939SJiyong Park void gicv3_distif_init(void);
506*54fd6939SJiyong Park void gicv3_rdistif_init(unsigned int proc_num);
507*54fd6939SJiyong Park void gicv3_rdistif_on(unsigned int proc_num);
508*54fd6939SJiyong Park void gicv3_rdistif_off(unsigned int proc_num);
509*54fd6939SJiyong Park unsigned int gicv3_rdistif_get_number_frames(const uintptr_t gicr_frame);
510*54fd6939SJiyong Park void gicv3_cpuif_enable(unsigned int proc_num);
511*54fd6939SJiyong Park void gicv3_cpuif_disable(unsigned int proc_num);
512*54fd6939SJiyong Park unsigned int gicv3_get_pending_interrupt_type(void);
513*54fd6939SJiyong Park unsigned int gicv3_get_pending_interrupt_id(void);
514*54fd6939SJiyong Park unsigned int gicv3_get_interrupt_type(unsigned int id,
515*54fd6939SJiyong Park 					  unsigned int proc_num);
516*54fd6939SJiyong Park void gicv3_distif_init_restore(const gicv3_dist_ctx_t * const dist_ctx);
517*54fd6939SJiyong Park void gicv3_distif_save(gicv3_dist_ctx_t * const dist_ctx);
518*54fd6939SJiyong Park /*
519*54fd6939SJiyong Park  * gicv3_distif_post_restore and gicv3_distif_pre_save must be implemented if
520*54fd6939SJiyong Park  * gicv3_distif_save and gicv3_rdistif_init_restore are used. If no
521*54fd6939SJiyong Park  * implementation-defined sequence is needed at these steps, an empty function
522*54fd6939SJiyong Park  * can be provided.
523*54fd6939SJiyong Park  */
524*54fd6939SJiyong Park void gicv3_distif_post_restore(unsigned int proc_num);
525*54fd6939SJiyong Park void gicv3_distif_pre_save(unsigned int proc_num);
526*54fd6939SJiyong Park void gicv3_rdistif_init_restore(unsigned int proc_num, const gicv3_redist_ctx_t * const rdist_ctx);
527*54fd6939SJiyong Park void gicv3_rdistif_save(unsigned int proc_num, gicv3_redist_ctx_t * const rdist_ctx);
528*54fd6939SJiyong Park void gicv3_its_save_disable(uintptr_t gits_base, gicv3_its_ctx_t * const its_ctx);
529*54fd6939SJiyong Park void gicv3_its_restore(uintptr_t gits_base, const gicv3_its_ctx_t * const its_ctx);
530*54fd6939SJiyong Park 
531*54fd6939SJiyong Park unsigned int gicv3_get_running_priority(void);
532*54fd6939SJiyong Park unsigned int gicv3_get_interrupt_active(unsigned int id, unsigned int proc_num);
533*54fd6939SJiyong Park void gicv3_enable_interrupt(unsigned int id, unsigned int proc_num);
534*54fd6939SJiyong Park void gicv3_disable_interrupt(unsigned int id, unsigned int proc_num);
535*54fd6939SJiyong Park void gicv3_set_interrupt_priority(unsigned int id, unsigned int proc_num,
536*54fd6939SJiyong Park 		unsigned int priority);
537*54fd6939SJiyong Park void gicv3_set_interrupt_type(unsigned int id, unsigned int proc_num,
538*54fd6939SJiyong Park 		unsigned int type);
539*54fd6939SJiyong Park void gicv3_raise_secure_g0_sgi(unsigned int sgi_num, u_register_t target);
540*54fd6939SJiyong Park void gicv3_set_spi_routing(unsigned int id, unsigned int irm,
541*54fd6939SJiyong Park 		u_register_t mpidr);
542*54fd6939SJiyong Park void gicv3_set_interrupt_pending(unsigned int id, unsigned int proc_num);
543*54fd6939SJiyong Park void gicv3_clear_interrupt_pending(unsigned int id, unsigned int proc_num);
544*54fd6939SJiyong Park unsigned int gicv3_set_pmr(unsigned int mask);
545*54fd6939SJiyong Park 
546*54fd6939SJiyong Park #endif /* __ASSEMBLER__ */
547*54fd6939SJiyong Park #endif /* GICV3_H */
548