xref: /rk3399_ARM-atf/lib/gpt_rme/gpt_rme.c (revision 09a4bcb81bc37def40ecb638b121e00e05bcbcbd)
1f19dc624Sjohpow01 /*
2b0f1c840SAlexeiFedorov  * Copyright (c) 2022-2025, Arm Limited. All rights reserved.
3f19dc624Sjohpow01  *
4f19dc624Sjohpow01  * SPDX-License-Identifier: BSD-3-Clause
5f19dc624Sjohpow01  */
6f19dc624Sjohpow01 
7f19dc624Sjohpow01 #include <assert.h>
8f19dc624Sjohpow01 #include <errno.h>
92461bd3aSManish Pandey #include <inttypes.h>
10f19dc624Sjohpow01 #include <limits.h>
11f19dc624Sjohpow01 #include <stdint.h>
12f19dc624Sjohpow01 
13f19dc624Sjohpow01 #include <arch.h>
1462d64652SOlivier Deprez #include <arch_features.h>
15f19dc624Sjohpow01 #include <common/debug.h>
16f19dc624Sjohpow01 #include <lib/gpt_rme/gpt_rme.h>
17f19dc624Sjohpow01 #include <lib/smccc.h>
18f19dc624Sjohpow01 #include <lib/xlat_tables/xlat_tables_v2.h>
19f19dc624Sjohpow01 
20b0f1c840SAlexeiFedorov #include "gpt_rme_private.h"
21b0f1c840SAlexeiFedorov 
22f19dc624Sjohpow01 #if !ENABLE_RME
23b99926efSAlexeiFedorov #error "ENABLE_RME must be enabled to use the GPT library"
24f19dc624Sjohpow01 #endif
25f19dc624Sjohpow01 
26f19dc624Sjohpow01 /*
27f19dc624Sjohpow01  * Lookup T from PPS
28f19dc624Sjohpow01  *
29f19dc624Sjohpow01  *   PPS    Size    T
30f19dc624Sjohpow01  *   0b000  4GB     32
31f19dc624Sjohpow01  *   0b001  64GB    36
32f19dc624Sjohpow01  *   0b010  1TB     40
33f19dc624Sjohpow01  *   0b011  4TB     42
34f19dc624Sjohpow01  *   0b100  16TB    44
35f19dc624Sjohpow01  *   0b101  256TB   48
36f19dc624Sjohpow01  *   0b110  4PB     52
37f19dc624Sjohpow01  *
38f19dc624Sjohpow01  * See section 15.1.27 of the RME specification.
39f19dc624Sjohpow01  */
40f19dc624Sjohpow01 static const gpt_t_val_e gpt_t_lookup[] = {PPS_4GB_T, PPS_64GB_T,
41f19dc624Sjohpow01 					   PPS_1TB_T, PPS_4TB_T,
42f19dc624Sjohpow01 					   PPS_16TB_T, PPS_256TB_T,
43f19dc624Sjohpow01 					   PPS_4PB_T};
44f19dc624Sjohpow01 
45f19dc624Sjohpow01 /*
46f19dc624Sjohpow01  * Lookup P from PGS
47f19dc624Sjohpow01  *
48f19dc624Sjohpow01  *   PGS    Size    P
49f19dc624Sjohpow01  *   0b00   4KB     12
50f19dc624Sjohpow01  *   0b10   16KB    14
51f19dc624Sjohpow01  *   0b01   64KB    16
52f19dc624Sjohpow01  *
53f19dc624Sjohpow01  * Note that pgs=0b10 is 16KB and pgs=0b01 is 64KB, this is not a typo.
54f19dc624Sjohpow01  *
55f19dc624Sjohpow01  * See section 15.1.27 of the RME specification.
56f19dc624Sjohpow01  */
57f19dc624Sjohpow01 static const gpt_p_val_e gpt_p_lookup[] = {PGS_4KB_P, PGS_64KB_P, PGS_16KB_P};
58f19dc624Sjohpow01 
59ec0088bbSAlexeiFedorov static void shatter_2mb(uintptr_t base, const gpi_info_t *gpi_info,
60ec0088bbSAlexeiFedorov 				uint64_t l1_desc);
61ec0088bbSAlexeiFedorov static void shatter_32mb(uintptr_t base, const gpi_info_t *gpi_info,
62ec0088bbSAlexeiFedorov 				uint64_t l1_desc);
63ec0088bbSAlexeiFedorov static void shatter_512mb(uintptr_t base, const gpi_info_t *gpi_info,
64ec0088bbSAlexeiFedorov 				uint64_t l1_desc);
65ec0088bbSAlexeiFedorov 
66f19dc624Sjohpow01 /*
67b99926efSAlexeiFedorov  * This structure contains GPT configuration data
68f19dc624Sjohpow01  */
69f19dc624Sjohpow01 typedef struct {
70f19dc624Sjohpow01 	uintptr_t plat_gpt_l0_base;
71f19dc624Sjohpow01 	gpccr_pps_e pps;
72f19dc624Sjohpow01 	gpt_t_val_e t;
73f19dc624Sjohpow01 	gpccr_pgs_e pgs;
74f19dc624Sjohpow01 	gpt_p_val_e p;
75f19dc624Sjohpow01 } gpt_config_t;
76f19dc624Sjohpow01 
77f19dc624Sjohpow01 static gpt_config_t gpt_config;
78f19dc624Sjohpow01 
79ec0088bbSAlexeiFedorov /*
80ec0088bbSAlexeiFedorov  * Number of L1 entries in 2MB, depending on GPCCR_EL3.PGS:
81ec0088bbSAlexeiFedorov  * +-------+------------+
82ec0088bbSAlexeiFedorov  * |  PGS  | L1 entries |
83ec0088bbSAlexeiFedorov  * +-------+------------+
84ec0088bbSAlexeiFedorov  * |  4KB  |     32     |
85ec0088bbSAlexeiFedorov  * +-------+------------+
86ec0088bbSAlexeiFedorov  * |  16KB |     8      |
87ec0088bbSAlexeiFedorov  * +-------+------------+
88ec0088bbSAlexeiFedorov  * |  64KB |     2      |
89ec0088bbSAlexeiFedorov  * +-------+------------+
90ec0088bbSAlexeiFedorov  */
91ec0088bbSAlexeiFedorov static unsigned int gpt_l1_cnt_2mb;
92ec0088bbSAlexeiFedorov 
93ec0088bbSAlexeiFedorov /*
94ec0088bbSAlexeiFedorov  * Mask for the L1 index field, depending on
95ec0088bbSAlexeiFedorov  * GPCCR_EL3.L0GPTSZ and GPCCR_EL3.PGS:
96ec0088bbSAlexeiFedorov  * +---------+-------------------------------+
97ec0088bbSAlexeiFedorov  * |         |             PGS               |
98ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
99ec0088bbSAlexeiFedorov  * | L0GPTSZ |   4KB    |   16KB   |   64KB  |
100ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
101ec0088bbSAlexeiFedorov  * |  1GB    |  0x3FFF  |  0xFFF   |  0x3FF  |
102ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
103ec0088bbSAlexeiFedorov  * |  16GB   | 0x3FFFF  |  0xFFFF  | 0x3FFF  |
104ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
105ec0088bbSAlexeiFedorov  * |  64GB   | 0xFFFFF  | 0x3FFFF  | 0xFFFF  |
106ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
107ec0088bbSAlexeiFedorov  * |  512GB  | 0x7FFFFF | 0x1FFFFF | 0x7FFFF |
108ec0088bbSAlexeiFedorov  * +---------+----------+----------+---------+
109ec0088bbSAlexeiFedorov  */
110ec0088bbSAlexeiFedorov static uint64_t gpt_l1_index_mask;
111ec0088bbSAlexeiFedorov 
112ec0088bbSAlexeiFedorov /* Number of 128-bit L1 entries in 2MB, 32MB and 512MB */
113ec0088bbSAlexeiFedorov #define L1_QWORDS_2MB	(gpt_l1_cnt_2mb / 2U)
114ec0088bbSAlexeiFedorov #define L1_QWORDS_32MB	(L1_QWORDS_2MB * 16U)
115ec0088bbSAlexeiFedorov #define L1_QWORDS_512MB	(L1_QWORDS_32MB * 16U)
116ec0088bbSAlexeiFedorov 
117ec0088bbSAlexeiFedorov /* Size in bytes of L1 entries in 2MB, 32MB */
118ec0088bbSAlexeiFedorov #define L1_BYTES_2MB	(gpt_l1_cnt_2mb * sizeof(uint64_t))
119ec0088bbSAlexeiFedorov #define L1_BYTES_32MB	(L1_BYTES_2MB * 16U)
120ec0088bbSAlexeiFedorov 
121ec0088bbSAlexeiFedorov /* Get the index into the L1 table from a physical address */
122ec0088bbSAlexeiFedorov #define GPT_L1_INDEX(_pa)	\
123ec0088bbSAlexeiFedorov 	(((_pa) >> (unsigned int)GPT_L1_IDX_SHIFT(gpt_config.p)) & gpt_l1_index_mask)
124ec0088bbSAlexeiFedorov 
125b0f1c840SAlexeiFedorov /* This variable is used during initialization of the L1 tables */
126f19dc624Sjohpow01 static uintptr_t gpt_l1_tbl;
127f19dc624Sjohpow01 
128b0f1c840SAlexeiFedorov /* These variables are used during runtime */
129d766084fSAlexeiFedorov #if (RME_GPT_BITLOCK_BLOCK == 0)
130d766084fSAlexeiFedorov /*
131d766084fSAlexeiFedorov  * The GPTs are protected by a global spinlock to ensure
132d766084fSAlexeiFedorov  * that multiple CPUs do not attempt to change the descriptors at once.
133d766084fSAlexeiFedorov  */
134d766084fSAlexeiFedorov static spinlock_t gpt_lock;
135ec0088bbSAlexeiFedorov 
136b0f1c840SAlexeiFedorov /* Lock/unlock macros for GPT entries
137b0f1c840SAlexeiFedorov  *
138d766084fSAlexeiFedorov  * Access to GPT is controlled by a global lock to ensure
139d766084fSAlexeiFedorov  * that no more than one CPU is allowed to make changes at any
140d766084fSAlexeiFedorov  * given time.
141d766084fSAlexeiFedorov  */
142d766084fSAlexeiFedorov #define GPT_LOCK	spin_lock(&gpt_lock)
143d766084fSAlexeiFedorov #define GPT_UNLOCK	spin_unlock(&gpt_lock)
144d766084fSAlexeiFedorov #else
145b0f1c840SAlexeiFedorov 
146b0f1c840SAlexeiFedorov /* Base address of bitlocks array */
147b0f1c840SAlexeiFedorov static bitlock_t *gpt_bitlock;
148b0f1c840SAlexeiFedorov 
149d766084fSAlexeiFedorov /*
150d766084fSAlexeiFedorov  * Access to a block of memory is controlled by a bitlock.
151d766084fSAlexeiFedorov  * Size of block = RME_GPT_BITLOCK_BLOCK * 512MB.
152d766084fSAlexeiFedorov  */
153d766084fSAlexeiFedorov #define GPT_LOCK	bit_lock(gpi_info.lock, gpi_info.mask)
154d766084fSAlexeiFedorov #define GPT_UNLOCK	bit_unlock(gpi_info.lock, gpi_info.mask)
155b0f1c840SAlexeiFedorov #endif /* RME_GPT_BITLOCK_BLOCK */
156ec0088bbSAlexeiFedorov 
157ec0088bbSAlexeiFedorov static void tlbi_page_dsbosh(uintptr_t base)
158ec0088bbSAlexeiFedorov {
159ec0088bbSAlexeiFedorov 	/* Look-up table for invalidation TLBs for 4KB, 16KB and 64KB pages */
160ec0088bbSAlexeiFedorov 	static const gpt_tlbi_lookup_t tlbi_page_lookup[] = {
161ec0088bbSAlexeiFedorov 		{ tlbirpalos_4k, ~(SZ_4K - 1UL) },
162ec0088bbSAlexeiFedorov 		{ tlbirpalos_64k, ~(SZ_64K - 1UL) },
163ec0088bbSAlexeiFedorov 		{ tlbirpalos_16k, ~(SZ_16K - 1UL) }
164ec0088bbSAlexeiFedorov 	};
165ec0088bbSAlexeiFedorov 
166ec0088bbSAlexeiFedorov 	tlbi_page_lookup[gpt_config.pgs].function(
167ec0088bbSAlexeiFedorov 			base & tlbi_page_lookup[gpt_config.pgs].mask);
168ec0088bbSAlexeiFedorov 	dsbosh();
169ec0088bbSAlexeiFedorov }
170ec0088bbSAlexeiFedorov 
171ec0088bbSAlexeiFedorov /*
172ec0088bbSAlexeiFedorov  * Helper function to fill out GPI entries in a single L1 table
173ec0088bbSAlexeiFedorov  * with Granules or Contiguous descriptor.
174ec0088bbSAlexeiFedorov  *
175ec0088bbSAlexeiFedorov  * Parameters
176ec0088bbSAlexeiFedorov  *   l1			Pointer to 2MB, 32MB or 512MB aligned L1 table entry to fill out
177ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules or Contiguous descriptor set this range to
178ec0088bbSAlexeiFedorov  *   cnt		Number of double 128-bit L1 entries to fill
179ec0088bbSAlexeiFedorov  *
180ec0088bbSAlexeiFedorov  */
181ec0088bbSAlexeiFedorov static void fill_desc(uint64_t *l1, uint64_t l1_desc, unsigned int cnt)
182ec0088bbSAlexeiFedorov {
183ec0088bbSAlexeiFedorov 	uint128_t *l1_quad = (uint128_t *)l1;
184ec0088bbSAlexeiFedorov 	uint128_t l1_quad_desc = (uint128_t)l1_desc | ((uint128_t)l1_desc << 64);
185ec0088bbSAlexeiFedorov 
186ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(%p 0x%"PRIx64" %u)\n", __func__, l1, l1_desc, cnt);
187ec0088bbSAlexeiFedorov 
188ec0088bbSAlexeiFedorov 	for (unsigned int i = 0U; i < cnt; i++) {
189ec0088bbSAlexeiFedorov 		*l1_quad++ = l1_quad_desc;
190ec0088bbSAlexeiFedorov 	}
191ec0088bbSAlexeiFedorov }
192ec0088bbSAlexeiFedorov 
193ec0088bbSAlexeiFedorov static void shatter_2mb(uintptr_t base, const gpi_info_t *gpi_info,
194ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
195ec0088bbSAlexeiFedorov {
196ec0088bbSAlexeiFedorov 	unsigned long idx = GPT_L1_INDEX(ALIGN_2MB(base));
197ec0088bbSAlexeiFedorov 
198ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n",
199ec0088bbSAlexeiFedorov 				__func__, base, l1_desc);
200ec0088bbSAlexeiFedorov 
201ec0088bbSAlexeiFedorov 	/* Convert 2MB Contiguous block to Granules */
202ec0088bbSAlexeiFedorov 	fill_desc(&gpi_info->gpt_l1_addr[idx], l1_desc, L1_QWORDS_2MB);
203ec0088bbSAlexeiFedorov }
204ec0088bbSAlexeiFedorov 
205ec0088bbSAlexeiFedorov static void shatter_32mb(uintptr_t base, const gpi_info_t *gpi_info,
206ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
207ec0088bbSAlexeiFedorov {
208ec0088bbSAlexeiFedorov 	unsigned long idx = GPT_L1_INDEX(ALIGN_2MB(base));
209ec0088bbSAlexeiFedorov 	const uint64_t *l1_gran = &gpi_info->gpt_l1_addr[idx];
210ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 2MB);
211ec0088bbSAlexeiFedorov 	uint64_t *l1;
212ec0088bbSAlexeiFedorov 
213ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n",
214ec0088bbSAlexeiFedorov 				__func__, base, l1_desc);
215ec0088bbSAlexeiFedorov 
216ec0088bbSAlexeiFedorov 	/* Get index corresponding to 32MB aligned address */
217ec0088bbSAlexeiFedorov 	idx = GPT_L1_INDEX(ALIGN_32MB(base));
218ec0088bbSAlexeiFedorov 	l1 = &gpi_info->gpt_l1_addr[idx];
219ec0088bbSAlexeiFedorov 
220ec0088bbSAlexeiFedorov 	/* 16 x 2MB blocks in 32MB */
221ec0088bbSAlexeiFedorov 	for (unsigned int i = 0U; i < 16U; i++) {
222ec0088bbSAlexeiFedorov 		/* Fill with Granules or Contiguous descriptors */
223ec0088bbSAlexeiFedorov 		fill_desc(l1, (l1 == l1_gran) ? l1_desc : l1_cont_desc,
224ec0088bbSAlexeiFedorov 							L1_QWORDS_2MB);
225ec0088bbSAlexeiFedorov 		l1 = (uint64_t *)((uintptr_t)l1 + L1_BYTES_2MB);
226ec0088bbSAlexeiFedorov 	}
227ec0088bbSAlexeiFedorov }
228ec0088bbSAlexeiFedorov 
229ec0088bbSAlexeiFedorov static void shatter_512mb(uintptr_t base, const gpi_info_t *gpi_info,
230ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
231ec0088bbSAlexeiFedorov {
232ec0088bbSAlexeiFedorov 	unsigned long idx = GPT_L1_INDEX(ALIGN_32MB(base));
233ec0088bbSAlexeiFedorov 	const uint64_t *l1_32mb = &gpi_info->gpt_l1_addr[idx];
234ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 32MB);
235ec0088bbSAlexeiFedorov 	uint64_t *l1;
236ec0088bbSAlexeiFedorov 
237ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n",
238ec0088bbSAlexeiFedorov 				__func__, base, l1_desc);
239ec0088bbSAlexeiFedorov 
240ec0088bbSAlexeiFedorov 	/* Get index corresponding to 512MB aligned address */
241ec0088bbSAlexeiFedorov 	idx = GPT_L1_INDEX(ALIGN_512MB(base));
242ec0088bbSAlexeiFedorov 	l1 = &gpi_info->gpt_l1_addr[idx];
243ec0088bbSAlexeiFedorov 
244ec0088bbSAlexeiFedorov 	/* 16 x 32MB blocks in 512MB */
245ec0088bbSAlexeiFedorov 	for (unsigned int i = 0U; i < 16U; i++) {
246ec0088bbSAlexeiFedorov 		if (l1 == l1_32mb) {
247ec0088bbSAlexeiFedorov 			/* Shatter this 32MB block */
248ec0088bbSAlexeiFedorov 			shatter_32mb(base, gpi_info, l1_desc);
249ec0088bbSAlexeiFedorov 		} else {
250ec0088bbSAlexeiFedorov 			/* Fill 32MB with Contiguous descriptors */
251ec0088bbSAlexeiFedorov 			fill_desc(l1, l1_cont_desc, L1_QWORDS_32MB);
252ec0088bbSAlexeiFedorov 		}
253ec0088bbSAlexeiFedorov 
254ec0088bbSAlexeiFedorov 		l1 = (uint64_t *)((uintptr_t)l1 + L1_BYTES_32MB);
255ec0088bbSAlexeiFedorov 	}
256ec0088bbSAlexeiFedorov }
257ec0088bbSAlexeiFedorov 
258f19dc624Sjohpow01 /*
259f19dc624Sjohpow01  * This function checks to see if a GPI value is valid.
260f19dc624Sjohpow01  *
261f19dc624Sjohpow01  * These are valid GPI values.
262f19dc624Sjohpow01  *   GPT_GPI_NO_ACCESS   U(0x0)
263f19dc624Sjohpow01  *   GPT_GPI_SECURE      U(0x8)
264f19dc624Sjohpow01  *   GPT_GPI_NS          U(0x9)
265f19dc624Sjohpow01  *   GPT_GPI_ROOT        U(0xA)
266f19dc624Sjohpow01  *   GPT_GPI_REALM       U(0xB)
267*09a4bcb8SGirish Pathak  *   GPT_GPI_NSO         U(0xD)
268f19dc624Sjohpow01  *   GPT_GPI_ANY         U(0xF)
269f19dc624Sjohpow01  *
270f19dc624Sjohpow01  * Parameters
271f19dc624Sjohpow01  *   gpi		GPI to check for validity.
272f19dc624Sjohpow01  *
273f19dc624Sjohpow01  * Return
274f19dc624Sjohpow01  *   true for a valid GPI, false for an invalid one.
275f19dc624Sjohpow01  */
27620e2683dSAlexeiFedorov static bool is_gpi_valid(unsigned int gpi)
277f19dc624Sjohpow01 {
278*09a4bcb8SGirish Pathak 	switch (gpi) {
279*09a4bcb8SGirish Pathak 	case GPT_GPI_NO_ACCESS:
280*09a4bcb8SGirish Pathak 	case GPT_GPI_SECURE:
281*09a4bcb8SGirish Pathak 	case GPT_GPI_NS:
282*09a4bcb8SGirish Pathak 	case GPT_GPI_ROOT:
283*09a4bcb8SGirish Pathak 	case GPT_GPI_REALM:
284*09a4bcb8SGirish Pathak 	case GPT_GPI_ANY:
285f19dc624Sjohpow01 		return true;
286*09a4bcb8SGirish Pathak 	case GPT_GPI_NSO:
287*09a4bcb8SGirish Pathak 		return is_feat_rme_gpc2_present();
288*09a4bcb8SGirish Pathak 	default:
2896a00e9b0SRobert Wakim 		return false;
290f19dc624Sjohpow01 	}
291*09a4bcb8SGirish Pathak }
292f19dc624Sjohpow01 
293f19dc624Sjohpow01 /*
294f19dc624Sjohpow01  * This function checks to see if two PAS regions overlap.
295f19dc624Sjohpow01  *
296f19dc624Sjohpow01  * Parameters
297f19dc624Sjohpow01  *   base_1: base address of first PAS
298f19dc624Sjohpow01  *   size_1: size of first PAS
299f19dc624Sjohpow01  *   base_2: base address of second PAS
300f19dc624Sjohpow01  *   size_2: size of second PAS
301f19dc624Sjohpow01  *
302f19dc624Sjohpow01  * Return
303f19dc624Sjohpow01  *   True if PAS regions overlap, false if they do not.
304f19dc624Sjohpow01  */
30520e2683dSAlexeiFedorov static bool check_pas_overlap(uintptr_t base_1, size_t size_1,
306f19dc624Sjohpow01 			      uintptr_t base_2, size_t size_2)
307f19dc624Sjohpow01 {
308f19dc624Sjohpow01 	if (((base_1 + size_1) > base_2) && ((base_2 + size_2) > base_1)) {
309f19dc624Sjohpow01 		return true;
310f19dc624Sjohpow01 	}
3116a00e9b0SRobert Wakim 	return false;
312f19dc624Sjohpow01 }
313f19dc624Sjohpow01 
314f19dc624Sjohpow01 /*
315f19dc624Sjohpow01  * This helper function checks to see if a PAS region from index 0 to
316f19dc624Sjohpow01  * (pas_idx - 1) occupies the L0 region at index l0_idx in the L0 table.
317f19dc624Sjohpow01  *
318f19dc624Sjohpow01  * Parameters
319f19dc624Sjohpow01  *   l0_idx:      Index of the L0 entry to check
320f19dc624Sjohpow01  *   pas_regions: PAS region array
321f19dc624Sjohpow01  *   pas_idx:     Upper bound of the PAS array index.
322f19dc624Sjohpow01  *
323f19dc624Sjohpow01  * Return
324f19dc624Sjohpow01  *   True if a PAS region occupies the L0 region in question, false if not.
325f19dc624Sjohpow01  */
32620e2683dSAlexeiFedorov static bool does_previous_pas_exist_here(unsigned int l0_idx,
327f19dc624Sjohpow01 					 pas_region_t *pas_regions,
328f19dc624Sjohpow01 					 unsigned int pas_idx)
329f19dc624Sjohpow01 {
330b99926efSAlexeiFedorov 	/* Iterate over PAS regions up to pas_idx */
331f19dc624Sjohpow01 	for (unsigned int i = 0U; i < pas_idx; i++) {
33220e2683dSAlexeiFedorov 		if (check_pas_overlap((GPT_L0GPTSZ_ACTUAL_SIZE * l0_idx),
333f19dc624Sjohpow01 		    GPT_L0GPTSZ_ACTUAL_SIZE,
334f19dc624Sjohpow01 		    pas_regions[i].base_pa, pas_regions[i].size)) {
335f19dc624Sjohpow01 			return true;
336f19dc624Sjohpow01 		}
337f19dc624Sjohpow01 	}
338f19dc624Sjohpow01 	return false;
339f19dc624Sjohpow01 }
340f19dc624Sjohpow01 
341f19dc624Sjohpow01 /*
342f19dc624Sjohpow01  * This function iterates over all of the PAS regions and checks them to ensure
343f19dc624Sjohpow01  * proper alignment of base and size, that the GPI is valid, and that no regions
344f19dc624Sjohpow01  * overlap. As a part of the overlap checks, this function checks existing L0
345f19dc624Sjohpow01  * mappings against the new PAS regions in the event that gpt_init_pas_l1_tables
346f19dc624Sjohpow01  * is called multiple times to place L1 tables in different areas of memory. It
347f19dc624Sjohpow01  * also counts the number of L1 tables needed and returns it on success.
348f19dc624Sjohpow01  *
349f19dc624Sjohpow01  * Parameters
350f19dc624Sjohpow01  *   *pas_regions	Pointer to array of PAS region structures.
351f19dc624Sjohpow01  *   pas_region_cnt	Total number of PAS regions in the array.
352f19dc624Sjohpow01  *
353f19dc624Sjohpow01  * Return
354f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, number of L1 regions
355f19dc624Sjohpow01  *   required when successful.
356f19dc624Sjohpow01  */
35720e2683dSAlexeiFedorov static int validate_pas_mappings(pas_region_t *pas_regions,
358f19dc624Sjohpow01 				 unsigned int pas_region_cnt)
359f19dc624Sjohpow01 {
360f19dc624Sjohpow01 	unsigned int idx;
361f19dc624Sjohpow01 	unsigned int l1_cnt = 0U;
362f19dc624Sjohpow01 	unsigned int pas_l1_cnt;
363f19dc624Sjohpow01 	uint64_t *l0_desc = (uint64_t *)gpt_config.plat_gpt_l0_base;
364f19dc624Sjohpow01 
365f19dc624Sjohpow01 	assert(pas_regions != NULL);
366f19dc624Sjohpow01 	assert(pas_region_cnt != 0U);
367f19dc624Sjohpow01 
368f19dc624Sjohpow01 	for (idx = 0U; idx < pas_region_cnt; idx++) {
369b99926efSAlexeiFedorov 		/* Check for arithmetic overflow in region */
370f19dc624Sjohpow01 		if ((ULONG_MAX - pas_regions[idx].base_pa) <
371f19dc624Sjohpow01 		    pas_regions[idx].size) {
372b99926efSAlexeiFedorov 			ERROR("GPT: Address overflow in PAS[%u]!\n", idx);
373f19dc624Sjohpow01 			return -EOVERFLOW;
374f19dc624Sjohpow01 		}
375f19dc624Sjohpow01 
376b99926efSAlexeiFedorov 		/* Initial checks for PAS validity */
377f19dc624Sjohpow01 		if (((pas_regions[idx].base_pa + pas_regions[idx].size) >
378f19dc624Sjohpow01 		    GPT_PPS_ACTUAL_SIZE(gpt_config.t)) ||
37920e2683dSAlexeiFedorov 		    !is_gpi_valid(GPT_PAS_ATTR_GPI(pas_regions[idx].attrs))) {
380b99926efSAlexeiFedorov 			ERROR("GPT: PAS[%u] is invalid!\n", idx);
381f19dc624Sjohpow01 			return -EFAULT;
382f19dc624Sjohpow01 		}
383f19dc624Sjohpow01 
384f19dc624Sjohpow01 		/*
385f19dc624Sjohpow01 		 * Make sure this PAS does not overlap with another one. We
386f19dc624Sjohpow01 		 * start from idx + 1 instead of 0 since prior PAS mappings will
387f19dc624Sjohpow01 		 * have already checked themselves against this one.
388f19dc624Sjohpow01 		 */
389b99926efSAlexeiFedorov 		for (unsigned int i = idx + 1U; i < pas_region_cnt; i++) {
39020e2683dSAlexeiFedorov 			if (check_pas_overlap(pas_regions[idx].base_pa,
391f19dc624Sjohpow01 			    pas_regions[idx].size,
392f19dc624Sjohpow01 			    pas_regions[i].base_pa,
393f19dc624Sjohpow01 			    pas_regions[i].size)) {
394b99926efSAlexeiFedorov 				ERROR("GPT: PAS[%u] overlaps with PAS[%u]\n",
395f19dc624Sjohpow01 					i, idx);
396f19dc624Sjohpow01 				return -EFAULT;
397f19dc624Sjohpow01 			}
398f19dc624Sjohpow01 		}
399f19dc624Sjohpow01 
400f19dc624Sjohpow01 		/*
401f19dc624Sjohpow01 		 * Since this function can be called multiple times with
402f19dc624Sjohpow01 		 * separate L1 tables we need to check the existing L0 mapping
403f19dc624Sjohpow01 		 * to see if this PAS would fall into one that has already been
404f19dc624Sjohpow01 		 * initialized.
405f19dc624Sjohpow01 		 */
406ec0088bbSAlexeiFedorov 		for (unsigned int i =
407ec0088bbSAlexeiFedorov 			(unsigned int)GPT_L0_IDX(pas_regions[idx].base_pa);
408b99926efSAlexeiFedorov 			i <= GPT_L0_IDX(pas_regions[idx].base_pa +
409b99926efSAlexeiFedorov 					pas_regions[idx].size - 1UL);
410f19dc624Sjohpow01 			i++) {
411f19dc624Sjohpow01 			if ((GPT_L0_TYPE(l0_desc[i]) == GPT_L0_TYPE_BLK_DESC) &&
412f19dc624Sjohpow01 			    (GPT_L0_BLKD_GPI(l0_desc[i]) == GPT_GPI_ANY)) {
413b99926efSAlexeiFedorov 				/* This descriptor is unused so continue */
414f19dc624Sjohpow01 				continue;
415f19dc624Sjohpow01 			}
416f19dc624Sjohpow01 
417f19dc624Sjohpow01 			/*
418f19dc624Sjohpow01 			 * This descriptor has been initialized in a previous
419f19dc624Sjohpow01 			 * call to this function so cannot be initialized again.
420f19dc624Sjohpow01 			 */
421ec0088bbSAlexeiFedorov 			ERROR("GPT: PAS[%u] overlaps with previous L0[%u]!\n",
422f19dc624Sjohpow01 			      idx, i);
423f19dc624Sjohpow01 			return -EFAULT;
424f19dc624Sjohpow01 		}
425f19dc624Sjohpow01 
426b99926efSAlexeiFedorov 		/* Check for block mapping (L0) type */
427f19dc624Sjohpow01 		if (GPT_PAS_ATTR_MAP_TYPE(pas_regions[idx].attrs) ==
428f19dc624Sjohpow01 		    GPT_PAS_ATTR_MAP_TYPE_BLOCK) {
429b99926efSAlexeiFedorov 			/* Make sure base and size are block-aligned */
430f19dc624Sjohpow01 			if (!GPT_IS_L0_ALIGNED(pas_regions[idx].base_pa) ||
431f19dc624Sjohpow01 			    !GPT_IS_L0_ALIGNED(pas_regions[idx].size)) {
432b99926efSAlexeiFedorov 				ERROR("GPT: PAS[%u] is not block-aligned!\n",
433f19dc624Sjohpow01 				      idx);
434f19dc624Sjohpow01 				return -EFAULT;
435f19dc624Sjohpow01 			}
436f19dc624Sjohpow01 
437f19dc624Sjohpow01 			continue;
438f19dc624Sjohpow01 		}
439f19dc624Sjohpow01 
440b99926efSAlexeiFedorov 		/* Check for granule mapping (L1) type */
441f19dc624Sjohpow01 		if (GPT_PAS_ATTR_MAP_TYPE(pas_regions[idx].attrs) ==
442f19dc624Sjohpow01 		    GPT_PAS_ATTR_MAP_TYPE_GRANULE) {
443b99926efSAlexeiFedorov 			/* Make sure base and size are granule-aligned */
444f19dc624Sjohpow01 			if (!GPT_IS_L1_ALIGNED(gpt_config.p, pas_regions[idx].base_pa) ||
445f19dc624Sjohpow01 			    !GPT_IS_L1_ALIGNED(gpt_config.p, pas_regions[idx].size)) {
446b99926efSAlexeiFedorov 				ERROR("GPT: PAS[%u] is not granule-aligned!\n",
447f19dc624Sjohpow01 				      idx);
448f19dc624Sjohpow01 				return -EFAULT;
449f19dc624Sjohpow01 			}
450f19dc624Sjohpow01 
451b99926efSAlexeiFedorov 			/* Find how many L1 tables this PAS occupies */
452f19dc624Sjohpow01 			pas_l1_cnt = (GPT_L0_IDX(pas_regions[idx].base_pa +
453b99926efSAlexeiFedorov 				     pas_regions[idx].size - 1UL) -
454b99926efSAlexeiFedorov 				     GPT_L0_IDX(pas_regions[idx].base_pa) + 1U);
455f19dc624Sjohpow01 
456f19dc624Sjohpow01 			/*
457f19dc624Sjohpow01 			 * This creates a situation where, if multiple PAS
458f19dc624Sjohpow01 			 * regions occupy the same table descriptor, we can get
459f19dc624Sjohpow01 			 * an artificially high total L1 table count. The way we
460f19dc624Sjohpow01 			 * handle this is by checking each PAS against those
461f19dc624Sjohpow01 			 * before it in the array, and if they both occupy the
462f19dc624Sjohpow01 			 * same PAS we subtract from pas_l1_cnt and only the
463f19dc624Sjohpow01 			 * first PAS in the array gets to count it.
464f19dc624Sjohpow01 			 */
465f19dc624Sjohpow01 
466f19dc624Sjohpow01 			/*
467f19dc624Sjohpow01 			 * If L1 count is greater than 1 we know the start and
468f19dc624Sjohpow01 			 * end PAs are in different L0 regions so we must check
469f19dc624Sjohpow01 			 * both for overlap against other PAS.
470f19dc624Sjohpow01 			 */
471f19dc624Sjohpow01 			if (pas_l1_cnt > 1) {
47220e2683dSAlexeiFedorov 				if (does_previous_pas_exist_here(
473f19dc624Sjohpow01 				    GPT_L0_IDX(pas_regions[idx].base_pa +
474b99926efSAlexeiFedorov 				    pas_regions[idx].size - 1UL),
475f19dc624Sjohpow01 				    pas_regions, idx)) {
476b99926efSAlexeiFedorov 					pas_l1_cnt--;
477f19dc624Sjohpow01 				}
478f19dc624Sjohpow01 			}
479f19dc624Sjohpow01 
48020e2683dSAlexeiFedorov 			if (does_previous_pas_exist_here(
481f19dc624Sjohpow01 			    GPT_L0_IDX(pas_regions[idx].base_pa),
482f19dc624Sjohpow01 			    pas_regions, idx)) {
483b99926efSAlexeiFedorov 				pas_l1_cnt--;
484f19dc624Sjohpow01 			}
485f19dc624Sjohpow01 
486f19dc624Sjohpow01 			l1_cnt += pas_l1_cnt;
487f19dc624Sjohpow01 			continue;
488f19dc624Sjohpow01 		}
489f19dc624Sjohpow01 
490b99926efSAlexeiFedorov 		/* If execution reaches this point, mapping type is invalid */
491b99926efSAlexeiFedorov 		ERROR("GPT: PAS[%u] has invalid mapping type 0x%x.\n", idx,
492f19dc624Sjohpow01 		      GPT_PAS_ATTR_MAP_TYPE(pas_regions[idx].attrs));
493f19dc624Sjohpow01 		return -EINVAL;
494f19dc624Sjohpow01 	}
495f19dc624Sjohpow01 
496f19dc624Sjohpow01 	return l1_cnt;
497f19dc624Sjohpow01 }
498f19dc624Sjohpow01 
499f19dc624Sjohpow01 /*
500f19dc624Sjohpow01  * This function validates L0 initialization parameters.
501f19dc624Sjohpow01  *
502f19dc624Sjohpow01  * Parameters
503b0f1c840SAlexeiFedorov  *   l0_mem_base	Base address of memory used for L0 table.
504b0f1c840SAlexeiFedorov  *   l0_mem_size	Size of memory available for L0 table.
505f19dc624Sjohpow01  *
506f19dc624Sjohpow01  * Return
507f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
508f19dc624Sjohpow01  */
50920e2683dSAlexeiFedorov static int validate_l0_params(gpccr_pps_e pps, uintptr_t l0_mem_base,
510f19dc624Sjohpow01 				size_t l0_mem_size)
511f19dc624Sjohpow01 {
512b0f1c840SAlexeiFedorov 	size_t l0_alignment;
513f19dc624Sjohpow01 
514f19dc624Sjohpow01 	/*
515f19dc624Sjohpow01 	 * Make sure PPS is valid and then store it since macros need this value
516f19dc624Sjohpow01 	 * to work.
517f19dc624Sjohpow01 	 */
518f19dc624Sjohpow01 	if (pps > GPT_PPS_MAX) {
519b99926efSAlexeiFedorov 		ERROR("GPT: Invalid PPS: 0x%x\n", pps);
520f19dc624Sjohpow01 		return -EINVAL;
521f19dc624Sjohpow01 	}
522f19dc624Sjohpow01 	gpt_config.pps = pps;
523f19dc624Sjohpow01 	gpt_config.t = gpt_t_lookup[pps];
524f19dc624Sjohpow01 
525b0f1c840SAlexeiFedorov 	/* Alignment must be the greater of 4KB or L0 table size */
526b0f1c840SAlexeiFedorov 	l0_alignment = SZ_4K;
527f19dc624Sjohpow01 	if (l0_alignment < GPT_L0_TABLE_SIZE(gpt_config.t)) {
528f19dc624Sjohpow01 		l0_alignment = GPT_L0_TABLE_SIZE(gpt_config.t);
529f19dc624Sjohpow01 	}
530f19dc624Sjohpow01 
531b99926efSAlexeiFedorov 	/* Check base address */
532b99926efSAlexeiFedorov 	if ((l0_mem_base == 0UL) ||
533b99926efSAlexeiFedorov 	   ((l0_mem_base & (l0_alignment - 1UL)) != 0UL)) {
534b99926efSAlexeiFedorov 		ERROR("GPT: Invalid L0 base address: 0x%lx\n", l0_mem_base);
535f19dc624Sjohpow01 		return -EFAULT;
536f19dc624Sjohpow01 	}
537f19dc624Sjohpow01 
538b0f1c840SAlexeiFedorov 	/* Check memory size for L0 table */
539b0f1c840SAlexeiFedorov 	if (l0_mem_size < GPT_L0_TABLE_SIZE(gpt_config.t)) {
540d766084fSAlexeiFedorov 		ERROR("GPT: Inadequate L0 memory\n");
541b0f1c840SAlexeiFedorov 		ERROR("      Expected 0x%lx bytes, got 0x%lx\n",
542b0f1c840SAlexeiFedorov 				GPT_L0_TABLE_SIZE(gpt_config.t), l0_mem_size);
543f19dc624Sjohpow01 		return -ENOMEM;
544f19dc624Sjohpow01 	}
545f19dc624Sjohpow01 
546f19dc624Sjohpow01 	return 0;
547f19dc624Sjohpow01 }
548f19dc624Sjohpow01 
549f19dc624Sjohpow01 /*
550f19dc624Sjohpow01  * In the event that L1 tables are needed, this function validates
551f19dc624Sjohpow01  * the L1 table generation parameters.
552f19dc624Sjohpow01  *
553f19dc624Sjohpow01  * Parameters
554f19dc624Sjohpow01  *   l1_mem_base	Base address of memory used for L1 table allocation.
555f19dc624Sjohpow01  *   l1_mem_size	Total size of memory available for L1 tables.
556f19dc624Sjohpow01  *   l1_gpt_cnt		Number of L1 tables needed.
557f19dc624Sjohpow01  *
558f19dc624Sjohpow01  * Return
559f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
560f19dc624Sjohpow01  */
56120e2683dSAlexeiFedorov static int validate_l1_params(uintptr_t l1_mem_base, size_t l1_mem_size,
562f19dc624Sjohpow01 				unsigned int l1_gpt_cnt)
563f19dc624Sjohpow01 {
564f19dc624Sjohpow01 	size_t l1_gpt_mem_sz;
565f19dc624Sjohpow01 
566f19dc624Sjohpow01 	/* Check if the granularity is supported */
567f19dc624Sjohpow01 	if (!xlat_arch_is_granule_size_supported(
568f19dc624Sjohpow01 	    GPT_PGS_ACTUAL_SIZE(gpt_config.p))) {
569f19dc624Sjohpow01 		return -EPERM;
570f19dc624Sjohpow01 	}
571f19dc624Sjohpow01 
572b99926efSAlexeiFedorov 	/* Make sure L1 tables are aligned to their size */
573b99926efSAlexeiFedorov 	if ((l1_mem_base & (GPT_L1_TABLE_SIZE(gpt_config.p) - 1UL)) != 0UL) {
574b99926efSAlexeiFedorov 		ERROR("GPT: Unaligned L1 GPT base address: 0x%"PRIxPTR"\n",
575f19dc624Sjohpow01 		      l1_mem_base);
576f19dc624Sjohpow01 		return -EFAULT;
577f19dc624Sjohpow01 	}
578f19dc624Sjohpow01 
579b99926efSAlexeiFedorov 	/* Get total memory needed for L1 tables */
580f19dc624Sjohpow01 	l1_gpt_mem_sz = l1_gpt_cnt * GPT_L1_TABLE_SIZE(gpt_config.p);
581f19dc624Sjohpow01 
582b99926efSAlexeiFedorov 	/* Check for overflow */
583f19dc624Sjohpow01 	if ((l1_gpt_mem_sz / GPT_L1_TABLE_SIZE(gpt_config.p)) != l1_gpt_cnt) {
584b99926efSAlexeiFedorov 		ERROR("GPT: Overflow calculating L1 memory size\n");
585f19dc624Sjohpow01 		return -ENOMEM;
586f19dc624Sjohpow01 	}
587f19dc624Sjohpow01 
588b99926efSAlexeiFedorov 	/* Make sure enough space was supplied */
589f19dc624Sjohpow01 	if (l1_mem_size < l1_gpt_mem_sz) {
590ec0088bbSAlexeiFedorov 		ERROR("%sL1 GPTs%s", (const char *)"GPT: Inadequate ",
591ec0088bbSAlexeiFedorov 			(const char *)" memory\n");
592b0f1c840SAlexeiFedorov 		ERROR("      Expected 0x%lx bytes, got 0x%lx\n",
593f19dc624Sjohpow01 			l1_gpt_mem_sz, l1_mem_size);
594f19dc624Sjohpow01 		return -ENOMEM;
595f19dc624Sjohpow01 	}
596f19dc624Sjohpow01 
597b99926efSAlexeiFedorov 	VERBOSE("GPT: Requested 0x%lx bytes for L1 GPTs\n", l1_gpt_mem_sz);
598f19dc624Sjohpow01 	return 0;
599f19dc624Sjohpow01 }
600f19dc624Sjohpow01 
601f19dc624Sjohpow01 /*
602f19dc624Sjohpow01  * This function initializes L0 block descriptors (regions that cannot be
603f19dc624Sjohpow01  * transitioned at the granule level) according to the provided PAS.
604f19dc624Sjohpow01  *
605f19dc624Sjohpow01  * Parameters
606f19dc624Sjohpow01  *   *pas		Pointer to the structure defining the PAS region to
607f19dc624Sjohpow01  *			initialize.
608f19dc624Sjohpow01  */
60920e2683dSAlexeiFedorov static void generate_l0_blk_desc(pas_region_t *pas)
610f19dc624Sjohpow01 {
611f19dc624Sjohpow01 	uint64_t gpt_desc;
612ec0088bbSAlexeiFedorov 	unsigned long idx, end_idx;
613f19dc624Sjohpow01 	uint64_t *l0_gpt_arr;
614f19dc624Sjohpow01 
615b0f1c840SAlexeiFedorov 	assert(gpt_config.plat_gpt_l0_base != 0UL);
616f19dc624Sjohpow01 	assert(pas != NULL);
617f19dc624Sjohpow01 
618f19dc624Sjohpow01 	/*
619f19dc624Sjohpow01 	 * Checking of PAS parameters has already been done in
62020e2683dSAlexeiFedorov 	 * validate_pas_mappings so no need to check the same things again.
621f19dc624Sjohpow01 	 */
622f19dc624Sjohpow01 
623f19dc624Sjohpow01 	l0_gpt_arr = (uint64_t *)gpt_config.plat_gpt_l0_base;
624f19dc624Sjohpow01 
625f19dc624Sjohpow01 	/* Create the GPT Block descriptor for this PAS region */
626f19dc624Sjohpow01 	gpt_desc = GPT_L0_BLK_DESC(GPT_PAS_ATTR_GPI(pas->attrs));
627f19dc624Sjohpow01 
628f19dc624Sjohpow01 	/* Start index of this region in L0 GPTs */
6296a00e9b0SRobert Wakim 	idx = GPT_L0_IDX(pas->base_pa);
630f19dc624Sjohpow01 
631f19dc624Sjohpow01 	/*
632f19dc624Sjohpow01 	 * Determine number of L0 GPT descriptors covered by
633f19dc624Sjohpow01 	 * this PAS region and use the count to populate these
634f19dc624Sjohpow01 	 * descriptors.
635f19dc624Sjohpow01 	 */
6366a00e9b0SRobert Wakim 	end_idx = GPT_L0_IDX(pas->base_pa + pas->size);
637f19dc624Sjohpow01 
638b99926efSAlexeiFedorov 	/* Generate the needed block descriptors */
639f19dc624Sjohpow01 	for (; idx < end_idx; idx++) {
640f19dc624Sjohpow01 		l0_gpt_arr[idx] = gpt_desc;
641ec0088bbSAlexeiFedorov 		VERBOSE("GPT: L0 entry (BLOCK) index %lu [%p]: GPI = 0x%"PRIx64" (0x%"PRIx64")\n",
642f19dc624Sjohpow01 			idx, &l0_gpt_arr[idx],
643f19dc624Sjohpow01 			(gpt_desc >> GPT_L0_BLK_DESC_GPI_SHIFT) &
644f19dc624Sjohpow01 			GPT_L0_BLK_DESC_GPI_MASK, l0_gpt_arr[idx]);
645f19dc624Sjohpow01 	}
646f19dc624Sjohpow01 }
647f19dc624Sjohpow01 
648f19dc624Sjohpow01 /*
649f19dc624Sjohpow01  * Helper function to determine if the end physical address lies in the same L0
650f19dc624Sjohpow01  * region as the current physical address. If true, the end physical address is
651f19dc624Sjohpow01  * returned else, the start address of the next region is returned.
652f19dc624Sjohpow01  *
653f19dc624Sjohpow01  * Parameters
654f19dc624Sjohpow01  *   cur_pa		Physical address of the current PA in the loop through
655f19dc624Sjohpow01  *			the range.
656f19dc624Sjohpow01  *   end_pa		Physical address of the end PA in a PAS range.
657f19dc624Sjohpow01  *
658f19dc624Sjohpow01  * Return
659f19dc624Sjohpow01  *   The PA of the end of the current range.
660f19dc624Sjohpow01  */
66120e2683dSAlexeiFedorov static uintptr_t get_l1_end_pa(uintptr_t cur_pa, uintptr_t end_pa)
662f19dc624Sjohpow01 {
663f19dc624Sjohpow01 	uintptr_t cur_idx;
664f19dc624Sjohpow01 	uintptr_t end_idx;
665f19dc624Sjohpow01 
6666a00e9b0SRobert Wakim 	cur_idx = GPT_L0_IDX(cur_pa);
6676a00e9b0SRobert Wakim 	end_idx = GPT_L0_IDX(end_pa);
668f19dc624Sjohpow01 
669f19dc624Sjohpow01 	assert(cur_idx <= end_idx);
670f19dc624Sjohpow01 
671f19dc624Sjohpow01 	if (cur_idx == end_idx) {
672f19dc624Sjohpow01 		return end_pa;
673f19dc624Sjohpow01 	}
674f19dc624Sjohpow01 
675ec0088bbSAlexeiFedorov 	return (cur_idx + 1UL) << GPT_L0_IDX_SHIFT;
676f19dc624Sjohpow01 }
677f19dc624Sjohpow01 
678f19dc624Sjohpow01 /*
679ec0088bbSAlexeiFedorov  * Helper function to fill out GPI entries from 'first' granule address of
680ec0088bbSAlexeiFedorov  * the specified 'length' in a single L1 table with 'l1_desc' Contiguous
681ec0088bbSAlexeiFedorov  * descriptor.
682f19dc624Sjohpow01  *
683f19dc624Sjohpow01  * Parameters
684f19dc624Sjohpow01  *   l1			Pointer to L1 table to fill out
685ec0088bbSAlexeiFedorov  *   first		Address of first granule in range
686ec0088bbSAlexeiFedorov  *   length		Length of the range in bytes
687ec0088bbSAlexeiFedorov  *   gpi		GPI set this range to
688ec0088bbSAlexeiFedorov  *
689ec0088bbSAlexeiFedorov  * Return
690ec0088bbSAlexeiFedorov  *   Address of next granule in range.
691f19dc624Sjohpow01  */
6926350aea2SAlexeiFedorov __unused static uintptr_t fill_l1_cont_desc(uint64_t *l1, uintptr_t first,
693ec0088bbSAlexeiFedorov 					    size_t length, unsigned int gpi)
694f19dc624Sjohpow01 {
695ec0088bbSAlexeiFedorov 	/*
696ec0088bbSAlexeiFedorov 	 * Look up table for contiguous blocks and descriptors.
697ec0088bbSAlexeiFedorov 	 * Entries should be defined in descending block sizes:
698ec0088bbSAlexeiFedorov 	 * 512MB, 32MB and 2MB.
699ec0088bbSAlexeiFedorov 	 */
700ec0088bbSAlexeiFedorov 	static const gpt_fill_lookup_t gpt_fill_lookup[] = {
701ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK == 512)
702ec0088bbSAlexeiFedorov 		{ SZ_512M, GPT_L1_CONT_DESC_512MB },
703ec0088bbSAlexeiFedorov #endif
704ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK >= 32)
705ec0088bbSAlexeiFedorov 		{ SZ_32M, GPT_L1_CONT_DESC_32MB },
706ec0088bbSAlexeiFedorov #endif
707ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
708ec0088bbSAlexeiFedorov 		{ SZ_2M, GPT_L1_CONT_DESC_2MB }
709ec0088bbSAlexeiFedorov #endif
710ec0088bbSAlexeiFedorov 	};
711f19dc624Sjohpow01 
712ec0088bbSAlexeiFedorov 	/*
713ec0088bbSAlexeiFedorov 	 * Iterate through all block sizes (512MB, 32MB and 2MB)
714ec0088bbSAlexeiFedorov 	 * starting with maximum supported.
715ec0088bbSAlexeiFedorov 	 */
716ec0088bbSAlexeiFedorov 	for (unsigned long i = 0UL; i < ARRAY_SIZE(gpt_fill_lookup); i++) {
717ec0088bbSAlexeiFedorov 		/* Calculate index */
718ec0088bbSAlexeiFedorov 		unsigned long idx = GPT_L1_INDEX(first);
719ec0088bbSAlexeiFedorov 
720ec0088bbSAlexeiFedorov 		/* Contiguous block size */
721ec0088bbSAlexeiFedorov 		size_t cont_size = gpt_fill_lookup[i].size;
722ec0088bbSAlexeiFedorov 
723ec0088bbSAlexeiFedorov 		if (GPT_REGION_IS_CONT(length, first, cont_size)) {
724ec0088bbSAlexeiFedorov 
725ec0088bbSAlexeiFedorov 			/* Generate Contiguous descriptor */
726ec0088bbSAlexeiFedorov 			uint64_t l1_desc = GPT_L1_GPI_CONT_DESC(gpi,
727ec0088bbSAlexeiFedorov 						gpt_fill_lookup[i].desc);
728ec0088bbSAlexeiFedorov 
729ec0088bbSAlexeiFedorov 			/* Number of 128-bit L1 entries in block */
730ec0088bbSAlexeiFedorov 			unsigned int cnt;
731ec0088bbSAlexeiFedorov 
732ec0088bbSAlexeiFedorov 			switch (cont_size) {
733ec0088bbSAlexeiFedorov 			case SZ_512M:
734ec0088bbSAlexeiFedorov 				cnt = L1_QWORDS_512MB;
735ec0088bbSAlexeiFedorov 				break;
736ec0088bbSAlexeiFedorov 			case SZ_32M:
737ec0088bbSAlexeiFedorov 				cnt = L1_QWORDS_32MB;
738ec0088bbSAlexeiFedorov 				break;
739ec0088bbSAlexeiFedorov 			default:			/* SZ_2MB */
740ec0088bbSAlexeiFedorov 				cnt = L1_QWORDS_2MB;
741ec0088bbSAlexeiFedorov 			}
742ec0088bbSAlexeiFedorov 
743ec0088bbSAlexeiFedorov 			VERBOSE("GPT: Contiguous descriptor 0x%"PRIxPTR" %luMB\n",
744ec0088bbSAlexeiFedorov 				first, cont_size / SZ_1M);
745ec0088bbSAlexeiFedorov 
746ec0088bbSAlexeiFedorov 			/* Fill Contiguous descriptors */
747ec0088bbSAlexeiFedorov 			fill_desc(&l1[idx], l1_desc, cnt);
7489bc1e599SAlexeiFedorov 			return (first + cont_size);
749ec0088bbSAlexeiFedorov 		}
750ec0088bbSAlexeiFedorov 	}
751ec0088bbSAlexeiFedorov 
752ec0088bbSAlexeiFedorov 	return first;
753ec0088bbSAlexeiFedorov }
754ec0088bbSAlexeiFedorov 
755ec0088bbSAlexeiFedorov /* Build Granules descriptor with the same 'gpi' for every GPI entry */
756ec0088bbSAlexeiFedorov static uint64_t build_l1_desc(unsigned int gpi)
757ec0088bbSAlexeiFedorov {
758ec0088bbSAlexeiFedorov 	uint64_t l1_desc = (uint64_t)gpi | ((uint64_t)gpi << 4);
759ec0088bbSAlexeiFedorov 
760ec0088bbSAlexeiFedorov 	l1_desc |= (l1_desc << 8);
761ec0088bbSAlexeiFedorov 	l1_desc |= (l1_desc << 16);
762ec0088bbSAlexeiFedorov 	return (l1_desc | (l1_desc << 32));
763ec0088bbSAlexeiFedorov }
764ec0088bbSAlexeiFedorov 
765ec0088bbSAlexeiFedorov /*
766ec0088bbSAlexeiFedorov  * Helper function to fill out GPI entries from 'first' to 'last' granule
767ec0088bbSAlexeiFedorov  * address in a single L1 table with 'l1_desc' Granules descriptor.
768ec0088bbSAlexeiFedorov  *
769ec0088bbSAlexeiFedorov  * Parameters
770ec0088bbSAlexeiFedorov  *   l1			Pointer to L1 table to fill out
771ec0088bbSAlexeiFedorov  *   first		Address of first granule in range
772ec0088bbSAlexeiFedorov  *   last		Address of last granule in range (inclusive)
773ec0088bbSAlexeiFedorov  *   gpi		GPI set this range to
774ec0088bbSAlexeiFedorov  *
775ec0088bbSAlexeiFedorov  * Return
776ec0088bbSAlexeiFedorov  *   Address of next granule in range.
777ec0088bbSAlexeiFedorov  */
778ec0088bbSAlexeiFedorov static uintptr_t fill_l1_gran_desc(uint64_t *l1, uintptr_t first,
779ec0088bbSAlexeiFedorov 				   uintptr_t last, unsigned int gpi)
780ec0088bbSAlexeiFedorov {
781ec0088bbSAlexeiFedorov 	uint64_t gpi_mask;
782ec0088bbSAlexeiFedorov 	unsigned long i;
783ec0088bbSAlexeiFedorov 
784ec0088bbSAlexeiFedorov 	/* Generate Granules descriptor */
785ec0088bbSAlexeiFedorov 	uint64_t l1_desc = build_l1_desc(gpi);
786f19dc624Sjohpow01 
787b99926efSAlexeiFedorov 	/* Shift the mask if we're starting in the middle of an L1 entry */
788ec0088bbSAlexeiFedorov 	gpi_mask = ULONG_MAX << (GPT_L1_GPI_IDX(gpt_config.p, first) << 2);
789f19dc624Sjohpow01 
790b99926efSAlexeiFedorov 	/* Fill out each L1 entry for this region */
791ec0088bbSAlexeiFedorov 	for (i = GPT_L1_INDEX(first); i <= GPT_L1_INDEX(last); i++) {
792ec0088bbSAlexeiFedorov 
793b99926efSAlexeiFedorov 		/* Account for stopping in the middle of an L1 entry */
794ec0088bbSAlexeiFedorov 		if (i == GPT_L1_INDEX(last)) {
795b99926efSAlexeiFedorov 			gpi_mask &= (gpi_mask >> ((15U -
796f19dc624Sjohpow01 				    GPT_L1_GPI_IDX(gpt_config.p, last)) << 2));
797f19dc624Sjohpow01 		}
798f19dc624Sjohpow01 
799ec0088bbSAlexeiFedorov 		assert((l1[i] & gpi_mask) == (GPT_L1_ANY_DESC & gpi_mask));
800ec0088bbSAlexeiFedorov 
801b99926efSAlexeiFedorov 		/* Write GPI values */
802ec0088bbSAlexeiFedorov 		l1[i] = (l1[i] & ~gpi_mask) | (l1_desc & gpi_mask);
803f19dc624Sjohpow01 
804b99926efSAlexeiFedorov 		/* Reset mask */
805b99926efSAlexeiFedorov 		gpi_mask = ULONG_MAX;
806f19dc624Sjohpow01 	}
807ec0088bbSAlexeiFedorov 
808ec0088bbSAlexeiFedorov 	return last + GPT_PGS_ACTUAL_SIZE(gpt_config.p);
809ec0088bbSAlexeiFedorov }
810ec0088bbSAlexeiFedorov 
811ec0088bbSAlexeiFedorov /*
812ec0088bbSAlexeiFedorov  * Helper function to fill out GPI entries in a single L1 table.
8136350aea2SAlexeiFedorov  * This function fills out an entire L1 table with either Granules or Contiguous
8146350aea2SAlexeiFedorov  * (RME_GPT_MAX_BLOCK != 0) descriptors depending on region length and alignment.
8156350aea2SAlexeiFedorov  * Note. If RME_GPT_MAX_BLOCK == 0, then the L1 tables are filled with regular
8166350aea2SAlexeiFedorov  * Granules descriptors.
817ec0088bbSAlexeiFedorov  *
818ec0088bbSAlexeiFedorov  * Parameters
819ec0088bbSAlexeiFedorov  *   l1			Pointer to L1 table to fill out
820ec0088bbSAlexeiFedorov  *   first		Address of first granule in range
821ec0088bbSAlexeiFedorov  *   last		Address of last granule in range (inclusive)
822ec0088bbSAlexeiFedorov  *   gpi		GPI set this range to
823ec0088bbSAlexeiFedorov  */
824ec0088bbSAlexeiFedorov static void fill_l1_tbl(uint64_t *l1, uintptr_t first, uintptr_t last,
825ec0088bbSAlexeiFedorov 			unsigned int gpi)
826ec0088bbSAlexeiFedorov {
827ec0088bbSAlexeiFedorov 	assert(l1 != NULL);
828ec0088bbSAlexeiFedorov 	assert(first <= last);
829ec0088bbSAlexeiFedorov 	assert((first & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) == 0UL);
830ec0088bbSAlexeiFedorov 	assert((last & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) == 0UL);
831ec0088bbSAlexeiFedorov 	assert(GPT_L0_IDX(first) == GPT_L0_IDX(last));
832ec0088bbSAlexeiFedorov 
8336350aea2SAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
834d024cce3SAlexeiFedorov 	while (first <= last) {
835ec0088bbSAlexeiFedorov 		/* Region length */
836ec0088bbSAlexeiFedorov 		size_t length = last - first + GPT_PGS_ACTUAL_SIZE(gpt_config.p);
837ec0088bbSAlexeiFedorov 
838ec0088bbSAlexeiFedorov 		if (length < SZ_2M) {
839ec0088bbSAlexeiFedorov 			/*
8406350aea2SAlexeiFedorov 			 * Fill with Granule descriptors in case of
841ec0088bbSAlexeiFedorov 			 * region length < 2MB.
842ec0088bbSAlexeiFedorov 			 */
843ec0088bbSAlexeiFedorov 			first = fill_l1_gran_desc(l1, first, last, gpi);
844ec0088bbSAlexeiFedorov 
845ec0088bbSAlexeiFedorov 		} else if ((first & (SZ_2M - UL(1))) == UL(0)) {
846ec0088bbSAlexeiFedorov 			/*
847ec0088bbSAlexeiFedorov 			 * For region length >= 2MB and at least 2MB aligned
848ec0088bbSAlexeiFedorov 			 * call to fill_l1_cont_desc will iterate through
849ec0088bbSAlexeiFedorov 			 * all block sizes (512MB, 32MB and 2MB) supported and
850ec0088bbSAlexeiFedorov 			 * fill corresponding Contiguous descriptors.
851ec0088bbSAlexeiFedorov 			 */
852ec0088bbSAlexeiFedorov 			first = fill_l1_cont_desc(l1, first, length, gpi);
853ec0088bbSAlexeiFedorov 		} else {
854ec0088bbSAlexeiFedorov 			/*
855ec0088bbSAlexeiFedorov 			 * For not aligned region >= 2MB fill with Granules
856ec0088bbSAlexeiFedorov 			 * descriptors up to the next 2MB aligned address.
857ec0088bbSAlexeiFedorov 			 */
858ec0088bbSAlexeiFedorov 			uintptr_t new_last = ALIGN_2MB(first + SZ_2M) -
859ec0088bbSAlexeiFedorov 					GPT_PGS_ACTUAL_SIZE(gpt_config.p);
860ec0088bbSAlexeiFedorov 
861ec0088bbSAlexeiFedorov 			first = fill_l1_gran_desc(l1, first, new_last, gpi);
862ec0088bbSAlexeiFedorov 		}
863ec0088bbSAlexeiFedorov 	}
8646350aea2SAlexeiFedorov #else
8656350aea2SAlexeiFedorov 	/* Fill with Granule descriptors */
8666350aea2SAlexeiFedorov 	first = fill_l1_gran_desc(l1, first, last, gpi);
8676350aea2SAlexeiFedorov #endif
868ec0088bbSAlexeiFedorov 	assert(first == (last + GPT_PGS_ACTUAL_SIZE(gpt_config.p)));
869f19dc624Sjohpow01 }
870f19dc624Sjohpow01 
871f19dc624Sjohpow01 /*
872f19dc624Sjohpow01  * This function finds the next available unused L1 table and initializes all
873f19dc624Sjohpow01  * granules descriptor entries to GPI_ANY. This ensures that there are no chunks
874f19dc624Sjohpow01  * of GPI_NO_ACCESS (0b0000) memory floating around in the system in the
875f19dc624Sjohpow01  * event that a PAS region stops midway through an L1 table, thus guaranteeing
876f19dc624Sjohpow01  * that all memory not explicitly assigned is GPI_ANY. This function does not
877f19dc624Sjohpow01  * check for overflow conditions, that should be done by the caller.
878f19dc624Sjohpow01  *
879f19dc624Sjohpow01  * Return
880f19dc624Sjohpow01  *   Pointer to the next available L1 table.
881f19dc624Sjohpow01  */
88220e2683dSAlexeiFedorov static uint64_t *get_new_l1_tbl(void)
883f19dc624Sjohpow01 {
884b99926efSAlexeiFedorov 	/* Retrieve the next L1 table */
885ec0088bbSAlexeiFedorov 	uint64_t *l1 = (uint64_t *)gpt_l1_tbl;
886f19dc624Sjohpow01 
887ec0088bbSAlexeiFedorov 	/* Increment L1 GPT address */
888ec0088bbSAlexeiFedorov 	gpt_l1_tbl += GPT_L1_TABLE_SIZE(gpt_config.p);
889f19dc624Sjohpow01 
890f19dc624Sjohpow01 	/* Initialize all GPIs to GPT_GPI_ANY */
891f19dc624Sjohpow01 	for (unsigned int i = 0U; i < GPT_L1_ENTRY_COUNT(gpt_config.p); i++) {
892ec0088bbSAlexeiFedorov 		l1[i] = GPT_L1_ANY_DESC;
893f19dc624Sjohpow01 	}
894f19dc624Sjohpow01 
895f19dc624Sjohpow01 	return l1;
896f19dc624Sjohpow01 }
897f19dc624Sjohpow01 
898f19dc624Sjohpow01 /*
899f19dc624Sjohpow01  * When L1 tables are needed, this function creates the necessary L0 table
900f19dc624Sjohpow01  * descriptors and fills out the L1 table entries according to the supplied
901f19dc624Sjohpow01  * PAS range.
902f19dc624Sjohpow01  *
903f19dc624Sjohpow01  * Parameters
904f19dc624Sjohpow01  *   *pas		Pointer to the structure defining the PAS region.
905f19dc624Sjohpow01  */
90620e2683dSAlexeiFedorov static void generate_l0_tbl_desc(pas_region_t *pas)
907f19dc624Sjohpow01 {
908f19dc624Sjohpow01 	uintptr_t end_pa;
909f19dc624Sjohpow01 	uintptr_t cur_pa;
910f19dc624Sjohpow01 	uintptr_t last_gran_pa;
911f19dc624Sjohpow01 	uint64_t *l0_gpt_base;
912f19dc624Sjohpow01 	uint64_t *l1_gpt_arr;
913ec0088bbSAlexeiFedorov 	unsigned int l0_idx, gpi;
914f19dc624Sjohpow01 
915b0f1c840SAlexeiFedorov 	assert(gpt_config.plat_gpt_l0_base != 0UL);
916f19dc624Sjohpow01 	assert(pas != NULL);
917f19dc624Sjohpow01 
918f19dc624Sjohpow01 	/*
919f19dc624Sjohpow01 	 * Checking of PAS parameters has already been done in
92020e2683dSAlexeiFedorov 	 * validate_pas_mappings so no need to check the same things again.
921f19dc624Sjohpow01 	 */
922f19dc624Sjohpow01 	end_pa = pas->base_pa + pas->size;
923f19dc624Sjohpow01 	l0_gpt_base = (uint64_t *)gpt_config.plat_gpt_l0_base;
924f19dc624Sjohpow01 
925f19dc624Sjohpow01 	/* We start working from the granule at base PA */
926f19dc624Sjohpow01 	cur_pa = pas->base_pa;
927f19dc624Sjohpow01 
928ec0088bbSAlexeiFedorov 	/* Get GPI */
929ec0088bbSAlexeiFedorov 	gpi = GPT_PAS_ATTR_GPI(pas->attrs);
930f19dc624Sjohpow01 
931ec0088bbSAlexeiFedorov 	/* Iterate over each L0 region in this memory range */
932ec0088bbSAlexeiFedorov 	for (l0_idx = (unsigned int)GPT_L0_IDX(pas->base_pa);
933ec0088bbSAlexeiFedorov 	     l0_idx <= (unsigned int)GPT_L0_IDX(end_pa - 1UL);
934ec0088bbSAlexeiFedorov 	     l0_idx++) {
935f19dc624Sjohpow01 		/*
936f19dc624Sjohpow01 		 * See if the L0 entry is already a table descriptor or if we
937f19dc624Sjohpow01 		 * need to create one.
938f19dc624Sjohpow01 		 */
939f19dc624Sjohpow01 		if (GPT_L0_TYPE(l0_gpt_base[l0_idx]) == GPT_L0_TYPE_TBL_DESC) {
940b99926efSAlexeiFedorov 			/* Get the L1 array from the L0 entry */
941f19dc624Sjohpow01 			l1_gpt_arr = GPT_L0_TBLD_ADDR(l0_gpt_base[l0_idx]);
942f19dc624Sjohpow01 		} else {
943b99926efSAlexeiFedorov 			/* Get a new L1 table from the L1 memory space */
94420e2683dSAlexeiFedorov 			l1_gpt_arr = get_new_l1_tbl();
945f19dc624Sjohpow01 
946b99926efSAlexeiFedorov 			/* Fill out the L0 descriptor and flush it */
947f19dc624Sjohpow01 			l0_gpt_base[l0_idx] = GPT_L0_TBL_DESC(l1_gpt_arr);
948f19dc624Sjohpow01 		}
949f19dc624Sjohpow01 
950b99926efSAlexeiFedorov 		VERBOSE("GPT: L0 entry (TABLE) index %u [%p] ==> L1 Addr %p (0x%"PRIx64")\n",
951b99926efSAlexeiFedorov 			l0_idx, &l0_gpt_base[l0_idx], l1_gpt_arr, l0_gpt_base[l0_idx]);
952f19dc624Sjohpow01 
953f19dc624Sjohpow01 		/*
954f19dc624Sjohpow01 		 * Determine the PA of the last granule in this L0 descriptor.
955f19dc624Sjohpow01 		 */
95620e2683dSAlexeiFedorov 		last_gran_pa = get_l1_end_pa(cur_pa, end_pa) -
957f19dc624Sjohpow01 			       GPT_PGS_ACTUAL_SIZE(gpt_config.p);
958f19dc624Sjohpow01 
959f19dc624Sjohpow01 		/*
960f19dc624Sjohpow01 		 * Fill up L1 GPT entries between these two addresses. This
961f19dc624Sjohpow01 		 * function needs the addresses of the first granule and last
962f19dc624Sjohpow01 		 * granule in the range.
963f19dc624Sjohpow01 		 */
964ec0088bbSAlexeiFedorov 		fill_l1_tbl(l1_gpt_arr, cur_pa, last_gran_pa, gpi);
965f19dc624Sjohpow01 
966b99926efSAlexeiFedorov 		/* Advance cur_pa to first granule in next L0 region */
96720e2683dSAlexeiFedorov 		cur_pa = get_l1_end_pa(cur_pa, end_pa);
968f19dc624Sjohpow01 	}
969f19dc624Sjohpow01 }
970f19dc624Sjohpow01 
971f19dc624Sjohpow01 /*
972f19dc624Sjohpow01  * This function flushes a range of L0 descriptors used by a given PAS region
973f19dc624Sjohpow01  * array. There is a chance that some unmodified L0 descriptors would be flushed
974f19dc624Sjohpow01  * in the case that there are "holes" in an array of PAS regions but overall
975f19dc624Sjohpow01  * this should be faster than individually flushing each modified L0 descriptor
976f19dc624Sjohpow01  * as they are created.
977f19dc624Sjohpow01  *
978f19dc624Sjohpow01  * Parameters
979f19dc624Sjohpow01  *   *pas		Pointer to an array of PAS regions.
980f19dc624Sjohpow01  *   pas_count		Number of entries in the PAS array.
981f19dc624Sjohpow01  */
982f19dc624Sjohpow01 static void flush_l0_for_pas_array(pas_region_t *pas, unsigned int pas_count)
983f19dc624Sjohpow01 {
984ec0088bbSAlexeiFedorov 	unsigned long idx;
985ec0088bbSAlexeiFedorov 	unsigned long start_idx;
986ec0088bbSAlexeiFedorov 	unsigned long end_idx;
987f19dc624Sjohpow01 	uint64_t *l0 = (uint64_t *)gpt_config.plat_gpt_l0_base;
988f19dc624Sjohpow01 
989f19dc624Sjohpow01 	assert(pas != NULL);
990b99926efSAlexeiFedorov 	assert(pas_count != 0U);
991f19dc624Sjohpow01 
992b99926efSAlexeiFedorov 	/* Initial start and end values */
993f19dc624Sjohpow01 	start_idx = GPT_L0_IDX(pas[0].base_pa);
994b99926efSAlexeiFedorov 	end_idx = GPT_L0_IDX(pas[0].base_pa + pas[0].size - 1UL);
995f19dc624Sjohpow01 
996b99926efSAlexeiFedorov 	/* Find lowest and highest L0 indices used in this PAS array */
997ec0088bbSAlexeiFedorov 	for (idx = 1UL; idx < pas_count; idx++) {
998f19dc624Sjohpow01 		if (GPT_L0_IDX(pas[idx].base_pa) < start_idx) {
999f19dc624Sjohpow01 			start_idx = GPT_L0_IDX(pas[idx].base_pa);
1000f19dc624Sjohpow01 		}
1001b99926efSAlexeiFedorov 		if (GPT_L0_IDX(pas[idx].base_pa + pas[idx].size - 1UL) > end_idx) {
1002b99926efSAlexeiFedorov 			end_idx = GPT_L0_IDX(pas[idx].base_pa + pas[idx].size - 1UL);
1003f19dc624Sjohpow01 		}
1004f19dc624Sjohpow01 	}
1005f19dc624Sjohpow01 
1006f19dc624Sjohpow01 	/*
1007f19dc624Sjohpow01 	 * Flush all covered L0 descriptors, add 1 because we need to include
1008f19dc624Sjohpow01 	 * the end index value.
1009f19dc624Sjohpow01 	 */
1010f19dc624Sjohpow01 	flush_dcache_range((uintptr_t)&l0[start_idx],
1011ec0088bbSAlexeiFedorov 			   ((end_idx + 1UL) - start_idx) * sizeof(uint64_t));
1012f19dc624Sjohpow01 }
1013f19dc624Sjohpow01 
1014f19dc624Sjohpow01 /*
1015f19dc624Sjohpow01  * Public API to enable granule protection checks once the tables have all been
1016f19dc624Sjohpow01  * initialized. This function is called at first initialization and then again
1017f19dc624Sjohpow01  * later during warm boots of CPU cores.
1018f19dc624Sjohpow01  *
1019f19dc624Sjohpow01  * Return
1020f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
1021f19dc624Sjohpow01  */
1022f19dc624Sjohpow01 int gpt_enable(void)
1023f19dc624Sjohpow01 {
1024f19dc624Sjohpow01 	u_register_t gpccr_el3;
1025f19dc624Sjohpow01 
1026f19dc624Sjohpow01 	/*
1027f19dc624Sjohpow01 	 * Granule tables must be initialised before enabling
1028f19dc624Sjohpow01 	 * granule protection.
1029f19dc624Sjohpow01 	 */
1030b99926efSAlexeiFedorov 	if (gpt_config.plat_gpt_l0_base == 0UL) {
1031b99926efSAlexeiFedorov 		ERROR("GPT: Tables have not been initialized!\n");
1032f19dc624Sjohpow01 		return -EPERM;
1033f19dc624Sjohpow01 	}
1034f19dc624Sjohpow01 
1035f19dc624Sjohpow01 	/* Write the base address of the L0 tables into GPTBR */
1036f19dc624Sjohpow01 	write_gptbr_el3(((gpt_config.plat_gpt_l0_base >> GPTBR_BADDR_VAL_SHIFT)
1037f19dc624Sjohpow01 			>> GPTBR_BADDR_SHIFT) & GPTBR_BADDR_MASK);
1038f19dc624Sjohpow01 
1039f19dc624Sjohpow01 	/* GPCCR_EL3.PPS */
1040f19dc624Sjohpow01 	gpccr_el3 = SET_GPCCR_PPS(gpt_config.pps);
1041f19dc624Sjohpow01 
1042f19dc624Sjohpow01 	/* GPCCR_EL3.PGS */
1043f19dc624Sjohpow01 	gpccr_el3 |= SET_GPCCR_PGS(gpt_config.pgs);
1044f19dc624Sjohpow01 
104577612b90SSoby Mathew 	/*
104677612b90SSoby Mathew 	 * Since EL3 maps the L1 region as Inner shareable, use the same
104777612b90SSoby Mathew 	 * shareability attribute for GPC as well so that
104877612b90SSoby Mathew 	 * GPC fetches are visible to PEs
104977612b90SSoby Mathew 	 */
105077612b90SSoby Mathew 	gpccr_el3 |= SET_GPCCR_SH(GPCCR_SH_IS);
1051f19dc624Sjohpow01 
1052b99926efSAlexeiFedorov 	/* Outer and Inner cacheability set to Normal memory, WB, RA, WA */
1053f19dc624Sjohpow01 	gpccr_el3 |= SET_GPCCR_ORGN(GPCCR_ORGN_WB_RA_WA);
1054f19dc624Sjohpow01 	gpccr_el3 |= SET_GPCCR_IRGN(GPCCR_IRGN_WB_RA_WA);
1055f19dc624Sjohpow01 
105614cddd7aSKathleen Capella 	/* Prepopulate GPCCR_EL3 but don't enable GPC yet */
105714cddd7aSKathleen Capella 	write_gpccr_el3(gpccr_el3);
105814cddd7aSKathleen Capella 	isb();
105914cddd7aSKathleen Capella 
106014cddd7aSKathleen Capella 	/* Invalidate any stale TLB entries and any cached register fields */
106114cddd7aSKathleen Capella 	tlbipaallos();
106214cddd7aSKathleen Capella 	dsb();
106314cddd7aSKathleen Capella 	isb();
106414cddd7aSKathleen Capella 
1065f19dc624Sjohpow01 	/* Enable GPT */
1066f19dc624Sjohpow01 	gpccr_el3 |= GPCCR_GPC_BIT;
1067f19dc624Sjohpow01 
1068*09a4bcb8SGirish Pathak 	/* Enable NSO encoding if FEAT_RME_GPC2 is supported. */
1069*09a4bcb8SGirish Pathak 	if (is_feat_rme_gpc2_present()) {
1070*09a4bcb8SGirish Pathak 		gpccr_el3 |= GPCCR_NSO_BIT;
1071*09a4bcb8SGirish Pathak 	}
1072*09a4bcb8SGirish Pathak 
1073b99926efSAlexeiFedorov 	/* TODO: Configure GPCCR_EL3_GPCP for Fault control */
1074f19dc624Sjohpow01 	write_gpccr_el3(gpccr_el3);
107577612b90SSoby Mathew 	isb();
1076f19dc624Sjohpow01 	tlbipaallos();
1077f19dc624Sjohpow01 	dsb();
1078f19dc624Sjohpow01 	isb();
1079f19dc624Sjohpow01 
1080f19dc624Sjohpow01 	return 0;
1081f19dc624Sjohpow01 }
1082f19dc624Sjohpow01 
1083f19dc624Sjohpow01 /*
1084f19dc624Sjohpow01  * Public API to disable granule protection checks.
1085f19dc624Sjohpow01  */
1086f19dc624Sjohpow01 void gpt_disable(void)
1087f19dc624Sjohpow01 {
1088f19dc624Sjohpow01 	u_register_t gpccr_el3 = read_gpccr_el3();
1089f19dc624Sjohpow01 
1090f19dc624Sjohpow01 	write_gpccr_el3(gpccr_el3 & ~GPCCR_GPC_BIT);
1091f19dc624Sjohpow01 	dsbsy();
1092f19dc624Sjohpow01 	isb();
1093f19dc624Sjohpow01 }
1094f19dc624Sjohpow01 
1095f19dc624Sjohpow01 /*
1096f19dc624Sjohpow01  * Public API that initializes the entire protected space to GPT_GPI_ANY using
1097f19dc624Sjohpow01  * the L0 tables (block descriptors). Ideally, this function is invoked prior
1098f19dc624Sjohpow01  * to DDR discovery and initialization. The MMU must be initialized before
1099f19dc624Sjohpow01  * calling this function.
1100f19dc624Sjohpow01  *
1101f19dc624Sjohpow01  * Parameters
1102f19dc624Sjohpow01  *   pps		PPS value to use for table generation
1103f19dc624Sjohpow01  *   l0_mem_base	Base address of L0 tables in memory.
1104f19dc624Sjohpow01  *   l0_mem_size	Total size of memory available for L0 tables.
1105f19dc624Sjohpow01  *
1106f19dc624Sjohpow01  * Return
1107f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
1108f19dc624Sjohpow01  */
1109a0d5147bSAlexeiFedorov int gpt_init_l0_tables(gpccr_pps_e pps, uintptr_t l0_mem_base,
1110f19dc624Sjohpow01 		       size_t l0_mem_size)
1111f19dc624Sjohpow01 {
1112f19dc624Sjohpow01 	uint64_t gpt_desc;
1113ec0088bbSAlexeiFedorov 	int ret;
1114f19dc624Sjohpow01 
1115b99926efSAlexeiFedorov 	/* Ensure that MMU and Data caches are enabled */
1116b0f1c840SAlexeiFedorov 	assert((read_sctlr_el3() & SCTLR_C_BIT) != 0UL);
1117f19dc624Sjohpow01 
1118b99926efSAlexeiFedorov 	/* Validate other parameters */
111920e2683dSAlexeiFedorov 	ret = validate_l0_params(pps, l0_mem_base, l0_mem_size);
11206a00e9b0SRobert Wakim 	if (ret != 0) {
1121f19dc624Sjohpow01 		return ret;
1122f19dc624Sjohpow01 	}
1123f19dc624Sjohpow01 
1124b99926efSAlexeiFedorov 	/* Create the descriptor to initialize L0 entries with */
1125f19dc624Sjohpow01 	gpt_desc = GPT_L0_BLK_DESC(GPT_GPI_ANY);
1126f19dc624Sjohpow01 
1127f19dc624Sjohpow01 	/* Iterate through all L0 entries */
1128f19dc624Sjohpow01 	for (unsigned int i = 0U; i < GPT_L0_REGION_COUNT(gpt_config.t); i++) {
1129f19dc624Sjohpow01 		((uint64_t *)l0_mem_base)[i] = gpt_desc;
1130f19dc624Sjohpow01 	}
1131f19dc624Sjohpow01 
1132b0f1c840SAlexeiFedorov 	/* Flush updated L0 table to memory */
1133b0f1c840SAlexeiFedorov 	flush_dcache_range((uintptr_t)l0_mem_base, GPT_L0_TABLE_SIZE(gpt_config.t));
1134f19dc624Sjohpow01 
1135b99926efSAlexeiFedorov 	/* Stash the L0 base address once initial setup is complete */
1136f19dc624Sjohpow01 	gpt_config.plat_gpt_l0_base = l0_mem_base;
1137f19dc624Sjohpow01 
1138f19dc624Sjohpow01 	return 0;
1139f19dc624Sjohpow01 }
1140f19dc624Sjohpow01 
1141f19dc624Sjohpow01 /*
1142f19dc624Sjohpow01  * Public API that carves out PAS regions from the L0 tables and builds any L1
1143f19dc624Sjohpow01  * tables that are needed. This function ideally is run after DDR discovery and
1144f19dc624Sjohpow01  * initialization. The L0 tables must have already been initialized to GPI_ANY
1145f19dc624Sjohpow01  * when this function is called.
1146f19dc624Sjohpow01  *
1147f19dc624Sjohpow01  * This function can be called multiple times with different L1 memory ranges
1148f19dc624Sjohpow01  * and PAS regions if it is desirable to place L1 tables in different locations
1149f19dc624Sjohpow01  * in memory. (ex: you have multiple DDR banks and want to place the L1 tables
1150ec0088bbSAlexeiFedorov  * in the DDR bank that they control).
1151f19dc624Sjohpow01  *
1152f19dc624Sjohpow01  * Parameters
1153f19dc624Sjohpow01  *   pgs		PGS value to use for table generation.
1154f19dc624Sjohpow01  *   l1_mem_base	Base address of memory used for L1 tables.
1155f19dc624Sjohpow01  *   l1_mem_size	Total size of memory available for L1 tables.
1156f19dc624Sjohpow01  *   *pas_regions	Pointer to PAS regions structure array.
1157f19dc624Sjohpow01  *   pas_count		Total number of PAS regions.
1158f19dc624Sjohpow01  *
1159f19dc624Sjohpow01  * Return
1160f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
1161f19dc624Sjohpow01  */
1162f19dc624Sjohpow01 int gpt_init_pas_l1_tables(gpccr_pgs_e pgs, uintptr_t l1_mem_base,
1163f19dc624Sjohpow01 			   size_t l1_mem_size, pas_region_t *pas_regions,
1164f19dc624Sjohpow01 			   unsigned int pas_count)
1165f19dc624Sjohpow01 {
1166ec0088bbSAlexeiFedorov 	int l1_gpt_cnt, ret;
1167f19dc624Sjohpow01 
1168b99926efSAlexeiFedorov 	/* Ensure that MMU and Data caches are enabled */
1169b0f1c840SAlexeiFedorov 	assert((read_sctlr_el3() & SCTLR_C_BIT) != 0UL);
1170f19dc624Sjohpow01 
1171b99926efSAlexeiFedorov 	/* PGS is needed for validate_pas_mappings so check it now */
1172f19dc624Sjohpow01 	if (pgs > GPT_PGS_MAX) {
1173b99926efSAlexeiFedorov 		ERROR("GPT: Invalid PGS: 0x%x\n", pgs);
1174f19dc624Sjohpow01 		return -EINVAL;
1175f19dc624Sjohpow01 	}
1176f19dc624Sjohpow01 	gpt_config.pgs = pgs;
1177f19dc624Sjohpow01 	gpt_config.p = gpt_p_lookup[pgs];
1178f19dc624Sjohpow01 
1179b99926efSAlexeiFedorov 	/* Make sure L0 tables have been initialized */
1180b0f1c840SAlexeiFedorov 	if (gpt_config.plat_gpt_l0_base == 0UL) {
1181b99926efSAlexeiFedorov 		ERROR("GPT: L0 tables must be initialized first!\n");
1182f19dc624Sjohpow01 		return -EPERM;
1183f19dc624Sjohpow01 	}
1184f19dc624Sjohpow01 
1185b99926efSAlexeiFedorov 	/* Check if L1 GPTs are required and how many */
118620e2683dSAlexeiFedorov 	l1_gpt_cnt = validate_pas_mappings(pas_regions, pas_count);
1187f19dc624Sjohpow01 	if (l1_gpt_cnt < 0) {
1188f19dc624Sjohpow01 		return l1_gpt_cnt;
1189f19dc624Sjohpow01 	}
1190f19dc624Sjohpow01 
1191b99926efSAlexeiFedorov 	VERBOSE("GPT: %i L1 GPTs requested\n", l1_gpt_cnt);
1192f19dc624Sjohpow01 
1193b99926efSAlexeiFedorov 	/* If L1 tables are needed then validate the L1 parameters */
1194f19dc624Sjohpow01 	if (l1_gpt_cnt > 0) {
119520e2683dSAlexeiFedorov 		ret = validate_l1_params(l1_mem_base, l1_mem_size,
1196b99926efSAlexeiFedorov 					(unsigned int)l1_gpt_cnt);
11976a00e9b0SRobert Wakim 		if (ret != 0) {
1198f19dc624Sjohpow01 			return ret;
1199f19dc624Sjohpow01 		}
1200f19dc624Sjohpow01 
1201b99926efSAlexeiFedorov 		/* Set up parameters for L1 table generation */
1202f19dc624Sjohpow01 		gpt_l1_tbl = l1_mem_base;
1203f19dc624Sjohpow01 	}
1204f19dc624Sjohpow01 
1205ec0088bbSAlexeiFedorov 	/* Number of L1 entries in 2MB depends on GPCCR_EL3.PGS value */
1206ec0088bbSAlexeiFedorov 	gpt_l1_cnt_2mb = (unsigned int)GPT_L1_ENTRY_COUNT_2MB(gpt_config.p);
1207ec0088bbSAlexeiFedorov 
1208ec0088bbSAlexeiFedorov 	/* Mask for the L1 index field */
1209ec0088bbSAlexeiFedorov 	gpt_l1_index_mask = GPT_L1_IDX_MASK(gpt_config.p);
1210ec0088bbSAlexeiFedorov 
1211b99926efSAlexeiFedorov 	INFO("GPT: Boot Configuration\n");
1212f19dc624Sjohpow01 	INFO("  PPS/T:     0x%x/%u\n", gpt_config.pps, gpt_config.t);
1213f19dc624Sjohpow01 	INFO("  PGS/P:     0x%x/%u\n", gpt_config.pgs, gpt_config.p);
1214f19dc624Sjohpow01 	INFO("  L0GPTSZ/S: 0x%x/%u\n", GPT_L0GPTSZ, GPT_S_VAL);
1215b99926efSAlexeiFedorov 	INFO("  PAS count: %u\n", pas_count);
1216b99926efSAlexeiFedorov 	INFO("  L0 base:   0x%"PRIxPTR"\n", gpt_config.plat_gpt_l0_base);
1217f19dc624Sjohpow01 
1218b99926efSAlexeiFedorov 	/* Generate the tables in memory */
1219f19dc624Sjohpow01 	for (unsigned int idx = 0U; idx < pas_count; idx++) {
1220b99926efSAlexeiFedorov 		VERBOSE("GPT: PAS[%u]: base 0x%"PRIxPTR"\tsize 0x%lx\tGPI 0x%x\ttype 0x%x\n",
1221f19dc624Sjohpow01 			idx, pas_regions[idx].base_pa, pas_regions[idx].size,
1222f19dc624Sjohpow01 			GPT_PAS_ATTR_GPI(pas_regions[idx].attrs),
1223f19dc624Sjohpow01 			GPT_PAS_ATTR_MAP_TYPE(pas_regions[idx].attrs));
1224f19dc624Sjohpow01 
1225f19dc624Sjohpow01 		/* Check if a block or table descriptor is required */
1226f19dc624Sjohpow01 		if (GPT_PAS_ATTR_MAP_TYPE(pas_regions[idx].attrs) ==
1227f19dc624Sjohpow01 		    GPT_PAS_ATTR_MAP_TYPE_BLOCK) {
122820e2683dSAlexeiFedorov 			generate_l0_blk_desc(&pas_regions[idx]);
1229f19dc624Sjohpow01 
1230f19dc624Sjohpow01 		} else {
123120e2683dSAlexeiFedorov 			generate_l0_tbl_desc(&pas_regions[idx]);
1232f19dc624Sjohpow01 		}
1233f19dc624Sjohpow01 	}
1234f19dc624Sjohpow01 
1235b99926efSAlexeiFedorov 	/* Flush modified L0 tables */
1236f19dc624Sjohpow01 	flush_l0_for_pas_array(pas_regions, pas_count);
1237f19dc624Sjohpow01 
1238b99926efSAlexeiFedorov 	/* Flush L1 tables if needed */
1239f19dc624Sjohpow01 	if (l1_gpt_cnt > 0) {
1240f19dc624Sjohpow01 		flush_dcache_range(l1_mem_base,
1241f19dc624Sjohpow01 				   GPT_L1_TABLE_SIZE(gpt_config.p) *
1242ec0088bbSAlexeiFedorov 				   (size_t)l1_gpt_cnt);
1243f19dc624Sjohpow01 	}
1244f19dc624Sjohpow01 
1245b99926efSAlexeiFedorov 	/* Make sure that all the entries are written to the memory */
1246f19dc624Sjohpow01 	dsbishst();
124777612b90SSoby Mathew 	tlbipaallos();
124877612b90SSoby Mathew 	dsb();
124977612b90SSoby Mathew 	isb();
1250f19dc624Sjohpow01 
1251f19dc624Sjohpow01 	return 0;
1252f19dc624Sjohpow01 }
1253f19dc624Sjohpow01 
1254f19dc624Sjohpow01 /*
1255f19dc624Sjohpow01  * Public API to initialize the runtime gpt_config structure based on the values
1256f19dc624Sjohpow01  * present in the GPTBR_EL3 and GPCCR_EL3 registers. GPT initialization
1257f19dc624Sjohpow01  * typically happens in a bootloader stage prior to setting up the EL3 runtime
1258f19dc624Sjohpow01  * environment for the granule transition service so this function detects the
1259f19dc624Sjohpow01  * initialization from a previous stage. Granule protection checks must be
1260f19dc624Sjohpow01  * enabled already or this function will return an error.
1261f19dc624Sjohpow01  *
1262b0f1c840SAlexeiFedorov  * Parameters
1263b0f1c840SAlexeiFedorov  *   l1_bitlocks_base	Base address of memory for L1 tables bitlocks.
1264b0f1c840SAlexeiFedorov  *   l1_bitlocks_size	Total size of memory available for L1 tables bitlocks.
1265b0f1c840SAlexeiFedorov  *
1266f19dc624Sjohpow01  * Return
1267f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
1268f19dc624Sjohpow01  */
1269b0f1c840SAlexeiFedorov int gpt_runtime_init(uintptr_t l1_bitlocks_base, size_t l1_bitlocks_size)
1270f19dc624Sjohpow01 {
1271f19dc624Sjohpow01 	u_register_t reg;
1272b0f1c840SAlexeiFedorov 	__unused size_t locks_size;
1273f19dc624Sjohpow01 
1274b99926efSAlexeiFedorov 	/* Ensure that MMU and Data caches are enabled */
1275b0f1c840SAlexeiFedorov 	assert((read_sctlr_el3() & SCTLR_C_BIT) != 0UL);
1276f19dc624Sjohpow01 
1277b99926efSAlexeiFedorov 	/* Ensure GPC are already enabled */
1278b0f1c840SAlexeiFedorov 	if ((read_gpccr_el3() & GPCCR_GPC_BIT) == 0UL) {
1279b99926efSAlexeiFedorov 		ERROR("GPT: Granule protection checks are not enabled!\n");
1280f19dc624Sjohpow01 		return -EPERM;
1281f19dc624Sjohpow01 	}
1282f19dc624Sjohpow01 
1283f19dc624Sjohpow01 	/*
1284f19dc624Sjohpow01 	 * Read the L0 table address from GPTBR, we don't need the L1 base
1285f19dc624Sjohpow01 	 * address since those are included in the L0 tables as needed.
1286f19dc624Sjohpow01 	 */
1287f19dc624Sjohpow01 	reg = read_gptbr_el3();
1288f19dc624Sjohpow01 	gpt_config.plat_gpt_l0_base = ((reg >> GPTBR_BADDR_SHIFT) &
1289f19dc624Sjohpow01 				      GPTBR_BADDR_MASK) <<
1290f19dc624Sjohpow01 				      GPTBR_BADDR_VAL_SHIFT;
1291f19dc624Sjohpow01 
1292b99926efSAlexeiFedorov 	/* Read GPCCR to get PGS and PPS values */
1293f19dc624Sjohpow01 	reg = read_gpccr_el3();
1294f19dc624Sjohpow01 	gpt_config.pps = (reg >> GPCCR_PPS_SHIFT) & GPCCR_PPS_MASK;
1295f19dc624Sjohpow01 	gpt_config.t = gpt_t_lookup[gpt_config.pps];
1296f19dc624Sjohpow01 	gpt_config.pgs = (reg >> GPCCR_PGS_SHIFT) & GPCCR_PGS_MASK;
1297f19dc624Sjohpow01 	gpt_config.p = gpt_p_lookup[gpt_config.pgs];
1298f19dc624Sjohpow01 
1299ec0088bbSAlexeiFedorov 	/* Number of L1 entries in 2MB depends on GPCCR_EL3.PGS value */
1300ec0088bbSAlexeiFedorov 	gpt_l1_cnt_2mb = (unsigned int)GPT_L1_ENTRY_COUNT_2MB(gpt_config.p);
1301ec0088bbSAlexeiFedorov 
1302ec0088bbSAlexeiFedorov 	/* Mask for the L1 index field */
1303ec0088bbSAlexeiFedorov 	gpt_l1_index_mask = GPT_L1_IDX_MASK(gpt_config.p);
1304ec0088bbSAlexeiFedorov 
1305d766084fSAlexeiFedorov #if (RME_GPT_BITLOCK_BLOCK != 0)
1306b0f1c840SAlexeiFedorov 	/*
1307b0f1c840SAlexeiFedorov 	 * Size of GPT bitlocks in bytes for the protected address space
1308b0f1c840SAlexeiFedorov 	 * with RME_GPT_BITLOCK_BLOCK * 512MB per bitlock.
1309b0f1c840SAlexeiFedorov 	 */
1310b0f1c840SAlexeiFedorov 	locks_size = GPT_PPS_ACTUAL_SIZE(gpt_config.t) /
1311b0f1c840SAlexeiFedorov 			(RME_GPT_BITLOCK_BLOCK * SZ_512M * 8U);
1312b0f1c840SAlexeiFedorov 	/*
1313b0f1c840SAlexeiFedorov 	 * If protected space size is less than the size covered
1314b0f1c840SAlexeiFedorov 	 * by 'bitlock' structure, check for a single bitlock.
1315b0f1c840SAlexeiFedorov 	 */
1316b0f1c840SAlexeiFedorov 	if (locks_size < LOCK_SIZE) {
1317b0f1c840SAlexeiFedorov 		locks_size = LOCK_SIZE;
1318b0f1c840SAlexeiFedorov 	/* Check bitlocks array size */
1319b0f1c840SAlexeiFedorov 	} else if (locks_size > l1_bitlocks_size) {
1320b0f1c840SAlexeiFedorov 		ERROR("GPT: Inadequate GPT bitlocks memory\n");
1321b0f1c840SAlexeiFedorov 		ERROR("      Expected 0x%lx bytes, got 0x%lx\n",
1322b0f1c840SAlexeiFedorov 			locks_size, l1_bitlocks_size);
1323b0f1c840SAlexeiFedorov 		return -ENOMEM;
1324b0f1c840SAlexeiFedorov 	}
1325b0f1c840SAlexeiFedorov 
1326b0f1c840SAlexeiFedorov 	gpt_bitlock = (bitlock_t *)l1_bitlocks_base;
1327b0f1c840SAlexeiFedorov 
1328b0f1c840SAlexeiFedorov 	/* Initialise GPT bitlocks */
1329b0f1c840SAlexeiFedorov 	(void)memset((void *)gpt_bitlock, 0, locks_size);
1330b0f1c840SAlexeiFedorov 
1331b0f1c840SAlexeiFedorov 	/* Flush GPT bitlocks to memory */
1332b0f1c840SAlexeiFedorov 	flush_dcache_range((uintptr_t)gpt_bitlock, locks_size);
1333b0f1c840SAlexeiFedorov #endif /* RME_GPT_BITLOCK_BLOCK */
1334b0f1c840SAlexeiFedorov 
1335b99926efSAlexeiFedorov 	VERBOSE("GPT: Runtime Configuration\n");
1336f19dc624Sjohpow01 	VERBOSE("  PPS/T:     0x%x/%u\n", gpt_config.pps, gpt_config.t);
1337f19dc624Sjohpow01 	VERBOSE("  PGS/P:     0x%x/%u\n", gpt_config.pgs, gpt_config.p);
1338f19dc624Sjohpow01 	VERBOSE("  L0GPTSZ/S: 0x%x/%u\n", GPT_L0GPTSZ, GPT_S_VAL);
1339b99926efSAlexeiFedorov 	VERBOSE("  L0 base:   0x%"PRIxPTR"\n", gpt_config.plat_gpt_l0_base);
1340d766084fSAlexeiFedorov #if (RME_GPT_BITLOCK_BLOCK != 0)
1341b0f1c840SAlexeiFedorov 	VERBOSE("  Bitlocks:  0x%"PRIxPTR"/0x%lx\n", (uintptr_t)gpt_bitlock,
1342b0f1c840SAlexeiFedorov 					locks_size);
1343d766084fSAlexeiFedorov #endif
1344f19dc624Sjohpow01 	return 0;
1345f19dc624Sjohpow01 }
1346f19dc624Sjohpow01 
1347f19dc624Sjohpow01 /*
13486a00e9b0SRobert Wakim  * A helper to write the value (target_pas << gpi_shift) to the index of
1349b99926efSAlexeiFedorov  * the gpt_l1_addr.
13506a00e9b0SRobert Wakim  */
13516a00e9b0SRobert Wakim static inline void write_gpt(uint64_t *gpt_l1_desc, uint64_t *gpt_l1_addr,
13526a00e9b0SRobert Wakim 			     unsigned int gpi_shift, unsigned int idx,
13536a00e9b0SRobert Wakim 			     unsigned int target_pas)
13546a00e9b0SRobert Wakim {
13556a00e9b0SRobert Wakim 	*gpt_l1_desc &= ~(GPT_L1_GRAN_DESC_GPI_MASK << gpi_shift);
13566a00e9b0SRobert Wakim 	*gpt_l1_desc |= ((uint64_t)target_pas << gpi_shift);
13576a00e9b0SRobert Wakim 	gpt_l1_addr[idx] = *gpt_l1_desc;
1358ec0088bbSAlexeiFedorov 
1359ec0088bbSAlexeiFedorov 	dsboshst();
13606a00e9b0SRobert Wakim }
13616a00e9b0SRobert Wakim 
13626a00e9b0SRobert Wakim /*
13636a00e9b0SRobert Wakim  * Helper to retrieve the gpt_l1_* information from the base address
1364b99926efSAlexeiFedorov  * returned in gpi_info.
13656a00e9b0SRobert Wakim  */
13666a00e9b0SRobert Wakim static int get_gpi_params(uint64_t base, gpi_info_t *gpi_info)
13676a00e9b0SRobert Wakim {
13686a00e9b0SRobert Wakim 	uint64_t gpt_l0_desc, *gpt_l0_base;
1369d766084fSAlexeiFedorov 	__unused unsigned int block_idx;
13706a00e9b0SRobert Wakim 
13716a00e9b0SRobert Wakim 	gpt_l0_base = (uint64_t *)gpt_config.plat_gpt_l0_base;
13726a00e9b0SRobert Wakim 	gpt_l0_desc = gpt_l0_base[GPT_L0_IDX(base)];
13736a00e9b0SRobert Wakim 	if (GPT_L0_TYPE(gpt_l0_desc) != GPT_L0_TYPE_TBL_DESC) {
1374b99926efSAlexeiFedorov 		VERBOSE("GPT: Granule is not covered by a table descriptor!\n");
13756a00e9b0SRobert Wakim 		VERBOSE("      Base=0x%"PRIx64"\n", base);
13766a00e9b0SRobert Wakim 		return -EINVAL;
13776a00e9b0SRobert Wakim 	}
13786a00e9b0SRobert Wakim 
1379b99926efSAlexeiFedorov 	/* Get the table index and GPI shift from PA */
13806a00e9b0SRobert Wakim 	gpi_info->gpt_l1_addr = GPT_L0_TBLD_ADDR(gpt_l0_desc);
1381ec0088bbSAlexeiFedorov 	gpi_info->idx = (unsigned int)GPT_L1_INDEX(base);
13826a00e9b0SRobert Wakim 	gpi_info->gpi_shift = GPT_L1_GPI_IDX(gpt_config.p, base) << 2;
13836a00e9b0SRobert Wakim 
1384d766084fSAlexeiFedorov #if (RME_GPT_BITLOCK_BLOCK != 0)
1385d766084fSAlexeiFedorov 	/* Block index */
1386d766084fSAlexeiFedorov 	block_idx = (unsigned int)(base / (RME_GPT_BITLOCK_BLOCK * SZ_512M));
1387ec0088bbSAlexeiFedorov 
1388ec0088bbSAlexeiFedorov 	/* Bitlock address and mask */
1389b0f1c840SAlexeiFedorov 	gpi_info->lock = &gpt_bitlock[block_idx / LOCK_BITS];
1390d766084fSAlexeiFedorov 	gpi_info->mask = 1U << (block_idx & (LOCK_BITS - 1U));
1391d766084fSAlexeiFedorov #endif
13926a00e9b0SRobert Wakim 	return 0;
13936a00e9b0SRobert Wakim }
13946a00e9b0SRobert Wakim 
13956a00e9b0SRobert Wakim /*
1396ec0088bbSAlexeiFedorov  * Helper to retrieve the gpt_l1_desc and GPI information from gpi_info.
1397d766084fSAlexeiFedorov  * This function is called with bitlock or spinlock acquired.
1398ec0088bbSAlexeiFedorov  */
1399ec0088bbSAlexeiFedorov static void read_gpi(gpi_info_t *gpi_info)
1400ec0088bbSAlexeiFedorov {
1401ec0088bbSAlexeiFedorov 	gpi_info->gpt_l1_desc = (gpi_info->gpt_l1_addr)[gpi_info->idx];
1402ec0088bbSAlexeiFedorov 
1403ec0088bbSAlexeiFedorov 	if ((gpi_info->gpt_l1_desc & GPT_L1_TYPE_CONT_DESC_MASK) ==
1404ec0088bbSAlexeiFedorov 				 GPT_L1_TYPE_CONT_DESC) {
1405ec0088bbSAlexeiFedorov 		/* Read GPI from Contiguous descriptor */
1406ec0088bbSAlexeiFedorov 		gpi_info->gpi = (unsigned int)GPT_L1_CONT_GPI(gpi_info->gpt_l1_desc);
1407ec0088bbSAlexeiFedorov 	} else {
1408ec0088bbSAlexeiFedorov 		/* Read GPI from Granules descriptor */
1409ec0088bbSAlexeiFedorov 		gpi_info->gpi = (unsigned int)((gpi_info->gpt_l1_desc >> gpi_info->gpi_shift) &
1410ec0088bbSAlexeiFedorov 						GPT_L1_GRAN_DESC_GPI_MASK);
1411ec0088bbSAlexeiFedorov 	}
1412ec0088bbSAlexeiFedorov }
1413ec0088bbSAlexeiFedorov 
1414ec0088bbSAlexeiFedorov static void flush_page_to_popa(uintptr_t addr)
1415ec0088bbSAlexeiFedorov {
1416ec0088bbSAlexeiFedorov 	size_t size = GPT_PGS_ACTUAL_SIZE(gpt_config.p);
1417ec0088bbSAlexeiFedorov 
1418ec0088bbSAlexeiFedorov 	if (is_feat_mte2_supported()) {
1419ec0088bbSAlexeiFedorov 		flush_dcache_to_popa_range_mte2(addr, size);
1420ec0088bbSAlexeiFedorov 	} else {
1421ec0088bbSAlexeiFedorov 		flush_dcache_to_popa_range(addr, size);
1422ec0088bbSAlexeiFedorov 	}
1423ec0088bbSAlexeiFedorov }
1424ec0088bbSAlexeiFedorov 
1425ec0088bbSAlexeiFedorov /*
1426ec0088bbSAlexeiFedorov  * Helper function to check if all L1 entries in 2MB block have
1427ec0088bbSAlexeiFedorov  * the same Granules descriptor value.
1428ec0088bbSAlexeiFedorov  *
1429ec0088bbSAlexeiFedorov  * Parameters
1430ec0088bbSAlexeiFedorov  *   base		Base address of the region to be checked
1431ec0088bbSAlexeiFedorov  *   gpi_info		Pointer to 'gpt_config_t' structure
1432ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules descriptor with all entries
1433ec0088bbSAlexeiFedorov  *			set to the same GPI.
1434ec0088bbSAlexeiFedorov  *
1435ec0088bbSAlexeiFedorov  * Return
1436ec0088bbSAlexeiFedorov  *   true if L1 all entries have the same descriptor value, false otherwise.
1437ec0088bbSAlexeiFedorov  */
1438ec0088bbSAlexeiFedorov __unused static bool check_fuse_2mb(uint64_t base, const gpi_info_t *gpi_info,
1439ec0088bbSAlexeiFedorov 					uint64_t l1_desc)
1440ec0088bbSAlexeiFedorov {
1441ec0088bbSAlexeiFedorov 	/* Last L1 entry index in 2MB block */
1442ec0088bbSAlexeiFedorov 	unsigned int long idx = GPT_L1_INDEX(ALIGN_2MB(base)) +
1443ec0088bbSAlexeiFedorov 						gpt_l1_cnt_2mb - 1UL;
1444ec0088bbSAlexeiFedorov 
1445ec0088bbSAlexeiFedorov 	/* Number of L1 entries in 2MB block */
1446ec0088bbSAlexeiFedorov 	unsigned int cnt = gpt_l1_cnt_2mb;
1447ec0088bbSAlexeiFedorov 
1448ec0088bbSAlexeiFedorov 	/*
1449ec0088bbSAlexeiFedorov 	 * Start check from the last L1 entry and continue until the first
1450ec0088bbSAlexeiFedorov 	 * non-matching to the passed Granules descriptor value is found.
1451ec0088bbSAlexeiFedorov 	 */
1452ec0088bbSAlexeiFedorov 	while (cnt-- != 0U) {
1453ec0088bbSAlexeiFedorov 		if (gpi_info->gpt_l1_addr[idx--] != l1_desc) {
1454ec0088bbSAlexeiFedorov 			/* Non-matching L1 entry found */
1455ec0088bbSAlexeiFedorov 			return false;
1456ec0088bbSAlexeiFedorov 		}
1457ec0088bbSAlexeiFedorov 	}
1458ec0088bbSAlexeiFedorov 
1459ec0088bbSAlexeiFedorov 	return true;
1460ec0088bbSAlexeiFedorov }
1461ec0088bbSAlexeiFedorov 
1462ec0088bbSAlexeiFedorov __unused static void fuse_2mb(uint64_t base, const gpi_info_t *gpi_info,
1463ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
1464ec0088bbSAlexeiFedorov {
1465ec0088bbSAlexeiFedorov 	/* L1 entry index of the start of 2MB block */
1466ec0088bbSAlexeiFedorov 	unsigned long idx_2 = GPT_L1_INDEX(ALIGN_2MB(base));
1467ec0088bbSAlexeiFedorov 
1468ec0088bbSAlexeiFedorov 	/* 2MB Contiguous descriptor */
1469ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 2MB);
1470ec0088bbSAlexeiFedorov 
1471ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n", __func__, base, l1_desc);
1472ec0088bbSAlexeiFedorov 
1473ec0088bbSAlexeiFedorov 	fill_desc(&gpi_info->gpt_l1_addr[idx_2], l1_cont_desc, L1_QWORDS_2MB);
1474ec0088bbSAlexeiFedorov }
1475ec0088bbSAlexeiFedorov 
1476ec0088bbSAlexeiFedorov /*
1477ec0088bbSAlexeiFedorov  * Helper function to check if all 1st L1 entries of 2MB blocks
1478ec0088bbSAlexeiFedorov  * in 32MB have the same 2MB Contiguous descriptor value.
1479ec0088bbSAlexeiFedorov  *
1480ec0088bbSAlexeiFedorov  * Parameters
1481ec0088bbSAlexeiFedorov  *   base		Base address of the region to be checked
1482ec0088bbSAlexeiFedorov  *   gpi_info		Pointer to 'gpt_config_t' structure
1483ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules descriptor.
1484ec0088bbSAlexeiFedorov  *
1485ec0088bbSAlexeiFedorov  * Return
1486ec0088bbSAlexeiFedorov  *   true if all L1 entries have the same descriptor value, false otherwise.
1487ec0088bbSAlexeiFedorov  */
1488ec0088bbSAlexeiFedorov __unused static bool check_fuse_32mb(uint64_t base, const gpi_info_t *gpi_info,
1489ec0088bbSAlexeiFedorov 					uint64_t l1_desc)
1490ec0088bbSAlexeiFedorov {
1491ec0088bbSAlexeiFedorov 	/* The 1st L1 entry index of the last 2MB block in 32MB */
1492ec0088bbSAlexeiFedorov 	unsigned long idx = GPT_L1_INDEX(ALIGN_32MB(base)) +
1493ec0088bbSAlexeiFedorov 					(15UL * gpt_l1_cnt_2mb);
1494ec0088bbSAlexeiFedorov 
1495ec0088bbSAlexeiFedorov 	/* 2MB Contiguous descriptor */
1496ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 2MB);
1497ec0088bbSAlexeiFedorov 
1498ec0088bbSAlexeiFedorov 	/* Number of 2MB blocks in 32MB */
1499ec0088bbSAlexeiFedorov 	unsigned int cnt = 16U;
1500ec0088bbSAlexeiFedorov 
1501ec0088bbSAlexeiFedorov 	/* Set the first L1 entry to 2MB Contiguous descriptor */
1502ec0088bbSAlexeiFedorov 	gpi_info->gpt_l1_addr[GPT_L1_INDEX(ALIGN_2MB(base))] = l1_cont_desc;
1503ec0088bbSAlexeiFedorov 
1504ec0088bbSAlexeiFedorov 	/*
1505ec0088bbSAlexeiFedorov 	 * Start check from the 1st L1 entry of the last 2MB block and
1506ec0088bbSAlexeiFedorov 	 * continue until the first non-matching to 2MB Contiguous descriptor
1507ec0088bbSAlexeiFedorov 	 * value is found.
1508ec0088bbSAlexeiFedorov 	 */
1509ec0088bbSAlexeiFedorov 	while (cnt-- != 0U) {
1510ec0088bbSAlexeiFedorov 		if (gpi_info->gpt_l1_addr[idx] != l1_cont_desc) {
1511ec0088bbSAlexeiFedorov 			/* Non-matching L1 entry found */
1512ec0088bbSAlexeiFedorov 			return false;
1513ec0088bbSAlexeiFedorov 		}
1514ec0088bbSAlexeiFedorov 		idx -= gpt_l1_cnt_2mb;
1515ec0088bbSAlexeiFedorov 	}
1516ec0088bbSAlexeiFedorov 
1517ec0088bbSAlexeiFedorov 	return true;
1518ec0088bbSAlexeiFedorov }
1519ec0088bbSAlexeiFedorov 
1520ec0088bbSAlexeiFedorov __unused static void fuse_32mb(uint64_t base, const gpi_info_t *gpi_info,
1521ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
1522ec0088bbSAlexeiFedorov {
1523ec0088bbSAlexeiFedorov 	/* L1 entry index of the start of 32MB block */
1524ec0088bbSAlexeiFedorov 	unsigned long idx_32 = GPT_L1_INDEX(ALIGN_32MB(base));
1525ec0088bbSAlexeiFedorov 
1526ec0088bbSAlexeiFedorov 	/* 32MB Contiguous descriptor */
1527ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 32MB);
1528ec0088bbSAlexeiFedorov 
1529ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n", __func__, base, l1_desc);
1530ec0088bbSAlexeiFedorov 
1531ec0088bbSAlexeiFedorov 	fill_desc(&gpi_info->gpt_l1_addr[idx_32], l1_cont_desc, L1_QWORDS_32MB);
1532ec0088bbSAlexeiFedorov }
1533ec0088bbSAlexeiFedorov 
1534ec0088bbSAlexeiFedorov /*
1535ec0088bbSAlexeiFedorov  * Helper function to check if all 1st L1 entries of 32MB blocks
1536ec0088bbSAlexeiFedorov  * in 512MB have the same 32MB Contiguous descriptor value.
1537ec0088bbSAlexeiFedorov  *
1538ec0088bbSAlexeiFedorov  * Parameters
1539ec0088bbSAlexeiFedorov  *   base		Base address of the region to be checked
1540ec0088bbSAlexeiFedorov  *   gpi_info		Pointer to 'gpt_config_t' structure
1541ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules descriptor.
1542ec0088bbSAlexeiFedorov  *
1543ec0088bbSAlexeiFedorov  * Return
1544ec0088bbSAlexeiFedorov  *   true if all L1 entries have the same descriptor value, false otherwise.
1545ec0088bbSAlexeiFedorov  */
1546ec0088bbSAlexeiFedorov __unused static bool check_fuse_512mb(uint64_t base, const gpi_info_t *gpi_info,
1547ec0088bbSAlexeiFedorov 					uint64_t l1_desc)
1548ec0088bbSAlexeiFedorov {
1549ec0088bbSAlexeiFedorov 	/* The 1st L1 entry index of the last 32MB block in 512MB */
1550ec0088bbSAlexeiFedorov 	unsigned long idx = GPT_L1_INDEX(ALIGN_512MB(base)) +
1551ec0088bbSAlexeiFedorov 					(15UL * 16UL * gpt_l1_cnt_2mb);
1552ec0088bbSAlexeiFedorov 
1553ec0088bbSAlexeiFedorov 	/* 32MB Contiguous descriptor */
1554ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 32MB);
1555ec0088bbSAlexeiFedorov 
1556ec0088bbSAlexeiFedorov 	/* Number of 32MB blocks in 512MB */
1557ec0088bbSAlexeiFedorov 	unsigned int cnt = 16U;
1558ec0088bbSAlexeiFedorov 
1559ec0088bbSAlexeiFedorov 	/* Set the first L1 entry to 2MB Contiguous descriptor */
1560ec0088bbSAlexeiFedorov 	gpi_info->gpt_l1_addr[GPT_L1_INDEX(ALIGN_32MB(base))] = l1_cont_desc;
1561ec0088bbSAlexeiFedorov 
1562ec0088bbSAlexeiFedorov 	/*
1563ec0088bbSAlexeiFedorov 	 * Start check from the 1st L1 entry of the last 32MB block and
1564ec0088bbSAlexeiFedorov 	 * continue until the first non-matching to 32MB Contiguous descriptor
1565ec0088bbSAlexeiFedorov 	 * value is found.
1566ec0088bbSAlexeiFedorov 	 */
1567ec0088bbSAlexeiFedorov 	while (cnt-- != 0U) {
1568ec0088bbSAlexeiFedorov 		if (gpi_info->gpt_l1_addr[idx] != l1_cont_desc) {
1569ec0088bbSAlexeiFedorov 			/* Non-matching L1 entry found */
1570ec0088bbSAlexeiFedorov 			return false;
1571ec0088bbSAlexeiFedorov 		}
1572ec0088bbSAlexeiFedorov 		idx -= 16UL * gpt_l1_cnt_2mb;
1573ec0088bbSAlexeiFedorov 	}
1574ec0088bbSAlexeiFedorov 
1575ec0088bbSAlexeiFedorov 	return true;
1576ec0088bbSAlexeiFedorov }
1577ec0088bbSAlexeiFedorov 
1578ec0088bbSAlexeiFedorov __unused static void fuse_512mb(uint64_t base, const gpi_info_t *gpi_info,
1579ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
1580ec0088bbSAlexeiFedorov {
1581ec0088bbSAlexeiFedorov 	/* L1 entry index of the start of 512MB block */
1582ec0088bbSAlexeiFedorov 	unsigned long idx_512 = GPT_L1_INDEX(ALIGN_512MB(base));
1583ec0088bbSAlexeiFedorov 
1584ec0088bbSAlexeiFedorov 	/* 512MB Contiguous descriptor */
1585ec0088bbSAlexeiFedorov 	uint64_t l1_cont_desc = GPT_L1_CONT_DESC(l1_desc, 512MB);
1586ec0088bbSAlexeiFedorov 
1587ec0088bbSAlexeiFedorov 	VERBOSE("GPT: %s(0x%"PRIxPTR" 0x%"PRIx64")\n", __func__, base, l1_desc);
1588ec0088bbSAlexeiFedorov 
1589ec0088bbSAlexeiFedorov 	fill_desc(&gpi_info->gpt_l1_addr[idx_512], l1_cont_desc, L1_QWORDS_512MB);
1590ec0088bbSAlexeiFedorov }
1591ec0088bbSAlexeiFedorov 
1592ec0088bbSAlexeiFedorov /*
1593ec0088bbSAlexeiFedorov  * Helper function to convert GPI entries in a single L1 table
1594ec0088bbSAlexeiFedorov  * from Granules to Contiguous descriptor.
1595ec0088bbSAlexeiFedorov  *
1596ec0088bbSAlexeiFedorov  * Parameters
1597ec0088bbSAlexeiFedorov  *   base		Base address of the region to be written
1598ec0088bbSAlexeiFedorov  *   gpi_info		Pointer to 'gpt_config_t' structure
1599ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules descriptor with all entries
1600ec0088bbSAlexeiFedorov  *			set to the same GPI.
1601ec0088bbSAlexeiFedorov  */
1602ec0088bbSAlexeiFedorov __unused static void fuse_block(uint64_t base, const gpi_info_t *gpi_info,
1603ec0088bbSAlexeiFedorov 				uint64_t l1_desc)
1604ec0088bbSAlexeiFedorov {
1605ec0088bbSAlexeiFedorov 	/* Start with check for 2MB block */
1606ec0088bbSAlexeiFedorov 	if (!check_fuse_2mb(base, gpi_info, l1_desc)) {
1607ec0088bbSAlexeiFedorov 		/* Check for 2MB fusing failed */
1608ec0088bbSAlexeiFedorov 		return;
1609ec0088bbSAlexeiFedorov 	}
1610ec0088bbSAlexeiFedorov 
1611ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK == 2)
1612ec0088bbSAlexeiFedorov 	fuse_2mb(base, gpi_info, l1_desc);
1613ec0088bbSAlexeiFedorov #else
1614ec0088bbSAlexeiFedorov 	/* Check for 32MB block */
1615ec0088bbSAlexeiFedorov 	if (!check_fuse_32mb(base, gpi_info, l1_desc)) {
1616ec0088bbSAlexeiFedorov 		/* Check for 32MB fusing failed, fuse to 2MB */
1617ec0088bbSAlexeiFedorov 		fuse_2mb(base, gpi_info, l1_desc);
1618ec0088bbSAlexeiFedorov 		return;
1619ec0088bbSAlexeiFedorov 	}
1620ec0088bbSAlexeiFedorov 
1621ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK == 32)
1622ec0088bbSAlexeiFedorov 	fuse_32mb(base, gpi_info, l1_desc);
1623ec0088bbSAlexeiFedorov #else
1624ec0088bbSAlexeiFedorov 	/* Check for 512MB block */
1625ec0088bbSAlexeiFedorov 	if (!check_fuse_512mb(base, gpi_info, l1_desc)) {
1626ec0088bbSAlexeiFedorov 		/* Check for 512MB fusing failed, fuse to 32MB */
1627ec0088bbSAlexeiFedorov 		fuse_32mb(base, gpi_info, l1_desc);
1628ec0088bbSAlexeiFedorov 		return;
1629ec0088bbSAlexeiFedorov 	}
1630ec0088bbSAlexeiFedorov 
1631ec0088bbSAlexeiFedorov 	/* Fuse to 512MB */
1632ec0088bbSAlexeiFedorov 	fuse_512mb(base, gpi_info, l1_desc);
1633ec0088bbSAlexeiFedorov 
1634ec0088bbSAlexeiFedorov #endif	/* RME_GPT_MAX_BLOCK == 32 */
1635ec0088bbSAlexeiFedorov #endif	/* RME_GPT_MAX_BLOCK == 2 */
1636ec0088bbSAlexeiFedorov }
1637ec0088bbSAlexeiFedorov 
1638ec0088bbSAlexeiFedorov /*
1639ec0088bbSAlexeiFedorov  * Helper function to convert GPI entries in a single L1 table
1640ec0088bbSAlexeiFedorov  * from Contiguous to Granules descriptor. This function updates
1641ec0088bbSAlexeiFedorov  * descriptor to Granules in passed 'gpt_config_t' structure as
1642ec0088bbSAlexeiFedorov  * the result of shuttering.
1643ec0088bbSAlexeiFedorov  *
1644ec0088bbSAlexeiFedorov  * Parameters
1645ec0088bbSAlexeiFedorov  *   base		Base address of the region to be written
1646ec0088bbSAlexeiFedorov  *   gpi_info		Pointer to 'gpt_config_t' structure
1647ec0088bbSAlexeiFedorov  *   l1_desc		GPT Granules descriptor set this range to.
1648ec0088bbSAlexeiFedorov  */
1649ec0088bbSAlexeiFedorov __unused static void shatter_block(uint64_t base, gpi_info_t *gpi_info,
1650ec0088bbSAlexeiFedorov 				   uint64_t l1_desc)
1651ec0088bbSAlexeiFedorov {
1652ec0088bbSAlexeiFedorov 	/* Look-up table for 2MB, 32MB and 512MB locks shattering */
1653ec0088bbSAlexeiFedorov 	static const gpt_shatter_func gpt_shatter_lookup[] = {
1654ec0088bbSAlexeiFedorov 		shatter_2mb,
1655ec0088bbSAlexeiFedorov 		shatter_32mb,
1656ec0088bbSAlexeiFedorov 		shatter_512mb
1657ec0088bbSAlexeiFedorov 	};
1658ec0088bbSAlexeiFedorov 
1659ec0088bbSAlexeiFedorov 	/* Look-up table for invalidation TLBs for 2MB, 32MB and 512MB blocks */
1660ec0088bbSAlexeiFedorov 	static const gpt_tlbi_lookup_t tlbi_lookup[] = {
1661ec0088bbSAlexeiFedorov 		{ tlbirpalos_2m, ~(SZ_2M - 1UL) },
1662ec0088bbSAlexeiFedorov 		{ tlbirpalos_32m, ~(SZ_32M - 1UL) },
1663ec0088bbSAlexeiFedorov 		{ tlbirpalos_512m, ~(SZ_512M - 1UL) }
1664ec0088bbSAlexeiFedorov 	};
1665ec0088bbSAlexeiFedorov 
1666ec0088bbSAlexeiFedorov 	/* Get shattering level from Contig field of Contiguous descriptor */
1667ec0088bbSAlexeiFedorov 	unsigned long level = GPT_L1_CONT_CONTIG(gpi_info->gpt_l1_desc) - 1UL;
1668ec0088bbSAlexeiFedorov 
1669ec0088bbSAlexeiFedorov 	/* Shatter contiguous block */
1670ec0088bbSAlexeiFedorov 	gpt_shatter_lookup[level](base, gpi_info, l1_desc);
1671ec0088bbSAlexeiFedorov 
1672ec0088bbSAlexeiFedorov 	tlbi_lookup[level].function(base & tlbi_lookup[level].mask);
1673ec0088bbSAlexeiFedorov 	dsbosh();
1674ec0088bbSAlexeiFedorov 
1675ec0088bbSAlexeiFedorov 	/*
1676ec0088bbSAlexeiFedorov 	 * Update 'gpt_config_t' structure's descriptor to Granules to reflect
1677ec0088bbSAlexeiFedorov 	 * the shattered GPI back to caller.
1678ec0088bbSAlexeiFedorov 	 */
1679ec0088bbSAlexeiFedorov 	gpi_info->gpt_l1_desc = l1_desc;
1680ec0088bbSAlexeiFedorov }
1681ec0088bbSAlexeiFedorov 
1682ec0088bbSAlexeiFedorov /*
16836a00e9b0SRobert Wakim  * This function is the granule transition delegate service. When a granule
16846a00e9b0SRobert Wakim  * transition request occurs it is routed to this function to have the request,
1685ec0088bbSAlexeiFedorov  * if valid, fulfilled following A1.1.1 Delegate of RME supplement.
1686f19dc624Sjohpow01  *
16876a00e9b0SRobert Wakim  * TODO: implement support for transitioning multiple granules at once.
1688f19dc624Sjohpow01  *
1689f19dc624Sjohpow01  * Parameters
16906a00e9b0SRobert Wakim  *   base		Base address of the region to transition, must be
16916a00e9b0SRobert Wakim  *			aligned to granule size.
16926a00e9b0SRobert Wakim  *   size		Size of region to transition, must be aligned to granule
16936a00e9b0SRobert Wakim  *			size.
1694f19dc624Sjohpow01  *   src_sec_state	Security state of the caller.
1695f19dc624Sjohpow01  *
1696f19dc624Sjohpow01  * Return
1697f19dc624Sjohpow01  *   Negative Linux error code in the event of a failure, 0 for success.
1698f19dc624Sjohpow01  */
16996a00e9b0SRobert Wakim int gpt_delegate_pas(uint64_t base, size_t size, unsigned int src_sec_state)
1700f19dc624Sjohpow01 {
17016a00e9b0SRobert Wakim 	gpi_info_t gpi_info;
1702ec0088bbSAlexeiFedorov 	uint64_t nse, __unused l1_desc;
17036a00e9b0SRobert Wakim 	unsigned int target_pas;
1704ec0088bbSAlexeiFedorov 	int res;
1705f19dc624Sjohpow01 
1706b99926efSAlexeiFedorov 	/* Ensure that the tables have been set up before taking requests */
17076a00e9b0SRobert Wakim 	assert(gpt_config.plat_gpt_l0_base != 0UL);
17086a00e9b0SRobert Wakim 
1709b99926efSAlexeiFedorov 	/* Ensure that caches are enabled */
17106a00e9b0SRobert Wakim 	assert((read_sctlr_el3() & SCTLR_C_BIT) != 0UL);
17116a00e9b0SRobert Wakim 
1712b99926efSAlexeiFedorov 	/* See if this is a single or a range of granule transition */
17136a00e9b0SRobert Wakim 	if (size != GPT_PGS_ACTUAL_SIZE(gpt_config.p)) {
1714f19dc624Sjohpow01 		return -EINVAL;
1715f19dc624Sjohpow01 	}
1716f19dc624Sjohpow01 
17176a00e9b0SRobert Wakim 	/* Check that base and size are valid */
17186a00e9b0SRobert Wakim 	if ((ULONG_MAX - base) < size) {
1719b99926efSAlexeiFedorov 		VERBOSE("GPT: Transition request address overflow!\n");
17206a00e9b0SRobert Wakim 		VERBOSE("      Base=0x%"PRIx64"\n", base);
17216a00e9b0SRobert Wakim 		VERBOSE("      Size=0x%lx\n", size);
17226a00e9b0SRobert Wakim 		return -EINVAL;
17236a00e9b0SRobert Wakim 	}
17246a00e9b0SRobert Wakim 
1725b99926efSAlexeiFedorov 	/* Make sure base and size are valid */
1726b99926efSAlexeiFedorov 	if (((base & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) != 0UL) ||
1727b99926efSAlexeiFedorov 	    ((size & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) != 0UL) ||
17286a00e9b0SRobert Wakim 	    (size == 0UL) ||
17296a00e9b0SRobert Wakim 	    ((base + size) >= GPT_PPS_ACTUAL_SIZE(gpt_config.t))) {
1730b99926efSAlexeiFedorov 		VERBOSE("GPT: Invalid granule transition address range!\n");
17316a00e9b0SRobert Wakim 		VERBOSE("      Base=0x%"PRIx64"\n", base);
17326a00e9b0SRobert Wakim 		VERBOSE("      Size=0x%lx\n", size);
17336a00e9b0SRobert Wakim 		return -EINVAL;
17346a00e9b0SRobert Wakim 	}
17356a00e9b0SRobert Wakim 
1736ec0088bbSAlexeiFedorov 	/* Delegate request can only come from REALM or SECURE */
1737ec0088bbSAlexeiFedorov 	if ((src_sec_state != SMC_FROM_REALM) &&
1738ec0088bbSAlexeiFedorov 	    (src_sec_state != SMC_FROM_SECURE)) {
1739ec0088bbSAlexeiFedorov 		VERBOSE("GPT: Invalid caller security state 0x%x\n",
1740ec0088bbSAlexeiFedorov 							src_sec_state);
1741ec0088bbSAlexeiFedorov 		return -EINVAL;
1742ec0088bbSAlexeiFedorov 	}
1743ec0088bbSAlexeiFedorov 
1744ec0088bbSAlexeiFedorov 	if (src_sec_state == SMC_FROM_REALM) {
17456a00e9b0SRobert Wakim 		target_pas = GPT_GPI_REALM;
1746ec0088bbSAlexeiFedorov 		nse = (uint64_t)GPT_NSE_REALM << GPT_NSE_SHIFT;
1747ec0088bbSAlexeiFedorov 		l1_desc = GPT_L1_REALM_DESC;
1748ec0088bbSAlexeiFedorov 	} else {
17496a00e9b0SRobert Wakim 		target_pas = GPT_GPI_SECURE;
1750ec0088bbSAlexeiFedorov 		nse = (uint64_t)GPT_NSE_SECURE << GPT_NSE_SHIFT;
1751ec0088bbSAlexeiFedorov 		l1_desc = GPT_L1_SECURE_DESC;
1752ec0088bbSAlexeiFedorov 	}
1753ec0088bbSAlexeiFedorov 
1754ec0088bbSAlexeiFedorov 	res = get_gpi_params(base, &gpi_info);
1755ec0088bbSAlexeiFedorov 	if (res != 0) {
1756ec0088bbSAlexeiFedorov 		return res;
17576a00e9b0SRobert Wakim 	}
17586a00e9b0SRobert Wakim 
17596a00e9b0SRobert Wakim 	/*
1760d766084fSAlexeiFedorov 	 * Access to GPT is controlled by a lock to ensure that no more
1761d766084fSAlexeiFedorov 	 * than one CPU is allowed to make changes at any given time.
17626a00e9b0SRobert Wakim 	 */
1763d766084fSAlexeiFedorov 	GPT_LOCK;
1764ec0088bbSAlexeiFedorov 	read_gpi(&gpi_info);
17656a00e9b0SRobert Wakim 
17666a00e9b0SRobert Wakim 	/* Check that the current address is in NS state */
17676a00e9b0SRobert Wakim 	if (gpi_info.gpi != GPT_GPI_NS) {
1768b99926efSAlexeiFedorov 		VERBOSE("GPT: Only Granule in NS state can be delegated.\n");
17696a00e9b0SRobert Wakim 		VERBOSE("      Caller: %u, Current GPI: %u\n", src_sec_state,
17706a00e9b0SRobert Wakim 			gpi_info.gpi);
1771d766084fSAlexeiFedorov 		GPT_UNLOCK;
1772e50fedbcSJavier Almansa Sobrino 		return -EPERM;
17736a00e9b0SRobert Wakim 	}
17746a00e9b0SRobert Wakim 
1775ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
1776ec0088bbSAlexeiFedorov 	/* Check for Contiguous descriptor */
1777ec0088bbSAlexeiFedorov 	if ((gpi_info.gpt_l1_desc & GPT_L1_TYPE_CONT_DESC_MASK) ==
1778ec0088bbSAlexeiFedorov 					GPT_L1_TYPE_CONT_DESC) {
1779ec0088bbSAlexeiFedorov 		shatter_block(base, &gpi_info, GPT_L1_NS_DESC);
1780f19dc624Sjohpow01 	}
1781ec0088bbSAlexeiFedorov #endif
17826a00e9b0SRobert Wakim 	/*
17836a00e9b0SRobert Wakim 	 * In order to maintain mutual distrust between Realm and Secure
17846a00e9b0SRobert Wakim 	 * states, remove any data speculatively fetched into the target
1785ec0088bbSAlexeiFedorov 	 * physical address space.
1786ec0088bbSAlexeiFedorov 	 * Issue DC CIPAPA or DC_CIGDPAPA on implementations with FEAT_MTE2.
17876a00e9b0SRobert Wakim 	 */
1788ec0088bbSAlexeiFedorov 	flush_page_to_popa(base | nse);
17896a00e9b0SRobert Wakim 
17906a00e9b0SRobert Wakim 	write_gpt(&gpi_info.gpt_l1_desc, gpi_info.gpt_l1_addr,
17916a00e9b0SRobert Wakim 		  gpi_info.gpi_shift, gpi_info.idx, target_pas);
17926a00e9b0SRobert Wakim 
1793ec0088bbSAlexeiFedorov 	/* Ensure that all agents observe the new configuration */
1794ec0088bbSAlexeiFedorov 	tlbi_page_dsbosh(base);
17956a00e9b0SRobert Wakim 
17966a00e9b0SRobert Wakim 	nse = (uint64_t)GPT_NSE_NS << GPT_NSE_SHIFT;
17976a00e9b0SRobert Wakim 
1798ec0088bbSAlexeiFedorov 	/* Ensure that the scrubbed data have made it past the PoPA */
1799ec0088bbSAlexeiFedorov 	flush_page_to_popa(base | nse);
18006a00e9b0SRobert Wakim 
1801ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
1802ec0088bbSAlexeiFedorov 	if (gpi_info.gpt_l1_desc == l1_desc) {
1803ec0088bbSAlexeiFedorov 		/* Try to fuse */
1804ec0088bbSAlexeiFedorov 		fuse_block(base, &gpi_info, l1_desc);
1805ec0088bbSAlexeiFedorov 	}
1806ec0088bbSAlexeiFedorov #endif
1807ec0088bbSAlexeiFedorov 
1808d766084fSAlexeiFedorov 	/* Unlock the lock to GPT */
1809d766084fSAlexeiFedorov 	GPT_UNLOCK;
18106a00e9b0SRobert Wakim 
18116a00e9b0SRobert Wakim 	/*
18126a00e9b0SRobert Wakim 	 * The isb() will be done as part of context
1813b99926efSAlexeiFedorov 	 * synchronization when returning to lower EL.
18146a00e9b0SRobert Wakim 	 */
1815b99926efSAlexeiFedorov 	VERBOSE("GPT: Granule 0x%"PRIx64" GPI 0x%x->0x%x\n",
18166a00e9b0SRobert Wakim 		base, gpi_info.gpi, target_pas);
1817f19dc624Sjohpow01 
1818f19dc624Sjohpow01 	return 0;
1819f19dc624Sjohpow01 }
1820f19dc624Sjohpow01 
1821f19dc624Sjohpow01 /*
18226a00e9b0SRobert Wakim  * This function is the granule transition undelegate service. When a granule
1823f19dc624Sjohpow01  * transition request occurs it is routed to this function where the request is
1824f19dc624Sjohpow01  * validated then fulfilled if possible.
1825f19dc624Sjohpow01  *
1826f19dc624Sjohpow01  * TODO: implement support for transitioning multiple granules at once.
1827f19dc624Sjohpow01  *
1828f19dc624Sjohpow01  * Parameters
1829f19dc624Sjohpow01  *   base		Base address of the region to transition, must be
1830f19dc624Sjohpow01  *			aligned to granule size.
1831f19dc624Sjohpow01  *   size		Size of region to transition, must be aligned to granule
1832f19dc624Sjohpow01  *			size.
1833f19dc624Sjohpow01  *   src_sec_state	Security state of the caller.
1834f19dc624Sjohpow01  *
1835f19dc624Sjohpow01  * Return
1836f19dc624Sjohpow01  *    Negative Linux error code in the event of a failure, 0 for success.
1837f19dc624Sjohpow01  */
18386a00e9b0SRobert Wakim int gpt_undelegate_pas(uint64_t base, size_t size, unsigned int src_sec_state)
1839f19dc624Sjohpow01 {
18406a00e9b0SRobert Wakim 	gpi_info_t gpi_info;
1841ec0088bbSAlexeiFedorov 	uint64_t nse, __unused l1_desc;
18426a00e9b0SRobert Wakim 	int res;
1843f19dc624Sjohpow01 
1844b99926efSAlexeiFedorov 	/* Ensure that the tables have been set up before taking requests */
18456a00e9b0SRobert Wakim 	assert(gpt_config.plat_gpt_l0_base != 0UL);
1846f19dc624Sjohpow01 
1847b99926efSAlexeiFedorov 	/* Ensure that MMU and caches are enabled */
18486a00e9b0SRobert Wakim 	assert((read_sctlr_el3() & SCTLR_C_BIT) != 0UL);
184977612b90SSoby Mathew 
1850b99926efSAlexeiFedorov 	/* See if this is a single or a range of granule transition */
18516a00e9b0SRobert Wakim 	if (size != GPT_PGS_ACTUAL_SIZE(gpt_config.p)) {
18526a00e9b0SRobert Wakim 		return -EINVAL;
18536a00e9b0SRobert Wakim 	}
18546a00e9b0SRobert Wakim 
18556a00e9b0SRobert Wakim 	/* Check that base and size are valid */
1856f19dc624Sjohpow01 	if ((ULONG_MAX - base) < size) {
1857b99926efSAlexeiFedorov 		VERBOSE("GPT: Transition request address overflow!\n");
18582461bd3aSManish Pandey 		VERBOSE("      Base=0x%"PRIx64"\n", base);
1859f19dc624Sjohpow01 		VERBOSE("      Size=0x%lx\n", size);
1860f19dc624Sjohpow01 		return -EINVAL;
1861f19dc624Sjohpow01 	}
1862f19dc624Sjohpow01 
1863b99926efSAlexeiFedorov 	/* Make sure base and size are valid */
1864b99926efSAlexeiFedorov 	if (((base & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) != 0UL) ||
1865b99926efSAlexeiFedorov 	    ((size & (GPT_PGS_ACTUAL_SIZE(gpt_config.p) - 1UL)) != 0UL) ||
18666a00e9b0SRobert Wakim 	    (size == 0UL) ||
1867f19dc624Sjohpow01 	    ((base + size) >= GPT_PPS_ACTUAL_SIZE(gpt_config.t))) {
1868b99926efSAlexeiFedorov 		VERBOSE("GPT: Invalid granule transition address range!\n");
18692461bd3aSManish Pandey 		VERBOSE("      Base=0x%"PRIx64"\n", base);
1870f19dc624Sjohpow01 		VERBOSE("      Size=0x%lx\n", size);
1871f19dc624Sjohpow01 		return -EINVAL;
1872f19dc624Sjohpow01 	}
1873f19dc624Sjohpow01 
18746a00e9b0SRobert Wakim 	res = get_gpi_params(base, &gpi_info);
18756a00e9b0SRobert Wakim 	if (res != 0) {
18766a00e9b0SRobert Wakim 		return res;
1877f19dc624Sjohpow01 	}
1878f19dc624Sjohpow01 
1879ec0088bbSAlexeiFedorov 	/*
1880d766084fSAlexeiFedorov 	 * Access to GPT is controlled by a lock to ensure that no more
1881d766084fSAlexeiFedorov 	 * than one CPU is allowed to make changes at any given time.
1882ec0088bbSAlexeiFedorov 	 */
1883d766084fSAlexeiFedorov 	GPT_LOCK;
1884ec0088bbSAlexeiFedorov 	read_gpi(&gpi_info);
1885ec0088bbSAlexeiFedorov 
18866a00e9b0SRobert Wakim 	/* Check that the current address is in the delegated state */
1887ec0088bbSAlexeiFedorov 	if ((src_sec_state == SMC_FROM_REALM) &&
1888ec0088bbSAlexeiFedorov 		(gpi_info.gpi == GPT_GPI_REALM)) {
1889ec0088bbSAlexeiFedorov 		l1_desc = GPT_L1_REALM_DESC;
1890ec0088bbSAlexeiFedorov 		nse = (uint64_t)GPT_NSE_REALM << GPT_NSE_SHIFT;
1891ec0088bbSAlexeiFedorov 	} else if ((src_sec_state == SMC_FROM_SECURE) &&
1892ec0088bbSAlexeiFedorov 		(gpi_info.gpi == GPT_GPI_SECURE)) {
1893ec0088bbSAlexeiFedorov 		l1_desc = GPT_L1_SECURE_DESC;
1894ec0088bbSAlexeiFedorov 		nse = (uint64_t)GPT_NSE_SECURE << GPT_NSE_SHIFT;
1895ec0088bbSAlexeiFedorov 	} else {
1896ec0088bbSAlexeiFedorov 		VERBOSE("GPT: Only Granule in REALM or SECURE state can be undelegated\n");
1897b99926efSAlexeiFedorov 		VERBOSE("      Caller: %u Current GPI: %u\n", src_sec_state,
18986a00e9b0SRobert Wakim 			gpi_info.gpi);
1899d766084fSAlexeiFedorov 		GPT_UNLOCK;
1900e50fedbcSJavier Almansa Sobrino 		return -EPERM;
19016a00e9b0SRobert Wakim 	}
1902f19dc624Sjohpow01 
1903ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
1904ec0088bbSAlexeiFedorov 	/* Check for Contiguous descriptor */
1905ec0088bbSAlexeiFedorov 	if ((gpi_info.gpt_l1_desc & GPT_L1_TYPE_CONT_DESC_MASK) ==
1906ec0088bbSAlexeiFedorov 					GPT_L1_TYPE_CONT_DESC) {
1907ec0088bbSAlexeiFedorov 		shatter_block(base, &gpi_info, l1_desc);
1908ec0088bbSAlexeiFedorov 	}
1909ec0088bbSAlexeiFedorov #endif
1910ec0088bbSAlexeiFedorov 	/*
1911ec0088bbSAlexeiFedorov 	 * In order to maintain mutual distrust between Realm and Secure
19126a00e9b0SRobert Wakim 	 * states, remove access now, in order to guarantee that writes
19136a00e9b0SRobert Wakim 	 * to the currently-accessible physical address space will not
19146a00e9b0SRobert Wakim 	 * later become observable.
19156a00e9b0SRobert Wakim 	 */
19166a00e9b0SRobert Wakim 	write_gpt(&gpi_info.gpt_l1_desc, gpi_info.gpt_l1_addr,
19176a00e9b0SRobert Wakim 		  gpi_info.gpi_shift, gpi_info.idx, GPT_GPI_NO_ACCESS);
19186a00e9b0SRobert Wakim 
1919ec0088bbSAlexeiFedorov 	/* Ensure that all agents observe the new NO_ACCESS configuration */
1920ec0088bbSAlexeiFedorov 	tlbi_page_dsbosh(base);
19216a00e9b0SRobert Wakim 
1922ec0088bbSAlexeiFedorov 	/* Ensure that the scrubbed data have made it past the PoPA */
1923ec0088bbSAlexeiFedorov 	flush_page_to_popa(base | nse);
19246a00e9b0SRobert Wakim 
19256a00e9b0SRobert Wakim 	/*
1926ec0088bbSAlexeiFedorov 	 * Remove any data loaded speculatively in NS space from before
1927ec0088bbSAlexeiFedorov 	 * the scrubbing.
19286a00e9b0SRobert Wakim 	 */
19296a00e9b0SRobert Wakim 	nse = (uint64_t)GPT_NSE_NS << GPT_NSE_SHIFT;
19306a00e9b0SRobert Wakim 
1931ec0088bbSAlexeiFedorov 	flush_page_to_popa(base | nse);
19326a00e9b0SRobert Wakim 
1933ec0088bbSAlexeiFedorov 	/* Clear existing GPI encoding and transition granule */
19346a00e9b0SRobert Wakim 	write_gpt(&gpi_info.gpt_l1_desc, gpi_info.gpt_l1_addr,
19356a00e9b0SRobert Wakim 		  gpi_info.gpi_shift, gpi_info.idx, GPT_GPI_NS);
19366a00e9b0SRobert Wakim 
19376a00e9b0SRobert Wakim 	/* Ensure that all agents observe the new NS configuration */
1938ec0088bbSAlexeiFedorov 	tlbi_page_dsbosh(base);
1939f19dc624Sjohpow01 
1940ec0088bbSAlexeiFedorov #if (RME_GPT_MAX_BLOCK != 0)
1941ec0088bbSAlexeiFedorov 	if (gpi_info.gpt_l1_desc == GPT_L1_NS_DESC) {
1942ec0088bbSAlexeiFedorov 		/* Try to fuse */
1943ec0088bbSAlexeiFedorov 		fuse_block(base, &gpi_info, GPT_L1_NS_DESC);
1944ec0088bbSAlexeiFedorov 	}
1945ec0088bbSAlexeiFedorov #endif
1946d766084fSAlexeiFedorov 	/* Unlock the lock to GPT */
1947d766084fSAlexeiFedorov 	GPT_UNLOCK;
1948f19dc624Sjohpow01 
194977612b90SSoby Mathew 	/*
195077612b90SSoby Mathew 	 * The isb() will be done as part of context
1951b99926efSAlexeiFedorov 	 * synchronization when returning to lower EL.
195277612b90SSoby Mathew 	 */
1953b99926efSAlexeiFedorov 	VERBOSE("GPT: Granule 0x%"PRIx64" GPI 0x%x->0x%x\n",
19546a00e9b0SRobert Wakim 		base, gpi_info.gpi, GPT_GPI_NS);
1955f19dc624Sjohpow01 
1956f19dc624Sjohpow01 	return 0;
1957f19dc624Sjohpow01 }
1958