1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2015, 2016 ARM Ltd.
5 #ifndef __KVM_ARM_VGIC_NEW_H__
6 #define __KVM_ARM_VGIC_NEW_H__
8 #include <linux/irqchip/arm-gic-common.h>
10 #define PRODUCT_ID_KVM 0x4b /* ASCII code K */
11 #define IMPLEMENTER_ARM 0x43b
13 #define VGIC_ADDR_UNDEF (-1)
14 #define IS_VGIC_ADDR_UNDEF(_x) ((_x) == VGIC_ADDR_UNDEF)
16 #define INTERRUPT_ID_BITS_SPIS 10
17 #define INTERRUPT_ID_BITS_ITS 16
18 #define VGIC_PRI_BITS 5
20 #define vgic_irq_is_sgi(intid) ((intid) < VGIC_NR_SGIS)
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)
31 #define VGIC_AFFINITY_LEVEL(reg, level) \
32 ((((reg) & VGIC_AFFINITY_## level ##_MASK) \
33 >> VGIC_AFFINITY_## level ##_SHIFT) << MPIDR_LEVEL_SHIFT(level))
36 * The Userspace encodes the affinity differently from the MPIDR,
37 * Below macro converts vgic userspace format to MPIDR reg format.
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))
45 * As per Documentation/virt/kvm/devices/arm-vgic-v3.txt,
46 * below macros are defined for CPUREG encoding.
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
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)
66 * As per Documentation/virt/kvm/devices/arm-vgic-its.txt,
67 * below macros are defined for ITS table entry encoding.
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)
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
95 #ifdef CONFIG_DEBUG_SPINLOCK
96 #define DEBUG_SPINLOCK_BUG_ON(p) BUG_ON(p)
98 #define DEBUG_SPINLOCK_BUG_ON(p)
101 /* Requires the irq_lock to be held by the caller. */
102 static inline bool irq_is_pending(struct vgic_irq *irq)
104 if (irq->config == VGIC_CONFIG_EDGE)
105 return irq->pending_latch;
107 return irq->pending_latch || irq->line_level;
110 static inline bool vgic_irq_is_mapped_level(struct vgic_irq *irq)
112 return irq->config == VGIC_CONFIG_LEVEL && irq->hw;
115 static inline int vgic_irq_get_lr_count(struct vgic_irq *irq)
117 /* Account for the active state as an interrupt */
118 if (vgic_irq_is_sgi(irq->intid) && irq->source)
119 return hweight8(irq->source) + irq->active;
121 return irq_is_pending(irq) || irq->active;
124 static inline bool vgic_irq_is_multi_sgi(struct vgic_irq *irq)
126 return vgic_irq_get_lr_count(irq) > 1;
130 * This struct provides an intermediate representation of the fields contained
131 * in the GICH_VMCR and ICH_VMCR registers, such that code exporting the GIC
132 * state to userspace can generate either GICv2 or GICv3 CPU interface
133 * registers regardless of the hardware backed GIC used.
146 u32 pmr; /* Priority mask field in the GICC_PMR and
147 * ICC_PMR_EL1 priority field format */
150 struct vgic_reg_attr {
151 struct kvm_vcpu *vcpu;
155 int vgic_v3_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
156 struct vgic_reg_attr *reg_attr);
157 int vgic_v2_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
158 struct vgic_reg_attr *reg_attr);
159 const struct vgic_register_region *
160 vgic_get_mmio_region(struct kvm_vcpu *vcpu, struct vgic_io_device *iodev,
161 gpa_t addr, int len);
162 struct vgic_irq *vgic_get_irq(struct kvm *kvm, struct kvm_vcpu *vcpu,
164 void vgic_put_irq(struct kvm *kvm, struct vgic_irq *irq);
165 bool vgic_get_phys_line_level(struct vgic_irq *irq);
166 void vgic_irq_set_phys_pending(struct vgic_irq *irq, bool pending);
167 void vgic_irq_set_phys_active(struct vgic_irq *irq, bool active);
168 bool vgic_queue_irq_unlock(struct kvm *kvm, struct vgic_irq *irq,
169 unsigned long flags);
170 void vgic_kick_vcpus(struct kvm *kvm);
172 int vgic_check_ioaddr(struct kvm *kvm, phys_addr_t *ioaddr,
173 phys_addr_t addr, phys_addr_t alignment);
175 void vgic_v2_fold_lr_state(struct kvm_vcpu *vcpu);
176 void vgic_v2_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
177 void vgic_v2_clear_lr(struct kvm_vcpu *vcpu, int lr);
178 void vgic_v2_set_underflow(struct kvm_vcpu *vcpu);
179 void vgic_v2_set_npie(struct kvm_vcpu *vcpu);
180 int vgic_v2_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
181 int vgic_v2_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
182 int offset, u32 *val);
183 int vgic_v2_cpuif_uaccess(struct kvm_vcpu *vcpu, bool is_write,
184 int offset, u32 *val);
185 void vgic_v2_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
186 void vgic_v2_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
187 void vgic_v2_enable(struct kvm_vcpu *vcpu);
188 int vgic_v2_probe(const struct gic_kvm_info *info);
189 int vgic_v2_map_resources(struct kvm *kvm);
190 int vgic_register_dist_iodev(struct kvm *kvm, gpa_t dist_base_address,
193 void vgic_v2_init_lrs(void);
194 void vgic_v2_load(struct kvm_vcpu *vcpu);
195 void vgic_v2_put(struct kvm_vcpu *vcpu);
196 void vgic_v2_vmcr_sync(struct kvm_vcpu *vcpu);
198 void vgic_v2_save_state(struct kvm_vcpu *vcpu);
199 void vgic_v2_restore_state(struct kvm_vcpu *vcpu);
201 static inline void vgic_get_irq_kref(struct vgic_irq *irq)
203 if (irq->intid < VGIC_MIN_LPI)
206 kref_get(&irq->refcount);
209 void vgic_v3_fold_lr_state(struct kvm_vcpu *vcpu);
210 void vgic_v3_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
211 void vgic_v3_clear_lr(struct kvm_vcpu *vcpu, int lr);
212 void vgic_v3_set_underflow(struct kvm_vcpu *vcpu);
213 void vgic_v3_set_npie(struct kvm_vcpu *vcpu);
214 void vgic_v3_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
215 void vgic_v3_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
216 void vgic_v3_enable(struct kvm_vcpu *vcpu);
217 int vgic_v3_probe(const struct gic_kvm_info *info);
218 int vgic_v3_map_resources(struct kvm *kvm);
219 int vgic_v3_lpi_sync_pending_status(struct kvm *kvm, struct vgic_irq *irq);
220 int vgic_v3_save_pending_tables(struct kvm *kvm);
221 int vgic_v3_set_redist_base(struct kvm *kvm, u32 index, u64 addr, u32 count);
222 int vgic_register_redist_iodev(struct kvm_vcpu *vcpu);
223 bool vgic_v3_check_base(struct kvm *kvm);
225 void vgic_v3_load(struct kvm_vcpu *vcpu);
226 void vgic_v3_put(struct kvm_vcpu *vcpu);
227 void vgic_v3_vmcr_sync(struct kvm_vcpu *vcpu);
229 bool vgic_has_its(struct kvm *kvm);
230 int kvm_vgic_register_its_device(void);
231 void vgic_enable_lpis(struct kvm_vcpu *vcpu);
232 void vgic_flush_pending_lpis(struct kvm_vcpu *vcpu);
233 int vgic_its_inject_msi(struct kvm *kvm, struct kvm_msi *msi);
234 int vgic_v3_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
235 int vgic_v3_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
236 int offset, u32 *val);
237 int vgic_v3_redist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
238 int offset, u32 *val);
239 int vgic_v3_cpu_sysregs_uaccess(struct kvm_vcpu *vcpu, bool is_write,
241 int vgic_v3_has_cpu_sysregs_attr(struct kvm_vcpu *vcpu, bool is_write, u64 id,
243 int vgic_v3_line_level_info_uaccess(struct kvm_vcpu *vcpu, bool is_write,
244 u32 intid, u64 *val);
245 int kvm_register_vgic_device(unsigned long type);
246 void vgic_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
247 void vgic_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
248 int vgic_lazy_init(struct kvm *kvm);
249 int vgic_init(struct kvm *kvm);
251 void vgic_debug_init(struct kvm *kvm);
252 void vgic_debug_destroy(struct kvm *kvm);
254 bool lock_all_vcpus(struct kvm *kvm);
255 void unlock_all_vcpus(struct kvm *kvm);
257 static inline int vgic_v3_max_apr_idx(struct kvm_vcpu *vcpu)
259 struct vgic_cpu *cpu_if = &vcpu->arch.vgic_cpu;
262 * num_pri_bits are initialized with HW supported values.
263 * We can rely safely on num_pri_bits even if VM has not
264 * restored ICC_CTLR_EL1 before restoring APnR registers.
266 switch (cpu_if->num_pri_bits) {
274 vgic_v3_redist_region_full(struct vgic_redist_region *region)
279 return (region->free_index >= region->count);
282 struct vgic_redist_region *vgic_v3_rdist_free_slot(struct list_head *rdregs);
285 vgic_v3_rd_region_size(struct kvm *kvm, struct vgic_redist_region *rdreg)
288 return atomic_read(&kvm->online_vcpus) * KVM_VGIC_V3_REDIST_SIZE;
290 return rdreg->count * KVM_VGIC_V3_REDIST_SIZE;
293 struct vgic_redist_region *vgic_v3_rdist_region_from_index(struct kvm *kvm,
296 bool vgic_v3_rdist_overlap(struct kvm *kvm, gpa_t base, size_t size);
298 static inline bool vgic_dist_overlap(struct kvm *kvm, gpa_t base, size_t size)
300 struct vgic_dist *d = &kvm->arch.vgic;
302 return (base + size > d->vgic_dist_base) &&
303 (base < d->vgic_dist_base + KVM_VGIC_V3_DIST_SIZE);
306 int vgic_copy_lpi_list(struct kvm *kvm, struct kvm_vcpu *vcpu, u32 **intid_ptr);
307 int vgic_its_resolve_lpi(struct kvm *kvm, struct vgic_its *its,
308 u32 devid, u32 eventid, struct vgic_irq **irq);
309 struct vgic_its *vgic_msi_to_its(struct kvm *kvm, struct kvm_msi *msi);
311 bool vgic_supports_direct_msis(struct kvm *kvm);
312 int vgic_v4_init(struct kvm *kvm);
313 void vgic_v4_teardown(struct kvm *kvm);
314 int vgic_v4_sync_hwstate(struct kvm_vcpu *vcpu);
315 int vgic_v4_flush_hwstate(struct kvm_vcpu *vcpu);