xref: /freebsd/sys/powerpc/include/pmap.h (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
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/tree.h>
69 #include <sys/_lock.h>
70 #include <sys/_mutex.h>
71 #include <machine/sr.h>
72 #include <machine/pte.h>
73 #include <machine/slb.h>
74 #include <machine/tlb.h>
75 
76 struct pmap_md {
77 	u_int		md_index;
78 	vm_paddr_t      md_paddr;
79 	vm_offset_t     md_vaddr;
80 	vm_size_t       md_size;
81 };
82 
83 #if defined(AIM)
84 
85 #if !defined(NPMAPS)
86 #define	NPMAPS		32768
87 #endif /* !defined(NPMAPS) */
88 
89 struct	slbcontainer;
90 
91 SPLAY_HEAD(slb_tree, slbcontainer);
92 
93 struct	pmap {
94 	struct	mtx	pm_mtx;
95 
96     #ifdef __powerpc64__
97 	struct slb_tree	pm_slbtree;
98 	struct slb	*pm_slb;
99     #else
100 	register_t	pm_sr[16];
101     #endif
102 	u_int		pm_active;
103 	uint32_t	pm_gen_count;	/* generation count (pmap lock dropped) */
104 	u_int		pm_retries;
105 
106 	struct pmap	*pmap_phys;
107 	struct		pmap_statistics	pm_stats;
108 };
109 
110 typedef	struct pmap *pmap_t;
111 
112 struct pvo_entry {
113 	LIST_ENTRY(pvo_entry) pvo_vlink;	/* Link to common virt page */
114 	LIST_ENTRY(pvo_entry) pvo_olink;	/* Link to overflow entry */
115 	union {
116 		struct	pte pte;		/* 32 bit PTE */
117 		struct	lpte lpte;		/* 64 bit PTE */
118 	} pvo_pte;
119 	pmap_t		pvo_pmap;		/* Owning pmap */
120 	vm_offset_t	pvo_vaddr;		/* VA of entry */
121 	uint64_t	pvo_vpn;		/* Virtual page number */
122 };
123 LIST_HEAD(pvo_head, pvo_entry);
124 
125 struct	md_page {
126 	u_int64_t mdpg_attrs;
127 	struct	pvo_head mdpg_pvoh;
128 };
129 
130 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
131 #define	pmap_page_is_mapped(m)	(!LIST_EMPTY(&(m)->md.mdpg_pvoh))
132 #define	pmap_page_set_memattr(m, ma)	(void)0
133 
134 /*
135  * Return the VSID corresponding to a given virtual address.
136  * If no VSID is currently defined, it will allocate one, and add
137  * it to a free slot if available.
138  *
139  * NB: The PMAP MUST be locked already.
140  */
141 uint64_t va_to_vsid(pmap_t pm, vm_offset_t va);
142 int      va_to_slb_entry(pmap_t pm, vm_offset_t va, struct slb *);
143 
144 uint64_t allocate_vsid(pmap_t pm, uint64_t esid, int large);
145 void     slb_insert(pmap_t pm, struct slb *dst, struct slb *);
146 int      vsid_to_esid(pmap_t pm, uint64_t vsid, uint64_t *esid);
147 void     free_vsids(pmap_t pm);
148 struct slb *slb_alloc_user_cache(void);
149 void	slb_free_user_cache(struct slb *);
150 
151 #else
152 
153 struct pmap {
154 	struct mtx		pm_mtx;		/* pmap mutex */
155 	tlbtid_t		pm_tid[MAXCPU];	/* TID to identify this pmap entries in TLB */
156 	u_int			pm_active;	/* active on cpus */
157 	int			pm_refs;	/* ref count */
158 	struct pmap_statistics	pm_stats;	/* pmap statistics */
159 
160 	/* Page table directory, array of pointers to page tables. */
161 	pte_t			*pm_pdir[PDIR_NENTRIES];
162 
163 	/* generation count (pmap lock dropped) */
164 	uint32_t		pm_gen_count;
165 	u_int			pm_retries;
166 
167 	/* List of allocated ptbl bufs (ptbl kva regions). */
168 	TAILQ_HEAD(, ptbl_buf)	pm_ptbl_list;
169 };
170 typedef	struct pmap *pmap_t;
171 
172 struct pv_entry {
173 	pmap_t pv_pmap;
174 	vm_offset_t pv_va;
175 	TAILQ_ENTRY(pv_entry) pv_link;
176 };
177 typedef struct pv_entry *pv_entry_t;
178 
179 struct md_page {
180 	TAILQ_HEAD(, pv_entry) pv_list;
181 };
182 
183 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
184 #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
185 #define	pmap_page_set_memattr(m, ma)	(void)0
186 
187 #endif /* AIM */
188 
189 extern	struct pmap kernel_pmap_store;
190 #define	kernel_pmap	(&kernel_pmap_store)
191 
192 #ifdef _KERNEL
193 
194 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
195 #define	PMAP_LOCK_ASSERT(pmap, type) \
196 				mtx_assert(&(pmap)->pm_mtx, (type))
197 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
198 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
199 				    NULL, MTX_DEF)
200 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
201 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
202 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
203 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
204 
205 void		pmap_bootstrap(vm_offset_t, vm_offset_t);
206 void		pmap_kenter(vm_offset_t va, vm_offset_t pa);
207 void		pmap_kremove(vm_offset_t);
208 void		*pmap_mapdev(vm_offset_t, vm_size_t);
209 void		pmap_unmapdev(vm_offset_t, vm_size_t);
210 void		pmap_deactivate(struct thread *);
211 vm_offset_t	pmap_kextract(vm_offset_t);
212 int		pmap_dev_direct_mapped(vm_offset_t, vm_size_t);
213 boolean_t	pmap_mmu_install(char *name, int prio);
214 
215 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
216 
217 #define PHYS_AVAIL_SZ	128
218 extern	vm_offset_t phys_avail[PHYS_AVAIL_SZ];
219 extern	vm_offset_t virtual_avail;
220 extern	vm_offset_t virtual_end;
221 
222 extern	vm_offset_t msgbuf_phys;
223 
224 extern	int pmap_bootstrapped;
225 
226 extern vm_offset_t pmap_dumpsys_map(struct pmap_md *, vm_size_t, vm_size_t *);
227 extern void pmap_dumpsys_unmap(struct pmap_md *, vm_size_t, vm_offset_t);
228 
229 extern struct pmap_md *pmap_scan_md(struct pmap_md *);
230 
231 #endif
232 
233 #endif /* !_MACHINE_PMAP_H_ */
234