include/kvm/arm_vgic.h

   1 /*
   2  * Copyright (C) 2012 ARM Ltd.
   3  * Author: Marc Zyngier <marc.zyngier@arm.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  17  */
  18
  19 #ifndef __ASM_ARM_KVM_VGIC_H
  20 #define __ASM_ARM_KVM_VGIC_H
  21
  22 #include <linux/kernel.h>
  23 #include <linux/kvm.h>
  24 #include <linux/irqreturn.h>
  25 #include <linux/spinlock.h>
  26 #include <linux/types.h>
  27 #include <kvm/iodev.h>
  28
  29 #define VGIC_NR_IRQS_LEGACY     256
  30 #define VGIC_NR_SGIS            16
  31 #define VGIC_NR_PPIS            16
  32 #define VGIC_NR_PRIVATE_IRQS    (VGIC_NR_SGIS + VGIC_NR_PPIS)
  33
  34 #define VGIC_V2_MAX_LRS         (1 << 6)
  35 #define VGIC_V3_MAX_LRS         16
  36 #define VGIC_MAX_IRQS           1024
  37 #define VGIC_V2_MAX_CPUS        8
  38
  39 /* Sanity checks... */
  40 #if (KVM_MAX_VCPUS > 255)
  41 #error Too many KVM VCPUs, the VGIC only supports up to 255 VCPUs for now
  42 #endif
  43
  44 #if (VGIC_NR_IRQS_LEGACY & 31)
  45 #error "VGIC_NR_IRQS must be a multiple of 32"
  46 #endif
  47
  48 #if (VGIC_NR_IRQS_LEGACY > VGIC_MAX_IRQS)
  49 #error "VGIC_NR_IRQS must be <= 1024"
  50 #endif
  51
  52 /*
  53  * The GIC distributor registers describing interrupts have two parts:
  54  * - 32 per-CPU interrupts (SGI + PPI)
  55  * - a bunch of shared interrupts (SPI)
  56  */
  57 struct vgic_bitmap {
  58         /*
  59          * - One UL per VCPU for private interrupts (assumes UL is at
  60          *   least 32 bits)
  61          * - As many UL as necessary for shared interrupts.
  62          *
  63          * The private interrupts are accessed via the "private"
  64          * field, one UL per vcpu (the state for vcpu n is in
  65          * private[n]). The shared interrupts are accessed via the
  66          * "shared" pointer (IRQn state is at bit n-32 in the bitmap).
  67          */
  68         unsigned long *private;
  69         unsigned long *shared;
  70 };
  71
  72 struct vgic_bytemap {
  73         /*
  74          * - 8 u32 per VCPU for private interrupts
  75          * - As many u32 as necessary for shared interrupts.
  76          *
  77          * The private interrupts are accessed via the "private"
  78          * field, (the state for vcpu n is in private[n*8] to
  79          * private[n*8 + 7]). The shared interrupts are accessed via
  80          * the "shared" pointer (IRQn state is at byte (n-32)%4 of the
  81          * shared[(n-32)/4] word).
  82          */
  83         u32 *private;
  84         u32 *shared;
  85 };
  86
  87 struct kvm_vcpu;
  88
  89 enum vgic_type {
  90         VGIC_V2,                /* Good ol' GICv2 */
  91         VGIC_V3,                /* New fancy GICv3 */
  92 };
  93
  94 #define LR_STATE_PENDING        (1 << 0)
  95 #define LR_STATE_ACTIVE         (1 << 1)
  96 #define LR_STATE_MASK           (3 << 0)
  97 #define LR_EOI_INT              (1 << 2)
  98
  99 struct vgic_lr {
 100         u16     irq;
 101         u8      source;
 102         u8      state;
 103 };
 104
 105 struct vgic_vmcr {
 106         u32     ctlr;
 107         u32     abpr;
 108         u32     bpr;
 109         u32     pmr;
 110 };
 111
 112 struct vgic_ops {
 113         struct vgic_lr  (*get_lr)(const struct kvm_vcpu *, int);
 114         void    (*set_lr)(struct kvm_vcpu *, int, struct vgic_lr);
 115         void    (*sync_lr_elrsr)(struct kvm_vcpu *, int, struct vgic_lr);
 116         u64     (*get_elrsr)(const struct kvm_vcpu *vcpu);
 117         u64     (*get_eisr)(const struct kvm_vcpu *vcpu);
 118         u32     (*get_interrupt_status)(const struct kvm_vcpu *vcpu);
 119         void    (*enable_underflow)(struct kvm_vcpu *vcpu);
 120         void    (*disable_underflow)(struct kvm_vcpu *vcpu);
 121         void    (*get_vmcr)(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
 122         void    (*set_vmcr)(struct kvm_vcpu *vcpu, struct vgic_vmcr *vmcr);
 123         void    (*enable)(struct kvm_vcpu *vcpu);
 124 };
 125
 126 struct vgic_params {
 127         /* vgic type */
 128         enum vgic_type  type;
 129         /* Physical address of vgic virtual cpu interface */
 130         phys_addr_t     vcpu_base;
 131         /* Number of list registers */
 132         u32             nr_lr;
 133         /* Interrupt number */
 134         unsigned int    maint_irq;
 135         /* Virtual control interface base address */
 136         void __iomem    *vctrl_base;
 137         int             max_gic_vcpus;
 138         /* Only needed for the legacy KVM_CREATE_IRQCHIP */
 139         bool            can_emulate_gicv2;
 140 };
 141
 142 struct vgic_vm_ops {
 143         bool    (*handle_mmio)(struct kvm_vcpu *, struct kvm_run *,
 144                                struct kvm_exit_mmio *);
 145         bool    (*queue_sgi)(struct kvm_vcpu *, int irq);
 146         void    (*add_sgi_source)(struct kvm_vcpu *, int irq, int source);
 147         int     (*init_model)(struct kvm *);
 148         int     (*map_resources)(struct kvm *, const struct vgic_params *);
 149 };
 150
 151 struct vgic_io_device {
 152         gpa_t addr;
 153         int len;
 154         const struct vgic_io_range *reg_ranges;
 155         struct kvm_vcpu *redist_vcpu;
 156         struct kvm_io_device dev;
 157 };
 158
 159 struct vgic_dist {
 160         spinlock_t              lock;
 161         bool                    in_kernel;
 162         bool                    ready;
 163
 164         /* vGIC model the kernel emulates for the guest (GICv2 or GICv3) */
 165         u32                     vgic_model;
 166
 167         int                     nr_cpus;
 168         int                     nr_irqs;
 169
 170         /* Virtual control interface mapping */
 171         void __iomem            *vctrl_base;
 172
 173         /* Distributor and vcpu interface mapping in the guest */
 174         phys_addr_t             vgic_dist_base;
 175         /* GICv2 and GICv3 use different mapped register blocks */
 176         union {
 177                 phys_addr_t             vgic_cpu_base;
 178                 phys_addr_t             vgic_redist_base;
 179         };
 180
 181         /* Distributor enabled */
 182         u32                     enabled;
 183
 184         /* Interrupt enabled (one bit per IRQ) */
 185         struct vgic_bitmap      irq_enabled;
 186
 187         /* Level-triggered interrupt external input is asserted */
 188         struct vgic_bitmap      irq_level;
 189
 190         /*
 191          * Interrupt state is pending on the distributor
 192          */
 193         struct vgic_bitmap      irq_pending;
 194
 195         /*
 196          * Tracks writes to GICD_ISPENDRn and GICD_ICPENDRn for level-triggered
 197          * interrupts.  Essentially holds the state of the flip-flop in
 198          * Figure 4-10 on page 4-101 in ARM IHI 0048B.b.
 199          * Once set, it is only cleared for level-triggered interrupts on
 200          * guest ACKs (when we queue it) or writes to GICD_ICPENDRn.
 201          */
 202         struct vgic_bitmap      irq_soft_pend;
 203
 204         /* Level-triggered interrupt queued on VCPU interface */
 205         struct vgic_bitmap      irq_queued;
 206
 207         /* Interrupt was active when unqueue from VCPU interface */
 208         struct vgic_bitmap      irq_active;
 209
 210         /* Interrupt priority. Not used yet. */
 211         struct vgic_bytemap     irq_priority;
 212
 213         /* Level/edge triggered */
 214         struct vgic_bitmap      irq_cfg;
 215
 216         /*
 217          * Source CPU per SGI and target CPU:
 218          *
 219          * Each byte represent a SGI observable on a VCPU, each bit of
 220          * this byte indicating if the corresponding VCPU has
 221          * generated this interrupt. This is a GICv2 feature only.
 222          *
 223          * For VCPUn (n < 8), irq_sgi_sources[n*16] to [n*16 + 15] are
 224          * the SGIs observable on VCPUn.
 225          */
 226         u8                      *irq_sgi_sources;
 227
 228         /*
 229          * Target CPU for each SPI:
 230          *
 231          * Array of available SPI, each byte indicating the target
 232          * VCPU for SPI. IRQn (n >=32) is at irq_spi_cpu[n-32].
 233          */
 234         u8                      *irq_spi_cpu;
 235
 236         /*
 237          * Reverse lookup of irq_spi_cpu for faster compute pending:
 238          *
 239          * Array of bitmaps, one per VCPU, describing if IRQn is
 240          * routed to a particular VCPU.
 241          */
 242         struct vgic_bitmap      *irq_spi_target;
 243
 244         /* Target MPIDR for each IRQ (needed for GICv3 IROUTERn) only */
 245         u32                     *irq_spi_mpidr;
 246
 247         /* Bitmap indicating which CPU has something pending */
 248         unsigned long           *irq_pending_on_cpu;
 249
 250         /* Bitmap indicating which CPU has active IRQs */
 251         unsigned long           *irq_active_on_cpu;
 252
 253         struct vgic_vm_ops      vm_ops;
 254         struct vgic_io_device   dist_iodev;
 255 };
 256
 257 struct vgic_v2_cpu_if {
 258         u32             vgic_hcr;
 259         u32             vgic_vmcr;
 260         u32             vgic_misr;      /* Saved only */
 261         u64             vgic_eisr;      /* Saved only */
 262         u64             vgic_elrsr;     /* Saved only */
 263         u32             vgic_apr;
 264         u32             vgic_lr[VGIC_V2_MAX_LRS];
 265 };
 266
 267 struct vgic_v3_cpu_if {
 268 #ifdef CONFIG_ARM_GIC_V3
 269         u32             vgic_hcr;
 270         u32             vgic_vmcr;
 271         u32             vgic_sre;       /* Restored only, change ignored */
 272         u32             vgic_misr;      /* Saved only */
 273         u32             vgic_eisr;      /* Saved only */
 274         u32             vgic_elrsr;     /* Saved only */
 275         u32             vgic_ap0r[4];
 276         u32             vgic_ap1r[4];
 277         u64             vgic_lr[VGIC_V3_MAX_LRS];
 278 #endif
 279 };
 280
 281 struct vgic_cpu {
 282         /* per IRQ to LR mapping */
 283         u8              *vgic_irq_lr_map;
 284
 285         /* Pending/active/both interrupts on this VCPU */
 286         DECLARE_BITMAP( pending_percpu, VGIC_NR_PRIVATE_IRQS);
 287         DECLARE_BITMAP( active_percpu, VGIC_NR_PRIVATE_IRQS);
 288         DECLARE_BITMAP( pend_act_percpu, VGIC_NR_PRIVATE_IRQS);
 289
 290         /* Pending/active/both shared interrupts, dynamically sized */
 291         unsigned long   *pending_shared;
 292         unsigned long   *active_shared;
 293         unsigned long   *pend_act_shared;
 294
 295         /* Bitmap of used/free list registers */
 296         DECLARE_BITMAP( lr_used, VGIC_V2_MAX_LRS);
 297
 298         /* Number of list registers on this CPU */
 299         int             nr_lr;
 300
 301         /* CPU vif control registers for world switch */
 302         union {
 303                 struct vgic_v2_cpu_if   vgic_v2;
 304                 struct vgic_v3_cpu_if   vgic_v3;
 305         };
 306 };
 307
 308 #define LR_EMPTY        0xff
 309
 310 #define INT_STATUS_EOI          (1 << 0)
 311 #define INT_STATUS_UNDERFLOW    (1 << 1)
 312
 313 struct kvm;
 314 struct kvm_vcpu;
 315 struct kvm_run;
 316 struct kvm_exit_mmio;
 317
 318 int kvm_vgic_addr(struct kvm *kvm, unsigned long type, u64 *addr, bool write);
 319 int kvm_vgic_hyp_init(void);
 320 int kvm_vgic_map_resources(struct kvm *kvm);
 321 int kvm_vgic_get_max_vcpus(void);
 322 int kvm_vgic_create(struct kvm *kvm, u32 type);
 323 void kvm_vgic_destroy(struct kvm *kvm);
 324 void kvm_vgic_vcpu_destroy(struct kvm_vcpu *vcpu);
 325 void kvm_vgic_flush_hwstate(struct kvm_vcpu *vcpu);
 326 void kvm_vgic_sync_hwstate(struct kvm_vcpu *vcpu);
 327 int kvm_vgic_inject_irq(struct kvm *kvm, int cpuid, unsigned int irq_num,
 328                         bool level);
 329 void vgic_v3_dispatch_sgi(struct kvm_vcpu *vcpu, u64 reg);
 330 int kvm_vgic_vcpu_pending_irq(struct kvm_vcpu *vcpu);
 331 int kvm_vgic_vcpu_active_irq(struct kvm_vcpu *vcpu);
 332 bool vgic_handle_mmio(struct kvm_vcpu *vcpu, struct kvm_run *run,
 333                       struct kvm_exit_mmio *mmio);
 334
 335 #define irqchip_in_kernel(k)    (!!((k)->arch.vgic.in_kernel))
 336 #define vgic_initialized(k)     (!!((k)->arch.vgic.nr_cpus))
 337 #define vgic_ready(k)           ((k)->arch.vgic.ready)
 338
 339 int vgic_v2_probe(struct device_node *vgic_node,
 340                   const struct vgic_ops **ops,
 341                   const struct vgic_params **params);
 342 #ifdef CONFIG_ARM_GIC_V3
 343 int vgic_v3_probe(struct device_node *vgic_node,
 344                   const struct vgic_ops **ops,
 345                   const struct vgic_params **params);
 346 #else
 347 static inline int vgic_v3_probe(struct device_node *vgic_node,
 348                                 const struct vgic_ops **ops,
 349                                 const struct vgic_params **params)
 350 {
 351         return -ENODEV;
 352 }
 353 #endif
 354
 355 #endif