1883f0b85SAlex Williamson /* 2883f0b85SAlex Williamson * VFIO API definition 3883f0b85SAlex Williamson * 4883f0b85SAlex Williamson * Copyright (C) 2012 Red Hat, Inc. All rights reserved. 5883f0b85SAlex Williamson * Author: Alex Williamson <alex.williamson@redhat.com> 6883f0b85SAlex Williamson * 7883f0b85SAlex Williamson * This program is free software; you can redistribute it and/or modify 8883f0b85SAlex Williamson * it under the terms of the GNU General Public License version 2 as 9883f0b85SAlex Williamson * published by the Free Software Foundation. 10883f0b85SAlex Williamson */ 11d4834ff9SAlexander Graf #ifndef VFIO_H 12d4834ff9SAlexander Graf #define VFIO_H 13883f0b85SAlex Williamson 14883f0b85SAlex Williamson #include <linux/types.h> 15883f0b85SAlex Williamson #include <linux/ioctl.h> 16883f0b85SAlex Williamson 17883f0b85SAlex Williamson #define VFIO_API_VERSION 0 18883f0b85SAlex Williamson 19883f0b85SAlex Williamson 20883f0b85SAlex Williamson /* Kernel & User level defines for VFIO IOCTLs. */ 21883f0b85SAlex Williamson 22883f0b85SAlex Williamson /* Extensions */ 23883f0b85SAlex Williamson 24883f0b85SAlex Williamson #define VFIO_TYPE1_IOMMU 1 25c5daeae1SAlexey Kardashevskiy #define VFIO_SPAPR_TCE_IOMMU 2 269ffd2685SCornelia Huck #define VFIO_TYPE1v2_IOMMU 3 279ffd2685SCornelia Huck /* 289ffd2685SCornelia Huck * IOMMU enforces DMA cache coherence (ex. PCIe NoSnoop stripping). This 299ffd2685SCornelia Huck * capability is subject to change as groups are added or removed. 309ffd2685SCornelia Huck */ 319ffd2685SCornelia Huck #define VFIO_DMA_CC_IOMMU 4 32883f0b85SAlex Williamson 33a9fd1654SJens Freimann /* Check if EEH is supported */ 34a9fd1654SJens Freimann #define VFIO_EEH 5 35a9fd1654SJens Freimann 36444b1996SArd Biesheuvel /* Two-stage IOMMU */ 37444b1996SArd Biesheuvel #define VFIO_TYPE1_NESTING_IOMMU 6 /* Implies v2 */ 38444b1996SArd Biesheuvel 3925b8b39bSAlexey Kardashevskiy #define VFIO_SPAPR_TCE_v2_IOMMU 7 4025b8b39bSAlexey Kardashevskiy 41883f0b85SAlex Williamson /* 42*66fb2d54SCornelia Huck * The No-IOMMU IOMMU offers no translation or isolation for devices and 43*66fb2d54SCornelia Huck * supports no ioctls outside of VFIO_CHECK_EXTENSION. Use of VFIO's No-IOMMU 44*66fb2d54SCornelia Huck * code will taint the host kernel and should be used with extreme caution. 45*66fb2d54SCornelia Huck */ 46*66fb2d54SCornelia Huck #define VFIO_NOIOMMU_IOMMU 8 47*66fb2d54SCornelia Huck 48*66fb2d54SCornelia Huck /* 49883f0b85SAlex Williamson * The IOCTL interface is designed for extensibility by embedding the 50883f0b85SAlex Williamson * structure length (argsz) and flags into structures passed between 51883f0b85SAlex Williamson * kernel and userspace. We therefore use the _IO() macro for these 52883f0b85SAlex Williamson * defines to avoid implicitly embedding a size into the ioctl request. 53883f0b85SAlex Williamson * As structure fields are added, argsz will increase to match and flag 54883f0b85SAlex Williamson * bits will be defined to indicate additional fields with valid data. 55883f0b85SAlex Williamson * It's *always* the caller's responsibility to indicate the size of 56883f0b85SAlex Williamson * the structure passed by setting argsz appropriately. 57883f0b85SAlex Williamson */ 58883f0b85SAlex Williamson 59883f0b85SAlex Williamson #define VFIO_TYPE (';') 60883f0b85SAlex Williamson #define VFIO_BASE 100 61883f0b85SAlex Williamson 62883f0b85SAlex Williamson /* -------- IOCTLs for VFIO file descriptor (/dev/vfio/vfio) -------- */ 63883f0b85SAlex Williamson 64883f0b85SAlex Williamson /** 65883f0b85SAlex Williamson * VFIO_GET_API_VERSION - _IO(VFIO_TYPE, VFIO_BASE + 0) 66883f0b85SAlex Williamson * 67883f0b85SAlex Williamson * Report the version of the VFIO API. This allows us to bump the entire 68883f0b85SAlex Williamson * API version should we later need to add or change features in incompatible 69883f0b85SAlex Williamson * ways. 70883f0b85SAlex Williamson * Return: VFIO_API_VERSION 71883f0b85SAlex Williamson * Availability: Always 72883f0b85SAlex Williamson */ 73883f0b85SAlex Williamson #define VFIO_GET_API_VERSION _IO(VFIO_TYPE, VFIO_BASE + 0) 74883f0b85SAlex Williamson 75883f0b85SAlex Williamson /** 76883f0b85SAlex Williamson * VFIO_CHECK_EXTENSION - _IOW(VFIO_TYPE, VFIO_BASE + 1, __u32) 77883f0b85SAlex Williamson * 78883f0b85SAlex Williamson * Check whether an extension is supported. 79883f0b85SAlex Williamson * Return: 0 if not supported, 1 (or some other positive integer) if supported. 80883f0b85SAlex Williamson * Availability: Always 81883f0b85SAlex Williamson */ 82883f0b85SAlex Williamson #define VFIO_CHECK_EXTENSION _IO(VFIO_TYPE, VFIO_BASE + 1) 83883f0b85SAlex Williamson 84883f0b85SAlex Williamson /** 85883f0b85SAlex Williamson * VFIO_SET_IOMMU - _IOW(VFIO_TYPE, VFIO_BASE + 2, __s32) 86883f0b85SAlex Williamson * 87883f0b85SAlex Williamson * Set the iommu to the given type. The type must be supported by an 88883f0b85SAlex Williamson * iommu driver as verified by calling CHECK_EXTENSION using the same 89883f0b85SAlex Williamson * type. A group must be set to this file descriptor before this 90883f0b85SAlex Williamson * ioctl is available. The IOMMU interfaces enabled by this call are 91883f0b85SAlex Williamson * specific to the value set. 92883f0b85SAlex Williamson * Return: 0 on success, -errno on failure 93883f0b85SAlex Williamson * Availability: When VFIO group attached 94883f0b85SAlex Williamson */ 95883f0b85SAlex Williamson #define VFIO_SET_IOMMU _IO(VFIO_TYPE, VFIO_BASE + 2) 96883f0b85SAlex Williamson 97883f0b85SAlex Williamson /* -------- IOCTLs for GROUP file descriptors (/dev/vfio/$GROUP) -------- */ 98883f0b85SAlex Williamson 99883f0b85SAlex Williamson /** 100883f0b85SAlex Williamson * VFIO_GROUP_GET_STATUS - _IOR(VFIO_TYPE, VFIO_BASE + 3, 101883f0b85SAlex Williamson * struct vfio_group_status) 102883f0b85SAlex Williamson * 103883f0b85SAlex Williamson * Retrieve information about the group. Fills in provided 104883f0b85SAlex Williamson * struct vfio_group_info. Caller sets argsz. 105883f0b85SAlex Williamson * Return: 0 on succes, -errno on failure. 106883f0b85SAlex Williamson * Availability: Always 107883f0b85SAlex Williamson */ 108883f0b85SAlex Williamson struct vfio_group_status { 109883f0b85SAlex Williamson __u32 argsz; 110883f0b85SAlex Williamson __u32 flags; 111883f0b85SAlex Williamson #define VFIO_GROUP_FLAGS_VIABLE (1 << 0) 112883f0b85SAlex Williamson #define VFIO_GROUP_FLAGS_CONTAINER_SET (1 << 1) 113883f0b85SAlex Williamson }; 114883f0b85SAlex Williamson #define VFIO_GROUP_GET_STATUS _IO(VFIO_TYPE, VFIO_BASE + 3) 115883f0b85SAlex Williamson 116883f0b85SAlex Williamson /** 117883f0b85SAlex Williamson * VFIO_GROUP_SET_CONTAINER - _IOW(VFIO_TYPE, VFIO_BASE + 4, __s32) 118883f0b85SAlex Williamson * 119883f0b85SAlex Williamson * Set the container for the VFIO group to the open VFIO file 120883f0b85SAlex Williamson * descriptor provided. Groups may only belong to a single 121883f0b85SAlex Williamson * container. Containers may, at their discretion, support multiple 122883f0b85SAlex Williamson * groups. Only when a container is set are all of the interfaces 123883f0b85SAlex Williamson * of the VFIO file descriptor and the VFIO group file descriptor 124883f0b85SAlex Williamson * available to the user. 125883f0b85SAlex Williamson * Return: 0 on success, -errno on failure. 126883f0b85SAlex Williamson * Availability: Always 127883f0b85SAlex Williamson */ 128883f0b85SAlex Williamson #define VFIO_GROUP_SET_CONTAINER _IO(VFIO_TYPE, VFIO_BASE + 4) 129883f0b85SAlex Williamson 130883f0b85SAlex Williamson /** 131883f0b85SAlex Williamson * VFIO_GROUP_UNSET_CONTAINER - _IO(VFIO_TYPE, VFIO_BASE + 5) 132883f0b85SAlex Williamson * 133883f0b85SAlex Williamson * Remove the group from the attached container. This is the 134883f0b85SAlex Williamson * opposite of the SET_CONTAINER call and returns the group to 135883f0b85SAlex Williamson * an initial state. All device file descriptors must be released 136883f0b85SAlex Williamson * prior to calling this interface. When removing the last group 137883f0b85SAlex Williamson * from a container, the IOMMU will be disabled and all state lost, 138883f0b85SAlex Williamson * effectively also returning the VFIO file descriptor to an initial 139883f0b85SAlex Williamson * state. 140883f0b85SAlex Williamson * Return: 0 on success, -errno on failure. 141883f0b85SAlex Williamson * Availability: When attached to container 142883f0b85SAlex Williamson */ 143883f0b85SAlex Williamson #define VFIO_GROUP_UNSET_CONTAINER _IO(VFIO_TYPE, VFIO_BASE + 5) 144883f0b85SAlex Williamson 145883f0b85SAlex Williamson /** 146883f0b85SAlex Williamson * VFIO_GROUP_GET_DEVICE_FD - _IOW(VFIO_TYPE, VFIO_BASE + 6, char) 147883f0b85SAlex Williamson * 148883f0b85SAlex Williamson * Return a new file descriptor for the device object described by 149883f0b85SAlex Williamson * the provided string. The string should match a device listed in 150883f0b85SAlex Williamson * the devices subdirectory of the IOMMU group sysfs entry. The 151883f0b85SAlex Williamson * group containing the device must already be added to this context. 152883f0b85SAlex Williamson * Return: new file descriptor on success, -errno on failure. 153883f0b85SAlex Williamson * Availability: When attached to container 154883f0b85SAlex Williamson */ 155883f0b85SAlex Williamson #define VFIO_GROUP_GET_DEVICE_FD _IO(VFIO_TYPE, VFIO_BASE + 6) 156883f0b85SAlex Williamson 157883f0b85SAlex Williamson /* --------------- IOCTLs for DEVICE file descriptors --------------- */ 158883f0b85SAlex Williamson 159883f0b85SAlex Williamson /** 160883f0b85SAlex Williamson * VFIO_DEVICE_GET_INFO - _IOR(VFIO_TYPE, VFIO_BASE + 7, 161883f0b85SAlex Williamson * struct vfio_device_info) 162883f0b85SAlex Williamson * 163883f0b85SAlex Williamson * Retrieve information about the device. Fills in provided 164883f0b85SAlex Williamson * struct vfio_device_info. Caller sets argsz. 165883f0b85SAlex Williamson * Return: 0 on success, -errno on failure. 166883f0b85SAlex Williamson */ 167883f0b85SAlex Williamson struct vfio_device_info { 168883f0b85SAlex Williamson __u32 argsz; 169883f0b85SAlex Williamson __u32 flags; 170883f0b85SAlex Williamson #define VFIO_DEVICE_FLAGS_RESET (1 << 0) /* Device supports reset */ 171883f0b85SAlex Williamson #define VFIO_DEVICE_FLAGS_PCI (1 << 1) /* vfio-pci device */ 1727a52ce8aSCornelia Huck #define VFIO_DEVICE_FLAGS_PLATFORM (1 << 2) /* vfio-platform device */ 1737a52ce8aSCornelia Huck #define VFIO_DEVICE_FLAGS_AMBA (1 << 3) /* vfio-amba device */ 174883f0b85SAlex Williamson __u32 num_regions; /* Max region index + 1 */ 175883f0b85SAlex Williamson __u32 num_irqs; /* Max IRQ index + 1 */ 176883f0b85SAlex Williamson }; 177883f0b85SAlex Williamson #define VFIO_DEVICE_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 7) 178883f0b85SAlex Williamson 179883f0b85SAlex Williamson /** 180883f0b85SAlex Williamson * VFIO_DEVICE_GET_REGION_INFO - _IOWR(VFIO_TYPE, VFIO_BASE + 8, 181883f0b85SAlex Williamson * struct vfio_region_info) 182883f0b85SAlex Williamson * 183883f0b85SAlex Williamson * Retrieve information about a device region. Caller provides 184883f0b85SAlex Williamson * struct vfio_region_info with index value set. Caller sets argsz. 185883f0b85SAlex Williamson * Implementation of region mapping is bus driver specific. This is 186883f0b85SAlex Williamson * intended to describe MMIO, I/O port, as well as bus specific 187883f0b85SAlex Williamson * regions (ex. PCI config space). Zero sized regions may be used 188883f0b85SAlex Williamson * to describe unimplemented regions (ex. unimplemented PCI BARs). 189883f0b85SAlex Williamson * Return: 0 on success, -errno on failure. 190883f0b85SAlex Williamson */ 191883f0b85SAlex Williamson struct vfio_region_info { 192883f0b85SAlex Williamson __u32 argsz; 193883f0b85SAlex Williamson __u32 flags; 194883f0b85SAlex Williamson #define VFIO_REGION_INFO_FLAG_READ (1 << 0) /* Region supports read */ 195883f0b85SAlex Williamson #define VFIO_REGION_INFO_FLAG_WRITE (1 << 1) /* Region supports write */ 196883f0b85SAlex Williamson #define VFIO_REGION_INFO_FLAG_MMAP (1 << 2) /* Region supports mmap */ 197883f0b85SAlex Williamson __u32 index; /* Region index */ 198883f0b85SAlex Williamson __u32 resv; /* Reserved for alignment */ 199883f0b85SAlex Williamson __u64 size; /* Region size (bytes) */ 200883f0b85SAlex Williamson __u64 offset; /* Region offset from start of device fd */ 201883f0b85SAlex Williamson }; 202883f0b85SAlex Williamson #define VFIO_DEVICE_GET_REGION_INFO _IO(VFIO_TYPE, VFIO_BASE + 8) 203883f0b85SAlex Williamson 204883f0b85SAlex Williamson /** 205883f0b85SAlex Williamson * VFIO_DEVICE_GET_IRQ_INFO - _IOWR(VFIO_TYPE, VFIO_BASE + 9, 206883f0b85SAlex Williamson * struct vfio_irq_info) 207883f0b85SAlex Williamson * 208883f0b85SAlex Williamson * Retrieve information about a device IRQ. Caller provides 209883f0b85SAlex Williamson * struct vfio_irq_info with index value set. Caller sets argsz. 210883f0b85SAlex Williamson * Implementation of IRQ mapping is bus driver specific. Indexes 211883f0b85SAlex Williamson * using multiple IRQs are primarily intended to support MSI-like 212883f0b85SAlex Williamson * interrupt blocks. Zero count irq blocks may be used to describe 213883f0b85SAlex Williamson * unimplemented interrupt types. 214883f0b85SAlex Williamson * 215883f0b85SAlex Williamson * The EVENTFD flag indicates the interrupt index supports eventfd based 216883f0b85SAlex Williamson * signaling. 217883f0b85SAlex Williamson * 218883f0b85SAlex Williamson * The MASKABLE flags indicates the index supports MASK and UNMASK 219883f0b85SAlex Williamson * actions described below. 220883f0b85SAlex Williamson * 221883f0b85SAlex Williamson * AUTOMASKED indicates that after signaling, the interrupt line is 222883f0b85SAlex Williamson * automatically masked by VFIO and the user needs to unmask the line 223883f0b85SAlex Williamson * to receive new interrupts. This is primarily intended to distinguish 224883f0b85SAlex Williamson * level triggered interrupts. 225883f0b85SAlex Williamson * 226883f0b85SAlex Williamson * The NORESIZE flag indicates that the interrupt lines within the index 227883f0b85SAlex Williamson * are setup as a set and new subindexes cannot be enabled without first 228883f0b85SAlex Williamson * disabling the entire index. This is used for interrupts like PCI MSI 229883f0b85SAlex Williamson * and MSI-X where the driver may only use a subset of the available 230883f0b85SAlex Williamson * indexes, but VFIO needs to enable a specific number of vectors 231883f0b85SAlex Williamson * upfront. In the case of MSI-X, where the user can enable MSI-X and 232883f0b85SAlex Williamson * then add and unmask vectors, it's up to userspace to make the decision 233883f0b85SAlex Williamson * whether to allocate the maximum supported number of vectors or tear 234883f0b85SAlex Williamson * down setup and incrementally increase the vectors as each is enabled. 235883f0b85SAlex Williamson */ 236883f0b85SAlex Williamson struct vfio_irq_info { 237883f0b85SAlex Williamson __u32 argsz; 238883f0b85SAlex Williamson __u32 flags; 239883f0b85SAlex Williamson #define VFIO_IRQ_INFO_EVENTFD (1 << 0) 240883f0b85SAlex Williamson #define VFIO_IRQ_INFO_MASKABLE (1 << 1) 241883f0b85SAlex Williamson #define VFIO_IRQ_INFO_AUTOMASKED (1 << 2) 242883f0b85SAlex Williamson #define VFIO_IRQ_INFO_NORESIZE (1 << 3) 243883f0b85SAlex Williamson __u32 index; /* IRQ index */ 244883f0b85SAlex Williamson __u32 count; /* Number of IRQs within this index */ 245883f0b85SAlex Williamson }; 246883f0b85SAlex Williamson #define VFIO_DEVICE_GET_IRQ_INFO _IO(VFIO_TYPE, VFIO_BASE + 9) 247883f0b85SAlex Williamson 248883f0b85SAlex Williamson /** 249883f0b85SAlex Williamson * VFIO_DEVICE_SET_IRQS - _IOW(VFIO_TYPE, VFIO_BASE + 10, struct vfio_irq_set) 250883f0b85SAlex Williamson * 251883f0b85SAlex Williamson * Set signaling, masking, and unmasking of interrupts. Caller provides 252883f0b85SAlex Williamson * struct vfio_irq_set with all fields set. 'start' and 'count' indicate 253883f0b85SAlex Williamson * the range of subindexes being specified. 254883f0b85SAlex Williamson * 255883f0b85SAlex Williamson * The DATA flags specify the type of data provided. If DATA_NONE, the 256883f0b85SAlex Williamson * operation performs the specified action immediately on the specified 257883f0b85SAlex Williamson * interrupt(s). For example, to unmask AUTOMASKED interrupt [0,0]: 258883f0b85SAlex Williamson * flags = (DATA_NONE|ACTION_UNMASK), index = 0, start = 0, count = 1. 259883f0b85SAlex Williamson * 260883f0b85SAlex Williamson * DATA_BOOL allows sparse support for the same on arrays of interrupts. 261883f0b85SAlex Williamson * For example, to mask interrupts [0,1] and [0,3] (but not [0,2]): 262883f0b85SAlex Williamson * flags = (DATA_BOOL|ACTION_MASK), index = 0, start = 1, count = 3, 263883f0b85SAlex Williamson * data = {1,0,1} 264883f0b85SAlex Williamson * 265883f0b85SAlex Williamson * DATA_EVENTFD binds the specified ACTION to the provided __s32 eventfd. 266883f0b85SAlex Williamson * A value of -1 can be used to either de-assign interrupts if already 267883f0b85SAlex Williamson * assigned or skip un-assigned interrupts. For example, to set an eventfd 268883f0b85SAlex Williamson * to be trigger for interrupts [0,0] and [0,2]: 269883f0b85SAlex Williamson * flags = (DATA_EVENTFD|ACTION_TRIGGER), index = 0, start = 0, count = 3, 270883f0b85SAlex Williamson * data = {fd1, -1, fd2} 271883f0b85SAlex Williamson * If index [0,1] is previously set, two count = 1 ioctls calls would be 272883f0b85SAlex Williamson * required to set [0,0] and [0,2] without changing [0,1]. 273883f0b85SAlex Williamson * 274883f0b85SAlex Williamson * Once a signaling mechanism is set, DATA_BOOL or DATA_NONE can be used 275883f0b85SAlex Williamson * with ACTION_TRIGGER to perform kernel level interrupt loopback testing 276883f0b85SAlex Williamson * from userspace (ie. simulate hardware triggering). 277883f0b85SAlex Williamson * 278883f0b85SAlex Williamson * Setting of an event triggering mechanism to userspace for ACTION_TRIGGER 279883f0b85SAlex Williamson * enables the interrupt index for the device. Individual subindex interrupts 280883f0b85SAlex Williamson * can be disabled using the -1 value for DATA_EVENTFD or the index can be 281883f0b85SAlex Williamson * disabled as a whole with: flags = (DATA_NONE|ACTION_TRIGGER), count = 0. 282883f0b85SAlex Williamson * 283883f0b85SAlex Williamson * Note that ACTION_[UN]MASK specify user->kernel signaling (irqfds) while 284883f0b85SAlex Williamson * ACTION_TRIGGER specifies kernel->user signaling. 285883f0b85SAlex Williamson */ 286883f0b85SAlex Williamson struct vfio_irq_set { 287883f0b85SAlex Williamson __u32 argsz; 288883f0b85SAlex Williamson __u32 flags; 289883f0b85SAlex Williamson #define VFIO_IRQ_SET_DATA_NONE (1 << 0) /* Data not present */ 290883f0b85SAlex Williamson #define VFIO_IRQ_SET_DATA_BOOL (1 << 1) /* Data is bool (u8) */ 291883f0b85SAlex Williamson #define VFIO_IRQ_SET_DATA_EVENTFD (1 << 2) /* Data is eventfd (s32) */ 292883f0b85SAlex Williamson #define VFIO_IRQ_SET_ACTION_MASK (1 << 3) /* Mask interrupt */ 293883f0b85SAlex Williamson #define VFIO_IRQ_SET_ACTION_UNMASK (1 << 4) /* Unmask interrupt */ 294883f0b85SAlex Williamson #define VFIO_IRQ_SET_ACTION_TRIGGER (1 << 5) /* Trigger interrupt */ 295883f0b85SAlex Williamson __u32 index; 296883f0b85SAlex Williamson __u32 start; 297883f0b85SAlex Williamson __u32 count; 298883f0b85SAlex Williamson __u8 data[]; 299883f0b85SAlex Williamson }; 300883f0b85SAlex Williamson #define VFIO_DEVICE_SET_IRQS _IO(VFIO_TYPE, VFIO_BASE + 10) 301883f0b85SAlex Williamson 302883f0b85SAlex Williamson #define VFIO_IRQ_SET_DATA_TYPE_MASK (VFIO_IRQ_SET_DATA_NONE | \ 303883f0b85SAlex Williamson VFIO_IRQ_SET_DATA_BOOL | \ 304883f0b85SAlex Williamson VFIO_IRQ_SET_DATA_EVENTFD) 305883f0b85SAlex Williamson #define VFIO_IRQ_SET_ACTION_TYPE_MASK (VFIO_IRQ_SET_ACTION_MASK | \ 306883f0b85SAlex Williamson VFIO_IRQ_SET_ACTION_UNMASK | \ 307883f0b85SAlex Williamson VFIO_IRQ_SET_ACTION_TRIGGER) 308883f0b85SAlex Williamson /** 309883f0b85SAlex Williamson * VFIO_DEVICE_RESET - _IO(VFIO_TYPE, VFIO_BASE + 11) 310883f0b85SAlex Williamson * 311883f0b85SAlex Williamson * Reset a device. 312883f0b85SAlex Williamson */ 313883f0b85SAlex Williamson #define VFIO_DEVICE_RESET _IO(VFIO_TYPE, VFIO_BASE + 11) 314883f0b85SAlex Williamson 315883f0b85SAlex Williamson /* 316883f0b85SAlex Williamson * The VFIO-PCI bus driver makes use of the following fixed region and 317883f0b85SAlex Williamson * IRQ index mapping. Unimplemented regions return a size of zero. 318883f0b85SAlex Williamson * Unimplemented IRQ types return a count of zero. 319883f0b85SAlex Williamson */ 320883f0b85SAlex Williamson 321883f0b85SAlex Williamson enum { 322883f0b85SAlex Williamson VFIO_PCI_BAR0_REGION_INDEX, 323883f0b85SAlex Williamson VFIO_PCI_BAR1_REGION_INDEX, 324883f0b85SAlex Williamson VFIO_PCI_BAR2_REGION_INDEX, 325883f0b85SAlex Williamson VFIO_PCI_BAR3_REGION_INDEX, 326883f0b85SAlex Williamson VFIO_PCI_BAR4_REGION_INDEX, 327883f0b85SAlex Williamson VFIO_PCI_BAR5_REGION_INDEX, 328883f0b85SAlex Williamson VFIO_PCI_ROM_REGION_INDEX, 329883f0b85SAlex Williamson VFIO_PCI_CONFIG_REGION_INDEX, 330010ca0b3SAlex Williamson /* 331010ca0b3SAlex Williamson * Expose VGA regions defined for PCI base class 03, subclass 00. 332010ca0b3SAlex Williamson * This includes I/O port ranges 0x3b0 to 0x3bb and 0x3c0 to 0x3df 333010ca0b3SAlex Williamson * as well as the MMIO range 0xa0000 to 0xbffff. Each implemented 334010ca0b3SAlex Williamson * range is found at it's identity mapped offset from the region 335010ca0b3SAlex Williamson * offset, for example 0x3b0 is region_info.offset + 0x3b0. Areas 336010ca0b3SAlex Williamson * between described ranges are unimplemented. 337010ca0b3SAlex Williamson */ 338010ca0b3SAlex Williamson VFIO_PCI_VGA_REGION_INDEX, 339883f0b85SAlex Williamson VFIO_PCI_NUM_REGIONS 340883f0b85SAlex Williamson }; 341883f0b85SAlex Williamson 342883f0b85SAlex Williamson enum { 343883f0b85SAlex Williamson VFIO_PCI_INTX_IRQ_INDEX, 344883f0b85SAlex Williamson VFIO_PCI_MSI_IRQ_INDEX, 345883f0b85SAlex Williamson VFIO_PCI_MSIX_IRQ_INDEX, 346e098b453SAlexey Kardashevskiy VFIO_PCI_ERR_IRQ_INDEX, 34747cbe50cSAlex Williamson VFIO_PCI_REQ_IRQ_INDEX, 348883f0b85SAlex Williamson VFIO_PCI_NUM_IRQS 349883f0b85SAlex Williamson }; 350883f0b85SAlex Williamson 3514f265607SAndrew Jones /** 3524f265607SAndrew Jones * VFIO_DEVICE_GET_PCI_HOT_RESET_INFO - _IORW(VFIO_TYPE, VFIO_BASE + 12, 3534f265607SAndrew Jones * struct vfio_pci_hot_reset_info) 3544f265607SAndrew Jones * 3554f265607SAndrew Jones * Return: 0 on success, -errno on failure: 3564f265607SAndrew Jones * -enospc = insufficient buffer, -enodev = unsupported for device. 3574f265607SAndrew Jones */ 3584f265607SAndrew Jones struct vfio_pci_dependent_device { 3594f265607SAndrew Jones __u32 group_id; 3604f265607SAndrew Jones __u16 segment; 3614f265607SAndrew Jones __u8 bus; 3624f265607SAndrew Jones __u8 devfn; /* Use PCI_SLOT/PCI_FUNC */ 3634f265607SAndrew Jones }; 3644f265607SAndrew Jones 3654f265607SAndrew Jones struct vfio_pci_hot_reset_info { 3664f265607SAndrew Jones __u32 argsz; 3674f265607SAndrew Jones __u32 flags; 3684f265607SAndrew Jones __u32 count; 3694f265607SAndrew Jones struct vfio_pci_dependent_device devices[]; 3704f265607SAndrew Jones }; 3714f265607SAndrew Jones 3724f265607SAndrew Jones #define VFIO_DEVICE_GET_PCI_HOT_RESET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12) 3734f265607SAndrew Jones 3744f265607SAndrew Jones /** 3754f265607SAndrew Jones * VFIO_DEVICE_PCI_HOT_RESET - _IOW(VFIO_TYPE, VFIO_BASE + 13, 3764f265607SAndrew Jones * struct vfio_pci_hot_reset) 3774f265607SAndrew Jones * 3784f265607SAndrew Jones * Return: 0 on success, -errno on failure. 3794f265607SAndrew Jones */ 3804f265607SAndrew Jones struct vfio_pci_hot_reset { 3814f265607SAndrew Jones __u32 argsz; 3824f265607SAndrew Jones __u32 flags; 3834f265607SAndrew Jones __u32 count; 3844f265607SAndrew Jones __s32 group_fds[]; 3854f265607SAndrew Jones }; 3864f265607SAndrew Jones 3874f265607SAndrew Jones #define VFIO_DEVICE_PCI_HOT_RESET _IO(VFIO_TYPE, VFIO_BASE + 13) 3884f265607SAndrew Jones 389883f0b85SAlex Williamson /* -------- API for Type1 VFIO IOMMU -------- */ 390883f0b85SAlex Williamson 391883f0b85SAlex Williamson /** 392883f0b85SAlex Williamson * VFIO_IOMMU_GET_INFO - _IOR(VFIO_TYPE, VFIO_BASE + 12, struct vfio_iommu_info) 393883f0b85SAlex Williamson * 394883f0b85SAlex Williamson * Retrieve information about the IOMMU object. Fills in provided 395883f0b85SAlex Williamson * struct vfio_iommu_info. Caller sets argsz. 396883f0b85SAlex Williamson * 397883f0b85SAlex Williamson * XXX Should we do these by CHECK_EXTENSION too? 398883f0b85SAlex Williamson */ 399883f0b85SAlex Williamson struct vfio_iommu_type1_info { 400883f0b85SAlex Williamson __u32 argsz; 401883f0b85SAlex Williamson __u32 flags; 402883f0b85SAlex Williamson #define VFIO_IOMMU_INFO_PGSIZES (1 << 0) /* supported page sizes info */ 403883f0b85SAlex Williamson __u64 iova_pgsizes; /* Bitmap of supported page sizes */ 404883f0b85SAlex Williamson }; 405883f0b85SAlex Williamson 406883f0b85SAlex Williamson #define VFIO_IOMMU_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12) 407883f0b85SAlex Williamson 408883f0b85SAlex Williamson /** 409883f0b85SAlex Williamson * VFIO_IOMMU_MAP_DMA - _IOW(VFIO_TYPE, VFIO_BASE + 13, struct vfio_dma_map) 410883f0b85SAlex Williamson * 411883f0b85SAlex Williamson * Map process virtual addresses to IO virtual addresses using the 412883f0b85SAlex Williamson * provided struct vfio_dma_map. Caller sets argsz. READ &/ WRITE required. 413883f0b85SAlex Williamson */ 414883f0b85SAlex Williamson struct vfio_iommu_type1_dma_map { 415883f0b85SAlex Williamson __u32 argsz; 416883f0b85SAlex Williamson __u32 flags; 417883f0b85SAlex Williamson #define VFIO_DMA_MAP_FLAG_READ (1 << 0) /* readable from device */ 418883f0b85SAlex Williamson #define VFIO_DMA_MAP_FLAG_WRITE (1 << 1) /* writable from device */ 419883f0b85SAlex Williamson __u64 vaddr; /* Process virtual address */ 420883f0b85SAlex Williamson __u64 iova; /* IO virtual address */ 421883f0b85SAlex Williamson __u64 size; /* Size of mapping (bytes) */ 422883f0b85SAlex Williamson }; 423883f0b85SAlex Williamson 424883f0b85SAlex Williamson #define VFIO_IOMMU_MAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 13) 425883f0b85SAlex Williamson 426883f0b85SAlex Williamson /** 427c5daeae1SAlexey Kardashevskiy * VFIO_IOMMU_UNMAP_DMA - _IOWR(VFIO_TYPE, VFIO_BASE + 14, 428c5daeae1SAlexey Kardashevskiy * struct vfio_dma_unmap) 429883f0b85SAlex Williamson * 430883f0b85SAlex Williamson * Unmap IO virtual addresses using the provided struct vfio_dma_unmap. 431c5daeae1SAlexey Kardashevskiy * Caller sets argsz. The actual unmapped size is returned in the size 432c5daeae1SAlexey Kardashevskiy * field. No guarantee is made to the user that arbitrary unmaps of iova 433c5daeae1SAlexey Kardashevskiy * or size different from those used in the original mapping call will 434c5daeae1SAlexey Kardashevskiy * succeed. 435883f0b85SAlex Williamson */ 436883f0b85SAlex Williamson struct vfio_iommu_type1_dma_unmap { 437883f0b85SAlex Williamson __u32 argsz; 438883f0b85SAlex Williamson __u32 flags; 439883f0b85SAlex Williamson __u64 iova; /* IO virtual address */ 440883f0b85SAlex Williamson __u64 size; /* Size of mapping (bytes) */ 441883f0b85SAlex Williamson }; 442883f0b85SAlex Williamson 443883f0b85SAlex Williamson #define VFIO_IOMMU_UNMAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 14) 444883f0b85SAlex Williamson 445c5daeae1SAlexey Kardashevskiy /* 446c5daeae1SAlexey Kardashevskiy * IOCTLs to enable/disable IOMMU container usage. 447c5daeae1SAlexey Kardashevskiy * No parameters are supported. 448c5daeae1SAlexey Kardashevskiy */ 449c5daeae1SAlexey Kardashevskiy #define VFIO_IOMMU_ENABLE _IO(VFIO_TYPE, VFIO_BASE + 15) 450c5daeae1SAlexey Kardashevskiy #define VFIO_IOMMU_DISABLE _IO(VFIO_TYPE, VFIO_BASE + 16) 451c5daeae1SAlexey Kardashevskiy 452c5daeae1SAlexey Kardashevskiy /* -------- Additional API for SPAPR TCE (Server POWERPC) IOMMU -------- */ 453c5daeae1SAlexey Kardashevskiy 454c5daeae1SAlexey Kardashevskiy /* 45525b8b39bSAlexey Kardashevskiy * The SPAPR TCE DDW info struct provides the information about 45625b8b39bSAlexey Kardashevskiy * the details of Dynamic DMA window capability. 45725b8b39bSAlexey Kardashevskiy * 45825b8b39bSAlexey Kardashevskiy * @pgsizes contains a page size bitmask, 4K/64K/16M are supported. 45925b8b39bSAlexey Kardashevskiy * @max_dynamic_windows_supported tells the maximum number of windows 46025b8b39bSAlexey Kardashevskiy * which the platform can create. 46125b8b39bSAlexey Kardashevskiy * @levels tells the maximum number of levels in multi-level IOMMU tables; 46225b8b39bSAlexey Kardashevskiy * this allows splitting a table into smaller chunks which reduces 46325b8b39bSAlexey Kardashevskiy * the amount of physically contiguous memory required for the table. 46425b8b39bSAlexey Kardashevskiy */ 46525b8b39bSAlexey Kardashevskiy struct vfio_iommu_spapr_tce_ddw_info { 46625b8b39bSAlexey Kardashevskiy __u64 pgsizes; /* Bitmap of supported page sizes */ 46725b8b39bSAlexey Kardashevskiy __u32 max_dynamic_windows_supported; 46825b8b39bSAlexey Kardashevskiy __u32 levels; 46925b8b39bSAlexey Kardashevskiy }; 47025b8b39bSAlexey Kardashevskiy 47125b8b39bSAlexey Kardashevskiy /* 472c5daeae1SAlexey Kardashevskiy * The SPAPR TCE info struct provides the information about the PCI bus 473c5daeae1SAlexey Kardashevskiy * address ranges available for DMA, these values are programmed into 474c5daeae1SAlexey Kardashevskiy * the hardware so the guest has to know that information. 475c5daeae1SAlexey Kardashevskiy * 476c5daeae1SAlexey Kardashevskiy * The DMA 32 bit window start is an absolute PCI bus address. 477c5daeae1SAlexey Kardashevskiy * The IOVA address passed via map/unmap ioctls are absolute PCI bus 478c5daeae1SAlexey Kardashevskiy * addresses too so the window works as a filter rather than an offset 479c5daeae1SAlexey Kardashevskiy * for IOVA addresses. 480c5daeae1SAlexey Kardashevskiy * 48125b8b39bSAlexey Kardashevskiy * Flags supported: 48225b8b39bSAlexey Kardashevskiy * - VFIO_IOMMU_SPAPR_INFO_DDW: informs the userspace that dynamic DMA windows 48325b8b39bSAlexey Kardashevskiy * (DDW) support is present. @ddw is only supported when DDW is present. 484c5daeae1SAlexey Kardashevskiy */ 485c5daeae1SAlexey Kardashevskiy struct vfio_iommu_spapr_tce_info { 486c5daeae1SAlexey Kardashevskiy __u32 argsz; 48725b8b39bSAlexey Kardashevskiy __u32 flags; 48825b8b39bSAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_INFO_DDW (1 << 0) /* DDW supported */ 489c5daeae1SAlexey Kardashevskiy __u32 dma32_window_start; /* 32 bit window start (bytes) */ 490c5daeae1SAlexey Kardashevskiy __u32 dma32_window_size; /* 32 bit window size (bytes) */ 49125b8b39bSAlexey Kardashevskiy struct vfio_iommu_spapr_tce_ddw_info ddw; 492c5daeae1SAlexey Kardashevskiy }; 493c5daeae1SAlexey Kardashevskiy 494c5daeae1SAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_TCE_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12) 495c5daeae1SAlexey Kardashevskiy 496a9fd1654SJens Freimann /* 497a9fd1654SJens Freimann * EEH PE operation struct provides ways to: 498a9fd1654SJens Freimann * - enable/disable EEH functionality; 499a9fd1654SJens Freimann * - unfreeze IO/DMA for frozen PE; 500a9fd1654SJens Freimann * - read PE state; 501a9fd1654SJens Freimann * - reset PE; 50225b8b39bSAlexey Kardashevskiy * - configure PE; 50325b8b39bSAlexey Kardashevskiy * - inject EEH error. 504a9fd1654SJens Freimann */ 50525b8b39bSAlexey Kardashevskiy struct vfio_eeh_pe_err { 50625b8b39bSAlexey Kardashevskiy __u32 type; 50725b8b39bSAlexey Kardashevskiy __u32 func; 50825b8b39bSAlexey Kardashevskiy __u64 addr; 50925b8b39bSAlexey Kardashevskiy __u64 mask; 51025b8b39bSAlexey Kardashevskiy }; 51125b8b39bSAlexey Kardashevskiy 512a9fd1654SJens Freimann struct vfio_eeh_pe_op { 513a9fd1654SJens Freimann __u32 argsz; 514a9fd1654SJens Freimann __u32 flags; 515a9fd1654SJens Freimann __u32 op; 51625b8b39bSAlexey Kardashevskiy union { 51725b8b39bSAlexey Kardashevskiy struct vfio_eeh_pe_err err; 51825b8b39bSAlexey Kardashevskiy }; 519a9fd1654SJens Freimann }; 520a9fd1654SJens Freimann 521a9fd1654SJens Freimann #define VFIO_EEH_PE_DISABLE 0 /* Disable EEH functionality */ 522a9fd1654SJens Freimann #define VFIO_EEH_PE_ENABLE 1 /* Enable EEH functionality */ 523a9fd1654SJens Freimann #define VFIO_EEH_PE_UNFREEZE_IO 2 /* Enable IO for frozen PE */ 524a9fd1654SJens Freimann #define VFIO_EEH_PE_UNFREEZE_DMA 3 /* Enable DMA for frozen PE */ 525a9fd1654SJens Freimann #define VFIO_EEH_PE_GET_STATE 4 /* PE state retrieval */ 526a9fd1654SJens Freimann #define VFIO_EEH_PE_STATE_NORMAL 0 /* PE in functional state */ 527a9fd1654SJens Freimann #define VFIO_EEH_PE_STATE_RESET 1 /* PE reset in progress */ 528a9fd1654SJens Freimann #define VFIO_EEH_PE_STATE_STOPPED 2 /* Stopped DMA and IO */ 529a9fd1654SJens Freimann #define VFIO_EEH_PE_STATE_STOPPED_DMA 4 /* Stopped DMA only */ 530a9fd1654SJens Freimann #define VFIO_EEH_PE_STATE_UNAVAIL 5 /* State unavailable */ 531a9fd1654SJens Freimann #define VFIO_EEH_PE_RESET_DEACTIVATE 5 /* Deassert PE reset */ 532a9fd1654SJens Freimann #define VFIO_EEH_PE_RESET_HOT 6 /* Assert hot reset */ 533a9fd1654SJens Freimann #define VFIO_EEH_PE_RESET_FUNDAMENTAL 7 /* Assert fundamental reset */ 534a9fd1654SJens Freimann #define VFIO_EEH_PE_CONFIGURE 8 /* PE configuration */ 53525b8b39bSAlexey Kardashevskiy #define VFIO_EEH_PE_INJECT_ERR 9 /* Inject EEH error */ 536a9fd1654SJens Freimann 537a9fd1654SJens Freimann #define VFIO_EEH_PE_OP _IO(VFIO_TYPE, VFIO_BASE + 21) 538a9fd1654SJens Freimann 53925b8b39bSAlexey Kardashevskiy /** 54025b8b39bSAlexey Kardashevskiy * VFIO_IOMMU_SPAPR_REGISTER_MEMORY - _IOW(VFIO_TYPE, VFIO_BASE + 17, struct vfio_iommu_spapr_register_memory) 54125b8b39bSAlexey Kardashevskiy * 54225b8b39bSAlexey Kardashevskiy * Registers user space memory where DMA is allowed. It pins 54325b8b39bSAlexey Kardashevskiy * user pages and does the locked memory accounting so 54425b8b39bSAlexey Kardashevskiy * subsequent VFIO_IOMMU_MAP_DMA/VFIO_IOMMU_UNMAP_DMA calls 54525b8b39bSAlexey Kardashevskiy * get faster. 54625b8b39bSAlexey Kardashevskiy */ 54725b8b39bSAlexey Kardashevskiy struct vfio_iommu_spapr_register_memory { 54825b8b39bSAlexey Kardashevskiy __u32 argsz; 54925b8b39bSAlexey Kardashevskiy __u32 flags; 55025b8b39bSAlexey Kardashevskiy __u64 vaddr; /* Process virtual address */ 55125b8b39bSAlexey Kardashevskiy __u64 size; /* Size of mapping (bytes) */ 55225b8b39bSAlexey Kardashevskiy }; 55325b8b39bSAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_REGISTER_MEMORY _IO(VFIO_TYPE, VFIO_BASE + 17) 55425b8b39bSAlexey Kardashevskiy 55525b8b39bSAlexey Kardashevskiy /** 55625b8b39bSAlexey Kardashevskiy * VFIO_IOMMU_SPAPR_UNREGISTER_MEMORY - _IOW(VFIO_TYPE, VFIO_BASE + 18, struct vfio_iommu_spapr_register_memory) 55725b8b39bSAlexey Kardashevskiy * 55825b8b39bSAlexey Kardashevskiy * Unregisters user space memory registered with 55925b8b39bSAlexey Kardashevskiy * VFIO_IOMMU_SPAPR_REGISTER_MEMORY. 56025b8b39bSAlexey Kardashevskiy * Uses vfio_iommu_spapr_register_memory for parameters. 56125b8b39bSAlexey Kardashevskiy */ 56225b8b39bSAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_UNREGISTER_MEMORY _IO(VFIO_TYPE, VFIO_BASE + 18) 56325b8b39bSAlexey Kardashevskiy 56425b8b39bSAlexey Kardashevskiy /** 56525b8b39bSAlexey Kardashevskiy * VFIO_IOMMU_SPAPR_TCE_CREATE - _IOWR(VFIO_TYPE, VFIO_BASE + 19, struct vfio_iommu_spapr_tce_create) 56625b8b39bSAlexey Kardashevskiy * 56725b8b39bSAlexey Kardashevskiy * Creates an additional TCE table and programs it (sets a new DMA window) 56825b8b39bSAlexey Kardashevskiy * to every IOMMU group in the container. It receives page shift, window 56925b8b39bSAlexey Kardashevskiy * size and number of levels in the TCE table being created. 57025b8b39bSAlexey Kardashevskiy * 57125b8b39bSAlexey Kardashevskiy * It allocates and returns an offset on a PCI bus of the new DMA window. 57225b8b39bSAlexey Kardashevskiy */ 57325b8b39bSAlexey Kardashevskiy struct vfio_iommu_spapr_tce_create { 57425b8b39bSAlexey Kardashevskiy __u32 argsz; 57525b8b39bSAlexey Kardashevskiy __u32 flags; 57625b8b39bSAlexey Kardashevskiy /* in */ 57725b8b39bSAlexey Kardashevskiy __u32 page_shift; 578*66fb2d54SCornelia Huck __u32 __resv1; 57925b8b39bSAlexey Kardashevskiy __u64 window_size; 58025b8b39bSAlexey Kardashevskiy __u32 levels; 581*66fb2d54SCornelia Huck __u32 __resv2; 58225b8b39bSAlexey Kardashevskiy /* out */ 58325b8b39bSAlexey Kardashevskiy __u64 start_addr; 58425b8b39bSAlexey Kardashevskiy }; 58525b8b39bSAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_TCE_CREATE _IO(VFIO_TYPE, VFIO_BASE + 19) 58625b8b39bSAlexey Kardashevskiy 58725b8b39bSAlexey Kardashevskiy /** 58825b8b39bSAlexey Kardashevskiy * VFIO_IOMMU_SPAPR_TCE_REMOVE - _IOW(VFIO_TYPE, VFIO_BASE + 20, struct vfio_iommu_spapr_tce_remove) 58925b8b39bSAlexey Kardashevskiy * 59025b8b39bSAlexey Kardashevskiy * Unprograms a TCE table from all groups in the container and destroys it. 59125b8b39bSAlexey Kardashevskiy * It receives a PCI bus offset as a window id. 59225b8b39bSAlexey Kardashevskiy */ 59325b8b39bSAlexey Kardashevskiy struct vfio_iommu_spapr_tce_remove { 59425b8b39bSAlexey Kardashevskiy __u32 argsz; 59525b8b39bSAlexey Kardashevskiy __u32 flags; 59625b8b39bSAlexey Kardashevskiy /* in */ 59725b8b39bSAlexey Kardashevskiy __u64 start_addr; 59825b8b39bSAlexey Kardashevskiy }; 59925b8b39bSAlexey Kardashevskiy #define VFIO_IOMMU_SPAPR_TCE_REMOVE _IO(VFIO_TYPE, VFIO_BASE + 20) 60025b8b39bSAlexey Kardashevskiy 601c5daeae1SAlexey Kardashevskiy /* ***************************************************************** */ 602c5daeae1SAlexey Kardashevskiy 603d4834ff9SAlexander Graf #endif /* VFIO_H */ 604