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