1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _SUN3_PGTABLE_H
3#define _SUN3_PGTABLE_H
4
5#include <asm/sun3mmu.h>
6
7#ifndef __ASSEMBLY__
8#include <asm/virtconvert.h>
9#include <linux/linkage.h>
10
11/*
12 * This file contains all the things which change drastically for the sun3
13 * pagetable stuff, to avoid making too much of a mess of the generic m68k
14 * `pgtable.h'; this should only be included from the generic file. --m
15 */
16
17/* For virtual address to physical address conversion */
18#define VTOP(addr)	__pa(addr)
19#define PTOV(addr)	__va(addr)
20
21
22#endif	/* !__ASSEMBLY__ */
23
24/* These need to be defined for compatibility although the sun3 doesn't use them */
25#define _PAGE_NOCACHE030 0x040
26#define _CACHEMASK040   (~0x060)
27#define _PAGE_NOCACHE_S 0x040
28
29/* Page protection values within PTE. */
30#define SUN3_PAGE_VALID     (0x80000000)
31#define SUN3_PAGE_WRITEABLE (0x40000000)
32#define SUN3_PAGE_SYSTEM    (0x20000000)
33#define SUN3_PAGE_NOCACHE   (0x10000000)
34#define SUN3_PAGE_ACCESSED  (0x02000000)
35#define SUN3_PAGE_MODIFIED  (0x01000000)
36
37
38/* Externally used page protection values. */
39#define _PAGE_PRESENT	(SUN3_PAGE_VALID)
40#define _PAGE_ACCESSED	(SUN3_PAGE_ACCESSED)
41
42/* Compound page protection values. */
43//todo: work out which ones *should* have SUN3_PAGE_NOCACHE and fix...
44// is it just PAGE_KERNEL and PAGE_SHARED?
45#define PAGE_NONE	__pgprot(SUN3_PAGE_VALID \
46				 | SUN3_PAGE_ACCESSED \
47				 | SUN3_PAGE_NOCACHE)
48#define PAGE_SHARED	__pgprot(SUN3_PAGE_VALID \
49				 | SUN3_PAGE_WRITEABLE \
50				 | SUN3_PAGE_ACCESSED \
51				 | SUN3_PAGE_NOCACHE)
52#define PAGE_COPY	__pgprot(SUN3_PAGE_VALID \
53				 | SUN3_PAGE_ACCESSED \
54				 | SUN3_PAGE_NOCACHE)
55#define PAGE_READONLY	__pgprot(SUN3_PAGE_VALID \
56				 | SUN3_PAGE_ACCESSED \
57				 | SUN3_PAGE_NOCACHE)
58#define PAGE_KERNEL	__pgprot(SUN3_PAGE_VALID \
59				 | SUN3_PAGE_WRITEABLE \
60				 | SUN3_PAGE_SYSTEM \
61				 | SUN3_PAGE_NOCACHE \
62				 | SUN3_PAGE_ACCESSED \
63				 | SUN3_PAGE_MODIFIED)
64#define PAGE_INIT	__pgprot(SUN3_PAGE_VALID \
65				 | SUN3_PAGE_WRITEABLE \
66				 | SUN3_PAGE_SYSTEM \
67				 | SUN3_PAGE_NOCACHE)
68
69/* Use these fake page-protections on PMDs. */
70#define SUN3_PMD_VALID	(0x00000001)
71#define SUN3_PMD_MASK	(0x0000003F)
72#define SUN3_PMD_MAGIC	(0x0000002B)
73
74/* We borrow bit 6 to store the exclusive marker in swap PTEs. */
75#define _PAGE_SWP_EXCLUSIVE	0x040
76
77#ifndef __ASSEMBLY__
78
79/*
80 * Conversion functions: convert a page and protection to a page entry,
81 * and a page entry and page directory to the page they refer to.
82 */
83#define mk_pte(page, pgprot) pfn_pte(page_to_pfn(page), (pgprot))
84
85static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
86{
87	pte_val(pte) = (pte_val(pte) & SUN3_PAGE_CHG_MASK) | pgprot_val(newprot);
88	return pte;
89}
90
91#define pmd_set(pmdp,ptep) do {} while (0)
92
93#define __pte_page(pte) \
94(__va ((pte_val (pte) & SUN3_PAGE_PGNUM_MASK) << PAGE_SHIFT))
95
96static inline unsigned long pmd_page_vaddr(pmd_t pmd)
97{
98	return (unsigned long)__va(pmd_val(pmd) & PAGE_MASK);
99}
100
101static inline int pte_none (pte_t pte) { return !pte_val (pte); }
102static inline int pte_present (pte_t pte) { return pte_val (pte) & SUN3_PAGE_VALID; }
103static inline void pte_clear (struct mm_struct *mm, unsigned long addr, pte_t *ptep)
104{
105	pte_val (*ptep) = 0;
106}
107
108#define PFN_PTE_SHIFT		0
109#define pte_pfn(pte)            (pte_val(pte) & SUN3_PAGE_PGNUM_MASK)
110#define pfn_pte(pfn, pgprot) \
111({ pte_t __pte; pte_val(__pte) = pfn | pgprot_val(pgprot); __pte; })
112
113#define pte_page(pte)		virt_to_page(__pte_page(pte))
114#define pmd_pfn(pmd)		(pmd_val(pmd) >> PAGE_SHIFT)
115#define pmd_page(pmd)		virt_to_page((void *)pmd_page_vaddr(pmd))
116
117
118static inline int pmd_none2 (pmd_t *pmd) { return !pmd_val (*pmd); }
119#define pmd_none(pmd) pmd_none2(&(pmd))
120//static inline int pmd_bad (pmd_t pmd) { return (pmd_val (pmd) & SUN3_PMD_MASK) != SUN3_PMD_MAGIC; }
121static inline int pmd_bad2 (pmd_t *pmd) { return 0; }
122#define pmd_bad(pmd) pmd_bad2(&(pmd))
123static inline int pmd_present2 (pmd_t *pmd) { return pmd_val (*pmd) & SUN3_PMD_VALID; }
124/* #define pmd_present(pmd) pmd_present2(&(pmd)) */
125#define pmd_present(pmd) (!pmd_none2(&(pmd)))
126static inline void pmd_clear (pmd_t *pmdp) { pmd_val (*pmdp) = 0; }
127
128
129#define pte_ERROR(e) \
130	pr_err("%s:%d: bad pte %08lx.\n", __FILE__, __LINE__, pte_val(e))
131#define pgd_ERROR(e) \
132	pr_err("%s:%d: bad pgd %08lx.\n", __FILE__, __LINE__, pgd_val(e))
133
134
135/*
136 * The following only work if pte_present() is true.
137 * Undefined behaviour if not...
138 * [we have the full set here even if they don't change from m68k]
139 */
140static inline int pte_write(pte_t pte)		{ return pte_val(pte) & SUN3_PAGE_WRITEABLE; }
141static inline int pte_dirty(pte_t pte)		{ return pte_val(pte) & SUN3_PAGE_MODIFIED; }
142static inline int pte_young(pte_t pte)		{ return pte_val(pte) & SUN3_PAGE_ACCESSED; }
143
144static inline pte_t pte_wrprotect(pte_t pte)	{ pte_val(pte) &= ~SUN3_PAGE_WRITEABLE; return pte; }
145static inline pte_t pte_mkclean(pte_t pte)	{ pte_val(pte) &= ~SUN3_PAGE_MODIFIED; return pte; }
146static inline pte_t pte_mkold(pte_t pte)	{ pte_val(pte) &= ~SUN3_PAGE_ACCESSED; return pte; }
147static inline pte_t pte_mkwrite_novma(pte_t pte){ pte_val(pte) |= SUN3_PAGE_WRITEABLE; return pte; }
148static inline pte_t pte_mkdirty(pte_t pte)	{ pte_val(pte) |= SUN3_PAGE_MODIFIED; return pte; }
149static inline pte_t pte_mkyoung(pte_t pte)	{ pte_val(pte) |= SUN3_PAGE_ACCESSED; return pte; }
150static inline pte_t pte_mknocache(pte_t pte)	{ pte_val(pte) |= SUN3_PAGE_NOCACHE; return pte; }
151// use this version when caches work...
152//static inline pte_t pte_mkcache(pte_t pte)	{ pte_val(pte) &= SUN3_PAGE_NOCACHE; return pte; }
153// until then, use:
154static inline pte_t pte_mkcache(pte_t pte)	{ return pte; }
155
156extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
157extern pgd_t kernel_pg_dir[PTRS_PER_PGD];
158
159/*
160 * Encode/decode swap entries and swap PTEs. Swap PTEs are all PTEs that
161 * are !pte_none() && !pte_present().
162 *
163 * Format of swap PTEs:
164 *
165 *   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
166 *   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
167 *   0 <--------------------- offset ----------------> E <- type -->
168 *
169 *   E is the exclusive marker that is not stored in swap entries.
170 */
171#define __swp_type(x)		((x).val & 0x3f)
172#define __swp_offset(x)		(((x).val) >> 7)
173#define __swp_entry(type, offset) ((swp_entry_t) { (((type) & 0x3f) | \
174						   (((offset) << 7) & ~SUN3_PAGE_VALID)) })
175#define __pte_to_swp_entry(pte)	((swp_entry_t) { pte_val(pte) })
176#define __swp_entry_to_pte(x)	((pte_t) { (x).val })
177
178static inline int pte_swp_exclusive(pte_t pte)
179{
180	return pte_val(pte) & _PAGE_SWP_EXCLUSIVE;
181}
182
183static inline pte_t pte_swp_mkexclusive(pte_t pte)
184{
185	pte_val(pte) |= _PAGE_SWP_EXCLUSIVE;
186	return pte;
187}
188
189static inline pte_t pte_swp_clear_exclusive(pte_t pte)
190{
191	pte_val(pte) &= ~_PAGE_SWP_EXCLUSIVE;
192	return pte;
193}
194
195#endif	/* !__ASSEMBLY__ */
196#endif	/* !_SUN3_PGTABLE_H */
197