xref: /freebsd/lib/libkvm/kvm_riscv.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * Copyright (c) 2015 John H. Baldwin <jhb@FreeBSD.org>
3  * Copyright (c) 2019 Mitchell Horne
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef __KVM_RISCV_H__
30 #define	__KVM_RISCV_H__
31 
32 #ifdef __riscv
33 #include <machine/pte.h>
34 #endif
35 
36 typedef uint64_t	riscv_physaddr_t;
37 typedef uint64_t	riscv_pt_entry_t;
38 
39 #define	RISCV_PAGE_SHIFT	12
40 #define	RISCV_PAGE_SIZE		(1 << RISCV_PAGE_SHIFT)
41 #define	RISCV_PAGE_MASK		(RISCV_PAGE_SIZE - 1)
42 
43 /* Source: sys/riscv/include/pte.h */
44 #define	RISCV_L3_SHIFT		12
45 #define	RISCV_L3_SIZE		(1 << L3_SHIFT)
46 #define	RISCV_L3_OFFSET 	(L3_SIZE - 1)
47 
48 #define	RISCV_PTE_SW_MANAGED	(1 << 9)
49 #define	RISCV_PTE_SW_WIRED	(1 << 8)
50 #define	RISCV_PTE_D		(1 << 7) /* Dirty */
51 #define	RISCV_PTE_A		(1 << 6) /* Accessed */
52 #define	RISCV_PTE_G		(1 << 5) /* Global */
53 #define	RISCV_PTE_U		(1 << 4) /* User */
54 #define	RISCV_PTE_X		(1 << 3) /* Execute */
55 #define	RISCV_PTE_W		(1 << 2) /* Write */
56 #define	RISCV_PTE_R		(1 << 1) /* Read */
57 #define	RISCV_PTE_V		(1 << 0) /* Valid */
58 #define	RISCV_PTE_RWX		(RISCV_PTE_R | RISCV_PTE_W | RISCV_PTE_X)
59 
60 #define	RISCV_PTE_PPN0_S	10
61 
62 #ifdef __riscv
63 _Static_assert(sizeof(pt_entry_t) == sizeof(riscv_pt_entry_t),
64     "pt_entry_t size mismatch");
65 
66 _Static_assert(PAGE_SHIFT == RISCV_PAGE_SHIFT, "PAGE_SHIFT mismatch");
67 _Static_assert(PAGE_SIZE == RISCV_PAGE_SIZE, "PAGE_SIZE mismatch");
68 _Static_assert(PAGE_MASK == RISCV_PAGE_MASK, "PAGE_MASK mismatch");
69 
70 _Static_assert(L3_SHIFT == RISCV_L3_SHIFT, "L3_SHIFT mismatch");
71 _Static_assert(L3_SIZE == RISCV_L3_SIZE, "L3_SIZE mismatch");
72 _Static_assert(L3_OFFSET == RISCV_L3_OFFSET, "L3_OFFSET mismatch");
73 _Static_assert(PTE_PPN0_S == RISCV_PTE_PPN0_S, "PTE_PPN0_S mismatch");
74 
75 _Static_assert(PTE_SW_MANAGED == RISCV_PTE_SW_MANAGED,
76     "PTE_SW_MANAGED mismatch");
77 _Static_assert(PTE_SW_WIRED == RISCV_PTE_SW_WIRED, "PTE_SW_WIRED mismatch");
78 _Static_assert(PTE_D == RISCV_PTE_D, "PTE_D mismatch");
79 _Static_assert(PTE_A == RISCV_PTE_A, "PTE_A mismatch");
80 _Static_assert(PTE_G == RISCV_PTE_G, "PTE_G mismatch");
81 _Static_assert(PTE_U == RISCV_PTE_U, "PTE_U mismatch");
82 _Static_assert(PTE_X == RISCV_PTE_X, "PTE_X mismatch");
83 _Static_assert(PTE_W == RISCV_PTE_W, "PTE_W mismatch");
84 _Static_assert(PTE_R == RISCV_PTE_R, "PTE_R mismatch");
85 _Static_assert(PTE_V == RISCV_PTE_V, "PTE_V mismatch");
86 _Static_assert(PTE_RWX == RISCV_PTE_RWX, "PTE_RWX mismatch");
87 #endif
88 
89 #endif /* !__KVM_RISCV_H__ */
90