xref: /linux/arch/microblaze/include/asm/pgtable.h (revision 2d7eaeb05ae265bd64270376e6a2c0d80244771f)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2008-2009 Michal Simek <monstr@monstr.eu>
4  * Copyright (C) 2008-2009 PetaLogix
5  * Copyright (C) 2006 Atmark Techno, Inc.
6  */
7 
8 #ifndef _ASM_MICROBLAZE_PGTABLE_H
9 #define _ASM_MICROBLAZE_PGTABLE_H
10 
11 #include <asm/setup.h>
12 
13 #ifndef __ASSEMBLER__
14 extern int mem_init_done;
15 #endif
16 
17 #include <asm-generic/pgtable-nopmd.h>
18 
19 #ifdef __KERNEL__
20 #ifndef __ASSEMBLER__
21 
22 #include <linux/sched.h>
23 #include <linux/threads.h>
24 #include <asm/processor.h>		/* For TASK_SIZE */
25 #include <asm/mmu.h>
26 #include <asm/page.h>
27 
28 extern unsigned long va_to_phys(unsigned long address);
29 extern pte_t *va_to_pte(unsigned long address);
30 
31 /*
32  * The following only work if pte_present() is true.
33  * Undefined behaviour if not..
34  */
35 
36 /* Start and end of the vmalloc area. */
37 /* Make sure to map the vmalloc area above the pinned kernel memory area
38    of 32Mb.  */
39 #define VMALLOC_START	(CONFIG_KERNEL_START + CONFIG_LOWMEM_SIZE)
40 #define VMALLOC_END	ioremap_bot
41 
42 #endif /* __ASSEMBLER__ */
43 
44 /*
45  * Macro to mark a page protection value as "uncacheable".
46  */
47 
48 #define _PAGE_CACHE_CTL	(_PAGE_GUARDED | _PAGE_NO_CACHE | \
49 							_PAGE_WRITETHRU)
50 
51 #define pgprot_noncached(prot) \
52 			(__pgprot((pgprot_val(prot) & ~_PAGE_CACHE_CTL) | \
53 					_PAGE_NO_CACHE | _PAGE_GUARDED))
54 
55 #define pgprot_noncached_wc(prot) \
56 			 (__pgprot((pgprot_val(prot) & ~_PAGE_CACHE_CTL) | \
57 							_PAGE_NO_CACHE))
58 
59 /*
60  * The MicroBlaze MMU is identical to the PPC-40x MMU, and uses a hash
61  * table containing PTEs, together with a set of 16 segment registers, to
62  * define the virtual to physical address mapping.
63  *
64  * We use the hash table as an extended TLB, i.e. a cache of currently
65  * active mappings.  We maintain a two-level page table tree, much
66  * like that used by the i386, for the sake of the Linux memory
67  * management code.  Low-level assembler code in hashtable.S
68  * (procedure hash_page) is responsible for extracting ptes from the
69  * tree and putting them into the hash table when necessary, and
70  * updating the accessed and modified bits in the page table tree.
71  */
72 
73 /*
74  * The MicroBlaze processor has a TLB architecture identical to PPC-40x. The
75  * instruction and data sides share a unified, 64-entry, semi-associative
76  * TLB which is maintained totally under software control. In addition, the
77  * instruction side has a hardware-managed, 2,4, or 8-entry, fully-associative
78  * TLB which serves as a first level to the shared TLB. These two TLBs are
79  * known as the UTLB and ITLB, respectively (see "mmu.h" for definitions).
80  */
81 
82 /*
83  * The normal case is that PTEs are 32-bits and we have a 1-page
84  * 1024-entry pgdir pointing to 1-page 1024-entry PTE pages.  -- paulus
85  *
86  */
87 
88 /* PGDIR_SHIFT determines what a top-level page table entry can map */
89 #define PGDIR_SHIFT	(PAGE_SHIFT + PTE_SHIFT)
90 #define PGDIR_SIZE	(1UL << PGDIR_SHIFT)
91 #define PGDIR_MASK	(~(PGDIR_SIZE-1))
92 
93 /*
94  * entries per page directory level: our page-table tree is two-level, so
95  * we don't really have any PMD directory.
96  */
97 #define PTRS_PER_PTE	(1 << PTE_SHIFT)
98 #define PTRS_PER_PMD	1
99 #define PTRS_PER_PGD	(1 << (32 - PGDIR_SHIFT))
100 
101 #define USER_PTRS_PER_PGD	(TASK_SIZE / PGDIR_SIZE)
102 
103 #define USER_PGD_PTRS (PAGE_OFFSET >> PGDIR_SHIFT)
104 #define KERNEL_PGD_PTRS (PTRS_PER_PGD-USER_PGD_PTRS)
105 
106 /*
107  * Bits in a linux-style PTE.  These match the bits in the
108  * (hardware-defined) PTE as closely as possible.
109  */
110 
111 /* There are several potential gotchas here.  The hardware TLBLO
112  * field looks like this:
113  *
114  * 0  1  2  3  4  ... 18 19 20 21 22 23 24 25 26 27 28 29 30 31
115  * RPN.....................  0  0 EX WR ZSEL.......  W  I  M  G
116  *
117  * Where possible we make the Linux PTE bits match up with this
118  *
119  * - bits 20 and 21 must be cleared, because we use 4k pages (4xx can
120  * support down to 1k pages), this is done in the TLBMiss exception
121  * handler.
122  * - We use only zones 0 (for kernel pages) and 1 (for user pages)
123  * of the 16 available.  Bit 24-26 of the TLB are cleared in the TLB
124  * miss handler.  Bit 27 is PAGE_USER, thus selecting the correct
125  * zone.
126  * - PRESENT *must* be in the bottom two bits because swap PTEs use the top
127  * 30 bits.  Because 4xx doesn't support SMP anyway, M is irrelevant so we
128  * borrow it for PAGE_PRESENT.  Bit 30 is cleared in the TLB miss handler
129  * before the TLB entry is loaded.
130  * - All other bits of the PTE are loaded into TLBLO without
131  *  * modification, leaving us only the bits 20, 21, 24, 25, 26, 30 for
132  * software PTE bits.  We actually use bits 21, 24, 25, and
133  * 30 respectively for the software bits: ACCESSED, DIRTY, RW, and
134  * PRESENT.
135  */
136 
137 /* Definitions for MicroBlaze. */
138 #define	_PAGE_GUARDED	0x001	/* G: page is guarded from prefetch */
139 #define _PAGE_PRESENT	0x002	/* software: PTE contains a translation */
140 #define	_PAGE_NO_CACHE	0x004	/* I: caching is inhibited */
141 #define	_PAGE_WRITETHRU	0x008	/* W: caching is write-through */
142 #define	_PAGE_USER	0x010	/* matches one of the zone permission bits */
143 #define	_PAGE_RW	0x040	/* software: Writes permitted */
144 #define	_PAGE_DIRTY	0x080	/* software: dirty page */
145 #define _PAGE_HWWRITE	0x100	/* hardware: Dirty & RW, set in exception */
146 #define _PAGE_HWEXEC	0x200	/* hardware: EX permission */
147 #define _PAGE_ACCESSED	0x400	/* software: R: page referenced */
148 #define _PMD_PRESENT	PAGE_MASK
149 
150 /* We borrow bit 24 to store the exclusive marker in swap PTEs. */
151 #define _PAGE_SWP_EXCLUSIVE	_PAGE_DIRTY
152 
153 /*
154  * Some bits are unused...
155  */
156 #ifndef _PAGE_HASHPTE
157 #define _PAGE_HASHPTE	0
158 #endif
159 #ifndef _PTE_NONE_MASK
160 #define _PTE_NONE_MASK	0
161 #endif
162 #ifndef _PAGE_SHARED
163 #define _PAGE_SHARED	0
164 #endif
165 #ifndef _PAGE_EXEC
166 #define _PAGE_EXEC	0
167 #endif
168 
169 #define _PAGE_CHG_MASK	(PAGE_MASK | _PAGE_ACCESSED | _PAGE_DIRTY)
170 
171 /*
172  * Note: the _PAGE_COHERENT bit automatically gets set in the hardware
173  * PTE if CONFIG_SMP is defined (hash_page does this); there is no need
174  * to have it in the Linux PTE, and in fact the bit could be reused for
175  * another purpose.  -- paulus.
176  */
177 #define _PAGE_BASE	(_PAGE_PRESENT | _PAGE_ACCESSED)
178 #define _PAGE_WRENABLE	(_PAGE_RW | _PAGE_DIRTY | _PAGE_HWWRITE)
179 
180 #define _PAGE_KERNEL \
181 	(_PAGE_BASE | _PAGE_WRENABLE | _PAGE_SHARED | _PAGE_HWEXEC)
182 
183 #define _PAGE_IO	(_PAGE_KERNEL | _PAGE_NO_CACHE | _PAGE_GUARDED)
184 
185 #define PAGE_NONE	__pgprot(_PAGE_BASE)
186 #define PAGE_READONLY	__pgprot(_PAGE_BASE | _PAGE_USER)
187 #define PAGE_READONLY_X	__pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_EXEC)
188 #define PAGE_SHARED	__pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RW)
189 #define PAGE_SHARED_X \
190 		__pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_RW | _PAGE_EXEC)
191 #define PAGE_COPY	__pgprot(_PAGE_BASE | _PAGE_USER)
192 #define PAGE_COPY_X	__pgprot(_PAGE_BASE | _PAGE_USER | _PAGE_EXEC)
193 
194 #define PAGE_KERNEL	__pgprot(_PAGE_KERNEL)
195 #define PAGE_KERNEL_RO	__pgprot(_PAGE_BASE | _PAGE_SHARED)
196 #define PAGE_KERNEL_CI	__pgprot(_PAGE_IO)
197 
198 /*
199  * We consider execute permission the same as read.
200  * Also, write permissions imply read permissions.
201  */
202 
203 #define pte_none(pte)		((pte_val(pte) & ~_PTE_NONE_MASK) == 0)
204 #define pte_present(pte)	(pte_val(pte) & _PAGE_PRESENT)
205 #define pte_clear(mm, addr, ptep) \
206 	do { set_pte_at((mm), (addr), (ptep), __pte(0)); } while (0)
207 
208 #define pmd_none(pmd)		(!pmd_val(pmd))
209 #define	pmd_bad(pmd)		((pmd_val(pmd) & _PMD_PRESENT) == 0)
210 #define	pmd_present(pmd)	((pmd_val(pmd) & _PMD_PRESENT) != 0)
211 #define	pmd_clear(pmdp)		do { pmd_val(*(pmdp)) = 0; } while (0)
212 
213 #define pte_page(x)		(mem_map + (unsigned long) \
214 				((pte_val(x) - memory_start) >> PAGE_SHIFT))
215 #define PFN_PTE_SHIFT		PAGE_SHIFT
216 
217 #define pte_pfn(x)		(pte_val(x) >> PFN_PTE_SHIFT)
218 
219 #define pfn_pte(pfn, prot) \
220 	__pte(((pte_basic_t)(pfn) << PFN_PTE_SHIFT) | pgprot_val(prot))
221 
222 #ifndef __ASSEMBLER__
223 /*
224  * The following only work if pte_present() is true.
225  * Undefined behaviour if not..
226  */
227 static inline int pte_read(pte_t pte)  { return pte_val(pte) & _PAGE_USER; }
228 static inline int pte_write(pte_t pte) { return pte_val(pte) & _PAGE_RW; }
229 static inline int pte_exec(pte_t pte)  { return pte_val(pte) & _PAGE_EXEC; }
230 static inline int pte_dirty(pte_t pte) { return pte_val(pte) & _PAGE_DIRTY; }
231 static inline int pte_young(pte_t pte) { return pte_val(pte) & _PAGE_ACCESSED; }
232 
233 static inline void pte_uncache(pte_t pte) { pte_val(pte) |= _PAGE_NO_CACHE; }
234 static inline void pte_cache(pte_t pte)   { pte_val(pte) &= ~_PAGE_NO_CACHE; }
235 
236 static inline pte_t pte_rdprotect(pte_t pte) \
237 		{ pte_val(pte) &= ~_PAGE_USER; return pte; }
238 static inline pte_t pte_wrprotect(pte_t pte) \
239 	{ pte_val(pte) &= ~(_PAGE_RW | _PAGE_HWWRITE); return pte; }
240 static inline pte_t pte_exprotect(pte_t pte) \
241 	{ pte_val(pte) &= ~_PAGE_EXEC; return pte; }
242 static inline pte_t pte_mkclean(pte_t pte) \
243 	{ pte_val(pte) &= ~(_PAGE_DIRTY | _PAGE_HWWRITE); return pte; }
244 static inline pte_t pte_mkold(pte_t pte) \
245 	{ pte_val(pte) &= ~_PAGE_ACCESSED; return pte; }
246 
247 static inline pte_t pte_mkread(pte_t pte) \
248 	{ pte_val(pte) |= _PAGE_USER; return pte; }
249 static inline pte_t pte_mkexec(pte_t pte) \
250 	{ pte_val(pte) |= _PAGE_USER | _PAGE_EXEC; return pte; }
251 static inline pte_t pte_mkwrite_novma(pte_t pte) \
252 	{ pte_val(pte) |= _PAGE_RW; return pte; }
253 static inline pte_t pte_mkdirty(pte_t pte) \
254 	{ pte_val(pte) |= _PAGE_DIRTY; return pte; }
255 static inline pte_t pte_mkyoung(pte_t pte) \
256 	{ pte_val(pte) |= _PAGE_ACCESSED; return pte; }
257 
258 /*
259  * Conversion functions: convert a page and protection to a page entry,
260  * and a page entry and page directory to the page they refer to.
261  */
262 
263 static inline pte_t mk_pte_phys(phys_addr_t physpage, pgprot_t pgprot)
264 {
265 	pte_t pte;
266 	pte_val(pte) = physpage | pgprot_val(pgprot);
267 	return pte;
268 }
269 
270 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
271 {
272 	pte_val(pte) = (pte_val(pte) & _PAGE_CHG_MASK) | pgprot_val(newprot);
273 	return pte;
274 }
275 
276 /*
277  * Atomic PTE updates.
278  *
279  * pte_update clears and sets bit atomically, and returns
280  * the old pte value.
281  * The ((unsigned long)(p+1) - 4) hack is to get to the least-significant
282  * 32 bits of the PTE regardless of whether PTEs are 32 or 64 bits.
283  */
284 static inline unsigned long pte_update(pte_t *p, unsigned long clr,
285 				unsigned long set)
286 {
287 	unsigned long flags, old, tmp;
288 
289 	raw_local_irq_save(flags);
290 
291 	__asm__ __volatile__(	"lw	%0, %2, r0	\n"
292 				"andn	%1, %0, %3	\n"
293 				"or	%1, %1, %4	\n"
294 				"sw	%1, %2, r0	\n"
295 			: "=&r" (old), "=&r" (tmp)
296 			: "r" ((unsigned long)(p + 1) - 4), "r" (clr), "r" (set)
297 			: "cc");
298 
299 	raw_local_irq_restore(flags);
300 
301 	return old;
302 }
303 
304 /*
305  * set_pte stores a linux PTE into the linux page table.
306  */
307 static inline void set_pte(pte_t *ptep, pte_t pte)
308 {
309 	*ptep = pte;
310 }
311 
312 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
313 struct vm_area_struct;
314 static inline bool ptep_test_and_clear_young(struct vm_area_struct *vma,
315 		unsigned long address, pte_t *ptep)
316 {
317 	return (pte_update(ptep, _PAGE_ACCESSED, 0) & _PAGE_ACCESSED) != 0;
318 }
319 
320 static inline int ptep_test_and_clear_dirty(struct mm_struct *mm,
321 		unsigned long addr, pte_t *ptep)
322 {
323 	return (pte_update(ptep, \
324 		(_PAGE_DIRTY | _PAGE_HWWRITE), 0) & _PAGE_DIRTY) != 0;
325 }
326 
327 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
328 static inline pte_t ptep_get_and_clear(struct mm_struct *mm,
329 		unsigned long addr, pte_t *ptep)
330 {
331 	return __pte(pte_update(ptep, ~_PAGE_HASHPTE, 0));
332 }
333 
334 /*static inline void ptep_set_wrprotect(struct mm_struct *mm,
335 		unsigned long addr, pte_t *ptep)
336 {
337 	pte_update(ptep, (_PAGE_RW | _PAGE_HWWRITE), 0);
338 }*/
339 
340 static inline void ptep_mkdirty(struct mm_struct *mm,
341 		unsigned long addr, pte_t *ptep)
342 {
343 	pte_update(ptep, 0, _PAGE_DIRTY);
344 }
345 
346 /*#define pte_same(A,B)	(((pte_val(A) ^ pte_val(B)) & ~_PAGE_HASHPTE) == 0)*/
347 
348 /* Convert pmd entry to page */
349 /* our pmd entry is an effective address of pte table*/
350 /* returns effective address of the pmd entry*/
351 static inline unsigned long pmd_page_vaddr(pmd_t pmd)
352 {
353 	return ((unsigned long) (pmd_val(pmd) & PAGE_MASK));
354 }
355 
356 /* returns pfn of the pmd entry*/
357 #define pmd_pfn(pmd)	(__pa(pmd_val(pmd)) >> PAGE_SHIFT)
358 
359 /* returns struct *page of the pmd entry*/
360 #define pmd_page(pmd)	(pfn_to_page(__pa(pmd_val(pmd)) >> PAGE_SHIFT))
361 
362 /* Find an entry in the third-level page table.. */
363 
364 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
365 
366 /*
367  * Encode/decode swap entries and swap PTEs. Swap PTEs are all PTEs that
368  * are !pte_none() && !pte_present().
369  *
370  *                         1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
371  *   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
372  *   <------------------ offset -------------------> E < type -> 0 0
373  *
374  *   E is the exclusive marker that is not stored in swap entries.
375  */
376 #define __swp_type(entry)	((entry).val & 0x1f)
377 #define __swp_offset(entry)	((entry).val >> 6)
378 #define __swp_entry(type, offset) \
379 		((swp_entry_t) { ((type) & 0x1f) | ((offset) << 6) })
380 #define __pte_to_swp_entry(pte)	((swp_entry_t) { pte_val(pte) >> 2 })
381 #define __swp_entry_to_pte(x)	((pte_t) { (x).val << 2 })
382 
383 static inline bool pte_swp_exclusive(pte_t pte)
384 {
385 	return pte_val(pte) & _PAGE_SWP_EXCLUSIVE;
386 }
387 
388 static inline pte_t pte_swp_mkexclusive(pte_t pte)
389 {
390 	pte_val(pte) |= _PAGE_SWP_EXCLUSIVE;
391 	return pte;
392 }
393 
394 static inline pte_t pte_swp_clear_exclusive(pte_t pte)
395 {
396 	pte_val(pte) &= ~_PAGE_SWP_EXCLUSIVE;
397 	return pte;
398 }
399 
400 extern unsigned long iopa(unsigned long addr);
401 
402 /* Values for nocacheflag and cmode */
403 /* These are not used by the APUS kernel_map, but prevents
404  * compilation errors.
405  */
406 #define	IOMAP_FULL_CACHING	0
407 #define	IOMAP_NOCACHE_SER	1
408 #define	IOMAP_NOCACHE_NONSER	2
409 #define	IOMAP_NO_COPYBACK	3
410 
411 void do_page_fault(struct pt_regs *regs, unsigned long address,
412 		   unsigned long error_code);
413 
414 void mapin_ram(void);
415 int map_page(unsigned long va, phys_addr_t pa, int flags);
416 
417 extern int mem_init_done;
418 
419 asmlinkage void __init mmu_init(void);
420 
421 #endif /* __ASSEMBLER__ */
422 #endif /* __KERNEL__ */
423 
424 #ifndef __ASSEMBLER__
425 extern unsigned long ioremap_bot, ioremap_base;
426 
427 void setup_memory(void);
428 #endif /* __ASSEMBLER__ */
429 
430 #endif /* _ASM_MICROBLAZE_PGTABLE_H */
431