drivers/xen/xen-pciback/pciback.h

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