blob: 1a55fba777da15d291696b554d80911c485b23be [file] [log] [blame]
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +00001/*
2 * Copyright (c) 2017, ARM Limited and Contributors. All rights reserved.
3 *
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_V2_H__
8#define __XLAT_TABLES_V2_H__
9
10#include <xlat_tables_defs.h>
11
12#ifndef __ASSEMBLY__
13#include <stddef.h>
14#include <stdint.h>
15#include <xlat_mmu_helpers.h>
Sandrine Bailleux3120ea22017-07-10 13:37:48 +010016#include <xlat_tables_v2_helpers.h>
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000017
Sandrine Bailleux8f23fa82017-09-28 21:58:12 +010018/*
19 * Default granularity size for an mmap_region_t.
20 * Useful when no specific granularity is required.
21 *
22 * By default, choose the biggest possible block size allowed by the
23 * architectural state and granule size in order to minimize the number of page
24 * tables required for the mapping.
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000025 */
Sandrine Bailleux8f23fa82017-09-28 21:58:12 +010026#define REGION_DEFAULT_GRANULARITY XLAT_BLOCK_SIZE(MIN_LVL_BLOCK_DESC)
27
28/* Helper macro to define an mmap_region_t. */
29#define MAP_REGION(_pa, _va, _sz, _attr) \
30 _MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, REGION_DEFAULT_GRANULARITY)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000031
Sandrine Bailleux8f23fa82017-09-28 21:58:12 +010032/* Helper macro to define an mmap_region_t with an identity mapping. */
33#define MAP_REGION_FLAT(_adr, _sz, _attr) \
34 MAP_REGION(_adr, _adr, _sz, _attr)
35
36/*
37 * Helper macro to define an mmap_region_t to map with the desired granularity
38 * of translation tables.
39 *
40 * The granularity value passed to this macro must be a valid block or page
41 * size. When using a 4KB translation granule, this might be 4KB, 2MB or 1GB.
42 * Passing REGION_DEFAULT_GRANULARITY is also allowed and means that the library
43 * is free to choose the granularity for this region. In this case, it is
44 * equivalent to the MAP_REGION() macro.
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000045 */
Sandrine Bailleux8f23fa82017-09-28 21:58:12 +010046#define MAP_REGION2(_pa, _va, _sz, _attr, _gr) \
47 _MAP_REGION_FULL_SPEC(_pa, _va, _sz, _attr, _gr)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000048
49/*
50 * Shifts and masks to access fields of an mmap_attr_t
51 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070052#define MT_TYPE_MASK U(0x7)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000053#define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK)
54/* Access permissions (RO/RW) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070055#define MT_PERM_SHIFT U(3)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000056/* Security state (SECURE/NS) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070057#define MT_SEC_SHIFT U(4)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000058/* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070059#define MT_EXECUTE_SHIFT U(5)
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +010060/*
61 * In the EL1&0 translation regime, mark the region as User (EL0) or
62 * Privileged (EL1). In the EL3 translation regime this has no effect.
63 */
64#define MT_USER_SHIFT U(6)
Antonio Nino Diazac998032017-02-27 17:23:54 +000065/* All other bits are reserved */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000066
67/*
68 * Memory mapping attributes
69 */
70typedef enum {
71 /*
72 * Memory types supported.
73 * These are organised so that, going down the list, the memory types
74 * are getting weaker; conversely going up the list the memory types are
75 * getting stronger.
76 */
77 MT_DEVICE,
78 MT_NON_CACHEABLE,
79 MT_MEMORY,
80 /* Values up to 7 are reserved to add new memory types in the future */
81
Varun Wadekarc6a11f62017-05-25 18:04:48 -070082 MT_RO = U(0) << MT_PERM_SHIFT,
83 MT_RW = U(1) << MT_PERM_SHIFT,
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000084
Varun Wadekarc6a11f62017-05-25 18:04:48 -070085 MT_SECURE = U(0) << MT_SEC_SHIFT,
86 MT_NS = U(1) << MT_SEC_SHIFT,
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +000087
88 /*
89 * Access permissions for instruction execution are only relevant for
90 * normal read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored
91 * (and potentially overridden) otherwise:
92 * - Device memory is always marked as execute-never.
93 * - Read-write normal memory is always marked as execute-never.
94 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -070095 MT_EXECUTE = U(0) << MT_EXECUTE_SHIFT,
96 MT_EXECUTE_NEVER = U(1) << MT_EXECUTE_SHIFT,
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +010097
98 /*
99 * When mapping a region at EL0 or EL1, this attribute will be used to
100 * determine if a User mapping (EL0) will be created or a Privileged
101 * mapping (EL1).
102 */
103 MT_USER = U(1) << MT_USER_SHIFT,
104 MT_PRIVILEGED = U(0) << MT_USER_SHIFT,
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000105} mmap_attr_t;
106
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +0100107/* Compound attributes for most common usages */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000108#define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE)
109#define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER)
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +0100110#define MT_RW_DATA (MT_MEMORY | MT_RW | MT_EXECUTE_NEVER)
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000111
112/*
113 * Structure for specifying a single region of memory.
114 */
115typedef struct mmap_region {
116 unsigned long long base_pa;
117 uintptr_t base_va;
118 size_t size;
119 mmap_attr_t attr;
Sandrine Bailleux8f23fa82017-09-28 21:58:12 +0100120 /* Desired granularity. See the MAP_REGION2() macro for more details. */
121 size_t granularity;
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000122} mmap_region_t;
123
Sandrine Bailleux3120ea22017-07-10 13:37:48 +0100124/*
Douglas Raillard2d545792017-09-25 15:23:22 +0100125 * Translation regimes supported by this library.
126 */
127typedef enum xlat_regime {
128 EL1_EL0_REGIME,
129 EL3_REGIME,
130} xlat_regime_t;
131
132/*
Sandrine Bailleux3120ea22017-07-10 13:37:48 +0100133 * Declare the translation context type.
134 * Its definition is private.
135 */
136typedef struct xlat_ctx xlat_ctx_t;
137
138/*
139 * Statically allocate a translation context and associated structures. Also
140 * initialize them.
141 *
142 * _ctx_name:
143 * Prefix for the translation context variable.
144 * E.g. If _ctx_name is 'foo', the variable will be called 'foo_xlat_ctx'.
145 * Useful to distinguish multiple contexts from one another.
146 *
147 * _mmap_count:
148 * Number of mmap_region_t to allocate.
149 * Would typically be MAX_MMAP_REGIONS for the translation context describing
150 * the BL image currently executing.
151 *
152 * _xlat_tables_count:
153 * Number of sub-translation tables to allocate.
154 * Would typically be MAX_XLAT_TABLES for the translation context describing
155 * the BL image currently executing.
156 * Note that this is only for sub-tables ; at the initial lookup level, there
157 * is always a single table.
158 *
159 * _virt_addr_space_size, _phy_addr_space_size:
160 * Size (in bytes) of the virtual (resp. physical) address space.
161 * Would typically be PLAT_VIRT_ADDR_SPACE_SIZE
162 * (resp. PLAT_PHY_ADDR_SPACE_SIZE) for the translation context describing the
163 * BL image currently executing.
164 */
165#define REGISTER_XLAT_CONTEXT(_ctx_name, _mmap_count, _xlat_tables_count, \
166 _virt_addr_space_size, _phy_addr_space_size) \
Antonio Nino Diazdcf9d922017-10-04 16:52:15 +0100167 _REGISTER_XLAT_CONTEXT_FULL_SPEC(_ctx_name, _mmap_count, \
168 _xlat_tables_count, \
169 _virt_addr_space_size, \
170 _phy_addr_space_size, \
171 IMAGE_XLAT_DEFAULT_REGIME)
172
173/*
174 * Same as REGISTER_XLAT_CONTEXT plus the additional parameter _xlat_regime to
175 * specify the translation regime managed by this xlat_ctx_t instance. The
176 * values are the one from xlat_regime_t enumeration.
177 */
178#define REGISTER_XLAT_CONTEXT2(_ctx_name, _mmap_count, _xlat_tables_count, \
179 _virt_addr_space_size, _phy_addr_space_size, \
180 _xlat_regime) \
181 _REGISTER_XLAT_CONTEXT_FULL_SPEC(_ctx_name, _mmap_count, \
182 _xlat_tables_count, \
183 _virt_addr_space_size, \
184 _phy_addr_space_size, \
185 _xlat_regime)
Sandrine Bailleux3120ea22017-07-10 13:37:48 +0100186
Sandrine Bailleux66342932017-07-18 13:26:36 +0100187/******************************************************************************
188 * Generic translation table APIs.
189 * Each API comes in 2 variants:
190 * - one that acts on the current translation context for this BL image
191 * - another that acts on the given translation context instead. This variant
192 * is named after the 1st version, with an additional '_ctx' suffix.
193 *****************************************************************************/
Antonio Nino Diaz9b11f392017-05-08 16:43:53 +0100194
195/*
196 * Initialize translation tables from the current list of mmap regions. Calling
197 * this function marks the transition point after which static regions can no
198 * longer be added.
199 */
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000200void init_xlat_tables(void);
Sandrine Bailleux66342932017-07-18 13:26:36 +0100201void init_xlat_tables_ctx(xlat_ctx_t *ctx);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000202
203/*
Antonio Nino Diaz9b11f392017-05-08 16:43:53 +0100204 * Add a static region with defined base PA and base VA. This function can only
205 * be used before initializing the translation tables. The region cannot be
206 * removed afterwards.
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000207 */
208void mmap_add_region(unsigned long long base_pa, uintptr_t base_va,
Sandrine Bailleux04980a32017-04-19 14:02:23 +0100209 size_t size, mmap_attr_t attr);
Sandrine Bailleux66342932017-07-18 13:26:36 +0100210void mmap_add_region_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm);
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000211
212/*
Sandrine Bailleux66342932017-07-18 13:26:36 +0100213 * Add an array of static regions with defined base PA and base VA. This
214 * function can only be used before initializing the translation tables. The
215 * regions cannot be removed afterwards.
216 */
217void mmap_add(const mmap_region_t *mm);
218void mmap_add_ctx(xlat_ctx_t *ctx, const mmap_region_t *mm);
219
220
221#if PLAT_XLAT_TABLES_DYNAMIC
222/*
Antonio Nino Diaz9b11f392017-05-08 16:43:53 +0100223 * Add a dynamic region with defined base PA and base VA. This type of region
224 * can be added and removed even after the translation tables are initialized.
Antonio Nino Diazac998032017-02-27 17:23:54 +0000225 *
226 * Returns:
227 * 0: Success.
228 * EINVAL: Invalid values were used as arguments.
229 * ERANGE: Memory limits were surpassed.
230 * ENOMEM: Not enough space in the mmap array or not enough free xlat tables.
231 * EPERM: It overlaps another region in an invalid way.
232 */
233int mmap_add_dynamic_region(unsigned long long base_pa, uintptr_t base_va,
Sandrine Bailleux04980a32017-04-19 14:02:23 +0100234 size_t size, mmap_attr_t attr);
Sandrine Bailleux66342932017-07-18 13:26:36 +0100235int mmap_add_dynamic_region_ctx(xlat_ctx_t *ctx, mmap_region_t *mm);
Antonio Nino Diazac998032017-02-27 17:23:54 +0000236
237/*
Antonio Nino Diazac998032017-02-27 17:23:54 +0000238 * Remove a region with the specified base VA and size. Only dynamic regions can
Antonio Nino Diaz9b11f392017-05-08 16:43:53 +0100239 * be removed, and they can be removed even if the translation tables are
240 * initialized.
Antonio Nino Diazac998032017-02-27 17:23:54 +0000241 *
242 * Returns:
243 * 0: Success.
244 * EINVAL: The specified region wasn't found.
245 * EPERM: Trying to remove a static region.
246 */
247int mmap_remove_dynamic_region(uintptr_t base_va, size_t size);
Sandrine Bailleux66342932017-07-18 13:26:36 +0100248int mmap_remove_dynamic_region_ctx(xlat_ctx_t *ctx,
249 uintptr_t base_va,
250 size_t size);
251
252#endif /* PLAT_XLAT_TABLES_DYNAMIC */
Antonio Nino Diazac998032017-02-27 17:23:54 +0000253
Antonio Nino Diaz233c7c12017-03-08 14:40:23 +0000254#endif /*__ASSEMBLY__*/
255#endif /* __XLAT_TABLES_V2_H__ */