GNU Linux-libre 4.19.286-gnu1
[releases.git] / arch / arm / include / asm / pgtable.h
1 /*
2  *  arch/arm/include/asm/pgtable.h
3  *
4  *  Copyright (C) 1995-2002 Russell King
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 #ifndef _ASMARM_PGTABLE_H
11 #define _ASMARM_PGTABLE_H
12
13 #include <linux/const.h>
14 #include <asm/proc-fns.h>
15
16 #ifndef __ASSEMBLY__
17 /*
18  * ZERO_PAGE is a global shared page that is always zero: used
19  * for zero-mapped memory areas etc..
20  */
21 extern struct page *empty_zero_page;
22 #define ZERO_PAGE(vaddr)        (empty_zero_page)
23 #endif
24
25 #ifndef CONFIG_MMU
26
27 #include <asm-generic/4level-fixup.h>
28 #include <asm/pgtable-nommu.h>
29
30 #else
31
32 #define __ARCH_USE_5LEVEL_HACK
33 #include <asm-generic/pgtable-nopud.h>
34 #include <asm/memory.h>
35 #include <asm/pgtable-hwdef.h>
36
37
38 #include <asm/tlbflush.h>
39
40 #ifdef CONFIG_ARM_LPAE
41 #include <asm/pgtable-3level.h>
42 #else
43 #include <asm/pgtable-2level.h>
44 #endif
45
46 /*
47  * Just any arbitrary offset to the start of the vmalloc VM area: the
48  * current 8MB value just means that there will be a 8MB "hole" after the
49  * physical memory until the kernel virtual memory starts.  That means that
50  * any out-of-bounds memory accesses will hopefully be caught.
51  * The vmalloc() routines leaves a hole of 4kB between each vmalloced
52  * area for the same reason. ;)
53  */
54 #define VMALLOC_OFFSET          (8*1024*1024)
55 #define VMALLOC_START           (((unsigned long)high_memory + VMALLOC_OFFSET) & ~(VMALLOC_OFFSET-1))
56 #define VMALLOC_END             0xff800000UL
57
58 #define LIBRARY_TEXT_START      0x0c000000
59
60 #ifndef __ASSEMBLY__
61 extern void __pte_error(const char *file, int line, pte_t);
62 extern void __pmd_error(const char *file, int line, pmd_t);
63 extern void __pgd_error(const char *file, int line, pgd_t);
64
65 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte)
66 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd)
67 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd)
68
69 /*
70  * This is the lowest virtual address we can permit any user space
71  * mapping to be mapped at.  This is particularly important for
72  * non-high vector CPUs.
73  */
74 #define FIRST_USER_ADDRESS      (PAGE_SIZE * 2)
75
76 /*
77  * Use TASK_SIZE as the ceiling argument for free_pgtables() and
78  * free_pgd_range() to avoid freeing the modules pmd when LPAE is enabled (pmd
79  * page shared between user and kernel).
80  */
81 #ifdef CONFIG_ARM_LPAE
82 #define USER_PGTABLES_CEILING   TASK_SIZE
83 #endif
84
85 /*
86  * The pgprot_* and protection_map entries will be fixed up in runtime
87  * to include the cachable and bufferable bits based on memory policy,
88  * as well as any architecture dependent bits like global/ASID and SMP
89  * shared mapping bits.
90  */
91 #define _L_PTE_DEFAULT  L_PTE_PRESENT | L_PTE_YOUNG
92
93 extern pgprot_t         pgprot_user;
94 extern pgprot_t         pgprot_kernel;
95 extern pgprot_t         pgprot_hyp_device;
96 extern pgprot_t         pgprot_s2;
97 extern pgprot_t         pgprot_s2_device;
98
99 #define _MOD_PROT(p, b) __pgprot(pgprot_val(p) | (b))
100
101 #define PAGE_NONE               _MOD_PROT(pgprot_user, L_PTE_XN | L_PTE_RDONLY | L_PTE_NONE)
102 #define PAGE_SHARED             _MOD_PROT(pgprot_user, L_PTE_USER | L_PTE_XN)
103 #define PAGE_SHARED_EXEC        _MOD_PROT(pgprot_user, L_PTE_USER)
104 #define PAGE_COPY               _MOD_PROT(pgprot_user, L_PTE_USER | L_PTE_RDONLY | L_PTE_XN)
105 #define PAGE_COPY_EXEC          _MOD_PROT(pgprot_user, L_PTE_USER | L_PTE_RDONLY)
106 #define PAGE_READONLY           _MOD_PROT(pgprot_user, L_PTE_USER | L_PTE_RDONLY | L_PTE_XN)
107 #define PAGE_READONLY_EXEC      _MOD_PROT(pgprot_user, L_PTE_USER | L_PTE_RDONLY)
108 #define PAGE_KERNEL             _MOD_PROT(pgprot_kernel, L_PTE_XN)
109 #define PAGE_KERNEL_EXEC        pgprot_kernel
110 #define PAGE_HYP                _MOD_PROT(pgprot_kernel, L_PTE_HYP | L_PTE_XN)
111 #define PAGE_HYP_EXEC           _MOD_PROT(pgprot_kernel, L_PTE_HYP | L_PTE_RDONLY)
112 #define PAGE_HYP_RO             _MOD_PROT(pgprot_kernel, L_PTE_HYP | L_PTE_RDONLY | L_PTE_XN)
113 #define PAGE_HYP_DEVICE         _MOD_PROT(pgprot_hyp_device, L_PTE_HYP)
114 #define PAGE_S2                 _MOD_PROT(pgprot_s2, L_PTE_S2_RDONLY | L_PTE_XN)
115 #define PAGE_S2_DEVICE          _MOD_PROT(pgprot_s2_device, L_PTE_S2_RDONLY | L_PTE_XN)
116
117 #define __PAGE_NONE             __pgprot(_L_PTE_DEFAULT | L_PTE_RDONLY | L_PTE_XN | L_PTE_NONE)
118 #define __PAGE_SHARED           __pgprot(_L_PTE_DEFAULT | L_PTE_USER | L_PTE_XN)
119 #define __PAGE_SHARED_EXEC      __pgprot(_L_PTE_DEFAULT | L_PTE_USER)
120 #define __PAGE_COPY             __pgprot(_L_PTE_DEFAULT | L_PTE_USER | L_PTE_RDONLY | L_PTE_XN)
121 #define __PAGE_COPY_EXEC        __pgprot(_L_PTE_DEFAULT | L_PTE_USER | L_PTE_RDONLY)
122 #define __PAGE_READONLY         __pgprot(_L_PTE_DEFAULT | L_PTE_USER | L_PTE_RDONLY | L_PTE_XN)
123 #define __PAGE_READONLY_EXEC    __pgprot(_L_PTE_DEFAULT | L_PTE_USER | L_PTE_RDONLY)
124
125 #define __pgprot_modify(prot,mask,bits)         \
126         __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
127
128 #define pgprot_noncached(prot) \
129         __pgprot_modify(prot, L_PTE_MT_MASK, L_PTE_MT_UNCACHED)
130
131 #define pgprot_writecombine(prot) \
132         __pgprot_modify(prot, L_PTE_MT_MASK, L_PTE_MT_BUFFERABLE)
133
134 #define pgprot_stronglyordered(prot) \
135         __pgprot_modify(prot, L_PTE_MT_MASK, L_PTE_MT_UNCACHED)
136
137 #ifdef CONFIG_ARM_DMA_MEM_BUFFERABLE
138 #define pgprot_dmacoherent(prot) \
139         __pgprot_modify(prot, L_PTE_MT_MASK, L_PTE_MT_BUFFERABLE | L_PTE_XN)
140 #define __HAVE_PHYS_MEM_ACCESS_PROT
141 struct file;
142 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
143                                      unsigned long size, pgprot_t vma_prot);
144 #else
145 #define pgprot_dmacoherent(prot) \
146         __pgprot_modify(prot, L_PTE_MT_MASK, L_PTE_MT_UNCACHED | L_PTE_XN)
147 #endif
148
149 #endif /* __ASSEMBLY__ */
150
151 /*
152  * The table below defines the page protection levels that we insert into our
153  * Linux page table version.  These get translated into the best that the
154  * architecture can perform.  Note that on most ARM hardware:
155  *  1) We cannot do execute protection
156  *  2) If we could do execute protection, then read is implied
157  *  3) write implies read permissions
158  */
159 #define __P000  __PAGE_NONE
160 #define __P001  __PAGE_READONLY
161 #define __P010  __PAGE_COPY
162 #define __P011  __PAGE_COPY
163 #define __P100  __PAGE_READONLY_EXEC
164 #define __P101  __PAGE_READONLY_EXEC
165 #define __P110  __PAGE_COPY_EXEC
166 #define __P111  __PAGE_COPY_EXEC
167
168 #define __S000  __PAGE_NONE
169 #define __S001  __PAGE_READONLY
170 #define __S010  __PAGE_SHARED
171 #define __S011  __PAGE_SHARED
172 #define __S100  __PAGE_READONLY_EXEC
173 #define __S101  __PAGE_READONLY_EXEC
174 #define __S110  __PAGE_SHARED_EXEC
175 #define __S111  __PAGE_SHARED_EXEC
176
177 #ifndef __ASSEMBLY__
178
179 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
180
181 /* to find an entry in a page-table-directory */
182 #define pgd_index(addr)         ((addr) >> PGDIR_SHIFT)
183
184 #define pgd_offset(mm, addr)    ((mm)->pgd + pgd_index(addr))
185
186 /* to find an entry in a kernel page-table-directory */
187 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
188
189 #define pmd_none(pmd)           (!pmd_val(pmd))
190
191 static inline pte_t *pmd_page_vaddr(pmd_t pmd)
192 {
193         return __va(pmd_val(pmd) & PHYS_MASK & (s32)PAGE_MASK);
194 }
195
196 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
197
198 #ifndef CONFIG_HIGHPTE
199 #define __pte_map(pmd)          pmd_page_vaddr(*(pmd))
200 #define __pte_unmap(pte)        do { } while (0)
201 #else
202 #define __pte_map(pmd)          (pte_t *)kmap_atomic(pmd_page(*(pmd)))
203 #define __pte_unmap(pte)        kunmap_atomic(pte)
204 #endif
205
206 #define pte_index(addr)         (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
207
208 #define pte_offset_kernel(pmd,addr)     (pmd_page_vaddr(*(pmd)) + pte_index(addr))
209
210 #define pte_offset_map(pmd,addr)        (__pte_map(pmd) + pte_index(addr))
211 #define pte_unmap(pte)                  __pte_unmap(pte)
212
213 #define pte_pfn(pte)            ((pte_val(pte) & PHYS_MASK) >> PAGE_SHIFT)
214 #define pfn_pte(pfn,prot)       __pte(__pfn_to_phys(pfn) | pgprot_val(prot))
215
216 #define pte_page(pte)           pfn_to_page(pte_pfn(pte))
217 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page), prot)
218
219 #define pte_clear(mm,addr,ptep) set_pte_ext(ptep, __pte(0), 0)
220
221 #define pte_isset(pte, val)     ((u32)(val) == (val) ? pte_val(pte) & (val) \
222                                                 : !!(pte_val(pte) & (val)))
223 #define pte_isclear(pte, val)   (!(pte_val(pte) & (val)))
224
225 #define pte_none(pte)           (!pte_val(pte))
226 #define pte_present(pte)        (pte_isset((pte), L_PTE_PRESENT))
227 #define pte_valid(pte)          (pte_isset((pte), L_PTE_VALID))
228 #define pte_accessible(mm, pte) (mm_tlb_flush_pending(mm) ? pte_present(pte) : pte_valid(pte))
229 #define pte_write(pte)          (pte_isclear((pte), L_PTE_RDONLY))
230 #define pte_dirty(pte)          (pte_isset((pte), L_PTE_DIRTY))
231 #define pte_young(pte)          (pte_isset((pte), L_PTE_YOUNG))
232 #define pte_exec(pte)           (pte_isclear((pte), L_PTE_XN))
233
234 #define pte_valid_user(pte)     \
235         (pte_valid(pte) && pte_isset((pte), L_PTE_USER) && pte_young(pte))
236
237 static inline bool pte_access_permitted(pte_t pte, bool write)
238 {
239         pteval_t mask = L_PTE_PRESENT | L_PTE_USER;
240         pteval_t needed = mask;
241
242         if (write)
243                 mask |= L_PTE_RDONLY;
244
245         return (pte_val(pte) & mask) == needed;
246 }
247 #define pte_access_permitted pte_access_permitted
248
249 #if __LINUX_ARM_ARCH__ < 6
250 static inline void __sync_icache_dcache(pte_t pteval)
251 {
252 }
253 #else
254 extern void __sync_icache_dcache(pte_t pteval);
255 #endif
256
257 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
258                               pte_t *ptep, pte_t pteval)
259 {
260         unsigned long ext = 0;
261
262         if (addr < TASK_SIZE && pte_valid_user(pteval)) {
263                 if (!pte_special(pteval))
264                         __sync_icache_dcache(pteval);
265                 ext |= PTE_EXT_NG;
266         }
267
268         set_pte_ext(ptep, pteval, ext);
269 }
270
271 static inline pte_t clear_pte_bit(pte_t pte, pgprot_t prot)
272 {
273         pte_val(pte) &= ~pgprot_val(prot);
274         return pte;
275 }
276
277 static inline pte_t set_pte_bit(pte_t pte, pgprot_t prot)
278 {
279         pte_val(pte) |= pgprot_val(prot);
280         return pte;
281 }
282
283 static inline pte_t pte_wrprotect(pte_t pte)
284 {
285         return set_pte_bit(pte, __pgprot(L_PTE_RDONLY));
286 }
287
288 static inline pte_t pte_mkwrite(pte_t pte)
289 {
290         return clear_pte_bit(pte, __pgprot(L_PTE_RDONLY));
291 }
292
293 static inline pte_t pte_mkclean(pte_t pte)
294 {
295         return clear_pte_bit(pte, __pgprot(L_PTE_DIRTY));
296 }
297
298 static inline pte_t pte_mkdirty(pte_t pte)
299 {
300         return set_pte_bit(pte, __pgprot(L_PTE_DIRTY));
301 }
302
303 static inline pte_t pte_mkold(pte_t pte)
304 {
305         return clear_pte_bit(pte, __pgprot(L_PTE_YOUNG));
306 }
307
308 static inline pte_t pte_mkyoung(pte_t pte)
309 {
310         return set_pte_bit(pte, __pgprot(L_PTE_YOUNG));
311 }
312
313 static inline pte_t pte_mkexec(pte_t pte)
314 {
315         return clear_pte_bit(pte, __pgprot(L_PTE_XN));
316 }
317
318 static inline pte_t pte_mknexec(pte_t pte)
319 {
320         return set_pte_bit(pte, __pgprot(L_PTE_XN));
321 }
322
323 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
324 {
325         const pteval_t mask = L_PTE_XN | L_PTE_RDONLY | L_PTE_USER |
326                 L_PTE_NONE | L_PTE_VALID;
327         pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
328         return pte;
329 }
330
331 /*
332  * Encode and decode a swap entry.  Swap entries are stored in the Linux
333  * page tables as follows:
334  *
335  *   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
336  *   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
337  *   <--------------- offset ------------------------> < type -> 0 0
338  *
339  * This gives us up to 31 swap files and 128GB per swap file.  Note that
340  * the offset field is always non-zero.
341  */
342 #define __SWP_TYPE_SHIFT        2
343 #define __SWP_TYPE_BITS         5
344 #define __SWP_TYPE_MASK         ((1 << __SWP_TYPE_BITS) - 1)
345 #define __SWP_OFFSET_SHIFT      (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
346
347 #define __swp_type(x)           (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
348 #define __swp_offset(x)         ((x).val >> __SWP_OFFSET_SHIFT)
349 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
350
351 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
352 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
353
354 /*
355  * It is an error for the kernel to have more swap files than we can
356  * encode in the PTEs.  This ensures that we know when MAX_SWAPFILES
357  * is increased beyond what we presently support.
358  */
359 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
360
361 /* Needs to be defined here and not in linux/mm.h, as it is arch dependent */
362 /* FIXME: this is not correct */
363 #define kern_addr_valid(addr)   (1)
364
365 #include <asm-generic/pgtable.h>
366
367 /*
368  * We provide our own arch_get_unmapped_area to cope with VIPT caches.
369  */
370 #define HAVE_ARCH_UNMAPPED_AREA
371 #define HAVE_ARCH_UNMAPPED_AREA_TOPDOWN
372
373 #define pgtable_cache_init() do { } while (0)
374
375 #endif /* !__ASSEMBLY__ */
376
377 #endif /* CONFIG_MMU */
378
379 #endif /* _ASMARM_PGTABLE_H */