]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - virt/kvm/arm/vgic/vgic.h
KVM: arm/arm64: vgic: Fix GICC_PMR uaccess on GICv3 and clarify ABI
[karo-tx-linux.git] / virt / kvm / arm / vgic / vgic.h
1 /*
2  * Copyright (C) 2015, 2016 ARM Ltd.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 #ifndef __KVM_ARM_VGIC_NEW_H__
17 #define __KVM_ARM_VGIC_NEW_H__
18
19 #include <linux/irqchip/arm-gic-common.h>
20
21 #define PRODUCT_ID_KVM          0x4b    /* ASCII code K */
22 #define IMPLEMENTER_ARM         0x43b
23
24 #define VGIC_ADDR_UNDEF         (-1)
25 #define IS_VGIC_ADDR_UNDEF(_x)  ((_x) == VGIC_ADDR_UNDEF)
26
27 #define INTERRUPT_ID_BITS_SPIS  10
28 #define INTERRUPT_ID_BITS_ITS   16
29 #define VGIC_PRI_BITS           5
30
31 #define vgic_irq_is_sgi(intid) ((intid) < VGIC_NR_SGIS)
32
33 #define VGIC_AFFINITY_0_SHIFT 0
34 #define VGIC_AFFINITY_0_MASK (0xffUL << VGIC_AFFINITY_0_SHIFT)
35 #define VGIC_AFFINITY_1_SHIFT 8
36 #define VGIC_AFFINITY_1_MASK (0xffUL << VGIC_AFFINITY_1_SHIFT)
37 #define VGIC_AFFINITY_2_SHIFT 16
38 #define VGIC_AFFINITY_2_MASK (0xffUL << VGIC_AFFINITY_2_SHIFT)
39 #define VGIC_AFFINITY_3_SHIFT 24
40 #define VGIC_AFFINITY_3_MASK (0xffUL << VGIC_AFFINITY_3_SHIFT)
41
42 #define VGIC_AFFINITY_LEVEL(reg, level) \
43         ((((reg) & VGIC_AFFINITY_## level ##_MASK) \
44         >> VGIC_AFFINITY_## level ##_SHIFT) << MPIDR_LEVEL_SHIFT(level))
45
46 /*
47  * The Userspace encodes the affinity differently from the MPIDR,
48  * Below macro converts vgic userspace format to MPIDR reg format.
49  */
50 #define VGIC_TO_MPIDR(val) (VGIC_AFFINITY_LEVEL(val, 0) | \
51                             VGIC_AFFINITY_LEVEL(val, 1) | \
52                             VGIC_AFFINITY_LEVEL(val, 2) | \
53                             VGIC_AFFINITY_LEVEL(val, 3))
54
55 /*
56  * As per Documentation/virtual/kvm/devices/arm-vgic-v3.txt,
57  * below macros are defined for CPUREG encoding.
58  */
59 #define KVM_REG_ARM_VGIC_SYSREG_OP0_MASK   0x000000000000c000
60 #define KVM_REG_ARM_VGIC_SYSREG_OP0_SHIFT  14
61 #define KVM_REG_ARM_VGIC_SYSREG_OP1_MASK   0x0000000000003800
62 #define KVM_REG_ARM_VGIC_SYSREG_OP1_SHIFT  11
63 #define KVM_REG_ARM_VGIC_SYSREG_CRN_MASK   0x0000000000000780
64 #define KVM_REG_ARM_VGIC_SYSREG_CRN_SHIFT  7
65 #define KVM_REG_ARM_VGIC_SYSREG_CRM_MASK   0x0000000000000078
66 #define KVM_REG_ARM_VGIC_SYSREG_CRM_SHIFT  3
67 #define KVM_REG_ARM_VGIC_SYSREG_OP2_MASK   0x0000000000000007
68 #define KVM_REG_ARM_VGIC_SYSREG_OP2_SHIFT  0
69
70 #define KVM_DEV_ARM_VGIC_SYSREG_MASK (KVM_REG_ARM_VGIC_SYSREG_OP0_MASK | \
71                                       KVM_REG_ARM_VGIC_SYSREG_OP1_MASK | \
72                                       KVM_REG_ARM_VGIC_SYSREG_CRN_MASK | \
73                                       KVM_REG_ARM_VGIC_SYSREG_CRM_MASK | \
74                                       KVM_REG_ARM_VGIC_SYSREG_OP2_MASK)
75
76 static inline bool irq_is_pending(struct vgic_irq *irq)
77 {
78         if (irq->config == VGIC_CONFIG_EDGE)
79                 return irq->pending_latch;
80         else
81                 return irq->pending_latch || irq->line_level;
82 }
83
84 /*
85  * This struct provides an intermediate representation of the fields contained
86  * in the GICH_VMCR and ICH_VMCR registers, such that code exporting the GIC
87  * state to userspace can generate either GICv2 or GICv3 CPU interface
88  * registers regardless of the hardware backed GIC used.
89  */
90 struct vgic_vmcr {
91         u32     ctlr;
92         u32     abpr;
93         u32     bpr;
94         u32     pmr;  /* Priority mask field in the GICC_PMR and
95                        * ICC_PMR_EL1 priority field format */
96         /* Below member variable are valid only for GICv3 */
97         u32     grpen0;
98         u32     grpen1;
99 };
100
101 struct vgic_reg_attr {
102         struct kvm_vcpu *vcpu;
103         gpa_t addr;
104 };
105
106 int vgic_v3_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
107                        struct vgic_reg_attr *reg_attr);
108 int vgic_v2_parse_attr(struct kvm_device *dev, struct kvm_device_attr *attr,
109                        struct vgic_reg_attr *reg_attr);
110 const struct vgic_register_region *
111 vgic_get_mmio_region(struct kvm_vcpu *vcpu, struct vgic_io_device *iodev,
112                      gpa_t addr, int len);
113 struct vgic_irq *vgic_get_irq(struct kvm *kvm, struct kvm_vcpu *vcpu,
114                               u32 intid);
115 void vgic_put_irq(struct kvm *kvm, struct vgic_irq *irq);
116 bool vgic_queue_irq_unlock(struct kvm *kvm, struct vgic_irq *irq);
117 void vgic_kick_vcpus(struct kvm *kvm);
118
119 int vgic_check_ioaddr(struct kvm *kvm, phys_addr_t *ioaddr,
120                       phys_addr_t addr, phys_addr_t alignment);
121
122 void vgic_v2_process_maintenance(struct kvm_vcpu *vcpu);
123 void vgic_v2_fold_lr_state(struct kvm_vcpu *vcpu);
124 void vgic_v2_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
125 void vgic_v2_clear_lr(struct kvm_vcpu *vcpu, int lr);
126 void vgic_v2_set_underflow(struct kvm_vcpu *vcpu);
127 int vgic_v2_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
128 int vgic_v2_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
129                          int offset, u32 *val);
130 int vgic_v2_cpuif_uaccess(struct kvm_vcpu *vcpu, bool is_write,
131                           int offset, u32 *val);
132 void vgic_v2_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
133 void vgic_v2_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
134 void vgic_v2_enable(struct kvm_vcpu *vcpu);
135 int vgic_v2_probe(const struct gic_kvm_info *info);
136 int vgic_v2_map_resources(struct kvm *kvm);
137 int vgic_register_dist_iodev(struct kvm *kvm, gpa_t dist_base_address,
138                              enum vgic_type);
139
140 void vgic_v2_init_lrs(void);
141
142 static inline void vgic_get_irq_kref(struct vgic_irq *irq)
143 {
144         if (irq->intid < VGIC_MIN_LPI)
145                 return;
146
147         kref_get(&irq->refcount);
148 }
149
150 void vgic_v3_process_maintenance(struct kvm_vcpu *vcpu);
151 void vgic_v3_fold_lr_state(struct kvm_vcpu *vcpu);
152 void vgic_v3_populate_lr(struct kvm_vcpu *vcpu, struct vgic_irq *irq, int lr);
153 void vgic_v3_clear_lr(struct kvm_vcpu *vcpu, int lr);
154 void vgic_v3_set_underflow(struct kvm_vcpu *vcpu);
155 void vgic_v3_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
156 void vgic_v3_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
157 void vgic_v3_enable(struct kvm_vcpu *vcpu);
158 int vgic_v3_probe(const struct gic_kvm_info *info);
159 int vgic_v3_map_resources(struct kvm *kvm);
160 int vgic_register_redist_iodevs(struct kvm *kvm, gpa_t dist_base_address);
161
162 int vgic_register_its_iodevs(struct kvm *kvm);
163 bool vgic_has_its(struct kvm *kvm);
164 int kvm_vgic_register_its_device(void);
165 void vgic_enable_lpis(struct kvm_vcpu *vcpu);
166 int vgic_its_inject_msi(struct kvm *kvm, struct kvm_msi *msi);
167 int vgic_v3_has_attr_regs(struct kvm_device *dev, struct kvm_device_attr *attr);
168 int vgic_v3_dist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
169                          int offset, u32 *val);
170 int vgic_v3_redist_uaccess(struct kvm_vcpu *vcpu, bool is_write,
171                          int offset, u32 *val);
172 int vgic_v3_cpu_sysregs_uaccess(struct kvm_vcpu *vcpu, bool is_write,
173                          u64 id, u64 *val);
174 int vgic_v3_has_cpu_sysregs_attr(struct kvm_vcpu *vcpu, bool is_write, u64 id,
175                                 u64 *reg);
176 int vgic_v3_line_level_info_uaccess(struct kvm_vcpu *vcpu, bool is_write,
177                                     u32 intid, u64 *val);
178 int kvm_register_vgic_device(unsigned long type);
179 void vgic_set_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
180 void vgic_get_vmcr(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
181 int vgic_lazy_init(struct kvm *kvm);
182 int vgic_init(struct kvm *kvm);
183
184 int vgic_debug_init(struct kvm *kvm);
185 int vgic_debug_destroy(struct kvm *kvm);
186
187 #endif