include/hw/vfio/vfio-common.h

   1 /*
   2  * common header for vfio based device assignment support
   3  *
   4  * Copyright Red Hat, Inc. 2012
   5  *
   6  * Authors:
   7  *  Alex Williamson <alex.williamson@redhat.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  * Based on qemu-kvm device-assignment:
  13  *  Adapted for KVM by Qumranet.
  14  *  Copyright (c) 2007, Neocleus, Alex Novik (alex@neocleus.com)
  15  *  Copyright (c) 2007, Neocleus, Guy Zana (guy@neocleus.com)
  16  *  Copyright (C) 2008, Qumranet, Amit Shah (amit.shah@qumranet.com)
  17  *  Copyright (C) 2008, Red Hat, Amit Shah (amit.shah@redhat.com)
  18  *  Copyright (C) 2008, IBM, Muli Ben-Yehuda (muli@il.ibm.com)
  19  */
  20
  21 #ifndef HW_VFIO_VFIO_COMMON_H
  22 #define HW_VFIO_VFIO_COMMON_H
  23
  24 #include "exec/memory.h"
  25 #include "qemu/queue.h"
  26 #include "qemu/notify.h"
  27 #include "ui/console.h"
  28 #include "hw/display/ramfb.h"
  29 #ifdef CONFIG_LINUX
  30 #include <linux/vfio.h>
  31 #endif
  32
  33 #define VFIO_MSG_PREFIX "vfio %s: "
  34
  35 enum {
  36     VFIO_DEVICE_TYPE_PCI = 0,
  37     VFIO_DEVICE_TYPE_PLATFORM = 1,
  38     VFIO_DEVICE_TYPE_CCW = 2,
  39     VFIO_DEVICE_TYPE_AP = 3,
  40 };
  41
  42 typedef struct VFIOMmap {
  43     MemoryRegion mem;
  44     void *mmap;
  45     off_t offset;
  46     size_t size;
  47 } VFIOMmap;
  48
  49 typedef struct VFIORegion {
  50     struct VFIODevice *vbasedev;
  51     off_t fd_offset; /* offset of region within device fd */
  52     MemoryRegion *mem; /* slow, read/write access */
  53     size_t size;
  54     uint32_t flags; /* VFIO region flags (rd/wr/mmap) */
  55     uint32_t nr_mmaps;
  56     VFIOMmap *mmaps;
  57     uint8_t nr; /* cache the region number for debug */
  58 } VFIORegion;
  59
  60 typedef struct VFIOMigration {
  61     VFIORegion region;
  62 } VFIOMigration;
  63
  64 typedef struct VFIOAddressSpace {
  65     AddressSpace *as;
  66     QLIST_HEAD(, VFIOContainer) containers;
  67     QLIST_ENTRY(VFIOAddressSpace) list;
  68 } VFIOAddressSpace;
  69
  70 struct VFIOGroup;
  71
  72 typedef struct VFIOContainer {
  73     VFIOAddressSpace *space;
  74     int fd; /* /dev/vfio/vfio, empowered by the attached groups */
  75     MemoryListener listener;
  76     MemoryListener prereg_listener;
  77     unsigned iommu_type;
  78     Error *error;
  79     bool initialized;
  80     unsigned long pgsizes;
  81     QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
  82     QLIST_HEAD(, VFIOHostDMAWindow) hostwin_list;
  83     QLIST_HEAD(, VFIOGroup) group_list;
  84     QLIST_ENTRY(VFIOContainer) next;
  85 } VFIOContainer;
  86
  87 typedef struct VFIOGuestIOMMU {
  88     VFIOContainer *container;
  89     IOMMUMemoryRegion *iommu;
  90     hwaddr iommu_offset;
  91     IOMMUNotifier n;
  92     QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
  93 } VFIOGuestIOMMU;
  94
  95 typedef struct VFIOHostDMAWindow {
  96     hwaddr min_iova;
  97     hwaddr max_iova;
  98     uint64_t iova_pgsizes;
  99     QLIST_ENTRY(VFIOHostDMAWindow) hostwin_next;
 100 } VFIOHostDMAWindow;
 101
 102 typedef struct VFIODeviceOps VFIODeviceOps;
 103
 104 typedef struct VFIODevice {
 105     QLIST_ENTRY(VFIODevice) next;
 106     struct VFIOGroup *group;
 107     char *sysfsdev;
 108     char *name;
 109     DeviceState *dev;
 110     int fd;
 111     int type;
 112     bool reset_works;
 113     bool needs_reset;
 114     bool no_mmap;
 115     bool ram_block_discard_allowed;
 116     VFIODeviceOps *ops;
 117     unsigned int num_irqs;
 118     unsigned int num_regions;
 119     unsigned int flags;
 120     VFIOMigration *migration;
 121     Error *migration_blocker;
 122 } VFIODevice;
 123
 124 struct VFIODeviceOps {
 125     void (*vfio_compute_needs_reset)(VFIODevice *vdev);
 126     int (*vfio_hot_reset_multi)(VFIODevice *vdev);
 127     void (*vfio_eoi)(VFIODevice *vdev);
 128     Object *(*vfio_get_object)(VFIODevice *vdev);
 129     void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f);
 130     int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f);
 131 };
 132
 133 typedef struct VFIOGroup {
 134     int fd;
 135     int groupid;
 136     VFIOContainer *container;
 137     QLIST_HEAD(, VFIODevice) device_list;
 138     QLIST_ENTRY(VFIOGroup) next;
 139     QLIST_ENTRY(VFIOGroup) container_next;
 140     bool ram_block_discard_allowed;
 141 } VFIOGroup;
 142
 143 typedef struct VFIODMABuf {
 144     QemuDmaBuf buf;
 145     uint32_t pos_x, pos_y, pos_updates;
 146     uint32_t hot_x, hot_y, hot_updates;
 147     int dmabuf_id;
 148     QTAILQ_ENTRY(VFIODMABuf) next;
 149 } VFIODMABuf;
 150
 151 typedef struct VFIODisplay {
 152     QemuConsole *con;
 153     RAMFBState *ramfb;
 154     struct vfio_region_info *edid_info;
 155     struct vfio_region_gfx_edid *edid_regs;
 156     uint8_t *edid_blob;
 157     QEMUTimer *edid_link_timer;
 158     struct {
 159         VFIORegion buffer;
 160         DisplaySurface *surface;
 161     } region;
 162     struct {
 163         QTAILQ_HEAD(, VFIODMABuf) bufs;
 164         VFIODMABuf *primary;
 165         VFIODMABuf *cursor;
 166     } dmabuf;
 167 } VFIODisplay;
 168
 169 void vfio_put_base_device(VFIODevice *vbasedev);
 170 void vfio_disable_irqindex(VFIODevice *vbasedev, int index);
 171 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index);
 172 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index);
 173 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex,
 174                            int action, int fd, Error **errp);
 175 void vfio_region_write(void *opaque, hwaddr addr,
 176                            uint64_t data, unsigned size);
 177 uint64_t vfio_region_read(void *opaque,
 178                           hwaddr addr, unsigned size);
 179 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region,
 180                       int index, const char *name);
 181 int vfio_region_mmap(VFIORegion *region);
 182 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled);
 183 void vfio_region_unmap(VFIORegion *region);
 184 void vfio_region_exit(VFIORegion *region);
 185 void vfio_region_finalize(VFIORegion *region);
 186 void vfio_reset_handler(void *opaque);
 187 VFIOGroup *vfio_get_group(int groupid, AddressSpace *as, Error **errp);
 188 void vfio_put_group(VFIOGroup *group);
 189 int vfio_get_device(VFIOGroup *group, const char *name,
 190                     VFIODevice *vbasedev, Error **errp);
 191
 192 extern const MemoryRegionOps vfio_region_ops;
 193 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList;
 194 extern VFIOGroupList vfio_group_list;
 195
 196 #ifdef CONFIG_LINUX
 197 int vfio_get_region_info(VFIODevice *vbasedev, int index,
 198                          struct vfio_region_info **info);
 199 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type,
 200                              uint32_t subtype, struct vfio_region_info **info);
 201 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type);
 202 struct vfio_info_cap_header *
 203 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id);
 204 #endif
 205 extern const MemoryListener vfio_prereg_listener;
 206
 207 int vfio_spapr_create_window(VFIOContainer *container,
 208                              MemoryRegionSection *section,
 209                              hwaddr *pgsize);
 210 int vfio_spapr_remove_window(VFIOContainer *container,
 211                              hwaddr offset_within_address_space);
 212
 213 int vfio_migration_probe(VFIODevice *vbasedev, Error **errp);
 214 void vfio_migration_finalize(VFIODevice *vbasedev);
 215
 216 #endif /* HW_VFIO_VFIO_COMMON_H */