1 /*
2  * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <arch.h>
8 #include <assert.h>
9 #include <gic_v2.h>
10 #include <interrupt_mgmt.h>
11 #include <mmio.h>
12 
13 /*******************************************************************************
14  * GIC Distributor interface accessors for reading entire registers
15  ******************************************************************************/
16 
gicd_read_igroupr(uintptr_t base,unsigned int id)17 unsigned int gicd_read_igroupr(uintptr_t base, unsigned int id)
18 {
19 	unsigned n = id >> IGROUPR_SHIFT;
20 	return mmio_read_32(base + GICD_IGROUPR + (n << 2));
21 }
22 
gicd_read_isenabler(uintptr_t base,unsigned int id)23 unsigned int gicd_read_isenabler(uintptr_t base, unsigned int id)
24 {
25 	unsigned n = id >> ISENABLER_SHIFT;
26 	return mmio_read_32(base + GICD_ISENABLER + (n << 2));
27 }
28 
gicd_read_icenabler(uintptr_t base,unsigned int id)29 unsigned int gicd_read_icenabler(uintptr_t base, unsigned int id)
30 {
31 	unsigned n = id >> ICENABLER_SHIFT;
32 	return mmio_read_32(base + GICD_ICENABLER + (n << 2));
33 }
34 
gicd_read_ispendr(uintptr_t base,unsigned int id)35 unsigned int gicd_read_ispendr(uintptr_t base, unsigned int id)
36 {
37 	unsigned n = id >> ISPENDR_SHIFT;
38 	return mmio_read_32(base + GICD_ISPENDR + (n << 2));
39 }
40 
gicd_read_icpendr(uintptr_t base,unsigned int id)41 unsigned int gicd_read_icpendr(uintptr_t base, unsigned int id)
42 {
43 	unsigned n = id >> ICPENDR_SHIFT;
44 	return mmio_read_32(base + GICD_ICPENDR + (n << 2));
45 }
46 
gicd_read_isactiver(uintptr_t base,unsigned int id)47 unsigned int gicd_read_isactiver(uintptr_t base, unsigned int id)
48 {
49 	unsigned n = id >> ISACTIVER_SHIFT;
50 	return mmio_read_32(base + GICD_ISACTIVER + (n << 2));
51 }
52 
gicd_read_icactiver(uintptr_t base,unsigned int id)53 unsigned int gicd_read_icactiver(uintptr_t base, unsigned int id)
54 {
55 	unsigned n = id >> ICACTIVER_SHIFT;
56 	return mmio_read_32(base + GICD_ICACTIVER + (n << 2));
57 }
58 
gicd_read_ipriorityr(uintptr_t base,unsigned int id)59 unsigned int gicd_read_ipriorityr(uintptr_t base, unsigned int id)
60 {
61 	unsigned n = id >> IPRIORITYR_SHIFT;
62 	return mmio_read_32(base + GICD_IPRIORITYR + (n << 2));
63 }
64 
gicd_read_itargetsr(uintptr_t base,unsigned int id)65 unsigned int gicd_read_itargetsr(uintptr_t base, unsigned int id)
66 {
67 	unsigned n = id >> ITARGETSR_SHIFT;
68 	return mmio_read_32(base + GICD_ITARGETSR + (n << 2));
69 }
70 
gicd_read_icfgr(uintptr_t base,unsigned int id)71 unsigned int gicd_read_icfgr(uintptr_t base, unsigned int id)
72 {
73 	unsigned n = id >> ICFGR_SHIFT;
74 	return mmio_read_32(base + GICD_ICFGR + (n << 2));
75 }
76 
gicd_read_cpendsgir(uintptr_t base,unsigned int id)77 unsigned int gicd_read_cpendsgir(uintptr_t base, unsigned int id)
78 {
79 	unsigned n = id >> CPENDSGIR_SHIFT;
80 	return mmio_read_32(base + GICD_CPENDSGIR + (n << 2));
81 }
82 
gicd_read_spendsgir(uintptr_t base,unsigned int id)83 unsigned int gicd_read_spendsgir(uintptr_t base, unsigned int id)
84 {
85 	unsigned n = id >> SPENDSGIR_SHIFT;
86 	return mmio_read_32(base + GICD_SPENDSGIR + (n << 2));
87 }
88 
89 /*******************************************************************************
90  * GIC Distributor interface accessors for writing entire registers
91  ******************************************************************************/
92 
gicd_write_igroupr(uintptr_t base,unsigned int id,unsigned int val)93 void gicd_write_igroupr(uintptr_t base, unsigned int id, unsigned int val)
94 {
95 	unsigned n = id >> IGROUPR_SHIFT;
96 	mmio_write_32(base + GICD_IGROUPR + (n << 2), val);
97 }
98 
gicd_write_isenabler(uintptr_t base,unsigned int id,unsigned int val)99 void gicd_write_isenabler(uintptr_t base, unsigned int id, unsigned int val)
100 {
101 	unsigned n = id >> ISENABLER_SHIFT;
102 	mmio_write_32(base + GICD_ISENABLER + (n << 2), val);
103 }
104 
gicd_write_icenabler(uintptr_t base,unsigned int id,unsigned int val)105 void gicd_write_icenabler(uintptr_t base, unsigned int id, unsigned int val)
106 {
107 	unsigned n = id >> ICENABLER_SHIFT;
108 	mmio_write_32(base + GICD_ICENABLER + (n << 2), val);
109 }
110 
gicd_write_ispendr(uintptr_t base,unsigned int id,unsigned int val)111 void gicd_write_ispendr(uintptr_t base, unsigned int id, unsigned int val)
112 {
113 	unsigned n = id >> ISPENDR_SHIFT;
114 	mmio_write_32(base + GICD_ISPENDR + (n << 2), val);
115 }
116 
gicd_write_icpendr(uintptr_t base,unsigned int id,unsigned int val)117 void gicd_write_icpendr(uintptr_t base, unsigned int id, unsigned int val)
118 {
119 	unsigned n = id >> ICPENDR_SHIFT;
120 	mmio_write_32(base + GICD_ICPENDR + (n << 2), val);
121 }
122 
gicd_write_isactiver(uintptr_t base,unsigned int id,unsigned int val)123 void gicd_write_isactiver(uintptr_t base, unsigned int id, unsigned int val)
124 {
125 	unsigned n = id >> ISACTIVER_SHIFT;
126 	mmio_write_32(base + GICD_ISACTIVER + (n << 2), val);
127 }
128 
gicd_write_icactiver(uintptr_t base,unsigned int id,unsigned int val)129 void gicd_write_icactiver(uintptr_t base, unsigned int id, unsigned int val)
130 {
131 	unsigned n = id >> ICACTIVER_SHIFT;
132 	mmio_write_32(base + GICD_ICACTIVER + (n << 2), val);
133 }
134 
gicd_write_ipriorityr(uintptr_t base,unsigned int id,unsigned int val)135 void gicd_write_ipriorityr(uintptr_t base, unsigned int id, unsigned int val)
136 {
137 	unsigned n = id >> IPRIORITYR_SHIFT;
138 	mmio_write_32(base + GICD_IPRIORITYR + (n << 2), val);
139 }
140 
gicd_write_itargetsr(uintptr_t base,unsigned int id,unsigned int val)141 void gicd_write_itargetsr(uintptr_t base, unsigned int id, unsigned int val)
142 {
143 	unsigned n = id >> ITARGETSR_SHIFT;
144 	mmio_write_32(base + GICD_ITARGETSR + (n << 2), val);
145 }
146 
gicd_write_icfgr(uintptr_t base,unsigned int id,unsigned int val)147 void gicd_write_icfgr(uintptr_t base, unsigned int id, unsigned int val)
148 {
149 	unsigned n = id >> ICFGR_SHIFT;
150 	mmio_write_32(base + GICD_ICFGR + (n << 2), val);
151 }
152 
gicd_write_cpendsgir(uintptr_t base,unsigned int id,unsigned int val)153 void gicd_write_cpendsgir(uintptr_t base, unsigned int id, unsigned int val)
154 {
155 	unsigned n = id >> CPENDSGIR_SHIFT;
156 	mmio_write_32(base + GICD_CPENDSGIR + (n << 2), val);
157 }
158 
gicd_write_spendsgir(uintptr_t base,unsigned int id,unsigned int val)159 void gicd_write_spendsgir(uintptr_t base, unsigned int id, unsigned int val)
160 {
161 	unsigned n = id >> SPENDSGIR_SHIFT;
162 	mmio_write_32(base + GICD_SPENDSGIR + (n << 2), val);
163 }
164 
165 /*******************************************************************************
166  * GIC Distributor interface accessors for individual interrupt manipulation
167  ******************************************************************************/
gicd_get_igroupr(uintptr_t base,unsigned int id)168 unsigned int gicd_get_igroupr(uintptr_t base, unsigned int id)
169 {
170 	unsigned bit_num = id & ((1 << IGROUPR_SHIFT) - 1);
171 	unsigned int reg_val = gicd_read_igroupr(base, id);
172 
173 	return (reg_val >> bit_num) & 0x1;
174 }
175 
gicd_set_igroupr(uintptr_t base,unsigned int id)176 void gicd_set_igroupr(uintptr_t base, unsigned int id)
177 {
178 	unsigned bit_num = id & ((1 << IGROUPR_SHIFT) - 1);
179 	unsigned int reg_val = gicd_read_igroupr(base, id);
180 
181 	gicd_write_igroupr(base, id, reg_val | (1 << bit_num));
182 }
183 
gicd_clr_igroupr(uintptr_t base,unsigned int id)184 void gicd_clr_igroupr(uintptr_t base, unsigned int id)
185 {
186 	unsigned bit_num = id & ((1 << IGROUPR_SHIFT) - 1);
187 	unsigned int reg_val = gicd_read_igroupr(base, id);
188 
189 	gicd_write_igroupr(base, id, reg_val & ~(1 << bit_num));
190 }
191 
gicd_set_isenabler(uintptr_t base,unsigned int id)192 void gicd_set_isenabler(uintptr_t base, unsigned int id)
193 {
194 	unsigned bit_num = id & ((1 << ISENABLER_SHIFT) - 1);
195 
196 	gicd_write_isenabler(base, id, (1 << bit_num));
197 }
198 
gicd_set_icenabler(uintptr_t base,unsigned int id)199 void gicd_set_icenabler(uintptr_t base, unsigned int id)
200 {
201 	unsigned bit_num = id & ((1 << ICENABLER_SHIFT) - 1);
202 
203 	gicd_write_icenabler(base, id, (1 << bit_num));
204 }
205 
gicd_set_ispendr(uintptr_t base,unsigned int id)206 void gicd_set_ispendr(uintptr_t base, unsigned int id)
207 {
208 	unsigned bit_num = id & ((1 << ISPENDR_SHIFT) - 1);
209 
210 	gicd_write_ispendr(base, id, (1 << bit_num));
211 }
212 
gicd_set_icpendr(uintptr_t base,unsigned int id)213 void gicd_set_icpendr(uintptr_t base, unsigned int id)
214 {
215 	unsigned bit_num = id & ((1 << ICPENDR_SHIFT) - 1);
216 
217 	gicd_write_icpendr(base, id, (1 << bit_num));
218 }
219 
gicd_set_isactiver(uintptr_t base,unsigned int id)220 void gicd_set_isactiver(uintptr_t base, unsigned int id)
221 {
222 	unsigned bit_num = id & ((1 << ISACTIVER_SHIFT) - 1);
223 
224 	gicd_write_isactiver(base, id, (1 << bit_num));
225 }
226 
gicd_set_icactiver(uintptr_t base,unsigned int id)227 void gicd_set_icactiver(uintptr_t base, unsigned int id)
228 {
229 	unsigned bit_num = id & ((1 << ICACTIVER_SHIFT) - 1);
230 
231 	gicd_write_icactiver(base, id, (1 << bit_num));
232 }
233 
234 /*
235  * Make sure that the interrupt's group is set before expecting
236  * this function to do its job correctly.
237  */
gicd_set_ipriorityr(uintptr_t base,unsigned int id,unsigned int pri)238 void gicd_set_ipriorityr(uintptr_t base, unsigned int id, unsigned int pri)
239 {
240 	/*
241 	 * Enforce ARM recommendation to manage priority values such
242 	 * that group1 interrupts always have a lower priority than
243 	 * group0 interrupts.
244 	 * Note, lower numerical values are higher priorities so the comparison
245 	 * checks below are reversed from what might be expected.
246 	 */
247 	assert(gicd_get_igroupr(base, id) == GRP1 ?
248 		pri >= GIC_HIGHEST_NS_PRIORITY &&
249 			pri <= GIC_LOWEST_NS_PRIORITY :
250 		pri >= GIC_HIGHEST_SEC_PRIORITY &&
251 			pri <= GIC_LOWEST_SEC_PRIORITY);
252 
253 	mmio_write_8(base + GICD_IPRIORITYR + id, pri & GIC_PRI_MASK);
254 }
255 
gicd_set_itargetsr(uintptr_t base,unsigned int id,unsigned int target)256 void gicd_set_itargetsr(uintptr_t base, unsigned int id, unsigned int target)
257 {
258 	mmio_write_8(base + GICD_ITARGETSR + id, target & GIC_TARGET_CPU_MASK);
259 }
260 
261 /*******************************************************************************
262  * This function allows the interrupt management framework to determine (through
263  * the platform) which interrupt line (IRQ/FIQ) to use for an interrupt type to
264  * route it to EL3. The interrupt line is represented as the bit position of the
265  * IRQ or FIQ bit in the SCR_EL3.
266  ******************************************************************************/
gicv2_interrupt_type_to_line(uint32_t cpuif_base,uint32_t type)267 uint32_t gicv2_interrupt_type_to_line(uint32_t cpuif_base, uint32_t type)
268 {
269 	uint32_t gicc_ctlr;
270 
271 	/* Non-secure interrupts are signalled on the IRQ line always */
272 	if (type == INTR_TYPE_NS)
273 		return __builtin_ctz(SCR_IRQ_BIT);
274 
275 	/*
276 	 * Secure interrupts are signalled using the IRQ line if the FIQ_EN
277 	 * bit is not set else they are signalled using the FIQ line.
278 	 */
279 	gicc_ctlr = gicc_read_ctlr(cpuif_base);
280 	if (gicc_ctlr & FIQ_EN)
281 		return __builtin_ctz(SCR_FIQ_BIT);
282 	else
283 		return __builtin_ctz(SCR_IRQ_BIT);
284 }
285