xref: /rk3399_ARM-atf/lib/xlat_tables/xlat_tables_private.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __XLAT_TABLES_PRIVATE_H__
32 #define __XLAT_TABLES_PRIVATE_H__
33 
34 #include <cassert.h>
35 #include <platform_def.h>
36 #include <utils.h>
37 
38 /*
39  * If the platform hasn't defined a physical and a virtual address space size
40  * default to ADDR_SPACE_SIZE.
41  */
42 #if ERROR_DEPRECATED
43 # ifdef ADDR_SPACE_SIZE
44 #  error "ADDR_SPACE_SIZE is deprecated. Use PLAT_xxx_ADDR_SPACE_SIZE instead."
45 # endif
46 #elif defined(ADDR_SPACE_SIZE)
47 # ifndef PLAT_PHY_ADDR_SPACE_SIZE
48 #  define PLAT_PHY_ADDR_SPACE_SIZE	ADDR_SPACE_SIZE
49 # endif
50 # ifndef PLAT_VIRT_ADDR_SPACE_SIZE
51 #  define PLAT_VIRT_ADDR_SPACE_SIZE	ADDR_SPACE_SIZE
52 # endif
53 #endif
54 
55 /* The virtual and physical address space sizes must be powers of two. */
56 CASSERT(IS_POWER_OF_TWO(PLAT_VIRT_ADDR_SPACE_SIZE),
57 	assert_valid_virt_addr_space_size);
58 CASSERT(IS_POWER_OF_TWO(PLAT_PHY_ADDR_SPACE_SIZE),
59 	assert_valid_phy_addr_space_size);
60 
61 /*
62  * In AArch32 state, the MMU only supports 4KB page granularity, which means
63  * that the first translation table level is either 1 or 2. Both of them are
64  * allowed to have block and table descriptors. See section G4.5.6 of the
65  * ARMv8-A Architecture Reference Manual (DDI 0487A.k) for more information.
66  *
67  * In AArch64 state, the MMU may support 4 KB, 16 KB and 64 KB page
68  * granularity. For 4KB granularity, a level 0 table descriptor doesn't support
69  * block translation. For 16KB, the same thing happens to levels 0 and 1. For
70  * 64KB, same for level 1. See section D4.3.1 of the ARMv8-A Architecture
71  * Reference Manual (DDI 0487A.k) for more information.
72  *
73  * The define below specifies the first table level that allows block
74  * descriptors.
75  */
76 
77 #ifdef AARCH32
78 
79 # define XLAT_BLOCK_LEVEL_MIN 1
80 
81 #else /* if AArch64 */
82 
83 # if PAGE_SIZE == (4*1024) /* 4KB */
84 #  define XLAT_BLOCK_LEVEL_MIN 1
85 # else /* 16KB or 64KB */
86 #  define XLAT_BLOCK_LEVEL_MIN 2
87 # endif
88 
89 #endif /* AARCH32 */
90 
91 void print_mmap(void);
92 void init_xlation_table(uintptr_t base_va, uint64_t *table,
93 			int level, uintptr_t *max_va,
94 			unsigned long long *max_pa);
95 
96 #endif /* __XLAT_TABLES_PRIVATE_H__ */
97