xref: /linux/arch/riscv/include/asm/kvm_vcpu_sbi.h (revision 63eb28bb1402891b1ad2be02a530f29a9dd7f1cd)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /**
3  * Copyright (c) 2021 Western Digital Corporation or its affiliates.
4  *
5  * Authors:
6  *     Atish Patra <atish.patra@wdc.com>
7  */
8 
9 #ifndef __RISCV_KVM_VCPU_SBI_H__
10 #define __RISCV_KVM_VCPU_SBI_H__
11 
12 #define KVM_SBI_IMPID 3
13 
14 #define KVM_SBI_VERSION_MAJOR 2
15 #define KVM_SBI_VERSION_MINOR 0
16 
17 enum kvm_riscv_sbi_ext_status {
18 	KVM_RISCV_SBI_EXT_STATUS_UNINITIALIZED,
19 	KVM_RISCV_SBI_EXT_STATUS_UNAVAILABLE,
20 	KVM_RISCV_SBI_EXT_STATUS_ENABLED,
21 	KVM_RISCV_SBI_EXT_STATUS_DISABLED,
22 };
23 
24 struct kvm_vcpu_sbi_context {
25 	int return_handled;
26 	enum kvm_riscv_sbi_ext_status ext_status[KVM_RISCV_SBI_EXT_MAX];
27 };
28 
29 struct kvm_vcpu_sbi_return {
30 	unsigned long out_val;
31 	unsigned long err_val;
32 	struct kvm_cpu_trap *utrap;
33 	bool uexit;
34 };
35 
36 struct kvm_vcpu_sbi_extension {
37 	unsigned long extid_start;
38 	unsigned long extid_end;
39 
40 	bool default_disabled;
41 
42 	/**
43 	 * SBI extension handler. It can be defined for a given extension or group of
44 	 * extension. But it should always return linux error codes rather than SBI
45 	 * specific error codes.
46 	 */
47 	int (*handler)(struct kvm_vcpu *vcpu, struct kvm_run *run,
48 		       struct kvm_vcpu_sbi_return *retdata);
49 
50 	/* Extension specific probe function */
51 	unsigned long (*probe)(struct kvm_vcpu *vcpu);
52 
53 	/*
54 	 * Init/deinit function called once during VCPU init/destroy. These
55 	 * might be use if the SBI extensions need to allocate or do specific
56 	 * init time only configuration.
57 	 */
58 	int (*init)(struct kvm_vcpu *vcpu);
59 	void (*deinit)(struct kvm_vcpu *vcpu);
60 
61 	void (*reset)(struct kvm_vcpu *vcpu);
62 };
63 
64 void kvm_riscv_vcpu_sbi_forward(struct kvm_vcpu *vcpu, struct kvm_run *run);
65 void kvm_riscv_vcpu_sbi_system_reset(struct kvm_vcpu *vcpu,
66 				     struct kvm_run *run,
67 				     u32 type, u64 flags);
68 void kvm_riscv_vcpu_sbi_request_reset(struct kvm_vcpu *vcpu,
69 				      unsigned long pc, unsigned long a1);
70 void kvm_riscv_vcpu_sbi_load_reset_state(struct kvm_vcpu *vcpu);
71 int kvm_riscv_vcpu_sbi_return(struct kvm_vcpu *vcpu, struct kvm_run *run);
72 int kvm_riscv_vcpu_set_reg_sbi_ext(struct kvm_vcpu *vcpu,
73 				   const struct kvm_one_reg *reg);
74 int kvm_riscv_vcpu_get_reg_sbi_ext(struct kvm_vcpu *vcpu,
75 				   const struct kvm_one_reg *reg);
76 int kvm_riscv_vcpu_set_reg_sbi(struct kvm_vcpu *vcpu,
77 			       const struct kvm_one_reg *reg);
78 int kvm_riscv_vcpu_get_reg_sbi(struct kvm_vcpu *vcpu,
79 			       const struct kvm_one_reg *reg);
80 const struct kvm_vcpu_sbi_extension *kvm_vcpu_sbi_find_ext(
81 				struct kvm_vcpu *vcpu, unsigned long extid);
82 bool riscv_vcpu_supports_sbi_ext(struct kvm_vcpu *vcpu, int idx);
83 int kvm_riscv_vcpu_sbi_ecall(struct kvm_vcpu *vcpu, struct kvm_run *run);
84 void kvm_riscv_vcpu_sbi_init(struct kvm_vcpu *vcpu);
85 void kvm_riscv_vcpu_sbi_deinit(struct kvm_vcpu *vcpu);
86 void kvm_riscv_vcpu_sbi_reset(struct kvm_vcpu *vcpu);
87 
88 int kvm_riscv_vcpu_get_reg_sbi_sta(struct kvm_vcpu *vcpu, unsigned long reg_num,
89 				   unsigned long *reg_val);
90 int kvm_riscv_vcpu_set_reg_sbi_sta(struct kvm_vcpu *vcpu, unsigned long reg_num,
91 				   unsigned long reg_val);
92 
93 #ifdef CONFIG_RISCV_SBI_V01
94 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_v01;
95 #endif
96 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_base;
97 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_time;
98 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_ipi;
99 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_rfence;
100 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_srst;
101 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_hsm;
102 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_dbcn;
103 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_susp;
104 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_sta;
105 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_experimental;
106 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_vendor;
107 
108 #ifdef CONFIG_RISCV_PMU_SBI
109 extern const struct kvm_vcpu_sbi_extension vcpu_sbi_ext_pmu;
110 #endif
111 #endif /* __RISCV_KVM_VCPU_SBI_H__ */
112