include/kvm/arm_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_H
  17 #define __KVM_ARM_VGIC_H
  18
  19 #include <linux/kernel.h>
  20 #include <linux/kvm.h>
  21 #include <linux/irqreturn.h>
  22 #include <linux/spinlock.h>
  23 #include <linux/types.h>
  24 #include <kvm/iodev.h>
  25
  26 #define VGIC_V3_MAX_CPUS        255
  27 #define VGIC_V2_MAX_CPUS        8
  28 #define VGIC_NR_IRQS_LEGACY     256
  29 #define VGIC_NR_SGIS            16
  30 #define VGIC_NR_PPIS            16
  31 #define VGIC_NR_PRIVATE_IRQS    (VGIC_NR_SGIS + VGIC_NR_PPIS)
  32 #define VGIC_MAX_PRIVATE        (VGIC_NR_PRIVATE_IRQS - 1)
  33 #define VGIC_MAX_SPI            1019
  34 #define VGIC_MAX_RESERVED       1023
  35 #define VGIC_MIN_LPI            8192
  36
  37 enum vgic_type {
  38         VGIC_V2,                /* Good ol' GICv2 */
  39         VGIC_V3,                /* New fancy GICv3 */
  40 };
  41
  42 /* same for all guests, as depending only on the _host's_ GIC model */
  43 struct vgic_global {
  44         /* type of the host GIC */
  45         enum vgic_type          type;
  46
  47         /* Physical address of vgic virtual cpu interface */
  48         phys_addr_t             vcpu_base;
  49
  50         /* virtual control interface mapping */
  51         void __iomem            *vctrl_base;
  52
  53         /* Number of implemented list registers */
  54         int                     nr_lr;
  55
  56         /* Maintenance IRQ number */
  57         unsigned int            maint_irq;
  58
  59         /* maximum number of VCPUs allowed (GICv2 limits us to 8) */
  60         int                     max_gic_vcpus;
  61
  62         /* Only needed for the legacy KVM_CREATE_IRQCHIP */
  63         bool                    can_emulate_gicv2;
  64 };
  65
  66 extern struct vgic_global kvm_vgic_global_state;
  67
  68 #define VGIC_V2_MAX_LRS         (1 << 6)
  69 #define VGIC_V3_MAX_LRS         16
  70 #define VGIC_V3_LR_INDEX(lr)    (VGIC_V3_MAX_LRS - 1 - lr)
  71
  72 enum vgic_irq_config {
  73         VGIC_CONFIG_EDGE = 0,
  74         VGIC_CONFIG_LEVEL
  75 };
  76
  77 struct vgic_irq {
  78         spinlock_t irq_lock;            /* Protects the content of the struct */
  79         struct list_head ap_list;
  80
  81         struct kvm_vcpu *vcpu;          /* SGIs and PPIs: The VCPU
  82                                          * SPIs and LPIs: The VCPU whose ap_list
  83                                          * this is queued on.
  84                                          */
  85
  86         struct kvm_vcpu *target_vcpu;   /* The VCPU that this interrupt should
  87                                          * be sent to, as a result of the
  88                                          * targets reg (v2) or the
  89                                          * affinity reg (v3).
  90                                          */
  91
  92         u32 intid;                      /* Guest visible INTID */
  93         bool pending;
  94         bool line_level;                /* Level only */
  95         bool soft_pending;              /* Level only */
  96         bool active;                    /* not used for LPIs */
  97         bool enabled;
  98         bool hw;                        /* Tied to HW IRQ */
  99         struct kref refcount;           /* Used for LPIs */
 100         u32 hwintid;                    /* HW INTID number */
 101         union {
 102                 u8 targets;                     /* GICv2 target VCPUs mask */
 103                 u32 mpidr;                      /* GICv3 target VCPU */
 104         };
 105         u8 source;                      /* GICv2 SGIs only */
 106         u8 priority;
 107         enum vgic_irq_config config;    /* Level or edge */
 108 };
 109
 110 struct vgic_register_region;
 111
 112 struct vgic_io_device {
 113         gpa_t base_addr;
 114         struct kvm_vcpu *redist_vcpu;
 115         const struct vgic_register_region *regions;
 116         int nr_regions;
 117         struct kvm_io_device dev;
 118 };
 119
 120 struct vgic_dist {
 121         bool                    in_kernel;
 122         bool                    ready;
 123         bool                    initialized;
 124
 125         /* vGIC model the kernel emulates for the guest (GICv2 or GICv3) */
 126         u32                     vgic_model;
 127
 128         int                     nr_spis;
 129
 130         /* TODO: Consider moving to global state */
 131         /* Virtual control interface mapping */
 132         void __iomem            *vctrl_base;
 133
 134         /* base addresses in guest physical address space: */
 135         gpa_t                   vgic_dist_base;         /* distributor */
 136         union {
 137                 /* either a GICv2 CPU interface */
 138                 gpa_t                   vgic_cpu_base;
 139                 /* or a number of GICv3 redistributor regions */
 140                 gpa_t                   vgic_redist_base;
 141         };
 142
 143         /* distributor enabled */
 144         bool                    enabled;
 145
 146         struct vgic_irq         *spis;
 147
 148         struct vgic_io_device   dist_iodev;
 149 };
 150
 151 struct vgic_v2_cpu_if {
 152         u32             vgic_hcr;
 153         u32             vgic_vmcr;
 154         u32             vgic_misr;      /* Saved only */
 155         u64             vgic_eisr;      /* Saved only */
 156         u64             vgic_elrsr;     /* Saved only */
 157         u32             vgic_apr;
 158         u32             vgic_lr[VGIC_V2_MAX_LRS];
 159 };
 160
 161 struct vgic_v3_cpu_if {
 162 #ifdef CONFIG_KVM_ARM_VGIC_V3
 163         u32             vgic_hcr;
 164         u32             vgic_vmcr;
 165         u32             vgic_sre;       /* Restored only, change ignored */
 166         u32             vgic_misr;      /* Saved only */
 167         u32             vgic_eisr;      /* Saved only */
 168         u32             vgic_elrsr;     /* Saved only */
 169         u32             vgic_ap0r[4];
 170         u32             vgic_ap1r[4];
 171         u64             vgic_lr[VGIC_V3_MAX_LRS];
 172 #endif
 173 };
 174
 175 struct vgic_cpu {
 176         /* CPU vif control registers for world switch */
 177         union {
 178                 struct vgic_v2_cpu_if   vgic_v2;
 179                 struct vgic_v3_cpu_if   vgic_v3;
 180         };
 181
 182         unsigned int used_lrs;
 183         struct vgic_irq private_irqs[VGIC_NR_PRIVATE_IRQS];
 184
 185         spinlock_t ap_list_lock;        /* Protects the ap_list */
 186
 187         /*
 188          * List of IRQs that this VCPU should consider because they are either
 189          * Active or Pending (hence the name; AP list), or because they recently
 190          * were one of the two and need to be migrated off this list to another
 191          * VCPU.
 192          */
 193         struct list_head ap_list_head;
 194
 195         u64 live_lrs;
 196
 197         /*
 198          * Members below are used with GICv3 emulation only and represent
 199          * parts of the redistributor.
 200          */
 201         struct vgic_io_device   rd_iodev;
 202         struct vgic_io_device   sgi_iodev;
 203 };
 204
 205 int kvm_vgic_addr(struct kvm *kvm, unsigned long type, u64 *addr, bool write);
 206 void kvm_vgic_early_init(struct kvm *kvm);
 207 int kvm_vgic_create(struct kvm *kvm, u32 type);
 208 void kvm_vgic_destroy(struct kvm *kvm);
 209 void kvm_vgic_vcpu_early_init(struct kvm_vcpu *vcpu);
 210 void kvm_vgic_vcpu_destroy(struct kvm_vcpu *vcpu);
 211 int kvm_vgic_map_resources(struct kvm *kvm);
 212 int kvm_vgic_hyp_init(void);
 213
 214 int kvm_vgic_inject_irq(struct kvm *kvm, int cpuid, unsigned int intid,
 215                         bool level);
 216 int kvm_vgic_inject_mapped_irq(struct kvm *kvm, int cpuid, unsigned int intid,
 217                                bool level);
 218 int kvm_vgic_map_phys_irq(struct kvm_vcpu *vcpu, u32 virt_irq, u32 phys_irq);
 219 int kvm_vgic_unmap_phys_irq(struct kvm_vcpu *vcpu, unsigned int virt_irq);
 220 bool kvm_vgic_map_is_active(struct kvm_vcpu *vcpu, unsigned int virt_irq);
 221
 222 int kvm_vgic_vcpu_pending_irq(struct kvm_vcpu *vcpu);
 223
 224 #define irqchip_in_kernel(k)    (!!((k)->arch.vgic.in_kernel))
 225 #define vgic_initialized(k)     ((k)->arch.vgic.initialized)
 226 #define vgic_ready(k)           ((k)->arch.vgic.ready)
 227 #define vgic_valid_spi(k, i)    (((i) >= VGIC_NR_PRIVATE_IRQS) && \
 228                         ((i) < (k)->arch.vgic.nr_spis + VGIC_NR_PRIVATE_IRQS))
 229
 230 bool kvm_vcpu_has_pending_irqs(struct kvm_vcpu *vcpu);
 231 void kvm_vgic_sync_hwstate(struct kvm_vcpu *vcpu);
 232 void kvm_vgic_flush_hwstate(struct kvm_vcpu *vcpu);
 233
 234 #ifdef CONFIG_KVM_ARM_VGIC_V3
 235 void vgic_v3_dispatch_sgi(struct kvm_vcpu *vcpu, u64 reg);
 236 #else
 237 static inline void vgic_v3_dispatch_sgi(struct kvm_vcpu *vcpu, u64 reg)
 238 {
 239 }
 240 #endif
 241
 242 /**
 243  * kvm_vgic_get_max_vcpus - Get the maximum number of VCPUs allowed by HW
 244  *
 245  * The host's GIC naturally limits the maximum amount of VCPUs a guest
 246  * can use.
 247  */
 248 static inline int kvm_vgic_get_max_vcpus(void)
 249 {
 250         return kvm_vgic_global_state.max_gic_vcpus;
 251 }
 252
 253 #endif /* __KVM_ARM_VGIC_H */