1 /* 2 * Copyright (c) 2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __XLAT_TABLES_DEFS_H__ 8 #define __XLAT_TABLES_DEFS_H__ 9 10 #include <arch.h> 11 #include <utils_def.h> 12 13 /* Miscellaneous MMU related constants */ 14 #define NUM_2MB_IN_GB (U(1) << 9) 15 #define NUM_4K_IN_2MB (U(1) << 9) 16 #define NUM_GB_IN_4GB (U(1) << 2) 17 18 #define TWO_MB_SHIFT U(21) 19 #define ONE_GB_SHIFT U(30) 20 #define FOUR_KB_SHIFT U(12) 21 22 #define ONE_GB_INDEX(x) ((x) >> ONE_GB_SHIFT) 23 #define TWO_MB_INDEX(x) ((x) >> TWO_MB_SHIFT) 24 #define FOUR_KB_INDEX(x) ((x) >> FOUR_KB_SHIFT) 25 26 #define INVALID_DESC U(0x0) 27 #define BLOCK_DESC U(0x1) /* Table levels 0-2 */ 28 #define TABLE_DESC U(0x3) /* Table levels 0-2 */ 29 #define PAGE_DESC U(0x3) /* Table level 3 */ 30 #define DESC_MASK U(0x3) 31 32 #define FIRST_LEVEL_DESC_N ONE_GB_SHIFT 33 #define SECOND_LEVEL_DESC_N TWO_MB_SHIFT 34 #define THIRD_LEVEL_DESC_N FOUR_KB_SHIFT 35 36 /* XN: Translation regimes that support one VA range (EL2 and EL3). */ 37 #define XN (ULL(1) << 2) 38 /* UXN, PXN: Translation regimes that support two VA ranges (EL1&0). */ 39 #define UXN (ULL(1) << 2) 40 #define PXN (ULL(1) << 1) 41 #define CONT_HINT (ULL(1) << 0) 42 #define UPPER_ATTRS(x) (((x) & ULL(0x7)) << 52) 43 44 #define NON_GLOBAL (U(1) << 9) 45 #define ACCESS_FLAG (U(1) << 8) 46 #define NSH (U(0x0) << 6) 47 #define OSH (U(0x2) << 6) 48 #define ISH (U(0x3) << 6) 49 50 #define TABLE_ADDR_MASK ULL(0x0000FFFFFFFFF000) 51 52 /* 53 * The ARMv8-A architecture allows translation granule sizes of 4KB, 16KB or 54 * 64KB. However, TF only supports the 4KB case at the moment. 55 */ 56 #define PAGE_SIZE_SHIFT FOUR_KB_SHIFT 57 #define PAGE_SIZE (U(1) << PAGE_SIZE_SHIFT) 58 #define PAGE_SIZE_MASK (PAGE_SIZE - 1) 59 #define IS_PAGE_ALIGNED(addr) (((addr) & PAGE_SIZE_MASK) == 0) 60 61 #define XLAT_ENTRY_SIZE_SHIFT U(3) /* Each MMU table entry is 8 bytes (1 << 3) */ 62 #define XLAT_ENTRY_SIZE (U(1) << XLAT_ENTRY_SIZE_SHIFT) 63 64 #define XLAT_TABLE_SIZE_SHIFT PAGE_SIZE_SHIFT /* Size of one complete table */ 65 #define XLAT_TABLE_SIZE (U(1) << XLAT_TABLE_SIZE_SHIFT) 66 67 #define XLAT_TABLE_LEVEL_MAX U(3) 68 69 /* Values for number of entries in each MMU translation table */ 70 #define XLAT_TABLE_ENTRIES_SHIFT (XLAT_TABLE_SIZE_SHIFT - XLAT_ENTRY_SIZE_SHIFT) 71 #define XLAT_TABLE_ENTRIES (U(1) << XLAT_TABLE_ENTRIES_SHIFT) 72 #define XLAT_TABLE_ENTRIES_MASK (XLAT_TABLE_ENTRIES - 1) 73 74 /* Values to convert a memory address to an index into a translation table */ 75 #define L3_XLAT_ADDRESS_SHIFT PAGE_SIZE_SHIFT 76 #define L2_XLAT_ADDRESS_SHIFT (L3_XLAT_ADDRESS_SHIFT + XLAT_TABLE_ENTRIES_SHIFT) 77 #define L1_XLAT_ADDRESS_SHIFT (L2_XLAT_ADDRESS_SHIFT + XLAT_TABLE_ENTRIES_SHIFT) 78 #define L0_XLAT_ADDRESS_SHIFT (L1_XLAT_ADDRESS_SHIFT + XLAT_TABLE_ENTRIES_SHIFT) 79 #define XLAT_ADDR_SHIFT(level) (PAGE_SIZE_SHIFT + \ 80 ((XLAT_TABLE_LEVEL_MAX - (level)) * XLAT_TABLE_ENTRIES_SHIFT)) 81 82 #define XLAT_BLOCK_SIZE(level) ((u_register_t)1 << XLAT_ADDR_SHIFT(level)) 83 /* Mask to get the bits used to index inside a block of a certain level */ 84 #define XLAT_BLOCK_MASK(level) (XLAT_BLOCK_SIZE(level) - 1) 85 /* Mask to get the address bits common to a block of a certain table level*/ 86 #define XLAT_ADDR_MASK(level) (~XLAT_BLOCK_MASK(level)) 87 88 /* 89 * AP[1] bit is ignored by hardware and is 90 * treated as if it is One in EL2/EL3 91 */ 92 #define AP_RO (U(0x1) << 5) 93 #define AP_RW (U(0x0) << 5) 94 95 #define NS (U(0x1) << 3) 96 #define ATTR_NON_CACHEABLE_INDEX U(0x2) 97 #define ATTR_DEVICE_INDEX U(0x1) 98 #define ATTR_IWBWA_OWBWA_NTR_INDEX U(0x0) 99 #define LOWER_ATTRS(x) (((x) & U(0xfff)) << 2) 100 101 /* Normal Memory, Outer Write-Through non-transient, Inner Non-cacheable */ 102 #define ATTR_NON_CACHEABLE MAKE_MAIR_NORMAL_MEMORY(MAIR_NORM_NC, MAIR_NORM_NC) 103 /* Device-nGnRE */ 104 #define ATTR_DEVICE MAIR_DEV_nGnRE 105 /* Normal Memory, Outer Write-Back non-transient, Inner Write-Back non-transient */ 106 #define ATTR_IWBWA_OWBWA_NTR MAKE_MAIR_NORMAL_MEMORY(MAIR_NORM_WB_NTR_RWA, MAIR_NORM_WB_NTR_RWA) 107 #define MAIR_ATTR_SET(attr, index) ((attr) << ((index) << 3)) 108 #define ATTR_INDEX_MASK U(0x3) 109 #define ATTR_INDEX_GET(attr) (((attr) >> 2) & ATTR_INDEX_MASK) 110 111 /* 112 * Flags to override default values used to program system registers while 113 * enabling the MMU. 114 */ 115 #define DISABLE_DCACHE (U(1) << 0) 116 117 /* 118 * This flag marks the translation tables are Non-cacheable for MMU accesses. 119 * If the flag is not specified, by default the tables are cacheable. 120 */ 121 #define XLAT_TABLE_NC (U(1) << 1) 122 123 #endif /* __XLAT_TABLES_DEFS_H__ */ 124