xref: /rk3399_ARM-atf/include/drivers/arm/gicv3.h (revision 79d89e3da078fa0e169a47bcc360c5e3308cdf42)
1df373737SAchin Gupta /*
26e19bd56SAlexei Fedorov  * Copyright (c) 2015-2020, ARM Limited and Contributors. All rights reserved.
3df373737SAchin Gupta  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5df373737SAchin Gupta  */
6df373737SAchin Gupta 
7c3cf06f1SAntonio Nino Diaz #ifndef GICV3_H
8c3cf06f1SAntonio Nino Diaz #define GICV3_H
9df373737SAchin Gupta 
10df373737SAchin Gupta /*******************************************************************************
118f3ad766SAlexei Fedorov  * GICv3 and 3.1 miscellaneous definitions
12df373737SAchin Gupta  ******************************************************************************/
13df373737SAchin Gupta /* Interrupt group definitions */
148782922cSAntonio Nino Diaz #define INTR_GROUP1S		U(0)
158782922cSAntonio Nino Diaz #define INTR_GROUP0		U(1)
168782922cSAntonio Nino Diaz #define INTR_GROUP1NS		U(2)
17df373737SAchin Gupta 
18df373737SAchin Gupta /* Interrupt IDs reported by the HPPIR and IAR registers */
198782922cSAntonio Nino Diaz #define PENDING_G1S_INTID	U(1020)
208782922cSAntonio Nino Diaz #define PENDING_G1NS_INTID	U(1021)
21df373737SAchin Gupta 
22df373737SAchin Gupta /* Constant to categorize LPI interrupt */
238782922cSAntonio Nino Diaz #define MIN_LPI_ID		U(8192)
24df373737SAchin Gupta 
258db978b5SJeenu Viswambharan /* GICv3 can only target up to 16 PEs with SGI */
268782922cSAntonio Nino Diaz #define GICV3_MAX_SGI_TARGETS	U(16)
278db978b5SJeenu Viswambharan 
288f3ad766SAlexei Fedorov /* PPIs INTIDs 16-31 */
298f3ad766SAlexei Fedorov #define MAX_PPI_ID		U(31)
308f3ad766SAlexei Fedorov 
318f3ad766SAlexei Fedorov #if GIC_EXT_INTID
328f3ad766SAlexei Fedorov 
338f3ad766SAlexei Fedorov /* GICv3.1 extended PPIs INTIDs 1056-1119 */
348f3ad766SAlexei Fedorov #define MIN_EPPI_ID		U(1056)
358f3ad766SAlexei Fedorov #define MAX_EPPI_ID		U(1119)
368f3ad766SAlexei Fedorov 
378f3ad766SAlexei Fedorov /* Total number of GICv3.1 EPPIs */
388f3ad766SAlexei Fedorov #define TOTAL_EPPI_INTR_NUM	(MAX_EPPI_ID - MIN_EPPI_ID + U(1))
398f3ad766SAlexei Fedorov 
408f3ad766SAlexei Fedorov /* Total number of GICv3.1 PPIs and EPPIs */
418f3ad766SAlexei Fedorov #define TOTAL_PRIVATE_INTR_NUM	(TOTAL_PCPU_INTR_NUM + TOTAL_EPPI_INTR_NUM)
428f3ad766SAlexei Fedorov 
438f3ad766SAlexei Fedorov /* GICv3.1 extended SPIs INTIDs 4096 - 5119 */
448f3ad766SAlexei Fedorov #define MIN_ESPI_ID		U(4096)
458f3ad766SAlexei Fedorov #define MAX_ESPI_ID		U(5119)
468f3ad766SAlexei Fedorov 
478f3ad766SAlexei Fedorov /* Total number of GICv3.1 ESPIs */
488f3ad766SAlexei Fedorov #define TOTAL_ESPI_INTR_NUM	(MAX_ESPI_ID - MIN_ESPI_ID + U(1))
498f3ad766SAlexei Fedorov 
508f3ad766SAlexei Fedorov /* Total number of GICv3.1 SPIs and ESPIs */
518f3ad766SAlexei Fedorov #define	TOTAL_SHARED_INTR_NUM	(TOTAL_SPI_INTR_NUM + TOTAL_ESPI_INTR_NUM)
528f3ad766SAlexei Fedorov 
538f3ad766SAlexei Fedorov /* SGIs: 0-15, PPIs: 16-31, EPPIs: 1056-1119 */
548f3ad766SAlexei Fedorov #define	IS_SGI_PPI(id)		(((id) <= MAX_PPI_ID)  || \
558f3ad766SAlexei Fedorov 				(((id) >= MIN_EPPI_ID) && \
568f3ad766SAlexei Fedorov 				 ((id) <= MAX_EPPI_ID)))
578f3ad766SAlexei Fedorov 
588f3ad766SAlexei Fedorov /* SPIs: 32-1019, ESPIs: 4096-5119 */
598f3ad766SAlexei Fedorov #define	IS_SPI(id)		((((id) >= MIN_SPI_ID)  && \
608f3ad766SAlexei Fedorov 				  ((id) <= MAX_SPI_ID)) || \
618f3ad766SAlexei Fedorov 				 (((id) >= MIN_ESPI_ID) && \
628f3ad766SAlexei Fedorov 				  ((id) <= MAX_ESPI_ID)))
638f3ad766SAlexei Fedorov #else	/* GICv3 */
648f3ad766SAlexei Fedorov 
658f3ad766SAlexei Fedorov /* Total number of GICv3 PPIs */
668f3ad766SAlexei Fedorov #define TOTAL_PRIVATE_INTR_NUM	TOTAL_PCPU_INTR_NUM
678f3ad766SAlexei Fedorov 
688f3ad766SAlexei Fedorov /* Total number of GICv3 SPIs */
698f3ad766SAlexei Fedorov #define	TOTAL_SHARED_INTR_NUM	TOTAL_SPI_INTR_NUM
708f3ad766SAlexei Fedorov 
718f3ad766SAlexei Fedorov /* SGIs: 0-15, PPIs: 16-31 */
728f3ad766SAlexei Fedorov #define	IS_SGI_PPI(id)		((id) <= MAX_PPI_ID)
738f3ad766SAlexei Fedorov 
748f3ad766SAlexei Fedorov /* SPIs: 32-1019 */
758f3ad766SAlexei Fedorov #define	IS_SPI(id)		(((id) >= MIN_SPI_ID) && ((id) <= MAX_SPI_ID))
768f3ad766SAlexei Fedorov 
778f3ad766SAlexei Fedorov #endif	/* GIC_EXT_INTID */
788f3ad766SAlexei Fedorov 
79df373737SAchin Gupta /*******************************************************************************
808f3ad766SAlexei Fedorov  * GICv3 and 3.1 specific Distributor interface register offsets and constants
81df373737SAchin Gupta  ******************************************************************************/
828f3ad766SAlexei Fedorov #define GICD_TYPER2		U(0x0c)
838782922cSAntonio Nino Diaz #define GICD_STATUSR		U(0x10)
848782922cSAntonio Nino Diaz #define GICD_SETSPI_NSR		U(0x40)
858782922cSAntonio Nino Diaz #define GICD_CLRSPI_NSR		U(0x48)
868782922cSAntonio Nino Diaz #define GICD_SETSPI_SR		U(0x50)
876e19bd56SAlexei Fedorov #define GICD_CLRSPI_SR		U(0x58)
888782922cSAntonio Nino Diaz #define GICD_IGRPMODR		U(0xd00)
898f3ad766SAlexei Fedorov #define GICD_IGROUPRE		U(0x1000)
908f3ad766SAlexei Fedorov #define GICD_ISENABLERE		U(0x1200)
918f3ad766SAlexei Fedorov #define GICD_ICENABLERE		U(0x1400)
928f3ad766SAlexei Fedorov #define GICD_ISPENDRE		U(0x1600)
938f3ad766SAlexei Fedorov #define GICD_ICPENDRE		U(0x1800)
948f3ad766SAlexei Fedorov #define GICD_ISACTIVERE		U(0x1a00)
958f3ad766SAlexei Fedorov #define GICD_ICACTIVERE		U(0x1c00)
968f3ad766SAlexei Fedorov #define GICD_IPRIORITYRE	U(0x2000)
978f3ad766SAlexei Fedorov #define GICD_ICFGRE		U(0x3000)
988f3ad766SAlexei Fedorov #define GICD_IGRPMODRE		U(0x3400)
998f3ad766SAlexei Fedorov #define GICD_NSACRE		U(0x3600)
10061e30277SSoby Mathew /*
1018f3ad766SAlexei Fedorov  * GICD_IROUTER<n> register is at 0x6000 + 8n, where n is the interrupt ID
1028f3ad766SAlexei Fedorov  * and n >= 32, making the effective offset as 0x6100
10361e30277SSoby Mathew  */
1048782922cSAntonio Nino Diaz #define GICD_IROUTER		U(0x6000)
1058f3ad766SAlexei Fedorov #define GICD_IROUTERE		U(0x8000)
1068f3ad766SAlexei Fedorov 
1078782922cSAntonio Nino Diaz #define GICD_PIDR2_GICV3	U(0xffe8)
108df373737SAchin Gupta 
109df373737SAchin Gupta #define IGRPMODR_SHIFT		5
110df373737SAchin Gupta 
111df373737SAchin Gupta /* GICD_CTLR bit definitions */
112df373737SAchin Gupta #define CTLR_ENABLE_G1NS_SHIFT		1
113df373737SAchin Gupta #define CTLR_ENABLE_G1S_SHIFT		2
114df373737SAchin Gupta #define CTLR_ARE_S_SHIFT		4
115df373737SAchin Gupta #define CTLR_ARE_NS_SHIFT		5
116df373737SAchin Gupta #define CTLR_DS_SHIFT			6
117df373737SAchin Gupta #define CTLR_E1NWF_SHIFT		7
118df373737SAchin Gupta #define GICD_CTLR_RWP_SHIFT		31
119df373737SAchin Gupta 
1208782922cSAntonio Nino Diaz #define CTLR_ENABLE_G1NS_MASK		U(0x1)
1218782922cSAntonio Nino Diaz #define CTLR_ENABLE_G1S_MASK		U(0x1)
1228782922cSAntonio Nino Diaz #define CTLR_ARE_S_MASK			U(0x1)
1238782922cSAntonio Nino Diaz #define CTLR_ARE_NS_MASK		U(0x1)
1248782922cSAntonio Nino Diaz #define CTLR_DS_MASK			U(0x1)
1258782922cSAntonio Nino Diaz #define CTLR_E1NWF_MASK			U(0x1)
1268782922cSAntonio Nino Diaz #define GICD_CTLR_RWP_MASK		U(0x1)
127df373737SAchin Gupta 
1288782922cSAntonio Nino Diaz #define CTLR_ENABLE_G1NS_BIT		BIT_32(CTLR_ENABLE_G1NS_SHIFT)
1298782922cSAntonio Nino Diaz #define CTLR_ENABLE_G1S_BIT		BIT_32(CTLR_ENABLE_G1S_SHIFT)
1308782922cSAntonio Nino Diaz #define CTLR_ARE_S_BIT			BIT_32(CTLR_ARE_S_SHIFT)
1318782922cSAntonio Nino Diaz #define CTLR_ARE_NS_BIT			BIT_32(CTLR_ARE_NS_SHIFT)
1328782922cSAntonio Nino Diaz #define CTLR_DS_BIT			BIT_32(CTLR_DS_SHIFT)
1338782922cSAntonio Nino Diaz #define CTLR_E1NWF_BIT			BIT_32(CTLR_E1NWF_SHIFT)
1348782922cSAntonio Nino Diaz #define GICD_CTLR_RWP_BIT		BIT_32(GICD_CTLR_RWP_SHIFT)
135df373737SAchin Gupta 
136df373737SAchin Gupta /* GICD_IROUTER shifts and masks */
137ebf1ca10SSoby Mathew #define IROUTER_SHIFT		0
138df373737SAchin Gupta #define IROUTER_IRM_SHIFT	31
1398782922cSAntonio Nino Diaz #define IROUTER_IRM_MASK	U(0x1)
140df373737SAchin Gupta 
1418782922cSAntonio Nino Diaz #define GICV3_IRM_PE		U(0)
1428782922cSAntonio Nino Diaz #define GICV3_IRM_ANY		U(1)
143fc529feeSJeenu Viswambharan 
144ebf1ca10SSoby Mathew #define NUM_OF_DIST_REGS	30
145ebf1ca10SSoby Mathew 
1468f3ad766SAlexei Fedorov /* GICD_TYPER shifts and masks */
1478f3ad766SAlexei Fedorov #define	TYPER_ESPI		U(1 << 8)
1488f3ad766SAlexei Fedorov #define	TYPER_DVIS		U(1 << 18)
1498f3ad766SAlexei Fedorov #define	TYPER_ESPI_RANGE_MASK	U(0x1f)
1508f3ad766SAlexei Fedorov #define	TYPER_ESPI_RANGE_SHIFT	U(27)
1518f3ad766SAlexei Fedorov #define	TYPER_ESPI_RANGE	U(TYPER_ESPI_MASK << TYPER_ESPI_SHIFT)
1528f3ad766SAlexei Fedorov 
153df373737SAchin Gupta /*******************************************************************************
1545875f266SAlexei Fedorov  * Common GIC Redistributor interface registers & constants
155df373737SAchin Gupta  ******************************************************************************/
1565875f266SAlexei Fedorov #if GIC_ENABLE_V4_EXTN
1575875f266SAlexei Fedorov #define GICR_PCPUBASE_SHIFT	0x12
1585875f266SAlexei Fedorov #else
159df373737SAchin Gupta #define GICR_PCPUBASE_SHIFT	0x11
1605875f266SAlexei Fedorov #endif
1618782922cSAntonio Nino Diaz #define GICR_SGIBASE_OFFSET	U(65536)	/* 64 KB */
1628782922cSAntonio Nino Diaz #define GICR_CTLR		U(0x0)
163b5443284SAndrew F. Davis #define GICR_IIDR		U(0x04)
1648782922cSAntonio Nino Diaz #define GICR_TYPER		U(0x08)
1658f3ad766SAlexei Fedorov #define GICR_STATUSR		U(0x10)
1668782922cSAntonio Nino Diaz #define GICR_WAKER		U(0x14)
1678782922cSAntonio Nino Diaz #define GICR_PROPBASER		U(0x70)
1688782922cSAntonio Nino Diaz #define GICR_PENDBASER		U(0x78)
1698782922cSAntonio Nino Diaz #define GICR_IGROUPR0		(GICR_SGIBASE_OFFSET + U(0x80))
1708782922cSAntonio Nino Diaz #define GICR_ISENABLER0		(GICR_SGIBASE_OFFSET + U(0x100))
1718782922cSAntonio Nino Diaz #define GICR_ICENABLER0		(GICR_SGIBASE_OFFSET + U(0x180))
1728782922cSAntonio Nino Diaz #define GICR_ISPENDR0		(GICR_SGIBASE_OFFSET + U(0x200))
1738782922cSAntonio Nino Diaz #define GICR_ICPENDR0		(GICR_SGIBASE_OFFSET + U(0x280))
1748782922cSAntonio Nino Diaz #define GICR_ISACTIVER0		(GICR_SGIBASE_OFFSET + U(0x300))
1758782922cSAntonio Nino Diaz #define GICR_ICACTIVER0		(GICR_SGIBASE_OFFSET + U(0x380))
1768782922cSAntonio Nino Diaz #define GICR_IPRIORITYR		(GICR_SGIBASE_OFFSET + U(0x400))
1778782922cSAntonio Nino Diaz #define GICR_ICFGR0		(GICR_SGIBASE_OFFSET + U(0xc00))
1788782922cSAntonio Nino Diaz #define GICR_ICFGR1		(GICR_SGIBASE_OFFSET + U(0xc04))
1798782922cSAntonio Nino Diaz #define GICR_IGRPMODR0		(GICR_SGIBASE_OFFSET + U(0xd00))
1808782922cSAntonio Nino Diaz #define GICR_NSACR		(GICR_SGIBASE_OFFSET + U(0xe00))
181df373737SAchin Gupta 
1828f3ad766SAlexei Fedorov #define GICR_IGROUPR		GICR_IGROUPR0
1838f3ad766SAlexei Fedorov #define GICR_ISENABLER		GICR_ISENABLER0
1848f3ad766SAlexei Fedorov #define GICR_ICENABLER		GICR_ICENABLER0
1858f3ad766SAlexei Fedorov #define GICR_ISPENDR		GICR_ISPENDR0
1868f3ad766SAlexei Fedorov #define GICR_ICPENDR		GICR_ICPENDR0
1878f3ad766SAlexei Fedorov #define GICR_ISACTIVER		GICR_ISACTIVER0
1888f3ad766SAlexei Fedorov #define GICR_ICACTIVER		GICR_ICACTIVER0
1898f3ad766SAlexei Fedorov #define GICR_ICFGR		GICR_ICFGR0
1908f3ad766SAlexei Fedorov #define GICR_IGRPMODR		GICR_IGRPMODR0
1918f3ad766SAlexei Fedorov 
192df373737SAchin Gupta /* GICR_CTLR bit definitions */
193ebf1ca10SSoby Mathew #define GICR_CTLR_UWP_SHIFT	31
1948782922cSAntonio Nino Diaz #define GICR_CTLR_UWP_MASK	U(0x1)
1958782922cSAntonio Nino Diaz #define GICR_CTLR_UWP_BIT	BIT_32(GICR_CTLR_UWP_SHIFT)
196df373737SAchin Gupta #define GICR_CTLR_RWP_SHIFT	3
1978782922cSAntonio Nino Diaz #define GICR_CTLR_RWP_MASK	U(0x1)
1988782922cSAntonio Nino Diaz #define GICR_CTLR_RWP_BIT	BIT_32(GICR_CTLR_RWP_SHIFT)
1998782922cSAntonio Nino Diaz #define GICR_CTLR_EN_LPIS_BIT	BIT_32(0)
200df373737SAchin Gupta 
201df373737SAchin Gupta /* GICR_WAKER bit definitions */
202df373737SAchin Gupta #define WAKER_CA_SHIFT		2
203df373737SAchin Gupta #define WAKER_PS_SHIFT		1
204df373737SAchin Gupta 
2058782922cSAntonio Nino Diaz #define WAKER_CA_MASK		U(0x1)
2068782922cSAntonio Nino Diaz #define WAKER_PS_MASK		U(0x1)
207df373737SAchin Gupta 
2088782922cSAntonio Nino Diaz #define WAKER_CA_BIT		BIT_32(WAKER_CA_SHIFT)
2098782922cSAntonio Nino Diaz #define WAKER_PS_BIT		BIT_32(WAKER_PS_SHIFT)
210df373737SAchin Gupta 
211df373737SAchin Gupta /* GICR_TYPER bit definitions */
212df373737SAchin Gupta #define TYPER_AFF_VAL_SHIFT	32
213df373737SAchin Gupta #define TYPER_PROC_NUM_SHIFT	8
214df373737SAchin Gupta #define TYPER_LAST_SHIFT	4
215df373737SAchin Gupta 
2168782922cSAntonio Nino Diaz #define TYPER_AFF_VAL_MASK	U(0xffffffff)
2178782922cSAntonio Nino Diaz #define TYPER_PROC_NUM_MASK	U(0xffff)
2188782922cSAntonio Nino Diaz #define TYPER_LAST_MASK		U(0x1)
219df373737SAchin Gupta 
2208782922cSAntonio Nino Diaz #define TYPER_LAST_BIT		BIT_32(TYPER_LAST_SHIFT)
221df373737SAchin Gupta 
2228f3ad766SAlexei Fedorov #define TYPER_PPI_NUM_SHIFT	U(27)
2238f3ad766SAlexei Fedorov #define TYPER_PPI_NUM_MASK	U(0x1f)
224ebf1ca10SSoby Mathew 
225b4ad365aSAndre Przywara /* GICR_IIDR bit definitions */
226b29c350cSAlexei Fedorov #define IIDR_PRODUCT_ID_MASK	U(0xff000000)
227b29c350cSAlexei Fedorov #define IIDR_VARIANT_MASK	U(0x000f0000)
228b29c350cSAlexei Fedorov #define IIDR_REVISION_MASK	U(0x0000f000)
229b29c350cSAlexei Fedorov #define IIDR_IMPLEMENTER_MASK	U(0x00000fff)
230b4ad365aSAndre Przywara #define IIDR_MODEL_MASK		(IIDR_PRODUCT_ID_MASK | \
231b4ad365aSAndre Przywara 				 IIDR_IMPLEMENTER_MASK)
232b4ad365aSAndre Przywara 
233df373737SAchin Gupta /*******************************************************************************
2348f3ad766SAlexei Fedorov  * GICv3 and 3.1 CPU interface registers & constants
235df373737SAchin Gupta  ******************************************************************************/
236df373737SAchin Gupta /* ICC_SRE bit definitions */
2378782922cSAntonio Nino Diaz #define ICC_SRE_EN_BIT		BIT_32(3)
2388782922cSAntonio Nino Diaz #define ICC_SRE_DIB_BIT		BIT_32(2)
2398782922cSAntonio Nino Diaz #define ICC_SRE_DFB_BIT		BIT_32(1)
2408782922cSAntonio Nino Diaz #define ICC_SRE_SRE_BIT		BIT_32(0)
241df373737SAchin Gupta 
242df373737SAchin Gupta /* ICC_IGRPEN1_EL3 bit definitions */
243df373737SAchin Gupta #define IGRPEN1_EL3_ENABLE_G1NS_SHIFT	0
244df373737SAchin Gupta #define IGRPEN1_EL3_ENABLE_G1S_SHIFT	1
245df373737SAchin Gupta 
2468782922cSAntonio Nino Diaz #define IGRPEN1_EL3_ENABLE_G1NS_BIT	BIT_32(IGRPEN1_EL3_ENABLE_G1NS_SHIFT)
2478782922cSAntonio Nino Diaz #define IGRPEN1_EL3_ENABLE_G1S_BIT	BIT_32(IGRPEN1_EL3_ENABLE_G1S_SHIFT)
248df373737SAchin Gupta 
249df373737SAchin Gupta /* ICC_IGRPEN0_EL1 bit definitions */
250df373737SAchin Gupta #define IGRPEN1_EL1_ENABLE_G0_SHIFT	0
2518782922cSAntonio Nino Diaz #define IGRPEN1_EL1_ENABLE_G0_BIT	BIT_32(IGRPEN1_EL1_ENABLE_G0_SHIFT)
252df373737SAchin Gupta 
253df373737SAchin Gupta /* ICC_HPPIR0_EL1 bit definitions */
254df373737SAchin Gupta #define HPPIR0_EL1_INTID_SHIFT		0
2558782922cSAntonio Nino Diaz #define HPPIR0_EL1_INTID_MASK		U(0xffffff)
256df373737SAchin Gupta 
257df373737SAchin Gupta /* ICC_HPPIR1_EL1 bit definitions */
258df373737SAchin Gupta #define HPPIR1_EL1_INTID_SHIFT		0
2598782922cSAntonio Nino Diaz #define HPPIR1_EL1_INTID_MASK		U(0xffffff)
260df373737SAchin Gupta 
261df373737SAchin Gupta /* ICC_IAR0_EL1 bit definitions */
262df373737SAchin Gupta #define IAR0_EL1_INTID_SHIFT		0
2638782922cSAntonio Nino Diaz #define IAR0_EL1_INTID_MASK		U(0xffffff)
264df373737SAchin Gupta 
265df373737SAchin Gupta /* ICC_IAR1_EL1 bit definitions */
266df373737SAchin Gupta #define IAR1_EL1_INTID_SHIFT		0
2678782922cSAntonio Nino Diaz #define IAR1_EL1_INTID_MASK		U(0xffffff)
268df373737SAchin Gupta 
2698db978b5SJeenu Viswambharan /* ICC SGI macros */
2708782922cSAntonio Nino Diaz #define SGIR_TGT_MASK			ULL(0xffff)
2718db978b5SJeenu Viswambharan #define SGIR_AFF1_SHIFT			16
2728db978b5SJeenu Viswambharan #define SGIR_INTID_SHIFT		24
2738782922cSAntonio Nino Diaz #define SGIR_INTID_MASK			ULL(0xf)
2748db978b5SJeenu Viswambharan #define SGIR_AFF2_SHIFT			32
2758db978b5SJeenu Viswambharan #define SGIR_IRM_SHIFT			40
2768782922cSAntonio Nino Diaz #define SGIR_IRM_MASK			ULL(0x1)
2778db978b5SJeenu Viswambharan #define SGIR_AFF3_SHIFT			48
2788782922cSAntonio Nino Diaz #define SGIR_AFF_MASK			ULL(0xf)
2798db978b5SJeenu Viswambharan 
2808782922cSAntonio Nino Diaz #define SGIR_IRM_TO_AFF			U(0)
2818db978b5SJeenu Viswambharan 
2828782922cSAntonio Nino Diaz #define GICV3_SGIR_VALUE(_aff3, _aff2, _aff1, _intid, _irm, _tgt)	\
2838782922cSAntonio Nino Diaz 	((((uint64_t) (_aff3) & SGIR_AFF_MASK) << SGIR_AFF3_SHIFT) |	\
2848782922cSAntonio Nino Diaz 	 (((uint64_t) (_irm) & SGIR_IRM_MASK) << SGIR_IRM_SHIFT) |	\
2858782922cSAntonio Nino Diaz 	 (((uint64_t) (_aff2) & SGIR_AFF_MASK) << SGIR_AFF2_SHIFT) |	\
2868782922cSAntonio Nino Diaz 	 (((_intid) & SGIR_INTID_MASK) << SGIR_INTID_SHIFT) |		\
2878782922cSAntonio Nino Diaz 	 (((_aff1) & SGIR_AFF_MASK) << SGIR_AFF1_SHIFT) |		\
2888782922cSAntonio Nino Diaz 	 ((_tgt) & SGIR_TGT_MASK))
2898db978b5SJeenu Viswambharan 
290b258278eSSoby Mathew /*****************************************************************************
2918f3ad766SAlexei Fedorov  * GICv3 and 3.1 ITS registers and constants
292b258278eSSoby Mathew  *****************************************************************************/
2938782922cSAntonio Nino Diaz #define GITS_CTLR			U(0x0)
2948782922cSAntonio Nino Diaz #define GITS_IIDR			U(0x4)
2958782922cSAntonio Nino Diaz #define GITS_TYPER			U(0x8)
2968782922cSAntonio Nino Diaz #define GITS_CBASER			U(0x80)
2978782922cSAntonio Nino Diaz #define GITS_CWRITER			U(0x88)
2988782922cSAntonio Nino Diaz #define GITS_CREADR			U(0x90)
2998782922cSAntonio Nino Diaz #define GITS_BASER			U(0x100)
300b258278eSSoby Mathew 
301b258278eSSoby Mathew /* GITS_CTLR bit definitions */
3028782922cSAntonio Nino Diaz #define GITS_CTLR_ENABLED_BIT		BIT_32(0)
3038f3ad766SAlexei Fedorov #define GITS_CTLR_QUIESCENT_BIT		BIT_32(1)
304b258278eSSoby Mathew 
305d5dfdeb6SJulius Werner #ifndef __ASSEMBLER__
306df373737SAchin Gupta 
307b9f68dfbSAntonio Nino Diaz #include <stdbool.h>
308df373737SAchin Gupta #include <stdint.h>
30909d40e0eSAntonio Nino Diaz 
31009d40e0eSAntonio Nino Diaz #include <arch_helpers.h>
31109d40e0eSAntonio Nino Diaz #include <common/interrupt_props.h>
31209d40e0eSAntonio Nino Diaz #include <drivers/arm/gic_common.h>
31309d40e0eSAntonio Nino Diaz #include <lib/utils_def.h>
314df373737SAchin Gupta 
315b9f68dfbSAntonio Nino Diaz static inline bool gicv3_is_intr_id_special_identifier(unsigned int id)
316b9f68dfbSAntonio Nino Diaz {
317b9f68dfbSAntonio Nino Diaz 	return (id >= PENDING_G1S_INTID) && (id <= GIC_SPURIOUS_INTERRUPT);
318b9f68dfbSAntonio Nino Diaz }
319df373737SAchin Gupta 
320df373737SAchin Gupta /*******************************************************************************
3218f3ad766SAlexei Fedorov  * Helper GICv3 and 3.1 macros for SEL1
322df373737SAchin Gupta  ******************************************************************************/
323b9f68dfbSAntonio Nino Diaz static inline uint32_t gicv3_acknowledge_interrupt_sel1(void)
324b9f68dfbSAntonio Nino Diaz {
325b9f68dfbSAntonio Nino Diaz 	return (uint32_t)read_icc_iar1_el1() & IAR1_EL1_INTID_MASK;
326b9f68dfbSAntonio Nino Diaz }
327df373737SAchin Gupta 
328b9f68dfbSAntonio Nino Diaz static inline uint32_t gicv3_get_pending_interrupt_id_sel1(void)
329b9f68dfbSAntonio Nino Diaz {
330b9f68dfbSAntonio Nino Diaz 	return (uint32_t)read_icc_hppir1_el1() & HPPIR1_EL1_INTID_MASK;
331b9f68dfbSAntonio Nino Diaz }
332b9f68dfbSAntonio Nino Diaz 
333b9f68dfbSAntonio Nino Diaz static inline void gicv3_end_of_interrupt_sel1(unsigned int id)
334b9f68dfbSAntonio Nino Diaz {
3355eb16c47SSandeep Tripathy 	/*
3365eb16c47SSandeep Tripathy 	 * Interrupt request deassertion from peripheral to GIC happens
3375eb16c47SSandeep Tripathy 	 * by clearing interrupt condition by a write to the peripheral
3385eb16c47SSandeep Tripathy 	 * register. It is desired that the write transfer is complete
3395eb16c47SSandeep Tripathy 	 * before the core tries to change GIC state from 'AP/Active' to
3405eb16c47SSandeep Tripathy 	 * a new state on seeing 'EOI write'.
3415eb16c47SSandeep Tripathy 	 * Since ICC interface writes are not ordered against Device
3425eb16c47SSandeep Tripathy 	 * memory writes, a barrier is required to ensure the ordering.
3435eb16c47SSandeep Tripathy 	 * The dsb will also ensure *completion* of previous writes with
3445eb16c47SSandeep Tripathy 	 * DEVICE nGnRnE attribute.
3455eb16c47SSandeep Tripathy 	 */
3465eb16c47SSandeep Tripathy 	dsbishst();
347b9f68dfbSAntonio Nino Diaz 	write_icc_eoir1_el1(id);
348b9f68dfbSAntonio Nino Diaz }
349df373737SAchin Gupta 
350df373737SAchin Gupta /*******************************************************************************
351df373737SAchin Gupta  * Helper GICv3 macros for EL3
352df373737SAchin Gupta  ******************************************************************************/
353b9f68dfbSAntonio Nino Diaz static inline uint32_t gicv3_acknowledge_interrupt(void)
354b9f68dfbSAntonio Nino Diaz {
355b9f68dfbSAntonio Nino Diaz 	return (uint32_t)read_icc_iar0_el1() & IAR0_EL1_INTID_MASK;
356b9f68dfbSAntonio Nino Diaz }
357b9f68dfbSAntonio Nino Diaz 
358b9f68dfbSAntonio Nino Diaz static inline void gicv3_end_of_interrupt(unsigned int id)
359b9f68dfbSAntonio Nino Diaz {
3605eb16c47SSandeep Tripathy 	/*
3615eb16c47SSandeep Tripathy 	 * Interrupt request deassertion from peripheral to GIC happens
3625eb16c47SSandeep Tripathy 	 * by clearing interrupt condition by a write to the peripheral
3635eb16c47SSandeep Tripathy 	 * register. It is desired that the write transfer is complete
3645eb16c47SSandeep Tripathy 	 * before the core tries to change GIC state from 'AP/Active' to
3655eb16c47SSandeep Tripathy 	 * a new state on seeing 'EOI write'.
3665eb16c47SSandeep Tripathy 	 * Since ICC interface writes are not ordered against Device
3675eb16c47SSandeep Tripathy 	 * memory writes, a barrier is required to ensure the ordering.
3685eb16c47SSandeep Tripathy 	 * The dsb will also ensure *completion* of previous writes with
3695eb16c47SSandeep Tripathy 	 * DEVICE nGnRnE attribute.
3705eb16c47SSandeep Tripathy 	 */
3715eb16c47SSandeep Tripathy 	dsbishst();
372b9f68dfbSAntonio Nino Diaz 	return write_icc_eoir0_el1(id);
373b9f68dfbSAntonio Nino Diaz }
374df373737SAchin Gupta 
375ebf1ca10SSoby Mathew /*
3768f3ad766SAlexei Fedorov  * This macro returns the total number of GICD/GICR registers corresponding to
3778f3ad766SAlexei Fedorov  * the register name
378ebf1ca10SSoby Mathew  */
379ebf1ca10SSoby Mathew #define GICD_NUM_REGS(reg_name)	\
3808f3ad766SAlexei Fedorov 	DIV_ROUND_UP_2EVAL(TOTAL_SHARED_INTR_NUM, (1 << reg_name##_SHIFT))
381ebf1ca10SSoby Mathew 
382ebf1ca10SSoby Mathew #define GICR_NUM_REGS(reg_name)	\
3838f3ad766SAlexei Fedorov 	DIV_ROUND_UP_2EVAL(TOTAL_PRIVATE_INTR_NUM, (1 << reg_name##_SHIFT))
384ebf1ca10SSoby Mathew 
3854ee8d0beSJeenu Viswambharan /* Interrupt ID mask for HPPIR, AHPPIR, IAR and AIAR CPU Interface registers */
3868782922cSAntonio Nino Diaz #define INT_ID_MASK	U(0xffffff)
3874ee8d0beSJeenu Viswambharan 
388df373737SAchin Gupta /*******************************************************************************
389df373737SAchin Gupta  * This structure describes some of the implementation defined attributes of the
390df373737SAchin Gupta  * GICv3 IP. It is used by the platform port to specify these attributes in order
391df373737SAchin Gupta  * to initialise the GICV3 driver. The attributes are described below.
392df373737SAchin Gupta  *
393c639e8ebSJeenu Viswambharan  * The 'gicd_base' field contains the base address of the Distributor interface
394c639e8ebSJeenu Viswambharan  * programmer's view.
395c639e8ebSJeenu Viswambharan  *
396c639e8ebSJeenu Viswambharan  * The 'gicr_base' field contains the base address of the Re-distributor
397df373737SAchin Gupta  * interface programmer's view.
398df373737SAchin Gupta  *
399c639e8ebSJeenu Viswambharan  * The 'interrupt_props' field is a pointer to an array that enumerates secure
400c639e8ebSJeenu Viswambharan  * interrupts and their properties. If this field is not NULL, both
401c639e8ebSJeenu Viswambharan  * 'g0_interrupt_array' and 'g1s_interrupt_array' fields are ignored.
402df373737SAchin Gupta  *
403c639e8ebSJeenu Viswambharan  * The 'interrupt_props_num' field contains the number of entries in the
404c639e8ebSJeenu Viswambharan  * 'interrupt_props' array. If this field is non-zero, both 'g0_interrupt_num'
405c639e8ebSJeenu Viswambharan  * and 'g1s_interrupt_num' are ignored.
406c639e8ebSJeenu Viswambharan  *
407c639e8ebSJeenu Viswambharan  * The 'rdistif_num' field contains the number of Redistributor interfaces the
408c639e8ebSJeenu Viswambharan  * GIC implements. This is equal to the number of CPUs or CPU interfaces
409df373737SAchin Gupta  * instantiated in the GIC.
410df373737SAchin Gupta  *
411c639e8ebSJeenu Viswambharan  * The 'rdistif_base_addrs' field is a pointer to an array that has an entry for
412c639e8ebSJeenu Viswambharan  * storing the base address of the Redistributor interface frame of each CPU in
413c639e8ebSJeenu Viswambharan  * the system. The size of the array = 'rdistif_num'. The base addresses are
414c639e8ebSJeenu Viswambharan  * detected during driver initialisation.
415df373737SAchin Gupta  *
416c639e8ebSJeenu Viswambharan  * The 'mpidr_to_core_pos' field is a pointer to a hash function which the
417c639e8ebSJeenu Viswambharan  * driver will use to convert an MPIDR value to a linear core index. This index
418c639e8ebSJeenu Viswambharan  * will be used for accessing the 'rdistif_base_addrs' array. This is an
419c639e8ebSJeenu Viswambharan  * optional field. A GICv3 implementation maps each MPIDR to a linear core index
420c639e8ebSJeenu Viswambharan  * as well. This mapping can be found by reading the "Affinity Value" and
421c639e8ebSJeenu Viswambharan  * "Processor Number" fields in the GICR_TYPER. It is IMP. DEF. if the
422df373737SAchin Gupta  * "Processor Numbers" are suitable to index into an array to access core
423c639e8ebSJeenu Viswambharan  * specific information. If this not the case, the platform port must provide a
424c639e8ebSJeenu Viswambharan  * hash function. Otherwise, the "Processor Number" field will be used to access
425c639e8ebSJeenu Viswambharan  * the array elements.
426df373737SAchin Gupta  ******************************************************************************/
4274c0d0390SSoby Mathew typedef unsigned int (*mpidr_hash_fn)(u_register_t mpidr);
428df373737SAchin Gupta 
429df373737SAchin Gupta typedef struct gicv3_driver_data {
430df373737SAchin Gupta 	uintptr_t gicd_base;
431df373737SAchin Gupta 	uintptr_t gicr_base;
432c639e8ebSJeenu Viswambharan 	const interrupt_prop_t *interrupt_props;
433c639e8ebSJeenu Viswambharan 	unsigned int interrupt_props_num;
434df373737SAchin Gupta 	unsigned int rdistif_num;
435df373737SAchin Gupta 	uintptr_t *rdistif_base_addrs;
436df373737SAchin Gupta 	mpidr_hash_fn mpidr_to_core_pos;
437df373737SAchin Gupta } gicv3_driver_data_t;
438df373737SAchin Gupta 
439ebf1ca10SSoby Mathew typedef struct gicv3_redist_ctx {
440ebf1ca10SSoby Mathew 	/* 64 bits registers */
441ebf1ca10SSoby Mathew 	uint64_t gicr_propbaser;
442ebf1ca10SSoby Mathew 	uint64_t gicr_pendbaser;
443ebf1ca10SSoby Mathew 
444ebf1ca10SSoby Mathew 	/* 32 bits registers */
445ebf1ca10SSoby Mathew 	uint32_t gicr_ctlr;
4468f3ad766SAlexei Fedorov 	uint32_t gicr_igroupr[GICR_NUM_REGS(IGROUPR)];
4478f3ad766SAlexei Fedorov 	uint32_t gicr_isenabler[GICR_NUM_REGS(ISENABLER)];
4488f3ad766SAlexei Fedorov 	uint32_t gicr_ispendr[GICR_NUM_REGS(ISPENDR)];
4498f3ad766SAlexei Fedorov 	uint32_t gicr_isactiver[GICR_NUM_REGS(ISACTIVER)];
450ebf1ca10SSoby Mathew 	uint32_t gicr_ipriorityr[GICR_NUM_REGS(IPRIORITYR)];
4518f3ad766SAlexei Fedorov 	uint32_t gicr_icfgr[GICR_NUM_REGS(ICFGR)];
4528f3ad766SAlexei Fedorov 	uint32_t gicr_igrpmodr[GICR_NUM_REGS(IGRPMODR)];
453ebf1ca10SSoby Mathew 	uint32_t gicr_nsacr;
454ebf1ca10SSoby Mathew } gicv3_redist_ctx_t;
455ebf1ca10SSoby Mathew 
456ebf1ca10SSoby Mathew typedef struct gicv3_dist_ctx {
457ebf1ca10SSoby Mathew 	/* 64 bits registers */
4588f3ad766SAlexei Fedorov 	uint64_t gicd_irouter[TOTAL_SHARED_INTR_NUM];
459ebf1ca10SSoby Mathew 
460ebf1ca10SSoby Mathew 	/* 32 bits registers */
461ebf1ca10SSoby Mathew 	uint32_t gicd_ctlr;
462ebf1ca10SSoby Mathew 	uint32_t gicd_igroupr[GICD_NUM_REGS(IGROUPR)];
463ebf1ca10SSoby Mathew 	uint32_t gicd_isenabler[GICD_NUM_REGS(ISENABLER)];
464ebf1ca10SSoby Mathew 	uint32_t gicd_ispendr[GICD_NUM_REGS(ISPENDR)];
465ebf1ca10SSoby Mathew 	uint32_t gicd_isactiver[GICD_NUM_REGS(ISACTIVER)];
466ebf1ca10SSoby Mathew 	uint32_t gicd_ipriorityr[GICD_NUM_REGS(IPRIORITYR)];
467ebf1ca10SSoby Mathew 	uint32_t gicd_icfgr[GICD_NUM_REGS(ICFGR)];
468ebf1ca10SSoby Mathew 	uint32_t gicd_igrpmodr[GICD_NUM_REGS(IGRPMODR)];
469ebf1ca10SSoby Mathew 	uint32_t gicd_nsacr[GICD_NUM_REGS(NSACR)];
470ebf1ca10SSoby Mathew } gicv3_dist_ctx_t;
471ebf1ca10SSoby Mathew 
472b258278eSSoby Mathew typedef struct gicv3_its_ctx {
473b258278eSSoby Mathew 	/* 64 bits registers */
474b258278eSSoby Mathew 	uint64_t gits_cbaser;
475b258278eSSoby Mathew 	uint64_t gits_cwriter;
476b258278eSSoby Mathew 	uint64_t gits_baser[8];
477b258278eSSoby Mathew 
478b258278eSSoby Mathew 	/* 32 bits registers */
479b258278eSSoby Mathew 	uint32_t gits_ctlr;
480b258278eSSoby Mathew } gicv3_its_ctx_t;
481b258278eSSoby Mathew 
482df373737SAchin Gupta /*******************************************************************************
483df373737SAchin Gupta  * GICv3 EL3 driver API
484df373737SAchin Gupta  ******************************************************************************/
485df373737SAchin Gupta void gicv3_driver_init(const gicv3_driver_data_t *plat_driver_data);
486ec834925SMadhukar Pappireddy int gicv3_rdistif_probe(const uintptr_t gicr_frame);
487df373737SAchin Gupta void gicv3_distif_init(void);
488df373737SAchin Gupta void gicv3_rdistif_init(unsigned int proc_num);
489d780699bSJeenu Viswambharan void gicv3_rdistif_on(unsigned int proc_num);
490d780699bSJeenu Viswambharan void gicv3_rdistif_off(unsigned int proc_num);
491*79d89e3dSAndre Przywara unsigned int gicv3_rdistif_get_number_frames(const uintptr_t gicr_frame);
492df373737SAchin Gupta void gicv3_cpuif_enable(unsigned int proc_num);
493df373737SAchin Gupta void gicv3_cpuif_disable(unsigned int proc_num);
494df373737SAchin Gupta unsigned int gicv3_get_pending_interrupt_type(void);
495df373737SAchin Gupta unsigned int gicv3_get_pending_interrupt_id(void);
496df373737SAchin Gupta unsigned int gicv3_get_interrupt_type(unsigned int id,
497df373737SAchin Gupta 					  unsigned int proc_num);
498ebf1ca10SSoby Mathew void gicv3_distif_init_restore(const gicv3_dist_ctx_t * const dist_ctx);
499ebf1ca10SSoby Mathew void gicv3_distif_save(gicv3_dist_ctx_t * const dist_ctx);
500ebf1ca10SSoby Mathew /*
501ebf1ca10SSoby Mathew  * gicv3_distif_post_restore and gicv3_distif_pre_save must be implemented if
502ebf1ca10SSoby Mathew  * gicv3_distif_save and gicv3_rdistif_init_restore are used. If no
503ebf1ca10SSoby Mathew  * implementation-defined sequence is needed at these steps, an empty function
504ebf1ca10SSoby Mathew  * can be provided.
505ebf1ca10SSoby Mathew  */
506ebf1ca10SSoby Mathew void gicv3_distif_post_restore(unsigned int proc_num);
507ebf1ca10SSoby Mathew void gicv3_distif_pre_save(unsigned int proc_num);
508ebf1ca10SSoby Mathew void gicv3_rdistif_init_restore(unsigned int proc_num, const gicv3_redist_ctx_t * const rdist_ctx);
509ebf1ca10SSoby Mathew void gicv3_rdistif_save(unsigned int proc_num, gicv3_redist_ctx_t * const rdist_ctx);
510b258278eSSoby Mathew void gicv3_its_save_disable(uintptr_t gits_base, gicv3_its_ctx_t * const its_ctx);
511b258278eSSoby Mathew void gicv3_its_restore(uintptr_t gits_base, const gicv3_its_ctx_t * const its_ctx);
512df373737SAchin Gupta 
513eb68ea9bSJeenu Viswambharan unsigned int gicv3_get_running_priority(void);
514cbd3f370SJeenu Viswambharan unsigned int gicv3_get_interrupt_active(unsigned int id, unsigned int proc_num);
515979225f4SJeenu Viswambharan void gicv3_enable_interrupt(unsigned int id, unsigned int proc_num);
516979225f4SJeenu Viswambharan void gicv3_disable_interrupt(unsigned int id, unsigned int proc_num);
517f3a86600SJeenu Viswambharan void gicv3_set_interrupt_priority(unsigned int id, unsigned int proc_num,
518f3a86600SJeenu Viswambharan 		unsigned int priority);
51974dce7faSJeenu Viswambharan void gicv3_set_interrupt_type(unsigned int id, unsigned int proc_num,
520dc6aad2eSRoberto Vargas 		unsigned int type);
5213fea9c8bSAntonio Nino Diaz void gicv3_raise_secure_g0_sgi(unsigned int sgi_num, u_register_t target);
522fc529feeSJeenu Viswambharan void gicv3_set_spi_routing(unsigned int id, unsigned int irm,
523fc529feeSJeenu Viswambharan 		u_register_t mpidr);
524a2816a16SJeenu Viswambharan void gicv3_set_interrupt_pending(unsigned int id, unsigned int proc_num);
525a2816a16SJeenu Viswambharan void gicv3_clear_interrupt_pending(unsigned int id, unsigned int proc_num);
526d55a4450SJeenu Viswambharan unsigned int gicv3_set_pmr(unsigned int mask);
527eb68ea9bSJeenu Viswambharan 
528d5dfdeb6SJulius Werner #endif /* __ASSEMBLER__ */
529c3cf06f1SAntonio Nino Diaz #endif /* GICV3_H */
530