2014-01-24 15:41:33 +00:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
|
* modification, are permitted provided that the following conditions are met:
|
|
|
|
|
*
|
|
|
|
|
* Redistributions of source code must retain the above copyright notice, this
|
|
|
|
|
* list of conditions and the following disclaimer.
|
|
|
|
|
*
|
|
|
|
|
* Redistributions in binary form must reproduce the above copyright notice,
|
|
|
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
|
|
|
* and/or other materials provided with the distribution.
|
|
|
|
|
*
|
|
|
|
|
* Neither the name of ARM nor the names of its contributors may be used
|
|
|
|
|
* to endorse or promote products derived from this software without specific
|
|
|
|
|
* prior written permission.
|
|
|
|
|
*
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
|
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
*/
|
|
|
|
|
|
2014-04-03 13:48:04 +01:00
|
|
|
#ifndef __XLAT_TABLES_H__
|
|
|
|
|
#define __XLAT_TABLES_H__
|
|
|
|
|
|
2014-06-26 08:59:07 +01:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Flags to override default values used to program system registers while
|
|
|
|
|
* enabling the MMU.
|
|
|
|
|
*/
|
|
|
|
|
#define DISABLE_DCACHE (1 << 0)
|
|
|
|
|
|
|
|
|
|
#ifndef __ASSEMBLY__
|
2014-01-24 15:41:33 +00:00
|
|
|
#include <stdint.h>
|
|
|
|
|
|
2014-09-03 17:48:44 +01:00
|
|
|
/* Helper macro to define entries for mmap_region_t. It creates
|
|
|
|
|
* identity mappings for each region.
|
|
|
|
|
*/
|
|
|
|
|
#define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr)
|
|
|
|
|
|
|
|
|
|
/* Helper macro to define entries for mmap_region_t. It allows to
|
|
|
|
|
* re-map address mappings from 'pa' to 'va' for each region.
|
|
|
|
|
*/
|
|
|
|
|
#define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)}
|
|
|
|
|
|
2014-01-24 15:41:33 +00:00
|
|
|
/*
|
Extend memory attributes to map non-cacheable memory
At the moment, the memory translation library allows to create memory
mappings of 2 types:
- Device nGnRE memory (named MT_DEVICE in the library);
- Normal, Inner Write-back non-transient, Outer Write-back
non-transient memory (named MT_MEMORY in the library).
As a consequence, the library code treats the memory type field as a
boolean: everything that is not device memory is normal memory and
vice-versa.
In reality, the ARMv8 architecture allows up to 8 types of memory to
be used at a single time for a given exception level. This patch
reworks the memory attributes such that the memory type is now defined
as an integer ranging from 0 to 7 instead of a boolean. This makes it
possible to extend the list of memory types supported by the memory
translation library.
The priority system dictating memory attributes for overlapping
memory regions has been extended to cope with these changes but the
algorithm at its core has been preserved. When a memory region is
re-mapped with different memory attributes, the memory translation
library examines the former attributes and updates them only if
the new attributes create a more restrictive mapping. This behaviour
is unchanged, only the manipulation of the value has been modified
to cope with the new format.
This patch also introduces a new type of memory mapping in the memory
translation library: MT_NON_CACHEABLE, meaning Normal, Inner
Non-cacheable, Outer Non-cacheable memory. This can be useful to map
a non-cacheable memory region, such as a DMA buffer for example.
The rules around the Execute-Never (XN) bit in a translation table
for an MT_NON_CACHEABLE memory mapping have been aligned on the rules
used for MT_MEMORY mappings:
- If the memory is read-only then it is also executable (XN = 0);
- If the memory is read-write then it is not executable (XN = 1).
The shareability field for MT_NON_CACHEABLE mappings is always set as
'Outer-Shareable'. Note that this is not strictly needed since
shareability is only relevant if the memory is a Normal Cacheable
memory type, but this is to align with the existing device memory
mappings setup. All Device and Normal Non-cacheable memory regions
are always treated as Outer Shareable, regardless of the translation
table shareability attributes.
This patch also removes the 'ATTR_SO' and 'ATTR_SO_INDEX' #defines.
They were introduced to map memory as Device nGnRnE (formerly called
"Strongly-Ordered" memory in the ARMv7 architecture) but were not
used anywhere in the code base. Removing them avoids any confusion
about the memory types supported by the library.
Upstream platforms do not currently use the MT_NON_CACHEABLE memory
type.
NOTE: THIS CHANGE IS SOURCE COMPATIBLE BUT PLATFORMS THAT RELY ON THE
BINARY VALUES OF `mmap_attr_t` or the `attr` argument of
`mmap_add_region()` MAY BE BROKEN.
Change-Id: I717d6ed79b4c845a04e34132432f98b93d661d79
2016-03-01 14:01:03 +00:00
|
|
|
* Shifts and masks to access fields of an mmap_attr_t
|
|
|
|
|
*/
|
|
|
|
|
#define MT_TYPE_MASK 0x7
|
|
|
|
|
#define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK)
|
|
|
|
|
/* Access permissions (RO/RW) */
|
|
|
|
|
#define MT_PERM_SHIFT 3
|
|
|
|
|
/* Security state (SECURE/NS) */
|
|
|
|
|
#define MT_SEC_SHIFT 4
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Memory mapping attributes
|
2014-01-24 15:41:33 +00:00
|
|
|
*/
|
|
|
|
|
typedef enum {
|
Extend memory attributes to map non-cacheable memory
At the moment, the memory translation library allows to create memory
mappings of 2 types:
- Device nGnRE memory (named MT_DEVICE in the library);
- Normal, Inner Write-back non-transient, Outer Write-back
non-transient memory (named MT_MEMORY in the library).
As a consequence, the library code treats the memory type field as a
boolean: everything that is not device memory is normal memory and
vice-versa.
In reality, the ARMv8 architecture allows up to 8 types of memory to
be used at a single time for a given exception level. This patch
reworks the memory attributes such that the memory type is now defined
as an integer ranging from 0 to 7 instead of a boolean. This makes it
possible to extend the list of memory types supported by the memory
translation library.
The priority system dictating memory attributes for overlapping
memory regions has been extended to cope with these changes but the
algorithm at its core has been preserved. When a memory region is
re-mapped with different memory attributes, the memory translation
library examines the former attributes and updates them only if
the new attributes create a more restrictive mapping. This behaviour
is unchanged, only the manipulation of the value has been modified
to cope with the new format.
This patch also introduces a new type of memory mapping in the memory
translation library: MT_NON_CACHEABLE, meaning Normal, Inner
Non-cacheable, Outer Non-cacheable memory. This can be useful to map
a non-cacheable memory region, such as a DMA buffer for example.
The rules around the Execute-Never (XN) bit in a translation table
for an MT_NON_CACHEABLE memory mapping have been aligned on the rules
used for MT_MEMORY mappings:
- If the memory is read-only then it is also executable (XN = 0);
- If the memory is read-write then it is not executable (XN = 1).
The shareability field for MT_NON_CACHEABLE mappings is always set as
'Outer-Shareable'. Note that this is not strictly needed since
shareability is only relevant if the memory is a Normal Cacheable
memory type, but this is to align with the existing device memory
mappings setup. All Device and Normal Non-cacheable memory regions
are always treated as Outer Shareable, regardless of the translation
table shareability attributes.
This patch also removes the 'ATTR_SO' and 'ATTR_SO_INDEX' #defines.
They were introduced to map memory as Device nGnRnE (formerly called
"Strongly-Ordered" memory in the ARMv7 architecture) but were not
used anywhere in the code base. Removing them avoids any confusion
about the memory types supported by the library.
Upstream platforms do not currently use the MT_NON_CACHEABLE memory
type.
NOTE: THIS CHANGE IS SOURCE COMPATIBLE BUT PLATFORMS THAT RELY ON THE
BINARY VALUES OF `mmap_attr_t` or the `attr` argument of
`mmap_add_region()` MAY BE BROKEN.
Change-Id: I717d6ed79b4c845a04e34132432f98b93d661d79
2016-03-01 14:01:03 +00:00
|
|
|
/*
|
|
|
|
|
* Memory types supported.
|
|
|
|
|
* These are organised so that, going down the list, the memory types
|
|
|
|
|
* are getting weaker; conversely going up the list the memory types are
|
|
|
|
|
* getting stronger.
|
|
|
|
|
*/
|
|
|
|
|
MT_DEVICE,
|
|
|
|
|
MT_NON_CACHEABLE,
|
|
|
|
|
MT_MEMORY,
|
|
|
|
|
/* Values up to 7 are reserved to add new memory types in the future */
|
2014-01-24 15:41:33 +00:00
|
|
|
|
Extend memory attributes to map non-cacheable memory
At the moment, the memory translation library allows to create memory
mappings of 2 types:
- Device nGnRE memory (named MT_DEVICE in the library);
- Normal, Inner Write-back non-transient, Outer Write-back
non-transient memory (named MT_MEMORY in the library).
As a consequence, the library code treats the memory type field as a
boolean: everything that is not device memory is normal memory and
vice-versa.
In reality, the ARMv8 architecture allows up to 8 types of memory to
be used at a single time for a given exception level. This patch
reworks the memory attributes such that the memory type is now defined
as an integer ranging from 0 to 7 instead of a boolean. This makes it
possible to extend the list of memory types supported by the memory
translation library.
The priority system dictating memory attributes for overlapping
memory regions has been extended to cope with these changes but the
algorithm at its core has been preserved. When a memory region is
re-mapped with different memory attributes, the memory translation
library examines the former attributes and updates them only if
the new attributes create a more restrictive mapping. This behaviour
is unchanged, only the manipulation of the value has been modified
to cope with the new format.
This patch also introduces a new type of memory mapping in the memory
translation library: MT_NON_CACHEABLE, meaning Normal, Inner
Non-cacheable, Outer Non-cacheable memory. This can be useful to map
a non-cacheable memory region, such as a DMA buffer for example.
The rules around the Execute-Never (XN) bit in a translation table
for an MT_NON_CACHEABLE memory mapping have been aligned on the rules
used for MT_MEMORY mappings:
- If the memory is read-only then it is also executable (XN = 0);
- If the memory is read-write then it is not executable (XN = 1).
The shareability field for MT_NON_CACHEABLE mappings is always set as
'Outer-Shareable'. Note that this is not strictly needed since
shareability is only relevant if the memory is a Normal Cacheable
memory type, but this is to align with the existing device memory
mappings setup. All Device and Normal Non-cacheable memory regions
are always treated as Outer Shareable, regardless of the translation
table shareability attributes.
This patch also removes the 'ATTR_SO' and 'ATTR_SO_INDEX' #defines.
They were introduced to map memory as Device nGnRnE (formerly called
"Strongly-Ordered" memory in the ARMv7 architecture) but were not
used anywhere in the code base. Removing them avoids any confusion
about the memory types supported by the library.
Upstream platforms do not currently use the MT_NON_CACHEABLE memory
type.
NOTE: THIS CHANGE IS SOURCE COMPATIBLE BUT PLATFORMS THAT RELY ON THE
BINARY VALUES OF `mmap_attr_t` or the `attr` argument of
`mmap_add_region()` MAY BE BROKEN.
Change-Id: I717d6ed79b4c845a04e34132432f98b93d661d79
2016-03-01 14:01:03 +00:00
|
|
|
/*
|
|
|
|
|
* The following values are organised so that a clear bit gives a more
|
|
|
|
|
* restrictive mapping than a set bit, that way a bitwise-and of two
|
|
|
|
|
* sets of attributes will never give an attribute which has greater
|
|
|
|
|
* access rights than any of the original attributes.
|
|
|
|
|
*/
|
|
|
|
|
MT_RO = 0 << MT_PERM_SHIFT,
|
|
|
|
|
MT_RW = 1 << MT_PERM_SHIFT,
|
2014-01-24 15:41:33 +00:00
|
|
|
|
Extend memory attributes to map non-cacheable memory
At the moment, the memory translation library allows to create memory
mappings of 2 types:
- Device nGnRE memory (named MT_DEVICE in the library);
- Normal, Inner Write-back non-transient, Outer Write-back
non-transient memory (named MT_MEMORY in the library).
As a consequence, the library code treats the memory type field as a
boolean: everything that is not device memory is normal memory and
vice-versa.
In reality, the ARMv8 architecture allows up to 8 types of memory to
be used at a single time for a given exception level. This patch
reworks the memory attributes such that the memory type is now defined
as an integer ranging from 0 to 7 instead of a boolean. This makes it
possible to extend the list of memory types supported by the memory
translation library.
The priority system dictating memory attributes for overlapping
memory regions has been extended to cope with these changes but the
algorithm at its core has been preserved. When a memory region is
re-mapped with different memory attributes, the memory translation
library examines the former attributes and updates them only if
the new attributes create a more restrictive mapping. This behaviour
is unchanged, only the manipulation of the value has been modified
to cope with the new format.
This patch also introduces a new type of memory mapping in the memory
translation library: MT_NON_CACHEABLE, meaning Normal, Inner
Non-cacheable, Outer Non-cacheable memory. This can be useful to map
a non-cacheable memory region, such as a DMA buffer for example.
The rules around the Execute-Never (XN) bit in a translation table
for an MT_NON_CACHEABLE memory mapping have been aligned on the rules
used for MT_MEMORY mappings:
- If the memory is read-only then it is also executable (XN = 0);
- If the memory is read-write then it is not executable (XN = 1).
The shareability field for MT_NON_CACHEABLE mappings is always set as
'Outer-Shareable'. Note that this is not strictly needed since
shareability is only relevant if the memory is a Normal Cacheable
memory type, but this is to align with the existing device memory
mappings setup. All Device and Normal Non-cacheable memory regions
are always treated as Outer Shareable, regardless of the translation
table shareability attributes.
This patch also removes the 'ATTR_SO' and 'ATTR_SO_INDEX' #defines.
They were introduced to map memory as Device nGnRnE (formerly called
"Strongly-Ordered" memory in the ARMv7 architecture) but were not
used anywhere in the code base. Removing them avoids any confusion
about the memory types supported by the library.
Upstream platforms do not currently use the MT_NON_CACHEABLE memory
type.
NOTE: THIS CHANGE IS SOURCE COMPATIBLE BUT PLATFORMS THAT RELY ON THE
BINARY VALUES OF `mmap_attr_t` or the `attr` argument of
`mmap_add_region()` MAY BE BROKEN.
Change-Id: I717d6ed79b4c845a04e34132432f98b93d661d79
2016-03-01 14:01:03 +00:00
|
|
|
MT_SECURE = 0 << MT_SEC_SHIFT,
|
|
|
|
|
MT_NS = 1 << MT_SEC_SHIFT,
|
2014-04-10 15:37:22 +01:00
|
|
|
} mmap_attr_t;
|
2014-01-24 15:41:33 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Structure for specifying a single region of memory.
|
|
|
|
|
*/
|
2014-04-10 15:37:22 +01:00
|
|
|
typedef struct mmap_region {
|
2014-06-02 19:45:36 +01:00
|
|
|
unsigned long base_pa;
|
|
|
|
|
unsigned long base_va;
|
2014-01-24 15:41:33 +00:00
|
|
|
unsigned long size;
|
2014-04-10 15:37:22 +01:00
|
|
|
mmap_attr_t attr;
|
|
|
|
|
} mmap_region_t;
|
2014-01-24 15:41:33 +00:00
|
|
|
|
2014-06-02 19:45:36 +01:00
|
|
|
void mmap_add_region(unsigned long base_pa, unsigned long base_va,
|
|
|
|
|
unsigned long size, unsigned attr);
|
2014-05-14 12:38:32 +01:00
|
|
|
void mmap_add(const mmap_region_t *mm);
|
2014-01-24 15:41:33 +00:00
|
|
|
|
2014-05-14 12:38:32 +01:00
|
|
|
void init_xlat_tables(void);
|
2014-01-24 15:41:33 +00:00
|
|
|
|
2014-06-26 08:59:07 +01:00
|
|
|
void enable_mmu_el1(uint32_t flags);
|
|
|
|
|
void enable_mmu_el3(uint32_t flags);
|
2014-04-03 13:48:04 +01:00
|
|
|
|
2014-06-26 08:59:07 +01:00
|
|
|
#endif /*__ASSEMBLY__*/
|
2014-04-03 13:48:04 +01:00
|
|
|
#endif /* __XLAT_TABLES_H__ */
|
