xref: /linux/arch/mips/include/uapi/asm/kvm.h (revision be709d48329a500621d2a05835283150ae137b45) 
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * This file is subject to the terms and conditions of the GNU General Public
4  * License.  See the file "COPYING" in the main directory of this archive
5  * for more details.
6  *
7  * Copyright (C) 2012  MIPS Technologies, Inc.  All rights reserved.
8  * Copyright (C) 2013 Cavium, Inc.
9  * Authors: Sanjay Lal <sanjayl@kymasys.com>
10  */
11 
12 #ifndef __LINUX_KVM_MIPS_H
13 #define __LINUX_KVM_MIPS_H
14 
15 #include <linux/types.h>
16 
17 /*
18  * KVM MIPS specific structures and definitions.
19  *
20  * Some parts derived from the x86 version of this file.
21  */
22 
23 #define __KVM_HAVE_READONLY_MEM
24 
25 #define KVM_COALESCED_MMIO_PAGE_OFFSET 1
26 
27 /*
28  * for KVM_GET_REGS and KVM_SET_REGS
29  *
30  * If Config[AT] is zero (32-bit CPU), the register contents are
31  * stored in the lower 32-bits of the struct kvm_regs fields and sign
32  * extended to 64-bits.
33  */
34 struct kvm_regs {
35 	/* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
36 	__u64 gpr[32];
37 	__u64 hi;
38 	__u64 lo;
39 	__u64 pc;
40 };
41 
42 /*
43  * for KVM_GET_FPU and KVM_SET_FPU
44  */
45 struct kvm_fpu {
46 };
47 
48 
49 /*
50  * For MIPS, we use KVM_SET_ONE_REG and KVM_GET_ONE_REG to access various
51  * registers.  The id field is broken down as follows:
52  *
53  *  bits[63..52] - As per linux/kvm.h
54  *  bits[51..32] - Must be zero.
55  *  bits[31..16] - Register set.
56  *
57  * Register set = 0: GP registers from kvm_regs (see definitions below).
58  *
59  * Register set = 1: CP0 registers.
60  *  bits[15..8]  - COP0 register set.
61  *
62  *  COP0 register set = 0: Main CP0 registers.
63  *   bits[7..3]   - Register 'rd'  index.
64  *   bits[2..0]   - Register 'sel' index.
65  *
66  *  COP0 register set = 1: MAARs.
67  *   bits[7..0]   - MAAR index.
68  *
69  * Register set = 2: KVM specific registers (see definitions below).
70  *
71  * Register set = 3: FPU / MSA registers (see definitions below).
72  *
73  * Other sets registers may be added in the future.  Each set would
74  * have its own identifier in bits[31..16].
75  */
76 
77 #define KVM_REG_MIPS_GP		(KVM_REG_MIPS | 0x0000000000000000ULL)
78 #define KVM_REG_MIPS_CP0	(KVM_REG_MIPS | 0x0000000000010000ULL)
79 #define KVM_REG_MIPS_KVM	(KVM_REG_MIPS | 0x0000000000020000ULL)
80 #define KVM_REG_MIPS_FPU	(KVM_REG_MIPS | 0x0000000000030000ULL)
81 
82 
83 /*
84  * KVM_REG_MIPS_GP - General purpose registers from kvm_regs.
85  */
86 
87 #define KVM_REG_MIPS_R0		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  0)
88 #define KVM_REG_MIPS_R1		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  1)
89 #define KVM_REG_MIPS_R2		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  2)
90 #define KVM_REG_MIPS_R3		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  3)
91 #define KVM_REG_MIPS_R4		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  4)
92 #define KVM_REG_MIPS_R5		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  5)
93 #define KVM_REG_MIPS_R6		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  6)
94 #define KVM_REG_MIPS_R7		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  7)
95 #define KVM_REG_MIPS_R8		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  8)
96 #define KVM_REG_MIPS_R9		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 |  9)
97 #define KVM_REG_MIPS_R10	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 10)
98 #define KVM_REG_MIPS_R11	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 11)
99 #define KVM_REG_MIPS_R12	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 12)
100 #define KVM_REG_MIPS_R13	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 13)
101 #define KVM_REG_MIPS_R14	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 14)
102 #define KVM_REG_MIPS_R15	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 15)
103 #define KVM_REG_MIPS_R16	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 16)
104 #define KVM_REG_MIPS_R17	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 17)
105 #define KVM_REG_MIPS_R18	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 18)
106 #define KVM_REG_MIPS_R19	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 19)
107 #define KVM_REG_MIPS_R20	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 20)
108 #define KVM_REG_MIPS_R21	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 21)
109 #define KVM_REG_MIPS_R22	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 22)
110 #define KVM_REG_MIPS_R23	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 23)
111 #define KVM_REG_MIPS_R24	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 24)
112 #define KVM_REG_MIPS_R25	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 25)
113 #define KVM_REG_MIPS_R26	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 26)
114 #define KVM_REG_MIPS_R27	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 27)
115 #define KVM_REG_MIPS_R28	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 28)
116 #define KVM_REG_MIPS_R29	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 29)
117 #define KVM_REG_MIPS_R30	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 30)
118 #define KVM_REG_MIPS_R31	(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 31)
119 
120 #define KVM_REG_MIPS_HI		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 32)
121 #define KVM_REG_MIPS_LO		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 33)
122 #define KVM_REG_MIPS_PC		(KVM_REG_MIPS_GP | KVM_REG_SIZE_U64 | 34)
123 
124 
125 /*
126  * KVM_REG_MIPS_CP0 - Coprocessor 0 registers.
127  */
128 
129 #define KVM_REG_MIPS_MAAR	(KVM_REG_MIPS_CP0 | (1 << 8))
130 #define KVM_REG_MIPS_CP0_MAAR(n)	(KVM_REG_MIPS_MAAR | \
131 					 KVM_REG_SIZE_U64 | (n))
132 
133 
134 /*
135  * KVM_REG_MIPS_KVM - KVM specific control registers.
136  */
137 
138 /*
139  * CP0_Count control
140  * DC:    Set 0: Master disable CP0_Count and set COUNT_RESUME to now
141  *        Set 1: Master re-enable CP0_Count with unchanged bias, handling timer
142  *               interrupts since COUNT_RESUME
143  *        This can be used to freeze the timer to get a consistent snapshot of
144  *        the CP0_Count and timer interrupt pending state, while also resuming
145  *        safely without losing time or guest timer interrupts.
146  * Other: Reserved, do not change.
147  */
148 #define KVM_REG_MIPS_COUNT_CTL	    (KVM_REG_MIPS_KVM | KVM_REG_SIZE_U64 | 0)
149 #define KVM_REG_MIPS_COUNT_CTL_DC	0x00000001
150 
151 /*
152  * CP0_Count resume monotonic nanoseconds
153  * The monotonic nanosecond time of the last set of COUNT_CTL.DC (master
154  * disable). Any reads and writes of Count related registers while
155  * COUNT_CTL.DC=1 will appear to occur at this time. When COUNT_CTL.DC is
156  * cleared again (master enable) any timer interrupts since this time will be
157  * emulated.
158  * Modifications to times in the future are rejected.
159  */
160 #define KVM_REG_MIPS_COUNT_RESUME   (KVM_REG_MIPS_KVM | KVM_REG_SIZE_U64 | 1)
161 /*
162  * CP0_Count rate in Hz
163  * Specifies the rate of the CP0_Count timer in Hz. Modifications occur without
164  * discontinuities in CP0_Count.
165  */
166 #define KVM_REG_MIPS_COUNT_HZ	    (KVM_REG_MIPS_KVM | KVM_REG_SIZE_U64 | 2)
167 
168 
169 /*
170  * KVM_REG_MIPS_FPU - Floating Point and MIPS SIMD Architecture (MSA) registers.
171  *
172  *  bits[15..8]  - Register subset (see definitions below).
173  *  bits[7..5]   - Must be zero.
174  *  bits[4..0]   - Register number within register subset.
175  */
176 
177 #define KVM_REG_MIPS_FPR	(KVM_REG_MIPS_FPU | 0x0000000000000000ULL)
178 #define KVM_REG_MIPS_FCR	(KVM_REG_MIPS_FPU | 0x0000000000000100ULL)
179 #define KVM_REG_MIPS_MSACR	(KVM_REG_MIPS_FPU | 0x0000000000000200ULL)
180 
181 /*
182  * KVM_REG_MIPS_FPR - Floating point / Vector registers.
183  */
184 #define KVM_REG_MIPS_FPR_32(n)	(KVM_REG_MIPS_FPR | KVM_REG_SIZE_U32  | (n))
185 #define KVM_REG_MIPS_FPR_64(n)	(KVM_REG_MIPS_FPR | KVM_REG_SIZE_U64  | (n))
186 #define KVM_REG_MIPS_VEC_128(n)	(KVM_REG_MIPS_FPR | KVM_REG_SIZE_U128 | (n))
187 
188 /*
189  * KVM_REG_MIPS_FCR - Floating point control registers.
190  */
191 #define KVM_REG_MIPS_FCR_IR	(KVM_REG_MIPS_FCR | KVM_REG_SIZE_U32 |  0)
192 #define KVM_REG_MIPS_FCR_CSR	(KVM_REG_MIPS_FCR | KVM_REG_SIZE_U32 | 31)
193 
194 /*
195  * KVM_REG_MIPS_MSACR - MIPS SIMD Architecture (MSA) control registers.
196  */
197 #define KVM_REG_MIPS_MSA_IR	 (KVM_REG_MIPS_MSACR | KVM_REG_SIZE_U32 |  0)
198 #define KVM_REG_MIPS_MSA_CSR	 (KVM_REG_MIPS_MSACR | KVM_REG_SIZE_U32 |  1)
199 
200 
201 /*
202  * KVM MIPS specific structures and definitions
203  *
204  */
205 struct kvm_debug_exit_arch {
206 	__u64 epc;
207 };
208 
209 /* for KVM_SET_GUEST_DEBUG */
210 struct kvm_guest_debug_arch {
211 };
212 
213 /* definition of registers in kvm_run */
214 struct kvm_sync_regs {
215 };
216 
217 /* dummy definition */
218 struct kvm_sregs {
219 };
220 
221 struct kvm_mips_interrupt {
222 	/* in */
223 	__u32 cpu;
224 	__u32 irq;
225 };
226 
227 #endif /* __LINUX_KVM_MIPS_H */
228