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