blob: fabc49460440af6935beae5f65840a5175066520 [file] [log] [blame]
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00001/*
Govindraj Rajaeee28e72023-08-01 15:52:40 -05002 * Copyright (c) 2014-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
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +01007#ifndef XLAT_MMU_HELPERS_H
8#define XLAT_MMU_HELPERS_H
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00009
Antonio Nino Diaz7c2a3ca2018-02-23 15:07:54 +000010/*
11 * The following flags are passed to enable_mmu_xxx() to override the default
12 * values used to program system registers while enabling the MMU.
13 */
14
15/*
16 * When this flag is used, all data access to Normal memory from this EL and all
17 * Normal memory accesses to the translation tables of this EL are non-cacheable
18 * for all levels of data and unified cache until the caches are enabled by
19 * setting the bit SCTLR_ELx.C.
20 */
21#define DISABLE_DCACHE (U(1) << 0)
22
23/*
24 * Mark the translation tables as non-cacheable for the MMU table walker, which
25 * is a different observer from the PE/CPU. If the flag is not specified, the
26 * tables are cacheable for the MMU table walker.
27 *
28 * Note that, as far as the PE/CPU observer is concerned, the attributes used
29 * are the ones specified in the translation tables themselves. The MAIR
30 * register specifies the cacheability through the field AttrIndx of the lower
31 * attributes of the translation tables. The shareability is specified in the SH
32 * field of the lower attributes.
33 *
34 * The MMU table walker uses the attributes specified in the fields ORGNn, IRGNn
35 * and SHn of the TCR register to access the translation tables.
36 *
37 * The attributes specified in the TCR register and the tables can be different
38 * as there are no checks to prevent that. Special care must be taken to ensure
39 * that there aren't mismatches. The behaviour in that case is described in the
40 * sections 'Mismatched memory attributes' in the ARMv8 ARM.
41 */
42#define XLAT_TABLE_NC (U(1) << 1)
43
Antonio Nino Diaz67f799e2018-07-15 16:42:01 +010044/*
45 * Offsets into a mmu_cfg_params array generated by setup_mmu_cfg(). All
46 * parameters are 64 bits wide.
47 */
48#define MMU_CFG_MAIR 0
49#define MMU_CFG_TCR 1
50#define MMU_CFG_TTBR0 2
51#define MMU_CFG_PARAM_MAX 3
52
Julius Werner53456fc2019-07-09 13:49:11 -070053#ifndef __ASSEMBLER__
Antonio Nino Diaz7c2a3ca2018-02-23 15:07:54 +000054
Antonio Nino Diaz5c97bd12018-08-02 09:57:29 +010055#include <stdbool.h>
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +010056#include <stdint.h>
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010057#include <string.h>
Antonio Nino Diaz4413ad52018-06-11 13:40:32 +010058
Masahiro Yamadafb10bfd2020-03-26 13:18:48 +090059#include <arch_helpers.h>
60
Antonio Nino Diaz67f799e2018-07-15 16:42:01 +010061/*
62 * Return the values that the MMU configuration registers must contain for the
63 * specified translation context. `params` must be a pointer to array of size
64 * MMU_CFG_PARAM_MAX.
65 */
66void setup_mmu_cfg(uint64_t *params, unsigned int flags,
67 const uint64_t *base_table, unsigned long long max_pa,
68 uintptr_t max_va, int xlat_regime);
69
Julius Werner8e0ef0f2019-07-09 14:02:43 -070070#ifdef __aarch64__
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000071/* AArch64 specific translation table APIs */
72void enable_mmu_el1(unsigned int flags);
Antonio Nino Diaz128de8d2018-08-07 19:59:49 +010073void enable_mmu_el2(unsigned int flags);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000074void enable_mmu_el3(unsigned int flags);
Masahiro Yamadafb10bfd2020-03-26 13:18:48 +090075void enable_mmu(unsigned int flags);
Jeenu Viswambharan58e81482018-04-27 15:06:57 +010076
77void enable_mmu_direct_el1(unsigned int flags);
Antonio Nino Diaz128de8d2018-08-07 19:59:49 +010078void enable_mmu_direct_el2(unsigned int flags);
Jeenu Viswambharan58e81482018-04-27 15:06:57 +010079void enable_mmu_direct_el3(unsigned int flags);
Julius Werner8e0ef0f2019-07-09 14:02:43 -070080#else
81/* AArch32 specific translation table API */
82void enable_mmu_svc_mon(unsigned int flags);
83void enable_mmu_hyp(unsigned int flags);
84
85void enable_mmu_direct_svc_mon(unsigned int flags);
86void enable_mmu_direct_hyp(unsigned int flags);
87#endif /* __aarch64__ */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000088
Antonio Nino Diaz5c97bd12018-08-02 09:57:29 +010089bool xlat_arch_is_granule_size_supported(size_t size);
Antonio Nino Diaz4413ad52018-06-11 13:40:32 +010090size_t xlat_arch_get_max_supported_granule_size(void);
91
Julius Werner53456fc2019-07-09 13:49:11 -070092#endif /* __ASSEMBLER__ */
Antonio Nino Diaz7c2a3ca2018-02-23 15:07:54 +000093
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +010094#endif /* XLAT_MMU_HELPERS_H */