xref: /freebsd/sys/powerpc/include/pmap.h (revision c47dd3db8cf22114267360dddb4b0334b997db0c)
1f9bac91bSBenno Rice /*-
2ffb56695SRafal Jaworowski  * Copyright (C) 2006 Semihalf, Marian Balakowicz <m8@semihalf.com>
3ffb56695SRafal Jaworowski  * All rights reserved.
4ffb56695SRafal Jaworowski  *
5ffb56695SRafal Jaworowski  * Adapted for Freescale's e500 core CPUs.
6ffb56695SRafal Jaworowski  *
7ffb56695SRafal Jaworowski  * Redistribution and use in source and binary forms, with or without
8ffb56695SRafal Jaworowski  * modification, are permitted provided that the following conditions
9ffb56695SRafal Jaworowski  * are met:
10ffb56695SRafal Jaworowski  * 1. Redistributions of source code must retain the above copyright
11ffb56695SRafal Jaworowski  *    notice, this list of conditions and the following disclaimer.
12ffb56695SRafal Jaworowski  * 2. Redistributions in binary form must reproduce the above copyright
13ffb56695SRafal Jaworowski  *    notice, this list of conditions and the following disclaimer in the
14ffb56695SRafal Jaworowski  *    documentation and/or other materials provided with the distribution.
15ffb56695SRafal Jaworowski  * 3. The name of the author may not be used to endorse or promote products
16ffb56695SRafal Jaworowski  *    derived from this software without specific prior written permission.
17ffb56695SRafal Jaworowski  *
18ffb56695SRafal Jaworowski  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19ffb56695SRafal Jaworowski  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20ffb56695SRafal Jaworowski  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
21ffb56695SRafal Jaworowski  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22ffb56695SRafal Jaworowski  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
23ffb56695SRafal Jaworowski  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24ffb56695SRafal Jaworowski  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25ffb56695SRafal Jaworowski  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26ffb56695SRafal Jaworowski  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27ffb56695SRafal Jaworowski  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28ffb56695SRafal Jaworowski  *
29ffb56695SRafal Jaworowski  * $FreeBSD$
30ffb56695SRafal Jaworowski  */
31ffb56695SRafal Jaworowski /*-
32f9bac91bSBenno Rice  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
33f9bac91bSBenno Rice  * Copyright (C) 1995, 1996 TooLs GmbH.
34f9bac91bSBenno Rice  * All rights reserved.
35f9bac91bSBenno Rice  *
36f9bac91bSBenno Rice  * Redistribution and use in source and binary forms, with or without
37f9bac91bSBenno Rice  * modification, are permitted provided that the following conditions
38f9bac91bSBenno Rice  * are met:
39f9bac91bSBenno Rice  * 1. Redistributions of source code must retain the above copyright
40f9bac91bSBenno Rice  *    notice, this list of conditions and the following disclaimer.
41f9bac91bSBenno Rice  * 2. Redistributions in binary form must reproduce the above copyright
42f9bac91bSBenno Rice  *    notice, this list of conditions and the following disclaimer in the
43f9bac91bSBenno Rice  *    documentation and/or other materials provided with the distribution.
44f9bac91bSBenno Rice  * 3. All advertising materials mentioning features or use of this software
45f9bac91bSBenno Rice  *    must display the following acknowledgement:
46f9bac91bSBenno Rice  *	This product includes software developed by TooLs GmbH.
47f9bac91bSBenno Rice  * 4. The name of TooLs GmbH may not be used to endorse or promote products
48f9bac91bSBenno Rice  *    derived from this software without specific prior written permission.
49f9bac91bSBenno Rice  *
50f9bac91bSBenno Rice  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
51f9bac91bSBenno Rice  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52f9bac91bSBenno Rice  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53f9bac91bSBenno Rice  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54f9bac91bSBenno Rice  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
55f9bac91bSBenno Rice  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
56f9bac91bSBenno Rice  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
57f9bac91bSBenno Rice  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
58f9bac91bSBenno Rice  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
59f9bac91bSBenno Rice  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60f9bac91bSBenno Rice  *
61ffb56695SRafal Jaworowski  *	from: $NetBSD: pmap.h,v 1.17 2000/03/30 16:18:24 jdolecek Exp $
62f9bac91bSBenno Rice  */
63f9bac91bSBenno Rice 
64f9bac91bSBenno Rice #ifndef	_MACHINE_PMAP_H_
65f9bac91bSBenno Rice #define	_MACHINE_PMAP_H_
66f9bac91bSBenno Rice 
6748d0b1a0SAlan Cox #include <sys/queue.h>
68c3e289e1SNathan Whitehorn #include <sys/tree.h>
69*c47dd3dbSAttilio Rao #include <sys/_cpuset.h>
7048d0b1a0SAlan Cox #include <sys/_lock.h>
7148d0b1a0SAlan Cox #include <sys/_mutex.h>
725244eac9SBenno Rice #include <machine/sr.h>
737f89270bSPeter Grehan #include <machine/pte.h>
74c3e289e1SNathan Whitehorn #include <machine/slb.h>
75ffb56695SRafal Jaworowski #include <machine/tlb.h>
76ffb56695SRafal Jaworowski 
7727457a80SMarcel Moolenaar struct pmap_md {
7827457a80SMarcel Moolenaar 	u_int		md_index;
7927457a80SMarcel Moolenaar 	vm_paddr_t      md_paddr;
8027457a80SMarcel Moolenaar 	vm_offset_t     md_vaddr;
8127457a80SMarcel Moolenaar 	vm_size_t       md_size;
8227457a80SMarcel Moolenaar };
8327457a80SMarcel Moolenaar 
84ffb56695SRafal Jaworowski #if defined(AIM)
85f9bac91bSBenno Rice 
867c277971SPeter Grehan #if !defined(NPMAPS)
877c277971SPeter Grehan #define	NPMAPS		32768
887c277971SPeter Grehan #endif /* !defined(NPMAPS) */
897c277971SPeter Grehan 
9095fa3335SNathan Whitehorn struct	slbtnode;
91c3e289e1SNathan Whitehorn 
92f9bac91bSBenno Rice struct	pmap {
9348d0b1a0SAlan Cox 	struct	mtx	pm_mtx;
94c3e289e1SNathan Whitehorn 
95c3e289e1SNathan Whitehorn     #ifdef __powerpc64__
9695fa3335SNathan Whitehorn 	struct slbtnode	*pm_slb_tree_root;
976416b9a8SNathan Whitehorn 	struct slb	**pm_slb;
986416b9a8SNathan Whitehorn 	int		pm_slb_len;
99c3e289e1SNathan Whitehorn     #else
100c3e289e1SNathan Whitehorn 	register_t	pm_sr[16];
101c3e289e1SNathan Whitehorn     #endif
102*c47dd3dbSAttilio Rao 	cpuset_t	pm_active;
10352a7870dSNathan Whitehorn 
10452a7870dSNathan Whitehorn 	struct pmap	*pmap_phys;
1055244eac9SBenno Rice 	struct		pmap_statistics	pm_stats;
106f9bac91bSBenno Rice };
107f9bac91bSBenno Rice 
108f9bac91bSBenno Rice typedef	struct pmap *pmap_t;
109f9bac91bSBenno Rice 
1105244eac9SBenno Rice struct pvo_entry {
1115244eac9SBenno Rice 	LIST_ENTRY(pvo_entry) pvo_vlink;	/* Link to common virt page */
1125244eac9SBenno Rice 	LIST_ENTRY(pvo_entry) pvo_olink;	/* Link to overflow entry */
11352a7870dSNathan Whitehorn 	union {
11452a7870dSNathan Whitehorn 		struct	pte pte;		/* 32 bit PTE */
11552a7870dSNathan Whitehorn 		struct	lpte lpte;		/* 64 bit PTE */
11652a7870dSNathan Whitehorn 	} pvo_pte;
1175244eac9SBenno Rice 	pmap_t		pvo_pmap;		/* Owning pmap */
1185244eac9SBenno Rice 	vm_offset_t	pvo_vaddr;		/* VA of entry */
119c3e289e1SNathan Whitehorn 	uint64_t	pvo_vpn;		/* Virtual page number */
1205244eac9SBenno Rice };
1215244eac9SBenno Rice LIST_HEAD(pvo_head, pvo_entry);
1225244eac9SBenno Rice 
123bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_MASK	0x007UL		/* which PTEG slot */
124bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_VALID	0x008UL		/* slot is valid */
125bef5da7fSNathan Whitehorn #define	PVO_WIRED		0x010UL		/* PVO entry is wired */
126bef5da7fSNathan Whitehorn #define	PVO_MANAGED		0x020UL		/* PVO entry is managed */
127bef5da7fSNathan Whitehorn #define	PVO_EXECUTABLE		0x040UL		/* PVO entry is executable */
128bef5da7fSNathan Whitehorn #define	PVO_BOOTSTRAP		0x080UL		/* PVO entry allocated during
129bef5da7fSNathan Whitehorn 						   bootstrap */
130bef5da7fSNathan Whitehorn #define PVO_FAKE		0x100UL		/* fictitious phys page */
131bef5da7fSNathan Whitehorn #define PVO_LARGE		0x200UL		/* large page */
132bef5da7fSNathan Whitehorn #define	PVO_VADDR(pvo)		((pvo)->pvo_vaddr & ~ADDR_POFF)
133bef5da7fSNathan Whitehorn #define PVO_ISFAKE(pvo)		((pvo)->pvo_vaddr & PVO_FAKE)
134bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_GET(pvo)	((pvo)->pvo_vaddr & PVO_PTEGIDX_MASK)
135bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_ISSET(pvo)	((pvo)->pvo_vaddr & PVO_PTEGIDX_VALID)
136bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_CLR(pvo)	\
137bef5da7fSNathan Whitehorn 	((void)((pvo)->pvo_vaddr &= ~(PVO_PTEGIDX_VALID|PVO_PTEGIDX_MASK)))
138bef5da7fSNathan Whitehorn #define	PVO_PTEGIDX_SET(pvo, i)	\
139bef5da7fSNathan Whitehorn 	((void)((pvo)->pvo_vaddr |= (i)|PVO_PTEGIDX_VALID))
140bef5da7fSNathan Whitehorn #define	PVO_VSID(pvo)		((pvo)->pvo_vpn >> 16)
141bef5da7fSNathan Whitehorn 
1425244eac9SBenno Rice struct	md_page {
14352a7870dSNathan Whitehorn 	u_int64_t	 mdpg_attrs;
144c1f4123bSNathan Whitehorn 	vm_memattr_t	 mdpg_cache_attrs;
1455244eac9SBenno Rice 	struct	pvo_head mdpg_pvoh;
1465244eac9SBenno Rice };
1475244eac9SBenno Rice 
148c1f4123bSNathan Whitehorn #define	pmap_page_get_memattr(m)	((m)->md.mdpg_cache_attrs)
149ffb56695SRafal Jaworowski #define	pmap_page_is_mapped(m)	(!LIST_EMPTY(&(m)->md.mdpg_pvoh))
150ffb56695SRafal Jaworowski 
151c3e289e1SNathan Whitehorn /*
152c3e289e1SNathan Whitehorn  * Return the VSID corresponding to a given virtual address.
153c3e289e1SNathan Whitehorn  * If no VSID is currently defined, it will allocate one, and add
154c3e289e1SNathan Whitehorn  * it to a free slot if available.
155c3e289e1SNathan Whitehorn  *
156c3e289e1SNathan Whitehorn  * NB: The PMAP MUST be locked already.
157c3e289e1SNathan Whitehorn  */
158c3e289e1SNathan Whitehorn uint64_t va_to_vsid(pmap_t pm, vm_offset_t va);
15995fa3335SNathan Whitehorn 
16095fa3335SNathan Whitehorn /* Lock-free, non-allocating lookup routines */
16195fa3335SNathan Whitehorn uint64_t kernel_va_to_slbv(vm_offset_t va);
16295fa3335SNathan Whitehorn struct slb *user_va_to_slb_entry(pmap_t pm, vm_offset_t va);
163c3e289e1SNathan Whitehorn 
1646416b9a8SNathan Whitehorn uint64_t allocate_user_vsid(pmap_t pm, uint64_t esid, int large);
16595fa3335SNathan Whitehorn void	free_vsid(pmap_t pm, uint64_t esid, int large);
1666416b9a8SNathan Whitehorn void	slb_insert_user(pmap_t pm, struct slb *slb);
1676416b9a8SNathan Whitehorn void	slb_insert_kernel(uint64_t slbe, uint64_t slbv);
16895fa3335SNathan Whitehorn 
16995fa3335SNathan Whitehorn struct slbtnode *slb_alloc_tree(void);
17095fa3335SNathan Whitehorn void     slb_free_tree(pmap_t pm);
1716416b9a8SNathan Whitehorn struct slb **slb_alloc_user_cache(void);
1726416b9a8SNathan Whitehorn void	slb_free_user_cache(struct slb **);
173c3e289e1SNathan Whitehorn 
174ffb56695SRafal Jaworowski #else
175ffb56695SRafal Jaworowski 
176ffb56695SRafal Jaworowski struct pmap {
177ffb56695SRafal Jaworowski 	struct mtx		pm_mtx;		/* pmap mutex */
178b2b734e7SRafal Jaworowski 	tlbtid_t		pm_tid[MAXCPU];	/* TID to identify this pmap entries in TLB */
179*c47dd3dbSAttilio Rao 	cpuset_t		pm_active;	/* active on cpus */
180ffb56695SRafal Jaworowski 	struct pmap_statistics	pm_stats;	/* pmap statistics */
181ffb56695SRafal Jaworowski 
182ffb56695SRafal Jaworowski 	/* Page table directory, array of pointers to page tables. */
183ffb56695SRafal Jaworowski 	pte_t			*pm_pdir[PDIR_NENTRIES];
184ffb56695SRafal Jaworowski 
185ffb56695SRafal Jaworowski 	/* List of allocated ptbl bufs (ptbl kva regions). */
186b2b734e7SRafal Jaworowski 	TAILQ_HEAD(, ptbl_buf)	pm_ptbl_list;
187ffb56695SRafal Jaworowski };
188ffb56695SRafal Jaworowski typedef	struct pmap *pmap_t;
189ffb56695SRafal Jaworowski 
190ffb56695SRafal Jaworowski struct pv_entry {
191ffb56695SRafal Jaworowski 	pmap_t pv_pmap;
192ffb56695SRafal Jaworowski 	vm_offset_t pv_va;
193ffb56695SRafal Jaworowski 	TAILQ_ENTRY(pv_entry) pv_link;
194ffb56695SRafal Jaworowski };
195ffb56695SRafal Jaworowski typedef struct pv_entry *pv_entry_t;
196ffb56695SRafal Jaworowski 
197ffb56695SRafal Jaworowski struct md_page {
198ffb56695SRafal Jaworowski 	TAILQ_HEAD(, pv_entry) pv_list;
199ffb56695SRafal Jaworowski };
200ffb56695SRafal Jaworowski 
2013153e878SAlan Cox #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
202ffb56695SRafal Jaworowski #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
203ffb56695SRafal Jaworowski 
204ffb56695SRafal Jaworowski #endif /* AIM */
205ffb56695SRafal Jaworowski 
2065244eac9SBenno Rice extern	struct pmap kernel_pmap_store;
2075244eac9SBenno Rice #define	kernel_pmap	(&kernel_pmap_store)
2085244eac9SBenno Rice 
209f9bac91bSBenno Rice #ifdef _KERNEL
210f9bac91bSBenno Rice 
21148d0b1a0SAlan Cox #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
21248d0b1a0SAlan Cox #define	PMAP_LOCK_ASSERT(pmap, type) \
21348d0b1a0SAlan Cox 				mtx_assert(&(pmap)->pm_mtx, (type))
21448d0b1a0SAlan Cox #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
21548d0b1a0SAlan Cox #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
21648d0b1a0SAlan Cox 				    NULL, MTX_DEF)
21748d0b1a0SAlan Cox #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
21848d0b1a0SAlan Cox #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
21948d0b1a0SAlan Cox #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
22048d0b1a0SAlan Cox #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
22148d0b1a0SAlan Cox 
2225244eac9SBenno Rice void		pmap_bootstrap(vm_offset_t, vm_offset_t);
2235501d40bSJake Burkholder void		pmap_kenter(vm_offset_t va, vm_offset_t pa);
224c1f4123bSNathan Whitehorn void		pmap_kenter_attr(vm_offset_t va, vm_offset_t pa, vm_memattr_t);
2255501d40bSJake Burkholder void		pmap_kremove(vm_offset_t);
2268bbfa33aSBenno Rice void		*pmap_mapdev(vm_offset_t, vm_size_t);
227c1f4123bSNathan Whitehorn void		*pmap_mapdev_attr(vm_offset_t, vm_size_t, vm_memattr_t);
2288bbfa33aSBenno Rice void		pmap_unmapdev(vm_offset_t, vm_size_t);
229c1f4123bSNathan Whitehorn void		pmap_page_set_memattr(vm_page_t, vm_memattr_t);
230ac6ba8bdSBenno Rice void		pmap_deactivate(struct thread *);
2315244eac9SBenno Rice vm_offset_t	pmap_kextract(vm_offset_t);
232c0763d37SSuleiman Souhlal int		pmap_dev_direct_mapped(vm_offset_t, vm_size_t);
233f9c702dbSPeter Grehan boolean_t	pmap_mmu_install(char *name, int prio);
234f9c702dbSPeter Grehan 
235696effb6SJohn Baldwin #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
236a0889814SBenno Rice 
237f9c702dbSPeter Grehan #define PHYS_AVAIL_SZ	128
238f9c702dbSPeter Grehan extern	vm_offset_t phys_avail[PHYS_AVAIL_SZ];
239f9bac91bSBenno Rice extern	vm_offset_t virtual_avail;
240f9bac91bSBenno Rice extern	vm_offset_t virtual_end;
241f9bac91bSBenno Rice 
2425244eac9SBenno Rice extern	vm_offset_t msgbuf_phys;
243f9bac91bSBenno Rice 
244f9c702dbSPeter Grehan extern	int pmap_bootstrapped;
245f9c702dbSPeter Grehan 
24627457a80SMarcel Moolenaar extern vm_offset_t pmap_dumpsys_map(struct pmap_md *, vm_size_t, vm_size_t *);
24727457a80SMarcel Moolenaar extern void pmap_dumpsys_unmap(struct pmap_md *, vm_size_t, vm_offset_t);
24827457a80SMarcel Moolenaar 
24927457a80SMarcel Moolenaar extern struct pmap_md *pmap_scan_md(struct pmap_md *);
25027457a80SMarcel Moolenaar 
251f9bac91bSBenno Rice #endif
252f9bac91bSBenno Rice 
2535244eac9SBenno Rice #endif /* !_MACHINE_PMAP_H_ */
254