blob: a1569697667efab7faf72b3e941974bcd970a516 [file] [log] [blame]
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00001/*
Zelalem Aweke173c6a22021-07-08 17:23:04 -05002 * Copyright (c) 2014-2021, 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_TABLES_H
8#define XLAT_TABLES_H
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <lib/xlat_tables/xlat_tables_defs.h>
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000011
Julius Werner53456fc2019-07-09 13:49:11 -070012#ifndef __ASSEMBLER__
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000013#include <stddef.h>
14#include <stdint.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000015
16#include <lib/xlat_tables/xlat_mmu_helpers.h>
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000017
18/* Helper macro to define entries for mmap_region_t. It creates
19 * identity mappings for each region.
20 */
21#define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr)
22
23/* Helper macro to define entries for mmap_region_t. It allows to
24 * re-map address mappings from 'pa' to 'va' for each region.
25 */
26#define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)}
27
28/*
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010029 * Shifts and masks to access fields of an mmap attribute
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000030 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070031#define MT_TYPE_MASK U(0x7)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000032#define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK)
33/* Access permissions (RO/RW) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070034#define MT_PERM_SHIFT U(3)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000035/* Security state (SECURE/NS) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070036#define MT_SEC_SHIFT U(4)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000037/* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070038#define MT_EXECUTE_SHIFT U(5)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000039
40/*
41 * Memory mapping attributes
42 */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000043
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010044/*
45 * Memory types supported.
46 * These are organised so that, going down the list, the memory types are
47 * getting weaker; conversely going up the list the memory types are getting
48 * stronger.
49 */
50#define MT_DEVICE U(0)
51#define MT_NON_CACHEABLE U(1)
52#define MT_MEMORY U(2)
53/* Values up to 7 are reserved to add new memory types in the future */
54
55#define MT_RO (U(0) << MT_PERM_SHIFT)
56#define MT_RW (U(1) << MT_PERM_SHIFT)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000057
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010058#define MT_SECURE (U(0) << MT_SEC_SHIFT)
59#define MT_NS (U(1) << MT_SEC_SHIFT)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000060
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010061/*
62 * Access permissions for instruction execution are only relevant for normal
63 * read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored (and potentially
64 * overridden) otherwise:
65 * - Device memory is always marked as execute-never.
66 * - Read-write normal memory is always marked as execute-never.
67 */
68#define MT_EXECUTE (U(0) << MT_EXECUTE_SHIFT)
69#define MT_EXECUTE_NEVER (U(1) << MT_EXECUTE_SHIFT)
70
71/* Compound attributes for most common usages */
72#define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE)
73#define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000074
Zelalem Aweke173c6a22021-07-08 17:23:04 -050075/* Memory type for EL3 regions */
76#if ENABLE_RME
77#error FEAT_RME requires version 2 of the Translation Tables Library
78#else
79#define EL3_PAS MT_SECURE
80#endif
81
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000082/*
83 * Structure for specifying a single region of memory.
84 */
85typedef struct mmap_region {
86 unsigned long long base_pa;
87 uintptr_t base_va;
88 size_t size;
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010089 unsigned int attr;
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000090} mmap_region_t;
91
92/* Generic translation table APIs */
93void init_xlat_tables(void);
94void mmap_add_region(unsigned long long base_pa, uintptr_t base_va,
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010095 size_t size, unsigned int attr);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000096void mmap_add(const mmap_region_t *mm);
97
Julius Werner53456fc2019-07-09 13:49:11 -070098#endif /*__ASSEMBLER__*/
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +010099#endif /* XLAT_TABLES_H */