xref: /rk3399_ARM-atf/include/drivers/arm/gic_common.h (revision fc529fee720de5fef8388c52bfefcb807ac764b0)
1 /*
2  * Copyright (c) 2015-2017, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef __GIC_COMMON_H__
8 #define __GIC_COMMON_H__
9 
10 /*******************************************************************************
11  * GIC Distributor interface general definitions
12  ******************************************************************************/
13 /* Constants to categorise interrupts */
14 #define MIN_SGI_ID		0
15 #define MIN_SEC_SGI_ID		8
16 #define MIN_PPI_ID		16
17 #define MIN_SPI_ID		32
18 #define MAX_SPI_ID		1019
19 
20 #define TOTAL_SPI_INTR_NUM	(MAX_SPI_ID - MIN_SPI_ID + 1)
21 #define TOTAL_PCPU_INTR_NUM	(MIN_SPI_ID - MIN_SGI_ID)
22 
23 /* Mask for the priority field common to all GIC interfaces */
24 #define GIC_PRI_MASK			0xff
25 
26 /* Constant to indicate a spurious interrupt in all GIC versions */
27 #define GIC_SPURIOUS_INTERRUPT		1023
28 
29 /* Constants to categorise priorities */
30 #define GIC_HIGHEST_SEC_PRIORITY	0
31 #define GIC_LOWEST_SEC_PRIORITY		127
32 #define GIC_HIGHEST_NS_PRIORITY		128
33 #define GIC_LOWEST_NS_PRIORITY		254 /* 255 would disable an interrupt */
34 
35 /*******************************************************************************
36  * GIC Distributor interface register offsets that are common to GICv3 & GICv2
37  ******************************************************************************/
38 #define GICD_CTLR		0x0
39 #define GICD_TYPER		0x4
40 #define GICD_IIDR		0x8
41 #define GICD_IGROUPR		0x80
42 #define GICD_ISENABLER		0x100
43 #define GICD_ICENABLER		0x180
44 #define GICD_ISPENDR		0x200
45 #define GICD_ICPENDR		0x280
46 #define GICD_ISACTIVER		0x300
47 #define GICD_ICACTIVER		0x380
48 #define GICD_IPRIORITYR		0x400
49 #define GICD_ICFGR		0xc00
50 #define GICD_NSACR		0xe00
51 
52 /* GICD_CTLR bit definitions */
53 #define CTLR_ENABLE_G0_SHIFT		0
54 #define CTLR_ENABLE_G0_MASK		0x1
55 #define CTLR_ENABLE_G0_BIT		(1 << CTLR_ENABLE_G0_SHIFT)
56 
57 
58 /*******************************************************************************
59  * GIC Distributor interface register constants that are common to GICv3 & GICv2
60  ******************************************************************************/
61 #define PIDR2_ARCH_REV_SHIFT	4
62 #define PIDR2_ARCH_REV_MASK	0xf
63 
64 /* GICv3 revision as reported by the PIDR2 register */
65 #define ARCH_REV_GICV3		0x3
66 /* GICv2 revision as reported by the PIDR2 register */
67 #define ARCH_REV_GICV2		0x2
68 
69 #define IGROUPR_SHIFT		5
70 #define ISENABLER_SHIFT		5
71 #define ICENABLER_SHIFT		ISENABLER_SHIFT
72 #define ISPENDR_SHIFT		5
73 #define ICPENDR_SHIFT		ISPENDR_SHIFT
74 #define ISACTIVER_SHIFT		5
75 #define ICACTIVER_SHIFT		ISACTIVER_SHIFT
76 #define IPRIORITYR_SHIFT	2
77 #define ITARGETSR_SHIFT		2
78 #define ICFGR_SHIFT		4
79 #define NSACR_SHIFT		4
80 
81 /* GICD_TYPER shifts and masks */
82 #define TYPER_IT_LINES_NO_SHIFT	0
83 #define TYPER_IT_LINES_NO_MASK	0x1f
84 
85 /* Value used to initialize Normal world interrupt priorities four at a time */
86 #define GICD_IPRIORITYR_DEF_VAL			\
87 	(GIC_HIGHEST_NS_PRIORITY	|	\
88 	(GIC_HIGHEST_NS_PRIORITY << 8)	|	\
89 	(GIC_HIGHEST_NS_PRIORITY << 16)	|	\
90 	(GIC_HIGHEST_NS_PRIORITY << 24))
91 
92 #endif /* __GIC_COMMON_H__ */
93