ArmV7Mmu.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. /** @file
  2. *
  3. * Copyright (c) 2011-2013, ARM Limited. All rights reserved.
  4. *
  5. * This program and the accompanying materials
  6. * are licensed and made available under the terms and conditions of the BSD License
  7. * which accompanies this distribution. The full text of the license may be found at
  8. * http://opensource.org/licenses/bsd-license.php
  9. *
  10. * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11. * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12. *
  13. **/
  14. #ifndef __ARMV7_MMU_H_
  15. #define __ARMV7_MMU_H_
  16. #define TTBR_NOT_OUTER_SHAREABLE BIT5
  17. #define TTBR_RGN_OUTER_NON_CACHEABLE 0
  18. #define TTBR_RGN_OUTER_WRITE_BACK_ALLOC BIT3
  19. #define TTBR_RGN_OUTER_WRITE_THROUGH BIT4
  20. #define TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC (BIT3|BIT4)
  21. #define TTBR_SHAREABLE BIT1
  22. #define TTBR_NON_SHAREABLE 0
  23. #define TTBR_INNER_CACHEABLE BIT0
  24. #define TTBR_NON_INNER_CACHEABLE BIT0
  25. #define TTBR_RGN_INNER_NON_CACHEABLE 0
  26. #define TTBR_RGN_INNER_WRITE_BACK_ALLOC BIT6
  27. #define TTBR_RGN_INNER_WRITE_THROUGH BIT0
  28. #define TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC (BIT0|BIT6)
  29. #define TTBR_WRITE_THROUGH_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_RGN_INNER_WRITE_BACK_ALLOC )
  30. #define TTBR_WRITE_BACK_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC | TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC )
  31. #define TTBR_NON_CACHEABLE ( TTBR_RGN_OUTER_NON_CACHEABLE | TTBR_RGN_INNER_NON_CACHEABLE )
  32. #define TTBR_WRITE_BACK_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_RGN_INNER_WRITE_BACK_ALLOC )
  33. #define TRANSLATION_TABLE_SECTION_COUNT 4096
  34. #define TRANSLATION_TABLE_SECTION_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT)
  35. #define TRANSLATION_TABLE_SECTION_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT)
  36. #define TRANSLATION_TABLE_SECTION_ALIGNMENT_MASK (TRANSLATION_TABLE_SECTION_ALIGNMENT - 1)
  37. #define TRANSLATION_TABLE_PAGE_COUNT 256
  38. #define TRANSLATION_TABLE_PAGE_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT)
  39. #define TRANSLATION_TABLE_PAGE_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT)
  40. #define TRANSLATION_TABLE_PAGE_ALIGNMENT_MASK (TRANSLATION_TABLE_PAGE_ALIGNMENT - 1)
  41. #define TRANSLATION_TABLE_ENTRY_FOR_VIRTUAL_ADDRESS(table, address) ((UINT32 *)(table) + (((UINTN)(address)) >> 20))
  42. // Translation table descriptor types
  43. #define TT_DESCRIPTOR_SECTION_TYPE_MASK ((1UL << 18) | (3UL << 0))
  44. #define TT_DESCRIPTOR_SECTION_TYPE_FAULT (0UL << 0)
  45. #define TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE (1UL << 0)
  46. #define TT_DESCRIPTOR_SECTION_TYPE_SECTION ((0UL << 18) | (2UL << 0))
  47. #define TT_DESCRIPTOR_SECTION_TYPE_SUPERSECTION ((1UL << 18) | (2UL << 0))
  48. #define TT_DESCRIPTOR_SECTION_TYPE_IS_PAGE_TABLE(Desc) (((Desc) & 3UL) == TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE)
  49. // Translation table descriptor types
  50. #define TT_DESCRIPTOR_PAGE_TYPE_MASK (3UL << 0)
  51. #define TT_DESCRIPTOR_PAGE_TYPE_FAULT (0UL << 0)
  52. #define TT_DESCRIPTOR_PAGE_TYPE_PAGE (2UL << 0)
  53. #define TT_DESCRIPTOR_PAGE_TYPE_PAGE_XN (3UL << 0)
  54. #define TT_DESCRIPTOR_PAGE_TYPE_LARGEPAGE (1UL << 0)
  55. // Section descriptor definitions
  56. #define TT_DESCRIPTOR_SECTION_SIZE (0x00100000)
  57. #define TT_DESCRIPTOR_SECTION_NS_MASK (1UL << 19)
  58. #define TT_DESCRIPTOR_SECTION_NS (1UL << 19)
  59. #define TT_DESCRIPTOR_SECTION_NG_MASK (1UL << 17)
  60. #define TT_DESCRIPTOR_SECTION_NG_GLOBAL (0UL << 17)
  61. #define TT_DESCRIPTOR_SECTION_NG_LOCAL (1UL << 17)
  62. #define TT_DESCRIPTOR_PAGE_NG_MASK (1UL << 11)
  63. #define TT_DESCRIPTOR_PAGE_NG_GLOBAL (0UL << 11)
  64. #define TT_DESCRIPTOR_PAGE_NG_LOCAL (1UL << 11)
  65. #define TT_DESCRIPTOR_SECTION_S_MASK (1UL << 16)
  66. #define TT_DESCRIPTOR_SECTION_S_NOT_SHARED (0UL << 16)
  67. #define TT_DESCRIPTOR_SECTION_S_SHARED (1UL << 16)
  68. #define TT_DESCRIPTOR_PAGE_S_MASK (1UL << 10)
  69. #define TT_DESCRIPTOR_PAGE_S_NOT_SHARED (0UL << 10)
  70. #define TT_DESCRIPTOR_PAGE_S_SHARED (1UL << 10)
  71. #define TT_DESCRIPTOR_SECTION_AP_MASK ((1UL << 15) | (3UL << 10))
  72. #define TT_DESCRIPTOR_SECTION_AP_NO_NO ((0UL << 15) | (0UL << 10))
  73. #define TT_DESCRIPTOR_SECTION_AP_RW_NO ((0UL << 15) | (1UL << 10))
  74. #define TT_DESCRIPTOR_SECTION_AP_RW_RO ((0UL << 15) | (2UL << 10))
  75. #define TT_DESCRIPTOR_SECTION_AP_RW_RW ((0UL << 15) | (3UL << 10))
  76. #define TT_DESCRIPTOR_SECTION_AP_RO_NO ((1UL << 15) | (1UL << 10))
  77. #define TT_DESCRIPTOR_SECTION_AP_RO_RO ((1UL << 15) | (3UL << 10))
  78. #define TT_DESCRIPTOR_PAGE_AP_MASK ((1UL << 9) | (3UL << 4))
  79. #define TT_DESCRIPTOR_PAGE_AP_NO_NO ((0UL << 9) | (0UL << 4))
  80. #define TT_DESCRIPTOR_PAGE_AP_RW_NO ((0UL << 9) | (1UL << 4))
  81. #define TT_DESCRIPTOR_PAGE_AP_RW_RO ((0UL << 9) | (2UL << 4))
  82. #define TT_DESCRIPTOR_PAGE_AP_RW_RW ((0UL << 9) | (3UL << 4))
  83. #define TT_DESCRIPTOR_PAGE_AP_RO_NO ((1UL << 9) | (1UL << 4))
  84. #define TT_DESCRIPTOR_PAGE_AP_RO_RO ((1UL << 9) | (3UL << 4))
  85. #define TT_DESCRIPTOR_SECTION_XN_MASK (0x1UL << 4)
  86. #define TT_DESCRIPTOR_PAGE_XN_MASK (0x1UL << 0)
  87. #define TT_DESCRIPTOR_LARGEPAGE_XN_MASK (0x1UL << 15)
  88. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK ((3UL << 12) | (1UL << 3) | (1UL << 2))
  89. #define TT_DESCRIPTOR_SECTION_CACHEABLE_MASK (1UL << 3)
  90. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2))
  91. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2))
  92. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2))
  93. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2))
  94. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2))
  95. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2))
  96. #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2))
  97. #define TT_DESCRIPTOR_PAGE_SIZE (0x00001000)
  98. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_MASK ((3UL << 6) | (1UL << 3) | (1UL << 2))
  99. #define TT_DESCRIPTOR_PAGE_CACHEABLE_MASK (1UL << 3)
  100. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 6) | (0UL << 3) | (0UL << 2))
  101. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 6) | (0UL << 3) | (1UL << 2))
  102. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 6) | (1UL << 3) | (0UL << 2))
  103. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 6) | (1UL << 3) | (1UL << 2))
  104. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 6) | (0UL << 3) | (0UL << 2))
  105. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 6) | (1UL << 3) | (1UL << 2))
  106. #define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 6) | (0UL << 3) | (0UL << 2))
  107. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK ((3UL << 12) | (1UL << 3) | (1UL << 2))
  108. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2))
  109. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2))
  110. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2))
  111. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2))
  112. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2))
  113. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2))
  114. #define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2))
  115. #define TT_DESCRIPTOR_CONVERT_TO_PAGE_AP(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_AP_MASK) >> 6) & TT_DESCRIPTOR_PAGE_AP_MASK)
  116. #define TT_DESCRIPTOR_CONVERT_TO_PAGE_NG(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_NG_MASK) >> 6) & TT_DESCRIPTOR_PAGE_NG_MASK)
  117. #define TT_DESCRIPTOR_CONVERT_TO_PAGE_S(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_S_MASK) >> 6) & TT_DESCRIPTOR_PAGE_S_MASK)
  118. #define TT_DESCRIPTOR_CONVERT_TO_PAGE_XN(Desc,IsLargePage) ((IsLargePage)? \
  119. ((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) << 11) & TT_DESCRIPTOR_LARGEPAGE_XN_MASK): \
  120. ((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) >> 4) & TT_DESCRIPTOR_PAGE_XN_MASK))
  121. #define TT_DESCRIPTOR_CONVERT_TO_PAGE_CACHE_POLICY(Desc,IsLargePage) (IsLargePage? \
  122. (((Desc) & TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK) & TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK): \
  123. (((((Desc) & (0x3 << 12)) >> 6) | (Desc & (0x3 << 2)))))
  124. #define TT_DESCRIPTOR_CONVERT_TO_SECTION_AP(Desc) ((((Desc) & TT_DESCRIPTOR_PAGE_AP_MASK) << 6) & TT_DESCRIPTOR_SECTION_AP_MASK)
  125. #define TT_DESCRIPTOR_CONVERT_TO_SECTION_CACHE_POLICY(Desc,IsLargePage) (IsLargePage? \
  126. (((Desc) & TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK) & TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK): \
  127. (((((Desc) & (0x3 << 6)) << 6) | (Desc & (0x3 << 2)))))
  128. #define TT_DESCRIPTOR_SECTION_ATTRIBUTE_MASK (TT_DESCRIPTOR_SECTION_NS_MASK | TT_DESCRIPTOR_SECTION_NG_MASK | \
  129. TT_DESCRIPTOR_SECTION_S_MASK | TT_DESCRIPTOR_SECTION_AP_MASK | \
  130. TT_DESCRIPTOR_SECTION_XN_MASK | TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK)
  131. #define TT_DESCRIPTOR_PAGE_ATTRIBUTE_MASK (TT_DESCRIPTOR_PAGE_NG_MASK | TT_DESCRIPTOR_PAGE_S_MASK | \
  132. TT_DESCRIPTOR_PAGE_AP_MASK | TT_DESCRIPTOR_PAGE_XN_MASK | \
  133. TT_DESCRIPTOR_PAGE_CACHE_POLICY_MASK)
  134. #define TT_DESCRIPTOR_SECTION_DOMAIN_MASK (0x0FUL << 5)
  135. #define TT_DESCRIPTOR_SECTION_DOMAIN(a) (((a) & 0x0FUL) << 5)
  136. #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK (0xFFF00000)
  137. #define TT_DESCRIPTOR_SECTION_PAGETABLE_ADDRESS_MASK (0xFFFFFC00)
  138. #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK)
  139. #define TT_DESCRIPTOR_SECTION_BASE_SHIFT 20
  140. #define TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK (0xFFFFF000)
  141. #define TT_DESCRIPTOR_PAGE_INDEX_MASK (0x000FF000)
  142. #define TT_DESCRIPTOR_PAGE_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK)
  143. #define TT_DESCRIPTOR_PAGE_BASE_SHIFT 12
  144. #define TT_DESCRIPTOR_SECTION_WRITE_BACK(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
  145. ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
  146. TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
  147. TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
  148. TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
  149. TT_DESCRIPTOR_SECTION_AP_RW_RW | \
  150. TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC)
  151. #define TT_DESCRIPTOR_SECTION_WRITE_THROUGH(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
  152. ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
  153. TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
  154. TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
  155. TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
  156. TT_DESCRIPTOR_SECTION_AP_RW_RW | \
  157. TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)
  158. #define TT_DESCRIPTOR_SECTION_DEVICE(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
  159. ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
  160. TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
  161. TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
  162. TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
  163. TT_DESCRIPTOR_SECTION_AP_RW_RW | \
  164. TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE)
  165. #define TT_DESCRIPTOR_SECTION_UNCACHED(NonSecure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \
  166. ((NonSecure) ? TT_DESCRIPTOR_SECTION_NS : 0) | \
  167. TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
  168. TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
  169. TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
  170. TT_DESCRIPTOR_SECTION_AP_RW_RW | \
  171. TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE)
  172. #define TT_DESCRIPTOR_PAGE_WRITE_BACK (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
  173. TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
  174. TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
  175. TT_DESCRIPTOR_PAGE_AP_RW_RW | \
  176. TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_ALLOC)
  177. #define TT_DESCRIPTOR_PAGE_WRITE_THROUGH (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
  178. TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
  179. TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
  180. TT_DESCRIPTOR_PAGE_AP_RW_RW | \
  181. TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)
  182. #define TT_DESCRIPTOR_PAGE_DEVICE (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
  183. TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
  184. TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
  185. TT_DESCRIPTOR_PAGE_AP_RW_RW | \
  186. TT_DESCRIPTOR_PAGE_CACHE_POLICY_SHAREABLE_DEVICE)
  187. #define TT_DESCRIPTOR_PAGE_UNCACHED (TT_DESCRIPTOR_PAGE_TYPE_PAGE | \
  188. TT_DESCRIPTOR_PAGE_NG_GLOBAL | \
  189. TT_DESCRIPTOR_PAGE_S_NOT_SHARED | \
  190. TT_DESCRIPTOR_PAGE_AP_RW_RW | \
  191. TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_CACHEABLE)
  192. UINT32
  193. ConvertSectionAttributesToPageAttributes (
  194. IN UINT32 SectionAttributes,
  195. IN BOOLEAN IsLargePage
  196. );
  197. #endif