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 allow_interrupt_control:1; 52 unsigned int warned_on_write:1; 53 unsigned int enable_intx:1; 54 unsigned int isr_on:1; /* Whether the IRQ handler is installed. */ 55 unsigned int ack_intr:1; /* .. and ACK-ing */ 56 unsigned long handled; 57 unsigned int irq; /* Saved in case device transitions to MSI/MSI-X */ 58 char irq_name[]; /* xen-pcibk[000:04:00.0] */ 59 }; 60 61 /* Used by XenBus and xen_pcibk_ops.c */ 62 extern wait_queue_head_t xen_pcibk_aer_wait_queue; 63 /* Used by pcistub.c and conf_space_quirks.c */ 64 extern struct list_head xen_pcibk_quirks; 65 66 /* Get/Put PCI Devices that are hidden from the PCI Backend Domain */ 67 struct pci_dev *pcistub_get_pci_dev_by_slot(struct xen_pcibk_device *pdev, 68 int domain, int bus, 69 int slot, int func); 70 struct pci_dev *pcistub_get_pci_dev(struct xen_pcibk_device *pdev, 71 struct pci_dev *dev); 72 void pcistub_put_pci_dev(struct pci_dev *dev); 73 74 /* Ensure a device is turned off or reset */ 75 void xen_pcibk_reset_device(struct pci_dev *pdev); 76 77 /* Access a virtual configuration space for a PCI device */ 78 int xen_pcibk_config_init(void); 79 int xen_pcibk_config_init_dev(struct pci_dev *dev); 80 void xen_pcibk_config_free_dyn_fields(struct pci_dev *dev); 81 void xen_pcibk_config_reset_dev(struct pci_dev *dev); 82 void xen_pcibk_config_free_dev(struct pci_dev *dev); 83 int xen_pcibk_config_read(struct pci_dev *dev, int offset, int size, 84 u32 *ret_val); 85 int xen_pcibk_config_write(struct pci_dev *dev, int offset, int size, 86 u32 value); 87 88 /* Handle requests for specific devices from the frontend */ 89 typedef int (*publish_pci_dev_cb) (struct xen_pcibk_device *pdev, 90 unsigned int domain, unsigned int bus, 91 unsigned int devfn, unsigned int devid); 92 typedef int (*publish_pci_root_cb) (struct xen_pcibk_device *pdev, 93 unsigned int domain, unsigned int bus); 94 95 /* Backend registration for the two types of BDF representation: 96 * vpci - BDFs start at 00 97 * passthrough - BDFs are exactly like in the host. 98 */ 99 struct xen_pcibk_backend { 100 const char *name; 101 int (*init)(struct xen_pcibk_device *pdev); 102 void (*free)(struct xen_pcibk_device *pdev); 103 int (*find)(struct pci_dev *pcidev, struct xen_pcibk_device *pdev, 104 unsigned int *domain, unsigned int *bus, 105 unsigned int *devfn); 106 int (*publish)(struct xen_pcibk_device *pdev, publish_pci_root_cb cb); 107 void (*release)(struct xen_pcibk_device *pdev, struct pci_dev *dev, 108 bool lock); 109 int (*add)(struct xen_pcibk_device *pdev, struct pci_dev *dev, 110 int devid, publish_pci_dev_cb publish_cb); 111 struct pci_dev *(*get)(struct xen_pcibk_device *pdev, 112 unsigned int domain, unsigned int bus, 113 unsigned int devfn); 114 }; 115 116 extern const struct xen_pcibk_backend xen_pcibk_vpci_backend; 117 extern const struct xen_pcibk_backend xen_pcibk_passthrough_backend; 118 extern const struct xen_pcibk_backend *xen_pcibk_backend; 119 120 static inline int xen_pcibk_add_pci_dev(struct xen_pcibk_device *pdev, 121 struct pci_dev *dev, 122 int devid, 123 publish_pci_dev_cb publish_cb) 124 { 125 if (xen_pcibk_backend && xen_pcibk_backend->add) 126 return xen_pcibk_backend->add(pdev, dev, devid, publish_cb); 127 return -1; 128 } 129 130 static inline void xen_pcibk_release_pci_dev(struct xen_pcibk_device *pdev, 131 struct pci_dev *dev, bool lock) 132 { 133 if (xen_pcibk_backend && xen_pcibk_backend->release) 134 return xen_pcibk_backend->release(pdev, dev, lock); 135 } 136 137 static inline struct pci_dev * 138 xen_pcibk_get_pci_dev(struct xen_pcibk_device *pdev, unsigned int domain, 139 unsigned int bus, unsigned int devfn) 140 { 141 if (xen_pcibk_backend && xen_pcibk_backend->get) 142 return xen_pcibk_backend->get(pdev, domain, bus, devfn); 143 return NULL; 144 } 145 146 /** 147 * Add for domain0 PCIE-AER handling. Get guest domain/bus/devfn in xen_pcibk 148 * before sending aer request to pcifront, so that guest could identify 149 * device, coopearte with xen_pcibk to finish aer recovery job if device driver 150 * has the capability 151 */ 152 static inline int xen_pcibk_get_pcifront_dev(struct pci_dev *pcidev, 153 struct xen_pcibk_device *pdev, 154 unsigned int *domain, 155 unsigned int *bus, 156 unsigned int *devfn) 157 { 158 if (xen_pcibk_backend && xen_pcibk_backend->find) 159 return xen_pcibk_backend->find(pcidev, pdev, domain, bus, 160 devfn); 161 return -1; 162 } 163 164 static inline int xen_pcibk_init_devices(struct xen_pcibk_device *pdev) 165 { 166 if (xen_pcibk_backend && xen_pcibk_backend->init) 167 return xen_pcibk_backend->init(pdev); 168 return -1; 169 } 170 171 static inline int xen_pcibk_publish_pci_roots(struct xen_pcibk_device *pdev, 172 publish_pci_root_cb cb) 173 { 174 if (xen_pcibk_backend && xen_pcibk_backend->publish) 175 return xen_pcibk_backend->publish(pdev, cb); 176 return -1; 177 } 178 179 static inline void xen_pcibk_release_devices(struct xen_pcibk_device *pdev) 180 { 181 if (xen_pcibk_backend && xen_pcibk_backend->free) 182 return xen_pcibk_backend->free(pdev); 183 } 184 185 /* Handles events from front-end */ 186 irqreturn_t xen_pcibk_handle_event(int irq, void *dev_id); 187 void xen_pcibk_do_op(struct work_struct *data); 188 189 static inline void xen_pcibk_lateeoi(struct xen_pcibk_device *pdev, 190 unsigned int eoi_flag) 191 { 192 if (test_and_clear_bit(_EOI_pending, &pdev->flags)) 193 xen_irq_lateeoi(pdev->evtchn_irq, eoi_flag); 194 } 195 196 int xen_pcibk_xenbus_register(void); 197 void xen_pcibk_xenbus_unregister(void); 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); 202