1 /* 2 * Copyright (c) 2017-2020, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef XLAT_TABLES_V2_H 8 #define XLAT_TABLES_V2_H 9 10 #include <lib/xlat_tables/xlat_tables_defs.h> 11 #include <lib/xlat_tables/xlat_tables_v2_helpers.h> 12 13 #ifndef __ASSEMBLER__ 14 #include <stddef.h> 15 #include <stdint.h> 16 17 #include <lib/xlat_tables/xlat_mmu_helpers.h> 18 19 /* 20 * Default granularity size for an mmap_region_t. 21 * Useful when no specific granularity is required. 22 * 23 * By default, choose the biggest possible block size allowed by the 24 * architectural state and granule size in order to minimize the number of page 25 * tables required for the mapping. 26 */ 27 #define REGION_DEFAULT_GRANULARITY XLAT_BLOCK_SIZE(MIN_LVL_BLOCK_DESC) 28 29 /* Helper macro to define an mmap_region_t. */ 30 #define MAP_REGION(_pa, _va, _sz, _attr) \ 31 MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, REGION_DEFAULT_GRANULARITY) 32 33 /* Helper macro to define an mmap_region_t with an identity mapping. */ 34 #define MAP_REGION_FLAT(_adr, _sz, _attr) \ 35 MAP_REGION(_adr, _adr, _sz, _attr) 36 37 /* 38 * Helper macro to define entries for mmap_region_t. It allows to define 'pa' 39 * and sets 'va' to 0 for each region. To be used with mmap_add_alloc_va(). 40 */ 41 #define MAP_REGION_ALLOC_VA(pa, sz, attr) MAP_REGION(pa, 0, sz, attr) 42 43 /* 44 * Helper macro to define an mmap_region_t to map with the desired granularity 45 * of translation tables. 46 * 47 * The granularity value passed to this macro must be a valid block or page 48 * size. When using a 4KB translation granule, this might be 4KB, 2MB or 1GB. 49 * Passing REGION_DEFAULT_GRANULARITY is also allowed and means that the library 50 * is free to choose the granularity for this region. In this case, it is 51 * equivalent to the MAP_REGION() macro. 52 */ 53 #define MAP_REGION2(_pa, _va, _sz, _attr, _gr) \ 54 MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, _gr) 55 56 /* 57 * Shifts and masks to access fields of an mmap attribute 58 */ 59 #define MT_TYPE_MASK U(0x7) 60 #define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK) 61 /* Access permissions (RO/RW) */ 62 #define MT_PERM_SHIFT U(3) 63 /* Security state (SECURE/NS) */ 64 #define MT_SEC_SHIFT U(4) 65 /* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */ 66 #define MT_EXECUTE_SHIFT U(5) 67 /* In the EL1&0 translation regime, User (EL0) or Privileged (EL1). */ 68 #define MT_USER_SHIFT U(6) 69 /* All other bits are reserved */ 70 71 /* 72 * Memory mapping attributes 73 */ 74 75 /* 76 * Memory types supported. 77 * These are organised so that, going down the list, the memory types are 78 * getting weaker; conversely going up the list the memory types are getting 79 * stronger. 80 */ 81 #define MT_DEVICE U(0) 82 #define MT_NON_CACHEABLE U(1) 83 #define MT_MEMORY U(2) 84 /* Values up to 7 are reserved to add new memory types in the future */ 85 86 #define MT_RO (U(0) << MT_PERM_SHIFT) 87 #define MT_RW (U(1) << MT_PERM_SHIFT) 88 89 #define MT_SECURE (U(0) << MT_SEC_SHIFT) 90 #define MT_NS (U(1) << MT_SEC_SHIFT) 91 92 /* 93 * Access permissions for instruction execution are only relevant for normal 94 * read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored (and potentially 95 * overridden) otherwise: 96 * - Device memory is always marked as execute-never. 97 * - Read-write normal memory is always marked as execute-never. 98 */ 99 #define MT_EXECUTE (U(0) << MT_EXECUTE_SHIFT) 100 #define MT_EXECUTE_NEVER (U(1) << MT_EXECUTE_SHIFT) 101 102 /* 103 * When mapping a region at EL0 or EL1, this attribute will be used to determine 104 * if a User mapping (EL0) will be created or a Privileged mapping (EL1). 105 */ 106 #define MT_USER (U(1) << MT_USER_SHIFT) 107 #define MT_PRIVILEGED (U(0) << MT_USER_SHIFT) 108 109 /* Compound attributes for most common usages */ 110 #define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE) 111 #define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER) 112 #define MT_RW_DATA (MT_MEMORY | MT_RW | MT_EXECUTE_NEVER) 113 114 /* 115 * Structure for specifying a single region of memory. 116 */ 117 typedef struct mmap_region { 118 unsigned long long base_pa; 119 uintptr_t base_va; 120 size_t size; 121 unsigned int attr; 122 /* Desired granularity. See the MAP_REGION2() macro for more details. */ 123 size_t granularity; 124 } mmap_region_t; 125 126 /* 127 * Translation regimes supported by this library. EL_REGIME_INVALID tells the 128 * library to detect it at runtime. 129 */ 130 #define EL1_EL0_REGIME 1 131 #define EL2_REGIME 2 132 #define EL3_REGIME 3 133 #define EL_REGIME_INVALID -1 134 135 /* 136 * Declare the translation context type. 137 * Its definition is private. 138 */ 139 typedef struct xlat_ctx xlat_ctx_t; 140 141 /* 142 * Statically allocate a translation context and associated structures. Also 143 * initialize them. 144 * 145 * _ctx_name: 146 * Prefix for the translation context variable. 147 * E.g. If _ctx_name is 'foo', the variable will be called 'foo_xlat_ctx'. 148 * Useful to distinguish multiple contexts from one another. 149 * 150 * _mmap_count: 151 * Number of mmap_region_t to allocate. 152 * Would typically be MAX_MMAP_REGIONS for the translation context describing 153 * the BL image currently executing. 154 * 155 * _xlat_tables_count: 156 * Number of sub-translation tables to allocate. 157 * Would typically be MAX_XLAT_TABLES for the translation context describing 158 * the BL image currently executing. 159 * Note that this is only for sub-tables ; at the initial lookup level, there 160 * is always a single table. 161 * 162 * _virt_addr_space_size, _phy_addr_space_size: 163 * Size (in bytes) of the virtual (resp. physical) address space. 164 * Would typically be PLAT_VIRT_ADDR_SPACE_SIZE 165 * (resp. PLAT_PHY_ADDR_SPACE_SIZE) for the translation context describing the 166 * BL image currently executing. 167 */ 168 #define REGISTER_XLAT_CONTEXT(_ctx_name, _mmap_count, _xlat_tables_count, \ 169 _virt_addr_space_size, _phy_addr_space_size) \ 170 REGISTER_XLAT_CONTEXT_FULL_SPEC(_ctx_name, (_mmap_count), \ 171 (_xlat_tables_count), \ 172 (_virt_addr_space_size), \ 173 (_phy_addr_space_size), \ 174 EL_REGIME_INVALID, \ 175 "xlat_table", "base_xlat_table") 176 177 /* 178 * Same as REGISTER_XLAT_CONTEXT plus the additional parameters: 179 * 180 * _xlat_regime: 181 * Specify the translation regime managed by this xlat_ctx_t instance. The 182 * values are the one from the EL*_REGIME definitions. 183 * 184 * _section_name: 185 * Specify the name of the section where the translation tables have to be 186 * placed by the linker. 187 */ 188 #define REGISTER_XLAT_CONTEXT2(_ctx_name, _mmap_count, _xlat_tables_count, \ 189 _virt_addr_space_size, _phy_addr_space_size, \ 190 _xlat_regime, _section_name) \ 191 REGISTER_XLAT_CONTEXT_FULL_SPEC(_ctx_name, (_mmap_count), \ 192 (_xlat_tables_count), \ 193 (_virt_addr_space_size), \ 194 (_phy_addr_space_size), \ 195 (_xlat_regime), \ 196 (_section_name), ".bss" \ 197 ) 198 199 /****************************************************************************** 200 * Generic translation table APIs. 201 * Each API comes in 2 variants: 202 * - one that acts on the current translation context for this BL image 203 * - another that acts on the given translation context instead. This variant 204 * is named after the 1st version, with an additional '_ctx' suffix. 205 *****************************************************************************/ 206 207 /* 208 * Initialize translation tables from the current list of mmap regions. Calling 209 * this function marks the transition point after which static regions can no 210 * longer be added. 211 */ 212 void init_xlat_tables(void); 213 void init_xlat_tables_ctx(xlat_ctx_t *ctx); 214 215 /* 216 * Fill all fields of a dynamic translation tables context. It must be done 217 * either statically with REGISTER_XLAT_CONTEXT() or at runtime with this 218 * function. 219 */ 220 void xlat_setup_dynamic_ctx(xlat_ctx_t *ctx, unsigned long long pa_max, 221 uintptr_t va_max, struct mmap_region *mmap, 222 unsigned int mmap_num, uint64_t **tables, 223 unsigned int tables_num, uint64_t *base_table, 224 int xlat_regime, int *mapped_regions); 225 226 /* 227 * Add a static region with defined base PA and base VA. This function can only 228 * be used before initializing the translation tables. The region cannot be 229 * removed afterwards. 230 */ 231 void mmap_add_region(unsigned long long base_pa, uintptr_t base_va, 232 size_t size, unsigned int attr); 233 void mmap_add_region_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm); 234 235 /* 236 * Add an array of static regions with defined base PA and base VA. This 237 * function can only be used before initializing the translation tables. The 238 * regions cannot be removed afterwards. 239 */ 240 void mmap_add(const mmap_region_t *mm); 241 void mmap_add_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm); 242 243 /* 244 * Add a region with defined base PA. Returns base VA calculated using the 245 * highest existing region in the mmap array even if it fails to allocate the 246 * region. 247 */ 248 void mmap_add_region_alloc_va(unsigned long long base_pa, uintptr_t *base_va, 249 size_t size, unsigned int attr); 250 void mmap_add_region_alloc_va_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 251 252 /* 253 * Add an array of static regions with defined base PA, and fill the base VA 254 * field on the array of structs. This function can only be used before 255 * initializing the translation tables. The regions cannot be removed afterwards. 256 */ 257 void mmap_add_alloc_va(mmap_region_t *mm); 258 259 #if PLAT_XLAT_TABLES_DYNAMIC 260 /* 261 * Add a dynamic region with defined base PA and base VA. This type of region 262 * can be added and removed even after the translation tables are initialized. 263 * 264 * Returns: 265 * 0: Success. 266 * EINVAL: Invalid values were used as arguments. 267 * ERANGE: Memory limits were surpassed. 268 * ENOMEM: Not enough space in the mmap array or not enough free xlat tables. 269 * EPERM: It overlaps another region in an invalid way. 270 */ 271 int mmap_add_dynamic_region(unsigned long long base_pa, uintptr_t base_va, 272 size_t size, unsigned int attr); 273 int mmap_add_dynamic_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 274 275 /* 276 * Add a dynamic region with defined base PA. Returns base VA calculated using 277 * the highest existing region in the mmap array even if it fails to allocate 278 * the region. 279 * 280 * mmap_add_dynamic_region_alloc_va() returns the allocated VA in 'base_va'. 281 * mmap_add_dynamic_region_alloc_va_ctx() returns it in 'mm->base_va'. 282 * 283 * It returns the same error values as mmap_add_dynamic_region(). 284 */ 285 int mmap_add_dynamic_region_alloc_va(unsigned long long base_pa, 286 uintptr_t *base_va, 287 size_t size, unsigned int attr); 288 int mmap_add_dynamic_region_alloc_va_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 289 290 /* 291 * Remove a region with the specified base VA and size. Only dynamic regions can 292 * be removed, and they can be removed even if the translation tables are 293 * initialized. 294 * 295 * Returns: 296 * 0: Success. 297 * EINVAL: The specified region wasn't found. 298 * EPERM: Trying to remove a static region. 299 */ 300 int mmap_remove_dynamic_region(uintptr_t base_va, size_t size); 301 int mmap_remove_dynamic_region_ctx(xlat_ctx_t *ctx, 302 uintptr_t base_va, 303 size_t size); 304 305 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 306 307 /* 308 * Change the memory attributes of the memory region starting from a given 309 * virtual address in a set of translation tables. 310 * 311 * This function can only be used after the translation tables have been 312 * initialized. 313 * 314 * The base address of the memory region must be aligned on a page boundary. 315 * The size of this memory region must be a multiple of a page size. 316 * The memory region must be already mapped by the given translation tables 317 * and it must be mapped at the granularity of a page. 318 * 319 * Return 0 on success, a negative value on error. 320 * 321 * In case of error, the memory attributes remain unchanged and this function 322 * has no effect. 323 * 324 * ctx 325 * Translation context to work on. 326 * base_va: 327 * Virtual address of the 1st page to change the attributes of. 328 * size: 329 * Size in bytes of the memory region. 330 * attr: 331 * New attributes of the page tables. The attributes that can be changed are 332 * data access (MT_RO/MT_RW), instruction access (MT_EXECUTE_NEVER/MT_EXECUTE) 333 * and user/privileged access (MT_USER/MT_PRIVILEGED) in the case of contexts 334 * that are used in the EL1&0 translation regime. Also, note that this 335 * function doesn't allow to remap a region as RW and executable, or to remap 336 * device memory as executable. 337 * 338 * NOTE: The caller of this function must be able to write to the translation 339 * tables, i.e. the memory where they are stored must be mapped with read-write 340 * access permissions. This function assumes it is the case. If this is not 341 * the case then this function might trigger a data abort exception. 342 * 343 * NOTE2: The caller is responsible for making sure that the targeted 344 * translation tables are not modified by any other code while this function is 345 * executing. 346 */ 347 int xlat_change_mem_attributes_ctx(const xlat_ctx_t *ctx, uintptr_t base_va, 348 size_t size, uint32_t attr); 349 int xlat_change_mem_attributes(uintptr_t base_va, size_t size, uint32_t attr); 350 351 #if PLAT_RO_XLAT_TABLES 352 /* 353 * Change the memory attributes of the memory region encompassing the higher 354 * level translation tables to secure read-only data. 355 * 356 * Return 0 on success, a negative error code on error. 357 */ 358 int xlat_make_tables_readonly(void); 359 #endif 360 361 /* 362 * Query the memory attributes of a memory page in a set of translation tables. 363 * 364 * Return 0 on success, a negative error code on error. 365 * On success, the attributes are stored into *attr. 366 * 367 * ctx 368 * Translation context to work on. 369 * base_va 370 * Virtual address of the page to get the attributes of. 371 * There are no alignment restrictions on this address. The attributes of the 372 * memory page it lies within are returned. 373 * attr 374 * Output parameter where to store the attributes of the targeted memory page. 375 */ 376 int xlat_get_mem_attributes_ctx(const xlat_ctx_t *ctx, uintptr_t base_va, 377 uint32_t *attr); 378 int xlat_get_mem_attributes(uintptr_t base_va, uint32_t *attr); 379 380 #endif /*__ASSEMBLER__*/ 381 #endif /* XLAT_TABLES_V2_H */ 382