drivers/xen/xen-pciback/pciback.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * PCI Backend Common Data Structures & Function Declarations
   4  *
   5  *   Author: Ryan Wilson <hap9@epoch.ncsc.mil>
   6  */
   7 #ifndef __XEN_PCIBACK_H__
   8 #define __XEN_PCIBACK_H__
   9
  10 #include <linux/pci.h>
  11 #include <linux/interrupt.h>
  12 #include <xen/xenbus.h>
  13 #include <linux/list.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/atomic.h>
  17 #include <xen/events.h>
  18 #include <xen/interface/io/pciif.h>
  19
  20 #define DRV_NAME        "xen-pciback"
  21
  22 struct pci_dev_entry {
  23         struct list_head list;
  24         struct pci_dev *dev;
  25 };
  26
  27 #define _PDEVF_op_active        (0)
  28 #define PDEVF_op_active         (1<<(_PDEVF_op_active))
  29 #define _PCIB_op_pending        (1)
  30 #define PCIB_op_pending         (1<<(_PCIB_op_pending))
  31 #define _EOI_pending            (2)
  32 #define EOI_pending             (1<<(_EOI_pending))
  33
  34 struct xen_pcibk_device {
  35         void *pci_dev_data;
  36         struct mutex dev_lock;
  37         struct xenbus_device *xdev;
  38         struct xenbus_watch be_watch;
  39         u8 be_watching;
  40         int evtchn_irq;
  41         struct xen_pci_sharedinfo *sh_info;
  42         unsigned long flags;
  43         struct work_struct op_work;
  44         struct xen_pci_op op;
  45 };
  46
  47 struct xen_pcibk_dev_data {
  48         struct list_head config_fields;
  49         struct pci_saved_state *pci_saved_state;
  50         unsigned int permissive:1;
  51         unsigned int warned_on_write:1;
  52         unsigned int enable_intx:1;
  53         unsigned int isr_on:1; /* Whether the IRQ handler is installed. */
  54         unsigned int ack_intr:1; /* .. and ACK-ing */
  55         unsigned long handled;
  56         unsigned int irq; /* Saved in case device transitions to MSI/MSI-X */
  57         char irq_name[0]; /* xen-pcibk[000:04:00.0] */
  58 };
  59
  60 /* Used by XenBus and xen_pcibk_ops.c */
  61 extern wait_queue_head_t xen_pcibk_aer_wait_queue;
  62 /* Used by pcistub.c and conf_space_quirks.c */
  63 extern struct list_head xen_pcibk_quirks;
  64
  65 /* Get/Put PCI Devices that are hidden from the PCI Backend Domain */
  66 struct pci_dev *pcistub_get_pci_dev_by_slot(struct xen_pcibk_device *pdev,
  67                                             int domain, int bus,
  68                                             int slot, int func);
  69 struct pci_dev *pcistub_get_pci_dev(struct xen_pcibk_device *pdev,
  70                                     struct pci_dev *dev);
  71 void pcistub_put_pci_dev(struct pci_dev *dev);
  72
  73 /* Ensure a device is turned off or reset */
  74 void xen_pcibk_reset_device(struct pci_dev *pdev);
  75
  76 /* Access a virtual configuration space for a PCI device */
  77 int xen_pcibk_config_init(void);
  78 int xen_pcibk_config_init_dev(struct pci_dev *dev);
  79 void xen_pcibk_config_free_dyn_fields(struct pci_dev *dev);
  80 void xen_pcibk_config_reset_dev(struct pci_dev *dev);
  81 void xen_pcibk_config_free_dev(struct pci_dev *dev);
  82 int xen_pcibk_config_read(struct pci_dev *dev, int offset, int size,
  83                           u32 *ret_val);
  84 int xen_pcibk_config_write(struct pci_dev *dev, int offset, int size,
  85                            u32 value);
  86
  87 /* Handle requests for specific devices from the frontend */
  88 typedef int (*publish_pci_dev_cb) (struct xen_pcibk_device *pdev,
  89                                    unsigned int domain, unsigned int bus,
  90                                    unsigned int devfn, unsigned int devid);
  91 typedef int (*publish_pci_root_cb) (struct xen_pcibk_device *pdev,
  92                                     unsigned int domain, unsigned int bus);
  93
  94 /* Backend registration for the two types of BDF representation:
  95  *  vpci - BDFs start at 00
  96  *  passthrough - BDFs are exactly like in the host.
  97  */
  98 struct xen_pcibk_backend {
  99         const char *name;
 100         int (*init)(struct xen_pcibk_device *pdev);
 101         void (*free)(struct xen_pcibk_device *pdev);
 102         int (*find)(struct pci_dev *pcidev, struct xen_pcibk_device *pdev,
 103                     unsigned int *domain, unsigned int *bus,
 104                     unsigned int *devfn);
 105         int (*publish)(struct xen_pcibk_device *pdev, publish_pci_root_cb cb);
 106         void (*release)(struct xen_pcibk_device *pdev, struct pci_dev *dev,
 107                         bool lock);
 108         int (*add)(struct xen_pcibk_device *pdev, struct pci_dev *dev,
 109                    int devid, publish_pci_dev_cb publish_cb);
 110         struct pci_dev *(*get)(struct xen_pcibk_device *pdev,
 111                                unsigned int domain, unsigned int bus,
 112                                unsigned int devfn);
 113 };
 114
 115 extern const struct xen_pcibk_backend xen_pcibk_vpci_backend;
 116 extern const struct xen_pcibk_backend xen_pcibk_passthrough_backend;
 117 extern const struct xen_pcibk_backend *xen_pcibk_backend;
 118
 119 static inline int xen_pcibk_add_pci_dev(struct xen_pcibk_device *pdev,
 120                                         struct pci_dev *dev,
 121                                         int devid,
 122                                         publish_pci_dev_cb publish_cb)
 123 {
 124         if (xen_pcibk_backend && xen_pcibk_backend->add)
 125                 return xen_pcibk_backend->add(pdev, dev, devid, publish_cb);
 126         return -1;
 127 }
 128
 129 static inline void xen_pcibk_release_pci_dev(struct xen_pcibk_device *pdev,
 130                                              struct pci_dev *dev, bool lock)
 131 {
 132         if (xen_pcibk_backend && xen_pcibk_backend->release)
 133                 return xen_pcibk_backend->release(pdev, dev, lock);
 134 }
 135
 136 static inline struct pci_dev *
 137 xen_pcibk_get_pci_dev(struct xen_pcibk_device *pdev, unsigned int domain,
 138                       unsigned int bus, unsigned int devfn)
 139 {
 140         if (xen_pcibk_backend && xen_pcibk_backend->get)
 141                 return xen_pcibk_backend->get(pdev, domain, bus, devfn);
 142         return NULL;
 143 }
 144
 145 /**
 146 * Add for domain0 PCIE-AER handling. Get guest domain/bus/devfn in xen_pcibk
 147 * before sending aer request to pcifront, so that guest could identify
 148 * device, coopearte with xen_pcibk to finish aer recovery job if device driver
 149 * has the capability
 150 */
 151 static inline int xen_pcibk_get_pcifront_dev(struct pci_dev *pcidev,
 152                                              struct xen_pcibk_device *pdev,
 153                                              unsigned int *domain,
 154                                              unsigned int *bus,
 155                                              unsigned int *devfn)
 156 {
 157         if (xen_pcibk_backend && xen_pcibk_backend->find)
 158                 return xen_pcibk_backend->find(pcidev, pdev, domain, bus,
 159                                                devfn);
 160         return -1;
 161 }
 162
 163 static inline int xen_pcibk_init_devices(struct xen_pcibk_device *pdev)
 164 {
 165         if (xen_pcibk_backend && xen_pcibk_backend->init)
 166                 return xen_pcibk_backend->init(pdev);
 167         return -1;
 168 }
 169
 170 static inline int xen_pcibk_publish_pci_roots(struct xen_pcibk_device *pdev,
 171                                               publish_pci_root_cb cb)
 172 {
 173         if (xen_pcibk_backend && xen_pcibk_backend->publish)
 174                 return xen_pcibk_backend->publish(pdev, cb);
 175         return -1;
 176 }
 177
 178 static inline void xen_pcibk_release_devices(struct xen_pcibk_device *pdev)
 179 {
 180         if (xen_pcibk_backend && xen_pcibk_backend->free)
 181                 return xen_pcibk_backend->free(pdev);
 182 }
 183
 184 /* Handles events from front-end */
 185 irqreturn_t xen_pcibk_handle_event(int irq, void *dev_id);
 186 void xen_pcibk_do_op(struct work_struct *data);
 187
 188 static inline void xen_pcibk_lateeoi(struct xen_pcibk_device *pdev,
 189                                      unsigned int eoi_flag)
 190 {
 191         if (test_and_clear_bit(_EOI_pending, &pdev->flags))
 192                 xen_irq_lateeoi(pdev->evtchn_irq, eoi_flag);
 193 }
 194
 195 int xen_pcibk_xenbus_register(void);
 196 void xen_pcibk_xenbus_unregister(void);
 197
 198 extern int verbose_request;
 199 #endif
 200
 201 /* Handles shared IRQs that can to device domain and control domain. */
 202 void xen_pcibk_irq_handler(struct pci_dev *dev, int reset);