GNU Linux-libre 4.14.262-gnu1
[releases.git] / arch / powerpc / include / asm / pte-common.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Included from asm/pgtable-*.h only ! */
3
4 /*
5  * Some bits are only used on some cpu families... Make sure that all
6  * the undefined gets a sensible default
7  */
8 #ifndef _PAGE_HASHPTE
9 #define _PAGE_HASHPTE   0
10 #endif
11 #ifndef _PAGE_SHARED
12 #define _PAGE_SHARED    0
13 #endif
14 #ifndef _PAGE_HWWRITE
15 #define _PAGE_HWWRITE   0
16 #endif
17 #ifndef _PAGE_EXEC
18 #define _PAGE_EXEC      0
19 #endif
20 #ifndef _PAGE_ENDIAN
21 #define _PAGE_ENDIAN    0
22 #endif
23 #ifndef _PAGE_COHERENT
24 #define _PAGE_COHERENT  0
25 #endif
26 #ifndef _PAGE_WRITETHRU
27 #define _PAGE_WRITETHRU 0
28 #endif
29 #ifndef _PAGE_4K_PFN
30 #define _PAGE_4K_PFN            0
31 #endif
32 #ifndef _PAGE_SAO
33 #define _PAGE_SAO       0
34 #endif
35 #ifndef _PAGE_PSIZE
36 #define _PAGE_PSIZE             0
37 #endif
38 /* _PAGE_RO and _PAGE_RW shall not be defined at the same time */
39 #ifndef _PAGE_RO
40 #define _PAGE_RO 0
41 #else
42 #define _PAGE_RW 0
43 #endif
44
45 #ifndef _PAGE_PTE
46 #define _PAGE_PTE 0
47 #endif
48
49 #ifndef _PMD_PRESENT_MASK
50 #define _PMD_PRESENT_MASK       _PMD_PRESENT
51 #endif
52 #ifndef _PMD_SIZE
53 #define _PMD_SIZE       0
54 #define PMD_PAGE_SIZE(pmd)      bad_call_to_PMD_PAGE_SIZE()
55 #endif
56 #ifndef _PAGE_KERNEL_RO
57 #define _PAGE_KERNEL_RO         (_PAGE_RO)
58 #endif
59 #ifndef _PAGE_KERNEL_ROX
60 #define _PAGE_KERNEL_ROX        (_PAGE_EXEC | _PAGE_RO)
61 #endif
62 #ifndef _PAGE_KERNEL_RW
63 #define _PAGE_KERNEL_RW         (_PAGE_DIRTY | _PAGE_RW | _PAGE_HWWRITE)
64 #endif
65 #ifndef _PAGE_KERNEL_RWX
66 #define _PAGE_KERNEL_RWX        (_PAGE_DIRTY | _PAGE_RW | _PAGE_HWWRITE | _PAGE_EXEC)
67 #endif
68 #ifndef _PAGE_HPTEFLAGS
69 #define _PAGE_HPTEFLAGS _PAGE_HASHPTE
70 #endif
71 #ifndef _PTE_NONE_MASK
72 #define _PTE_NONE_MASK  _PAGE_HPTEFLAGS
73 #endif
74
75 /* Make sure we get a link error if PMD_PAGE_SIZE is ever called on a
76  * kernel without large page PMD support
77  */
78 #ifndef __ASSEMBLY__
79 extern unsigned long bad_call_to_PMD_PAGE_SIZE(void);
80
81 /*
82  * Don't just check for any non zero bits in __PAGE_USER, since for book3e
83  * and PTE_64BIT, PAGE_KERNEL_X contains _PAGE_BAP_SR which is also in
84  * _PAGE_USER.  Need to explicitly match _PAGE_BAP_UR bit in that case too.
85  */
86 static inline bool pte_user(pte_t pte)
87 {
88         return (pte_val(pte) & _PAGE_USER) == _PAGE_USER;
89 }
90 #endif /* __ASSEMBLY__ */
91
92 /* Location of the PFN in the PTE. Most 32-bit platforms use the same
93  * as _PAGE_SHIFT here (ie, naturally aligned).
94  * Platform who don't just pre-define the value so we don't override it here
95  */
96 #ifndef PTE_RPN_SHIFT
97 #define PTE_RPN_SHIFT   (PAGE_SHIFT)
98 #endif
99
100 /* The mask covered by the RPN must be a ULL on 32-bit platforms with
101  * 64-bit PTEs
102  */
103 #if defined(CONFIG_PPC32) && defined(CONFIG_PTE_64BIT)
104 #define PTE_RPN_MASK    (~((1ULL<<PTE_RPN_SHIFT)-1))
105 #define MAX_POSSIBLE_PHYSMEM_BITS 36
106 #else
107 #define PTE_RPN_MASK    (~((1UL<<PTE_RPN_SHIFT)-1))
108 #define MAX_POSSIBLE_PHYSMEM_BITS 32
109 #endif
110
111 /* _PAGE_CHG_MASK masks of bits that are to be preserved across
112  * pgprot changes
113  */
114 #define _PAGE_CHG_MASK  (PTE_RPN_MASK | _PAGE_HPTEFLAGS | _PAGE_DIRTY | \
115                          _PAGE_ACCESSED | _PAGE_SPECIAL)
116
117 /* Mask of bits returned by pte_pgprot() */
118 #define PAGE_PROT_BITS  (_PAGE_GUARDED | _PAGE_COHERENT | _PAGE_NO_CACHE | \
119                          _PAGE_WRITETHRU | _PAGE_ENDIAN | _PAGE_4K_PFN | \
120                          _PAGE_USER | _PAGE_ACCESSED | _PAGE_RO | \
121                          _PAGE_RW | _PAGE_HWWRITE | _PAGE_DIRTY | _PAGE_EXEC)
122
123 /*
124  * We define 2 sets of base prot bits, one for basic pages (ie,
125  * cacheable kernel and user pages) and one for non cacheable
126  * pages. We always set _PAGE_COHERENT when SMP is enabled or
127  * the processor might need it for DMA coherency.
128  */
129 #define _PAGE_BASE_NC   (_PAGE_PRESENT | _PAGE_ACCESSED | _PAGE_PSIZE)
130 #if defined(CONFIG_SMP) || defined(CONFIG_PPC_STD_MMU) || \
131         defined(CONFIG_PPC_E500MC)
132 #define _PAGE_BASE      (_PAGE_BASE_NC | _PAGE_COHERENT)
133 #else
134 #define _PAGE_BASE      (_PAGE_BASE_NC)
135 #endif
136
137 /* Permission masks used to generate the __P and __S table,
138  *
139  * Note:__pgprot is defined in arch/powerpc/include/asm/page.h
140  *
141  * Write permissions imply read permissions for now (we could make write-only
142  * pages on BookE but we don't bother for now). Execute permission control is
143  * possible on platforms that define _PAGE_EXEC
144  *
145  * Note due to the way vm flags are laid out, the bits are XWR
146  */
147 #define PAGE_NONE       __pgprot(_PAGE_BASE)
148 #define PAGE_SHARED     __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RW)
149 #define PAGE_SHARED_X   __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RW | \
150                                  _PAGE_EXEC)
151 #define PAGE_COPY       __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RO)
152 #define PAGE_COPY_X     __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RO | \
153                                  _PAGE_EXEC)
154 #define PAGE_READONLY   __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RO)
155 #define PAGE_READONLY_X __pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RO | \
156                                  _PAGE_EXEC)
157
158 #define __P000  PAGE_NONE
159 #define __P001  PAGE_READONLY
160 #define __P010  PAGE_COPY
161 #define __P011  PAGE_COPY
162 #define __P100  PAGE_READONLY_X
163 #define __P101  PAGE_READONLY_X
164 #define __P110  PAGE_COPY_X
165 #define __P111  PAGE_COPY_X
166
167 #define __S000  PAGE_NONE
168 #define __S001  PAGE_READONLY
169 #define __S010  PAGE_SHARED
170 #define __S011  PAGE_SHARED
171 #define __S100  PAGE_READONLY_X
172 #define __S101  PAGE_READONLY_X
173 #define __S110  PAGE_SHARED_X
174 #define __S111  PAGE_SHARED_X
175
176 /* Permission masks used for kernel mappings */
177 #define PAGE_KERNEL     __pgprot(_PAGE_BASE | _PAGE_KERNEL_RW)
178 #define PAGE_KERNEL_NC  __pgprot(_PAGE_BASE_NC | _PAGE_KERNEL_RW | \
179                                  _PAGE_NO_CACHE)
180 #define PAGE_KERNEL_NCG __pgprot(_PAGE_BASE_NC | _PAGE_KERNEL_RW | \
181                                  _PAGE_NO_CACHE | _PAGE_GUARDED)
182 #define PAGE_KERNEL_X   __pgprot(_PAGE_BASE | _PAGE_KERNEL_RWX)
183 #define PAGE_KERNEL_RO  __pgprot(_PAGE_BASE | _PAGE_KERNEL_RO)
184 #define PAGE_KERNEL_ROX __pgprot(_PAGE_BASE | _PAGE_KERNEL_ROX)
185
186 /* Protection used for kernel text. We want the debuggers to be able to
187  * set breakpoints anywhere, so don't write protect the kernel text
188  * on platforms where such control is possible.
189  */
190 #if defined(CONFIG_KGDB) || defined(CONFIG_XMON) || defined(CONFIG_BDI_SWITCH) ||\
191         defined(CONFIG_KPROBES) || defined(CONFIG_DYNAMIC_FTRACE)
192 #define PAGE_KERNEL_TEXT        PAGE_KERNEL_X
193 #else
194 #define PAGE_KERNEL_TEXT        PAGE_KERNEL_ROX
195 #endif
196
197 /* Make modules code happy. We don't set RO yet */
198 #define PAGE_KERNEL_EXEC        PAGE_KERNEL_X
199
200 /* Advertise special mapping type for AGP */
201 #define PAGE_AGP                (PAGE_KERNEL_NC)
202 #define HAVE_PAGE_AGP
203
204 /* Advertise support for _PAGE_SPECIAL */
205 #define __HAVE_ARCH_PTE_SPECIAL
206
207 #ifndef _PAGE_READ
208 /* if not defined, we should not find _PAGE_WRITE too */
209 #define _PAGE_READ 0
210 #define _PAGE_WRITE _PAGE_RW
211 #endif
212
213 #ifndef H_PAGE_4K_PFN
214 #define H_PAGE_4K_PFN 0
215 #endif