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