ARC: mm: disintegrate pgtable.h into levels and flags
[linux-2.6-microblaze.git] / arch / arc / include / asm / pgtable-levels.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2020 Synopsys, Inc. (www.synopsys.com)
4  */
5
6 /*
7  * Helpers for implemenintg paging levels
8  */
9
10 #ifndef _ASM_ARC_PGTABLE_LEVELS_H
11 #define _ASM_ARC_PGTABLE_LEVELS_H
12
13 /*
14  * 2 level paging setup for software walked MMUv3 (ARC700) and MMUv4 (HS)
15  *
16  * [31]            32 bit virtual address              [0]
17  * -------------------------------------------------------
18  * |               | <---------- PGDIR_SHIFT ----------> |
19  * |               |                | <-- PAGE_SHIFT --> |
20  * -------------------------------------------------------
21  *       |                  |                |
22  *       |                  |                --> off in page frame
23  *       |                  ---> index into Page Table
24  *       ----> index into Page Directory
25  *
26  * Given software walk, the vaddr split is arbitrary set to 11:8:13
27  * However enabling of super page in a 2 level regime pegs PGDIR_SHIFT to
28  * super page size.
29  */
30
31 #if defined(CONFIG_ARC_HUGEPAGE_16M)
32 #define PGDIR_SHIFT             24
33 #elif defined(CONFIG_ARC_HUGEPAGE_2M)
34 #define PGDIR_SHIFT             21
35 #else
36 /*
37  * No Super page case
38  * Default value provides 11:8:13 (8K), 11:9:12 (4K)
39  */
40 #define PGDIR_SHIFT             21
41
42 #endif
43
44 #define PGDIR_SIZE              BIT(PGDIR_SHIFT)        /* vaddr span, not PDG sz */
45 #define PGDIR_MASK              (~(PGDIR_SIZE - 1))
46
47 #define PTRS_PER_PGD            BIT(32 - PGDIR_SHIFT)
48
49 #define PTRS_PER_PTE            BIT(PGDIR_SHIFT - PAGE_SHIFT)
50
51 #ifndef __ASSEMBLY__
52
53 #include <asm-generic/pgtable-nopmd.h>
54
55 /*
56  * 1st level paging: pgd
57  */
58 #define pgd_index(addr)         ((addr) >> PGDIR_SHIFT)
59 #define pgd_offset(mm, addr)    (((mm)->pgd) + pgd_index(addr))
60 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
61 #define pgd_ERROR(e) \
62         pr_crit("%s:%d: bad pgd %08lx.\n", __FILE__, __LINE__, pgd_val(e))
63
64 /*
65  * Due to the strange way generic pgtable level folding works, in a 2 level
66  * setup, pmd_val() returns pgd, so these pmd_* macros actually work on pgd
67  */
68 #define pmd_none(x)             (!pmd_val(x))
69 #define pmd_bad(x)              ((pmd_val(x) & ~PAGE_MASK))
70 #define pmd_present(x)          (pmd_val(x))
71 #define pmd_clear(xp)           do { pmd_val(*(xp)) = 0; } while (0)
72 #define pmd_page_vaddr(pmd)     (pmd_val(pmd) & PAGE_MASK)
73 #define pmd_page(pmd)           virt_to_page(pmd_page_vaddr(pmd))
74 #define set_pmd(pmdp, pmd)      (*(pmdp) = pmd)
75 #define pmd_pgtable(pmd)        ((pgtable_t) pmd_page_vaddr(pmd))
76
77 #define pte_ERROR(e) \
78         pr_crit("%s:%d: bad pte %08lx.\n", __FILE__, __LINE__, pte_val(e))
79
80 #define pte_none(x)             (!pte_val(x))
81 #define pte_present(x)          (pte_val(x) & _PAGE_PRESENT)
82 #define pte_clear(mm,addr,ptep) set_pte_at(mm, addr, ptep, __pte(0))
83 #define pte_page(pte)           pfn_to_page(pte_pfn(pte))
84 #define set_pte(ptep, pte)      ((*(ptep)) = (pte))
85 #define pte_pfn(pte)            (pte_val(pte) >> PAGE_SHIFT)
86 #define pfn_pte(pfn, prot)      __pte(__pfn_to_phys(pfn) | pgprot_val(prot))
87 #define mk_pte(page, prot)      pfn_pte(page_to_pfn(page), prot)
88
89 #ifdef CONFIG_ISA_ARCV2
90 #define pmd_leaf(x)             (pmd_val(x) & _PAGE_HW_SZ)
91 #endif
92
93 #endif  /* !__ASSEMBLY__ */
94
95 #endif