183a49794SMarc Zyngier /*
283a49794SMarc Zyngier  * Copyright (C) 2012,2013 - ARM Ltd
383a49794SMarc Zyngier  * Author: Marc Zyngier <marc.zyngier@arm.com>
483a49794SMarc Zyngier  *
583a49794SMarc Zyngier  * Derived from arch/arm/include/kvm_emulate.h
683a49794SMarc Zyngier  * Copyright (C) 2012 - Virtual Open Systems and Columbia University
783a49794SMarc Zyngier  * Author: Christoffer Dall <c.dall@virtualopensystems.com>
883a49794SMarc Zyngier  *
983a49794SMarc Zyngier  * This program is free software; you can redistribute it and/or modify
1083a49794SMarc Zyngier  * it under the terms of the GNU General Public License version 2 as
1183a49794SMarc Zyngier  * published by the Free Software Foundation.
1283a49794SMarc Zyngier  *
1383a49794SMarc Zyngier  * This program is distributed in the hope that it will be useful,
1483a49794SMarc Zyngier  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1583a49794SMarc Zyngier  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1683a49794SMarc Zyngier  * GNU General Public License for more details.
1783a49794SMarc Zyngier  *
1883a49794SMarc Zyngier  * You should have received a copy of the GNU General Public License
1983a49794SMarc Zyngier  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
2083a49794SMarc Zyngier  */
2183a49794SMarc Zyngier 
2283a49794SMarc Zyngier #ifndef __ARM64_KVM_EMULATE_H__
2383a49794SMarc Zyngier #define __ARM64_KVM_EMULATE_H__
2483a49794SMarc Zyngier 
2583a49794SMarc Zyngier #include <linux/kvm_host.h>
26c6d01a94SMark Rutland 
27c6d01a94SMark Rutland #include <asm/esr.h>
2883a49794SMarc Zyngier #include <asm/kvm_arm.h>
29c6d01a94SMark Rutland #include <asm/kvm_asm.h>
3083a49794SMarc Zyngier #include <asm/kvm_mmio.h>
3183a49794SMarc Zyngier #include <asm/ptrace.h>
3283a49794SMarc Zyngier 
33b547631fSMarc Zyngier unsigned long *vcpu_reg32(const struct kvm_vcpu *vcpu, u8 reg_num);
34b547631fSMarc Zyngier unsigned long *vcpu_spsr32(const struct kvm_vcpu *vcpu);
35b547631fSMarc Zyngier 
3627b190bdSMarc Zyngier bool kvm_condition_valid32(const struct kvm_vcpu *vcpu);
3727b190bdSMarc Zyngier void kvm_skip_instr32(struct kvm_vcpu *vcpu, bool is_wide_instr);
3827b190bdSMarc Zyngier 
3983a49794SMarc Zyngier void kvm_inject_undefined(struct kvm_vcpu *vcpu);
4083a49794SMarc Zyngier void kvm_inject_dabt(struct kvm_vcpu *vcpu, unsigned long addr);
4183a49794SMarc Zyngier void kvm_inject_pabt(struct kvm_vcpu *vcpu, unsigned long addr);
4283a49794SMarc Zyngier 
43b856a591SChristoffer Dall static inline void vcpu_reset_hcr(struct kvm_vcpu *vcpu)
44b856a591SChristoffer Dall {
45b856a591SChristoffer Dall 	vcpu->arch.hcr_el2 = HCR_GUEST_FLAGS;
46b856a591SChristoffer Dall }
47b856a591SChristoffer Dall 
4883a49794SMarc Zyngier static inline unsigned long *vcpu_pc(const struct kvm_vcpu *vcpu)
4983a49794SMarc Zyngier {
5083a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pc;
5183a49794SMarc Zyngier }
5283a49794SMarc Zyngier 
5383a49794SMarc Zyngier static inline unsigned long *vcpu_elr_el1(const struct kvm_vcpu *vcpu)
5483a49794SMarc Zyngier {
5583a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->elr_el1;
5683a49794SMarc Zyngier }
5783a49794SMarc Zyngier 
5883a49794SMarc Zyngier static inline unsigned long *vcpu_cpsr(const struct kvm_vcpu *vcpu)
5983a49794SMarc Zyngier {
6083a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pstate;
6183a49794SMarc Zyngier }
6283a49794SMarc Zyngier 
6383a49794SMarc Zyngier static inline bool vcpu_mode_is_32bit(const struct kvm_vcpu *vcpu)
6483a49794SMarc Zyngier {
65b547631fSMarc Zyngier 	return !!(*vcpu_cpsr(vcpu) & PSR_MODE32_BIT);
6683a49794SMarc Zyngier }
6783a49794SMarc Zyngier 
6883a49794SMarc Zyngier static inline bool kvm_condition_valid(const struct kvm_vcpu *vcpu)
6983a49794SMarc Zyngier {
7027b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
7127b190bdSMarc Zyngier 		return kvm_condition_valid32(vcpu);
7227b190bdSMarc Zyngier 
7327b190bdSMarc Zyngier 	return true;
7483a49794SMarc Zyngier }
7583a49794SMarc Zyngier 
7683a49794SMarc Zyngier static inline void kvm_skip_instr(struct kvm_vcpu *vcpu, bool is_wide_instr)
7783a49794SMarc Zyngier {
7827b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
7927b190bdSMarc Zyngier 		kvm_skip_instr32(vcpu, is_wide_instr);
8027b190bdSMarc Zyngier 	else
8183a49794SMarc Zyngier 		*vcpu_pc(vcpu) += 4;
8283a49794SMarc Zyngier }
8383a49794SMarc Zyngier 
8483a49794SMarc Zyngier static inline void vcpu_set_thumb(struct kvm_vcpu *vcpu)
8583a49794SMarc Zyngier {
86b547631fSMarc Zyngier 	*vcpu_cpsr(vcpu) |= COMPAT_PSR_T_BIT;
8783a49794SMarc Zyngier }
8883a49794SMarc Zyngier 
8983a49794SMarc Zyngier static inline unsigned long *vcpu_reg(const struct kvm_vcpu *vcpu, u8 reg_num)
9083a49794SMarc Zyngier {
91b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
92b547631fSMarc Zyngier 		return vcpu_reg32(vcpu, reg_num);
93b547631fSMarc Zyngier 
9483a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.regs[reg_num];
9583a49794SMarc Zyngier }
9683a49794SMarc Zyngier 
9783a49794SMarc Zyngier /* Get vcpu SPSR for current mode */
9883a49794SMarc Zyngier static inline unsigned long *vcpu_spsr(const struct kvm_vcpu *vcpu)
9983a49794SMarc Zyngier {
100b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
101b547631fSMarc Zyngier 		return vcpu_spsr32(vcpu);
102b547631fSMarc Zyngier 
10383a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->spsr[KVM_SPSR_EL1];
10483a49794SMarc Zyngier }
10583a49794SMarc Zyngier 
10683a49794SMarc Zyngier static inline bool vcpu_mode_priv(const struct kvm_vcpu *vcpu)
10783a49794SMarc Zyngier {
10883a49794SMarc Zyngier 	u32 mode = *vcpu_cpsr(vcpu) & PSR_MODE_MASK;
10983a49794SMarc Zyngier 
110b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
111b547631fSMarc Zyngier 		return mode > COMPAT_PSR_MODE_USR;
112b547631fSMarc Zyngier 
11383a49794SMarc Zyngier 	return mode != PSR_MODE_EL0t;
11483a49794SMarc Zyngier }
11583a49794SMarc Zyngier 
11683a49794SMarc Zyngier static inline u32 kvm_vcpu_get_hsr(const struct kvm_vcpu *vcpu)
11783a49794SMarc Zyngier {
11883a49794SMarc Zyngier 	return vcpu->arch.fault.esr_el2;
11983a49794SMarc Zyngier }
12083a49794SMarc Zyngier 
12183a49794SMarc Zyngier static inline unsigned long kvm_vcpu_get_hfar(const struct kvm_vcpu *vcpu)
12283a49794SMarc Zyngier {
12383a49794SMarc Zyngier 	return vcpu->arch.fault.far_el2;
12483a49794SMarc Zyngier }
12583a49794SMarc Zyngier 
12683a49794SMarc Zyngier static inline phys_addr_t kvm_vcpu_get_fault_ipa(const struct kvm_vcpu *vcpu)
12783a49794SMarc Zyngier {
12883a49794SMarc Zyngier 	return ((phys_addr_t)vcpu->arch.fault.hpfar_el2 & HPFAR_MASK) << 8;
12983a49794SMarc Zyngier }
13083a49794SMarc Zyngier 
13183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isvalid(const struct kvm_vcpu *vcpu)
13283a49794SMarc Zyngier {
133c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_ISV);
13483a49794SMarc Zyngier }
13583a49794SMarc Zyngier 
13683a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iswrite(const struct kvm_vcpu *vcpu)
13783a49794SMarc Zyngier {
138c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_WNR);
13983a49794SMarc Zyngier }
14083a49794SMarc Zyngier 
14183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_issext(const struct kvm_vcpu *vcpu)
14283a49794SMarc Zyngier {
143c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SSE);
14483a49794SMarc Zyngier }
14583a49794SMarc Zyngier 
14683a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_rd(const struct kvm_vcpu *vcpu)
14783a49794SMarc Zyngier {
148c6d01a94SMark Rutland 	return (kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SRT_MASK) >> ESR_ELx_SRT_SHIFT;
14983a49794SMarc Zyngier }
15083a49794SMarc Zyngier 
15183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isextabt(const struct kvm_vcpu *vcpu)
15283a49794SMarc Zyngier {
153c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_EA);
15483a49794SMarc Zyngier }
15583a49794SMarc Zyngier 
15683a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iss1tw(const struct kvm_vcpu *vcpu)
15783a49794SMarc Zyngier {
158c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_S1PTW);
15983a49794SMarc Zyngier }
16083a49794SMarc Zyngier 
16183a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_as(const struct kvm_vcpu *vcpu)
16283a49794SMarc Zyngier {
163c6d01a94SMark Rutland 	return 1 << ((kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SAS) >> ESR_ELx_SAS_SHIFT);
16483a49794SMarc Zyngier }
16583a49794SMarc Zyngier 
16683a49794SMarc Zyngier /* This one is not specific to Data Abort */
16783a49794SMarc Zyngier static inline bool kvm_vcpu_trap_il_is32bit(const struct kvm_vcpu *vcpu)
16883a49794SMarc Zyngier {
169c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_IL);
17083a49794SMarc Zyngier }
17183a49794SMarc Zyngier 
17283a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_class(const struct kvm_vcpu *vcpu)
17383a49794SMarc Zyngier {
174c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) >> ESR_ELx_EC_SHIFT;
17583a49794SMarc Zyngier }
17683a49794SMarc Zyngier 
17783a49794SMarc Zyngier static inline bool kvm_vcpu_trap_is_iabt(const struct kvm_vcpu *vcpu)
17883a49794SMarc Zyngier {
179c6d01a94SMark Rutland 	return kvm_vcpu_trap_get_class(vcpu) == ESR_ELx_EC_IABT_LOW;
18083a49794SMarc Zyngier }
18183a49794SMarc Zyngier 
18283a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_fault(const struct kvm_vcpu *vcpu)
18383a49794SMarc Zyngier {
184c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC;
1850496daa5SChristoffer Dall }
1860496daa5SChristoffer Dall 
1870496daa5SChristoffer Dall static inline u8 kvm_vcpu_trap_get_fault_type(const struct kvm_vcpu *vcpu)
1880496daa5SChristoffer Dall {
189c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC_TYPE;
19083a49794SMarc Zyngier }
19183a49794SMarc Zyngier 
19279c64880SMarc Zyngier static inline unsigned long kvm_vcpu_get_mpidr(struct kvm_vcpu *vcpu)
19379c64880SMarc Zyngier {
19479c64880SMarc Zyngier 	return vcpu_sys_reg(vcpu, MPIDR_EL1);
19579c64880SMarc Zyngier }
19679c64880SMarc Zyngier 
197ce94fe93SMarc Zyngier static inline void kvm_vcpu_set_be(struct kvm_vcpu *vcpu)
198ce94fe93SMarc Zyngier {
199ce94fe93SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
200ce94fe93SMarc Zyngier 		*vcpu_cpsr(vcpu) |= COMPAT_PSR_E_BIT;
201ce94fe93SMarc Zyngier 	else
202ce94fe93SMarc Zyngier 		vcpu_sys_reg(vcpu, SCTLR_EL1) |= (1 << 25);
203ce94fe93SMarc Zyngier }
204ce94fe93SMarc Zyngier 
2056d89d2d9SMarc Zyngier static inline bool kvm_vcpu_is_be(struct kvm_vcpu *vcpu)
2066d89d2d9SMarc Zyngier {
2076d89d2d9SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
2086d89d2d9SMarc Zyngier 		return !!(*vcpu_cpsr(vcpu) & COMPAT_PSR_E_BIT);
2096d89d2d9SMarc Zyngier 
2106d89d2d9SMarc Zyngier 	return !!(vcpu_sys_reg(vcpu, SCTLR_EL1) & (1 << 25));
2116d89d2d9SMarc Zyngier }
2126d89d2d9SMarc Zyngier 
2136d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_guest_to_host(struct kvm_vcpu *vcpu,
2146d89d2d9SMarc Zyngier 						    unsigned long data,
2156d89d2d9SMarc Zyngier 						    unsigned int len)
2166d89d2d9SMarc Zyngier {
2176d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2186d89d2d9SMarc Zyngier 		switch (len) {
2196d89d2d9SMarc Zyngier 		case 1:
2206d89d2d9SMarc Zyngier 			return data & 0xff;
2216d89d2d9SMarc Zyngier 		case 2:
2226d89d2d9SMarc Zyngier 			return be16_to_cpu(data & 0xffff);
2236d89d2d9SMarc Zyngier 		case 4:
2246d89d2d9SMarc Zyngier 			return be32_to_cpu(data & 0xffffffff);
2256d89d2d9SMarc Zyngier 		default:
2266d89d2d9SMarc Zyngier 			return be64_to_cpu(data);
2276d89d2d9SMarc Zyngier 		}
228b3007086SVictor Kamensky 	} else {
229b3007086SVictor Kamensky 		switch (len) {
230b3007086SVictor Kamensky 		case 1:
231b3007086SVictor Kamensky 			return data & 0xff;
232b3007086SVictor Kamensky 		case 2:
233b3007086SVictor Kamensky 			return le16_to_cpu(data & 0xffff);
234b3007086SVictor Kamensky 		case 4:
235b3007086SVictor Kamensky 			return le32_to_cpu(data & 0xffffffff);
236b3007086SVictor Kamensky 		default:
237b3007086SVictor Kamensky 			return le64_to_cpu(data);
238b3007086SVictor Kamensky 		}
2396d89d2d9SMarc Zyngier 	}
2406d89d2d9SMarc Zyngier 
2416d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
2426d89d2d9SMarc Zyngier }
2436d89d2d9SMarc Zyngier 
2446d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_host_to_guest(struct kvm_vcpu *vcpu,
2456d89d2d9SMarc Zyngier 						    unsigned long data,
2466d89d2d9SMarc Zyngier 						    unsigned int len)
2476d89d2d9SMarc Zyngier {
2486d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2496d89d2d9SMarc Zyngier 		switch (len) {
2506d89d2d9SMarc Zyngier 		case 1:
2516d89d2d9SMarc Zyngier 			return data & 0xff;
2526d89d2d9SMarc Zyngier 		case 2:
2536d89d2d9SMarc Zyngier 			return cpu_to_be16(data & 0xffff);
2546d89d2d9SMarc Zyngier 		case 4:
2556d89d2d9SMarc Zyngier 			return cpu_to_be32(data & 0xffffffff);
2566d89d2d9SMarc Zyngier 		default:
2576d89d2d9SMarc Zyngier 			return cpu_to_be64(data);
2586d89d2d9SMarc Zyngier 		}
259b3007086SVictor Kamensky 	} else {
260b3007086SVictor Kamensky 		switch (len) {
261b3007086SVictor Kamensky 		case 1:
262b3007086SVictor Kamensky 			return data & 0xff;
263b3007086SVictor Kamensky 		case 2:
264b3007086SVictor Kamensky 			return cpu_to_le16(data & 0xffff);
265b3007086SVictor Kamensky 		case 4:
266b3007086SVictor Kamensky 			return cpu_to_le32(data & 0xffffffff);
267b3007086SVictor Kamensky 		default:
268b3007086SVictor Kamensky 			return cpu_to_le64(data);
269b3007086SVictor Kamensky 		}
2706d89d2d9SMarc Zyngier 	}
2716d89d2d9SMarc Zyngier 
2726d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
2736d89d2d9SMarc Zyngier }
2746d89d2d9SMarc Zyngier 
27583a49794SMarc Zyngier #endif /* __ARM64_KVM_EMULATE_H__ */
276