1 /*
2  * Copyright (C) 2012,2013 - ARM Ltd
3  * Author: Marc Zyngier <marc.zyngier@arm.com>
4  *
5  * Derived from arch/arm/include/kvm_emulate.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 __ARM64_KVM_EMULATE_H__
23 #define __ARM64_KVM_EMULATE_H__
24 
25 #include <linux/kvm_host.h>
26 
27 #include <asm/esr.h>
28 #include <asm/kvm_arm.h>
29 #include <asm/kvm_mmio.h>
30 #include <asm/ptrace.h>
31 #include <asm/cputype.h>
32 
33 unsigned long *vcpu_reg32(const struct kvm_vcpu *vcpu, u8 reg_num);
34 unsigned long *vcpu_spsr32(const struct kvm_vcpu *vcpu);
35 
36 bool kvm_condition_valid32(const struct kvm_vcpu *vcpu);
37 void kvm_skip_instr32(struct kvm_vcpu *vcpu, bool is_wide_instr);
38 
39 void kvm_inject_undefined(struct kvm_vcpu *vcpu);
40 void kvm_inject_dabt(struct kvm_vcpu *vcpu, unsigned long addr);
41 void kvm_inject_pabt(struct kvm_vcpu *vcpu, unsigned long addr);
42 
43 static inline void vcpu_reset_hcr(struct kvm_vcpu *vcpu)
44 {
45 	vcpu->arch.hcr_el2 = HCR_GUEST_FLAGS;
46 	if (test_bit(KVM_ARM_VCPU_EL1_32BIT, vcpu->arch.features))
47 		vcpu->arch.hcr_el2 &= ~HCR_RW;
48 }
49 
50 static inline unsigned long vcpu_get_hcr(struct kvm_vcpu *vcpu)
51 {
52 	return vcpu->arch.hcr_el2;
53 }
54 
55 static inline void vcpu_set_hcr(struct kvm_vcpu *vcpu, unsigned long hcr)
56 {
57 	vcpu->arch.hcr_el2 = hcr;
58 }
59 
60 static inline unsigned long *vcpu_pc(const struct kvm_vcpu *vcpu)
61 {
62 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pc;
63 }
64 
65 static inline unsigned long *vcpu_elr_el1(const struct kvm_vcpu *vcpu)
66 {
67 	return (unsigned long *)&vcpu_gp_regs(vcpu)->elr_el1;
68 }
69 
70 static inline unsigned long *vcpu_cpsr(const struct kvm_vcpu *vcpu)
71 {
72 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pstate;
73 }
74 
75 static inline bool vcpu_mode_is_32bit(const struct kvm_vcpu *vcpu)
76 {
77 	return !!(*vcpu_cpsr(vcpu) & PSR_MODE32_BIT);
78 }
79 
80 static inline bool kvm_condition_valid(const struct kvm_vcpu *vcpu)
81 {
82 	if (vcpu_mode_is_32bit(vcpu))
83 		return kvm_condition_valid32(vcpu);
84 
85 	return true;
86 }
87 
88 static inline void kvm_skip_instr(struct kvm_vcpu *vcpu, bool is_wide_instr)
89 {
90 	if (vcpu_mode_is_32bit(vcpu))
91 		kvm_skip_instr32(vcpu, is_wide_instr);
92 	else
93 		*vcpu_pc(vcpu) += 4;
94 }
95 
96 static inline void vcpu_set_thumb(struct kvm_vcpu *vcpu)
97 {
98 	*vcpu_cpsr(vcpu) |= COMPAT_PSR_T_BIT;
99 }
100 
101 /*
102  * vcpu_get_reg and vcpu_set_reg should always be passed a register number
103  * coming from a read of ESR_EL2. Otherwise, it may give the wrong result on
104  * AArch32 with banked registers.
105  */
106 static inline unsigned long vcpu_get_reg(const struct kvm_vcpu *vcpu,
107 					 u8 reg_num)
108 {
109 	return (reg_num == 31) ? 0 : vcpu_gp_regs(vcpu)->regs.regs[reg_num];
110 }
111 
112 static inline void vcpu_set_reg(struct kvm_vcpu *vcpu, u8 reg_num,
113 				unsigned long val)
114 {
115 	if (reg_num != 31)
116 		vcpu_gp_regs(vcpu)->regs.regs[reg_num] = val;
117 }
118 
119 /* Get vcpu SPSR for current mode */
120 static inline unsigned long *vcpu_spsr(const struct kvm_vcpu *vcpu)
121 {
122 	if (vcpu_mode_is_32bit(vcpu))
123 		return vcpu_spsr32(vcpu);
124 
125 	return (unsigned long *)&vcpu_gp_regs(vcpu)->spsr[KVM_SPSR_EL1];
126 }
127 
128 static inline bool vcpu_mode_priv(const struct kvm_vcpu *vcpu)
129 {
130 	u32 mode;
131 
132 	if (vcpu_mode_is_32bit(vcpu)) {
133 		mode = *vcpu_cpsr(vcpu) & COMPAT_PSR_MODE_MASK;
134 		return mode > COMPAT_PSR_MODE_USR;
135 	}
136 
137 	mode = *vcpu_cpsr(vcpu) & PSR_MODE_MASK;
138 
139 	return mode != PSR_MODE_EL0t;
140 }
141 
142 static inline u32 kvm_vcpu_get_hsr(const struct kvm_vcpu *vcpu)
143 {
144 	return vcpu->arch.fault.esr_el2;
145 }
146 
147 static inline unsigned long kvm_vcpu_get_hfar(const struct kvm_vcpu *vcpu)
148 {
149 	return vcpu->arch.fault.far_el2;
150 }
151 
152 static inline phys_addr_t kvm_vcpu_get_fault_ipa(const struct kvm_vcpu *vcpu)
153 {
154 	return ((phys_addr_t)vcpu->arch.fault.hpfar_el2 & HPFAR_MASK) << 8;
155 }
156 
157 static inline u32 kvm_vcpu_hvc_get_imm(const struct kvm_vcpu *vcpu)
158 {
159 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_xVC_IMM_MASK;
160 }
161 
162 static inline bool kvm_vcpu_dabt_isvalid(const struct kvm_vcpu *vcpu)
163 {
164 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_ISV);
165 }
166 
167 static inline bool kvm_vcpu_dabt_iswrite(const struct kvm_vcpu *vcpu)
168 {
169 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_WNR);
170 }
171 
172 static inline bool kvm_vcpu_dabt_issext(const struct kvm_vcpu *vcpu)
173 {
174 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SSE);
175 }
176 
177 static inline int kvm_vcpu_dabt_get_rd(const struct kvm_vcpu *vcpu)
178 {
179 	return (kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SRT_MASK) >> ESR_ELx_SRT_SHIFT;
180 }
181 
182 static inline bool kvm_vcpu_dabt_isextabt(const struct kvm_vcpu *vcpu)
183 {
184 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_EA);
185 }
186 
187 static inline bool kvm_vcpu_dabt_iss1tw(const struct kvm_vcpu *vcpu)
188 {
189 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_S1PTW);
190 }
191 
192 static inline int kvm_vcpu_dabt_get_as(const struct kvm_vcpu *vcpu)
193 {
194 	return 1 << ((kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SAS) >> ESR_ELx_SAS_SHIFT);
195 }
196 
197 /* This one is not specific to Data Abort */
198 static inline bool kvm_vcpu_trap_il_is32bit(const struct kvm_vcpu *vcpu)
199 {
200 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_IL);
201 }
202 
203 static inline u8 kvm_vcpu_trap_get_class(const struct kvm_vcpu *vcpu)
204 {
205 	return kvm_vcpu_get_hsr(vcpu) >> ESR_ELx_EC_SHIFT;
206 }
207 
208 static inline bool kvm_vcpu_trap_is_iabt(const struct kvm_vcpu *vcpu)
209 {
210 	return kvm_vcpu_trap_get_class(vcpu) == ESR_ELx_EC_IABT_LOW;
211 }
212 
213 static inline u8 kvm_vcpu_trap_get_fault(const struct kvm_vcpu *vcpu)
214 {
215 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC;
216 }
217 
218 static inline u8 kvm_vcpu_trap_get_fault_type(const struct kvm_vcpu *vcpu)
219 {
220 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC_TYPE;
221 }
222 
223 static inline unsigned long kvm_vcpu_get_mpidr_aff(struct kvm_vcpu *vcpu)
224 {
225 	return vcpu_sys_reg(vcpu, MPIDR_EL1) & MPIDR_HWID_BITMASK;
226 }
227 
228 static inline void kvm_vcpu_set_be(struct kvm_vcpu *vcpu)
229 {
230 	if (vcpu_mode_is_32bit(vcpu))
231 		*vcpu_cpsr(vcpu) |= COMPAT_PSR_E_BIT;
232 	else
233 		vcpu_sys_reg(vcpu, SCTLR_EL1) |= (1 << 25);
234 }
235 
236 static inline bool kvm_vcpu_is_be(struct kvm_vcpu *vcpu)
237 {
238 	if (vcpu_mode_is_32bit(vcpu))
239 		return !!(*vcpu_cpsr(vcpu) & COMPAT_PSR_E_BIT);
240 
241 	return !!(vcpu_sys_reg(vcpu, SCTLR_EL1) & (1 << 25));
242 }
243 
244 static inline unsigned long vcpu_data_guest_to_host(struct kvm_vcpu *vcpu,
245 						    unsigned long data,
246 						    unsigned int len)
247 {
248 	if (kvm_vcpu_is_be(vcpu)) {
249 		switch (len) {
250 		case 1:
251 			return data & 0xff;
252 		case 2:
253 			return be16_to_cpu(data & 0xffff);
254 		case 4:
255 			return be32_to_cpu(data & 0xffffffff);
256 		default:
257 			return be64_to_cpu(data);
258 		}
259 	} else {
260 		switch (len) {
261 		case 1:
262 			return data & 0xff;
263 		case 2:
264 			return le16_to_cpu(data & 0xffff);
265 		case 4:
266 			return le32_to_cpu(data & 0xffffffff);
267 		default:
268 			return le64_to_cpu(data);
269 		}
270 	}
271 
272 	return data;		/* Leave LE untouched */
273 }
274 
275 static inline unsigned long vcpu_data_host_to_guest(struct kvm_vcpu *vcpu,
276 						    unsigned long data,
277 						    unsigned int len)
278 {
279 	if (kvm_vcpu_is_be(vcpu)) {
280 		switch (len) {
281 		case 1:
282 			return data & 0xff;
283 		case 2:
284 			return cpu_to_be16(data & 0xffff);
285 		case 4:
286 			return cpu_to_be32(data & 0xffffffff);
287 		default:
288 			return cpu_to_be64(data);
289 		}
290 	} else {
291 		switch (len) {
292 		case 1:
293 			return data & 0xff;
294 		case 2:
295 			return cpu_to_le16(data & 0xffff);
296 		case 4:
297 			return cpu_to_le32(data & 0xffffffff);
298 		default:
299 			return cpu_to_le64(data);
300 		}
301 	}
302 
303 	return data;		/* Leave LE untouched */
304 }
305 
306 #endif /* __ARM64_KVM_EMULATE_H__ */
307