xref: /openbmc/linux/arch/arm64/include/uapi/asm/kvm.h (revision 8b235f2f)
1 /*
2  * Copyright (C) 2012,2013 - ARM Ltd
3  * Author: Marc Zyngier <marc.zyngier@arm.com>
4  *
5  * Derived from arch/arm/include/uapi/asm/kvm.h:
6  * Copyright (C) 2012 - Virtual Open Systems and Columbia University
7  * Author: Christoffer Dall <c.dall@virtualopensystems.com>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef __ARM_KVM_H__
23 #define __ARM_KVM_H__
24 
25 #define KVM_SPSR_EL1	0
26 #define KVM_SPSR_SVC	KVM_SPSR_EL1
27 #define KVM_SPSR_ABT	1
28 #define KVM_SPSR_UND	2
29 #define KVM_SPSR_IRQ	3
30 #define KVM_SPSR_FIQ	4
31 #define KVM_NR_SPSR	5
32 
33 #ifndef __ASSEMBLY__
34 #include <linux/psci.h>
35 #include <asm/types.h>
36 #include <asm/ptrace.h>
37 
38 #define __KVM_HAVE_GUEST_DEBUG
39 #define __KVM_HAVE_IRQ_LINE
40 #define __KVM_HAVE_READONLY_MEM
41 
42 #define KVM_REG_SIZE(id)						\
43 	(1U << (((id) & KVM_REG_SIZE_MASK) >> KVM_REG_SIZE_SHIFT))
44 
45 struct kvm_regs {
46 	struct user_pt_regs regs;	/* sp = sp_el0 */
47 
48 	__u64	sp_el1;
49 	__u64	elr_el1;
50 
51 	__u64	spsr[KVM_NR_SPSR];
52 
53 	struct user_fpsimd_state fp_regs;
54 };
55 
56 /* Supported Processor Types */
57 #define KVM_ARM_TARGET_AEM_V8		0
58 #define KVM_ARM_TARGET_FOUNDATION_V8	1
59 #define KVM_ARM_TARGET_CORTEX_A57	2
60 #define KVM_ARM_TARGET_XGENE_POTENZA	3
61 #define KVM_ARM_TARGET_CORTEX_A53	4
62 
63 #define KVM_ARM_NUM_TARGETS		5
64 
65 /* KVM_ARM_SET_DEVICE_ADDR ioctl id encoding */
66 #define KVM_ARM_DEVICE_TYPE_SHIFT	0
67 #define KVM_ARM_DEVICE_TYPE_MASK	(0xffff << KVM_ARM_DEVICE_TYPE_SHIFT)
68 #define KVM_ARM_DEVICE_ID_SHIFT		16
69 #define KVM_ARM_DEVICE_ID_MASK		(0xffff << KVM_ARM_DEVICE_ID_SHIFT)
70 
71 /* Supported device IDs */
72 #define KVM_ARM_DEVICE_VGIC_V2		0
73 
74 /* Supported VGIC address types  */
75 #define KVM_VGIC_V2_ADDR_TYPE_DIST	0
76 #define KVM_VGIC_V2_ADDR_TYPE_CPU	1
77 
78 #define KVM_VGIC_V2_DIST_SIZE		0x1000
79 #define KVM_VGIC_V2_CPU_SIZE		0x2000
80 
81 /* Supported VGICv3 address types  */
82 #define KVM_VGIC_V3_ADDR_TYPE_DIST	2
83 #define KVM_VGIC_V3_ADDR_TYPE_REDIST	3
84 
85 #define KVM_VGIC_V3_DIST_SIZE		SZ_64K
86 #define KVM_VGIC_V3_REDIST_SIZE		(2 * SZ_64K)
87 
88 #define KVM_ARM_VCPU_POWER_OFF		0 /* CPU is started in OFF state */
89 #define KVM_ARM_VCPU_EL1_32BIT		1 /* CPU running a 32bit VM */
90 #define KVM_ARM_VCPU_PSCI_0_2		2 /* CPU uses PSCI v0.2 */
91 
92 struct kvm_vcpu_init {
93 	__u32 target;
94 	__u32 features[7];
95 };
96 
97 struct kvm_sregs {
98 };
99 
100 struct kvm_fpu {
101 };
102 
103 struct kvm_guest_debug_arch {
104 };
105 
106 struct kvm_debug_exit_arch {
107 };
108 
109 struct kvm_sync_regs {
110 };
111 
112 struct kvm_arch_memory_slot {
113 };
114 
115 /* If you need to interpret the index values, here is the key: */
116 #define KVM_REG_ARM_COPROC_MASK		0x000000000FFF0000
117 #define KVM_REG_ARM_COPROC_SHIFT	16
118 
119 /* Normal registers are mapped as coprocessor 16. */
120 #define KVM_REG_ARM_CORE		(0x0010 << KVM_REG_ARM_COPROC_SHIFT)
121 #define KVM_REG_ARM_CORE_REG(name)	(offsetof(struct kvm_regs, name) / sizeof(__u32))
122 
123 /* Some registers need more space to represent values. */
124 #define KVM_REG_ARM_DEMUX		(0x0011 << KVM_REG_ARM_COPROC_SHIFT)
125 #define KVM_REG_ARM_DEMUX_ID_MASK	0x000000000000FF00
126 #define KVM_REG_ARM_DEMUX_ID_SHIFT	8
127 #define KVM_REG_ARM_DEMUX_ID_CCSIDR	(0x00 << KVM_REG_ARM_DEMUX_ID_SHIFT)
128 #define KVM_REG_ARM_DEMUX_VAL_MASK	0x00000000000000FF
129 #define KVM_REG_ARM_DEMUX_VAL_SHIFT	0
130 
131 /* AArch64 system registers */
132 #define KVM_REG_ARM64_SYSREG		(0x0013 << KVM_REG_ARM_COPROC_SHIFT)
133 #define KVM_REG_ARM64_SYSREG_OP0_MASK	0x000000000000c000
134 #define KVM_REG_ARM64_SYSREG_OP0_SHIFT	14
135 #define KVM_REG_ARM64_SYSREG_OP1_MASK	0x0000000000003800
136 #define KVM_REG_ARM64_SYSREG_OP1_SHIFT	11
137 #define KVM_REG_ARM64_SYSREG_CRN_MASK	0x0000000000000780
138 #define KVM_REG_ARM64_SYSREG_CRN_SHIFT	7
139 #define KVM_REG_ARM64_SYSREG_CRM_MASK	0x0000000000000078
140 #define KVM_REG_ARM64_SYSREG_CRM_SHIFT	3
141 #define KVM_REG_ARM64_SYSREG_OP2_MASK	0x0000000000000007
142 #define KVM_REG_ARM64_SYSREG_OP2_SHIFT	0
143 
144 #define ARM64_SYS_REG_SHIFT_MASK(x,n) \
145 	(((x) << KVM_REG_ARM64_SYSREG_ ## n ## _SHIFT) & \
146 	KVM_REG_ARM64_SYSREG_ ## n ## _MASK)
147 
148 #define __ARM64_SYS_REG(op0,op1,crn,crm,op2) \
149 	(KVM_REG_ARM64 | KVM_REG_ARM64_SYSREG | \
150 	ARM64_SYS_REG_SHIFT_MASK(op0, OP0) | \
151 	ARM64_SYS_REG_SHIFT_MASK(op1, OP1) | \
152 	ARM64_SYS_REG_SHIFT_MASK(crn, CRN) | \
153 	ARM64_SYS_REG_SHIFT_MASK(crm, CRM) | \
154 	ARM64_SYS_REG_SHIFT_MASK(op2, OP2))
155 
156 #define ARM64_SYS_REG(...) (__ARM64_SYS_REG(__VA_ARGS__) | KVM_REG_SIZE_U64)
157 
158 #define KVM_REG_ARM_TIMER_CTL		ARM64_SYS_REG(3, 3, 14, 3, 1)
159 #define KVM_REG_ARM_TIMER_CNT		ARM64_SYS_REG(3, 3, 14, 3, 2)
160 #define KVM_REG_ARM_TIMER_CVAL		ARM64_SYS_REG(3, 3, 14, 0, 2)
161 
162 /* Device Control API: ARM VGIC */
163 #define KVM_DEV_ARM_VGIC_GRP_ADDR	0
164 #define KVM_DEV_ARM_VGIC_GRP_DIST_REGS	1
165 #define KVM_DEV_ARM_VGIC_GRP_CPU_REGS	2
166 #define   KVM_DEV_ARM_VGIC_CPUID_SHIFT	32
167 #define   KVM_DEV_ARM_VGIC_CPUID_MASK	(0xffULL << KVM_DEV_ARM_VGIC_CPUID_SHIFT)
168 #define   KVM_DEV_ARM_VGIC_OFFSET_SHIFT	0
169 #define   KVM_DEV_ARM_VGIC_OFFSET_MASK	(0xffffffffULL << KVM_DEV_ARM_VGIC_OFFSET_SHIFT)
170 #define KVM_DEV_ARM_VGIC_GRP_NR_IRQS	3
171 #define KVM_DEV_ARM_VGIC_GRP_CTRL	4
172 #define   KVM_DEV_ARM_VGIC_CTRL_INIT	0
173 
174 /* KVM_IRQ_LINE irq field index values */
175 #define KVM_ARM_IRQ_TYPE_SHIFT		24
176 #define KVM_ARM_IRQ_TYPE_MASK		0xff
177 #define KVM_ARM_IRQ_VCPU_SHIFT		16
178 #define KVM_ARM_IRQ_VCPU_MASK		0xff
179 #define KVM_ARM_IRQ_NUM_SHIFT		0
180 #define KVM_ARM_IRQ_NUM_MASK		0xffff
181 
182 /* irq_type field */
183 #define KVM_ARM_IRQ_TYPE_CPU		0
184 #define KVM_ARM_IRQ_TYPE_SPI		1
185 #define KVM_ARM_IRQ_TYPE_PPI		2
186 
187 /* out-of-kernel GIC cpu interrupt injection irq_number field */
188 #define KVM_ARM_IRQ_CPU_IRQ		0
189 #define KVM_ARM_IRQ_CPU_FIQ		1
190 
191 /*
192  * This used to hold the highest supported SPI, but it is now obsolete
193  * and only here to provide source code level compatibility with older
194  * userland. The highest SPI number can be set via KVM_DEV_ARM_VGIC_GRP_NR_IRQS.
195  */
196 #ifndef __KERNEL__
197 #define KVM_ARM_IRQ_GIC_MAX		127
198 #endif
199 
200 /* One single KVM irqchip, ie. the VGIC */
201 #define KVM_NR_IRQCHIPS          1
202 
203 /* PSCI interface */
204 #define KVM_PSCI_FN_BASE		0x95c1ba5e
205 #define KVM_PSCI_FN(n)			(KVM_PSCI_FN_BASE + (n))
206 
207 #define KVM_PSCI_FN_CPU_SUSPEND		KVM_PSCI_FN(0)
208 #define KVM_PSCI_FN_CPU_OFF		KVM_PSCI_FN(1)
209 #define KVM_PSCI_FN_CPU_ON		KVM_PSCI_FN(2)
210 #define KVM_PSCI_FN_MIGRATE		KVM_PSCI_FN(3)
211 
212 #define KVM_PSCI_RET_SUCCESS		PSCI_RET_SUCCESS
213 #define KVM_PSCI_RET_NI			PSCI_RET_NOT_SUPPORTED
214 #define KVM_PSCI_RET_INVAL		PSCI_RET_INVALID_PARAMS
215 #define KVM_PSCI_RET_DENIED		PSCI_RET_DENIED
216 
217 #endif
218 
219 #endif /* __ARM_KVM_H__ */
220