1 /*
2  * Copyright (c) 2014-2021, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef XLAT_TABLES_H
8 #define XLAT_TABLES_H
9 
10 #include <lib/xlat_tables/xlat_tables_defs.h>
11 
12 #ifndef __ASSEMBLER__
13 #include <stddef.h>
14 #include <stdint.h>
15 
16 #include <lib/xlat_tables/xlat_mmu_helpers.h>
17 
18 /* Helper macro to define entries for mmap_region_t. It creates
19  * identity mappings for each region.
20  */
21 #define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr)
22 
23 /* Helper macro to define entries for mmap_region_t. It allows to
24  * re-map address mappings from 'pa' to 'va' for each region.
25  */
26 #define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)}
27 
28 /*
29  * Shifts and masks to access fields of an mmap attribute
30  */
31 #define MT_TYPE_MASK	U(0x7)
32 #define MT_TYPE(_attr)	((_attr) & MT_TYPE_MASK)
33 /* Access permissions (RO/RW) */
34 #define MT_PERM_SHIFT	U(3)
35 /* Security state (SECURE/NS) */
36 #define MT_SEC_SHIFT	U(4)
37 /* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */
38 #define MT_EXECUTE_SHIFT	U(5)
39 
40 /*
41  * Memory mapping attributes
42  */
43 
44 /*
45  * Memory types supported.
46  * These are organised so that, going down the list, the memory types are
47  * getting weaker; conversely going up the list the memory types are getting
48  * stronger.
49  */
50 #define MT_DEVICE		U(0)
51 #define MT_NON_CACHEABLE	U(1)
52 #define MT_MEMORY		U(2)
53 /* Values up to 7 are reserved to add new memory types in the future */
54 
55 #define MT_RO			(U(0) << MT_PERM_SHIFT)
56 #define MT_RW			(U(1) << MT_PERM_SHIFT)
57 
58 #define MT_SECURE		(U(0) << MT_SEC_SHIFT)
59 #define MT_NS			(U(1) << MT_SEC_SHIFT)
60 
61 /*
62  * Access permissions for instruction execution are only relevant for normal
63  * read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored (and potentially
64  * overridden) otherwise:
65  *  - Device memory is always marked as execute-never.
66  *  - Read-write normal memory is always marked as execute-never.
67  */
68 #define MT_EXECUTE		(U(0) << MT_EXECUTE_SHIFT)
69 #define MT_EXECUTE_NEVER	(U(1) << MT_EXECUTE_SHIFT)
70 
71 /* Compound attributes for most common usages */
72 #define MT_CODE			(MT_MEMORY | MT_RO | MT_EXECUTE)
73 #define MT_RO_DATA		(MT_MEMORY | MT_RO | MT_EXECUTE_NEVER)
74 
75 /* Memory type for EL3 regions */
76 #if ENABLE_RME
77 #error FEAT_RME requires version 2 of the Translation Tables Library
78 #else
79 #define EL3_PAS			MT_SECURE
80 #endif
81 
82 /*
83  * Structure for specifying a single region of memory.
84  */
85 typedef struct mmap_region {
86 	unsigned long long	base_pa;
87 	uintptr_t		base_va;
88 	size_t			size;
89 	unsigned int		attr;
90 } mmap_region_t;
91 
92 /* Generic translation table APIs */
93 void init_xlat_tables(void);
94 void mmap_add_region(unsigned long long base_pa, uintptr_t base_va,
95 		     size_t size, unsigned int attr);
96 void mmap_add(const mmap_region_t *mm);
97 
98 #endif /*__ASSEMBLER__*/
99 #endif /* XLAT_TABLES_H */
100