| /* |
| * Copyright (c) 2017, ARM Limited and Contributors. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * |
| * Redistributions of source code must retain the above copyright notice, this |
| * list of conditions and the following disclaimer. |
| * |
| * Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * |
| * Neither the name of ARM nor the names of its contributors may be used |
| * to endorse or promote products derived from this software without specific |
| * prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #ifndef __XLAT_TABLES_PRIVATE_H__ |
| #define __XLAT_TABLES_PRIVATE_H__ |
| |
| #include <cassert.h> |
| #include <platform_def.h> |
| #include <utils.h> |
| |
| /* |
| * If the platform hasn't defined a physical and a virtual address space size |
| * default to ADDR_SPACE_SIZE. |
| */ |
| #if ERROR_DEPRECATED |
| # ifdef ADDR_SPACE_SIZE |
| # error "ADDR_SPACE_SIZE is deprecated. Use PLAT_xxx_ADDR_SPACE_SIZE instead." |
| # endif |
| #elif defined(ADDR_SPACE_SIZE) |
| # ifndef PLAT_PHY_ADDR_SPACE_SIZE |
| # define PLAT_PHY_ADDR_SPACE_SIZE ADDR_SPACE_SIZE |
| # endif |
| # ifndef PLAT_VIRT_ADDR_SPACE_SIZE |
| # define PLAT_VIRT_ADDR_SPACE_SIZE ADDR_SPACE_SIZE |
| # endif |
| #endif |
| |
| /* The virtual and physical address space sizes must be powers of two. */ |
| CASSERT(IS_POWER_OF_TWO(PLAT_VIRT_ADDR_SPACE_SIZE), |
| assert_valid_virt_addr_space_size); |
| CASSERT(IS_POWER_OF_TWO(PLAT_PHY_ADDR_SPACE_SIZE), |
| assert_valid_phy_addr_space_size); |
| |
| /* Struct that holds all information about the translation tables. */ |
| typedef struct { |
| |
| /* |
| * Max allowed Virtual and Physical Addresses. |
| */ |
| unsigned long long pa_max_address; |
| uintptr_t va_max_address; |
| |
| /* |
| * Array of all memory regions stored in order of ascending end address |
| * and ascending size to simplify the code that allows overlapping |
| * regions. The list is terminated by the first entry with size == 0. |
| */ |
| mmap_region_t *mmap; /* mmap_num + 1 elements */ |
| int mmap_num; |
| |
| /* |
| * Array of finer-grain translation tables. |
| * For example, if the initial lookup level is 1 then this array would |
| * contain both level-2 and level-3 entries. |
| */ |
| uint64_t (*tables)[XLAT_TABLE_ENTRIES]; |
| int tables_num; |
| |
| int next_table; |
| |
| /* |
| * Base translation table. It doesn't need to have the same amount of |
| * entries as the ones used for other levels. |
| */ |
| uint64_t *base_table; |
| int base_table_entries; |
| |
| unsigned long long max_pa; |
| uintptr_t max_va; |
| |
| /* Level of the base translation table. */ |
| int base_level; |
| |
| /* Set to 1 when the translation tables are initialized. */ |
| int initialized; |
| |
| } xlat_ctx_t; |
| |
| /* Print VA, PA, size and attributes of all regions in the mmap array. */ |
| void print_mmap(mmap_region_t *const mmap); |
| |
| /* |
| * Print the current state of the translation tables by reading them from |
| * memory. |
| */ |
| void xlat_tables_print(xlat_ctx_t *ctx); |
| |
| /* |
| * Initialize the translation tables by mapping all regions added to the |
| * specified context. |
| */ |
| void init_xlation_table(xlat_ctx_t *ctx); |
| |
| /* Add a static region to the specified context. */ |
| void mmap_add_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm); |
| |
| /* |
| * Architecture-specific initialization code. |
| */ |
| |
| /* Execute architecture-specific translation table initialization code. */ |
| void init_xlat_tables_arch(unsigned long long max_pa); |
| |
| /* Enable MMU and configure it to use the specified translation tables. */ |
| void enable_mmu_arch(unsigned int flags, uint64_t *base_table); |
| |
| /* Return 1 if the MMU of this Exception Level is enabled, 0 otherwise. */ |
| int is_mmu_enabled(void); |
| |
| #endif /* __XLAT_TABLES_PRIVATE_H__ */ |