xref: /freebsd/sys/powerpc/include/pmap.h (revision aa64588d28258aef88cc33b8043112e8856948d0)
1 /*-
2  * Copyright (C) 2006 Semihalf, Marian Balakowicz <m8@semihalf.com>
3  * All rights reserved.
4  *
5  * Adapted for Freescale's e500 core CPUs.
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. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
21  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
23  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 /*-
32  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
33  * Copyright (C) 1995, 1996 TooLs GmbH.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by TooLs GmbH.
47  * 4. The name of TooLs GmbH may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
55  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
56  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
57  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
58  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
59  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  *	from: $NetBSD: pmap.h,v 1.17 2000/03/30 16:18:24 jdolecek Exp $
62  */
63 
64 #ifndef	_MACHINE_PMAP_H_
65 #define	_MACHINE_PMAP_H_
66 
67 #include <sys/queue.h>
68 #include <sys/_lock.h>
69 #include <sys/_mutex.h>
70 #include <machine/sr.h>
71 #include <machine/pte.h>
72 #include <machine/tlb.h>
73 
74 struct pmap_md {
75 	u_int		md_index;
76 	vm_paddr_t      md_paddr;
77 	vm_offset_t     md_vaddr;
78 	vm_size_t       md_size;
79 };
80 
81 #if defined(AIM)
82 
83 #if !defined(NPMAPS)
84 #define	NPMAPS		32768
85 #endif /* !defined(NPMAPS) */
86 
87 struct	pmap {
88 	struct	mtx	pm_mtx;
89 	u_int		pm_sr[16];
90 	u_int		pm_active;
91 	uint32_t	pm_gen_count;	/* generation count (pmap lock dropped) */
92 	u_int		pm_retries;
93 	u_int		pm_context;
94 
95 	struct pmap	*pmap_phys;
96 	struct		pmap_statistics	pm_stats;
97 };
98 
99 typedef	struct pmap *pmap_t;
100 
101 struct pvo_entry {
102 	LIST_ENTRY(pvo_entry) pvo_vlink;	/* Link to common virt page */
103 	LIST_ENTRY(pvo_entry) pvo_olink;	/* Link to overflow entry */
104 	union {
105 		struct	pte pte;		/* 32 bit PTE */
106 		struct	lpte lpte;		/* 64 bit PTE */
107 	} pvo_pte;
108 	pmap_t		pvo_pmap;		/* Owning pmap */
109 	vm_offset_t	pvo_vaddr;		/* VA of entry */
110 };
111 LIST_HEAD(pvo_head, pvo_entry);
112 
113 struct	md_page {
114 	u_int64_t mdpg_attrs;
115 	struct	pvo_head mdpg_pvoh;
116 };
117 
118 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
119 #define	pmap_page_is_mapped(m)	(!LIST_EMPTY(&(m)->md.mdpg_pvoh))
120 #define	pmap_page_set_memattr(m, ma)	(void)0
121 
122 #else
123 
124 struct pmap {
125 	struct mtx		pm_mtx;		/* pmap mutex */
126 	tlbtid_t		pm_tid[MAXCPU];	/* TID to identify this pmap entries in TLB */
127 	u_int			pm_active;	/* active on cpus */
128 	uint32_t		pm_gen_count;	/* generation count (pmap lock dropped) */
129 	u_int			pm_retries;
130 	int			pm_refs;	/* ref count */
131 	struct pmap_statistics	pm_stats;	/* pmap statistics */
132 
133 	/* Page table directory, array of pointers to page tables. */
134 	pte_t			*pm_pdir[PDIR_NENTRIES];
135 
136 	/* List of allocated ptbl bufs (ptbl kva regions). */
137 	TAILQ_HEAD(, ptbl_buf)	pm_ptbl_list;
138 };
139 typedef	struct pmap *pmap_t;
140 
141 struct pv_entry {
142 	pmap_t pv_pmap;
143 	vm_offset_t pv_va;
144 	TAILQ_ENTRY(pv_entry) pv_link;
145 };
146 typedef struct pv_entry *pv_entry_t;
147 
148 struct md_page {
149 	TAILQ_HEAD(, pv_entry) pv_list;
150 };
151 
152 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
153 #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
154 #define	pmap_page_set_memattr(m, ma)	(void)0
155 
156 #endif /* AIM */
157 
158 extern	struct pmap kernel_pmap_store;
159 #define	kernel_pmap	(&kernel_pmap_store)
160 
161 #ifdef _KERNEL
162 
163 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
164 #define	PMAP_LOCK_ASSERT(pmap, type) \
165 				mtx_assert(&(pmap)->pm_mtx, (type))
166 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
167 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
168 				    NULL, MTX_DEF)
169 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
170 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
171 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
172 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
173 
174 void		pmap_bootstrap(vm_offset_t, vm_offset_t);
175 void		pmap_kenter(vm_offset_t va, vm_offset_t pa);
176 void		pmap_kremove(vm_offset_t);
177 void		*pmap_mapdev(vm_offset_t, vm_size_t);
178 void		pmap_unmapdev(vm_offset_t, vm_size_t);
179 void		pmap_deactivate(struct thread *);
180 vm_offset_t	pmap_kextract(vm_offset_t);
181 int		pmap_dev_direct_mapped(vm_offset_t, vm_size_t);
182 boolean_t	pmap_mmu_install(char *name, int prio);
183 
184 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
185 
186 #define PHYS_AVAIL_SZ	128
187 extern	vm_offset_t phys_avail[PHYS_AVAIL_SZ];
188 extern	vm_offset_t virtual_avail;
189 extern	vm_offset_t virtual_end;
190 
191 extern	vm_offset_t msgbuf_phys;
192 
193 extern	int pmap_bootstrapped;
194 
195 extern vm_offset_t pmap_dumpsys_map(struct pmap_md *, vm_size_t, vm_size_t *);
196 extern void pmap_dumpsys_unmap(struct pmap_md *, vm_size_t, vm_offset_t);
197 
198 extern struct pmap_md *pmap_scan_md(struct pmap_md *);
199 
200 #endif
201 
202 #endif /* !_MACHINE_PMAP_H_ */
203