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>
2683a49794SMarc Zyngier #include <asm/kvm_asm.h>
2783a49794SMarc Zyngier #include <asm/kvm_arm.h>
2883a49794SMarc Zyngier #include <asm/kvm_mmio.h>
2983a49794SMarc Zyngier #include <asm/ptrace.h>
3083a49794SMarc Zyngier 
31b547631fSMarc Zyngier unsigned long *vcpu_reg32(const struct kvm_vcpu *vcpu, u8 reg_num);
32b547631fSMarc Zyngier unsigned long *vcpu_spsr32(const struct kvm_vcpu *vcpu);
33b547631fSMarc Zyngier 
3427b190bdSMarc Zyngier bool kvm_condition_valid32(const struct kvm_vcpu *vcpu);
3527b190bdSMarc Zyngier void kvm_skip_instr32(struct kvm_vcpu *vcpu, bool is_wide_instr);
3627b190bdSMarc Zyngier 
3783a49794SMarc Zyngier void kvm_inject_undefined(struct kvm_vcpu *vcpu);
3883a49794SMarc Zyngier void kvm_inject_dabt(struct kvm_vcpu *vcpu, unsigned long addr);
3983a49794SMarc Zyngier void kvm_inject_pabt(struct kvm_vcpu *vcpu, unsigned long addr);
4083a49794SMarc Zyngier 
41b856a591SChristoffer Dall static inline void vcpu_reset_hcr(struct kvm_vcpu *vcpu)
42b856a591SChristoffer Dall {
43b856a591SChristoffer Dall 	vcpu->arch.hcr_el2 = HCR_GUEST_FLAGS;
44801f6772SMarc Zyngier 	if (test_bit(KVM_ARM_VCPU_EL1_32BIT, vcpu->arch.features))
45801f6772SMarc Zyngier 		vcpu->arch.hcr_el2 &= ~HCR_RW;
46b856a591SChristoffer Dall }
47b856a591SChristoffer Dall 
483c1e7165SMarc Zyngier static inline unsigned long vcpu_get_hcr(struct kvm_vcpu *vcpu)
493c1e7165SMarc Zyngier {
503c1e7165SMarc Zyngier 	return vcpu->arch.hcr_el2;
513c1e7165SMarc Zyngier }
523c1e7165SMarc Zyngier 
533c1e7165SMarc Zyngier static inline void vcpu_set_hcr(struct kvm_vcpu *vcpu, unsigned long hcr)
543c1e7165SMarc Zyngier {
553c1e7165SMarc Zyngier 	vcpu->arch.hcr_el2 = hcr;
563c1e7165SMarc Zyngier }
573c1e7165SMarc Zyngier 
5883a49794SMarc Zyngier static inline unsigned long *vcpu_pc(const struct kvm_vcpu *vcpu)
5983a49794SMarc Zyngier {
6083a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pc;
6183a49794SMarc Zyngier }
6283a49794SMarc Zyngier 
6383a49794SMarc Zyngier static inline unsigned long *vcpu_elr_el1(const struct kvm_vcpu *vcpu)
6483a49794SMarc Zyngier {
6583a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->elr_el1;
6683a49794SMarc Zyngier }
6783a49794SMarc Zyngier 
6883a49794SMarc Zyngier static inline unsigned long *vcpu_cpsr(const struct kvm_vcpu *vcpu)
6983a49794SMarc Zyngier {
7083a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.pstate;
7183a49794SMarc Zyngier }
7283a49794SMarc Zyngier 
7383a49794SMarc Zyngier static inline bool vcpu_mode_is_32bit(const struct kvm_vcpu *vcpu)
7483a49794SMarc Zyngier {
75b547631fSMarc Zyngier 	return !!(*vcpu_cpsr(vcpu) & PSR_MODE32_BIT);
7683a49794SMarc Zyngier }
7783a49794SMarc Zyngier 
7883a49794SMarc Zyngier static inline bool kvm_condition_valid(const struct kvm_vcpu *vcpu)
7983a49794SMarc Zyngier {
8027b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
8127b190bdSMarc Zyngier 		return kvm_condition_valid32(vcpu);
8227b190bdSMarc Zyngier 
8327b190bdSMarc Zyngier 	return true;
8483a49794SMarc Zyngier }
8583a49794SMarc Zyngier 
8683a49794SMarc Zyngier static inline void kvm_skip_instr(struct kvm_vcpu *vcpu, bool is_wide_instr)
8783a49794SMarc Zyngier {
8827b190bdSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
8927b190bdSMarc Zyngier 		kvm_skip_instr32(vcpu, is_wide_instr);
9027b190bdSMarc Zyngier 	else
9183a49794SMarc Zyngier 		*vcpu_pc(vcpu) += 4;
9283a49794SMarc Zyngier }
9383a49794SMarc Zyngier 
9483a49794SMarc Zyngier static inline void vcpu_set_thumb(struct kvm_vcpu *vcpu)
9583a49794SMarc Zyngier {
96b547631fSMarc Zyngier 	*vcpu_cpsr(vcpu) |= COMPAT_PSR_T_BIT;
9783a49794SMarc Zyngier }
9883a49794SMarc Zyngier 
9983a49794SMarc Zyngier static inline unsigned long *vcpu_reg(const struct kvm_vcpu *vcpu, u8 reg_num)
10083a49794SMarc Zyngier {
101b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
102b547631fSMarc Zyngier 		return vcpu_reg32(vcpu, reg_num);
103b547631fSMarc Zyngier 
10483a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->regs.regs[reg_num];
10583a49794SMarc Zyngier }
10683a49794SMarc Zyngier 
10783a49794SMarc Zyngier /* Get vcpu SPSR for current mode */
10883a49794SMarc Zyngier static inline unsigned long *vcpu_spsr(const struct kvm_vcpu *vcpu)
10983a49794SMarc Zyngier {
110b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
111b547631fSMarc Zyngier 		return vcpu_spsr32(vcpu);
112b547631fSMarc Zyngier 
11383a49794SMarc Zyngier 	return (unsigned long *)&vcpu_gp_regs(vcpu)->spsr[KVM_SPSR_EL1];
11483a49794SMarc Zyngier }
11583a49794SMarc Zyngier 
11683a49794SMarc Zyngier static inline bool vcpu_mode_priv(const struct kvm_vcpu *vcpu)
11783a49794SMarc Zyngier {
11883a49794SMarc Zyngier 	u32 mode = *vcpu_cpsr(vcpu) & PSR_MODE_MASK;
11983a49794SMarc Zyngier 
120b547631fSMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
121b547631fSMarc Zyngier 		return mode > COMPAT_PSR_MODE_USR;
122b547631fSMarc Zyngier 
12383a49794SMarc Zyngier 	return mode != PSR_MODE_EL0t;
12483a49794SMarc Zyngier }
12583a49794SMarc Zyngier 
12683a49794SMarc Zyngier static inline u32 kvm_vcpu_get_hsr(const struct kvm_vcpu *vcpu)
12783a49794SMarc Zyngier {
12883a49794SMarc Zyngier 	return vcpu->arch.fault.esr_el2;
12983a49794SMarc Zyngier }
13083a49794SMarc Zyngier 
13183a49794SMarc Zyngier static inline unsigned long kvm_vcpu_get_hfar(const struct kvm_vcpu *vcpu)
13283a49794SMarc Zyngier {
13383a49794SMarc Zyngier 	return vcpu->arch.fault.far_el2;
13483a49794SMarc Zyngier }
13583a49794SMarc Zyngier 
13683a49794SMarc Zyngier static inline phys_addr_t kvm_vcpu_get_fault_ipa(const struct kvm_vcpu *vcpu)
13783a49794SMarc Zyngier {
13883a49794SMarc Zyngier 	return ((phys_addr_t)vcpu->arch.fault.hpfar_el2 & HPFAR_MASK) << 8;
13983a49794SMarc Zyngier }
14083a49794SMarc Zyngier 
14183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isvalid(const struct kvm_vcpu *vcpu)
14283a49794SMarc Zyngier {
14383a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_ISV);
14483a49794SMarc Zyngier }
14583a49794SMarc Zyngier 
14683a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iswrite(const struct kvm_vcpu *vcpu)
14783a49794SMarc Zyngier {
14883a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_WNR);
14983a49794SMarc Zyngier }
15083a49794SMarc Zyngier 
15183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_issext(const struct kvm_vcpu *vcpu)
15283a49794SMarc Zyngier {
15383a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SSE);
15483a49794SMarc Zyngier }
15583a49794SMarc Zyngier 
15683a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_rd(const struct kvm_vcpu *vcpu)
15783a49794SMarc Zyngier {
15883a49794SMarc Zyngier 	return (kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SRT_MASK) >> ESR_EL2_SRT_SHIFT;
15983a49794SMarc Zyngier }
16083a49794SMarc Zyngier 
16183a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_isextabt(const struct kvm_vcpu *vcpu)
16283a49794SMarc Zyngier {
16383a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_EA);
16483a49794SMarc Zyngier }
16583a49794SMarc Zyngier 
16683a49794SMarc Zyngier static inline bool kvm_vcpu_dabt_iss1tw(const struct kvm_vcpu *vcpu)
16783a49794SMarc Zyngier {
16883a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_S1PTW);
16983a49794SMarc Zyngier }
17083a49794SMarc Zyngier 
17183a49794SMarc Zyngier static inline int kvm_vcpu_dabt_get_as(const struct kvm_vcpu *vcpu)
17283a49794SMarc Zyngier {
17383a49794SMarc Zyngier 	return 1 << ((kvm_vcpu_get_hsr(vcpu) & ESR_EL2_SAS) >> ESR_EL2_SAS_SHIFT);
17483a49794SMarc Zyngier }
17583a49794SMarc Zyngier 
17683a49794SMarc Zyngier /* This one is not specific to Data Abort */
17783a49794SMarc Zyngier static inline bool kvm_vcpu_trap_il_is32bit(const struct kvm_vcpu *vcpu)
17883a49794SMarc Zyngier {
17983a49794SMarc Zyngier 	return !!(kvm_vcpu_get_hsr(vcpu) & ESR_EL2_IL);
18083a49794SMarc Zyngier }
18183a49794SMarc Zyngier 
18283a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_class(const struct kvm_vcpu *vcpu)
18383a49794SMarc Zyngier {
18483a49794SMarc Zyngier 	return kvm_vcpu_get_hsr(vcpu) >> ESR_EL2_EC_SHIFT;
18583a49794SMarc Zyngier }
18683a49794SMarc Zyngier 
18783a49794SMarc Zyngier static inline bool kvm_vcpu_trap_is_iabt(const struct kvm_vcpu *vcpu)
18883a49794SMarc Zyngier {
18983a49794SMarc Zyngier 	return kvm_vcpu_trap_get_class(vcpu) == ESR_EL2_EC_IABT;
19083a49794SMarc Zyngier }
19183a49794SMarc Zyngier 
19283a49794SMarc Zyngier static inline u8 kvm_vcpu_trap_get_fault(const struct kvm_vcpu *vcpu)
19383a49794SMarc Zyngier {
1940496daa5SChristoffer Dall 	return kvm_vcpu_get_hsr(vcpu) & ESR_EL2_FSC;
1950496daa5SChristoffer Dall }
1960496daa5SChristoffer Dall 
1970496daa5SChristoffer Dall static inline u8 kvm_vcpu_trap_get_fault_type(const struct kvm_vcpu *vcpu)
1980496daa5SChristoffer Dall {
19983a49794SMarc Zyngier 	return kvm_vcpu_get_hsr(vcpu) & ESR_EL2_FSC_TYPE;
20083a49794SMarc Zyngier }
20183a49794SMarc Zyngier 
20279c64880SMarc Zyngier static inline unsigned long kvm_vcpu_get_mpidr(struct kvm_vcpu *vcpu)
20379c64880SMarc Zyngier {
20479c64880SMarc Zyngier 	return vcpu_sys_reg(vcpu, MPIDR_EL1);
20579c64880SMarc Zyngier }
20679c64880SMarc Zyngier 
207ce94fe93SMarc Zyngier static inline void kvm_vcpu_set_be(struct kvm_vcpu *vcpu)
208ce94fe93SMarc Zyngier {
209ce94fe93SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
210ce94fe93SMarc Zyngier 		*vcpu_cpsr(vcpu) |= COMPAT_PSR_E_BIT;
211ce94fe93SMarc Zyngier 	else
212ce94fe93SMarc Zyngier 		vcpu_sys_reg(vcpu, SCTLR_EL1) |= (1 << 25);
213ce94fe93SMarc Zyngier }
214ce94fe93SMarc Zyngier 
2156d89d2d9SMarc Zyngier static inline bool kvm_vcpu_is_be(struct kvm_vcpu *vcpu)
2166d89d2d9SMarc Zyngier {
2176d89d2d9SMarc Zyngier 	if (vcpu_mode_is_32bit(vcpu))
2186d89d2d9SMarc Zyngier 		return !!(*vcpu_cpsr(vcpu) & COMPAT_PSR_E_BIT);
2196d89d2d9SMarc Zyngier 
2206d89d2d9SMarc Zyngier 	return !!(vcpu_sys_reg(vcpu, SCTLR_EL1) & (1 << 25));
2216d89d2d9SMarc Zyngier }
2226d89d2d9SMarc Zyngier 
2236d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_guest_to_host(struct kvm_vcpu *vcpu,
2246d89d2d9SMarc Zyngier 						    unsigned long data,
2256d89d2d9SMarc Zyngier 						    unsigned int len)
2266d89d2d9SMarc Zyngier {
2276d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2286d89d2d9SMarc Zyngier 		switch (len) {
2296d89d2d9SMarc Zyngier 		case 1:
2306d89d2d9SMarc Zyngier 			return data & 0xff;
2316d89d2d9SMarc Zyngier 		case 2:
2326d89d2d9SMarc Zyngier 			return be16_to_cpu(data & 0xffff);
2336d89d2d9SMarc Zyngier 		case 4:
2346d89d2d9SMarc Zyngier 			return be32_to_cpu(data & 0xffffffff);
2356d89d2d9SMarc Zyngier 		default:
2366d89d2d9SMarc Zyngier 			return be64_to_cpu(data);
2376d89d2d9SMarc Zyngier 		}
238b3007086SVictor Kamensky 	} else {
239b3007086SVictor Kamensky 		switch (len) {
240b3007086SVictor Kamensky 		case 1:
241b3007086SVictor Kamensky 			return data & 0xff;
242b3007086SVictor Kamensky 		case 2:
243b3007086SVictor Kamensky 			return le16_to_cpu(data & 0xffff);
244b3007086SVictor Kamensky 		case 4:
245b3007086SVictor Kamensky 			return le32_to_cpu(data & 0xffffffff);
246b3007086SVictor Kamensky 		default:
247b3007086SVictor Kamensky 			return le64_to_cpu(data);
248b3007086SVictor Kamensky 		}
2496d89d2d9SMarc Zyngier 	}
2506d89d2d9SMarc Zyngier 
2516d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
2526d89d2d9SMarc Zyngier }
2536d89d2d9SMarc Zyngier 
2546d89d2d9SMarc Zyngier static inline unsigned long vcpu_data_host_to_guest(struct kvm_vcpu *vcpu,
2556d89d2d9SMarc Zyngier 						    unsigned long data,
2566d89d2d9SMarc Zyngier 						    unsigned int len)
2576d89d2d9SMarc Zyngier {
2586d89d2d9SMarc Zyngier 	if (kvm_vcpu_is_be(vcpu)) {
2596d89d2d9SMarc Zyngier 		switch (len) {
2606d89d2d9SMarc Zyngier 		case 1:
2616d89d2d9SMarc Zyngier 			return data & 0xff;
2626d89d2d9SMarc Zyngier 		case 2:
2636d89d2d9SMarc Zyngier 			return cpu_to_be16(data & 0xffff);
2646d89d2d9SMarc Zyngier 		case 4:
2656d89d2d9SMarc Zyngier 			return cpu_to_be32(data & 0xffffffff);
2666d89d2d9SMarc Zyngier 		default:
2676d89d2d9SMarc Zyngier 			return cpu_to_be64(data);
2686d89d2d9SMarc Zyngier 		}
269b3007086SVictor Kamensky 	} else {
270b3007086SVictor Kamensky 		switch (len) {
271b3007086SVictor Kamensky 		case 1:
272b3007086SVictor Kamensky 			return data & 0xff;
273b3007086SVictor Kamensky 		case 2:
274b3007086SVictor Kamensky 			return cpu_to_le16(data & 0xffff);
275b3007086SVictor Kamensky 		case 4:
276b3007086SVictor Kamensky 			return cpu_to_le32(data & 0xffffffff);
277b3007086SVictor Kamensky 		default:
278b3007086SVictor Kamensky 			return cpu_to_le64(data);
279b3007086SVictor Kamensky 		}
2806d89d2d9SMarc Zyngier 	}
2816d89d2d9SMarc Zyngier 
2826d89d2d9SMarc Zyngier 	return data;		/* Leave LE untouched */
2836d89d2d9SMarc Zyngier }
2846d89d2d9SMarc Zyngier 
28583a49794SMarc Zyngier #endif /* __ARM64_KVM_EMULATE_H__ */
286