Documentation/virtual/kvm/devices/arm-vgic-its.txt

   1 ARM Virtual Interrupt Translation Service (ITS)
   2 ===============================================
   3
   4 Device types supported:
   5   KVM_DEV_TYPE_ARM_VGIC_ITS    ARM Interrupt Translation Service Controller
   6
   7 The ITS allows MSI(-X) interrupts to be injected into guests. This extension is
   8 optional.  Creating a virtual ITS controller also requires a host GICv3 (see
   9 arm-vgic-v3.txt), but does not depend on having physical ITS controllers.
  10
  11 There can be multiple ITS controllers per guest, each of them has to have
  12 a separate, non-overlapping MMIO region.
  13
  14
  15 Groups:
  16   KVM_DEV_ARM_VGIC_GRP_ADDR
  17   Attributes:
  18     KVM_VGIC_ITS_ADDR_TYPE (rw, 64-bit)
  19       Base address in the guest physical address space of the GICv3 ITS
  20       control register frame.
  21       This address needs to be 64K aligned and the region covers 128K.
  22   Errors:
  23     -E2BIG:  Address outside of addressable IPA range
  24     -EINVAL: Incorrectly aligned address
  25     -EEXIST: Address already configured
  26     -EFAULT: Invalid user pointer for attr->addr.
  27     -ENODEV: Incorrect attribute or the ITS is not supported.
  28
  29
  30   KVM_DEV_ARM_VGIC_GRP_CTRL
  31   Attributes:
  32     KVM_DEV_ARM_VGIC_CTRL_INIT
  33       request the initialization of the ITS, no additional parameter in
  34       kvm_device_attr.addr.
  35
  36     KVM_DEV_ARM_ITS_CTRL_RESET
  37       reset the ITS, no additional parameter in kvm_device_attr.addr.
  38       See "ITS Reset State" section.
  39
  40     KVM_DEV_ARM_ITS_SAVE_TABLES
  41       save the ITS table data into guest RAM, at the location provisioned
  42       by the guest in corresponding registers/table entries.
  43
  44       The layout of the tables in guest memory defines an ABI. The entries
  45       are laid out in little endian format as described in the last paragraph.
  46
  47     KVM_DEV_ARM_ITS_RESTORE_TABLES
  48       restore the ITS tables from guest RAM to ITS internal structures.
  49
  50       The GICV3 must be restored before the ITS and all ITS registers but
  51       the GITS_CTLR must be restored before restoring the ITS tables.
  52
  53       The GITS_IIDR read-only register must also be restored before
  54       calling KVM_DEV_ARM_ITS_RESTORE_TABLES as the IIDR revision field
  55       encodes the ABI revision.
  56
  57       The expected ordering when restoring the GICv3/ITS is described in section
  58       "ITS Restore Sequence".
  59
  60   Errors:
  61     -ENXIO:  ITS not properly configured as required prior to setting
  62              this attribute
  63     -ENOMEM: Memory shortage when allocating ITS internal data
  64     -EINVAL: Inconsistent restored data
  65     -EFAULT: Invalid guest ram access
  66     -EBUSY:  One or more VCPUS are running
  67
  68   KVM_DEV_ARM_VGIC_GRP_ITS_REGS
  69   Attributes:
  70       The attr field of kvm_device_attr encodes the offset of the
  71       ITS register, relative to the ITS control frame base address
  72       (ITS_base).
  73
  74       kvm_device_attr.addr points to a __u64 value whatever the width
  75       of the addressed register (32/64 bits). 64 bit registers can only
  76       be accessed with full length.
  77
  78       Writes to read-only registers are ignored by the kernel except for:
  79       - GITS_CREADR. It must be restored otherwise commands in the queue
  80         will be re-executed after restoring CWRITER. GITS_CREADR must be
  81         restored before restoring the GITS_CTLR which is likely to enable the
  82         ITS. Also it must be restored after GITS_CBASER since a write to
  83         GITS_CBASER resets GITS_CREADR.
  84       - GITS_IIDR. The Revision field encodes the table layout ABI revision.
  85         In the future we might implement direct injection of virtual LPIs.
  86         This will require an upgrade of the table layout and an evolution of
  87         the ABI. GITS_IIDR must be restored before calling
  88         KVM_DEV_ARM_ITS_RESTORE_TABLES.
  89
  90       For other registers, getting or setting a register has the same
  91       effect as reading/writing the register on real hardware.
  92   Errors:
  93     -ENXIO: Offset does not correspond to any supported register
  94     -EFAULT: Invalid user pointer for attr->addr
  95     -EINVAL: Offset is not 64-bit aligned
  96     -EBUSY: one or more VCPUS are running
  97
  98  ITS Restore Sequence:
  99  -------------------------
 100
 101 The following ordering must be followed when restoring the GIC and the ITS:
 102 a) restore all guest memory and create vcpus
 103 b) restore all redistributors
 104 c) provide the its base address
 105    (KVM_DEV_ARM_VGIC_GRP_ADDR)
 106 d) restore the ITS in the following order:
 107    1. Restore GITS_CBASER
 108    2. Restore all other GITS_ registers, except GITS_CTLR!
 109    3. Load the ITS table data (KVM_DEV_ARM_ITS_RESTORE_TABLES)
 110    4. Restore GITS_CTLR
 111
 112 Then vcpus can be started.
 113
 114  ITS Table ABI REV0:
 115  -------------------
 116
 117  Revision 0 of the ABI only supports the features of a virtual GICv3, and does
 118  not support a virtual GICv4 with support for direct injection of virtual
 119  interrupts for nested hypervisors.
 120
 121  The device table and ITT are indexed by the DeviceID and EventID,
 122  respectively. The collection table is not indexed by CollectionID, and the
 123  entries in the collection are listed in no particular order.
 124  All entries are 8 bytes.
 125
 126  Device Table Entry (DTE):
 127
 128  bits:     | 63| 62 ... 49 | 48 ... 5 | 4 ... 0 |
 129  values:   | V |   next    | ITT_addr |  Size   |
 130
 131  where;
 132  - V indicates whether the entry is valid. If not, other fields
 133    are not meaningful.
 134  - next: equals to 0 if this entry is the last one; otherwise it
 135    corresponds to the DeviceID offset to the next DTE, capped by
 136    2^14 -1.
 137  - ITT_addr matches bits [51:8] of the ITT address (256 Byte aligned).
 138  - Size specifies the supported number of bits for the EventID,
 139    minus one
 140
 141  Collection Table Entry (CTE):
 142
 143  bits:     | 63| 62 ..  52  | 51 ... 16 | 15  ...   0 |
 144  values:   | V |    RES0    |  RDBase   |    ICID     |
 145
 146  where:
 147  - V indicates whether the entry is valid. If not, other fields are
 148    not meaningful.
 149  - RES0: reserved field with Should-Be-Zero-or-Preserved behavior.
 150  - RDBase is the PE number (GICR_TYPER.Processor_Number semantic),
 151  - ICID is the collection ID
 152
 153  Interrupt Translation Entry (ITE):
 154
 155  bits:     | 63 ... 48 | 47 ... 16 | 15 ... 0 |
 156  values:   |    next   |   pINTID  |  ICID    |
 157
 158  where:
 159  - next: equals to 0 if this entry is the last one; otherwise it corresponds
 160    to the EventID offset to the next ITE capped by 2^16 -1.
 161  - pINTID is the physical LPI ID; if zero, it means the entry is not valid
 162    and other fields are not meaningful.
 163  - ICID is the collection ID
 164
 165  ITS Reset State:
 166  ----------------
 167
 168 RESET returns the ITS to the same state that it was when first created and
 169 initialized. When the RESET command returns, the following things are
 170 guaranteed:
 171
 172 - The ITS is not enabled and quiescent
 173   GITS_CTLR.Enabled = 0 .Quiescent=1
 174 - There is no internally cached state
 175 - No collection or device table are used
 176   GITS_BASER<n>.Valid = 0
 177 - GITS_CBASER = 0, GITS_CREADR = 0, GITS_CWRITER = 0
 178 - The ABI version is unchanged and remains the one set when the ITS
 179   device was first created.