Sync up ArmPkg with patch from mailing list. Changed name of BdsLib.h to BdsUnixLib...
[mirror_edk2.git] / ArmPkg / Include / Chipset / ARM1176JZ-S.h
CommitLineData
2ef2b01e
A
1/** @file\r
2\r
d6ebcab7 3 Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
2ef2b01e 4\r
d6ebcab7 5 This program and the accompanying materials\r
2ef2b01e
A
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef __ARM1176JZ_S_H__\r
16#define __ARM1176JZ_S_H__\r
17\r
18// Domain Access Control Register\r
19#define DOMAIN_ACCESS_CONTROL_MASK(a) (3UL << (2 * (a)))\r
20#define DOMAIN_ACCESS_CONTROL_NONE(a) (0UL << (2 * (a)))\r
21#define DOMAIN_ACCESS_CONTROL_CLIENT(a) (1UL << (2 * (a)))\r
22#define DOMAIN_ACCESS_CONTROL_RESERVED(a) (2UL << (2 * (a)))\r
23#define DOMAIN_ACCESS_CONTROL_MANAGER(a) (3UL << (2 * (a)))\r
24\r
25#define TRANSLATION_TABLE_SIZE (16 * 1024)\r
26#define TRANSLATION_TABLE_ALIGNMENT (16 * 1024)\r
27#define TRANSLATION_TABLE_ALIGNMENT_MASK (TRANSLATION_TABLE_ALIGNMENT - 1)\r
28\r
29#define TRANSLATION_TABLE_ENTRY_FOR_VIRTUAL_ADDRESS(table, address) ((UINT32 *)(table) + (((UINTN)(address)) >> 20))\r
30\r
31// Translation table descriptor types\r
32#define TT_DESCRIPTOR_TYPE_MASK ((1UL << 18) | (3UL << 0))\r
33#define TT_DESCRIPTOR_TYPE_PAGE_TABLE ((0UL << 18) | (1UL << 0))\r
34#define TT_DESCRIPTOR_TYPE_SECTION ((0UL << 18) | (2UL << 0))\r
35#define TT_DESCRIPTOR_TYPE_SUPERSECTION ((1UL << 18) | (2UL << 0))\r
36\r
37// Section descriptor definitions\r
38#define TT_DESCRIPTOR_SECTION_SIZE (0x00100000)\r
39\r
40#define TT_DESCRIPTOR_SECTION_NS_MASK (1UL << 19)\r
41#define TT_DESCRIPTOR_SECTION_NS_SECURE (0UL << 19)\r
42#define TT_DESCRIPTOR_SECTION_NS_NON_SECURE (1UL << 19)\r
43\r
44#define TT_DESCRIPTOR_SECTION_NG_MASK (1UL << 17)\r
45#define TT_DESCRIPTOR_SECTION_NG_GLOBAL (0UL << 17)\r
46#define TT_DESCRIPTOR_SECTION_NG_LOCAL (1UL << 17)\r
47\r
48#define TT_DESCRIPTOR_SECTION_S_MASK (1UL << 16)\r
49#define TT_DESCRIPTOR_SECTION_S_NOT_SHARED (0UL << 16)\r
50#define TT_DESCRIPTOR_SECTION_S_SHARED (1UL << 16)\r
51\r
52#define TT_DESCRIPTOR_SECTION_AP_MASK ((1UL << 15) | (3UL << 10))\r
53#define TT_DESCRIPTOR_SECTION_AP_NO_NO ((0UL << 15) | (0UL << 10))\r
54#define TT_DESCRIPTOR_SECTION_AP_RW_NO ((0UL << 15) | (1UL << 10))\r
55#define TT_DESCRIPTOR_SECTION_AP_RW_RO ((0UL << 15) | (2UL << 10))\r
56#define TT_DESCRIPTOR_SECTION_AP_RW_RW ((0UL << 15) | (3UL << 10))\r
57#define TT_DESCRIPTOR_SECTION_AP_RO_NO ((1UL << 15) | (1UL << 10))\r
58#define TT_DESCRIPTOR_SECTION_AP_RO_RO ((1UL << 15) | (3UL << 10))\r
59\r
60#define TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE (0UL)\r
61#define TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE (1UL)\r
62#define TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE (2UL)\r
63#define TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE (3UL)\r
64\r
65#define TT_DESCRIPTOR_OUTER_CACHE_POLICY_MASK ((1UL << 14) | (3UL << 12))\r
66#define TT_DESCRIPTOR_OUTER_CACHE_POLICY_NON_CACHEABLE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE << 12))\r
67#define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE << 12))\r
68#define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE << 12))\r
69#define TT_DESCRIPTOR_OUTER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE ((1UL << 14) | (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE << 12))\r
70\r
71#define TT_DESCRIPTOR_INNER_CACHE_POLICY_MASK (3UL << 2)\r
72#define TT_DESCRIPTOR_INNER_CACHE_POLICY_NON_CACHEABLE (TT_DESCRIPTOR_CACHE_POLICY_NON_CACHEABLE << 2)\r
73#define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_ALLOCATE << 2)\r
74#define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_THROUGH_NO_ALLOCATE << 2)\r
75#define TT_DESCRIPTOR_INNER_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE (TT_DESCRIPTOR_CACHE_POLICY_WRITE_BACK_NO_ALLOCATE << 2)\r
76\r
77#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_MASK (TT_DESCRIPTOR_OUTER_CACHE_POLICY_MASK | TT_DESCRIPTOR_INNER_CACHE_POLICY_MASK)\r
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)\r
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)\r
80#define TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE (TT_DESCRIPTOR_OUTER_CACHE_POLICY_NON_CACHEABLE | TT_DESCRIPTOR_INNER_CACHE_POLICY_NON_CACHEABLE)\r
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)\r
82\r
83#define TT_DESCRIPTOR_SECTION_DOMAIN_MASK (0x0FUL << 5)\r
84#define TT_DESCRIPTOR_SECTION_DOMAIN(a) (((a) & 0x0FUL) << 5)\r
85\r
86#define TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK (0xFFF00000)\r
87#define TT_DESCRIPTOR_SECTION_BASE_ADDRESS(a) (a & TT_DESCRIPTOR_SECTION_BASE_ADDRESS_MASK)\r
88\r
1bfda055 89#define TT_DESCRIPTOR_SECTION_WRITE_BACK(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \\r
90 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \\r
2ef2b01e
A
91 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \\r
92 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \\r
93 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \\r
94 TT_DESCRIPTOR_SECTION_AP_RW_RW | \\r
95 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_BACK_ALLOC)\r
1bfda055 96#define TT_DESCRIPTOR_SECTION_WRITE_THROUGH(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \\r
97 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \\r
2ef2b01e
A
98 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \\r
99 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \\r
100 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \\r
101 TT_DESCRIPTOR_SECTION_AP_RW_RW | \\r
102 TT_DESCRIPTOR_SECTION_CACHE_POLICY_WRITE_THROUGH_NO_ALLOC)\r
1bfda055 103#define TT_DESCRIPTOR_SECTION_UNCACHED(Secure) (TT_DESCRIPTOR_TYPE_SECTION | \\r
104 (Secure ? TT_DESCRIPTOR_SECTION_NS_SECURE : TT_DESCRIPTOR_SECTION_NS_NON_SECURE ) | \\r
2ef2b01e
A
105 TT_DESCRIPTOR_SECTION_NG_GLOBAL | \\r
106 TT_DESCRIPTOR_SECTION_S_NOT_SHARED | \\r
107 TT_DESCRIPTOR_SECTION_DOMAIN(0) | \\r
108 TT_DESCRIPTOR_SECTION_AP_RW_RW | \\r
109 TT_DESCRIPTOR_SECTION_CACHE_POLICY_NON_CACHEABLE)\r
110\r
111#endif // __ARM1176JZ_S_H__\r