Sync up ArmPkg with patch from mailing list. Changed name of BdsLib.h to BdsUnixLib...
[mirror_edk2.git] / ArmPkg / Include / Chipset / ARM1176JZ-S.h
1 /** @file
2
3 Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
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
15 #ifndef __ARM1176JZ_S_H__
16 #define __ARM1176JZ_S_H__
17
18 // Domain Access Control Register
19 #define DOMAIN_ACCESS_CONTROL_MASK(a) (3UL << (2 * (a)))
20 #define DOMAIN_ACCESS_CONTROL_NONE(a) (0UL << (2 * (a)))
21 #define DOMAIN_ACCESS_CONTROL_CLIENT(a) (1UL << (2 * (a)))
22 #define DOMAIN_ACCESS_CONTROL_RESERVED(a) (2UL << (2 * (a)))
23 #define DOMAIN_ACCESS_CONTROL_MANAGER(a) (3UL << (2 * (a)))
24
25 #define TRANSLATION_TABLE_SIZE (16 * 1024)
26 #define TRANSLATION_TABLE_ALIGNMENT (16 * 1024)
27 #define TRANSLATION_TABLE_ALIGNMENT_MASK (TRANSLATION_TABLE_ALIGNMENT - 1)
28
29 #define TRANSLATION_TABLE_ENTRY_FOR_VIRTUAL_ADDRESS(table, address) ((UINT32 *)(table) + (((UINTN)(address)) >> 20))
30
31 // Translation table descriptor types
32 #define TT_DESCRIPTOR_TYPE_MASK ((1UL << 18) | (3UL << 0))
33 #define TT_DESCRIPTOR_TYPE_PAGE_TABLE ((0UL << 18) | (1UL << 0))
34 #define TT_DESCRIPTOR_TYPE_SECTION ((0UL << 18) | (2UL << 0))
35 #define TT_DESCRIPTOR_TYPE_SUPERSECTION ((1UL << 18) | (2UL << 0))
36
37 // Section descriptor definitions
38 #define TT_DESCRIPTOR_SECTION_SIZE (0x00100000)
39
40 #define TT_DESCRIPTOR_SECTION_NS_MASK (1UL << 19)
41 #define TT_DESCRIPTOR_SECTION_NS_SECURE (0UL << 19)
42 #define TT_DESCRIPTOR_SECTION_NS_NON_SECURE (1UL << 19)
43
44 #define TT_DESCRIPTOR_SECTION_NG_MASK (1UL << 17)
45 #define TT_DESCRIPTOR_SECTION_NG_GLOBAL (0UL << 17)
46 #define TT_DESCRIPTOR_SECTION_NG_LOCAL (1UL << 17)
47
48 #define TT_DESCRIPTOR_SECTION_S_MASK (1UL << 16)
49 #define TT_DESCRIPTOR_SECTION_S_NOT_SHARED (0UL << 16)
50 #define TT_DESCRIPTOR_SECTION_S_SHARED (1UL << 16)
51
52 #define TT_DESCRIPTOR_SECTION_AP_MASK ((1UL << 15) | (3UL << 10))
53 #define TT_DESCRIPTOR_SECTION_AP_NO_NO ((0UL << 15) | (0UL << 10))
54 #define TT_DESCRIPTOR_SECTION_AP_RW_NO ((0UL << 15) | (1UL << 10))
55 #define TT_DESCRIPTOR_SECTION_AP_RW_RO ((0UL << 15) | (2UL << 10))
56 #define TT_DESCRIPTOR_SECTION_AP_RW_RW ((0UL << 15) | (3UL << 10))
57 #define TT_DESCRIPTOR_SECTION_AP_RO_NO ((1UL << 15) | (1UL << 10))
58 #define TT_DESCRIPTOR_SECTION_AP_RO_RO ((1UL << 15) | (3UL << 10))
59
60 #define TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE (0UL)
61 #define TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE (1UL)
62 #define TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE (2UL)
63 #define TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE (3UL)
64
65 #define TT_DESCRIPTOR_OUTER_CACHE_POLICY_MASK ((1UL << 14) | (3UL << 12))
66 #define TT_DESCRIPTOR_OUTER_CACHE_POLICY_NON_CACHEABLE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE << 12))
67 #define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE << 12))
68 #define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE << 12))
69 #define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE << 12))
70
71 #define TT_DESCRIPTOR_INNER_CACHE_POLICY_MASK (3UL << 2)
72 #define TT_DESCRIPTOR_INNER_CACHE_POLICY_NON_CACHEABLE (TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE << 2)
73 #define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE << 2)
74 #define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE << 2)
75 #define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE << 2)
76
77 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK (TT_DESCRIPTOR_OUTER_CACHE_POLICY_MASK | TT_DESCRIPTOR_INNER_CACHE_POLICY_MASK)
78 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC (TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE | TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE)
79 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_NO_ALLOC (TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE | TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE)
80 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE (TT_DESCRIPTOR_OUTER_CACHE_POLICY_NON_CACHEABLE | TT_DESCRIPTOR_INNER_CACHE_POLICY_NON_CACHEABLE)
81 #define TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC (TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_ALLOCATE | TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_ALLOCATE)
82
83 #define TT_DESCRIPTOR_SECTION_DOMAIN_MASK (0x0FUL << 5)
84 #define TT_DESCRIPTOR_SECTION_DOMAIN(a) (((a) & 0x0FUL) << 5)
85
86 #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK (0xFFF00000)
87 #define TT_DESCRIPTOR_SECTION_BASE_ADDRESS(a) (a & TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK)
88
89 #define TT_DESCRIPTOR_SECTION_WRITE_BACK(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \
90 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \
91 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
92 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
93 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
94 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
95 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC)
96 #define TT_DESCRIPTOR_SECTION_WRITE_THROUGH(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \
97 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \
98 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
99 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
100 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
101 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
102 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)
103 #define TT_DESCRIPTOR_SECTION_UNCACHED(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \
104 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \
105 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \
106 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \
107 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \
108 TT_DESCRIPTOR_SECTION_AP_RW_RW | \
109 TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE)
110
111 #endif // __ARM1176JZ_S_H__