xref: /openbsd-src/sys/arch/arm/include/pmap.h (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1 /*	$OpenBSD: pmap.h,v 1.18 2011/04/28 20:50:58 ariane Exp $	*/
2 /*	$NetBSD: pmap.h,v 1.76 2003/09/06 09:10:46 rearnsha Exp $	*/
3 
4 /*
5  * Copyright (c) 2002, 2003 Wasabi Systems, Inc.
6  * All rights reserved.
7  *
8  * Written by Jason R. Thorpe & Steve C. Woodford for Wasabi Systems, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed for the NetBSD Project by
21  *	Wasabi Systems, Inc.
22  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
23  *    or promote products derived from this software without specific prior
24  *    written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Copyright (c) 1994,1995 Mark Brinicombe.
41  * All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Mark Brinicombe
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 #ifndef	_ARM_PMAP_H_
70 #define	_ARM_PMAP_H_
71 
72 #ifdef _KERNEL
73 
74 #include <arm/cpuconf.h>
75 #include <arm/pte.h>
76 #ifndef _LOCORE
77 #include <arm/cpufunc.h>
78 #endif
79 
80 /*
81  * a pmap describes a processes' 4GB virtual address space.  this
82  * virtual address space can be broken up into 4096 1MB regions which
83  * are described by L1 PTEs in the L1 table.
84  *
85  * There is a line drawn at KERNEL_BASE.  Everything below that line
86  * changes when the VM context is switched.  Everything above that line
87  * is the same no matter which VM context is running.  This is achieved
88  * by making the L1 PTEs for those slots above KERNEL_BASE reference
89  * kernel L2 tables.
90  *
91  * The basic layout of the virtual address space thus looks like this:
92  *
93  *	0xffffffff
94  *	.
95  *	.
96  *	.
97  *	KERNEL_BASE
98  *	--------------------
99  *	.
100  *	.
101  *	.
102  *	0x00000000
103  */
104 
105 /*
106  * The number of L2 descriptor tables which can be tracked by an l2_dtable.
107  * A bucket size of 16 provides for 16MB of contiguous virtual address
108  * space per l2_dtable. Most processes will, therefore, require only two or
109  * three of these to map their whole working set.
110  */
111 #define	L2_BUCKET_LOG2	4
112 #define	L2_BUCKET_SIZE	(1 << L2_BUCKET_LOG2)
113 
114 /*
115  * Given the above "L2-descriptors-per-l2_dtable" constant, the number
116  * of l2_dtable structures required to track all possible page descriptors
117  * mappable by an L1 translation table is given by the following constants:
118  */
119 #define	L2_LOG2		((32 - L1_S_SHIFT) - L2_BUCKET_LOG2)
120 #define	L2_SIZE		(1 << L2_LOG2)
121 
122 #ifndef _LOCORE
123 
124 struct l1_ttable;
125 struct l2_dtable;
126 
127 /*
128  * Track cache/tlb occupancy using the following structure
129  */
130 union pmap_cache_state {
131 	struct {
132 		union {
133 			u_int8_t csu_cache_b[2];
134 			u_int16_t csu_cache;
135 		} cs_cache_u;
136 
137 		union {
138 			u_int8_t csu_tlb_b[2];
139 			u_int16_t csu_tlb;
140 		} cs_tlb_u;
141 	} cs_s;
142 	u_int32_t cs_all;
143 };
144 #define	cs_cache_id	cs_s.cs_cache_u.csu_cache_b[0]
145 #define	cs_cache_d	cs_s.cs_cache_u.csu_cache_b[1]
146 #define	cs_cache	cs_s.cs_cache_u.csu_cache
147 #define	cs_tlb_id	cs_s.cs_tlb_u.csu_tlb_b[0]
148 #define	cs_tlb_d	cs_s.cs_tlb_u.csu_tlb_b[1]
149 #define	cs_tlb		cs_s.cs_tlb_u.csu_tlb
150 
151 /*
152  * Assigned to cs_all to force cacheops to work for a particular pmap
153  */
154 #define	PMAP_CACHE_STATE_ALL	0xffffffffu
155 
156 /*
157  * This structure is used by machine-dependent code to describe
158  * static mappings of devices, created at bootstrap time.
159  */
160 struct pmap_devmap {
161 	vaddr_t		pd_va;		/* virtual address */
162 	paddr_t		pd_pa;		/* physical address */
163 	psize_t		pd_size;	/* size of region */
164 	vm_prot_t	pd_prot;	/* protection code */
165 	int		pd_cache;	/* cache attributes */
166 };
167 
168 /*
169  * The pmap structure itself
170  */
171 struct pmap {
172 	u_int8_t		pm_domain;
173 	boolean_t		pm_remove_all;
174 	struct l1_ttable	*pm_l1;
175 	union pmap_cache_state	pm_cstate;
176 	u_int			pm_refs;
177 	simple_lock_data_t	pm_lock;
178 	struct l2_dtable	*pm_l2[L2_SIZE];
179 	struct pmap_statistics	pm_stats;
180 };
181 
182 typedef struct pmap *pmap_t;
183 
184 /*
185  * Physical / virtual address structure. In a number of places (particularly
186  * during bootstrapping) we need to keep track of the physical and virtual
187  * addresses of various pages
188  */
189 typedef struct pv_addr {
190 	SLIST_ENTRY(pv_addr) pv_list;
191 	paddr_t pv_pa;
192 	vaddr_t pv_va;
193 } pv_addr_t;
194 
195 /*
196  * Determine various modes for PTEs (user vs. kernel, cacheable
197  * vs. non-cacheable).
198  */
199 #define	PTE_KERNEL	0
200 #define	PTE_USER	1
201 #define	PTE_NOCACHE	0
202 #define	PTE_CACHE	1
203 #define	PTE_PAGETABLE	2
204 
205 /*
206  * Flags that indicate attributes of pages or mappings of pages.
207  *
208  * The PVF_MOD and PVF_REF flags are stored in the mdpage for each
209  * page.  PVF_WIRED, PVF_WRITE, and PVF_NC are kept in individual
210  * pv_entry's for each page.  They live in the same "namespace" so
211  * that we can clear multiple attributes at a time.
212  *
213  * Note the "non-cacheable" flag generally means the page has
214  * multiple mappings in a given address space.
215  */
216 #define	PVF_MOD		0x01		/* page is modified */
217 #define	PVF_REF		0x02		/* page is referenced */
218 #define	PVF_WIRED	0x04		/* mapping is wired */
219 #define	PVF_WRITE	0x08		/* mapping is writable */
220 #define	PVF_EXEC	0x10		/* mapping is executable */
221 #define	PVF_UNC		0x20		/* mapping is 'user' non-cacheable */
222 #define	PVF_KNC		0x40		/* mapping is 'kernel' non-cacheable */
223 #define	PVF_NC		(PVF_UNC|PVF_KNC)
224 
225 /*
226  * Commonly referenced structures
227  */
228 extern struct pmap	kernel_pmap_store;
229 extern int		pmap_debug_level; /* Only exists if PMAP_DEBUG */
230 
231 /*
232  * Macros that we need to export
233  */
234 #define pmap_kernel()			(&kernel_pmap_store)
235 #define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
236 #define	pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
237 
238 #define	pmap_is_modified(pg)	\
239 	(((pg)->mdpage.pvh_attrs & PVF_MOD) != 0)
240 #define	pmap_is_referenced(pg)	\
241 	(((pg)->mdpage.pvh_attrs & PVF_REF) != 0)
242 
243 #define	pmap_deactivate(p)		do { /* nothing */ } while (0)
244 #define	pmap_copy(dp, sp, da, l, sa)	do { /* nothing */ } while (0)
245 
246 #define pmap_proc_iflush(p, va, len)	do { /* nothing */ } while (0)
247 #define pmap_unuse_final(p)		do { /* nothing */ } while (0)
248 #define	pmap_remove_holes(map)		do { /* nothing */ } while (0)
249 
250 /*
251  * Functions that we need to export
252  */
253 void	pmap_procwr(struct proc *, vaddr_t, int);
254 void	pmap_remove_all(pmap_t);
255 boolean_t pmap_extract(pmap_t, vaddr_t, paddr_t *);
256 void	pmap_uncache_page(paddr_t, vaddr_t);
257 
258 #define	PMAP_NEED_PROCWR
259 #define PMAP_GROWKERNEL		/* turn on pmap_growkernel interface */
260 
261 /* Functions we use internally. */
262 void	pmap_bootstrap(pd_entry_t *, vaddr_t, vaddr_t);
263 
264 int	pmap_fault_fixup(pmap_t, vaddr_t, vm_prot_t, int);
265 boolean_t pmap_get_pde_pte(pmap_t, vaddr_t, pd_entry_t **, pt_entry_t **);
266 boolean_t pmap_get_pde(pmap_t, vaddr_t, pd_entry_t **);
267 void	pmap_set_pcb_pagedir(pmap_t, struct pcb *);
268 
269 void	pmap_debug(int);
270 void	pmap_postinit(void);
271 
272 void	vector_page_setprot(int);
273 
274 /* XXX */
275 void pmap_kenter_cache(vaddr_t va, paddr_t pa, vm_prot_t prot, int cacheable);
276 
277 const struct pmap_devmap *pmap_devmap_find_pa(paddr_t, psize_t);
278 const struct pmap_devmap *pmap_devmap_find_va(vaddr_t, vsize_t);
279 
280 /* Bootstrapping routines. */
281 void	pmap_map_section(vaddr_t, vaddr_t, paddr_t, int, int);
282 void	pmap_map_entry(vaddr_t, vaddr_t, paddr_t, int, int);
283 vsize_t	pmap_map_chunk(vaddr_t, vaddr_t, paddr_t, vsize_t, int, int);
284 void	pmap_link_l2pt(vaddr_t, vaddr_t, pv_addr_t *);
285 void	pmap_devmap_bootstrap(vaddr_t, const struct pmap_devmap *);
286 void	pmap_devmap_register(const struct pmap_devmap *);
287 
288 /*
289  * Special page zero routine for use by the idle loop (no cache cleans).
290  */
291 boolean_t	pmap_pageidlezero(struct vm_page *);
292 #define PMAP_PAGEIDLEZERO(pg)	pmap_pageidlezero((pg))
293 
294 /*
295  * The current top of kernel VM
296  */
297 extern vaddr_t	pmap_curmaxkvaddr;
298 
299 /*
300  * Useful macros and constants
301  */
302 
303 /* Virtual address to page table entry */
304 static __inline pt_entry_t *
305 vtopte(vaddr_t va)
306 {
307 	pd_entry_t *pdep;
308 	pt_entry_t *ptep;
309 
310 	if (pmap_get_pde_pte(pmap_kernel(), va, &pdep, &ptep) == FALSE)
311 		return (NULL);
312 	return (ptep);
313 }
314 
315 /*
316  * The new pmap ensures that page-tables are always mapping Write-Thru.
317  * Thus, on some platforms we can run fast and loose and avoid syncing PTEs
318  * on every change.
319  *
320  * Unfortunately, not all CPUs have a write-through cache mode.  So we
321  * define PMAP_NEEDS_PTE_SYNC for C code to conditionally do PTE syncs,
322  * and if there is the chance for PTE syncs to be needed, we define
323  * PMAP_INCLUDE_PTE_SYNC so e.g. assembly code can include (and run)
324  * the code.
325  */
326 extern int pmap_needs_pte_sync;
327 
328 /*
329  * StrongARM SA-1 caches do not have a write-through mode.  So, on these,
330  * we need to do PTE syncs.  If only SA-1 is configured, then evaluate
331  * this at compile time.
332  */
333 #if (ARM_MMU_SA1 == 1) && (ARM_NMMUS == 1)
334 #define	PMAP_NEEDS_PTE_SYNC	1
335 #define	PMAP_INCLUDE_PTE_SYNC
336 #elif (ARM_MMU_SA1 == 0)
337 #define	PMAP_NEEDS_PTE_SYNC	0
338 #endif
339 
340 /*
341  * Provide a fallback in case we were not able to determine it at
342  * compile-time.
343  */
344 #ifndef PMAP_NEEDS_PTE_SYNC
345 #define	PMAP_NEEDS_PTE_SYNC	pmap_needs_pte_sync
346 #define	PMAP_INCLUDE_PTE_SYNC
347 #endif
348 
349 #define	PTE_SYNC(pte)							\
350 do {									\
351 	if (PMAP_NEEDS_PTE_SYNC)					\
352 		cpu_dcache_wb_range((vaddr_t)(pte), sizeof(pt_entry_t));\
353 } while (/*CONSTCOND*/0)
354 
355 #define	PTE_SYNC_RANGE(pte, cnt)					\
356 do {									\
357 	if (PMAP_NEEDS_PTE_SYNC) {					\
358 		cpu_dcache_wb_range((vaddr_t)(pte),			\
359 		    (cnt) << 2); /* * sizeof(pt_entry_t) */		\
360 	}								\
361 } while (/*CONSTCOND*/0)
362 
363 #define	l1pte_valid(pde)	((pde) != 0)
364 #define	l1pte_section_p(pde)	(((pde) & L1_TYPE_MASK) == L1_TYPE_S)
365 #define	l1pte_page_p(pde)	(((pde) & L1_TYPE_MASK) == L1_TYPE_C)
366 #define	l1pte_fpage_p(pde)	(((pde) & L1_TYPE_MASK) == L1_TYPE_F)
367 
368 #define l2pte_index(v)		(((v) & L2_ADDR_BITS) >> L2_S_SHIFT)
369 #define	l2pte_valid(pte)	((pte) != 0)
370 #define	l2pte_pa(pte)		((pte) & L2_S_FRAME)
371 #define l2pte_minidata(pte)	(((pte) & \
372 				 (L2_B | L2_C | L2_XSCALE_T_TEX(TEX_XSCALE_X)))\
373 				 == (L2_C | L2_XSCALE_T_TEX(TEX_XSCALE_X)))
374 
375 /* L1 and L2 page table macros */
376 #define pmap_pde_v(pde)		l1pte_valid(*(pde))
377 #define pmap_pde_section(pde)	l1pte_section_p(*(pde))
378 #define pmap_pde_page(pde)	l1pte_page_p(*(pde))
379 #define pmap_pde_fpage(pde)	l1pte_fpage_p(*(pde))
380 
381 #define	pmap_pte_v(pte)		l2pte_valid(*(pte))
382 #define	pmap_pte_pa(pte)	l2pte_pa(*(pte))
383 
384 /* Size of the kernel part of the L1 page table */
385 #define KERNEL_PD_SIZE	\
386 	(L1_TABLE_SIZE - (KERNEL_BASE >> L1_S_SHIFT) * sizeof(pd_entry_t))
387 
388 /************************* ARM MMU configuration *****************************/
389 
390 #if (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0
391 void	pmap_copy_page_generic(struct vm_page *, struct vm_page *);
392 void	pmap_zero_page_generic(struct vm_page *);
393 
394 void	pmap_pte_init_generic(void);
395 #if defined(CPU_ARM8)
396 void	pmap_pte_init_arm8(void);
397 #endif
398 #if defined(CPU_ARM9)
399 void	pmap_pte_init_arm9(void);
400 #endif /* CPU_ARM9 */
401 #if defined(CPU_ARM10)
402 void	pmap_pte_init_arm10(void);
403 #endif /* CPU_ARM10 */
404 #if defined(CPU_ARM11)
405 void	pmap_pte_init_arm11(void);
406 #endif /* CPU_ARM11 */
407 #if defined(CPU_ARMv7)
408 void	pmap_pte_init_armv7(void);
409 #endif /* CPU_ARMv7 */
410 #endif /* (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0 */
411 
412 #if ARM_MMU_SA1 == 1
413 void	pmap_pte_init_sa1(void);
414 #endif /* ARM_MMU_SA1 == 1 */
415 
416 #if ARM_MMU_V7 == 1
417 void	pmap_copy_page_v7(struct vm_page *, struct vm_page *);
418 void	pmap_zero_page_v7(struct vm_page *);
419 
420 void	pmap_pte_init_v7(void);
421 #endif /* ARM_MMU_V7 == 1 */
422 
423 #if ARM_MMU_XSCALE == 1
424 void	pmap_copy_page_xscale(struct vm_page *, struct vm_page *);
425 void	pmap_zero_page_xscale(struct vm_page *);
426 
427 void	pmap_pte_init_xscale(void);
428 
429 void	xscale_setup_minidata(vaddr_t, vaddr_t, paddr_t);
430 
431 #define	PMAP_UAREA(va)		pmap_uarea(va)
432 void	pmap_uarea(vaddr_t);
433 #endif /* ARM_MMU_XSCALE == 1 */
434 
435 extern pt_entry_t		pte_l1_s_cache_mode;
436 extern pt_entry_t		pte_l1_s_cache_mask;
437 
438 extern pt_entry_t		pte_l2_l_cache_mode;
439 extern pt_entry_t		pte_l2_l_cache_mask;
440 
441 extern pt_entry_t		pte_l2_s_cache_mode;
442 extern pt_entry_t		pte_l2_s_cache_mask;
443 
444 extern pt_entry_t		pte_l1_s_cache_mode_pt;
445 extern pt_entry_t		pte_l2_l_cache_mode_pt;
446 extern pt_entry_t		pte_l2_s_cache_mode_pt;
447 
448 extern pt_entry_t		pte_l2_s_prot_u;
449 extern pt_entry_t		pte_l2_s_prot_w;
450 extern pt_entry_t		pte_l2_s_prot_mask;
451 
452 extern pt_entry_t		pte_l1_s_proto;
453 extern pt_entry_t		pte_l1_c_proto;
454 extern pt_entry_t		pte_l2_s_proto;
455 
456 extern void (*pmap_copy_page_func)(struct vm_page *, struct vm_page *);
457 extern void (*pmap_zero_page_func)(struct vm_page *);
458 
459 #endif /* !_LOCORE */
460 
461 /*****************************************************************************/
462 
463 /*
464  * tell MI code that the cache is virtually-indexed *and* virtually-tagged.
465  */
466 #define PMAP_CACHE_VIVT
467 
468 /*
469  * Definitions for MMU domains
470  */
471 #define	PMAP_DOMAINS		15	/* 15 'user' domains (0-14) */
472 #define	PMAP_DOMAIN_KERNEL	15	/* The kernel uses domain #15 */
473 
474 /*
475  * These macros define the various bit masks in the PTE.
476  *
477  * We use these macros since we use different bits on different processor
478  * models.
479  */
480 #define	L1_S_PROT_U		(L1_S_AP(AP_U))
481 #define	L1_S_PROT_W		(L1_S_AP(AP_W))
482 #define	L1_S_PROT_MASK		(L1_S_PROT_U|L1_S_PROT_W)
483 
484 #define	L1_S_CACHE_MASK_generic	(L1_S_B|L1_S_C)
485 #define	L1_S_CACHE_MASK_xscale	(L1_S_B|L1_S_C|L1_S_XSCALE_TEX(TEX_XSCALE_X))
486 #define	L1_S_CACHE_MASK_v7	(L1_S_B|L1_S_C|L1_S_V7_TEX(TEX_V7_X))
487 
488 #define	L2_L_PROT_U		(L2_AP(AP_U))
489 #define	L2_L_PROT_W		(L2_AP(AP_W))
490 #define	L2_L_PROT_MASK		(L2_L_PROT_U|L2_L_PROT_W)
491 
492 #define	L2_L_CACHE_MASK_generic	(L2_B|L2_C)
493 #define	L2_L_CACHE_MASK_xscale	(L2_B|L2_C|L2_XSCALE_L_TEX(TEX_XSCALE_X))
494 #define	L2_L_CACHE_MASK_v7	(L2_B|L2_C|L2_V7_L_TEX(TEX_V7_X))
495 
496 #define	L2_S_PROT_U_generic	(L2_AP(AP_U))
497 #define	L2_S_PROT_W_generic	(L2_AP(AP_W))
498 #define	L2_S_PROT_MASK_generic	(L2_S_PROT_U|L2_S_PROT_W)
499 
500 #define	L2_S_PROT_U_xscale	(L2_AP0(AP_U))
501 #define	L2_S_PROT_W_xscale	(L2_AP0(AP_W))
502 #define	L2_S_PROT_MASK_xscale	(L2_S_PROT_U|L2_S_PROT_W)
503 
504 #define	L2_S_PROT_U_v7		(L2_AP0(AP_U))
505 #define	L2_S_PROT_W_v7		(L2_AP0(AP_W))
506 #define	L2_S_PROT_MASK_v7	(L2_S_PROT_U|L2_S_PROT_W)
507 
508 #define	L2_S_CACHE_MASK_generic	(L2_B|L2_C)
509 #define	L2_S_CACHE_MASK_xscale	(L2_B|L2_C|L2_XSCALE_T_TEX(TEX_XSCALE_X))
510 #define	L2_S_CACHE_MASK_v7	(L2_B|L2_C)
511 
512 #define	L1_S_PROTO_generic	(L1_TYPE_S | L1_S_IMP)
513 #define	L1_S_PROTO_xscale	(L1_TYPE_S)
514 #define	L1_S_PROTO_v7		(L1_TYPE_S)
515 
516 #define	L1_C_PROTO_generic	(L1_TYPE_C | L1_C_IMP2)
517 #define	L1_C_PROTO_xscale	(L1_TYPE_C)
518 #define	L1_C_PROTO_v7		(L1_TYPE_C)
519 
520 #define	L2_L_PROTO		(L2_TYPE_L)
521 
522 #define	L2_S_PROTO_generic	(L2_TYPE_S)
523 #define	L2_S_PROTO_xscale	(L2_TYPE_XSCALE_XS)
524 #define	L2_S_PROTO_v7		(L2_TYPE_S)
525 
526 /*
527  * User-visible names for the ones that vary with MMU class.
528  */
529 
530 #if ARM_NMMUS > 1
531 /* More than one MMU class configured; use variables. */
532 #define	L2_S_PROT_U		pte_l2_s_prot_u
533 #define	L2_S_PROT_W		pte_l2_s_prot_w
534 #define	L2_S_PROT_MASK		pte_l2_s_prot_mask
535 
536 #define	L1_S_CACHE_MASK		pte_l1_s_cache_mask
537 #define	L2_L_CACHE_MASK		pte_l2_l_cache_mask
538 #define	L2_S_CACHE_MASK		pte_l2_s_cache_mask
539 
540 #define	L1_S_PROTO		pte_l1_s_proto
541 #define	L1_C_PROTO		pte_l1_c_proto
542 #define	L2_S_PROTO		pte_l2_s_proto
543 
544 #define	pmap_copy_page(s, d)	(*pmap_copy_page_func)((s), (d))
545 #define	pmap_zero_page(d)	(*pmap_zero_page_func)((d))
546 #elif (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0
547 #define	L2_S_PROT_U		L2_S_PROT_U_generic
548 #define	L2_S_PROT_W		L2_S_PROT_W_generic
549 #define	L2_S_PROT_MASK		L2_S_PROT_MASK_generic
550 
551 #define	L1_S_CACHE_MASK		L1_S_CACHE_MASK_generic
552 #define	L2_L_CACHE_MASK		L2_L_CACHE_MASK_generic
553 #define	L2_S_CACHE_MASK		L2_S_CACHE_MASK_generic
554 
555 #define	L1_S_PROTO		L1_S_PROTO_generic
556 #define	L1_C_PROTO		L1_C_PROTO_generic
557 #define	L2_S_PROTO		L2_S_PROTO_generic
558 
559 #define	pmap_copy_page(s, d)	pmap_copy_page_generic((s), (d))
560 #define	pmap_zero_page(d)	pmap_zero_page_generic((d))
561 #elif ARM_MMU_XSCALE == 1
562 #define	L2_S_PROT_U		L2_S_PROT_U_xscale
563 #define	L2_S_PROT_W		L2_S_PROT_W_xscale
564 #define	L2_S_PROT_MASK		L2_S_PROT_MASK_xscale
565 
566 #define	L1_S_CACHE_MASK		L1_S_CACHE_MASK_xscale
567 #define	L2_L_CACHE_MASK		L2_L_CACHE_MASK_xscale
568 #define	L2_S_CACHE_MASK		L2_S_CACHE_MASK_xscale
569 
570 #define	L1_S_PROTO		L1_S_PROTO_xscale
571 #define	L1_C_PROTO		L1_C_PROTO_xscale
572 #define	L2_S_PROTO		L2_S_PROTO_xscale
573 
574 #define	pmap_copy_page(s, d)	pmap_copy_page_xscale((s), (d))
575 #define	pmap_zero_page(d)	pmap_zero_page_xscale((d))
576 #elif ARM_MMU_V7 == 1
577 #define	L2_S_PROT_U		L2_S_PROT_U_v7
578 #define	L2_S_PROT_W		L2_S_PROT_W_v7
579 #define	L2_S_PROT_MASK		L2_S_PROT_MASK_v7
580 
581 #define	L1_S_CACHE_MASK		L1_S_CACHE_MASK_v7
582 #define	L2_L_CACHE_MASK		L2_L_CACHE_MASK_v7
583 #define	L2_S_CACHE_MASK		L2_S_CACHE_MASK_v7
584 
585 #define	L1_S_PROTO		L1_S_PROTO_v7
586 #define	L1_C_PROTO		L1_C_PROTO_v7
587 #define	L2_S_PROTO		L2_S_PROTO_v7
588 
589 #define	pmap_copy_page(s, d)	pmap_copy_page_v7((s), (d))
590 #define	pmap_zero_page(d)	pmap_zero_page_v7((d))
591 #endif /* ARM_NMMUS > 1 */
592 
593 /*
594  * These macros return various bits based on kernel/user and protection.
595  * Note that the compiler will usually fold these at compile time.
596  */
597 #define	L1_S_PROT(ku, pr)	((((ku) == PTE_USER) ? L1_S_PROT_U : 0) | \
598 				 (((pr) & VM_PROT_WRITE) ? L1_S_PROT_W : 0))
599 
600 #define	L2_L_PROT(ku, pr)	((((ku) == PTE_USER) ? L2_L_PROT_U : 0) | \
601 				 (((pr) & VM_PROT_WRITE) ? L2_L_PROT_W : 0))
602 
603 #define	L2_S_PROT(ku, pr)	((((ku) == PTE_USER) ? L2_S_PROT_U : 0) | \
604 				 (((pr) & VM_PROT_WRITE) ? L2_S_PROT_W : 0))
605 
606 /*
607  * Macros to test if a mapping is mappable with an L1 Section mapping
608  * or an L2 Large Page mapping.
609  */
610 #define	L1_S_MAPPABLE_P(va, pa, size)					\
611 	((((va) | (pa)) & L1_S_OFFSET) == 0 && (size) >= L1_S_SIZE)
612 
613 #define	L2_L_MAPPABLE_P(va, pa, size)					\
614 	((((va) | (pa)) & L2_L_OFFSET) == 0 && (size) >= L2_L_SIZE)
615 
616 #ifndef _LOCORE
617 /* pmap_prefer bits for VIPT ARMv7 */
618 #define PMAP_PREFER(fo, ap)	pmap_prefer((fo), (ap))
619 vaddr_t	pmap_prefer(vaddr_t, vaddr_t);
620 
621 extern uint32_t pmap_alias_dist;
622 extern uint32_t pmap_alias_bits;
623 
624 /* pmap prefer alias alignment. */
625 #define PMAP_PREFER_ALIGN()	(pmap_alias_dist)
626 /* pmap prefer offset withing alignment. */
627 #define PMAP_PREFER_OFFSET(of)						\
628     (PMAP_PREFER_ALIGN() == 0 ? 0 : ((of) & (PMAP_PREFER_ALIGN() - 1)))
629 
630 
631 #endif /* _LOCORE */
632 
633 #endif /* _KERNEL */
634 
635 #endif	/* _ARM_PMAP_H_ */
636