Home | History | Annotate | Download | only in xlat_tables_v2
      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_PRIVATE_H__
      8 #define __XLAT_TABLES_PRIVATE_H__
      9 
     10 #include <platform_def.h>
     11 #include <xlat_tables_defs.h>
     12 
     13 #if PLAT_XLAT_TABLES_DYNAMIC
     14 /*
     15  * Shifts and masks to access fields of an mmap_attr_t
     16  */
     17 /* Dynamic or static */
     18 #define MT_DYN_SHIFT		30 /* 31 would cause undefined behaviours */
     19 
     20 /*
     21  * Memory mapping private attributes
     22  *
     23  * Private attributes not exposed in the mmap_attr_t enum.
     24  */
     25 typedef enum  {
     26 	/*
     27 	 * Regions mapped before the MMU can't be unmapped dynamically (they are
     28 	 * static) and regions mapped with MMU enabled can be unmapped. This
     29 	 * behaviour can't be overridden.
     30 	 *
     31 	 * Static regions can overlap each other, dynamic regions can't.
     32 	 */
     33 	MT_STATIC	= 0 << MT_DYN_SHIFT,
     34 	MT_DYNAMIC	= 1 << MT_DYN_SHIFT
     35 } mmap_priv_attr_t;
     36 
     37 #endif /* PLAT_XLAT_TABLES_DYNAMIC */
     38 
     39 /*
     40  * Invalidate all TLB entries that match the given virtual address. This
     41  * operation applies to all PEs in the same Inner Shareable domain as the PE
     42  * that executes this function. This functions must be called for every
     43  * translation table entry that is modified.
     44  *
     45  * xlat_arch_tlbi_va() applies the invalidation to the exception level of the
     46  * current translation regime, whereas xlat_arch_tlbi_va_regime() applies it to
     47  * the given translation regime.
     48  *
     49  * Note, however, that it is architecturally UNDEFINED to invalidate TLB entries
     50  * pertaining to a higher exception level, e.g. invalidating EL3 entries from
     51  * S-EL1.
     52  */
     53 void xlat_arch_tlbi_va(uintptr_t va);
     54 void xlat_arch_tlbi_va_regime(uintptr_t va, xlat_regime_t xlat_regime);
     55 
     56 /*
     57  * This function has to be called at the end of any code that uses the function
     58  * xlat_arch_tlbi_va().
     59  */
     60 void xlat_arch_tlbi_va_sync(void);
     61 
     62 /* Print VA, PA, size and attributes of all regions in the mmap array. */
     63 void print_mmap(mmap_region_t *const mmap);
     64 
     65 /*
     66  * Print the current state of the translation tables by reading them from
     67  * memory.
     68  */
     69 void xlat_tables_print(xlat_ctx_t *ctx);
     70 
     71 /*
     72  * Architecture-specific initialization code.
     73  */
     74 
     75 /* Returns the current Exception Level. The returned EL must be 1 or higher. */
     76 int xlat_arch_current_el(void);
     77 
     78 /*
     79  * Return the maximum physical address supported by the hardware.
     80  * This value depends on the execution state (AArch32/AArch64).
     81  */
     82 unsigned long long xlat_arch_get_max_supported_pa(void);
     83 
     84 /* Enable MMU and configure it to use the specified translation tables. */
     85 void enable_mmu_arch(unsigned int flags, uint64_t *base_table,
     86 		unsigned long long pa, uintptr_t max_va);
     87 
     88 /*
     89  * Return 1 if the MMU of the translation regime managed by the given xlat_ctx_t
     90  * is enabled, 0 otherwise.
     91  */
     92 int is_mmu_enabled_ctx(const xlat_ctx_t *ctx);
     93 
     94 #endif /* __XLAT_TABLES_PRIVATE_H__ */
     95