xref: /rk3399_ARM-atf/lib/xlat_tables_v2/xlat_tables_private.h (revision 3a1b7b108aec527597075b48aa929a622fff23da)
1 /*
2  * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef __XLAT_TABLES_PRIVATE_H__
8 #define __XLAT_TABLES_PRIVATE_H__
9 
10 #include <platform_def.h>
11 #include <xlat_tables_defs.h>
12 
13 #if PLAT_XLAT_TABLES_DYNAMIC
14 /*
15  * Private shifts and masks to access fields of an mmap attribute
16  */
17 /* Dynamic or static */
18 #define MT_DYN_SHIFT		U(31)
19 
20 /*
21  * Memory mapping private attributes
22  *
23  * Private attributes not exposed in the public header.
24  */
25 
26 /*
27  * Regions mapped before the MMU can't be unmapped dynamically (they are
28  * static) and regions mapped with MMU enabled can be unmapped. This
29  * behaviour can't be overridden.
30  *
31  * Static regions can overlap each other, dynamic regions can't.
32  */
33 #define MT_STATIC	(U(0) << MT_DYN_SHIFT)
34 #define MT_DYNAMIC	(U(1) << MT_DYN_SHIFT)
35 
36 #endif /* PLAT_XLAT_TABLES_DYNAMIC */
37 
38 /*
39  * Invalidate all TLB entries that match the given virtual address. This
40  * operation applies to all PEs in the same Inner Shareable domain as the PE
41  * that executes this function. This functions must be called for every
42  * translation table entry that is modified.
43  *
44  * xlat_arch_tlbi_va() applies the invalidation to the exception level of the
45  * current translation regime, whereas xlat_arch_tlbi_va_regime() applies it to
46  * the given translation regime.
47  *
48  * Note, however, that it is architecturally UNDEFINED to invalidate TLB entries
49  * pertaining to a higher exception level, e.g. invalidating EL3 entries from
50  * S-EL1.
51  */
52 void xlat_arch_tlbi_va(uintptr_t va);
53 void xlat_arch_tlbi_va_regime(uintptr_t va, xlat_regime_t xlat_regime);
54 
55 /*
56  * This function has to be called at the end of any code that uses the function
57  * xlat_arch_tlbi_va().
58  */
59 void xlat_arch_tlbi_va_sync(void);
60 
61 /* Print VA, PA, size and attributes of all regions in the mmap array. */
62 void print_mmap(mmap_region_t *const mmap);
63 
64 /*
65  * Print the current state of the translation tables by reading them from
66  * memory.
67  */
68 void xlat_tables_print(xlat_ctx_t *ctx);
69 
70 /*
71  * Architecture-specific initialization code.
72  */
73 
74 /* Returns the current Exception Level. The returned EL must be 1 or higher. */
75 int xlat_arch_current_el(void);
76 
77 /*
78  * Return the maximum physical address supported by the hardware.
79  * This value depends on the execution state (AArch32/AArch64).
80  */
81 unsigned long long xlat_arch_get_max_supported_pa(void);
82 
83 /* Enable MMU and configure it to use the specified translation tables. */
84 void enable_mmu_arch(unsigned int flags, uint64_t *base_table,
85 		unsigned long long max_pa, uintptr_t max_va);
86 
87 /*
88  * Return 1 if the MMU of the translation regime managed by the given xlat_ctx_t
89  * is enabled, 0 otherwise.
90  */
91 int is_mmu_enabled_ctx(const xlat_ctx_t *ctx);
92 
93 #endif /* __XLAT_TABLES_PRIVATE_H__ */
94