1 /* 2 * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 /* 8 * This header file contains internal definitions that are not supposed to be 9 * used outside of this library code. 10 */ 11 12 #ifndef XLAT_TABLES_V2_HELPERS_H 13 #define XLAT_TABLES_V2_HELPERS_H 14 15 #ifndef XLAT_TABLES_V2_H 16 #error "Do not include this header file directly. Include xlat_tables_v2.h instead." 17 #endif 18 19 #ifndef __ASSEMBLER__ 20 21 #include <stdbool.h> 22 #include <stddef.h> 23 24 #include <platform_def.h> 25 26 #include <lib/cassert.h> 27 #include <lib/xlat_tables/xlat_tables_arch.h> 28 #include <lib/xlat_tables/xlat_tables_defs.h> 29 30 /* Forward declaration */ 31 struct mmap_region; 32 33 /* 34 * Helper macro to define an mmap_region_t. This macro allows to specify all 35 * the fields of the structure but its parameter list is not guaranteed to 36 * remain stable as we add members to mmap_region_t. 37 */ 38 #define MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, _gr) \ 39 { \ 40 .base_pa = (_pa), \ 41 .base_va = (_va), \ 42 .size = (_sz), \ 43 .attr = (_attr), \ 44 .granularity = (_gr), \ 45 } 46 47 /* Struct that holds all information about the translation tables. */ 48 struct xlat_ctx { 49 /* 50 * Max allowed Virtual and Physical Addresses. 51 */ 52 unsigned long long pa_max_address; 53 uintptr_t va_max_address; 54 55 /* 56 * Array of all memory regions stored in order of ascending end address 57 * and ascending size to simplify the code that allows overlapping 58 * regions. The list is terminated by the first entry with size == 0. 59 * The max size of the list is stored in `mmap_num`. `mmap` points to an 60 * array of mmap_num + 1 elements, so that there is space for the final 61 * null entry. 62 */ 63 struct mmap_region *mmap; 64 int mmap_num; 65 66 /* 67 * Array of finer-grain translation tables. 68 * For example, if the initial lookup level is 1 then this array would 69 * contain both level-2 and level-3 entries. 70 */ 71 uint64_t (*tables)[XLAT_TABLE_ENTRIES]; 72 int tables_num; 73 /* 74 * Keep track of how many regions are mapped in each table. The base 75 * table can't be unmapped so it isn't needed to keep track of it. 76 */ 77 #if PLAT_XLAT_TABLES_DYNAMIC 78 int *tables_mapped_regions; 79 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 80 81 int next_table; 82 83 /* 84 * Base translation table. It doesn't need to have the same amount of 85 * entries as the ones used for other levels. 86 */ 87 uint64_t *base_table; 88 unsigned int base_table_entries; 89 90 /* 91 * Max Physical and Virtual addresses currently in use by the 92 * translation tables. These might get updated as we map/unmap memory 93 * regions but they will never go beyond pa/va_max_address. 94 */ 95 unsigned long long max_pa; 96 uintptr_t max_va; 97 98 /* Level of the base translation table. */ 99 unsigned int base_level; 100 101 /* Set to true when the translation tables are initialized. */ 102 bool initialized; 103 104 /* 105 * Translation regime managed by this xlat_ctx_t. It should be one of 106 * the EL*_REGIME defines. 107 */ 108 int xlat_regime; 109 }; 110 111 #if PLAT_XLAT_TABLES_DYNAMIC 112 #define XLAT_ALLOC_DYNMAP_STRUCT(_ctx_name, _xlat_tables_count) \ 113 static int _ctx_name##_mapped_regions[_xlat_tables_count]; 114 115 #define XLAT_REGISTER_DYNMAP_STRUCT(_ctx_name) \ 116 .tables_mapped_regions = _ctx_name##_mapped_regions, 117 #else 118 #define XLAT_ALLOC_DYNMAP_STRUCT(_ctx_name, _xlat_tables_count) \ 119 /* do nothing */ 120 121 #define XLAT_REGISTER_DYNMAP_STRUCT(_ctx_name) \ 122 /* do nothing */ 123 #endif /* PLAT_XLAT_TABLES_DYNAMIC */ 124 125 #define REGISTER_XLAT_CONTEXT_FULL_SPEC(_ctx_name, _mmap_count, \ 126 _xlat_tables_count, _virt_addr_space_size, \ 127 _phy_addr_space_size, _xlat_regime, _section_name)\ 128 CASSERT(CHECK_PHY_ADDR_SPACE_SIZE(_phy_addr_space_size), \ 129 assert_invalid_physical_addr_space_sizefor_##_ctx_name);\ 130 \ 131 static mmap_region_t _ctx_name##_mmap[_mmap_count + 1]; \ 132 \ 133 static uint64_t _ctx_name##_xlat_tables[_xlat_tables_count] \ 134 [XLAT_TABLE_ENTRIES] \ 135 __aligned(XLAT_TABLE_SIZE) __section(_section_name); \ 136 \ 137 static uint64_t _ctx_name##_base_xlat_table \ 138 [GET_NUM_BASE_LEVEL_ENTRIES(_virt_addr_space_size)] \ 139 __aligned(GET_NUM_BASE_LEVEL_ENTRIES(_virt_addr_space_size)\ 140 * sizeof(uint64_t)); \ 141 \ 142 XLAT_ALLOC_DYNMAP_STRUCT(_ctx_name, _xlat_tables_count) \ 143 \ 144 static xlat_ctx_t _ctx_name##_xlat_ctx = { \ 145 .va_max_address = (_virt_addr_space_size) - 1UL, \ 146 .pa_max_address = (_phy_addr_space_size) - 1ULL, \ 147 .mmap = _ctx_name##_mmap, \ 148 .mmap_num = (_mmap_count), \ 149 .base_level = GET_XLAT_TABLE_LEVEL_BASE(_virt_addr_space_size),\ 150 .base_table = _ctx_name##_base_xlat_table, \ 151 .base_table_entries = \ 152 GET_NUM_BASE_LEVEL_ENTRIES(_virt_addr_space_size),\ 153 .tables = _ctx_name##_xlat_tables, \ 154 .tables_num = _xlat_tables_count, \ 155 XLAT_REGISTER_DYNMAP_STRUCT(_ctx_name) \ 156 .xlat_regime = (_xlat_regime), \ 157 .max_pa = 0U, \ 158 .max_va = 0U, \ 159 .next_table = 0, \ 160 .initialized = false, \ 161 } 162 163 #endif /*__ASSEMBLER__*/ 164 165 #endif /* XLAT_TABLES_V2_HELPERS_H */ 166