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_V2_H__ 8 #define __XLAT_TABLES_V2_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 #include <xlat_tables_v2_helpers.h> 17 18 /* 19 * Default granularity size for an mmap_region_t. 20 * Useful when no specific granularity is required. 21 * 22 * By default, choose the biggest possible block size allowed by the 23 * architectural state and granule size in order to minimize the number of page 24 * tables required for the mapping. 25 */ 26 #define REGION_DEFAULT_GRANULARITY XLAT_BLOCK_SIZE(MIN_LVL_BLOCK_DESC) 27 28 /* Helper macro to define an mmap_region_t. */ 29 #define MAP_REGION(_pa, _va, _sz, _attr) \ 30 _MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, REGION_DEFAULT_GRANULARITY) 31 32 /* Helper macro to define an mmap_region_t with an identity mapping. */ 33 #define MAP_REGION_FLAT(_adr, _sz, _attr) \ 34 MAP_REGION(_adr, _adr, _sz, _attr) 35 36 /* 37 * Helper macro to define an mmap_region_t to map with the desired granularity 38 * of translation tables. 39 * 40 * The granularity value passed to this macro must be a valid block or page 41 * size. When using a 4KB translation granule, this might be 4KB, 2MB or 1GB. 42 * Passing REGION_DEFAULT_GRANULARITY is also allowed and means that the library 43 * is free to choose the granularity for this region. In this case, it is 44 * equivalent to the MAP_REGION() macro. 45 */ 46 #define MAP_REGION2(_pa, _va, _sz, _attr, _gr) \ 47 _MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, _gr) 48 49 /* 50 * Shifts and masks to access fields of an mmap_attr_t 51 */ 52 #define MT_TYPE_MASK U(0x7) 53 #define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK) 54 /* Access permissions (RO/RW) */ 55 #define MT_PERM_SHIFT U(3) 56 /* Security state (SECURE/NS) */ 57 #define MT_SEC_SHIFT U(4) 58 /* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */ 59 #define MT_EXECUTE_SHIFT U(5) 60 /* All other bits are reserved */ 61 62 /* 63 * Memory mapping attributes 64 */ 65 typedef enum { 66 /* 67 * Memory types supported. 68 * These are organised so that, going down the list, the memory types 69 * are getting weaker; conversely going up the list the memory types are 70 * getting stronger. 71 */ 72 MT_DEVICE, 73 MT_NON_CACHEABLE, 74 MT_MEMORY, 75 /* Values up to 7 are reserved to add new memory types in the future */ 76 77 MT_RO = U(0) << MT_PERM_SHIFT, 78 MT_RW = U(1) << MT_PERM_SHIFT, 79 80 MT_SECURE = U(0) << MT_SEC_SHIFT, 81 MT_NS = U(1) << MT_SEC_SHIFT, 82 83 /* 84 * Access permissions for instruction execution are only relevant for 85 * normal read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored 86 * (and potentially overridden) otherwise: 87 * - Device memory is always marked as execute-never. 88 * - Read-write normal memory is always marked as execute-never. 89 */ 90 MT_EXECUTE = U(0) << MT_EXECUTE_SHIFT, 91 MT_EXECUTE_NEVER = U(1) << MT_EXECUTE_SHIFT, 92 } mmap_attr_t; 93 94 #define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE) 95 #define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER) 96 97 /* 98 * Structure for specifying a single region of memory. 99 */ 100 typedef struct mmap_region { 101 unsigned long long base_pa; 102 uintptr_t base_va; 103 size_t size; 104 mmap_attr_t attr; 105 /* Desired granularity. See the MAP_REGION2() macro for more details. */ 106 size_t granularity; 107 } mmap_region_t; 108 109 /* 110 * Translation regimes supported by this library. 111 */ 112 typedef enum xlat_regime { 113 EL1_EL0_REGIME, 114 EL3_REGIME, 115 } xlat_regime_t; 116 117 /* 118 * Declare the translation context type. 119 * Its definition is private. 120 */ 121 typedef struct xlat_ctx xlat_ctx_t; 122 123 /* 124 * Statically allocate a translation context and associated structures. Also 125 * initialize them. 126 * 127 * _ctx_name: 128 * Prefix for the translation context variable. 129 * E.g. If _ctx_name is 'foo', the variable will be called 'foo_xlat_ctx'. 130 * Useful to distinguish multiple contexts from one another. 131 * 132 * _mmap_count: 133 * Number of mmap_region_t to allocate. 134 * Would typically be MAX_MMAP_REGIONS for the translation context describing 135 * the BL image currently executing. 136 * 137 * _xlat_tables_count: 138 * Number of sub-translation tables to allocate. 139 * Would typically be MAX_XLAT_TABLES for the translation context describing 140 * the BL image currently executing. 141 * Note that this is only for sub-tables ; at the initial lookup level, there 142 * is always a single table. 143 * 144 * _virt_addr_space_size, _phy_addr_space_size: 145 * Size (in bytes) of the virtual (resp. physical) address space. 146 * Would typically be PLAT_VIRT_ADDR_SPACE_SIZE 147 * (resp. PLAT_PHY_ADDR_SPACE_SIZE) for the translation context describing the 148 * BL image currently executing. 149 */ 150 #define REGISTER_XLAT_CONTEXT(_ctx_name, _mmap_count, _xlat_tables_count, \ 151 _virt_addr_space_size, _phy_addr_space_size) \ 152 _REGISTER_XLAT_CONTEXT(_ctx_name, _mmap_count, _xlat_tables_count, \ 153 _virt_addr_space_size, _phy_addr_space_size) 154 155 /****************************************************************************** 156 * Generic translation table APIs. 157 * Each API comes in 2 variants: 158 * - one that acts on the current translation context for this BL image 159 * - another that acts on the given translation context instead. This variant 160 * is named after the 1st version, with an additional '_ctx' suffix. 161 *****************************************************************************/ 162 163 /* 164 * Initialize translation tables from the current list of mmap regions. Calling 165 * this function marks the transition point after which static regions can no 166 * longer be added. 167 */ 168 void init_xlat_tables(void); 169 void init_xlat_tables_ctx(xlat_ctx_t *ctx); 170 171 /* 172 * Add a static region with defined base PA and base VA. This function can only 173 * be used before initializing the translation tables. The region cannot be 174 * removed afterwards. 175 */ 176 void mmap_add_region(unsigned long long base_pa, uintptr_t base_va, 177 size_t size, mmap_attr_t attr); 178 void mmap_add_region_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm); 179 180 /* 181 * Add an array of static regions with defined base PA and base VA. This 182 * function can only be used before initializing the translation tables. The 183 * regions cannot be removed afterwards. 184 */ 185 void mmap_add(const mmap_region_t *mm); 186 void mmap_add_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm); 187 188 189 #if PLAT_XLAT_TABLES_DYNAMIC 190 /* 191 * Add a dynamic region with defined base PA and base VA. This type of region 192 * can be added and removed even after the translation tables are initialized. 193 * 194 * Returns: 195 * 0: Success. 196 * EINVAL: Invalid values were used as arguments. 197 * ERANGE: Memory limits were surpassed. 198 * ENOMEM: Not enough space in the mmap array or not enough free xlat tables. 199 * EPERM: It overlaps another region in an invalid way. 200 */ 201 int mmap_add_dynamic_region(unsigned long long base_pa, uintptr_t base_va, 202 size_t size, mmap_attr_t attr); 203 int mmap_add_dynamic_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); 204 205 /* 206 * Remove a region with the specified base VA and size. Only dynamic regions can 207 * be removed, and they can be removed even if the translation tables are 208 * initialized. 209 * 210 * Returns: 211 * 0: Success. 212 * EINVAL: The specified region wasn't found. 213 * EPERM: Trying to remove a static region. 214 */ 215 int mmap_remove_dynamic_region(uintptr_t base_va, size_t size); 216 int mmap_remove_dynamic_region_ctx(xlat_ctx_t *ctx, 217 uintptr_t base_va, 218 size_t size); 219 220 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 221 222 #endif /*__ASSEMBLY__*/ 223 #endif /* __XLAT_TABLES_V2_H__ */ 224