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>
324429fc64SAndre Przywara #include <asm/cputype.h>
3383a49794SMarc Zyngier 
34b547631fSMarc Zyngier unsigned long *vcpu_reg32(const struct kvm_vcpu *vcpu, u8 reg_num);
35b547631fSMarc Zyngier unsigned long *vcpu_spsr32(const struct kvm_vcpu *vcpu);
36b547631fSMarc Zyngier 
3727b190bdSMarc Zyngier bool kvm_condition_valid32(const struct kvm_vcpu *vcpu);
3827b190bdSMarc Zyngier void kvm_skip_instr32(struct kvm_vcpu *vcpu, bool is_wide_instr);
3927b190bdSMarc Zyngier 
4083a49794SMarc Zyngier void kvm_inject_undefined(struct kvm_vcpu *vcpu);
4183a49794SMarc Zyngier void kvm_inject_dabt(struct kvm_vcpu *vcpu, unsigned long addr);
4283a49794SMarc Zyngier void kvm_inject_pabt(struct kvm_vcpu *vcpu, unsigned long addr);
4383a49794SMarc Zyngier 
44b856a591SChristoffer Dall static inline void vcpu_reset_hcr(struct kvm_vcpu *vcpu)
45b856a591SChristoffer Dall {
46b856a591SChristoffer Dall 	vcpu->arch.hcr_el2 = HCR_GUEST_FLAGS;
47801f6772SMarc Zyngier 	if (test_bit(KVM_ARM_VCPU_EL1_32BIT, vcpu->arch.features))
48801f6772SMarc Zyngier 		vcpu->arch.hcr_el2 &= ~HCR_RW;
49b856a591SChristoffer Dall }
50b856a591SChristoffer Dall 
513c1e7165SMarc Zyngier static inline unsigned long vcpu_get_hcr(struct kvm_vcpu *vcpu)
523c1e7165SMarc Zyngier {
533c1e7165SMarc Zyngier 	return vcpu->arch.hcr_el2;
543c1e7165SMarc Zyngier }
553c1e7165SMarc Zyngier 
563c1e7165SMarc Zyngier static inline void vcpu_set_hcr(struct kvm_vcpu *vcpu, unsigned long hcr)
573c1e7165SMarc Zyngier {
583c1e7165SMarc Zyngier 	vcpu->arch.hcr_el2 = hcr;
593c1e7165SMarc Zyngier }
603c1e7165SMarc Zyngier 
6183a49794SMarc Zyngier static inline unsigned long *vcpu_pc(const struct kvm_vcpu *vcpu)
6283a49794SMarc Zyngier {
6383a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pc;
6483a49794SMarc Zyngier }
6583a49794SMarc Zyngier 
6683a49794SMarc Zyngier static inline unsigned long *vcpu_elr_el1(const struct kvm_vcpu *vcpu)
6783a49794SMarc Zyngier {
6883a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->elr_el1;
6983a49794SMarc Zyngier }
7083a49794SMarc Zyngier 
7183a49794SMarc Zyngier static inline unsigned long *vcpu_cpsr(const struct kvm_vcpu *vcpu)
7283a49794SMarc Zyngier {
7383a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pstate;
7483a49794SMarc Zyngier }
7583a49794SMarc Zyngier 
7683a49794SMarc Zyngier static inline bool vcpu_mode_is_32bit(const struct kvm_vcpu *vcpu)
7783a49794SMarc Zyngier {
78b547631fSMarc Zyngier 	return !!(*vcpu_cpsr(vcpu) & PSR_MODE32_BIT);
7983a49794SMarc Zyngier }
8083a49794SMarc Zyngier 
8183a49794SMarc Zyngier static inline bool kvm_condition_valid(const struct kvm_vcpu *vcpu)
8283a49794SMarc Zyngier {
8327b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
8427b190bdSMarc Zyngier 		return kvm_condition_valid32(vcpu);
8527b190bdSMarc Zyngier 
8627b190bdSMarc Zyngier 	return true;
8783a49794SMarc Zyngier }
8883a49794SMarc Zyngier 
8983a49794SMarc Zyngier static inline void kvm_skip_instr(struct kvm_vcpu *vcpu, bool is_wide_instr)
9083a49794SMarc Zyngier {
9127b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
9227b190bdSMarc Zyngier 		kvm_skip_instr32(vcpu, is_wide_instr);
9327b190bdSMarc Zyngier 	else
9483a49794SMarc Zyngier 		*vcpu_pc(vcpu) += 4;
9583a49794SMarc Zyngier }
9683a49794SMarc Zyngier 
9783a49794SMarc Zyngier static inline void vcpu_set_thumb(struct kvm_vcpu *vcpu)
9883a49794SMarc Zyngier {
99b547631fSMarc Zyngier 	*vcpu_cpsr(vcpu) |= COMPAT_PSR_T_BIT;
10083a49794SMarc Zyngier }
10183a49794SMarc Zyngier 
102c0f09634SMarc Zyngier /*
103c0f09634SMarc Zyngier  * vcpu_reg should always be passed a register number coming from a
104c0f09634SMarc Zyngier  * read of ESR_EL2. Otherwise, it may give the wrong result on AArch32
105c0f09634SMarc Zyngier  * with banked registers.
106c0f09634SMarc Zyngier  */
10783a49794SMarc Zyngier static inline unsigned long *vcpu_reg(const struct kvm_vcpu *vcpu, u8 reg_num)
10883a49794SMarc Zyngier {
10983a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.regs[reg_num];
11083a49794SMarc Zyngier }
11183a49794SMarc Zyngier 
112bc45a516SPavel Fedin static inline unsigned long vcpu_get_reg(const struct kvm_vcpu *vcpu,
113bc45a516SPavel Fedin 					 u8 reg_num)
114bc45a516SPavel Fedin {
115bc45a516SPavel Fedin 	return (reg_num == 31) ? 0 : vcpu_gp_regs(vcpu)->regs.regs[reg_num];
116bc45a516SPavel Fedin }
117bc45a516SPavel Fedin 
118bc45a516SPavel Fedin static inline void vcpu_set_reg(struct kvm_vcpu *vcpu, u8 reg_num,
119bc45a516SPavel Fedin 				unsigned long val)
120bc45a516SPavel Fedin {
121bc45a516SPavel Fedin 	if (reg_num != 31)
122bc45a516SPavel Fedin 		vcpu_gp_regs(vcpu)->regs.regs[reg_num] = val;
123bc45a516SPavel Fedin }
124bc45a516SPavel Fedin 
12583a49794SMarc Zyngier /* Get vcpu SPSR for current mode */
12683a49794SMarc Zyngier static inline unsigned long *vcpu_spsr(const struct kvm_vcpu *vcpu)
12783a49794SMarc Zyngier {
128b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
129b547631fSMarc Zyngier 		return vcpu_spsr32(vcpu);
130b547631fSMarc Zyngier 
13183a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->spsr[KVM_SPSR_EL1];
13283a49794SMarc Zyngier }
13383a49794SMarc Zyngier 
13483a49794SMarc Zyngier static inline bool vcpu_mode_priv(const struct kvm_vcpu *vcpu)
13583a49794SMarc Zyngier {
13683a49794SMarc Zyngier 	u32 mode = *vcpu_cpsr(vcpu) & PSR_MODE_MASK;
13783a49794SMarc Zyngier 
138b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
139b547631fSMarc Zyngier 		return mode > COMPAT_PSR_MODE_USR;
140b547631fSMarc Zyngier 
14183a49794SMarc Zyngier 	return mode != PSR_MODE_EL0t;
14283a49794SMarc Zyngier }
14383a49794SMarc Zyngier 
14483a49794SMarc Zyngier static inline u32 kvm_vcpu_get_hsr(const struct kvm_vcpu *vcpu)
14583a49794SMarc Zyngier {
14683a49794SMarc Zyngier 	return vcpu->arch.fault.esr_el2;
14783a49794SMarc Zyngier }
14883a49794SMarc Zyngier 
14983a49794SMarc Zyngier static inline unsigned long kvm_vcpu_get_hfar(const struct kvm_vcpu *vcpu)
15083a49794SMarc Zyngier {
15183a49794SMarc Zyngier 	return vcpu->arch.fault.far_el2;
15283a49794SMarc Zyngier }
15383a49794SMarc Zyngier 
15483a49794SMarc Zyngier static inline phys_addr_t kvm_vcpu_get_fault_ipa(const struct kvm_vcpu *vcpu)
15583a49794SMarc Zyngier {
15683a49794SMarc Zyngier 	return ((phys_addr_t)vcpu->arch.fault.hpfar_el2 & HPFAR_MASK) << 8;
15783a49794SMarc Zyngier }
15883a49794SMarc Zyngier 
1590d97f884SWei Huang static inline u32 kvm_vcpu_hvc_get_imm(const struct kvm_vcpu *vcpu)
1600d97f884SWei Huang {
1611c6007d5SPaolo Bonzini 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_xVC_IMM_MASK;
1620d97f884SWei Huang }
1630d97f884SWei Huang 
16483a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isvalid(const struct kvm_vcpu *vcpu)
16583a49794SMarc Zyngier {
166c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_ISV);
16783a49794SMarc Zyngier }
16883a49794SMarc Zyngier 
16983a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iswrite(const struct kvm_vcpu *vcpu)
17083a49794SMarc Zyngier {
171c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_WNR);
17283a49794SMarc Zyngier }
17383a49794SMarc Zyngier 
17483a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_issext(const struct kvm_vcpu *vcpu)
17583a49794SMarc Zyngier {
176c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SSE);
17783a49794SMarc Zyngier }
17883a49794SMarc Zyngier 
17983a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_rd(const struct kvm_vcpu *vcpu)
18083a49794SMarc Zyngier {
181c6d01a94SMark Rutland 	return (kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SRT_MASK) >> ESR_ELx_SRT_SHIFT;
18283a49794SMarc Zyngier }
18383a49794SMarc Zyngier 
18483a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isextabt(const struct kvm_vcpu *vcpu)
18583a49794SMarc Zyngier {
186c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_EA);
18783a49794SMarc Zyngier }
18883a49794SMarc Zyngier 
18983a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iss1tw(const struct kvm_vcpu *vcpu)
19083a49794SMarc Zyngier {
191c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_S1PTW);
19283a49794SMarc Zyngier }
19383a49794SMarc Zyngier 
19483a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_as(const struct kvm_vcpu *vcpu)
19583a49794SMarc Zyngier {
196c6d01a94SMark Rutland 	return 1 << ((kvm_vcpu_get_hsr(vcpu) & ESR_ELx_SAS) >> ESR_ELx_SAS_SHIFT);
19783a49794SMarc Zyngier }
19883a49794SMarc Zyngier 
19983a49794SMarc Zyngier /* This one is not specific to Data Abort */
20083a49794SMarc Zyngier static inline bool kvm_vcpu_trap_il_is32bit(const struct kvm_vcpu *vcpu)
20183a49794SMarc Zyngier {
202c6d01a94SMark Rutland 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_ELx_IL);
20383a49794SMarc Zyngier }
20483a49794SMarc Zyngier 
20583a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_class(const struct kvm_vcpu *vcpu)
20683a49794SMarc Zyngier {
207c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) >> ESR_ELx_EC_SHIFT;
20883a49794SMarc Zyngier }
20983a49794SMarc Zyngier 
21083a49794SMarc Zyngier static inline bool kvm_vcpu_trap_is_iabt(const struct kvm_vcpu *vcpu)
21183a49794SMarc Zyngier {
212c6d01a94SMark Rutland 	return kvm_vcpu_trap_get_class(vcpu) == ESR_ELx_EC_IABT_LOW;
21383a49794SMarc Zyngier }
21483a49794SMarc Zyngier 
21583a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_fault(const struct kvm_vcpu *vcpu)
21683a49794SMarc Zyngier {
217c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC;
2180496daa5SChristoffer Dall }
2190496daa5SChristoffer Dall 
2200496daa5SChristoffer Dall static inline u8 kvm_vcpu_trap_get_fault_type(const struct kvm_vcpu *vcpu)
2210496daa5SChristoffer Dall {
222c6d01a94SMark Rutland 	return kvm_vcpu_get_hsr(vcpu) & ESR_ELx_FSC_TYPE;
22383a49794SMarc Zyngier }
22483a49794SMarc Zyngier 
2254429fc64SAndre Przywara static inline unsigned long kvm_vcpu_get_mpidr_aff(struct kvm_vcpu *vcpu)
22679c64880SMarc Zyngier {
2274429fc64SAndre Przywara 	return vcpu_sys_reg(vcpu, MPIDR_EL1) & MPIDR_HWID_BITMASK;
22879c64880SMarc Zyngier }
22979c64880SMarc Zyngier 
230ce94fe93SMarc Zyngier static inline void kvm_vcpu_set_be(struct kvm_vcpu *vcpu)
231ce94fe93SMarc Zyngier {
232ce94fe93SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
233ce94fe93SMarc Zyngier 		*vcpu_cpsr(vcpu) |= COMPAT_PSR_E_BIT;
234ce94fe93SMarc Zyngier 	else
235ce94fe93SMarc Zyngier 		vcpu_sys_reg(vcpu, SCTLR_EL1) |= (1 << 25);
236ce94fe93SMarc Zyngier }
237ce94fe93SMarc Zyngier 
2386d89d2d9SMarc Zyngier static inline bool kvm_vcpu_is_be(struct kvm_vcpu *vcpu)
2396d89d2d9SMarc Zyngier {
2406d89d2d9SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
2416d89d2d9SMarc Zyngier 		return !!(*vcpu_cpsr(vcpu) & COMPAT_PSR_E_BIT);
2426d89d2d9SMarc Zyngier 
2436d89d2d9SMarc Zyngier 	return !!(vcpu_sys_reg(vcpu, SCTLR_EL1) & (1 << 25));
2446d89d2d9SMarc Zyngier }
2456d89d2d9SMarc Zyngier 
2466d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_guest_to_host(struct kvm_vcpu *vcpu,
2476d89d2d9SMarc Zyngier 						    unsigned long data,
2486d89d2d9SMarc Zyngier 						    unsigned int len)
2496d89d2d9SMarc Zyngier {
2506d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2516d89d2d9SMarc Zyngier 		switch (len) {
2526d89d2d9SMarc Zyngier 		case 1:
2536d89d2d9SMarc Zyngier 			return data & 0xff;
2546d89d2d9SMarc Zyngier 		case 2:
2556d89d2d9SMarc Zyngier 			return be16_to_cpu(data & 0xffff);
2566d89d2d9SMarc Zyngier 		case 4:
2576d89d2d9SMarc Zyngier 			return be32_to_cpu(data & 0xffffffff);
2586d89d2d9SMarc Zyngier 		default:
2596d89d2d9SMarc Zyngier 			return be64_to_cpu(data);
2606d89d2d9SMarc Zyngier 		}
261b3007086SVictor Kamensky 	} else {
262b3007086SVictor Kamensky 		switch (len) {
263b3007086SVictor Kamensky 		case 1:
264b3007086SVictor Kamensky 			return data & 0xff;
265b3007086SVictor Kamensky 		case 2:
266b3007086SVictor Kamensky 			return le16_to_cpu(data & 0xffff);
267b3007086SVictor Kamensky 		case 4:
268b3007086SVictor Kamensky 			return le32_to_cpu(data & 0xffffffff);
269b3007086SVictor Kamensky 		default:
270b3007086SVictor Kamensky 			return le64_to_cpu(data);
271b3007086SVictor Kamensky 		}
2726d89d2d9SMarc Zyngier 	}
2736d89d2d9SMarc Zyngier 
2746d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
2756d89d2d9SMarc Zyngier }
2766d89d2d9SMarc Zyngier 
2776d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_host_to_guest(struct kvm_vcpu *vcpu,
2786d89d2d9SMarc Zyngier 						    unsigned long data,
2796d89d2d9SMarc Zyngier 						    unsigned int len)
2806d89d2d9SMarc Zyngier {
2816d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2826d89d2d9SMarc Zyngier 		switch (len) {
2836d89d2d9SMarc Zyngier 		case 1:
2846d89d2d9SMarc Zyngier 			return data & 0xff;
2856d89d2d9SMarc Zyngier 		case 2:
2866d89d2d9SMarc Zyngier 			return cpu_to_be16(data & 0xffff);
2876d89d2d9SMarc Zyngier 		case 4:
2886d89d2d9SMarc Zyngier 			return cpu_to_be32(data & 0xffffffff);
2896d89d2d9SMarc Zyngier 		default:
2906d89d2d9SMarc Zyngier 			return cpu_to_be64(data);
2916d89d2d9SMarc Zyngier 		}
292b3007086SVictor Kamensky 	} else {
293b3007086SVictor Kamensky 		switch (len) {
294b3007086SVictor Kamensky 		case 1:
295b3007086SVictor Kamensky 			return data & 0xff;
296b3007086SVictor Kamensky 		case 2:
297b3007086SVictor Kamensky 			return cpu_to_le16(data & 0xffff);
298b3007086SVictor Kamensky 		case 4:
299b3007086SVictor Kamensky 			return cpu_to_le32(data & 0xffffffff);
300b3007086SVictor Kamensky 		default:
301b3007086SVictor Kamensky 			return cpu_to_le64(data);
302b3007086SVictor Kamensky 		}
3036d89d2d9SMarc Zyngier 	}
3046d89d2d9SMarc Zyngier 
3056d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
3066d89d2d9SMarc Zyngier }
3076d89d2d9SMarc Zyngier 
30883a49794SMarc Zyngier #endif /* __ARM64_KVM_EMULATE_H__ */
309