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