1/*
2 * This file is subject to the terms and conditions of the GNU General Public
3 * License.  See the file "COPYING" in the main directory of this archive
4 * for more details.
5 *
6 * Copyright (C) 1994 - 2002 by Ralf Baechle
7 * Copyright (C) 1999, 2000, 2001 Silicon Graphics, Inc.
8 * Copyright (C) 2002  Maciej W. Rozycki
9 */
10#ifndef _ASM_PGTABLE_BITS_H
11#define _ASM_PGTABLE_BITS_H
12
13
14/*
15 * Note that we shift the lower 32bits of each EntryLo[01] entry
16 * 6 bits to the left. That way we can convert the PFN into the
17 * physical address by a single 'and' operation and gain 6 additional
18 * bits for storing information which isn't present in a normal
19 * MIPS page table.
20 *
21 * Similar to the Alpha port, we need to keep track of the ref
22 * and mod bits in software.  We have a software "yeah you can read
23 * from this page" bit, and a hardware one which actually lets the
24 * process read from the page.	On the same token we have a software
25 * writable bit and the real hardware one which actually lets the
26 * process write to the page, this keeps a mod bit via the hardware
27 * dirty bit.
28 *
29 * Certain revisions of the R4000 and R5000 have a bug where if a
30 * certain sequence occurs in the last 3 instructions of an executable
31 * page, and the following page is not mapped, the cpu can do
32 * unpredictable things.  The code (when it is written) to deal with
33 * this problem will be in the update_mmu_cache() code for the r4k.
34 */
35#if defined(CONFIG_PHYS_ADDR_T_64BIT) && defined(CONFIG_CPU_MIPS32)
36
37/*
38 * The following bits are implemented by the TLB hardware
39 */
40#define _PAGE_NO_EXEC_SHIFT	0
41#define _PAGE_NO_EXEC		(1 << _PAGE_NO_EXEC_SHIFT)
42#define _PAGE_NO_READ_SHIFT	(_PAGE_NO_EXEC_SHIFT + 1)
43#define _PAGE_NO_READ		(1 << _PAGE_NO_READ_SHIFT)
44#define _PAGE_GLOBAL_SHIFT	(_PAGE_NO_READ_SHIFT + 1)
45#define _PAGE_GLOBAL		(1 << _PAGE_GLOBAL_SHIFT)
46#define _PAGE_VALID_SHIFT	(_PAGE_GLOBAL_SHIFT + 1)
47#define _PAGE_VALID		(1 << _PAGE_VALID_SHIFT)
48#define _PAGE_DIRTY_SHIFT	(_PAGE_VALID_SHIFT + 1)
49#define _PAGE_DIRTY		(1 << _PAGE_DIRTY_SHIFT)
50#define _CACHE_SHIFT		(_PAGE_DIRTY_SHIFT + 1)
51#define _CACHE_MASK		(7 << _CACHE_SHIFT)
52
53/*
54 * The following bits are implemented in software
55 */
56#define _PAGE_PRESENT_SHIFT	(24)
57#define _PAGE_PRESENT		(1 << _PAGE_PRESENT_SHIFT)
58#define _PAGE_READ_SHIFT	(_PAGE_PRESENT_SHIFT + 1)
59#define _PAGE_READ		(1 << _PAGE_READ_SHIFT)
60#define _PAGE_WRITE_SHIFT	(_PAGE_READ_SHIFT + 1)
61#define _PAGE_WRITE		(1 << _PAGE_WRITE_SHIFT)
62#define _PAGE_ACCESSED_SHIFT	(_PAGE_WRITE_SHIFT + 1)
63#define _PAGE_ACCESSED		(1 << _PAGE_ACCESSED_SHIFT)
64#define _PAGE_MODIFIED_SHIFT	(_PAGE_ACCESSED_SHIFT + 1)
65#define _PAGE_MODIFIED		(1 << _PAGE_MODIFIED_SHIFT)
66
67#define _PFN_SHIFT		(PAGE_SHIFT - 12 + _CACHE_SHIFT + 3)
68
69/*
70 * Bits for extended EntryLo0/EntryLo1 registers
71 */
72#define _PFNX_MASK		0xffffff
73
74#elif defined(CONFIG_CPU_R3000) || defined(CONFIG_CPU_TX39XX)
75
76/*
77 * The following bits are implemented in software
78 */
79#define _PAGE_PRESENT_SHIFT	(0)
80#define _PAGE_PRESENT		(1 << _PAGE_PRESENT_SHIFT)
81#define _PAGE_READ_SHIFT	(_PAGE_PRESENT_SHIFT + 1)
82#define _PAGE_READ		(1 << _PAGE_READ_SHIFT)
83#define _PAGE_WRITE_SHIFT	(_PAGE_READ_SHIFT + 1)
84#define _PAGE_WRITE		(1 << _PAGE_WRITE_SHIFT)
85#define _PAGE_ACCESSED_SHIFT	(_PAGE_WRITE_SHIFT + 1)
86#define _PAGE_ACCESSED		(1 << _PAGE_ACCESSED_SHIFT)
87#define _PAGE_MODIFIED_SHIFT	(_PAGE_ACCESSED_SHIFT + 1)
88#define _PAGE_MODIFIED		(1 << _PAGE_MODIFIED_SHIFT)
89
90/*
91 * The following bits are implemented by the TLB hardware
92 */
93#define _PAGE_GLOBAL_SHIFT	(_PAGE_MODIFIED_SHIFT + 4)
94#define _PAGE_GLOBAL		(1 << _PAGE_GLOBAL_SHIFT)
95#define _PAGE_VALID_SHIFT	(_PAGE_GLOBAL_SHIFT + 1)
96#define _PAGE_VALID		(1 << _PAGE_VALID_SHIFT)
97#define _PAGE_DIRTY_SHIFT	(_PAGE_VALID_SHIFT + 1)
98#define _PAGE_DIRTY		(1 << _PAGE_DIRTY_SHIFT)
99#define _CACHE_UNCACHED_SHIFT	(_PAGE_DIRTY_SHIFT + 1)
100#define _CACHE_UNCACHED		(1 << _CACHE_UNCACHED_SHIFT)
101#define _CACHE_MASK		_CACHE_UNCACHED
102
103#define _PFN_SHIFT		PAGE_SHIFT
104
105#else
106/*
107 * Below are the "Normal" R4K cases
108 */
109
110/*
111 * The following bits are implemented in software
112 */
113#define _PAGE_PRESENT_SHIFT	0
114#define _PAGE_PRESENT		(1 << _PAGE_PRESENT_SHIFT)
115/* R2 or later cores check for RI/XI support to determine _PAGE_READ */
116#if defined(CONFIG_CPU_MIPSR2) || defined(CONFIG_CPU_MIPSR6)
117#define _PAGE_WRITE_SHIFT	(_PAGE_PRESENT_SHIFT + 1)
118#define _PAGE_WRITE		(1 << _PAGE_WRITE_SHIFT)
119#else
120#define _PAGE_READ_SHIFT	(_PAGE_PRESENT_SHIFT + 1)
121#define _PAGE_READ		(1 << _PAGE_READ_SHIFT)
122#define _PAGE_WRITE_SHIFT	(_PAGE_READ_SHIFT + 1)
123#define _PAGE_WRITE		(1 << _PAGE_WRITE_SHIFT)
124#endif
125#define _PAGE_ACCESSED_SHIFT	(_PAGE_WRITE_SHIFT + 1)
126#define _PAGE_ACCESSED		(1 << _PAGE_ACCESSED_SHIFT)
127#define _PAGE_MODIFIED_SHIFT	(_PAGE_ACCESSED_SHIFT + 1)
128#define _PAGE_MODIFIED		(1 << _PAGE_MODIFIED_SHIFT)
129
130#if defined(CONFIG_64BIT) && defined(CONFIG_MIPS_HUGE_TLB_SUPPORT)
131/* Huge TLB page */
132#define _PAGE_HUGE_SHIFT	(_PAGE_MODIFIED_SHIFT + 1)
133#define _PAGE_HUGE		(1 << _PAGE_HUGE_SHIFT)
134#define _PAGE_SPLITTING_SHIFT	(_PAGE_HUGE_SHIFT + 1)
135#define _PAGE_SPLITTING		(1 << _PAGE_SPLITTING_SHIFT)
136
137/* Only R2 or newer cores have the XI bit */
138#if defined(CONFIG_CPU_MIPSR2) || defined(CONFIG_CPU_MIPSR6)
139#define _PAGE_NO_EXEC_SHIFT	(_PAGE_SPLITTING_SHIFT + 1)
140#else
141#define _PAGE_GLOBAL_SHIFT	(_PAGE_SPLITTING_SHIFT + 1)
142#define _PAGE_GLOBAL		(1 << _PAGE_GLOBAL_SHIFT)
143#endif	/* CONFIG_CPU_MIPSR2 || CONFIG_CPU_MIPSR6 */
144
145#endif	/* CONFIG_64BIT && CONFIG_MIPS_HUGE_TLB_SUPPORT */
146
147#if defined(CONFIG_CPU_MIPSR2) || defined(CONFIG_CPU_MIPSR6)
148/* XI - page cannot be executed */
149#ifndef _PAGE_NO_EXEC_SHIFT
150#define _PAGE_NO_EXEC_SHIFT	(_PAGE_MODIFIED_SHIFT + 1)
151#endif
152#define _PAGE_NO_EXEC		(cpu_has_rixi ? (1 << _PAGE_NO_EXEC_SHIFT) : 0)
153
154/* RI - page cannot be read */
155#define _PAGE_READ_SHIFT	(_PAGE_NO_EXEC_SHIFT + 1)
156#define _PAGE_READ		(cpu_has_rixi ? 0 : (1 << _PAGE_READ_SHIFT))
157#define _PAGE_NO_READ_SHIFT	_PAGE_READ_SHIFT
158#define _PAGE_NO_READ		(cpu_has_rixi ? (1 << _PAGE_READ_SHIFT) : 0)
159
160#define _PAGE_GLOBAL_SHIFT	(_PAGE_NO_READ_SHIFT + 1)
161#define _PAGE_GLOBAL		(1 << _PAGE_GLOBAL_SHIFT)
162
163#else	/* !CONFIG_CPU_MIPSR2 && !CONFIG_CPU_MIPSR6 */
164#define _PAGE_GLOBAL_SHIFT	(_PAGE_MODIFIED_SHIFT + 1)
165#define _PAGE_GLOBAL		(1 << _PAGE_GLOBAL_SHIFT)
166#endif	/* CONFIG_CPU_MIPSR2 || CONFIG_CPU_MIPSR6 */
167
168#define _PAGE_VALID_SHIFT	(_PAGE_GLOBAL_SHIFT + 1)
169#define _PAGE_VALID		(1 << _PAGE_VALID_SHIFT)
170#define _PAGE_DIRTY_SHIFT	(_PAGE_VALID_SHIFT + 1)
171#define _PAGE_DIRTY		(1 << _PAGE_DIRTY_SHIFT)
172#define _CACHE_SHIFT		(_PAGE_DIRTY_SHIFT + 1)
173#define _CACHE_MASK		(7 << _CACHE_SHIFT)
174
175#define _PFN_SHIFT		(PAGE_SHIFT - 12 + _CACHE_SHIFT + 3)
176
177#endif /* defined(CONFIG_PHYS_ADDR_T_64BIT && defined(CONFIG_CPU_MIPS32) */
178
179#ifndef _PAGE_NO_EXEC
180#define _PAGE_NO_EXEC		0
181#endif
182#ifndef _PAGE_NO_READ
183#define _PAGE_NO_READ		0
184#endif
185
186#define _PAGE_SILENT_READ	_PAGE_VALID
187#define _PAGE_SILENT_WRITE	_PAGE_DIRTY
188
189#define _PFN_MASK		(~((1 << (_PFN_SHIFT)) - 1))
190
191/*
192 * The final layouts of the PTE bits are:
193 *
194 *   64-bit, R1 or earlier:     CCC D V G [S H] M A W R P
195 *   32-bit, R1 or earler:      CCC D V G M A W R P
196 *   64-bit, R2 or later:       CCC D V G RI/R XI [S H] M A W P
197 *   32-bit, R2 or later:       CCC D V G RI/R XI M A W P
198 */
199
200
201#ifndef __ASSEMBLY__
202/*
203 * pte_to_entrylo converts a page table entry (PTE) into a Mips
204 * entrylo0/1 value.
205 */
206static inline uint64_t pte_to_entrylo(unsigned long pte_val)
207{
208#if defined(CONFIG_CPU_MIPSR2) || defined(CONFIG_CPU_MIPSR6)
209	if (cpu_has_rixi) {
210		int sa;
211#ifdef CONFIG_32BIT
212		sa = 31 - _PAGE_NO_READ_SHIFT;
213#else
214		sa = 63 - _PAGE_NO_READ_SHIFT;
215#endif
216		/*
217		 * C has no way to express that this is a DSRL
218		 * _PAGE_NO_EXEC_SHIFT followed by a ROTR 2.  Luckily
219		 * in the fast path this is done in assembly
220		 */
221		return (pte_val >> _PAGE_GLOBAL_SHIFT) |
222			((pte_val & (_PAGE_NO_EXEC | _PAGE_NO_READ)) << sa);
223	}
224#endif
225
226	return pte_val >> _PAGE_GLOBAL_SHIFT;
227}
228#endif
229
230/*
231 * Cache attributes
232 */
233#if defined(CONFIG_CPU_R3000) || defined(CONFIG_CPU_TX39XX)
234
235#define _CACHE_CACHABLE_NONCOHERENT 0
236#define _CACHE_UNCACHED_ACCELERATED _CACHE_UNCACHED
237
238#elif defined(CONFIG_CPU_SB1)
239
240/* No penalty for being coherent on the SB1, so just
241   use it for "noncoherent" spaces, too.  Shouldn't hurt. */
242
243#define _CACHE_CACHABLE_NONCOHERENT (5<<_CACHE_SHIFT)
244
245#elif defined(CONFIG_CPU_LOONGSON3)
246
247/* Using COHERENT flag for NONCOHERENT doesn't hurt. */
248
249#define _CACHE_CACHABLE_NONCOHERENT (3<<_CACHE_SHIFT)  /* LOONGSON       */
250#define _CACHE_CACHABLE_COHERENT    (3<<_CACHE_SHIFT)  /* LOONGSON-3     */
251
252#elif defined(CONFIG_MACH_JZ4740)
253
254/* Ingenic uses the WA bit to achieve write-combine memory writes */
255#define _CACHE_UNCACHED_ACCELERATED (1<<_CACHE_SHIFT)
256
257#endif
258
259#ifndef _CACHE_CACHABLE_NO_WA
260#define _CACHE_CACHABLE_NO_WA		(0<<_CACHE_SHIFT)
261#endif
262#ifndef _CACHE_CACHABLE_WA
263#define _CACHE_CACHABLE_WA		(1<<_CACHE_SHIFT)
264#endif
265#ifndef _CACHE_UNCACHED
266#define _CACHE_UNCACHED			(2<<_CACHE_SHIFT)
267#endif
268#ifndef _CACHE_CACHABLE_NONCOHERENT
269#define _CACHE_CACHABLE_NONCOHERENT	(3<<_CACHE_SHIFT)
270#endif
271#ifndef _CACHE_CACHABLE_CE
272#define _CACHE_CACHABLE_CE		(4<<_CACHE_SHIFT)
273#endif
274#ifndef _CACHE_CACHABLE_COW
275#define _CACHE_CACHABLE_COW		(5<<_CACHE_SHIFT)
276#endif
277#ifndef _CACHE_CACHABLE_CUW
278#define _CACHE_CACHABLE_CUW		(6<<_CACHE_SHIFT)
279#endif
280#ifndef _CACHE_UNCACHED_ACCELERATED
281#define _CACHE_UNCACHED_ACCELERATED	(7<<_CACHE_SHIFT)
282#endif
283
284#define __READABLE	(_PAGE_SILENT_READ | _PAGE_READ | _PAGE_ACCESSED)
285#define __WRITEABLE	(_PAGE_SILENT_WRITE | _PAGE_WRITE | _PAGE_MODIFIED)
286
287#define _PAGE_CHG_MASK	(_PAGE_ACCESSED | _PAGE_MODIFIED |	\
288			 _PFN_MASK | _CACHE_MASK)
289
290#endif /* _ASM_PGTABLE_BITS_H */
291