arm64: Introduce VA_BITS and translation level options
[linux-2.6-block.git] / arch / arm64 / include / asm / pgtable.h
CommitLineData
4f04d8f0
CM
1/*
2 * Copyright (C) 2012 ARM Ltd.
3 *
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.
7 *
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.
12 *
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/>.
15 */
16#ifndef __ASM_PGTABLE_H
17#define __ASM_PGTABLE_H
18
19#include <asm/proc-fns.h>
20
21#include <asm/memory.h>
22#include <asm/pgtable-hwdef.h>
23
24/*
25 * Software defined PTE bits definition.
26 */
a6fadf7e 27#define PTE_VALID (_AT(pteval_t, 1) << 0)
3676f9ef 28#define PTE_FILE (_AT(pteval_t, 1) << 2) /* only when !pte_present() */
4f04d8f0
CM
29#define PTE_DIRTY (_AT(pteval_t, 1) << 55)
30#define PTE_SPECIAL (_AT(pteval_t, 1) << 56)
c2c93e5b 31#define PTE_WRITE (_AT(pteval_t, 1) << 57)
3676f9ef 32#define PTE_PROT_NONE (_AT(pteval_t, 1) << 58) /* only when !PTE_VALID */
4f04d8f0
CM
33
34/*
35 * VMALLOC and SPARSEMEM_VMEMMAP ranges.
36 */
847264fb 37#define VMALLOC_START (UL(0xffffffffffffffff) << VA_BITS)
4f04d8f0
CM
38#define VMALLOC_END (PAGE_OFFSET - UL(0x400000000) - SZ_64K)
39
40#define vmemmap ((struct page *)(VMALLOC_END + SZ_64K))
41
42#define FIRST_USER_ADDRESS 0
43
44#ifndef __ASSEMBLY__
45extern void __pte_error(const char *file, int line, unsigned long val);
46extern void __pmd_error(const char *file, int line, unsigned long val);
47extern void __pgd_error(const char *file, int line, unsigned long val);
48
49#define pte_ERROR(pte) __pte_error(__FILE__, __LINE__, pte_val(pte))
e41ceed0 50#ifndef CONFIG_ARM64_2_LEVELS
4f04d8f0
CM
51#define pmd_ERROR(pmd) __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
52#endif
53#define pgd_ERROR(pgd) __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
54
a501e324
CM
55#ifdef CONFIG_SMP
56#define PROT_DEFAULT (PTE_TYPE_PAGE | PTE_AF | PTE_SHARED)
57#define PROT_SECT_DEFAULT (PMD_TYPE_SECT | PMD_SECT_AF | PMD_SECT_S)
58#else
59#define PROT_DEFAULT (PTE_TYPE_PAGE | PTE_AF)
60#define PROT_SECT_DEFAULT (PMD_TYPE_SECT | PMD_SECT_AF)
61#endif
4f04d8f0 62
a501e324
CM
63#define PROT_DEVICE_nGnRE (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_DEVICE_nGnRE))
64#define PROT_NORMAL_NC (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL_NC))
65#define PROT_NORMAL (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL))
4f04d8f0 66
a501e324
CM
67#define PROT_SECT_DEVICE_nGnRE (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_DEVICE_nGnRE))
68#define PROT_SECT_NORMAL (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
69#define PROT_SECT_NORMAL_EXEC (PROT_SECT_DEFAULT | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
a6fadf7e 70
a501e324 71#define _PAGE_DEFAULT (PROT_DEFAULT | PTE_ATTRINDX(MT_NORMAL))
4f04d8f0 72
a501e324
CM
73#define PAGE_KERNEL __pgprot(_PAGE_DEFAULT | PTE_PXN | PTE_UXN | PTE_DIRTY | PTE_WRITE)
74#define PAGE_KERNEL_EXEC __pgprot(_PAGE_DEFAULT | PTE_UXN | PTE_DIRTY | PTE_WRITE)
8e620b04 75
a501e324 76#define PAGE_HYP __pgprot(_PAGE_DEFAULT | PTE_HYP)
36311607
MZ
77#define PAGE_HYP_DEVICE __pgprot(PROT_DEVICE_nGnRE | PTE_HYP)
78
a501e324 79#define PAGE_S2 __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_NORMAL) | PTE_S2_RDONLY)
36311607
MZ
80#define PAGE_S2_DEVICE __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_DEVICE_nGnRE) | PTE_S2_RDWR | PTE_UXN)
81
a501e324
CM
82#define PAGE_NONE __pgprot(((_PAGE_DEFAULT) & ~PTE_TYPE_MASK) | PTE_PROT_NONE | PTE_PXN | PTE_UXN)
83#define PAGE_SHARED __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN | PTE_WRITE)
84#define PAGE_SHARED_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_WRITE)
85#define PAGE_COPY __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
86#define PAGE_COPY_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
87#define PAGE_READONLY __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
88#define PAGE_READONLY_EXEC __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
a501e324
CM
89
90#define __P000 PAGE_NONE
91#define __P001 PAGE_READONLY
92#define __P010 PAGE_COPY
93#define __P011 PAGE_COPY
5a0fdfad 94#define __P100 PAGE_READONLY_EXEC
a501e324
CM
95#define __P101 PAGE_READONLY_EXEC
96#define __P110 PAGE_COPY_EXEC
97#define __P111 PAGE_COPY_EXEC
98
99#define __S000 PAGE_NONE
100#define __S001 PAGE_READONLY
101#define __S010 PAGE_SHARED
102#define __S011 PAGE_SHARED
5a0fdfad 103#define __S100 PAGE_READONLY_EXEC
a501e324
CM
104#define __S101 PAGE_READONLY_EXEC
105#define __S110 PAGE_SHARED_EXEC
106#define __S111 PAGE_SHARED_EXEC
4f04d8f0 107
4f04d8f0
CM
108/*
109 * ZERO_PAGE is a global shared page that is always zero: used
110 * for zero-mapped memory areas etc..
111 */
112extern struct page *empty_zero_page;
113#define ZERO_PAGE(vaddr) (empty_zero_page)
114
115#define pte_pfn(pte) ((pte_val(pte) & PHYS_MASK) >> PAGE_SHIFT)
116
117#define pfn_pte(pfn,prot) (__pte(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
118
119#define pte_none(pte) (!pte_val(pte))
120#define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
121#define pte_page(pte) (pfn_to_page(pte_pfn(pte)))
9ab6d02f 122#define pte_offset_kernel(dir,addr) (pmd_page_vaddr(*(dir)) + pte_index(addr))
4f04d8f0
CM
123
124#define pte_offset_map(dir,addr) pte_offset_kernel((dir), (addr))
125#define pte_offset_map_nested(dir,addr) pte_offset_kernel((dir), (addr))
126#define pte_unmap(pte) do { } while (0)
127#define pte_unmap_nested(pte) do { } while (0)
128
129/*
130 * The following only work if pte_present(). Undefined behaviour otherwise.
131 */
84fe6826
SC
132#define pte_present(pte) (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
133#define pte_dirty(pte) (!!(pte_val(pte) & PTE_DIRTY))
134#define pte_young(pte) (!!(pte_val(pte) & PTE_AF))
135#define pte_special(pte) (!!(pte_val(pte) & PTE_SPECIAL))
136#define pte_write(pte) (!!(pte_val(pte) & PTE_WRITE))
8e620b04 137#define pte_exec(pte) (!(pte_val(pte) & PTE_UXN))
4f04d8f0 138
a6fadf7e 139#define pte_valid_user(pte) \
02522463 140 ((pte_val(pte) & (PTE_VALID | PTE_USER)) == (PTE_VALID | PTE_USER))
4f04d8f0 141
44b6dfc5
SC
142static inline pte_t pte_wrprotect(pte_t pte)
143{
c2c93e5b 144 pte_val(pte) &= ~PTE_WRITE;
44b6dfc5
SC
145 return pte;
146}
147
148static inline pte_t pte_mkwrite(pte_t pte)
149{
c2c93e5b 150 pte_val(pte) |= PTE_WRITE;
44b6dfc5
SC
151 return pte;
152}
153
154static inline pte_t pte_mkclean(pte_t pte)
155{
156 pte_val(pte) &= ~PTE_DIRTY;
157 return pte;
158}
159
160static inline pte_t pte_mkdirty(pte_t pte)
161{
162 pte_val(pte) |= PTE_DIRTY;
163 return pte;
164}
165
166static inline pte_t pte_mkold(pte_t pte)
167{
168 pte_val(pte) &= ~PTE_AF;
169 return pte;
170}
171
172static inline pte_t pte_mkyoung(pte_t pte)
173{
174 pte_val(pte) |= PTE_AF;
175 return pte;
176}
177
178static inline pte_t pte_mkspecial(pte_t pte)
179{
180 pte_val(pte) |= PTE_SPECIAL;
181 return pte;
182}
4f04d8f0
CM
183
184static inline void set_pte(pte_t *ptep, pte_t pte)
185{
186 *ptep = pte;
187}
188
189extern void __sync_icache_dcache(pte_t pteval, unsigned long addr);
190
191static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
192 pte_t *ptep, pte_t pte)
193{
a6fadf7e 194 if (pte_valid_user(pte)) {
71fdb6bf 195 if (!pte_special(pte) && pte_exec(pte))
02522463 196 __sync_icache_dcache(pte, addr);
c2c93e5b
SC
197 if (pte_dirty(pte) && pte_write(pte))
198 pte_val(pte) &= ~PTE_RDONLY;
199 else
200 pte_val(pte) |= PTE_RDONLY;
02522463
WD
201 }
202
4f04d8f0
CM
203 set_pte(ptep, pte);
204}
205
206/*
207 * Huge pte definitions.
208 */
084bd298
SC
209#define pte_huge(pte) (!(pte_val(pte) & PTE_TABLE_BIT))
210#define pte_mkhuge(pte) (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
211
212/*
213 * Hugetlb definitions.
214 */
215#define HUGE_MAX_HSTATE 2
216#define HPAGE_SHIFT PMD_SHIFT
217#define HPAGE_SIZE (_AC(1, UL) << HPAGE_SHIFT)
218#define HPAGE_MASK (~(HPAGE_SIZE - 1))
219#define HUGETLB_PAGE_ORDER (HPAGE_SHIFT - PAGE_SHIFT)
4f04d8f0 220
4f04d8f0
CM
221#define __HAVE_ARCH_PTE_SPECIAL
222
9c7e535f
SC
223static inline pte_t pmd_pte(pmd_t pmd)
224{
225 return __pte(pmd_val(pmd));
226}
af074848 227
9c7e535f
SC
228static inline pmd_t pte_pmd(pte_t pte)
229{
230 return __pmd(pte_val(pte));
231}
af074848
SC
232
233/*
234 * THP definitions.
235 */
af074848
SC
236
237#ifdef CONFIG_TRANSPARENT_HUGEPAGE
238#define pmd_trans_huge(pmd) (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
9c7e535f 239#define pmd_trans_splitting(pmd) pte_special(pmd_pte(pmd))
af074848
SC
240#endif
241
9c7e535f
SC
242#define pmd_young(pmd) pte_young(pmd_pte(pmd))
243#define pmd_wrprotect(pmd) pte_pmd(pte_wrprotect(pmd_pte(pmd)))
244#define pmd_mksplitting(pmd) pte_pmd(pte_mkspecial(pmd_pte(pmd)))
245#define pmd_mkold(pmd) pte_pmd(pte_mkold(pmd_pte(pmd)))
246#define pmd_mkwrite(pmd) pte_pmd(pte_mkwrite(pmd_pte(pmd)))
247#define pmd_mkdirty(pmd) pte_pmd(pte_mkdirty(pmd_pte(pmd)))
248#define pmd_mkyoung(pmd) pte_pmd(pte_mkyoung(pmd_pte(pmd)))
e3a920af 249#define pmd_mknotpresent(pmd) (__pmd(pmd_val(pmd) & ~PMD_TYPE_MASK))
af074848 250
9c7e535f
SC
251#define __HAVE_ARCH_PMD_WRITE
252#define pmd_write(pmd) pte_write(pmd_pte(pmd))
af074848
SC
253
254#define pmd_mkhuge(pmd) (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
255
256#define pmd_pfn(pmd) (((pmd_val(pmd) & PMD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
257#define pfn_pmd(pfn,prot) (__pmd(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
258#define mk_pmd(page,prot) pfn_pmd(page_to_pfn(page),prot)
259
260#define pmd_page(pmd) pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
206a2a73 261#define pud_pfn(pud) (((pud_val(pud) & PUD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
af074848 262
ceb21835 263#define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
af074848
SC
264
265static inline int has_transparent_hugepage(void)
266{
267 return 1;
268}
269
a501e324
CM
270#define __pgprot_modify(prot,mask,bits) \
271 __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
272
4f04d8f0
CM
273/*
274 * Mark the prot value as uncacheable and unbufferable.
275 */
276#define pgprot_noncached(prot) \
de2db743 277 __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
4f04d8f0 278#define pgprot_writecombine(prot) \
de2db743 279 __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
4f04d8f0
CM
280#define __HAVE_PHYS_MEM_ACCESS_PROT
281struct file;
282extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
283 unsigned long size, pgprot_t vma_prot);
284
285#define pmd_none(pmd) (!pmd_val(pmd))
286#define pmd_present(pmd) (pmd_val(pmd))
287
288#define pmd_bad(pmd) (!(pmd_val(pmd) & 2))
289
36311607
MZ
290#define pmd_table(pmd) ((pmd_val(pmd) & PMD_TYPE_MASK) == \
291 PMD_TYPE_TABLE)
292#define pmd_sect(pmd) ((pmd_val(pmd) & PMD_TYPE_MASK) == \
293 PMD_TYPE_SECT)
294
f3b766a2 295#ifdef CONFIG_ARM64_64K_PAGES
206a2a73
SC
296#define pud_sect(pud) (0)
297#else
298#define pud_sect(pud) ((pud_val(pud) & PUD_TYPE_MASK) == \
299 PUD_TYPE_SECT)
300#endif
36311607 301
4f04d8f0
CM
302static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
303{
304 *pmdp = pmd;
98f7685e 305 dsb(ishst);
4f04d8f0
CM
306}
307
308static inline void pmd_clear(pmd_t *pmdp)
309{
310 set_pmd(pmdp, __pmd(0));
311}
312
313static inline pte_t *pmd_page_vaddr(pmd_t pmd)
314{
315 return __va(pmd_val(pmd) & PHYS_MASK & (s32)PAGE_MASK);
316}
317
318#define pmd_page(pmd) pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
319
320/*
321 * Conversion functions: convert a page and protection to a page entry,
322 * and a page entry and page directory to the page they refer to.
323 */
324#define mk_pte(page,prot) pfn_pte(page_to_pfn(page),prot)
325
e41ceed0 326#ifndef CONFIG_ARM64_2_LEVELS
4f04d8f0
CM
327
328#define pud_none(pud) (!pud_val(pud))
329#define pud_bad(pud) (!(pud_val(pud) & 2))
330#define pud_present(pud) (pud_val(pud))
331
332static inline void set_pud(pud_t *pudp, pud_t pud)
333{
334 *pudp = pud;
98f7685e 335 dsb(ishst);
4f04d8f0
CM
336}
337
338static inline void pud_clear(pud_t *pudp)
339{
340 set_pud(pudp, __pud(0));
341}
342
343static inline pmd_t *pud_page_vaddr(pud_t pud)
344{
345 return __va(pud_val(pud) & PHYS_MASK & (s32)PAGE_MASK);
346}
347
e41ceed0 348#endif /* CONFIG_ARM64_2_LEVELS */
4f04d8f0
CM
349
350/* to find an entry in a page-table-directory */
351#define pgd_index(addr) (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
352
353#define pgd_offset(mm, addr) ((mm)->pgd+pgd_index(addr))
354
355/* to find an entry in a kernel page-table-directory */
356#define pgd_offset_k(addr) pgd_offset(&init_mm, addr)
357
358/* Find an entry in the second-level page table.. */
e41ceed0 359#ifndef CONFIG_ARM64_2_LEVELS
4f04d8f0
CM
360#define pmd_index(addr) (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
361static inline pmd_t *pmd_offset(pud_t *pud, unsigned long addr)
362{
363 return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(addr);
364}
365#endif
366
367/* Find an entry in the third-level page table.. */
9ab6d02f 368#define pte_index(addr) (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
4f04d8f0
CM
369
370static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
371{
a6fadf7e 372 const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
c2c93e5b 373 PTE_PROT_NONE | PTE_VALID | PTE_WRITE;
4f04d8f0
CM
374 pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
375 return pte;
376}
377
9c7e535f
SC
378static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
379{
380 return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
381}
382
4f04d8f0
CM
383extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
384extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
385
4f04d8f0
CM
386/*
387 * Encode and decode a swap entry:
3676f9ef
CM
388 * bits 0-1: present (must be zero)
389 * bit 2: PTE_FILE
390 * bits 3-8: swap type
391 * bits 9-57: swap offset
4f04d8f0 392 */
3676f9ef 393#define __SWP_TYPE_SHIFT 3
4f04d8f0 394#define __SWP_TYPE_BITS 6
3676f9ef 395#define __SWP_OFFSET_BITS 49
4f04d8f0
CM
396#define __SWP_TYPE_MASK ((1 << __SWP_TYPE_BITS) - 1)
397#define __SWP_OFFSET_SHIFT (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
3676f9ef 398#define __SWP_OFFSET_MASK ((1UL << __SWP_OFFSET_BITS) - 1)
4f04d8f0
CM
399
400#define __swp_type(x) (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
3676f9ef 401#define __swp_offset(x) (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
4f04d8f0
CM
402#define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
403
404#define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
405#define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
406
407/*
408 * Ensure that there are not more swap files than can be encoded in the kernel
aad9061b 409 * PTEs.
4f04d8f0
CM
410 */
411#define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
412
413/*
414 * Encode and decode a file entry:
3676f9ef
CM
415 * bits 0-1: present (must be zero)
416 * bit 2: PTE_FILE
417 * bits 3-57: file offset / PAGE_SIZE
4f04d8f0
CM
418 */
419#define pte_file(pte) (pte_val(pte) & PTE_FILE)
3676f9ef
CM
420#define pte_to_pgoff(x) (pte_val(x) >> 3)
421#define pgoff_to_pte(x) __pte(((x) << 3) | PTE_FILE)
4f04d8f0 422
3676f9ef 423#define PTE_FILE_MAX_BITS 55
4f04d8f0
CM
424
425extern int kern_addr_valid(unsigned long addr);
426
427#include <asm-generic/pgtable.h>
428
4f04d8f0
CM
429#define pgtable_cache_init() do { } while (0)
430
431#endif /* !__ASSEMBLY__ */
432
433#endif /* __ASM_PGTABLE_H */