HACK: arm: keystone: add outer shareable attribute for pages/sections
[rpmsg/hwspinlock.git] / arch / arm / include / asm / pgtable-3level.h
1 /*
2  * arch/arm/include/asm/pgtable-3level.h
3  *
4  * Copyright (C) 2011 ARM Ltd.
5  * Author: Catalin Marinas <catalin.marinas@arm.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  */
20 #ifndef _ASM_PGTABLE_3LEVEL_H
21 #define _ASM_PGTABLE_3LEVEL_H
23 /*
24  * With LPAE, there are 3 levels of page tables. Each level has 512 entries of
25  * 8 bytes each, occupying a 4K page. The first level table covers a range of
26  * 512GB, each entry representing 1GB. Since we are limited to 4GB input
27  * address range, only 4 entries in the PGD are used.
28  *
29  * There are enough spare bits in a page table entry for the kernel specific
30  * state.
31  */
32 #define PTRS_PER_PTE            512
33 #define PTRS_PER_PMD            512
34 #define PTRS_PER_PGD            4
36 #define PTE_HWTABLE_PTRS        (0)
37 #define PTE_HWTABLE_OFF         (0)
38 #define PTE_HWTABLE_SIZE        (PTRS_PER_PTE * sizeof(u64))
40 /*
41  * PGDIR_SHIFT determines the size a top-level page table entry can map.
42  */
43 #define PGDIR_SHIFT             30
45 /*
46  * PMD_SHIFT determines the size a middle-level page table entry can map.
47  */
48 #define PMD_SHIFT               21
50 #define PMD_SIZE                (1UL << PMD_SHIFT)
51 #define PMD_MASK                (~((1 << PMD_SHIFT) - 1))
52 #define PGDIR_SIZE              (1UL << PGDIR_SHIFT)
53 #define PGDIR_MASK              (~((1 << PGDIR_SHIFT) - 1))
55 /*
56  * section address mask and size definitions.
57  */
58 #define SECTION_SHIFT           21
59 #define SECTION_SIZE            (1UL << SECTION_SHIFT)
60 #define SECTION_MASK            (~((1 << SECTION_SHIFT) - 1))
62 #define USER_PTRS_PER_PGD       (PAGE_OFFSET / PGDIR_SIZE)
64 /*
65  * Hugetlb definitions.
66  */
67 #define HPAGE_SHIFT             PMD_SHIFT
68 #define HPAGE_SIZE              (_AC(1, UL) << HPAGE_SHIFT)
69 #define HPAGE_MASK              (~(HPAGE_SIZE - 1))
70 #define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
72 /*
73  * "Linux" PTE definitions for LPAE.
74  *
75  * These bits overlap with the hardware bits but the naming is preserved for
76  * consistency with the classic page table format.
77  */
78 #define L_PTE_VALID             (_AT(pteval_t, 1) << 0)         /* Valid */
79 #define L_PTE_PRESENT           (_AT(pteval_t, 3) << 0)         /* Present */
80 #define L_PTE_USER              (_AT(pteval_t, 1) << 6)         /* AP[1] */
81 #ifdef CONFIG_KEYSTONE2_DMA_COHERENT
82 /* SH[1:0], outer shareable */
83 #define L_PTE_SHARED            (_AT(pteval_t, 2) << 8)
84 #else
85 #define L_PTE_SHARED            (_AT(pteval_t, 3) << 8)         /* SH[1:0], inner shareable */
86 #endif
87 #define L_PTE_YOUNG             (_AT(pteval_t, 1) << 10)        /* AF */
88 #define L_PTE_XN                (_AT(pteval_t, 1) << 54)        /* XN */
89 #define L_PTE_DIRTY             (_AT(pteval_t, 1) << 55)
90 #define L_PTE_SPECIAL           (_AT(pteval_t, 1) << 56)
91 #define L_PTE_NONE              (_AT(pteval_t, 1) << 57)        /* PROT_NONE */
92 #define L_PTE_RDONLY            (_AT(pteval_t, 1) << 58)        /* READ ONLY */
94 #define L_PMD_SECT_VALID        (_AT(pmdval_t, 1) << 0)
95 #define L_PMD_SECT_DIRTY        (_AT(pmdval_t, 1) << 55)
96 #define L_PMD_SECT_NONE         (_AT(pmdval_t, 1) << 57)
97 #define L_PMD_SECT_RDONLY       (_AT(pteval_t, 1) << 58)
99 /*
100  * To be used in assembly code with the upper page attributes.
101  */
102 #define L_PTE_XN_HIGH           (1 << (54 - 32))
103 #define L_PTE_DIRTY_HIGH        (1 << (55 - 32))
105 /*
106  * AttrIndx[2:0] encoding (mapping attributes defined in the MAIR* registers).
107  */
108 #define L_PTE_MT_UNCACHED       (_AT(pteval_t, 0) << 2) /* strongly ordered */
109 #define L_PTE_MT_BUFFERABLE     (_AT(pteval_t, 1) << 2) /* normal non-cacheable */
110 #define L_PTE_MT_WRITETHROUGH   (_AT(pteval_t, 2) << 2) /* normal inner write-through */
111 #define L_PTE_MT_WRITEBACK      (_AT(pteval_t, 3) << 2) /* normal inner write-back */
112 #define L_PTE_MT_WRITEALLOC     (_AT(pteval_t, 7) << 2) /* normal inner write-alloc */
113 #define L_PTE_MT_DEV_SHARED     (_AT(pteval_t, 4) << 2) /* device */
114 #define L_PTE_MT_DEV_NONSHARED  (_AT(pteval_t, 4) << 2) /* device */
115 #define L_PTE_MT_DEV_WC         (_AT(pteval_t, 1) << 2) /* normal non-cacheable */
116 #define L_PTE_MT_DEV_CACHED     (_AT(pteval_t, 3) << 2) /* normal inner write-back */
117 #define L_PTE_MT_MASK           (_AT(pteval_t, 7) << 2)
119 /*
120  * Software PGD flags.
121  */
122 #define L_PGD_SWAPPER           (_AT(pgdval_t, 1) << 55)        /* swapper_pg_dir entry */
124 /*
125  * 2nd stage PTE definitions for LPAE.
126  */
127 #define L_PTE_S2_MT_UNCACHED            (_AT(pteval_t, 0x0) << 2) /* strongly ordered */
128 #define L_PTE_S2_MT_WRITETHROUGH        (_AT(pteval_t, 0xa) << 2) /* normal inner write-through */
129 #define L_PTE_S2_MT_WRITEBACK           (_AT(pteval_t, 0xf) << 2) /* normal inner write-back */
130 #define L_PTE_S2_MT_DEV_SHARED          (_AT(pteval_t, 0x1) << 2) /* device */
131 #define L_PTE_S2_MT_MASK                (_AT(pteval_t, 0xf) << 2)
133 #define L_PTE_S2_RDONLY                 (_AT(pteval_t, 1) << 6)   /* HAP[1]   */
134 #define L_PTE_S2_RDWR                   (_AT(pteval_t, 3) << 6)   /* HAP[2:1] */
136 #define L_PMD_S2_RDONLY                 (_AT(pmdval_t, 1) << 6)   /* HAP[1]   */
137 #define L_PMD_S2_RDWR                   (_AT(pmdval_t, 3) << 6)   /* HAP[2:1] */
139 /*
140  * Hyp-mode PL2 PTE definitions for LPAE.
141  */
142 #define L_PTE_HYP               L_PTE_USER
144 #ifndef __ASSEMBLY__
146 #define pud_none(pud)           (!pud_val(pud))
147 #define pud_bad(pud)            (!(pud_val(pud) & 2))
148 #define pud_present(pud)        (pud_val(pud))
149 #define pmd_table(pmd)          ((pmd_val(pmd) & PMD_TYPE_MASK) == \
150                                                  PMD_TYPE_TABLE)
151 #define pmd_sect(pmd)           ((pmd_val(pmd) & PMD_TYPE_MASK) == \
152                                                  PMD_TYPE_SECT)
153 #define pmd_large(pmd)          pmd_sect(pmd)
155 #define pud_clear(pudp)                 \
156         do {                            \
157                 *pudp = __pud(0);       \
158                 clean_pmd_entry(pudp);  \
159         } while (0)
161 #define set_pud(pudp, pud)              \
162         do {                            \
163                 *pudp = pud;            \
164                 flush_pmd_entry(pudp);  \
165         } while (0)
167 static inline pmd_t *pud_page_vaddr(pud_t pud)
169         return __va(pud_val(pud) & PHYS_MASK & (s32)PAGE_MASK);
172 /* Find an entry in the second-level page table.. */
173 #define pmd_index(addr)         (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
174 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long addr)
176         return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(addr);
179 #define pmd_bad(pmd)            (!(pmd_val(pmd) & 2))
181 #define copy_pmd(pmdpd,pmdps)           \
182         do {                            \
183                 *pmdpd = *pmdps;        \
184                 flush_pmd_entry(pmdpd); \
185         } while (0)
187 #define pmd_clear(pmdp)                 \
188         do {                            \
189                 *pmdp = __pmd(0);       \
190                 clean_pmd_entry(pmdp);  \
191         } while (0)
193 /*
194  * For 3 levels of paging the PTE_EXT_NG bit will be set for user address ptes
195  * that are written to a page table but not for ptes created with mk_pte.
196  *
197  * In hugetlb_no_page, a new huge pte (new_pte) is generated and passed to
198  * hugetlb_cow, where it is compared with an entry in a page table.
199  * This comparison test fails erroneously leading ultimately to a memory leak.
200  *
201  * To correct this behaviour, we mask off PTE_EXT_NG for any pte that is
202  * present before running the comparison.
203  */
204 #define __HAVE_ARCH_PTE_SAME
205 #define pte_same(pte_a,pte_b)   ((pte_present(pte_a) ? pte_val(pte_a) & ~PTE_EXT_NG     \
206                                         : pte_val(pte_a))                               \
207                                 == (pte_present(pte_b) ? pte_val(pte_b) & ~PTE_EXT_NG   \
208                                         : pte_val(pte_b)))
210 #define set_pte_ext(ptep,pte,ext) cpu_set_pte_ext(ptep,__pte(pte_val(pte)|(ext)))
212 #define pte_huge(pte)           (pte_val(pte) && !(pte_val(pte) & PTE_TABLE_BIT))
213 #define pte_mkhuge(pte)         (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
215 #define pmd_isset(pmd, val)     ((u32)(val) == (val) ? pmd_val(pmd) & (val) \
216                                                 : !!(pmd_val(pmd) & (val)))
217 #define pmd_isclear(pmd, val)   (!(pmd_val(pmd) & (val)))
219 #define pmd_present(pmd)        (pmd_isset((pmd), L_PMD_SECT_VALID))
220 #define pmd_young(pmd)          (pmd_isset((pmd), PMD_SECT_AF))
221 #define pte_special(pte)        (pte_isset((pte), L_PTE_SPECIAL))
222 static inline pte_t pte_mkspecial(pte_t pte)
224         pte_val(pte) |= L_PTE_SPECIAL;
225         return pte;
228 #define pmd_write(pmd)          (pmd_isclear((pmd), L_PMD_SECT_RDONLY))
229 #define pmd_dirty(pmd)          (pmd_isset((pmd), L_PMD_SECT_DIRTY))
230 #define pud_page(pud)           pmd_page(__pmd(pud_val(pud)))
231 #define pud_write(pud)          pmd_write(__pmd(pud_val(pud)))
233 #define pmd_hugewillfault(pmd)  (!pmd_young(pmd) || !pmd_write(pmd))
234 #define pmd_thp_or_huge(pmd)    (pmd_huge(pmd) || pmd_trans_huge(pmd))
236 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
237 #define pmd_trans_huge(pmd)     (pmd_val(pmd) && !pmd_table(pmd))
238 #endif
240 #define PMD_BIT_FUNC(fn,op) \
241 static inline pmd_t pmd_##fn(pmd_t pmd) { pmd_val(pmd) op; return pmd; }
243 PMD_BIT_FUNC(wrprotect, |= L_PMD_SECT_RDONLY);
244 PMD_BIT_FUNC(mkold,     &= ~PMD_SECT_AF);
245 PMD_BIT_FUNC(mkwrite,   &= ~L_PMD_SECT_RDONLY);
246 PMD_BIT_FUNC(mkdirty,   |= L_PMD_SECT_DIRTY);
247 PMD_BIT_FUNC(mkclean,   &= ~L_PMD_SECT_DIRTY);
248 PMD_BIT_FUNC(mkyoung,   |= PMD_SECT_AF);
250 #define pmd_mkhuge(pmd)         (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
252 #define pmd_pfn(pmd)            (((pmd_val(pmd) & PMD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
253 #define pfn_pmd(pfn,prot)       (__pmd(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
254 #define mk_pmd(page,prot)       pfn_pmd(page_to_pfn(page),prot)
256 /* No hardware dirty/accessed bits -- generic_pmdp_establish() fits */
257 #define pmdp_establish generic_pmdp_establish
259 /* represent a notpresent pmd by faulting entry, this is used by pmdp_invalidate */
260 static inline pmd_t pmd_mknotpresent(pmd_t pmd)
262         return __pmd(pmd_val(pmd) & ~L_PMD_SECT_VALID);
265 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
267         const pmdval_t mask = PMD_SECT_USER | PMD_SECT_XN | L_PMD_SECT_RDONLY |
268                                 L_PMD_SECT_VALID | L_PMD_SECT_NONE;
269         pmd_val(pmd) = (pmd_val(pmd) & ~mask) | (pgprot_val(newprot) & mask);
270         return pmd;
273 static inline void set_pmd_at(struct mm_struct *mm, unsigned long addr,
274                               pmd_t *pmdp, pmd_t pmd)
276         BUG_ON(addr >= TASK_SIZE);
278         /* create a faulting entry if PROT_NONE protected */
279         if (pmd_val(pmd) & L_PMD_SECT_NONE)
280                 pmd_val(pmd) &= ~L_PMD_SECT_VALID;
282         if (pmd_write(pmd) && pmd_dirty(pmd))
283                 pmd_val(pmd) &= ~PMD_SECT_AP2;
284         else
285                 pmd_val(pmd) |= PMD_SECT_AP2;
287         *pmdp = __pmd(pmd_val(pmd) | PMD_SECT_nG);
288         flush_pmd_entry(pmdp);
291 #endif /* __ASSEMBLY__ */
293 #endif /* _ASM_PGTABLE_3LEVEL_H */