xref: /freebsd/sys/powerpc/aim/mmu_oea64.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (C) 2010 Nathan Whitehorn
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #ifndef _POWERPC_AIM_MMU_OEA64_H
31 #define _POWERPC_AIM_MMU_OEA64_H
32 
33 #include "opt_pmap.h"
34 
35 #include <vm/vm_extern.h>
36 #include <machine/mmuvar.h>
37 
38 struct dump_context {
39 	u_long ptex;
40 	u_long ptex_end;
41 	size_t blksz;
42 };
43 
44 extern const struct mmu_kobj oea64_mmu;
45 
46 /*
47  * Helper routines
48  */
49 
50 /* Allocate physical memory for use in moea64_bootstrap. */
51 vm_offset_t	moea64_bootstrap_alloc(vm_size_t size, vm_size_t align);
52 /* Set an LPTE structure to match the contents of a PVO */
53 void	moea64_pte_from_pvo(const struct pvo_entry *pvo, struct lpte *lpte);
54 
55 /*
56  * Flags
57  */
58 
59 #define MOEA64_PTE_PROT_UPDATE	1
60 #define MOEA64_PTE_INVALIDATE	2
61 
62 /*
63  * Bootstrap subroutines
64  *
65  * An MMU_BOOTSTRAP() implementation looks like this:
66  *   moea64_early_bootstrap();
67  *   Allocate Page Table
68  *   moea64_mid_bootstrap();
69  *   Add mappings for MMU resources
70  *   moea64_late_bootstrap();
71  */
72 
73 void		moea64_early_bootstrap(vm_offset_t kernelstart,
74 		    vm_offset_t kernelend);
75 void		moea64_mid_bootstrap(vm_offset_t kernelstart,
76 		    vm_offset_t kernelend);
77 void		moea64_late_bootstrap(vm_offset_t kernelstart,
78 		    vm_offset_t kernelend);
79 
80 /* "base" install method for initializing moea64 pmap ifuncs */
81 void		moea64_install(void);
82 
83 int64_t		moea64_pte_replace(struct pvo_entry *, int);
84 int64_t		moea64_pte_insert(struct pvo_entry *);
85 int64_t		moea64_pte_unset(struct pvo_entry *);
86 int64_t		moea64_pte_clear(struct pvo_entry *, uint64_t);
87 int64_t		moea64_pte_synch(struct pvo_entry *);
88 int64_t		moea64_pte_insert_sp(struct pvo_entry *);
89 int64_t		moea64_pte_unset_sp(struct pvo_entry *);
90 int64_t		moea64_pte_replace_sp(struct pvo_entry *);
91 
92 typedef int64_t	(*moea64_pte_replace_t)(struct pvo_entry *, int);
93 typedef int64_t	(*moea64_pte_insert_t)(struct pvo_entry *);
94 typedef int64_t	(*moea64_pte_unset_t)(struct pvo_entry *);
95 typedef int64_t	(*moea64_pte_clear_t)(struct pvo_entry *, uint64_t);
96 typedef int64_t	(*moea64_pte_synch_t)(struct pvo_entry *);
97 typedef int64_t	(*moea64_pte_insert_sp_t)(struct pvo_entry *);
98 typedef int64_t	(*moea64_pte_unset_sp_t)(struct pvo_entry *);
99 typedef int64_t	(*moea64_pte_replace_sp_t)(struct pvo_entry *);
100 
101 struct moea64_funcs {
102 	moea64_pte_replace_t	pte_replace;
103 	moea64_pte_insert_t	pte_insert;
104 	moea64_pte_unset_t	pte_unset;
105 	moea64_pte_clear_t	pte_clear;
106 	moea64_pte_synch_t	pte_synch;
107 	moea64_pte_insert_sp_t	pte_insert_sp;
108 	moea64_pte_unset_sp_t	pte_unset_sp;
109 	moea64_pte_replace_sp_t	pte_replace_sp;
110 };
111 
112 extern struct moea64_funcs *moea64_ops;
113 
114 static inline uint64_t
115 moea64_pte_vpn_from_pvo_vpn(const struct pvo_entry *pvo)
116 {
117 	return ((pvo->pvo_vpn >> (ADDR_API_SHFT64 - ADDR_PIDX_SHFT)) &
118 	    LPTE_AVPN_MASK);
119 }
120 
121 /*
122  * Statistics
123  */
124 
125 #ifdef MOEA64_STATS
126 extern u_int	moea64_pte_valid;
127 extern u_int	moea64_pte_overflow;
128 #define STAT_MOEA64(x)	x
129 #else
130 #define	STAT_MOEA64(x) ((void)0)
131 #endif
132 
133 /*
134  * State variables
135  */
136 
137 extern int		moea64_large_page_shift;
138 extern uint64_t		moea64_large_page_size;
139 extern uint64_t		moea64_large_page_mask;
140 extern u_long		moea64_pteg_count;
141 extern u_long		moea64_pteg_mask;
142 extern int		n_slbs;
143 extern bool		moea64_has_lp_4k_16m;
144 
145 #endif /* _POWERPC_AIM_MMU_OEA64_H */
146