blob: 93640ddbce7e33df3071c5d232dee49f044efb3f [file] [log] [blame]
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00001/*
Roberto Vargas777dd432018-02-12 12:36:17 +00002 * Copyright (c) 2017-2018, ARM Limited and Contributors. All rights reserved.
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00005 */
6
7#ifndef __XLAT_TABLES_PRIVATE_H__
8#define __XLAT_TABLES_PRIVATE_H__
9
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000010#include <platform_def.h>
Sandrine Bailleux090c8492017-05-19 09:59:37 +010011#include <xlat_tables_defs.h>
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000012
Antonio Nino Diazac998032017-02-27 17:23:54 +000013#if PLAT_XLAT_TABLES_DYNAMIC
14/*
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010015 * Private shifts and masks to access fields of an mmap attribute
Antonio Nino Diazac998032017-02-27 17:23:54 +000016 */
17/* Dynamic or static */
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010018#define MT_DYN_SHIFT U(31)
Antonio Nino Diazac998032017-02-27 17:23:54 +000019
20/*
21 * Memory mapping private attributes
22 *
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010023 * Private attributes not exposed in the public header.
24 */
25
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.
Antonio Nino Diazac998032017-02-27 17:23:54 +000032 */
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010033#define MT_STATIC (U(0) << MT_DYN_SHIFT)
34#define MT_DYNAMIC (U(1) << MT_DYN_SHIFT)
Antonio Nino Diazac998032017-02-27 17:23:54 +000035
Sandrine Bailleux33835542017-04-25 14:09:47 +010036#endif /* PLAT_XLAT_TABLES_DYNAMIC */
37
Antonio Nino Diazac998032017-02-27 17:23:54 +000038/*
Antonio Nino Diaz44d3c212018-07-05 08:11:48 +010039 * Return the execute-never mask that will prevent instruction fetch at the
40 * given translation regime.
41 */
42uint64_t xlat_arch_regime_get_xn_desc(int xlat_regime);
43
44/*
Douglas Raillard2d545792017-09-25 15:23:22 +010045 * Invalidate all TLB entries that match the given virtual address. This
46 * operation applies to all PEs in the same Inner Shareable domain as the PE
47 * that executes this function. This functions must be called for every
Antonio Nino Diazad5dc7f2018-07-11 09:46:45 +010048 * translation table entry that is modified. It only affects the specified
49 * translation regime.
Douglas Raillard2d545792017-09-25 15:23:22 +010050 *
51 * Note, however, that it is architecturally UNDEFINED to invalidate TLB entries
52 * pertaining to a higher exception level, e.g. invalidating EL3 entries from
53 * S-EL1.
Antonio Nino Diazac998032017-02-27 17:23:54 +000054 */
Antonio Nino Diazad5dc7f2018-07-11 09:46:45 +010055void xlat_arch_tlbi_va(uintptr_t va, int xlat_regime);
Antonio Nino Diazac998032017-02-27 17:23:54 +000056
57/*
58 * This function has to be called at the end of any code that uses the function
59 * xlat_arch_tlbi_va().
60 */
61void xlat_arch_tlbi_va_sync(void);
62
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000063/* Print VA, PA, size and attributes of all regions in the mmap array. */
Antonio Nino Diazf1b84f62018-07-03 11:58:49 +010064void xlat_mmap_print(mmap_region_t *const mmap);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000065
66/*
67 * Print the current state of the translation tables by reading them from
68 * memory.
69 */
70void xlat_tables_print(xlat_ctx_t *ctx);
71
72/*
Antonio Nino Diazf1b84f62018-07-03 11:58:49 +010073 * Returns a block/page table descriptor for the given level and attributes.
74 */
75uint64_t xlat_desc(const xlat_ctx_t *ctx, uint32_t attr,
76 unsigned long long addr_pa, int level);
77
78/*
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000079 * Architecture-specific initialization code.
80 */
Antonio Nino Diazefabaa92017-04-27 13:30:22 +010081
82/* Returns the current Exception Level. The returned EL must be 1 or higher. */
83int xlat_arch_current_el(void);
84
85/*
Sandrine Bailleuxc5b63772017-05-31 13:31:48 +010086 * Return the maximum physical address supported by the hardware.
87 * This value depends on the execution state (AArch32/AArch64).
88 */
89unsigned long long xlat_arch_get_max_supported_pa(void);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000090
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +010091/*
92 * Return 1 if the MMU of the translation regime managed by the given xlat_ctx_t
93 * is enabled, 0 otherwise.
94 */
95int is_mmu_enabled_ctx(const xlat_ctx_t *ctx);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000096
97#endif /* __XLAT_TABLES_PRIVATE_H__ */