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