xref: /openbmc/linux/arch/arm64/kvm/vgic/vgic.h (revision a90fa0ad)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2015, 2016 ARM Ltd.
4  */
5 #ifndef __KVM_ARM_VGIC_NEW_H__
6 #define __KVM_ARM_VGIC_NEW_H__
7 
8 #include <linux/irqchip/arm-gic-common.h>
9 
10 #define PRODUCT_ID_KVM		0x4b	/* ASCII code K */
11 #define IMPLEMENTER_ARM		0x43b
12 
13 #define VGIC_ADDR_UNDEF		(-1)
14 #define IS_VGIC_ADDR_UNDEF(_x)  ((_x) == VGIC_ADDR_UNDEF)
15 
16 #define INTERRUPT_ID_BITS_SPIS	10
17 #define INTERRUPT_ID_BITS_ITS	16
18 #define VGIC_PRI_BITS		5
19 
20 #define vgic_irq_is_sgi(intid) ((intid) < VGIC_NR_SGIS)
21 
22 #define VGIC_AFFINITY_0_SHIFT 0
23 #define VGIC_AFFINITY_0_MASK (0xffUL << VGIC_AFFINITY_0_SHIFT)
24 #define VGIC_AFFINITY_1_SHIFT 8
25 #define VGIC_AFFINITY_1_MASK (0xffUL << VGIC_AFFINITY_1_SHIFT)
26 #define VGIC_AFFINITY_2_SHIFT 16
27 #define VGIC_AFFINITY_2_MASK (0xffUL << VGIC_AFFINITY_2_SHIFT)
28 #define VGIC_AFFINITY_3_SHIFT 24
29 #define VGIC_AFFINITY_3_MASK (0xffUL << VGIC_AFFINITY_3_SHIFT)
30 
31 #define VGIC_AFFINITY_LEVEL(reg, level) \
32 	((((reg) & VGIC_AFFINITY_## level ##_MASK) \
33 	>> VGIC_AFFINITY_## level ##_SHIFT) << MPIDR_LEVEL_SHIFT(level))
34 
35 /*
36  * The Userspace encodes the affinity differently from the MPIDR,
37  * Below macro converts vgic userspace format to MPIDR reg format.
38  */
39 #define VGIC_TO_MPIDR(val) (VGIC_AFFINITY_LEVEL(val, 0) | \
40 			    VGIC_AFFINITY_LEVEL(val, 1) | \
41 			    VGIC_AFFINITY_LEVEL(val, 2) | \
42 			    VGIC_AFFINITY_LEVEL(val, 3))
43 
44 /*
45  * As per Documentation/virt/kvm/devices/arm-vgic-v3.rst,
46  * below macros are defined for CPUREG encoding.
47  */
48 #define KVM_REG_ARM_VGIC_SYSREG_OP0_MASK   0x000000000000c000
49 #define KVM_REG_ARM_VGIC_SYSREG_OP0_SHIFT  14
50 #define KVM_REG_ARM_VGIC_SYSREG_OP1_MASK   0x0000000000003800
51 #define KVM_REG_ARM_VGIC_SYSREG_OP1_SHIFT  11
52 #define KVM_REG_ARM_VGIC_SYSREG_CRN_MASK   0x0000000000000780
53 #define KVM_REG_ARM_VGIC_SYSREG_CRN_SHIFT  7
54 #define KVM_REG_ARM_VGIC_SYSREG_CRM_MASK   0x0000000000000078
55 #define KVM_REG_ARM_VGIC_SYSREG_CRM_SHIFT  3
56 #define KVM_REG_ARM_VGIC_SYSREG_OP2_MASK   0x0000000000000007
57 #define KVM_REG_ARM_VGIC_SYSREG_OP2_SHIFT  0
58 
59 #define KVM_DEV_ARM_VGIC_SYSREG_MASK (KVM_REG_ARM_VGIC_SYSREG_OP0_MASK | \
60 				      KVM_REG_ARM_VGIC_SYSREG_OP1_MASK | \
61 				      KVM_REG_ARM_VGIC_SYSREG_CRN_MASK | \
62 				      KVM_REG_ARM_VGIC_SYSREG_CRM_MASK | \
63 				      KVM_REG_ARM_VGIC_SYSREG_OP2_MASK)
64 
65 /*
66  * As per Documentation/virt/kvm/devices/arm-vgic-its.rst,
67  * below macros are defined for ITS table entry encoding.
68  */
69 #define KVM_ITS_CTE_VALID_SHIFT		63
70 #define KVM_ITS_CTE_VALID_MASK		BIT_ULL(63)
71 #define KVM_ITS_CTE_RDBASE_SHIFT	16
72 #define KVM_ITS_CTE_ICID_MASK		GENMASK_ULL(15, 0)
73 #define KVM_ITS_ITE_NEXT_SHIFT		48
74 #define KVM_ITS_ITE_PINTID_SHIFT	16
75 #define KVM_ITS_ITE_PINTID_MASK		GENMASK_ULL(47, 16)
76 #define KVM_ITS_ITE_ICID_MASK		GENMASK_ULL(15, 0)
77 #define KVM_ITS_DTE_VALID_SHIFT		63
78 #define KVM_ITS_DTE_VALID_MASK		BIT_ULL(63)
79 #define KVM_ITS_DTE_NEXT_SHIFT		49
80 #define KVM_ITS_DTE_NEXT_MASK		GENMASK_ULL(62, 49)
81 #define KVM_ITS_DTE_ITTADDR_SHIFT	5
82 #define KVM_ITS_DTE_ITTADDR_MASK	GENMASK_ULL(48, 5)
83 #define KVM_ITS_DTE_SIZE_MASK		GENMASK_ULL(4, 0)
84 #define KVM_ITS_L1E_VALID_MASK		BIT_ULL(63)
85 /* we only support 64 kB translation table page size */
86 #define KVM_ITS_L1E_ADDR_MASK		GENMASK_ULL(51, 16)
87 
88 #define KVM_VGIC_V3_RDIST_INDEX_MASK	GENMASK_ULL(11, 0)
89 #define KVM_VGIC_V3_RDIST_FLAGS_MASK	GENMASK_ULL(15, 12)
90 #define KVM_VGIC_V3_RDIST_FLAGS_SHIFT	12
91 #define KVM_VGIC_V3_RDIST_BASE_MASK	GENMASK_ULL(51, 16)
92 #define KVM_VGIC_V3_RDIST_COUNT_MASK	GENMASK_ULL(63, 52)
93 #define KVM_VGIC_V3_RDIST_COUNT_SHIFT	52
94 
95 #ifdef CONFIG_DEBUG_SPINLOCK
96 #define DEBUG_SPINLOCK_BUG_ON(p) BUG_ON(p)
97 #else
98 #define DEBUG_SPINLOCK_BUG_ON(p)
99 #endif
100 
101 static inline u32 vgic_get_implementation_rev(struct kvm_vcpu *vcpu)
102 {
103 	return vcpu->kvm->arch.vgic.implementation_rev;
104 }
105 
106 /* Requires the irq_lock to be held by the caller. */
107 static inline bool irq_is_pending(struct vgic_irq *irq)
108 {
109 	if (irq->config == VGIC_CONFIG_EDGE)
110 		return irq->pending_latch;
111 	else
112 		return irq->pending_latch || irq->line_level;
113 }
114 
115 static inline bool vgic_irq_is_mapped_level(struct vgic_irq *irq)
116 {
117 	return irq->config == VGIC_CONFIG_LEVEL && irq->hw;
118 }
119 
120 static inline int vgic_irq_get_lr_count(struct vgic_irq *irq)
121 {
122 	/* Account for the active state as an interrupt */
123 	if (vgic_irq_is_sgi(irq->intid) && irq->source)
124 		return hweight8(irq->source) + irq->active;
125 
126 	return irq_is_pending(irq) || irq->active;
127 }
128 
129 static inline bool vgic_irq_is_multi_sgi(struct vgic_irq *irq)
130 {
131 	return vgic_irq_get_lr_count(irq) > 1;
132 }
133 
134 /*
135  * This struct provides an intermediate representation of the fields contained
136  * in the GICH_VMCR and ICH_VMCR registers, such that code exporting the GIC
137  * state to userspace can generate either GICv2 or GICv3 CPU interface
138  * registers regardless of the hardware backed GIC used.
139  */
140 struct vgic_vmcr {
141 	u32	grpen0;
142 	u32	grpen1;
143 
144 	u32	ackctl;
145 	u32	fiqen;
146 	u32	cbpr;
147 	u32	eoim;
148 
149 	u32	abpr;
150 	u32	bpr;
151 	u32	pmr;  /* Priority mask field in the GICC_PMR and
152 		       * ICC_PMR_EL1 priority field format */
153 };
154 
155 struct vgic_reg_attr {
156 	struct kvm_vcpu *vcpu;
157 	gpa_t addr;
158 };
159 
160 int vgic_v3_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
161 		       struct vgic_reg_attr *reg_attr);
162 int vgic_v2_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
163 		       struct vgic_reg_attr *reg_attr);
164 const struct vgic_register_region *
165 vgic_get_mmio_region(struct kvm_vcpu *vcpu, struct vgic_io_device *iodev,
166 		     gpa_t addr, int len);
167 struct vgic_irq *vgic_get_irq(struct kvm *kvm, struct kvm_vcpu *vcpu,
168 			      u32 intid);
169 void __vgic_put_lpi_locked(struct kvm *kvm, struct vgic_irq *irq);
170 void vgic_put_irq(struct kvm *kvm, struct vgic_irq *irq);
171 bool vgic_get_phys_line_level(struct vgic_irq *irq);
172 void vgic_irq_set_phys_pending(struct vgic_irq *irq, bool pending);
173 void vgic_irq_set_phys_active(struct vgic_irq *irq, bool active);
174 bool vgic_queue_irq_unlock(struct kvm *kvm, struct vgic_irq *irq,
175 			   unsigned long flags);
176 void vgic_kick_vcpus(struct kvm *kvm);
177 void vgic_irq_handle_resampling(struct vgic_irq *irq,
178 				bool lr_deactivated, bool lr_pending);
179 
180 int vgic_check_iorange(struct kvm *kvm, phys_addr_t ioaddr,
181 		       phys_addr_t addr, phys_addr_t alignment,
182 		       phys_addr_t size);
183 
184 void vgic_v2_fold_lr_state(struct kvm_vcpu *vcpu);
185 void vgic_v2_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
186 void vgic_v2_clear_lr(struct kvm_vcpu *vcpu, int lr);
187 void vgic_v2_set_underflow(struct kvm_vcpu *vcpu);
188 void vgic_v2_set_npie(struct kvm_vcpu *vcpu);
189 int vgic_v2_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
190 int vgic_v2_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
191 			 int offset, u32 *val);
192 int vgic_v2_cpuif_uaccess(struct kvm_vcpu *vcpu, bool is_write,
193 			  int offset, u32 *val);
194 void vgic_v2_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
195 void vgic_v2_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
196 void vgic_v2_enable(struct kvm_vcpu *vcpu);
197 int vgic_v2_probe(const struct gic_kvm_info *info);
198 int vgic_v2_map_resources(struct kvm *kvm);
199 int vgic_register_dist_iodev(struct kvm *kvm, gpa_t dist_base_address,
200 			     enum vgic_type);
201 
202 void vgic_v2_init_lrs(void);
203 void vgic_v2_load(struct kvm_vcpu *vcpu);
204 void vgic_v2_put(struct kvm_vcpu *vcpu);
205 void vgic_v2_vmcr_sync(struct kvm_vcpu *vcpu);
206 
207 void vgic_v2_save_state(struct kvm_vcpu *vcpu);
208 void vgic_v2_restore_state(struct kvm_vcpu *vcpu);
209 
210 static inline void vgic_get_irq_kref(struct vgic_irq *irq)
211 {
212 	if (irq->intid < VGIC_MIN_LPI)
213 		return;
214 
215 	kref_get(&irq->refcount);
216 }
217 
218 void vgic_v3_fold_lr_state(struct kvm_vcpu *vcpu);
219 void vgic_v3_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
220 void vgic_v3_clear_lr(struct kvm_vcpu *vcpu, int lr);
221 void vgic_v3_set_underflow(struct kvm_vcpu *vcpu);
222 void vgic_v3_set_npie(struct kvm_vcpu *vcpu);
223 void vgic_v3_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
224 void vgic_v3_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
225 void vgic_v3_enable(struct kvm_vcpu *vcpu);
226 int vgic_v3_probe(const struct gic_kvm_info *info);
227 int vgic_v3_map_resources(struct kvm *kvm);
228 int vgic_v3_lpi_sync_pending_status(struct kvm *kvm, struct vgic_irq *irq);
229 int vgic_v3_save_pending_tables(struct kvm *kvm);
230 int vgic_v3_set_redist_base(struct kvm *kvm, u32 index, u64 addr, u32 count);
231 int vgic_register_redist_iodev(struct kvm_vcpu *vcpu);
232 bool vgic_v3_check_base(struct kvm *kvm);
233 
234 void vgic_v3_load(struct kvm_vcpu *vcpu);
235 void vgic_v3_put(struct kvm_vcpu *vcpu);
236 void vgic_v3_vmcr_sync(struct kvm_vcpu *vcpu);
237 
238 bool vgic_has_its(struct kvm *kvm);
239 int kvm_vgic_register_its_device(void);
240 void vgic_enable_lpis(struct kvm_vcpu *vcpu);
241 void vgic_flush_pending_lpis(struct kvm_vcpu *vcpu);
242 int vgic_its_inject_msi(struct kvm *kvm, struct kvm_msi *msi);
243 int vgic_v3_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
244 int vgic_v3_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
245 			 int offset, u32 *val);
246 int vgic_v3_redist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
247 			 int offset, u32 *val);
248 int vgic_v3_cpu_sysregs_uaccess(struct kvm_vcpu *vcpu,
249 				struct kvm_device_attr *attr, bool is_write);
250 int vgic_v3_has_cpu_sysregs_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
251 int vgic_v3_line_level_info_uaccess(struct kvm_vcpu *vcpu, bool is_write,
252 				    u32 intid, u32 *val);
253 int kvm_register_vgic_device(unsigned long type);
254 void vgic_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
255 void vgic_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
256 int vgic_lazy_init(struct kvm *kvm);
257 int vgic_init(struct kvm *kvm);
258 
259 void vgic_debug_init(struct kvm *kvm);
260 void vgic_debug_destroy(struct kvm *kvm);
261 
262 bool lock_all_vcpus(struct kvm *kvm);
263 void unlock_all_vcpus(struct kvm *kvm);
264 
265 static inline int vgic_v3_max_apr_idx(struct kvm_vcpu *vcpu)
266 {
267 	struct vgic_cpu *cpu_if = &vcpu->arch.vgic_cpu;
268 
269 	/*
270 	 * num_pri_bits are initialized with HW supported values.
271 	 * We can rely safely on num_pri_bits even if VM has not
272 	 * restored ICC_CTLR_EL1 before restoring APnR registers.
273 	 */
274 	switch (cpu_if->num_pri_bits) {
275 	case 7: return 3;
276 	case 6: return 1;
277 	default: return 0;
278 	}
279 }
280 
281 static inline bool
282 vgic_v3_redist_region_full(struct vgic_redist_region *region)
283 {
284 	if (!region->count)
285 		return false;
286 
287 	return (region->free_index >= region->count);
288 }
289 
290 struct vgic_redist_region *vgic_v3_rdist_free_slot(struct list_head *rdregs);
291 
292 static inline size_t
293 vgic_v3_rd_region_size(struct kvm *kvm, struct vgic_redist_region *rdreg)
294 {
295 	if (!rdreg->count)
296 		return atomic_read(&kvm->online_vcpus) * KVM_VGIC_V3_REDIST_SIZE;
297 	else
298 		return rdreg->count * KVM_VGIC_V3_REDIST_SIZE;
299 }
300 
301 struct vgic_redist_region *vgic_v3_rdist_region_from_index(struct kvm *kvm,
302 							   u32 index);
303 void vgic_v3_free_redist_region(struct vgic_redist_region *rdreg);
304 
305 bool vgic_v3_rdist_overlap(struct kvm *kvm, gpa_t base, size_t size);
306 
307 static inline bool vgic_dist_overlap(struct kvm *kvm, gpa_t base, size_t size)
308 {
309 	struct vgic_dist *d = &kvm->arch.vgic;
310 
311 	return (base + size > d->vgic_dist_base) &&
312 		(base < d->vgic_dist_base + KVM_VGIC_V3_DIST_SIZE);
313 }
314 
315 bool vgic_lpis_enabled(struct kvm_vcpu *vcpu);
316 int vgic_copy_lpi_list(struct kvm *kvm, struct kvm_vcpu *vcpu, u32 **intid_ptr);
317 int vgic_its_resolve_lpi(struct kvm *kvm, struct vgic_its *its,
318 			 u32 devid, u32 eventid, struct vgic_irq **irq);
319 struct vgic_its *vgic_msi_to_its(struct kvm *kvm, struct kvm_msi *msi);
320 int vgic_its_inject_cached_translation(struct kvm *kvm, struct kvm_msi *msi);
321 void vgic_lpi_translation_cache_init(struct kvm *kvm);
322 void vgic_lpi_translation_cache_destroy(struct kvm *kvm);
323 void vgic_its_invalidate_cache(struct kvm *kvm);
324 
325 /* GICv4.1 MMIO interface */
326 int vgic_its_inv_lpi(struct kvm *kvm, struct vgic_irq *irq);
327 int vgic_its_invall(struct kvm_vcpu *vcpu);
328 
329 bool vgic_supports_direct_msis(struct kvm *kvm);
330 int vgic_v4_init(struct kvm *kvm);
331 void vgic_v4_teardown(struct kvm *kvm);
332 void vgic_v4_configure_vsgis(struct kvm *kvm);
333 void vgic_v4_get_vlpi_state(struct vgic_irq *irq, bool *val);
334 int vgic_v4_request_vpe_irq(struct kvm_vcpu *vcpu, int irq);
335 
336 #endif
337