1 /* 2 * Copyright (c) 2014-2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __XLAT_TABLES_H__ 32 #define __XLAT_TABLES_H__ 33 34 #include <xlat_tables_defs.h> 35 36 #ifndef __ASSEMBLY__ 37 #include <stddef.h> 38 #include <stdint.h> 39 #include <xlat_mmu_helpers.h> 40 41 /* Helper macro to define entries for mmap_region_t. It creates 42 * identity mappings for each region. 43 */ 44 #define MAP_REGION_FLAT(adr, sz, attr) MAP_REGION(adr, adr, sz, attr) 45 46 /* Helper macro to define entries for mmap_region_t. It allows to 47 * re-map address mappings from 'pa' to 'va' for each region. 48 */ 49 #define MAP_REGION(pa, va, sz, attr) {(pa), (va), (sz), (attr)} 50 51 /* 52 * Shifts and masks to access fields of an mmap_attr_t 53 */ 54 #define MT_TYPE_MASK 0x7 55 #define MT_TYPE(_attr) ((_attr) & MT_TYPE_MASK) 56 /* Access permissions (RO/RW) */ 57 #define MT_PERM_SHIFT 3 58 /* Security state (SECURE/NS) */ 59 #define MT_SEC_SHIFT 4 60 /* Access permissions for instruction execution (EXECUTE/EXECUTE_NEVER) */ 61 #define MT_EXECUTE_SHIFT 5 62 63 /* 64 * Memory mapping attributes 65 */ 66 typedef enum { 67 /* 68 * Memory types supported. 69 * These are organised so that, going down the list, the memory types 70 * are getting weaker; conversely going up the list the memory types are 71 * getting stronger. 72 */ 73 MT_DEVICE, 74 MT_NON_CACHEABLE, 75 MT_MEMORY, 76 /* Values up to 7 are reserved to add new memory types in the future */ 77 78 MT_RO = 0 << MT_PERM_SHIFT, 79 MT_RW = 1 << MT_PERM_SHIFT, 80 81 MT_SECURE = 0 << MT_SEC_SHIFT, 82 MT_NS = 1 << MT_SEC_SHIFT, 83 84 /* 85 * Access permissions for instruction execution are only relevant for 86 * normal read-only memory, i.e. MT_MEMORY | MT_RO. They are ignored 87 * (and potentially overridden) otherwise: 88 * - Device memory is always marked as execute-never. 89 * - Read-write normal memory is always marked as execute-never. 90 */ 91 MT_EXECUTE = 0 << MT_EXECUTE_SHIFT, 92 MT_EXECUTE_NEVER = 1 << MT_EXECUTE_SHIFT, 93 } mmap_attr_t; 94 95 #define MT_CODE (MT_MEMORY | MT_RO | MT_EXECUTE) 96 #define MT_RO_DATA (MT_MEMORY | MT_RO | MT_EXECUTE_NEVER) 97 98 /* 99 * Structure for specifying a single region of memory. 100 */ 101 typedef struct mmap_region { 102 unsigned long long base_pa; 103 uintptr_t base_va; 104 size_t size; 105 mmap_attr_t attr; 106 } mmap_region_t; 107 108 /* Generic translation table APIs */ 109 void init_xlat_tables(void); 110 void mmap_add_region(unsigned long long base_pa, uintptr_t base_va, 111 size_t size, mmap_attr_t attr); 112 void mmap_add(const mmap_region_t *mm); 113 114 #endif /*__ASSEMBLY__*/ 115 #endif /* __XLAT_TABLES_H__ */ 116