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 /* Cap maximum number of ioeventfds per device (arbitrary) */
  33 #define VFIO_PCI_IOEVENTFD_MAX          1000
  34
  35 struct vfio_pci_ioeventfd {
  36         struct list_head        next;
  37         struct virqfd           *virqfd;
  38         void __iomem            *addr;
  39         uint64_t                data;
  40         loff_t                  pos;
  41         int                     bar;
  42         int                     count;
  43 };
  44
  45 struct vfio_pci_irq_ctx {
  46         struct eventfd_ctx      *trigger;
  47         struct virqfd           *unmask;
  48         struct virqfd           *mask;
  49         char                    *name;
  50         bool                    masked;
  51         struct irq_bypass_producer      producer;
  52 };
  53
  54 struct vfio_pci_device;
  55 struct vfio_pci_region;
  56
  57 struct vfio_pci_regops {
  58         size_t  (*rw)(struct vfio_pci_device *vdev, char __user *buf,
  59                       size_t count, loff_t *ppos, bool iswrite);
  60         void    (*release)(struct vfio_pci_device *vdev,
  61                            struct vfio_pci_region *region);
  62         int     (*mmap)(struct vfio_pci_device *vdev,
  63                         struct vfio_pci_region *region,
  64                         struct vm_area_struct *vma);
  65         int     (*add_capability)(struct vfio_pci_device *vdev,
  66                                   struct vfio_pci_region *region,
  67                                   struct vfio_info_cap *caps);
  68 };
  69
  70 struct vfio_pci_region {
  71         u32                             type;
  72         u32                             subtype;
  73         const struct vfio_pci_regops    *ops;
  74         void                            *data;
  75         size_t                          size;
  76         u32                             flags;
  77 };
  78
  79 struct vfio_pci_dummy_resource {
  80         struct resource         resource;
  81         int                     index;
  82         struct list_head        res_next;
  83 };
  84
  85 struct vfio_pci_reflck {
  86         struct kref             kref;
  87         struct mutex            lock;
  88 };
  89
  90 struct vfio_pci_device {
  91         struct pci_dev          *pdev;
  92         void __iomem            *barmap[PCI_STD_RESOURCE_END + 1];
  93         bool                    bar_mmap_supported[PCI_STD_RESOURCE_END + 1];
  94         u8                      *pci_config_map;
  95         u8                      *vconfig;
  96         struct perm_bits        *msi_perm;
  97         spinlock_t              irqlock;
  98         struct mutex            igate;
  99         struct vfio_pci_irq_ctx *ctx;
 100         int                     num_ctx;
 101         int                     irq_type;
 102         int                     num_regions;
 103         struct vfio_pci_region  *region;
 104         u8                      msi_qmax;
 105         u8                      msix_bar;
 106         u16                     msix_size;
 107         u32                     msix_offset;
 108         u32                     rbar[7];
 109         bool                    pci_2_3;
 110         bool                    virq_disabled;
 111         bool                    reset_works;
 112         bool                    extended_caps;
 113         bool                    bardirty;
 114         bool                    has_vga;
 115         bool                    needs_reset;
 116         bool                    nointx;
 117         struct pci_saved_state  *pci_saved_state;
 118         struct vfio_pci_reflck  *reflck;
 119         int                     refcnt;
 120         int                     ioeventfds_nr;
 121         struct eventfd_ctx      *err_trigger;
 122         struct eventfd_ctx      *req_trigger;
 123         struct list_head        dummy_resources_list;
 124         struct mutex            ioeventfds_lock;
 125         struct list_head        ioeventfds_list;
 126 };
 127
 128 #define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
 129 #define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
 130 #define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
 131 #define is_irq_none(vdev) (!(is_intx(vdev) || is_msi(vdev) || is_msix(vdev)))
 132 #define irq_is(vdev, type) (vdev->irq_type == type)
 133
 134 extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
 135 extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
 136
 137 extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
 138                                    uint32_t flags, unsigned index,
 139                                    unsigned start, unsigned count, void *data);
 140
 141 extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
 142                                   char __user *buf, size_t count,
 143                                   loff_t *ppos, bool iswrite);
 144
 145 extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device *vdev, char __user *buf,
 146                                size_t count, loff_t *ppos, bool iswrite);
 147
 148 extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device *vdev, char __user *buf,
 149                                size_t count, loff_t *ppos, bool iswrite);
 150
 151 extern long vfio_pci_ioeventfd(struct vfio_pci_device *vdev, loff_t offset,
 152                                uint64_t data, int count, int fd);
 153
 154 extern int vfio_pci_init_perm_bits(void);
 155 extern void vfio_pci_uninit_perm_bits(void);
 156
 157 extern int vfio_config_init(struct vfio_pci_device *vdev);
 158 extern void vfio_config_free(struct vfio_pci_device *vdev);
 159
 160 extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
 161                                         unsigned int type, unsigned int subtype,
 162                                         const struct vfio_pci_regops *ops,
 163                                         size_t size, u32 flags, void *data);
 164 #ifdef CONFIG_VFIO_PCI_IGD
 165 extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
 166 #else
 167 static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
 168 {
 169         return -ENODEV;
 170 }
 171 #endif
 172 #ifdef CONFIG_VFIO_PCI_NVLINK2
 173 extern int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev);
 174 extern int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev);
 175 #else
 176 static inline int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev)
 177 {
 178         return -ENODEV;
 179 }
 180
 181 static inline int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev)
 182 {
 183         return -ENODEV;
 184 }
 185 #endif
 186 #endif /* VFIO_PCI_PRIVATE_H */