arch/arm/include/uapi/asm/kvm.h

   1 /*
   2  * Copyright (C) 2012 - Virtual Open Systems and Columbia University
   3  * Author: Christoffer Dall <c.dall@virtualopensystems.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, 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 #ifndef __ARM_KVM_H__
  20 #define __ARM_KVM_H__
  21
  22 #include <linux/types.h>
  23 #include <linux/psci.h>
  24 #include <asm/ptrace.h>
  25
  26 #define __KVM_HAVE_GUEST_DEBUG
  27 #define __KVM_HAVE_IRQ_LINE
  28 #define __KVM_HAVE_READONLY_MEM
  29
  30 #define KVM_COALESCED_MMIO_PAGE_OFFSET 1
  31
  32 #define KVM_REG_SIZE(id)                                                \
  33         (1U << (((id) & KVM_REG_SIZE_MASK) >> KVM_REG_SIZE_SHIFT))
  34
  35 /* Valid for svc_regs, abt_regs, und_regs, irq_regs in struct kvm_regs */
  36 #define KVM_ARM_SVC_sp          svc_regs[0]
  37 #define KVM_ARM_SVC_lr          svc_regs[1]
  38 #define KVM_ARM_SVC_spsr        svc_regs[2]
  39 #define KVM_ARM_ABT_sp          abt_regs[0]
  40 #define KVM_ARM_ABT_lr          abt_regs[1]
  41 #define KVM_ARM_ABT_spsr        abt_regs[2]
  42 #define KVM_ARM_UND_sp          und_regs[0]
  43 #define KVM_ARM_UND_lr          und_regs[1]
  44 #define KVM_ARM_UND_spsr        und_regs[2]
  45 #define KVM_ARM_IRQ_sp          irq_regs[0]
  46 #define KVM_ARM_IRQ_lr          irq_regs[1]
  47 #define KVM_ARM_IRQ_spsr        irq_regs[2]
  48
  49 /* Valid only for fiq_regs in struct kvm_regs */
  50 #define KVM_ARM_FIQ_r8          fiq_regs[0]
  51 #define KVM_ARM_FIQ_r9          fiq_regs[1]
  52 #define KVM_ARM_FIQ_r10         fiq_regs[2]
  53 #define KVM_ARM_FIQ_fp          fiq_regs[3]
  54 #define KVM_ARM_FIQ_ip          fiq_regs[4]
  55 #define KVM_ARM_FIQ_sp          fiq_regs[5]
  56 #define KVM_ARM_FIQ_lr          fiq_regs[6]
  57 #define KVM_ARM_FIQ_spsr        fiq_regs[7]
  58
  59 struct kvm_regs {
  60         struct pt_regs usr_regs;        /* R0_usr - R14_usr, PC, CPSR */
  61         unsigned long svc_regs[3];      /* SP_svc, LR_svc, SPSR_svc */
  62         unsigned long abt_regs[3];      /* SP_abt, LR_abt, SPSR_abt */
  63         unsigned long und_regs[3];      /* SP_und, LR_und, SPSR_und */
  64         unsigned long irq_regs[3];      /* SP_irq, LR_irq, SPSR_irq */
  65         unsigned long fiq_regs[8];      /* R8_fiq - R14_fiq, SPSR_fiq */
  66 };
  67
  68 /* Supported Processor Types */
  69 #define KVM_ARM_TARGET_CORTEX_A15       0
  70 #define KVM_ARM_TARGET_CORTEX_A7        1
  71 #define KVM_ARM_NUM_TARGETS             2
  72
  73 /* KVM_ARM_SET_DEVICE_ADDR ioctl id encoding */
  74 #define KVM_ARM_DEVICE_TYPE_SHIFT       0
  75 #define KVM_ARM_DEVICE_TYPE_MASK        (0xffff << KVM_ARM_DEVICE_TYPE_SHIFT)
  76 #define KVM_ARM_DEVICE_ID_SHIFT         16
  77 #define KVM_ARM_DEVICE_ID_MASK          (0xffff << KVM_ARM_DEVICE_ID_SHIFT)
  78
  79 /* Supported device IDs */
  80 #define KVM_ARM_DEVICE_VGIC_V2          0
  81
  82 /* Supported VGIC address types  */
  83 #define KVM_VGIC_V2_ADDR_TYPE_DIST      0
  84 #define KVM_VGIC_V2_ADDR_TYPE_CPU       1
  85
  86 #define KVM_VGIC_V2_DIST_SIZE           0x1000
  87 #define KVM_VGIC_V2_CPU_SIZE            0x2000
  88
  89 /* Supported VGICv3 address types  */
  90 #define KVM_VGIC_V3_ADDR_TYPE_DIST      2
  91 #define KVM_VGIC_V3_ADDR_TYPE_REDIST    3
  92 #define KVM_VGIC_ITS_ADDR_TYPE          4
  93
  94 #define KVM_VGIC_V3_DIST_SIZE           SZ_64K
  95 #define KVM_VGIC_V3_REDIST_SIZE         (2 * SZ_64K)
  96 #define KVM_VGIC_V3_ITS_SIZE            (2 * SZ_64K)
  97
  98 #define KVM_ARM_VCPU_POWER_OFF          0 /* CPU is started in OFF state */
  99 #define KVM_ARM_VCPU_PSCI_0_2           1 /* CPU uses PSCI v0.2 */
 100
 101 struct kvm_vcpu_init {
 102         __u32 target;
 103         __u32 features[7];
 104 };
 105
 106 struct kvm_sregs {
 107 };
 108
 109 struct kvm_fpu {
 110 };
 111
 112 struct kvm_guest_debug_arch {
 113 };
 114
 115 struct kvm_debug_exit_arch {
 116 };
 117
 118 struct kvm_sync_regs {
 119         /* Used with KVM_CAP_ARM_USER_IRQ */
 120         __u64 device_irq_level;
 121 };
 122
 123 struct kvm_arch_memory_slot {
 124 };
 125
 126 /* If you need to interpret the index values, here is the key: */
 127 #define KVM_REG_ARM_COPROC_MASK         0x000000000FFF0000
 128 #define KVM_REG_ARM_COPROC_SHIFT        16
 129 #define KVM_REG_ARM_32_OPC2_MASK        0x0000000000000007
 130 #define KVM_REG_ARM_32_OPC2_SHIFT       0
 131 #define KVM_REG_ARM_OPC1_MASK           0x0000000000000078
 132 #define KVM_REG_ARM_OPC1_SHIFT          3
 133 #define KVM_REG_ARM_CRM_MASK            0x0000000000000780
 134 #define KVM_REG_ARM_CRM_SHIFT           7
 135 #define KVM_REG_ARM_32_CRN_MASK         0x0000000000007800
 136 #define KVM_REG_ARM_32_CRN_SHIFT        11
 137
 138 #define ARM_CP15_REG_SHIFT_MASK(x,n) \
 139         (((x) << KVM_REG_ARM_ ## n ## _SHIFT) & KVM_REG_ARM_ ## n ## _MASK)
 140
 141 #define __ARM_CP15_REG(op1,crn,crm,op2) \
 142         (KVM_REG_ARM | (15 << KVM_REG_ARM_COPROC_SHIFT) | \
 143         ARM_CP15_REG_SHIFT_MASK(op1, OPC1) | \
 144         ARM_CP15_REG_SHIFT_MASK(crn, 32_CRN) | \
 145         ARM_CP15_REG_SHIFT_MASK(crm, CRM) | \
 146         ARM_CP15_REG_SHIFT_MASK(op2, 32_OPC2))
 147
 148 #define ARM_CP15_REG32(...) (__ARM_CP15_REG(__VA_ARGS__) | KVM_REG_SIZE_U32)
 149
 150 #define __ARM_CP15_REG64(op1,crm) \
 151         (__ARM_CP15_REG(op1, 0, crm, 0) | KVM_REG_SIZE_U64)
 152 #define ARM_CP15_REG64(...) __ARM_CP15_REG64(__VA_ARGS__)
 153
 154 #define KVM_REG_ARM_TIMER_CTL           ARM_CP15_REG32(0, 14, 3, 1)
 155 #define KVM_REG_ARM_TIMER_CNT           ARM_CP15_REG64(1, 14)
 156 #define KVM_REG_ARM_TIMER_CVAL          ARM_CP15_REG64(3, 14)
 157
 158 /* Normal registers are mapped as coprocessor 16. */
 159 #define KVM_REG_ARM_CORE                (0x0010 << KVM_REG_ARM_COPROC_SHIFT)
 160 #define KVM_REG_ARM_CORE_REG(name)      (offsetof(struct kvm_regs, name) / 4)
 161
 162 /* Some registers need more space to represent values. */
 163 #define KVM_REG_ARM_DEMUX               (0x0011 << KVM_REG_ARM_COPROC_SHIFT)
 164 #define KVM_REG_ARM_DEMUX_ID_MASK       0x000000000000FF00
 165 #define KVM_REG_ARM_DEMUX_ID_SHIFT      8
 166 #define KVM_REG_ARM_DEMUX_ID_CCSIDR     (0x00 << KVM_REG_ARM_DEMUX_ID_SHIFT)
 167 #define KVM_REG_ARM_DEMUX_VAL_MASK      0x00000000000000FF
 168 #define KVM_REG_ARM_DEMUX_VAL_SHIFT     0
 169
 170 /* VFP registers: we could overload CP10 like ARM does, but that's ugly. */
 171 #define KVM_REG_ARM_VFP                 (0x0012 << KVM_REG_ARM_COPROC_SHIFT)
 172 #define KVM_REG_ARM_VFP_MASK            0x000000000000FFFF
 173 #define KVM_REG_ARM_VFP_BASE_REG        0x0
 174 #define KVM_REG_ARM_VFP_FPSID           0x1000
 175 #define KVM_REG_ARM_VFP_FPSCR           0x1001
 176 #define KVM_REG_ARM_VFP_MVFR1           0x1006
 177 #define KVM_REG_ARM_VFP_MVFR0           0x1007
 178 #define KVM_REG_ARM_VFP_FPEXC           0x1008
 179 #define KVM_REG_ARM_VFP_FPINST          0x1009
 180 #define KVM_REG_ARM_VFP_FPINST2         0x100A
 181
 182 /* Device Control API: ARM VGIC */
 183 #define KVM_DEV_ARM_VGIC_GRP_ADDR       0
 184 #define KVM_DEV_ARM_VGIC_GRP_DIST_REGS  1
 185 #define KVM_DEV_ARM_VGIC_GRP_CPU_REGS   2
 186 #define   KVM_DEV_ARM_VGIC_CPUID_SHIFT  32
 187 #define   KVM_DEV_ARM_VGIC_CPUID_MASK   (0xffULL << KVM_DEV_ARM_VGIC_CPUID_SHIFT)
 188 #define   KVM_DEV_ARM_VGIC_V3_MPIDR_SHIFT 32
 189 #define   KVM_DEV_ARM_VGIC_V3_MPIDR_MASK \
 190                         (0xffffffffULL << KVM_DEV_ARM_VGIC_V3_MPIDR_SHIFT)
 191 #define   KVM_DEV_ARM_VGIC_OFFSET_SHIFT 0
 192 #define   KVM_DEV_ARM_VGIC_OFFSET_MASK  (0xffffffffULL << KVM_DEV_ARM_VGIC_OFFSET_SHIFT)
 193 #define   KVM_DEV_ARM_VGIC_SYSREG_INSTR_MASK (0xffff)
 194 #define KVM_DEV_ARM_VGIC_GRP_NR_IRQS    3
 195 #define KVM_DEV_ARM_VGIC_GRP_CTRL       4
 196 #define KVM_DEV_ARM_VGIC_GRP_REDIST_REGS 5
 197 #define KVM_DEV_ARM_VGIC_GRP_CPU_SYSREGS 6
 198 #define KVM_DEV_ARM_VGIC_GRP_LEVEL_INFO  7
 199 #define KVM_DEV_ARM_VGIC_GRP_ITS_REGS   8
 200 #define KVM_DEV_ARM_VGIC_LINE_LEVEL_INFO_SHIFT  10
 201 #define KVM_DEV_ARM_VGIC_LINE_LEVEL_INFO_MASK \
 202                         (0x3fffffULL << KVM_DEV_ARM_VGIC_LINE_LEVEL_INFO_SHIFT)
 203 #define KVM_DEV_ARM_VGIC_LINE_LEVEL_INTID_MASK 0x3ff
 204 #define VGIC_LEVEL_INFO_LINE_LEVEL      0
 205
 206 /* Device Control API on vcpu fd */
 207 #define KVM_ARM_VCPU_PMU_V3_CTRL        0
 208 #define   KVM_ARM_VCPU_PMU_V3_IRQ       0
 209 #define   KVM_ARM_VCPU_PMU_V3_INIT      1
 210 #define KVM_ARM_VCPU_TIMER_CTRL         1
 211 #define   KVM_ARM_VCPU_TIMER_IRQ_VTIMER         0
 212 #define   KVM_ARM_VCPU_TIMER_IRQ_PTIMER         1
 213
 214 #define   KVM_DEV_ARM_VGIC_CTRL_INIT            0
 215 #define   KVM_DEV_ARM_ITS_SAVE_TABLES           1
 216 #define   KVM_DEV_ARM_ITS_RESTORE_TABLES        2
 217 #define   KVM_DEV_ARM_VGIC_SAVE_PENDING_TABLES  3
 218
 219 /* KVM_IRQ_LINE irq field index values */
 220 #define KVM_ARM_IRQ_TYPE_SHIFT          24
 221 #define KVM_ARM_IRQ_TYPE_MASK           0xff
 222 #define KVM_ARM_IRQ_VCPU_SHIFT          16
 223 #define KVM_ARM_IRQ_VCPU_MASK           0xff
 224 #define KVM_ARM_IRQ_NUM_SHIFT           0
 225 #define KVM_ARM_IRQ_NUM_MASK            0xffff
 226
 227 /* irq_type field */
 228 #define KVM_ARM_IRQ_TYPE_CPU            0
 229 #define KVM_ARM_IRQ_TYPE_SPI            1
 230 #define KVM_ARM_IRQ_TYPE_PPI            2
 231
 232 /* out-of-kernel GIC cpu interrupt injection irq_number field */
 233 #define KVM_ARM_IRQ_CPU_IRQ             0
 234 #define KVM_ARM_IRQ_CPU_FIQ             1
 235
 236 /*
 237  * This used to hold the highest supported SPI, but it is now obsolete
 238  * and only here to provide source code level compatibility with older
 239  * userland. The highest SPI number can be set via KVM_DEV_ARM_VGIC_GRP_NR_IRQS.
 240  */
 241 #ifndef __KERNEL__
 242 #define KVM_ARM_IRQ_GIC_MAX             127
 243 #endif
 244
 245 /* One single KVM irqchip, ie. the VGIC */
 246 #define KVM_NR_IRQCHIPS          1
 247
 248 /* PSCI interface */
 249 #define KVM_PSCI_FN_BASE                0x95c1ba5e
 250 #define KVM_PSCI_FN(n)                  (KVM_PSCI_FN_BASE + (n))
 251
 252 #define KVM_PSCI_FN_CPU_SUSPEND         KVM_PSCI_FN(0)
 253 #define KVM_PSCI_FN_CPU_OFF             KVM_PSCI_FN(1)
 254 #define KVM_PSCI_FN_CPU_ON              KVM_PSCI_FN(2)
 255 #define KVM_PSCI_FN_MIGRATE             KVM_PSCI_FN(3)
 256
 257 #define KVM_PSCI_RET_SUCCESS            PSCI_RET_SUCCESS
 258 #define KVM_PSCI_RET_NI                 PSCI_RET_NOT_SUPPORTED
 259 #define KVM_PSCI_RET_INVAL              PSCI_RET_INVALID_PARAMS
 260 #define KVM_PSCI_RET_DENIED             PSCI_RET_DENIED
 261
 262 #endif /* __ARM_KVM_H__ */