blob: 4097c76f46d6b85bcf94eeba69034eafc57592ad [file] [log] [blame]
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00001/*
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +01002 * 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_TABLES_H
8#define XLAT_TABLES_H
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00009
10#include <xlat_tables_defs.h>
11
12#ifndef __ASSEMBLY__
13#include <stddef.h>
14#include <stdint.h>
15#include <xlat_mmu_helpers.h>
16
17/* Helper macro to define entries for mmap_region_t. It creates
18 * identity mappings for each region.
19 */
20#define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr)
21
22/* Helper macro to define entries for mmap_region_t. It allows to
23 * re-map address mappings from 'pa' to 'va' for each region.
24 */
25#define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)}
26
27/*
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010028 * Shifts and masks to access fields of an mmap attribute
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000029 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070030#define MT_TYPE_MASK U(0x7)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000031#define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK)
32/* Access permissions (RO/RW) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070033#define MT_PERM_SHIFT U(3)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000034/* Security state (SECURE/NS) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070035#define MT_SEC_SHIFT U(4)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000036/* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070037#define MT_EXECUTE_SHIFT U(5)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000038
39/*
40 * Memory mapping attributes
41 */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000042
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010043/*
44 * Memory types supported.
45 * These are organised so that, going down the list, the memory types are
46 * getting weaker; conversely going up the list the memory types are getting
47 * stronger.
48 */
49#define MT_DEVICE U(0)
50#define MT_NON_CACHEABLE U(1)
51#define MT_MEMORY U(2)
52/* Values up to 7 are reserved to add new memory types in the future */
53
54#define MT_RO (U(0) << MT_PERM_SHIFT)
55#define MT_RW (U(1) << MT_PERM_SHIFT)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000056
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010057#define MT_SECURE (U(0) << MT_SEC_SHIFT)
58#define MT_NS (U(1) << MT_SEC_SHIFT)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000059
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010060/*
61 * Access permissions for instruction execution are only relevant for normal
62 * read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored (and potentially
63 * overridden) otherwise:
64 * - Device memory is always marked as execute-never.
65 * - Read-write normal memory is always marked as execute-never.
66 */
67#define MT_EXECUTE (U(0) << MT_EXECUTE_SHIFT)
68#define MT_EXECUTE_NEVER (U(1) << MT_EXECUTE_SHIFT)
69
70/* Compound attributes for most common usages */
71#define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE)
72#define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000073
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010074#if !ERROR_DEPRECATED
75typedef unsigned int mmap_attr_t;
76#endif
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000077
78/*
79 * Structure for specifying a single region of memory.
80 */
81typedef struct mmap_region {
82 unsigned long long base_pa;
83 uintptr_t base_va;
84 size_t size;
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010085 unsigned int attr;
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000086} mmap_region_t;
87
88/* Generic translation table APIs */
89void init_xlat_tables(void);
90void mmap_add_region(unsigned long long base_pa, uintptr_t base_va,
Antonio Nino Diaz8643a812018-06-21 14:39:16 +010091 size_t size, unsigned int attr);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000092void mmap_add(const mmap_region_t *mm);
93
94#endif /*__ASSEMBLY__*/
Antonio Nino Diaz50eb3742018-07-24 10:20:53 +010095#endif /* XLAT_TABLES_H */