1 /* 2 * Copyright (c) 2017, 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 <cassert.h> 11 #include <platform_def.h> 12 #include <utils_def.h> 13 14 /* 15 * If the platform hasn't defined a physical and a virtual address space size 16 * default to ADDR_SPACE_SIZE. 17 */ 18 #if ERROR_DEPRECATED 19 # ifdef ADDR_SPACE_SIZE 20 # error "ADDR_SPACE_SIZE is deprecated. Use PLAT_xxx_ADDR_SPACE_SIZE instead." 21 # endif 22 #elif defined(ADDR_SPACE_SIZE) 23 # ifndef PLAT_PHY_ADDR_SPACE_SIZE 24 # define PLAT_PHY_ADDR_SPACE_SIZE ADDR_SPACE_SIZE 25 # endif 26 # ifndef PLAT_VIRT_ADDR_SPACE_SIZE 27 # define PLAT_VIRT_ADDR_SPACE_SIZE ADDR_SPACE_SIZE 28 # endif 29 #endif 30 31 /* The virtual and physical address space sizes must be powers of two. */ 32 CASSERT(IS_POWER_OF_TWO(PLAT_VIRT_ADDR_SPACE_SIZE), 33 assert_valid_virt_addr_space_size); 34 CASSERT(IS_POWER_OF_TWO(PLAT_PHY_ADDR_SPACE_SIZE), 35 assert_valid_phy_addr_space_size); 36 37 /* Struct that holds all information about the translation tables. */ 38 typedef struct { 39 40 /* 41 * Max allowed Virtual and Physical Addresses. 42 */ 43 unsigned long long pa_max_address; 44 uintptr_t va_max_address; 45 46 /* 47 * Array of all memory regions stored in order of ascending end address 48 * and ascending size to simplify the code that allows overlapping 49 * regions. The list is terminated by the first entry with size == 0. 50 */ 51 mmap_region_t *mmap; /* mmap_num + 1 elements */ 52 int mmap_num; 53 54 /* 55 * Array of finer-grain translation tables. 56 * For example, if the initial lookup level is 1 then this array would 57 * contain both level-2 and level-3 entries. 58 */ 59 uint64_t (*tables)[XLAT_TABLE_ENTRIES]; 60 int tables_num; 61 /* 62 * Keep track of how many regions are mapped in each table. The base 63 * table can't be unmapped so it isn't needed to keep track of it. 64 */ 65 #if PLAT_XLAT_TABLES_DYNAMIC 66 int *tables_mapped_regions; 67 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 68 69 int next_table; 70 71 /* 72 * Base translation table. It doesn't need to have the same amount of 73 * entries as the ones used for other levels. 74 */ 75 uint64_t *base_table; 76 int base_table_entries; 77 78 unsigned long long max_pa; 79 uintptr_t max_va; 80 81 /* Level of the base translation table. */ 82 int base_level; 83 84 /* Set to 1 when the translation tables are initialized. */ 85 int initialized; 86 87 /* 88 * Bit mask that has to be ORed to the rest of a translation table 89 * descriptor in order to prohibit execution of code at the exception 90 * level of this translation context. 91 */ 92 uint64_t execute_never_mask; 93 94 } xlat_ctx_t; 95 96 #if PLAT_XLAT_TABLES_DYNAMIC 97 /* 98 * Shifts and masks to access fields of an mmap_attr_t 99 */ 100 /* Dynamic or static */ 101 #define MT_DYN_SHIFT 30 /* 31 would cause undefined behaviours */ 102 103 /* 104 * Memory mapping private attributes 105 * 106 * Private attributes not exposed in the mmap_attr_t enum. 107 */ 108 typedef enum { 109 /* 110 * Regions mapped before the MMU can't be unmapped dynamically (they are 111 * static) and regions mapped with MMU enabled can be unmapped. This 112 * behaviour can't be overridden. 113 * 114 * Static regions can overlap each other, dynamic regions can't. 115 */ 116 MT_STATIC = 0 << MT_DYN_SHIFT, 117 MT_DYNAMIC = 1 << MT_DYN_SHIFT 118 } mmap_priv_attr_t; 119 120 /* 121 * Function used to invalidate all levels of the translation walk for a given 122 * virtual address. It must be called for every translation table entry that is 123 * modified. 124 */ 125 void xlat_arch_tlbi_va(uintptr_t va); 126 127 /* 128 * This function has to be called at the end of any code that uses the function 129 * xlat_arch_tlbi_va(). 130 */ 131 void xlat_arch_tlbi_va_sync(void); 132 133 /* Add a dynamic region to the specified context. */ 134 int mmap_add_dynamic_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 135 136 /* Remove a dynamic region from the specified context. */ 137 int mmap_remove_dynamic_region_ctx(xlat_ctx_t *ctx, uintptr_t base_va, 138 size_t size); 139 140 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 141 142 /* Print VA, PA, size and attributes of all regions in the mmap array. */ 143 void print_mmap(mmap_region_t *const mmap); 144 145 /* 146 * Print the current state of the translation tables by reading them from 147 * memory. 148 */ 149 void xlat_tables_print(xlat_ctx_t *ctx); 150 151 /* 152 * Initialize the translation tables by mapping all regions added to the 153 * specified context. 154 */ 155 void init_xlation_table(xlat_ctx_t *ctx); 156 157 /* Add a static region to the specified context. */ 158 void mmap_add_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 159 160 /* 161 * Architecture-specific initialization code. 162 */ 163 164 /* Returns the current Exception Level. The returned EL must be 1 or higher. */ 165 int xlat_arch_current_el(void); 166 167 /* 168 * Returns the bit mask that has to be ORed to the rest of a translation table 169 * descriptor so that execution of code is prohibited at the given Exception 170 * Level. 171 */ 172 uint64_t xlat_arch_get_xn_desc(int el); 173 174 /* Execute architecture-specific translation table initialization code. */ 175 void init_xlat_tables_arch(unsigned long long max_pa); 176 177 /* Enable MMU and configure it to use the specified translation tables. */ 178 void enable_mmu_arch(unsigned int flags, uint64_t *base_table); 179 180 /* Return 1 if the MMU of this Exception Level is enabled, 0 otherwise. */ 181 int is_mmu_enabled(void); 182 183 #endif /* __XLAT_TABLES_PRIVATE_H__ */ 184