xref: /rk3399_ARM-atf/include/drivers/arm/gic_common.h (revision 22966106967b01768db5140ce20f62dd7f20358f)
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 /* Mask for the configuration field common to all GIC interfaces */
27 #define GIC_CFG_MASK			0x3
28 
29 /* Constant to indicate a spurious interrupt in all GIC versions */
30 #define GIC_SPURIOUS_INTERRUPT		1023
31 
32 /* Constants to categorise priorities */
33 #define GIC_HIGHEST_SEC_PRIORITY	0
34 #define GIC_LOWEST_SEC_PRIORITY		127
35 #define GIC_HIGHEST_NS_PRIORITY		128
36 #define GIC_LOWEST_NS_PRIORITY		254 /* 255 would disable an interrupt */
37 
38 /*******************************************************************************
39  * GIC Distributor interface register offsets that are common to GICv3 & GICv2
40  ******************************************************************************/
41 #define GICD_CTLR		0x0
42 #define GICD_TYPER		0x4
43 #define GICD_IIDR		0x8
44 #define GICD_IGROUPR		0x80
45 #define GICD_ISENABLER		0x100
46 #define GICD_ICENABLER		0x180
47 #define GICD_ISPENDR		0x200
48 #define GICD_ICPENDR		0x280
49 #define GICD_ISACTIVER		0x300
50 #define GICD_ICACTIVER		0x380
51 #define GICD_IPRIORITYR		0x400
52 #define GICD_ICFGR		0xc00
53 #define GICD_NSACR		0xe00
54 
55 /* GICD_CTLR bit definitions */
56 #define CTLR_ENABLE_G0_SHIFT		0
57 #define CTLR_ENABLE_G0_MASK		0x1
58 #define CTLR_ENABLE_G0_BIT		(1 << CTLR_ENABLE_G0_SHIFT)
59 
60 
61 /*******************************************************************************
62  * GIC Distributor interface register constants that are common to GICv3 & GICv2
63  ******************************************************************************/
64 #define PIDR2_ARCH_REV_SHIFT	4
65 #define PIDR2_ARCH_REV_MASK	0xf
66 
67 /* GICv3 revision as reported by the PIDR2 register */
68 #define ARCH_REV_GICV3		0x3
69 /* GICv2 revision as reported by the PIDR2 register */
70 #define ARCH_REV_GICV2		0x2
71 
72 #define IGROUPR_SHIFT		5
73 #define ISENABLER_SHIFT		5
74 #define ICENABLER_SHIFT		ISENABLER_SHIFT
75 #define ISPENDR_SHIFT		5
76 #define ICPENDR_SHIFT		ISPENDR_SHIFT
77 #define ISACTIVER_SHIFT		5
78 #define ICACTIVER_SHIFT		ISACTIVER_SHIFT
79 #define IPRIORITYR_SHIFT	2
80 #define ITARGETSR_SHIFT		2
81 #define ICFGR_SHIFT		4
82 #define NSACR_SHIFT		4
83 
84 /* GICD_TYPER shifts and masks */
85 #define TYPER_IT_LINES_NO_SHIFT	0
86 #define TYPER_IT_LINES_NO_MASK	0x1f
87 
88 /* Value used to initialize Normal world interrupt priorities four at a time */
89 #define GICD_IPRIORITYR_DEF_VAL			\
90 	(GIC_HIGHEST_NS_PRIORITY	|	\
91 	(GIC_HIGHEST_NS_PRIORITY << 8)	|	\
92 	(GIC_HIGHEST_NS_PRIORITY << 16)	|	\
93 	(GIC_HIGHEST_NS_PRIORITY << 24))
94 
95 #endif /* __GIC_COMMON_H__ */
96