xref: /rk3399_ARM-atf/drivers/arm/gic/v3/gicv3_helpers.c (revision 3dbbbca29e3c42a6f9976878f27e1f1fd75b5c8e)
1 /*
2  * Copyright (c) 2015-2021, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 
9 #include <arch.h>
10 #include <arch_helpers.h>
11 #include <common/debug.h>
12 #include <common/interrupt_props.h>
13 #include <drivers/arm/gic_common.h>
14 
15 #include "../common/gic_common_private.h"
16 #include "gicv3_private.h"
17 
18 /******************************************************************************
19  * This function marks the core as awake in the re-distributor and
20  * ensures that the interface is active.
21  *****************************************************************************/
22 void gicv3_rdistif_mark_core_awake(uintptr_t gicr_base)
23 {
24 	/*
25 	 * The WAKER_PS_BIT should be changed to 0
26 	 * only when WAKER_CA_BIT is 1.
27 	 */
28 	assert((gicr_read_waker(gicr_base) & WAKER_CA_BIT) != 0U);
29 
30 	/* Mark the connected core as awake */
31 	gicr_write_waker(gicr_base, gicr_read_waker(gicr_base) & ~WAKER_PS_BIT);
32 
33 	/* Wait till the WAKER_CA_BIT changes to 0 */
34 	while ((gicr_read_waker(gicr_base) & WAKER_CA_BIT) != 0U) {
35 	}
36 }
37 
38 /******************************************************************************
39  * This function marks the core as asleep in the re-distributor and ensures
40  * that the interface is quiescent.
41  *****************************************************************************/
42 void gicv3_rdistif_mark_core_asleep(uintptr_t gicr_base)
43 {
44 	/* Mark the connected core as asleep */
45 	gicr_write_waker(gicr_base, gicr_read_waker(gicr_base) | WAKER_PS_BIT);
46 
47 	/* Wait till the WAKER_CA_BIT changes to 1 */
48 	while ((gicr_read_waker(gicr_base) & WAKER_CA_BIT) == 0U) {
49 	}
50 }
51 
52 /*******************************************************************************
53  * This function probes the Redistributor frames when the driver is initialised
54  * and saves their base addresses. These base addresses are used later to
55  * initialise each Redistributor interface.
56  ******************************************************************************/
57 void gicv3_rdistif_base_addrs_probe(uintptr_t *rdistif_base_addrs,
58 					unsigned int rdistif_num,
59 					uintptr_t gicr_base,
60 					mpidr_hash_fn mpidr_to_core_pos)
61 {
62 	u_register_t mpidr;
63 	unsigned int proc_num;
64 	uint64_t typer_val;
65 	uintptr_t rdistif_base = gicr_base;
66 
67 	assert(rdistif_base_addrs != NULL);
68 
69 	/*
70 	 * Iterate over the Redistributor frames. Store the base address of each
71 	 * frame in the platform provided array. Use the "Processor Number"
72 	 * field to index into the array if the platform has not provided a hash
73 	 * function to convert an MPIDR (obtained from the "Affinity Value"
74 	 * field into a linear index.
75 	 */
76 	do {
77 		typer_val = gicr_read_typer(rdistif_base);
78 		if (mpidr_to_core_pos != NULL) {
79 			mpidr = mpidr_from_gicr_typer(typer_val);
80 			proc_num = mpidr_to_core_pos(mpidr);
81 		} else {
82 			proc_num = (typer_val >> TYPER_PROC_NUM_SHIFT) &
83 				TYPER_PROC_NUM_MASK;
84 		}
85 
86 		if (proc_num < rdistif_num) {
87 			rdistif_base_addrs[proc_num] = rdistif_base;
88 		}
89 
90 		rdistif_base += (1U << GICR_PCPUBASE_SHIFT);
91 	} while ((typer_val & TYPER_LAST_BIT) == 0U);
92 }
93 
94 /*******************************************************************************
95  * Helper function to configure the default attributes of (E)SPIs.
96  ******************************************************************************/
97 void gicv3_spis_config_defaults(uintptr_t gicd_base)
98 {
99 	unsigned int i, num_ints;
100 #if GIC_EXT_INTID
101 	unsigned int num_eints;
102 #endif
103 	unsigned int typer_reg = gicd_read_typer(gicd_base);
104 
105 	/* Maximum SPI INTID is 32 * (GICD_TYPER.ITLinesNumber + 1) - 1 */
106 	num_ints = ((typer_reg & TYPER_IT_LINES_NO_MASK) + 1U) << 5;
107 
108 	/*
109 	 * The GICv3 architecture allows GICD_TYPER.ITLinesNumber to be 31, so
110 	 * the maximum possible value for num_ints is 1024. Limit the value to
111 	 * MAX_SPI_ID + 1 to avoid getting wrong address in GICD_OFFSET() macro.
112 	 */
113 	if (num_ints > MAX_SPI_ID + 1U) {
114 		num_ints = MAX_SPI_ID + 1U;
115 	}
116 	INFO("Maximum SPI INTID supported: %u\n", num_ints - 1);
117 
118 	/* Treat all (E)SPIs as G1NS by default. We do 32 at a time. */
119 	for (i = MIN_SPI_ID; i < num_ints; i += (1U << IGROUPR_SHIFT)) {
120 		gicd_write_igroupr(gicd_base, i, ~0U);
121 	}
122 
123 #if GIC_EXT_INTID
124 	/* Check if extended SPI range is implemented */
125 	if ((typer_reg & TYPER_ESPI) != 0U) {
126 		/*
127 		 * Maximum ESPI INTID is 32 * (GICD_TYPER.ESPI_range + 1) + 4095
128 		 */
129 		num_eints = ((((typer_reg >> TYPER_ESPI_RANGE_SHIFT) &
130 			TYPER_ESPI_RANGE_MASK) + 1U) << 5) + MIN_ESPI_ID;
131 		INFO("Maximum ESPI INTID supported: %u\n", num_eints - 1);
132 
133 		for (i = MIN_ESPI_ID; i < num_eints;
134 					i += (1U << IGROUPR_SHIFT)) {
135 			gicd_write_igroupr(gicd_base, i, ~0U);
136 		}
137 	} else {
138 		num_eints = 0U;
139 		INFO("ESPI range is not implemented.\n");
140 	}
141 #endif
142 
143 	/* Setup the default (E)SPI priorities doing four at a time */
144 	for (i = MIN_SPI_ID; i < num_ints; i += (1U << IPRIORITYR_SHIFT)) {
145 		gicd_write_ipriorityr(gicd_base, i, GICD_IPRIORITYR_DEF_VAL);
146 	}
147 
148 #if GIC_EXT_INTID
149 	for (i = MIN_ESPI_ID; i < num_eints;
150 					i += (1U << IPRIORITYR_SHIFT)) {
151 		gicd_write_ipriorityr(gicd_base, i, GICD_IPRIORITYR_DEF_VAL);
152 	}
153 #endif
154 	/*
155 	 * Treat all (E)SPIs as level triggered by default, write 16 at a time
156 	 */
157 	for (i = MIN_SPI_ID; i < num_ints; i += (1U << ICFGR_SHIFT)) {
158 		gicd_write_icfgr(gicd_base, i, 0U);
159 	}
160 
161 #if GIC_EXT_INTID
162 	for (i = MIN_ESPI_ID; i < num_eints; i += (1U << ICFGR_SHIFT)) {
163 		gicd_write_icfgr(gicd_base, i, 0U);
164 	}
165 #endif
166 }
167 
168 /*******************************************************************************
169  * Helper function to configure properties of secure (E)SPIs
170  ******************************************************************************/
171 unsigned int gicv3_secure_spis_config_props(uintptr_t gicd_base,
172 		const interrupt_prop_t *interrupt_props,
173 		unsigned int interrupt_props_num)
174 {
175 	unsigned int i;
176 	const interrupt_prop_t *current_prop;
177 	unsigned long long gic_affinity_val;
178 	unsigned int ctlr_enable = 0U;
179 
180 	/* Make sure there's a valid property array */
181 	if (interrupt_props_num > 0U) {
182 		assert(interrupt_props != NULL);
183 	}
184 
185 	for (i = 0U; i < interrupt_props_num; i++) {
186 		current_prop = &interrupt_props[i];
187 
188 		unsigned int intr_num = current_prop->intr_num;
189 
190 		/* Skip SGI, (E)PPI and LPI interrupts */
191 		if (!IS_SPI(intr_num)) {
192 			continue;
193 		}
194 
195 		/* Configure this interrupt as a secure interrupt */
196 		gicd_clr_igroupr(gicd_base, intr_num);
197 
198 		/* Configure this interrupt as G0 or a G1S interrupt */
199 		assert((current_prop->intr_grp == INTR_GROUP0) ||
200 				(current_prop->intr_grp == INTR_GROUP1S));
201 
202 		if (current_prop->intr_grp == INTR_GROUP1S) {
203 			gicd_set_igrpmodr(gicd_base, intr_num);
204 			ctlr_enable |= CTLR_ENABLE_G1S_BIT;
205 		} else {
206 			gicd_clr_igrpmodr(gicd_base, intr_num);
207 			ctlr_enable |= CTLR_ENABLE_G0_BIT;
208 		}
209 
210 		/* Set interrupt configuration */
211 		gicd_set_icfgr(gicd_base, intr_num, current_prop->intr_cfg);
212 
213 		/* Set the priority of this interrupt */
214 		gicd_set_ipriorityr(gicd_base, intr_num,
215 					current_prop->intr_pri);
216 
217 		/* Target (E)SPIs to the primary CPU */
218 		gic_affinity_val =
219 			gicd_irouter_val_from_mpidr(read_mpidr(), 0U);
220 		gicd_write_irouter(gicd_base, intr_num,
221 					gic_affinity_val);
222 
223 		/* Enable this interrupt */
224 		gicd_set_isenabler(gicd_base, intr_num);
225 	}
226 
227 	return ctlr_enable;
228 }
229 
230 /*******************************************************************************
231  * Helper function to configure the default attributes of (E)SPIs
232  ******************************************************************************/
233 void gicv3_ppi_sgi_config_defaults(uintptr_t gicr_base)
234 {
235 	unsigned int i, ppi_regs_num, regs_num;
236 
237 #if GIC_EXT_INTID
238 	/* Calculate number of PPI registers */
239 	ppi_regs_num = (unsigned int)((gicr_read_typer(gicr_base) >>
240 			TYPER_PPI_NUM_SHIFT) & TYPER_PPI_NUM_MASK) + 1;
241 	/* All other values except PPInum [0-2] are reserved */
242 	if (ppi_regs_num > 3U) {
243 		ppi_regs_num = 1U;
244 	}
245 #else
246 	ppi_regs_num = 1U;
247 #endif
248 	/*
249 	 * Disable all SGIs (imp. def.)/(E)PPIs before configuring them.
250 	 * This is a more scalable approach as it avoids clearing
251 	 * the enable bits in the GICD_CTLR.
252 	 */
253 	for (i = 0U; i < ppi_regs_num; ++i) {
254 		gicr_write_icenabler(gicr_base, i, ~0U);
255 	}
256 
257 	/* Wait for pending writes to GICR_ICENABLER */
258 	gicr_wait_for_pending_write(gicr_base);
259 
260 	/* 32 interrupt IDs per GICR_IGROUPR register */
261 	for (i = 0U; i < ppi_regs_num; ++i) {
262 		/* Treat all SGIs/(E)PPIs as G1NS by default */
263 		gicr_write_igroupr(gicr_base, i, ~0U);
264 	}
265 
266 	/* 4 interrupt IDs per GICR_IPRIORITYR register */
267 	regs_num = ppi_regs_num << 3;
268 	for (i = 0U; i < regs_num; ++i) {
269 		/* Setup the default (E)PPI/SGI priorities doing 4 at a time */
270 		gicr_write_ipriorityr(gicr_base, i, GICD_IPRIORITYR_DEF_VAL);
271 	}
272 
273 	/* 16 interrupt IDs per GICR_ICFGR register */
274 	regs_num = ppi_regs_num << 1;
275 	for (i = (MIN_PPI_ID >> ICFGR_SHIFT); i < regs_num; ++i) {
276 		/* Configure all (E)PPIs as level triggered by default */
277 		gicr_write_icfgr(gicr_base, i, 0U);
278 	}
279 }
280 
281 /*******************************************************************************
282  * Helper function to configure properties of secure G0 and G1S (E)PPIs and SGIs
283  ******************************************************************************/
284 unsigned int gicv3_secure_ppi_sgi_config_props(uintptr_t gicr_base,
285 		const interrupt_prop_t *interrupt_props,
286 		unsigned int interrupt_props_num)
287 {
288 	unsigned int i;
289 	const interrupt_prop_t *current_prop;
290 	unsigned int ctlr_enable = 0U;
291 
292 	/* Make sure there's a valid property array */
293 	if (interrupt_props_num > 0U) {
294 		assert(interrupt_props != NULL);
295 	}
296 
297 	for (i = 0U; i < interrupt_props_num; i++) {
298 		current_prop = &interrupt_props[i];
299 
300 		unsigned int intr_num = current_prop->intr_num;
301 
302 		/* Skip (E)SPI interrupt */
303 		if (!IS_SGI_PPI(intr_num)) {
304 			continue;
305 		}
306 
307 		/* Configure this interrupt as a secure interrupt */
308 		gicr_clr_igroupr(gicr_base, intr_num);
309 
310 		/* Configure this interrupt as G0 or a G1S interrupt */
311 		assert((current_prop->intr_grp == INTR_GROUP0) ||
312 			(current_prop->intr_grp == INTR_GROUP1S));
313 
314 		if (current_prop->intr_grp == INTR_GROUP1S) {
315 			gicr_set_igrpmodr(gicr_base, intr_num);
316 			ctlr_enable |= CTLR_ENABLE_G1S_BIT;
317 		} else {
318 			gicr_clr_igrpmodr(gicr_base, intr_num);
319 			ctlr_enable |= CTLR_ENABLE_G0_BIT;
320 		}
321 
322 		/* Set the priority of this interrupt */
323 		gicr_set_ipriorityr(gicr_base, intr_num,
324 					current_prop->intr_pri);
325 
326 		/*
327 		 * Set interrupt configuration for (E)PPIs.
328 		 * Configurations for SGIs 0-15 are ignored.
329 		 */
330 		if (intr_num >= MIN_PPI_ID) {
331 			gicr_set_icfgr(gicr_base, intr_num,
332 					current_prop->intr_cfg);
333 		}
334 
335 		/* Enable this interrupt */
336 		gicr_set_isenabler(gicr_base, intr_num);
337 	}
338 
339 	return ctlr_enable;
340 }
341 
342 /**
343  * gicv3_rdistif_get_number_frames() - determine size of GICv3 GICR region
344  * @gicr_frame: base address of the GICR region to check
345  *
346  * This iterates over the GICR_TYPER registers of multiple GICR frames in
347  * a GICR region, to find the instance which has the LAST bit set. For most
348  * systems this corresponds to the number of cores handled by a redistributor,
349  * but there could be disabled cores among them.
350  * It assumes that each GICR region is fully accessible (till the LAST bit
351  * marks the end of the region).
352  * If a platform has multiple GICR regions, this function would need to be
353  * called multiple times, providing the respective GICR base address each time.
354  *
355  * Return: number of valid GICR frames (at least 1, up to PLATFORM_CORE_COUNT)
356  ******************************************************************************/
357 unsigned int gicv3_rdistif_get_number_frames(const uintptr_t gicr_frame)
358 {
359 	uintptr_t rdistif_base = gicr_frame;
360 	unsigned int count;
361 
362 	for (count = 1; count < PLATFORM_CORE_COUNT; count++) {
363 		if ((gicr_read_typer(rdistif_base) & TYPER_LAST_BIT) != 0U) {
364 			break;
365 		}
366 		rdistif_base += (1U << GICR_PCPUBASE_SHIFT);
367 	}
368 
369 	return count;
370 }
371