drivers/vfio/pci/vfio_pci_private.h

   1 /*
   2  * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
   3  *     Author: Alex Williamson <alex.williamson@redhat.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  * Derived from original vfio:
  10  * Copyright 2010 Cisco Systems, Inc.  All rights reserved.
  11  * Author: Tom Lyon, pugs@cisco.com
  12  */
  13
  14 #include <linux/mutex.h>
  15 #include <linux/pci.h>
  16 #include <linux/irqbypass.h>
  17 #include <linux/types.h>
  18
  19 #ifndef VFIO_PCI_PRIVATE_H
  20 #define VFIO_PCI_PRIVATE_H
  21
  22 #define VFIO_PCI_OFFSET_SHIFT   40
  23
  24 #define VFIO_PCI_OFFSET_TO_INDEX(off)   (off >> VFIO_PCI_OFFSET_SHIFT)
  25 #define VFIO_PCI_INDEX_TO_OFFSET(index) ((u64)(index) << VFIO_PCI_OFFSET_SHIFT)
  26 #define VFIO_PCI_OFFSET_MASK    (((u64)(1) << VFIO_PCI_OFFSET_SHIFT) - 1)
  27
  28 /* Special capability IDs predefined access */
  29 #define PCI_CAP_ID_INVALID              0xFF    /* default raw access */
  30 #define PCI_CAP_ID_INVALID_VIRT         0xFE    /* default virt access */
  31
  32 struct vfio_pci_irq_ctx {
  33         struct eventfd_ctx      *trigger;
  34         struct virqfd           *unmask;
  35         struct virqfd           *mask;
  36         char                    *name;
  37         bool                    masked;
  38         struct irq_bypass_producer      producer;
  39 };
  40
  41 struct vfio_pci_device;
  42 struct vfio_pci_region;
  43
  44 struct vfio_pci_regops {
  45         size_t  (*rw)(struct vfio_pci_device *vdev, char __user *buf,
  46                       size_t count, loff_t *ppos, bool iswrite);
  47         void    (*release)(struct vfio_pci_device *vdev,
  48                            struct vfio_pci_region *region);
  49 };
  50
  51 struct vfio_pci_region {
  52         u32                             type;
  53         u32                             subtype;
  54         const struct vfio_pci_regops    *ops;
  55         void                            *data;
  56         size_t                          size;
  57         u32                             flags;
  58 };
  59
  60 struct vfio_pci_dummy_resource {
  61         struct resource         resource;
  62         int                     index;
  63         struct list_head        res_next;
  64 };
  65
  66 struct vfio_pci_mmap_vma {
  67         struct vm_area_struct   *vma;
  68         struct list_head        vma_next;
  69 };
  70
  71 struct vfio_pci_device {
  72         struct pci_dev          *pdev;
  73         void __iomem            *barmap[PCI_STD_RESOURCE_END + 1];
  74         bool                    bar_mmap_supported[PCI_STD_RESOURCE_END + 1];
  75         u8                      *pci_config_map;
  76         u8                      *vconfig;
  77         struct perm_bits        *msi_perm;
  78         spinlock_t              irqlock;
  79         struct mutex            igate;
  80         struct vfio_pci_irq_ctx *ctx;
  81         int                     num_ctx;
  82         int                     irq_type;
  83         int                     num_regions;
  84         struct vfio_pci_region  *region;
  85         u8                      msi_qmax;
  86         u8                      msix_bar;
  87         u16                     msix_size;
  88         u32                     msix_offset;
  89         u32                     rbar[7];
  90         bool                    pci_2_3;
  91         bool                    virq_disabled;
  92         bool                    reset_works;
  93         bool                    extended_caps;
  94         bool                    bardirty;
  95         bool                    has_vga;
  96         bool                    needs_reset;
  97         bool                    nointx;
  98         struct pci_saved_state  *pci_saved_state;
  99         int                     refcnt;
 100         struct eventfd_ctx      *err_trigger;
 101         struct eventfd_ctx      *req_trigger;
 102         struct list_head        dummy_resources_list;
 103         struct mutex            vma_lock;
 104         struct list_head        vma_list;
 105         struct rw_semaphore     memory_lock;
 106 };
 107
 108 #define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
 109 #define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
 110 #define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
 111 #define is_irq_none(vdev) (!(is_intx(vdev) || is_msi(vdev) || is_msix(vdev)))
 112 #define irq_is(vdev, type) (vdev->irq_type == type)
 113
 114 extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
 115 extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
 116
 117 extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
 118                                    uint32_t flags, unsigned index,
 119                                    unsigned start, unsigned count, void *data);
 120
 121 extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
 122                                   char __user *buf, size_t count,
 123                                   loff_t *ppos, bool iswrite);
 124
 125 extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device *vdev, char __user *buf,
 126                                size_t count, loff_t *ppos, bool iswrite);
 127
 128 extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device *vdev, char __user *buf,
 129                                size_t count, loff_t *ppos, bool iswrite);
 130
 131 extern int vfio_pci_init_perm_bits(void);
 132 extern void vfio_pci_uninit_perm_bits(void);
 133
 134 extern int vfio_config_init(struct vfio_pci_device *vdev);
 135 extern void vfio_config_free(struct vfio_pci_device *vdev);
 136
 137 extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
 138                                         unsigned int type, unsigned int subtype,
 139                                         const struct vfio_pci_regops *ops,
 140                                         size_t size, u32 flags, void *data);
 141
 142 extern bool __vfio_pci_memory_enabled(struct vfio_pci_device *vdev);
 143 extern void vfio_pci_zap_and_down_write_memory_lock(struct vfio_pci_device
 144                                                     *vdev);
 145 extern u16 vfio_pci_memory_lock_and_enable(struct vfio_pci_device *vdev);
 146 extern void vfio_pci_memory_unlock_and_restore(struct vfio_pci_device *vdev,
 147                                                u16 cmd);
 148
 149 #ifdef CONFIG_VFIO_PCI_IGD
 150 extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
 151 #else
 152 static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
 153 {
 154         return -ENODEV;
 155 }
 156 #endif
 157 #endif /* VFIO_PCI_PRIVATE_H */