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 #include <asm/kvm_asm.h>
27 #include <asm/kvm_arm.h>
28 #include <asm/kvm_mmio.h>
29 #include <asm/ptrace.h>
30 
31 unsigned long *vcpu_reg32(const struct kvm_vcpu *vcpu, u8 reg_num);
32 unsigned long *vcpu_spsr32(const struct kvm_vcpu *vcpu);
33 
34 bool kvm_condition_valid32(const struct kvm_vcpu *vcpu);
35 void kvm_skip_instr32(struct kvm_vcpu *vcpu, bool is_wide_instr);
36 
37 void kvm_inject_undefined(struct kvm_vcpu *vcpu);
38 void kvm_inject_dabt(struct kvm_vcpu *vcpu, unsigned long addr);
39 void kvm_inject_pabt(struct kvm_vcpu *vcpu, unsigned long addr);
40 
41 static inline void vcpu_reset_hcr(struct kvm_vcpu *vcpu)
42 {
43 	vcpu->arch.hcr_el2 = HCR_GUEST_FLAGS;
44 	if (test_bit(KVM_ARM_VCPU_EL1_32BIT, vcpu->arch.features))
45 		vcpu->arch.hcr_el2 &= ~HCR_RW;
46 }
47 
48 static inline unsigned long vcpu_get_hcr(struct kvm_vcpu *vcpu)
49 {
50 	return vcpu->arch.hcr_el2;
51 }
52 
53 static inline void vcpu_set_hcr(struct kvm_vcpu *vcpu, unsigned long hcr)
54 {
55 	vcpu->arch.hcr_el2 = hcr;
56 }
57 
58 static inline unsigned long *vcpu_pc(const struct kvm_vcpu *vcpu)
59 {
60 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pc;
61 }
62 
63 static inline unsigned long *vcpu_elr_el1(const struct kvm_vcpu *vcpu)
64 {
65 	return (unsigned long *)&vcpu_gp_regs(vcpu)->elr_el1;
66 }
67 
68 static inline unsigned long *vcpu_cpsr(const struct kvm_vcpu *vcpu)
69 {
70 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pstate;
71 }
72 
73 static inline bool vcpu_mode_is_32bit(const struct kvm_vcpu *vcpu)
74 {
75 	return !!(*vcpu_cpsr(vcpu) & PSR_MODE32_BIT);
76 }
77 
78 static inline bool kvm_condition_valid(const struct kvm_vcpu *vcpu)
79 {
80 	if (vcpu_mode_is_32bit(vcpu))
81 		return kvm_condition_valid32(vcpu);
82 
83 	return true;
84 }
85 
86 static inline void kvm_skip_instr(struct kvm_vcpu *vcpu, bool is_wide_instr)
87 {
88 	if (vcpu_mode_is_32bit(vcpu))
89 		kvm_skip_instr32(vcpu, is_wide_instr);
90 	else
91 		*vcpu_pc(vcpu) += 4;
92 }
93 
94 static inline void vcpu_set_thumb(struct kvm_vcpu *vcpu)
95 {
96 	*vcpu_cpsr(vcpu) |= COMPAT_PSR_T_BIT;
97 }
98 
99 static inline unsigned long *vcpu_reg(const struct kvm_vcpu *vcpu, u8 reg_num)
100 {
101 	if (vcpu_mode_is_32bit(vcpu))
102 		return vcpu_reg32(vcpu, reg_num);
103 
104 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.regs[reg_num];
105 }
106 
107 /* Get vcpu SPSR for current mode */
108 static inline unsigned long *vcpu_spsr(const struct kvm_vcpu *vcpu)
109 {
110 	if (vcpu_mode_is_32bit(vcpu))
111 		return vcpu_spsr32(vcpu);
112 
113 	return (unsigned long *)&vcpu_gp_regs(vcpu)->spsr[KVM_SPSR_EL1];
114 }
115 
116 static inline bool vcpu_mode_priv(const struct kvm_vcpu *vcpu)
117 {
118 	u32 mode = *vcpu_cpsr(vcpu) & PSR_MODE_MASK;
119 
120 	if (vcpu_mode_is_32bit(vcpu))
121 		return mode > COMPAT_PSR_MODE_USR;
122 
123 	return mode != PSR_MODE_EL0t;
124 }
125 
126 static inline u32 kvm_vcpu_get_hsr(const struct kvm_vcpu *vcpu)
127 {
128 	return vcpu->arch.fault.esr_el2;
129 }
130 
131 static inline unsigned long kvm_vcpu_get_hfar(const struct kvm_vcpu *vcpu)
132 {
133 	return vcpu->arch.fault.far_el2;
134 }
135 
136 static inline phys_addr_t kvm_vcpu_get_fault_ipa(const struct kvm_vcpu *vcpu)
137 {
138 	return ((phys_addr_t)vcpu->arch.fault.hpfar_el2 & HPFAR_MASK) << 8;
139 }
140 
141 static inline bool kvm_vcpu_dabt_isvalid(const struct kvm_vcpu *vcpu)
142 {
143 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_ISV);
144 }
145 
146 static inline bool kvm_vcpu_dabt_iswrite(const struct kvm_vcpu *vcpu)
147 {
148 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_WNR);
149 }
150 
151 static inline bool kvm_vcpu_dabt_issext(const struct kvm_vcpu *vcpu)
152 {
153 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SSE);
154 }
155 
156 static inline int kvm_vcpu_dabt_get_rd(const struct kvm_vcpu *vcpu)
157 {
158 	return (kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SRT_MASK) >> ESR_EL2_SRT_SHIFT;
159 }
160 
161 static inline bool kvm_vcpu_dabt_isextabt(const struct kvm_vcpu *vcpu)
162 {
163 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_EA);
164 }
165 
166 static inline bool kvm_vcpu_dabt_iss1tw(const struct kvm_vcpu *vcpu)
167 {
168 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_S1PTW);
169 }
170 
171 static inline int kvm_vcpu_dabt_get_as(const struct kvm_vcpu *vcpu)
172 {
173 	return 1 << ((kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SAS) >> ESR_EL2_SAS_SHIFT);
174 }
175 
176 /* This one is not specific to Data Abort */
177 static inline bool kvm_vcpu_trap_il_is32bit(const struct kvm_vcpu *vcpu)
178 {
179 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_IL);
180 }
181 
182 static inline u8 kvm_vcpu_trap_get_class(const struct kvm_vcpu *vcpu)
183 {
184 	return kvm_vcpu_get_hsr(vcpu) >> ESR_EL2_EC_SHIFT;
185 }
186 
187 static inline bool kvm_vcpu_trap_is_iabt(const struct kvm_vcpu *vcpu)
188 {
189 	return kvm_vcpu_trap_get_class(vcpu) == ESR_EL2_EC_IABT;
190 }
191 
192 static inline u8 kvm_vcpu_trap_get_fault(const struct kvm_vcpu *vcpu)
193 {
194 	return kvm_vcpu_get_hsr(vcpu) & ESR_EL2_FSC;
195 }
196 
197 static inline u8 kvm_vcpu_trap_get_fault_type(const struct kvm_vcpu *vcpu)
198 {
199 	return kvm_vcpu_get_hsr(vcpu) & ESR_EL2_FSC_TYPE;
200 }
201 
202 static inline unsigned long kvm_vcpu_get_mpidr(struct kvm_vcpu *vcpu)
203 {
204 	return vcpu_sys_reg(vcpu, MPIDR_EL1);
205 }
206 
207 static inline void kvm_vcpu_set_be(struct kvm_vcpu *vcpu)
208 {
209 	if (vcpu_mode_is_32bit(vcpu))
210 		*vcpu_cpsr(vcpu) |= COMPAT_PSR_E_BIT;
211 	else
212 		vcpu_sys_reg(vcpu, SCTLR_EL1) |= (1 << 25);
213 }
214 
215 static inline bool kvm_vcpu_is_be(struct kvm_vcpu *vcpu)
216 {
217 	if (vcpu_mode_is_32bit(vcpu))
218 		return !!(*vcpu_cpsr(vcpu) & COMPAT_PSR_E_BIT);
219 
220 	return !!(vcpu_sys_reg(vcpu, SCTLR_EL1) & (1 << 25));
221 }
222 
223 static inline unsigned long vcpu_data_guest_to_host(struct kvm_vcpu *vcpu,
224 						    unsigned long data,
225 						    unsigned int len)
226 {
227 	if (kvm_vcpu_is_be(vcpu)) {
228 		switch (len) {
229 		case 1:
230 			return data & 0xff;
231 		case 2:
232 			return be16_to_cpu(data & 0xffff);
233 		case 4:
234 			return be32_to_cpu(data & 0xffffffff);
235 		default:
236 			return be64_to_cpu(data);
237 		}
238 	} else {
239 		switch (len) {
240 		case 1:
241 			return data & 0xff;
242 		case 2:
243 			return le16_to_cpu(data & 0xffff);
244 		case 4:
245 			return le32_to_cpu(data & 0xffffffff);
246 		default:
247 			return le64_to_cpu(data);
248 		}
249 	}
250 
251 	return data;		/* Leave LE untouched */
252 }
253 
254 static inline unsigned long vcpu_data_host_to_guest(struct kvm_vcpu *vcpu,
255 						    unsigned long data,
256 						    unsigned int len)
257 {
258 	if (kvm_vcpu_is_be(vcpu)) {
259 		switch (len) {
260 		case 1:
261 			return data & 0xff;
262 		case 2:
263 			return cpu_to_be16(data & 0xffff);
264 		case 4:
265 			return cpu_to_be32(data & 0xffffffff);
266 		default:
267 			return cpu_to_be64(data);
268 		}
269 	} else {
270 		switch (len) {
271 		case 1:
272 			return data & 0xff;
273 		case 2:
274 			return cpu_to_le16(data & 0xffff);
275 		case 4:
276 			return cpu_to_le32(data & 0xffffffff);
277 		default:
278 			return cpu_to_le64(data);
279 		}
280 	}
281 
282 	return data;		/* Leave LE untouched */
283 }
284 
285 #endif /* __ARM64_KVM_EMULATE_H__ */
286