xref: /freebsd/sys/powerpc/include/pte.h (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
1 /*-
2  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
3  * Copyright (C) 1995, 1996 TooLs GmbH.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by TooLs GmbH.
17  * 4. The name of TooLs GmbH may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  *	$NetBSD: pte.h,v 1.2 1998/08/31 14:43:40 tsubai Exp $
32  * $FreeBSD$
33  */
34 
35 #ifndef	_MACHINE_PTE_H_
36 #define	_MACHINE_PTE_H_
37 
38 #if defined(AIM)
39 
40 /*
41  * Page Table Entries
42  */
43 #ifndef	LOCORE
44 
45 /* 32-bit PTE */
46 struct pte {
47 	u_int32_t pte_hi;
48 	u_int32_t pte_lo;
49 };
50 
51 struct pteg {
52 	struct	pte pt[8];
53 };
54 
55 /* 64-bit (long) PTE */
56 struct lpte {
57 	u_int64_t pte_hi;
58 	u_int64_t pte_lo;
59 };
60 
61 struct lpteg {
62 	struct lpte pt[8];
63 };
64 
65 #endif	/* LOCORE */
66 
67 /* 32-bit PTE definitions */
68 
69 /* High word: */
70 #define	PTE_VALID	0x80000000
71 #define	PTE_VSID_SHFT	7
72 #define	PTE_HID		0x00000040
73 #define	PTE_API		0x0000003f
74 /* Low word: */
75 #define	PTE_RPGN	0xfffff000
76 #define	PTE_REF		0x00000100
77 #define	PTE_CHG		0x00000080
78 #define	PTE_WIMG	0x00000078
79 #define	PTE_W		0x00000040
80 #define	PTE_I		0x00000020
81 #define	PTE_M		0x00000010
82 #define	PTE_G		0x00000008
83 #define	PTE_PP		0x00000003
84 #define	PTE_SO		0x00000000	/* Super. Only       (U: XX, S: RW) */
85 #define PTE_SW		0x00000001	/* Super. Write-Only (U: RO, S: RW) */
86 #define	PTE_BW		0x00000002	/* Supervisor        (U: RW, S: RW) */
87 #define	PTE_BR		0x00000003	/* Both Read Only    (U: RO, S: RO) */
88 #define	PTE_RW		PTE_BW
89 #define	PTE_RO		PTE_BR
90 
91 #define	PTE_EXEC	0x00000200	/* pseudo bit in attrs; page is exec */
92 
93 /* 64-bit PTE definitions */
94 
95 /* High quadword: */
96 #define LPTE_VSID_SHIFT		12
97 #define LPTE_API		0x0000000000000F80ULL
98 #define LPTE_WIRED		0x0000000000000010ULL
99 #define LPTE_LOCKED		0x0000000000000008ULL
100 #define LPTE_BIG		0x0000000000000004ULL	/* 4kb/16Mb page */
101 #define LPTE_HID		0x0000000000000002ULL
102 #define LPTE_VALID		0x0000000000000001ULL
103 
104 /* Low quadword: */
105 #define EXTEND_PTE(x)	UINT64_C(x)	/* make constants 64-bit */
106 #define	LPTE_RPGN	0xfffffffffffff000ULL
107 #define	LPTE_REF	EXTEND_PTE( PTE_REF )
108 #define	LPTE_CHG	EXTEND_PTE( PTE_CHG )
109 #define	LPTE_WIMG	EXTEND_PTE( PTE_WIMG )
110 #define	LPTE_W		EXTEND_PTE( PTE_W )
111 #define	LPTE_I		EXTEND_PTE( PTE_I )
112 #define	LPTE_M		EXTEND_PTE( PTE_M )
113 #define	LPTE_G		EXTEND_PTE( PTE_G )
114 #define	LPTE_NOEXEC	0x0000000000000004ULL
115 #define	LPTE_PP		EXTEND_PTE( PTE_PP )
116 
117 #define	LPTE_SO		EXTEND_PTE( PTE_SO )	/* Super. Only */
118 #define	LPTE_SW		EXTEND_PTE( PTE_SW )	/* Super. Write-Only */
119 #define	LPTE_BW		EXTEND_PTE( PTE_BW )	/* Supervisor */
120 #define	LPTE_BR		EXTEND_PTE( PTE_BR )	/* Both Read Only */
121 #define	LPTE_RW		LPTE_BW
122 #define	LPTE_RO		LPTE_BR
123 
124 #ifndef	LOCORE
125 typedef	struct pte pte_t;
126 typedef	struct lpte lpte_t;
127 #endif	/* LOCORE */
128 
129 /*
130  * Extract bits from address
131  */
132 #define	ADDR_SR_SHFT	28
133 #define	ADDR_PIDX	0x0ffff000UL
134 #define	ADDR_PIDX_SHFT	12
135 #define	ADDR_API_SHFT	22
136 #define	ADDR_API_SHFT64	16
137 #define	ADDR_POFF	0x00000fffUL
138 
139 /*
140  * Bits in DSISR:
141  */
142 #define	DSISR_DIRECT	0x80000000
143 #define	DSISR_NOTFOUND	0x40000000
144 #define	DSISR_PROTECT	0x08000000
145 #define	DSISR_INVRX	0x04000000
146 #define	DSISR_STORE	0x02000000
147 #define	DSISR_DABR	0x00400000
148 #define	DSISR_SEGMENT	0x00200000
149 #define	DSISR_EAR	0x00100000
150 
151 /*
152  * Bits in SRR1 on ISI:
153  */
154 #define	ISSRR1_NOTFOUND	0x40000000
155 #define	ISSRR1_DIRECT	0x10000000
156 #define	ISSRR1_PROTECT	0x08000000
157 #define	ISSRR1_SEGMENT	0x00200000
158 
159 #ifdef	_KERNEL
160 #ifndef	LOCORE
161 extern u_int dsisr(void);
162 #endif	/* _KERNEL */
163 #endif	/* LOCORE */
164 
165 #else
166 
167 #include <machine/tlb.h>
168 
169 /*
170  * 1st level - page table directory (pdir)
171  *
172  * pdir consists of 1024 entries, each being a pointer to
173  * second level entity, i.e. the actual page table (ptbl).
174  */
175 #define PDIR_SHIFT	22
176 #define PDIR_SIZE	(1 << PDIR_SHIFT)	/* va range mapped by pdir */
177 #define PDIR_MASK	(~(PDIR_SIZE - 1))
178 #define PDIR_NENTRIES	1024			/* number of page tables in pdir */
179 
180 /* Returns pdir entry number for given va */
181 #define PDIR_IDX(va)	((va) >> PDIR_SHIFT)
182 
183 #define PDIR_ENTRY_SHIFT 2	/* entry size is 2^2 = 4 bytes */
184 
185 /*
186  * 2nd level - page table (ptbl)
187  *
188  * Page table covers 1024 page table entries. Page
189  * table entry (pte) is 32 bit wide and defines mapping
190  * for a single page.
191  */
192 #define PTBL_SHIFT	PAGE_SHIFT
193 #define PTBL_SIZE	PAGE_SIZE		/* va range mapped by ptbl entry */
194 #define PTBL_MASK	((PDIR_SIZE - 1) & ~((1 << PAGE_SHIFT) - 1))
195 #define PTBL_NENTRIES	1024			/* number of pages mapped by ptbl */
196 
197 /* Returns ptbl entry number for given va */
198 #define PTBL_IDX(va)	(((va) & PTBL_MASK) >> PTBL_SHIFT)
199 
200 /* Size of ptbl in pages, 1024 entries, each sizeof(struct pte_entry). */
201 #define PTBL_PAGES	2
202 #define PTBL_ENTRY_SHIFT 3	/* entry size is 2^3 = 8 bytes */
203 
204 /*
205  * Flags for pte_remove() routine.
206  */
207 #define PTBL_HOLD	0x00000001	/* do not unhold ptbl pages */
208 #define PTBL_UNHOLD	0x00000002	/* unhold and attempt to free ptbl pages */
209 
210 #define PTBL_HOLD_FLAG(pmap)	(((pmap) == kernel_pmap) ? PTBL_HOLD : PTBL_UNHOLD)
211 
212 /*
213  * Page Table Entry definitions and macros.
214  */
215 #ifndef	LOCORE
216 struct pte {
217 	vm_offset_t rpn;
218 	uint32_t flags;
219 };
220 typedef struct pte pte_t;
221 #endif
222 
223 /* RPN mask, TLB0 4K pages */
224 #define PTE_PA_MASK	PAGE_MASK
225 
226 /* PTE bits assigned to MAS2, MAS3 flags */
227 #define PTE_W		MAS2_W
228 #define PTE_I		MAS2_I
229 #define PTE_M		MAS2_M
230 #define PTE_G		MAS2_G
231 #define PTE_MAS2_MASK	(MAS2_G | MAS2_M | MAS2_I | MAS2_W)
232 
233 #define PTE_MAS3_SHIFT	8
234 #define PTE_UX		(MAS3_UX << PTE_MAS3_SHIFT)
235 #define PTE_SX		(MAS3_SX << PTE_MAS3_SHIFT)
236 #define PTE_UW		(MAS3_UW << PTE_MAS3_SHIFT)
237 #define PTE_SW		(MAS3_SW << PTE_MAS3_SHIFT)
238 #define PTE_UR		(MAS3_UR << PTE_MAS3_SHIFT)
239 #define PTE_SR		(MAS3_SR << PTE_MAS3_SHIFT)
240 #define PTE_MAS3_MASK	((MAS3_UX | MAS3_SX | MAS3_UW	\
241 			| MAS3_SW | MAS3_UR | MAS3_SR) << PTE_MAS3_SHIFT)
242 
243 /* Other PTE flags */
244 #define PTE_VALID	0x80000000	/* Valid */
245 #define PTE_MODIFIED	0x40000000	/* Modified */
246 #define PTE_WIRED	0x20000000	/* Wired */
247 #define PTE_MANAGED	0x10000000	/* Managed */
248 #define PTE_REFERENCED	0x04000000	/* Referenced */
249 
250 /* Macro argument must of pte_t type. */
251 #define PTE_PA(pte)		((pte)->rpn & ~PTE_PA_MASK)
252 #define PTE_ISVALID(pte)	((pte)->flags & PTE_VALID)
253 #define PTE_ISWIRED(pte)	((pte)->flags & PTE_WIRED)
254 #define PTE_ISMANAGED(pte)	((pte)->flags & PTE_MANAGED)
255 #define PTE_ISMODIFIED(pte)	((pte)->flags & PTE_MODIFIED)
256 #define PTE_ISREFERENCED(pte)	((pte)->flags & PTE_REFERENCED)
257 
258 #endif /* #elif defined(E500) */
259 
260 #endif /* _MACHINE_PTE_H_ */
261