/** @file | |
Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR> | |
This program and the accompanying materials | |
are licensed and made available under the terms and conditions of the BSD License | |
which accompanies this distribution. The full text of the license may be found at | |
http://opensource.org/licenses/bsd-license.php | |
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
**/ | |
#ifndef __ARM_V7_H__ | |
#define __ARM_V7_H__ | |
// Domain Access Control Register | |
#define DOMAIN_ACCESS_CONTROL_MASK(a) (3UL << (2 * (a))) | |
#define DOMAIN_ACCESS_CONTROL_NONE(a) (0UL << (2 * (a))) | |
#define DOMAIN_ACCESS_CONTROL_CLIENT(a) (1UL << (2 * (a))) | |
#define DOMAIN_ACCESS_CONTROL_RESERVED(a) (2UL << (2 * (a))) | |
#define DOMAIN_ACCESS_CONTROL_MANAGER(a) (3UL << (2 * (a))) | |
#define TTBR_NOT_OUTER_SHAREABLE BIT5 | |
#define TTBR_RGN_OUTER_NON_CACHEABLE 0 | |
#define TTBR_RGN_OUTER_WRITE_BACK_ALLOC BIT3 | |
#define TTBR_RGN_OUTER_WRITE_THROUGH BIT4 | |
#define TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC (BIT3|BIT4) | |
#define TTBR_SHAREABLE BIT1 | |
#define TTBR_NON_SHAREABLE 0 | |
#define TTBR_INNER_CACHEABLE BIT0 | |
#define TTBR_NON_INNER_CACHEABLE BIT0 | |
#define TTBR_RGN_INNER_NON_CACHEABLE 0 | |
#define TTBR_RGN_INNER_WRITE_BACK_ALLOC BIT6 | |
#define TTBR_RGN_INNER_WRITE_THROUGH BIT0 | |
#define TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC (BIT0|BIT6) | |
#define TTBR_WRITE_THROUGH_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_RGN_INNER_WRITE_BACK_ALLOC ) | |
#define TTBR_WRITE_BACK_NO_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_NO_ALLOC | TTBR_RGN_INNER_WRITE_BACK_NO_ALLOC ) | |
#define TTBR_NON_CACHEABLE ( TTBR_RGN_OUTER_NON_CACHEABLE | TTBR_RGN_INNER_NON_CACHEABLE ) | |
#define TTBR_WRITE_BACK_ALLOC ( TTBR_RGN_OUTER_WRITE_BACK_ALLOC | TTBR_RGN_INNER_WRITE_BACK_ALLOC ) | |
#define TRANSLATION_TABLE_SECTION_COUNT 4096 | |
#define TRANSLATION_TABLE_SECTION_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT) | |
#define TRANSLATION_TABLE_SECTION_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_SECTION_COUNT) | |
#define TRANSLATION_TABLE_SECTION_ALIGNMENT_MASK (TRANSLATION_TABLE_SECTION_ALIGNMENT - 1) | |
#define TRANSLATION_TABLE_PAGE_COUNT 256 | |
#define TRANSLATION_TABLE_PAGE_SIZE (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT) | |
#define TRANSLATION_TABLE_PAGE_ALIGNMENT (sizeof(UINT32) * TRANSLATION_TABLE_PAGE_COUNT) | |
#define TRANSLATION_TABLE_PAGE_ALIGNMENT_MASK (TRANSLATION_TABLE_PAGE_ALIGNMENT - 1) | |
#define TRANSLATION_TABLE_ENTRY_FOR_VIRTUAL_ADDRESS(table, address) ((UINT32 *)(table) + (((UINTN)(address)) >> 20)) | |
// Translation table descriptor types | |
#define TT_DESCRIPTOR_SECTION_TYPE_MASK ((1UL << 18) | (3UL << 0)) | |
#define TT_DESCRIPTOR_SECTION_TYPE_FAULT (0UL << 0) | |
#define TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE (1UL << 0) | |
#define TT_DESCRIPTOR_SECTION_TYPE_SECTION ((0UL << 18) | (2UL << 0)) | |
#define TT_DESCRIPTOR_SECTION_TYPE_SUPERSECTION ((1UL << 18) | (2UL << 0)) | |
#define TT_DESCRIPTOR_SECTION_TYPE_IS_PAGE_TABLE(Desc) (((Desc) & 3UL) == TT_DESCRIPTOR_SECTION_TYPE_PAGE_TABLE) | |
// Translation table descriptor types | |
#define TT_DESCRIPTOR_PAGE_TYPE_MASK (3UL << 0) | |
#define TT_DESCRIPTOR_PAGE_TYPE_FAULT (0UL << 0) | |
#define TT_DESCRIPTOR_PAGE_TYPE_PAGE (2UL << 0) | |
#define TT_DESCRIPTOR_PAGE_TYPE_PAGE_XN (3UL << 0) | |
#define TT_DESCRIPTOR_PAGE_TYPE_LARGEPAGE (1UL << 0) | |
// Section descriptor definitions | |
#define TT_DESCRIPTOR_SECTION_SIZE (0x00100000) | |
#define TT_DESCRIPTOR_SECTION_NS_MASK (1UL << 19) | |
#define TT_DESCRIPTOR_SECTION_NS_SECURE (0UL << 19) | |
#define TT_DESCRIPTOR_SECTION_NS_NON_SECURE (1UL << 19) | |
#define TT_DESCRIPTOR_SECTION_NG_MASK (1UL << 17) | |
#define TT_DESCRIPTOR_SECTION_NG_GLOBAL (0UL << 17) | |
#define TT_DESCRIPTOR_SECTION_NG_LOCAL (1UL << 17) | |
#define TT_DESCRIPTOR_PAGE_NG_MASK (1UL << 11) | |
#define TT_DESCRIPTOR_PAGE_NG_GLOBAL (0UL << 11) | |
#define TT_DESCRIPTOR_PAGE_NG_LOCAL (1UL << 11) | |
#define TT_DESCRIPTOR_SECTION_S_MASK (1UL << 16) | |
#define TT_DESCRIPTOR_SECTION_S_NOT_SHARED (0UL << 16) | |
#define TT_DESCRIPTOR_SECTION_S_SHARED (1UL << 16) | |
#define TT_DESCRIPTOR_PAGE_S_MASK (1UL << 10) | |
#define TT_DESCRIPTOR_PAGE_S_NOT_SHARED (0UL << 10) | |
#define TT_DESCRIPTOR_PAGE_S_SHARED (1UL << 10) | |
#define TT_DESCRIPTOR_SECTION_AP_MASK ((1UL << 15) | (3UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_NO_NO ((0UL << 15) | (0UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_RW_NO ((0UL << 15) | (1UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_RW_RO ((0UL << 15) | (2UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_RW_RW ((0UL << 15) | (3UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_RO_NO ((1UL << 15) | (1UL << 10)) | |
#define TT_DESCRIPTOR_SECTION_AP_RO_RO ((1UL << 15) | (3UL << 10)) | |
#define TT_DESCRIPTOR_PAGE_AP_MASK ((1UL << 9) | (3UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_NO_NO ((0UL << 9) | (0UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_RW_NO ((0UL << 9) | (1UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_RW_RO ((0UL << 9) | (2UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_RW_RW ((0UL << 9) | (3UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_RO_NO ((1UL << 9) | (1UL << 4)) | |
#define TT_DESCRIPTOR_PAGE_AP_RO_RO ((1UL << 9) | (3UL << 4)) | |
#define TT_DESCRIPTOR_SECTION_XN_MASK (0x1UL << 4) | |
#define TT_DESCRIPTOR_PAGE_XN_MASK (0x1UL << 0) | |
#define TT_DESCRIPTOR_LARGEPAGE_XN_MASK (0x1UL << 15) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK ((3UL << 12) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHEABLE_MASK (1UL << 3) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_MASK ((3UL << 6) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHEABLE_MASK (1UL << 3) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 6) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 6) | (0UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 6) | (1UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 6) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 6) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 6) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_PAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 6) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK ((3UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_STRONGLY_ORDERED ((0UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_SHAREABLE_DEVICE ((0UL << 12) | (0UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC ((0UL << 12) | (1UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_NO_ALLOC ((0UL << 12) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_CACHEABLE ((1UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_WRITE_BACK_ALLOC ((1UL << 12) | (1UL << 3) | (1UL << 2)) | |
#define TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_NON_SHAREABLE_DEVICE ((2UL << 12) | (0UL << 3) | (0UL << 2)) | |
#define TT_DESCRIPTOR_CONVERT_TO_PAGE_AP(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_AP_MASK) >> 6) & TT_DESCRIPTOR_PAGE_AP_MASK) | |
#define TT_DESCRIPTOR_CONVERT_TO_PAGE_NG(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_NG_MASK) >> 6) & TT_DESCRIPTOR_PAGE_NG_MASK) | |
#define TT_DESCRIPTOR_CONVERT_TO_PAGE_S(Desc) ((((Desc) & TT_DESCRIPTOR_SECTION_S_MASK) >> 6) & TT_DESCRIPTOR_PAGE_S_MASK) | |
#define TT_DESCRIPTOR_CONVERT_TO_PAGE_XN(Desc,IsLargePage) ((IsLargePage)? \ | |
((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) >> 4) & TT_DESCRIPTOR_LARGEPAGE_XN_MASK): \ | |
((((Desc) & TT_DESCRIPTOR_SECTION_XN_MASK) << 11) & TT_DESCRIPTOR_PAGE_XN_MASK)) | |
#define TT_DESCRIPTOR_CONVERT_TO_PAGE_CACHE_POLICY(Desc,IsLargePage) (IsLargePage? \ | |
(((Desc) & TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK) & TT_DESCRIPTOR_LARGEPAGE_CACHE_POLICY_MASK): \ | |
(((((Desc) & (0x3 << 12)) >> 6) | (Desc & (0x3 << 2))))) | |
#define TT_DESCRIPTOR_SECTION_DOMAIN_MASK (0x0FUL << 5) | |
#define TT_DESCRIPTOR_SECTION_DOMAIN(a) (((a) & 0x0FUL) << 5) | |
#define TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK (0xFFF00000) | |
#define TT_DESCRIPTOR_SECTION_PAGETABLE_ADDRESS_MASK (0xFFFFFC00) | |
#define TT_DESCRIPTOR_SECTION_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK) | |
#define TT_DESCRIPTOR_SECTION_BASE_SHIFT 20 | |
#define TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK (0xFFFFF000) | |
#define TT_DESCRIPTOR_PAGE_INDEX_MASK (0x000FF000) | |
#define TT_DESCRIPTOR_PAGE_BASE_ADDRESS(a) ((a) & TT_DESCRIPTOR_PAGE_BASE_ADDRESS_MASK) | |
#define TT_DESCRIPTOR_PAGE_BASE_SHIFT 12 | |
#define TT_DESCRIPTOR_SECTION_WRITE_BACK(Secure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \ | |
((Secure) ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \ | |
TT_DESCRIPTOR_SECTION_NG_GLOBAL | \ | |
TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \ | |
TT_DESCRIPTOR_SECTION_DOMAIN(0) | \ | |
TT_DESCRIPTOR_SECTION_AP_RW_RW | \ | |
TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC) | |
#define TT_DESCRIPTOR_SECTION_WRITE_THROUGH(Secure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \ | |
((Secure) ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \ | |
TT_DESCRIPTOR_SECTION_NG_GLOBAL | \ | |
TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \ | |
TT_DESCRIPTOR_SECTION_DOMAIN(0) | \ | |
TT_DESCRIPTOR_SECTION_AP_RW_RW | \ | |
TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC) | |
#define TT_DESCRIPTOR_SECTION_DEVICE(Secure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \ | |
((Secure) ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \ | |
TT_DESCRIPTOR_SECTION_NG_GLOBAL | \ | |
TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \ | |
TT_DESCRIPTOR_SECTION_DOMAIN(0) | \ | |
TT_DESCRIPTOR_SECTION_AP_RW_RW | \ | |
TT_DESCRIPTOR_SECTION_CACHE_POLICY_SHAREABLE_DEVICE) | |
#define TT_DESCRIPTOR_SECTION_UNCACHED(Secure) (TT_DESCRIPTOR_SECTION_TYPE_SECTION | \ | |
((Secure) ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \ | |
TT_DESCRIPTOR_SECTION_NG_GLOBAL | \ | |
TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \ | |
TT_DESCRIPTOR_SECTION_DOMAIN(0) | \ | |
TT_DESCRIPTOR_SECTION_AP_RW_RW | \ | |
TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE) | |
// Cortex A9 feature bit definitions | |
#define A9_FEATURE_PARITY (1<<9) | |
#define A9_FEATURE_AOW (1<<8) | |
#define A9_FEATURE_EXCL (1<<7) | |
#define A9_FEATURE_SMP (1<<6) | |
#define A9_FEATURE_FOZ (1<<3) | |
#define A9_FEATURE_DPREF (1<<2) | |
#define A9_FEATURE_HINT (1<<1) | |
#define A9_FEATURE_FWD (1<<0) | |
// SCU register offsets & masks | |
#define SCU_CONTROL_OFFSET 0x0 | |
#define SCU_CONFIG_OFFSET 0x4 | |
#define SCU_INVALL_OFFSET 0xC | |
#define SCU_FILT_START_OFFSET 0x40 | |
#define SCU_FILT_END_OFFSET 0x44 | |
#define SCU_SACR_OFFSET 0x50 | |
#define SCU_SSACR_OFFSET 0x54 | |
#define SMP_GIC_CPUIF_BASE 0x100 | |
#define SMP_GIC_DIST_BASE 0x1000 | |
// CPACR - Coprocessor Access Control Register defintions | |
#define CPACR_CP_DENIED(cp) 0x00 | |
#define CPACR_CP_PRIV(cp) ((0x1 << ((cp) << 1)) & 0x0FFFFFFF) | |
#define CPACR_CP_FULL(cp) ((0x3 << ((cp) << 1)) & 0x0FFFFFFF) | |
#define CPACR_ASEDIS (1 << 31) | |
#define CPACR_D32DIS (1 << 30) | |
#define CPACR_CP_FULL_ACCESS 0x0FFFFFFF | |
// NSACR - Non-Secure Access Control Register defintions | |
#define NSACR_CP(cp) ((1 << (cp)) & 0x3FFF) | |
#define NSACR_NSD32DIS (1 << 14) | |
#define NSACR_NSASEDIS (1 << 15) | |
#define NSACR_PLE (1 << 16) | |
#define NSACR_TL (1 << 17) | |
#define NSACR_NS_SMP (1 << 18) | |
#define NSACR_RFR (1 << 19) | |
// SCR - Secure Configuration Register defintions | |
#define SCR_NS (1 << 0) | |
#define SCR_IRQ (1 << 1) | |
#define SCR_FIQ (1 << 2) | |
#define SCR_EA (1 << 3) | |
#define SCR_FW (1 << 4) | |
#define SCR_AW (1 << 5) | |
VOID | |
EFIAPI | |
ArmEnableSWPInstruction ( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmWriteNsacr ( | |
IN UINT32 SetWayFormat | |
); | |
VOID | |
EFIAPI | |
ArmWriteScr ( | |
IN UINT32 SetWayFormat | |
); | |
VOID | |
EFIAPI | |
ArmWriteVMBar ( | |
IN UINT32 SetWayFormat | |
); | |
VOID | |
EFIAPI | |
ArmWriteVBar ( | |
IN UINT32 SetWayFormat | |
); | |
UINT32 | |
EFIAPI | |
ArmReadVBar ( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmWriteCPACR ( | |
IN UINT32 SetWayFormat | |
); | |
VOID | |
EFIAPI | |
ArmEnableVFP ( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmCallWFI ( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmInvalidScu ( | |
VOID | |
); | |
UINTN | |
EFIAPI | |
ArmGetScuBaseAddress ( | |
VOID | |
); | |
UINT32 | |
EFIAPI | |
ArmIsScuEnable( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmWriteAuxCr ( | |
IN UINT32 Bit | |
); | |
UINT32 | |
EFIAPI | |
ArmReadAuxCr ( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmSetAuxCrBit ( | |
IN UINT32 Bits | |
); | |
VOID | |
EFIAPI | |
ArmSetupSmpNonSecure ( | |
IN UINTN CoreId | |
); | |
UINTN | |
EFIAPI | |
ArmReadCbar( | |
VOID | |
); | |
VOID | |
EFIAPI | |
ArmInvalidateInstructionAndDataTlb( | |
VOID | |
); | |
UINTN | |
EFIAPI | |
ArmReadMpidr( | |
VOID | |
); | |
#endif // __ARM_V7_H__ |