xref: /netbsd/sys/arch/sun2/include/pmap.h (revision c4a72b64)
1 /*	$NetBSD: pmap.h,v 1.13 2002/09/22 07:53:50 chs Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *        This product includes software developed by the NetBSD
18  *        Foundation, Inc. and its contributors.
19  * 4. Neither the name of The NetBSD Foundation nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef	_MACHINE_PMAP_H
37 #define	_MACHINE_PMAP_H
38 
39 /*
40  * NB:  The details of struct pmap are exposed ONLY when
41  * building a kernel.  LKMs and user-level programs see
42  * only this anonymous declaration.  Note that the actual
43  * declaration may vary on different m68k kernels.
44  */
45 struct pmap;
46 typedef struct pmap *pmap_t;
47 
48 /*
49  * Physical map structures exported to the VM code.
50  * XXX - Does user-level code really see this struct?
51  */
52 
53 struct pmap {
54 	unsigned char   	*pm_segmap; 	/* soft copy of segmap */
55 	int             	pm_ctxnum;	/* MMU context number */
56 	struct simplelock	pm_lock;    	/* lock on pmap */
57 	int             	pm_refcount;	/* reference count */
58 	int             	pm_version;
59 };
60 
61 #ifdef _KERNEL
62 extern	struct pmap	kernel_pmap_store;
63 #define	pmap_kernel()	(&kernel_pmap_store)
64 
65 /*
66  * We give the pmap code a chance to resolve faults by
67  * reloading translations that it was forced to unload.
68  * This function does that, and calls vm_fault if it
69  * could not resolve the fault by reloading the MMU.
70  */
71 int _pmap_fault __P((struct vm_map *, vaddr_t, vm_prot_t));
72 
73 /* This lets us have some say in choosing VA locations. */
74 extern void pmap_prefer __P((vaddr_t, vaddr_t *));
75 #define PMAP_PREFER(fo, ap) pmap_prefer((fo), (ap))
76 
77 /* This needs to be a macro for kern_sysctl.c */
78 extern segsz_t pmap_resident_pages(pmap_t);
79 #define	pmap_resident_count(pmap)	(pmap_resident_pages(pmap))
80 
81 /* This needs to be a macro for vm_mmap.c */
82 extern segsz_t pmap_wired_pages(pmap_t);
83 #define	pmap_wired_count(pmap)	(pmap_wired_pages(pmap))
84 
85 /* We use the PA plus some low bits for device mmap. */
86 #define pmap_phys_address(addr) 	(addr)
87 
88 #define	pmap_update(pmap)		/* nothing (yet) */
89 
90 /* Map a given physical region to a virtual region */
91 extern vaddr_t pmap_map __P((vaddr_t, paddr_t, paddr_t, int));
92 
93 /* Extract the PMEG for a given physical address. */
94 extern int _pmap_extract_pmeg __P((pmap_t, vaddr_t));
95 
96 static __inline void
97 pmap_remove_all(struct pmap *pmap)
98 {
99 	/* Nothing. */
100 }
101 
102 /*
103  * Since PTEs also contain type bits, we have to have some way
104  * to tell pmap_enter `this is an IO page' or `this is not to
105  * be cached'.  Since physical addresses are always aligned, we
106  * can do this with the low order bits.
107  *
108  * The values below must agree with pte.h such that:
109  *	(PMAP_OBIO << PG_MOD_SHIFT) == PGT_OBIO
110  */
111 #define	PMAP_OBMEM	0x00
112 #define	PMAP_OBIO	0x04	/* tells pmap_enter to use PG_OBIO */
113 #define	PMAP_MBMEM	0x08	/* etc (sun-2/120) */
114 #define	PMAP_MBIO	0x0C	/* etc (sun-2/120) */
115 #define	PMAP_VME0	0x08	/* etc (sun-2/50) */
116 #define	PMAP_VME8	0x0C	/* etc (sun-2/50) */
117 #define	PMAP_NC		0x00	/* tells pmap_enter to set PG_NC */
118 #define	PMAP_SPEC	0x0C	/* mask to get all above. */
119 
120 #endif	/* _KERNEL */
121 
122 void pmap_procwr __P((struct proc *, vaddr_t, size_t));
123 
124 #endif	/* _MACHINE_PMAP_H */
125