xref: /rk3399_ARM-atf/lib/xlat_tables_v2/xlat_tables_private.h (revision 468e2382756e075ab02849e13990f4bbe2a3a7c6)
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  * Return the execute-never mask that will prevent instruction fetch at the
40  * given translation regime.
41  */
42 uint64_t xlat_arch_regime_get_xn_desc(int xlat_regime);
43 
44 /*
45  * Invalidate all TLB entries that match the given virtual address. This
46  * operation applies to all PEs in the same Inner Shareable domain as the PE
47  * that executes this function. This functions must be called for every
48  * translation table entry that is modified.
49  *
50  * xlat_arch_tlbi_va() applies the invalidation to the exception level of the
51  * current translation regime, whereas xlat_arch_tlbi_va_regime() applies it to
52  * the given translation regime.
53  *
54  * Note, however, that it is architecturally UNDEFINED to invalidate TLB entries
55  * pertaining to a higher exception level, e.g. invalidating EL3 entries from
56  * S-EL1.
57  */
58 void xlat_arch_tlbi_va(uintptr_t va);
59 void xlat_arch_tlbi_va_regime(uintptr_t va, int xlat_regime);
60 
61 /*
62  * This function has to be called at the end of any code that uses the function
63  * xlat_arch_tlbi_va().
64  */
65 void xlat_arch_tlbi_va_sync(void);
66 
67 /* Print VA, PA, size and attributes of all regions in the mmap array. */
68 void xlat_mmap_print(mmap_region_t *const mmap);
69 
70 /*
71  * Print the current state of the translation tables by reading them from
72  * memory.
73  */
74 void xlat_tables_print(xlat_ctx_t *ctx);
75 
76 /*
77  * Returns a block/page table descriptor for the given level and attributes.
78  */
79 uint64_t xlat_desc(const xlat_ctx_t *ctx, uint32_t attr,
80 		   unsigned long long addr_pa, int level);
81 
82 /*
83  * Architecture-specific initialization code.
84  */
85 
86 /* Returns the current Exception Level. The returned EL must be 1 or higher. */
87 int xlat_arch_current_el(void);
88 
89 /*
90  * Return the maximum physical address supported by the hardware.
91  * This value depends on the execution state (AArch32/AArch64).
92  */
93 unsigned long long xlat_arch_get_max_supported_pa(void);
94 
95 /* Enable MMU and configure it to use the specified translation tables. */
96 void setup_mmu_cfg(unsigned int flags, const uint64_t *base_table,
97 		unsigned long long max_pa, uintptr_t max_va);
98 
99 /*
100  * Return 1 if the MMU of the translation regime managed by the given xlat_ctx_t
101  * is enabled, 0 otherwise.
102  */
103 int is_mmu_enabled_ctx(const xlat_ctx_t *ctx);
104 
105 #endif /* __XLAT_TABLES_PRIVATE_H__ */
106