xref: /netbsd-src/sys/arch/riscv/include/pmap.h (revision 7d62b00eb9ad855ffcd7da46b41e23feb5476fac)
1 /* $NetBSD: pmap.h,v 1.14 2022/12/23 10:44:25 skrll Exp $ */
2 
3 /*
4  * Copyright (c) 2014, 2019, 2021 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Matt Thomas (of 3am Software Foundry), Maxime Villard, and
9  * Nick Hudson.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _RISCV_PMAP_H_
34 #define	_RISCV_PMAP_H_
35 
36 #ifdef _KERNEL_OPT
37 #include "opt_modular.h"
38 #endif
39 
40 #if !defined(_MODULE)
41 
42 #include <sys/cdefs.h>
43 #include <sys/types.h>
44 #include <sys/pool.h>
45 #include <sys/evcnt.h>
46 
47 #include <uvm/uvm_physseg.h>
48 #include <uvm/pmap/vmpagemd.h>
49 
50 #include <riscv/pte.h>
51 #include <riscv/sysreg.h>
52 
53 #define	PMAP_SEGTABSIZE	NPTEPG
54 #define	PMAP_PDETABSIZE	NPTEPG
55 
56 #ifdef _LP64
57 #define	PTPSHIFT	3
58 /* This is SV48. */
59 //#define SEGLENGTH + SEGSHIFT + SEGSHIFT */
60 
61 /* This is SV39. */
62 #define	XSEGSHIFT	(SEGSHIFT + SEGLENGTH)
63 #define	NBXSEG		(1ULL << XSEGSHIFT)
64 #define	XSEGOFSET	(NBXSEG - 1)		/* byte offset into xsegment */
65 #define	XSEGLENGTH	(PGSHIFT - 3)
66 #define	NXSEGPG		(1 << XSEGLENGTH)
67 #else
68 #define	PTPSHIFT	2
69 #define	XSEGSHIFT	SEGSHIFT
70 #endif
71 
72 #define	SEGLENGTH	(PGSHIFT - PTPSHIFT)
73 #define	SEGSHIFT	(SEGLENGTH + PGSHIFT)
74 #define	NBSEG		(1 << SEGSHIFT)		/* bytes/segment */
75 #define	SEGOFSET	(NBSEG - 1)		/* byte offset into segment */
76 
77 #define	KERNEL_PID	0
78 
79 #define	PMAP_HWPAGEWALKER		1
80 #define	PMAP_TLB_MAX			1
81 #ifdef _LP64
82 #define	PMAP_INVALID_PDETAB_ADDRESS	((pmap_pdetab_t *)(VM_MIN_KERNEL_ADDRESS - PAGE_SIZE))
83 #define	PMAP_INVALID_SEGTAB_ADDRESS	((pmap_segtab_t *)(VM_MIN_KERNEL_ADDRESS - PAGE_SIZE))
84 #else
85 #define	PMAP_INVALID_PDETAB_ADDRESS	((pmap_pdetab_t *)0xdeadbeef)
86 #define	PMAP_INVALID_SEGTAB_ADDRESS	((pmap_segtab_t *)0xdeadbeef)
87 #endif
88 #define	PMAP_TLB_NUM_PIDS		(__SHIFTOUT_MASK(SATP_ASID) + 1)
89 #define	PMAP_TLB_BITMAP_LENGTH          PMAP_TLB_NUM_PIDS
90 #define	PMAP_TLB_FLUSH_ASID_ON_RESET	false
91 
92 #define	pmap_phys_address(x)		(x)
93 
94 #ifndef __BSD_PTENTRY_T__
95 #define	__BSD_PTENTRY_T__
96 #ifdef _LP64
97 #define	PRIxPTE         PRIx64
98 #else
99 #define	PRIxPTE         PRIx32
100 #endif
101 #endif /* __BSD_PTENTRY_T__ */
102 
103 #define	PMAP_NEED_PROCWR
104 static inline void
105 pmap_procwr(struct proc *p, vaddr_t va, vsize_t len)
106 {
107 	__asm __volatile("fence\trw,rw; fence.i" ::: "memory");
108 }
109 
110 #include <uvm/pmap/tlb.h>
111 #include <uvm/pmap/pmap_tlb.h>
112 
113 #define	PMAP_GROWKERNEL
114 #define	PMAP_STEAL_MEMORY
115 
116 #ifdef _KERNEL
117 
118 #define	__HAVE_PMAP_MD
119 struct pmap_md {
120 	paddr_t md_ppn;
121 	pd_entry_t *md_pdetab;
122 };
123 
124 struct vm_page *
125 	pmap_md_alloc_poolpage(int flags);
126 vaddr_t	pmap_md_map_poolpage(paddr_t, vsize_t);
127 void	pmap_md_unmap_poolpage(vaddr_t, vsize_t);
128 bool	pmap_md_direct_mapped_vaddr_p(vaddr_t);
129 bool	pmap_md_io_vaddr_p(vaddr_t);
130 paddr_t	pmap_md_direct_mapped_vaddr_to_paddr(vaddr_t);
131 vaddr_t	pmap_md_direct_map_paddr(paddr_t);
132 void	pmap_md_init(void);
133 
134 void	pmap_md_xtab_activate(struct pmap *, struct lwp *);
135 void	pmap_md_xtab_deactivate(struct pmap *);
136 void	pmap_md_pdetab_init(struct pmap *);
137 void	pmap_md_pdetab_fini(struct pmap *);
138 bool	pmap_md_ok_to_steal_p(const uvm_physseg_t, size_t);
139 
140 void	pmap_bootstrap(vaddr_t kstart, vaddr_t kend);
141 
142 extern vaddr_t pmap_direct_base;
143 extern vaddr_t pmap_direct_end;
144 #define	PMAP_DIRECT_MAP(pa)	(pmap_direct_base + (pa))
145 #define	PMAP_DIRECT_UNMAP(va)	((paddr_t)(va) - pmap_direct_base)
146 
147 #define	MEGAPAGE_TRUNC(x)	((x) & ~SEGOFSET)
148 #define	MEGAPAGE_ROUND(x)	MEGAPAGE_TRUNC((x) + SEGOFSET)
149 
150 #ifdef __PMAP_PRIVATE
151 
152 static inline bool
153 pmap_md_tlb_check_entry(void *ctx, vaddr_t va, tlb_asid_t asid, pt_entry_t pte)
154 {
155         // TLB not walked and so not called.
156         return false;
157 }
158 
159 static inline void
160 pmap_md_page_syncicache(struct vm_page_md *mdpg, const kcpuset_t *kc)
161 {
162 	__asm __volatile("fence\trw,rw; fence.i" ::: "memory");
163 }
164 
165 /*
166  * Virtual Cache Alias helper routines.  Not a problem for RISCV CPUs.
167  */
168 static inline bool
169 pmap_md_vca_add(struct vm_page_md *mdpg, vaddr_t va, pt_entry_t *nptep)
170 {
171 	return false;
172 }
173 
174 static inline void
175 pmap_md_vca_remove(struct vm_page_md *mdpg, vaddr_t va)
176 {
177 }
178 
179 static inline void
180 pmap_md_vca_clean(struct vm_page_md *mdpg, vaddr_t va, int op)
181 {
182 }
183 
184 static inline size_t
185 pmap_md_tlb_asid_max(void)
186 {
187 	return PMAP_TLB_NUM_PIDS - 1;
188 }
189 
190 #endif /* __PMAP_PRIVATE */
191 #endif /* _KERNEL */
192 
193 #include <uvm/pmap/pmap.h>
194 
195 #endif /* !_MODULE */
196 
197 #if defined(MODULAR) || defined(_MODULE)
198 /*
199  * Define a compatible vm_page_md so that struct vm_page is the same size
200  * whether we are using modules or not.
201  */
202 #ifndef __HAVE_VM_PAGE_MD
203 #define	__HAVE_VM_PAGE_MD
204 
205 struct vm_page_md {
206 	uintptr_t mdpg_dummy[3];
207 };
208 __CTASSERT(sizeof(struct vm_page_md) == sizeof(uintptr_t)*3);
209 
210 #endif /* !__HAVE_VM_PAGE_MD */
211 
212 #endif /* MODULAR || _MODULE */
213 
214 #endif /* !_RISCV_PMAP_H_ */
215