xref: /freebsd/sys/arm64/include/pte.h (revision b9c36cc755002809a7d7c7109e3425fdfca036d2)
1 /*-
2  * Copyright (c) 2014 Andrew Turner
3  * Copyright (c) 2014-2015 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Andrew Turner under
7  * sponsorship from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * 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 AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _MACHINE_PTE_H_
34 #define	_MACHINE_PTE_H_
35 
36 #ifndef LOCORE
37 typedef	uint64_t	pd_entry_t;		/* page directory entry */
38 typedef	uint64_t	pt_entry_t;		/* page table entry */
39 #endif
40 
41 /* Block and Page attributes */
42 /* TODO: Add the upper attributes */
43 #define	ATTR_MASK_H	UINT64_C(0xfff0000000000000)
44 #define	ATTR_MASK_L	UINT64_C(0x0000000000000fff)
45 #define	ATTR_MASK	(ATTR_MASK_H | ATTR_MASK_L)
46 /* Bits 58:55 are reserved for software */
47 #define	ATTR_SW_MANAGED	(1UL << 56)
48 #define	ATTR_SW_WIRED	(1UL << 55)
49 #define	ATTR_nG		(1 << 11)
50 #define	ATTR_AF		(1 << 10)
51 #define	ATTR_SH(x)	((x) << 8)
52 #define	 ATTR_SH_MASK	ATTR_SH(3)
53 #define	 ATTR_SH_NS	0		/* Non-shareable */
54 #define	 ATTR_SH_OS	2		/* Outer-shareable */
55 #define	 ATTR_SH_IS	3		/* Inner-shareable */
56 #define	ATTR_AP_RW_BIT	(1 << 7)
57 #define	ATTR_AP(x)	((x) << 6)
58 #define	 ATTR_AP_MASK	ATTR_AP(3)
59 #define	 ATTR_AP_RW	(0 << 1)
60 #define	 ATTR_AP_RO	(1 << 1)
61 #define	 ATTR_AP_USER	(1 << 0)
62 #define	ATTR_NS		(1 << 5)
63 #define	ATTR_IDX(x)	((x) << 2)
64 #define	ATTR_IDX_MASK	(7 << 2)
65 
66 #define	ATTR_DEFAULT	(ATTR_AF | ATTR_SH(ATTR_SH_IS))
67 
68 #define	ATTR_DESCR_MASK	3
69 
70 /* Level 0 table, 512GiB per entry */
71 #define	L0_SHIFT	39
72 #define	L0_SIZE		(1ul << L0_SHIFT)
73 #define	L0_OFFSET	(L0_SIZE - 1ul)
74 #define	L0_INVAL	0x0 /* An invalid address */
75 	/* 0x1 Level 0 doesn't support block translation */
76 	/* 0x2 also marks an invalid address */
77 #define	L0_TABLE	0x3 /* A next-level table */
78 
79 /* Level 1 table, 1GiB per entry */
80 #define	L1_SHIFT	30
81 #define	L1_SIZE 	(1 << L1_SHIFT)
82 #define	L1_OFFSET 	(L1_SIZE - 1)
83 #define	L1_INVAL	L0_INVAL
84 #define	L1_BLOCK	0x1
85 #define	L1_TABLE	L0_TABLE
86 
87 /* Level 2 table, 2MiB per entry */
88 #define	L2_SHIFT	21
89 #define	L2_SIZE 	(1 << L2_SHIFT)
90 #define	L2_OFFSET 	(L2_SIZE - 1)
91 #define	L2_INVAL	L1_INVAL
92 #define	L2_BLOCK	L1_BLOCK
93 #define	L2_TABLE	L1_TABLE
94 
95 #define	L2_BLOCK_MASK	UINT64_C(0xffffffe00000)
96 
97 /* Level 3 table, 4KiB per entry */
98 #define	L3_SHIFT	12
99 #define	L3_SIZE 	(1 << L3_SHIFT)
100 #define	L3_OFFSET 	(L3_SIZE - 1)
101 #define	L3_SHIFT	12
102 #define	L3_INVAL	0x0
103 	/* 0x1 is reserved */
104 	/* 0x2 also marks an invalid address */
105 #define	L3_PAGE		0x3
106 
107 #define	L0_ENTRIES_SHIFT 9
108 #define	L0_ENTRIES	(1 << L0_ENTRIES_SHIFT)
109 #define	L0_ADDR_MASK	(L0_ENTRIES - 1)
110 
111 #define	Ln_ENTRIES_SHIFT 9
112 #define	Ln_ENTRIES	(1 << Ln_ENTRIES_SHIFT)
113 #define	Ln_ADDR_MASK	(Ln_ENTRIES - 1)
114 #define	Ln_TABLE_MASK	((1 << 12) - 1)
115 
116 #endif /* !_MACHINE_PTE_H_ */
117 
118 /* End of pte.h */
119