2 * Copyright (C) 2012 ARM Ltd.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #ifndef __ASM_PGTABLE_H
17 #define __ASM_PGTABLE_H
19 #include <asm/proc-fns.h>
21 #include <asm/memory.h>
22 #include <asm/pgtable-hwdef.h>
25 * Software defined PTE bits definition.
27 #define PTE_VALID (_AT(pteval_t, 1) << 0)
28 #define PTE_FILE (_AT(pteval_t, 1) << 2) /* only when !pte_present() */
29 #define PTE_DIRTY (_AT(pteval_t, 1) << 55)
30 #define PTE_SPECIAL (_AT(pteval_t, 1) << 56)
31 #define PTE_WRITE (_AT(pteval_t, 1) << 57)
32 #define PTE_PROT_NONE (_AT(pteval_t, 1) << 58) /* only when !PTE_VALID */
35 * VMALLOC and SPARSEMEM_VMEMMAP ranges.
37 #define VMALLOC_START (UL(0xffffffffffffffff) << VA_BITS)
38 #ifndef CONFIG_ARM64_4_LEVELS
39 #define VMALLOC_END (PAGE_OFFSET - UL(0x400000000) - SZ_64K)
41 #define VMALLOC_END (PAGE_OFFSET - UL(0x40000000000) - SZ_64K)
44 #define vmemmap ((struct page *)(VMALLOC_END + SZ_64K))
46 #define FIRST_USER_ADDRESS 0
49 extern void __pte_error(const char *file, int line, unsigned long val);
50 extern void __pmd_error(const char *file, int line, unsigned long val);
51 extern void __pud_error(const char *file, int line, unsigned long val);
52 extern void __pgd_error(const char *file, int line, unsigned long val);
54 #define pte_ERROR(pte) __pte_error(__FILE__, __LINE__, pte_val(pte))
55 #ifndef CONFIG_ARM64_2_LEVELS
56 #define pmd_ERROR(pmd) __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
58 #ifdef CONFIG_ARM64_4_LEVELS
59 #define pud_ERROR(pud) __pud_error(__FILE__, __LINE__, pud_val(pud))
61 #define pgd_ERROR(pgd) __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
64 #define PROT_DEFAULT (PTE_TYPE_PAGE | PTE_AF | PTE_SHARED)
65 #define PROT_SECT_DEFAULT (PMD_TYPE_SECT | PMD_SECT_AF | PMD_SECT_S)
67 #define PROT_DEFAULT (PTE_TYPE_PAGE | PTE_AF)
68 #define PROT_SECT_DEFAULT (PMD_TYPE_SECT | PMD_SECT_AF)
71 #define PROT_DEVICE_nGnRE (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_DEVICE_nGnRE))
72 #define PROT_NORMAL_NC (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL_NC))
73 #define PROT_NORMAL (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL))
75 #define PROT_SECT_DEVICE_nGnRE (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_DEVICE_nGnRE))
76 #define PROT_SECT_NORMAL (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
77 #define PROT_SECT_NORMAL_EXEC (PROT_SECT_DEFAULT | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
79 #define _PAGE_DEFAULT (PROT_DEFAULT | PTE_ATTRINDX(MT_NORMAL))
81 #define PAGE_KERNEL __pgprot(_PAGE_DEFAULT | PTE_PXN | PTE_UXN | PTE_DIRTY | PTE_WRITE)
82 #define PAGE_KERNEL_EXEC __pgprot(_PAGE_DEFAULT | PTE_UXN | PTE_DIRTY | PTE_WRITE)
84 #define PAGE_HYP __pgprot(_PAGE_DEFAULT | PTE_HYP)
85 #define PAGE_HYP_DEVICE __pgprot(PROT_DEVICE_nGnRE | PTE_HYP)
87 #define PAGE_S2 __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_NORMAL) | PTE_S2_RDONLY)
88 #define PAGE_S2_DEVICE __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_DEVICE_nGnRE) | PTE_S2_RDWR | PTE_UXN)
90 #define PAGE_NONE __pgprot(((_PAGE_DEFAULT) & ~PTE_TYPE_MASK) | PTE_PROT_NONE | PTE_PXN | PTE_UXN)
91 #define PAGE_SHARED __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN | PTE_WRITE)
92 #define PAGE_SHARED_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_WRITE)
93 #define PAGE_COPY __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
94 #define PAGE_COPY_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
95 #define PAGE_READONLY __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
96 #define PAGE_READONLY_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
98 #define __P000 PAGE_NONE
99 #define __P001 PAGE_READONLY
100 #define __P010 PAGE_COPY
101 #define __P011 PAGE_COPY
102 #define __P100 PAGE_READONLY_EXEC
103 #define __P101 PAGE_READONLY_EXEC
104 #define __P110 PAGE_COPY_EXEC
105 #define __P111 PAGE_COPY_EXEC
107 #define __S000 PAGE_NONE
108 #define __S001 PAGE_READONLY
109 #define __S010 PAGE_SHARED
110 #define __S011 PAGE_SHARED
111 #define __S100 PAGE_READONLY_EXEC
112 #define __S101 PAGE_READONLY_EXEC
113 #define __S110 PAGE_SHARED_EXEC
114 #define __S111 PAGE_SHARED_EXEC
117 * ZERO_PAGE is a global shared page that is always zero: used
118 * for zero-mapped memory areas etc..
120 extern struct page *empty_zero_page;
121 #define ZERO_PAGE(vaddr) (empty_zero_page)
123 #define pte_pfn(pte) ((pte_val(pte) & PHYS_MASK) >> PAGE_SHIFT)
125 #define pfn_pte(pfn,prot) (__pte(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
127 #define pte_none(pte) (!pte_val(pte))
128 #define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
129 #define pte_page(pte) (pfn_to_page(pte_pfn(pte)))
130 #define pte_offset_kernel(dir,addr) (pmd_page_vaddr(*(dir)) + pte_index(addr))
132 #define pte_offset_map(dir,addr) pte_offset_kernel((dir), (addr))
133 #define pte_offset_map_nested(dir,addr) pte_offset_kernel((dir), (addr))
134 #define pte_unmap(pte) do { } while (0)
135 #define pte_unmap_nested(pte) do { } while (0)
138 * The following only work if pte_present(). Undefined behaviour otherwise.
140 #define pte_present(pte) (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
141 #define pte_dirty(pte) (!!(pte_val(pte) & PTE_DIRTY))
142 #define pte_young(pte) (!!(pte_val(pte) & PTE_AF))
143 #define pte_special(pte) (!!(pte_val(pte) & PTE_SPECIAL))
144 #define pte_write(pte) (!!(pte_val(pte) & PTE_WRITE))
145 #define pte_exec(pte) (!(pte_val(pte) & PTE_UXN))
147 #define pte_valid_user(pte) \
148 ((pte_val(pte) & (PTE_VALID | PTE_USER)) == (PTE_VALID | PTE_USER))
150 static inline pte_t pte_wrprotect(pte_t pte)
152 pte_val(pte) &= ~PTE_WRITE;
156 static inline pte_t pte_mkwrite(pte_t pte)
158 pte_val(pte) |= PTE_WRITE;
162 static inline pte_t pte_mkclean(pte_t pte)
164 pte_val(pte) &= ~PTE_DIRTY;
168 static inline pte_t pte_mkdirty(pte_t pte)
170 pte_val(pte) |= PTE_DIRTY;
174 static inline pte_t pte_mkold(pte_t pte)
176 pte_val(pte) &= ~PTE_AF;
180 static inline pte_t pte_mkyoung(pte_t pte)
182 pte_val(pte) |= PTE_AF;
186 static inline pte_t pte_mkspecial(pte_t pte)
188 pte_val(pte) |= PTE_SPECIAL;
192 static inline void set_pte(pte_t *ptep, pte_t pte)
197 extern void __sync_icache_dcache(pte_t pteval, unsigned long addr);
199 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
200 pte_t *ptep, pte_t pte)
202 if (pte_valid_user(pte)) {
203 if (!pte_special(pte) && pte_exec(pte))
204 __sync_icache_dcache(pte, addr);
205 if (pte_dirty(pte) && pte_write(pte))
206 pte_val(pte) &= ~PTE_RDONLY;
208 pte_val(pte) |= PTE_RDONLY;
215 * Huge pte definitions.
217 #define pte_huge(pte) (!(pte_val(pte) & PTE_TABLE_BIT))
218 #define pte_mkhuge(pte) (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
221 * Hugetlb definitions.
223 #define HUGE_MAX_HSTATE 2
224 #define HPAGE_SHIFT PMD_SHIFT
225 #define HPAGE_SIZE (_AC(1, UL) << HPAGE_SHIFT)
226 #define HPAGE_MASK (~(HPAGE_SIZE - 1))
227 #define HUGETLB_PAGE_ORDER (HPAGE_SHIFT - PAGE_SHIFT)
229 #define __HAVE_ARCH_PTE_SPECIAL
231 static inline pte_t pmd_pte(pmd_t pmd)
233 return __pte(pmd_val(pmd));
236 static inline pmd_t pte_pmd(pte_t pte)
238 return __pmd(pte_val(pte));
245 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
246 #define pmd_trans_huge(pmd) (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
247 #define pmd_trans_splitting(pmd) pte_special(pmd_pte(pmd))
250 #define pmd_young(pmd) pte_young(pmd_pte(pmd))
251 #define pmd_wrprotect(pmd) pte_pmd(pte_wrprotect(pmd_pte(pmd)))
252 #define pmd_mksplitting(pmd) pte_pmd(pte_mkspecial(pmd_pte(pmd)))
253 #define pmd_mkold(pmd) pte_pmd(pte_mkold(pmd_pte(pmd)))
254 #define pmd_mkwrite(pmd) pte_pmd(pte_mkwrite(pmd_pte(pmd)))
255 #define pmd_mkdirty(pmd) pte_pmd(pte_mkdirty(pmd_pte(pmd)))
256 #define pmd_mkyoung(pmd) pte_pmd(pte_mkyoung(pmd_pte(pmd)))
257 #define pmd_mknotpresent(pmd) (__pmd(pmd_val(pmd) & ~PMD_TYPE_MASK))
259 #define __HAVE_ARCH_PMD_WRITE
260 #define pmd_write(pmd) pte_write(pmd_pte(pmd))
262 #define pmd_mkhuge(pmd) (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
264 #define pmd_pfn(pmd) (((pmd_val(pmd) & PMD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
265 #define pfn_pmd(pfn,prot) (__pmd(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
266 #define mk_pmd(page,prot) pfn_pmd(page_to_pfn(page),prot)
268 #define pmd_page(pmd) pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
269 #define pud_pfn(pud) (((pud_val(pud) & PUD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
271 #define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
273 static inline int has_transparent_hugepage(void)
278 #define __pgprot_modify(prot,mask,bits) \
279 __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
282 * Mark the prot value as uncacheable and unbufferable.
284 #define pgprot_noncached(prot) \
285 __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
286 #define pgprot_writecombine(prot) \
287 __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
288 #define __HAVE_PHYS_MEM_ACCESS_PROT
290 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
291 unsigned long size, pgprot_t vma_prot);
293 #define pmd_none(pmd) (!pmd_val(pmd))
294 #define pmd_present(pmd) (pmd_val(pmd))
296 #define pmd_bad(pmd) (!(pmd_val(pmd) & 2))
298 #define pmd_table(pmd) ((pmd_val(pmd) & PMD_TYPE_MASK) == \
300 #define pmd_sect(pmd) ((pmd_val(pmd) & PMD_TYPE_MASK) == \
303 #ifdef CONFIG_ARM64_64K_PAGES
304 #define pud_sect(pud) (0)
306 #define pud_sect(pud) ((pud_val(pud) & PUD_TYPE_MASK) == \
310 static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
316 static inline void pmd_clear(pmd_t *pmdp)
318 set_pmd(pmdp, __pmd(0));
321 static inline pte_t *pmd_page_vaddr(pmd_t pmd)
323 return __va(pmd_val(pmd) & PHYS_MASK & (s32)PAGE_MASK);
326 #define pmd_page(pmd) pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
329 * Conversion functions: convert a page and protection to a page entry,
330 * and a page entry and page directory to the page they refer to.
332 #define mk_pte(page,prot) pfn_pte(page_to_pfn(page),prot)
334 #ifndef CONFIG_ARM64_2_LEVELS
336 #define pud_none(pud) (!pud_val(pud))
337 #define pud_bad(pud) (!(pud_val(pud) & 2))
338 #define pud_present(pud) (pud_val(pud))
340 static inline void set_pud(pud_t *pudp, pud_t pud)
346 static inline void pud_clear(pud_t *pudp)
348 set_pud(pudp, __pud(0));
351 static inline pmd_t *pud_page_vaddr(pud_t pud)
353 return __va(pud_val(pud) & PHYS_MASK & (s32)PAGE_MASK);
356 #endif /* CONFIG_ARM64_2_LEVELS */
358 #ifdef CONFIG_ARM64_4_LEVELS
360 #define pgd_none(pgd) (!pgd_val(pgd))
361 #define pgd_bad(pgd) (!(pgd_val(pgd) & 2))
362 #define pgd_present(pgd) (pgd_val(pgd))
364 static inline void set_pgd(pgd_t *pgdp, pgd_t pgd)
370 static inline void pgd_clear(pgd_t *pgdp)
372 set_pgd(pgdp, __pgd(0));
375 static inline pud_t *pgd_page_vaddr(pgd_t pgd)
377 return __va(pgd_val(pgd) & PHYS_MASK & (s32)PAGE_MASK);
380 #endif /* CONFIG_ARM64_4_LEVELS */
382 /* to find an entry in a page-table-directory */
383 #define pgd_index(addr) (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
385 #define pgd_offset(mm, addr) ((mm)->pgd+pgd_index(addr))
387 /* to find an entry in a kernel page-table-directory */
388 #define pgd_offset_k(addr) pgd_offset(&init_mm, addr)
390 #ifdef CONFIG_ARM64_4_LEVELS
391 #define pud_index(addr) (((addr) >> PUD_SHIFT) & (PTRS_PER_PUD - 1))
392 static inline pud_t *pud_offset(pgd_t *pgd, unsigned long addr)
394 return (pud_t *)pgd_page_vaddr(*pgd) + pud_index(addr);
398 /* Find an entry in the second-level page table.. */
399 #ifndef CONFIG_ARM64_2_LEVELS
400 #define pmd_index(addr) (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
401 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long addr)
403 return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(addr);
407 /* Find an entry in the third-level page table.. */
408 #define pte_index(addr) (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
410 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
412 const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
413 PTE_PROT_NONE | PTE_VALID | PTE_WRITE;
414 pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
418 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
420 return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
423 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
424 extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
427 * Encode and decode a swap entry:
428 * bits 0-1: present (must be zero)
430 * bits 3-8: swap type
431 * bits 9-57: swap offset
433 #define __SWP_TYPE_SHIFT 3
434 #define __SWP_TYPE_BITS 6
435 #define __SWP_OFFSET_BITS 49
436 #define __SWP_TYPE_MASK ((1 << __SWP_TYPE_BITS) - 1)
437 #define __SWP_OFFSET_SHIFT (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
438 #define __SWP_OFFSET_MASK ((1UL << __SWP_OFFSET_BITS) - 1)
440 #define __swp_type(x) (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
441 #define __swp_offset(x) (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
442 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
444 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
445 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
448 * Ensure that there are not more swap files than can be encoded in the kernel
451 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
454 * Encode and decode a file entry:
455 * bits 0-1: present (must be zero)
457 * bits 3-57: file offset / PAGE_SIZE
459 #define pte_file(pte) (pte_val(pte) & PTE_FILE)
460 #define pte_to_pgoff(x) (pte_val(x) >> 3)
461 #define pgoff_to_pte(x) __pte(((x) << 3) | PTE_FILE)
463 #define PTE_FILE_MAX_BITS 55
465 extern int kern_addr_valid(unsigned long addr);
467 #include <asm-generic/pgtable.h>
469 #define pgtable_cache_init() do { } while (0)
471 #endif /* !__ASSEMBLY__ */
473 #endif /* __ASM_PGTABLE_H */