Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
cba3345c AW |
2 | /* |
3 | * VFIO API definition | |
4 | * | |
5 | * Copyright (C) 2012 Red Hat, Inc. All rights reserved. | |
6 | * Author: Alex Williamson <alex.williamson@redhat.com> | |
cba3345c AW |
7 | */ |
8 | #ifndef VFIO_H | |
9 | #define VFIO_H | |
10 | ||
cba3345c AW |
11 | |
12 | #include <linux/iommu.h> | |
13 | #include <linux/mm.h> | |
7e992d69 AM |
14 | #include <linux/workqueue.h> |
15 | #include <linux/poll.h> | |
607ca46e | 16 | #include <uapi/linux/vfio.h> |
cba3345c AW |
17 | |
18 | /** | |
19 | * struct vfio_device_ops - VFIO bus driver device callbacks | |
20 | * | |
21 | * @open: Called when userspace creates new file descriptor for device | |
22 | * @release: Called when userspace releases file descriptor for device | |
23 | * @read: Perform read(2) on device file descriptor | |
24 | * @write: Perform write(2) on device file descriptor | |
25 | * @ioctl: Perform ioctl(2) on device file descriptor, supporting VFIO_DEVICE_* | |
26 | * operations documented below | |
27 | * @mmap: Perform mmap(2) on a region of the device file descriptor | |
13060b64 | 28 | * @request: Request for the bus driver to release the device |
5f3874c2 AW |
29 | * @match: Optional device name match callback (return: 0 for no-match, >0 for |
30 | * match, -errno for abort (ex. match with insufficient or incorrect | |
31 | * additional args) | |
cba3345c AW |
32 | */ |
33 | struct vfio_device_ops { | |
34 | char *name; | |
35 | int (*open)(void *device_data); | |
36 | void (*release)(void *device_data); | |
37 | ssize_t (*read)(void *device_data, char __user *buf, | |
38 | size_t count, loff_t *ppos); | |
39 | ssize_t (*write)(void *device_data, const char __user *buf, | |
40 | size_t count, loff_t *size); | |
41 | long (*ioctl)(void *device_data, unsigned int cmd, | |
42 | unsigned long arg); | |
43 | int (*mmap)(void *device_data, struct vm_area_struct *vma); | |
13060b64 | 44 | void (*request)(void *device_data, unsigned int count); |
5f3874c2 | 45 | int (*match)(void *device_data, char *buf); |
cba3345c AW |
46 | }; |
47 | ||
03a76b60 AW |
48 | extern struct iommu_group *vfio_iommu_group_get(struct device *dev); |
49 | extern void vfio_iommu_group_put(struct iommu_group *group, struct device *dev); | |
50 | ||
cba3345c AW |
51 | extern int vfio_add_group_dev(struct device *dev, |
52 | const struct vfio_device_ops *ops, | |
53 | void *device_data); | |
54 | ||
55 | extern void *vfio_del_group_dev(struct device *dev); | |
44f50716 VMP |
56 | extern struct vfio_device *vfio_device_get_from_dev(struct device *dev); |
57 | extern void vfio_device_put(struct vfio_device *device); | |
58 | extern void *vfio_device_data(struct vfio_device *device); | |
cba3345c AW |
59 | |
60 | /** | |
61 | * struct vfio_iommu_driver_ops - VFIO IOMMU driver callbacks | |
62 | */ | |
63 | struct vfio_iommu_driver_ops { | |
64 | char *name; | |
65 | struct module *owner; | |
66 | void *(*open)(unsigned long arg); | |
67 | void (*release)(void *iommu_data); | |
68 | ssize_t (*read)(void *iommu_data, char __user *buf, | |
69 | size_t count, loff_t *ppos); | |
70 | ssize_t (*write)(void *iommu_data, const char __user *buf, | |
71 | size_t count, loff_t *size); | |
72 | long (*ioctl)(void *iommu_data, unsigned int cmd, | |
73 | unsigned long arg); | |
74 | int (*mmap)(void *iommu_data, struct vm_area_struct *vma); | |
75 | int (*attach_group)(void *iommu_data, | |
76 | struct iommu_group *group); | |
77 | void (*detach_group)(void *iommu_data, | |
78 | struct iommu_group *group); | |
95fc87b4 KW |
79 | int (*pin_pages)(void *iommu_data, |
80 | struct iommu_group *group, | |
81 | unsigned long *user_pfn, | |
2169037d KW |
82 | int npage, int prot, |
83 | unsigned long *phys_pfn); | |
84 | int (*unpin_pages)(void *iommu_data, | |
85 | unsigned long *user_pfn, int npage); | |
c086de81 | 86 | int (*register_notifier)(void *iommu_data, |
22195cbd | 87 | unsigned long *events, |
c086de81 KW |
88 | struct notifier_block *nb); |
89 | int (*unregister_notifier)(void *iommu_data, | |
90 | struct notifier_block *nb); | |
8d46c0cc YZ |
91 | int (*dma_rw)(void *iommu_data, dma_addr_t user_iova, |
92 | void *data, size_t count, bool write); | |
cba3345c AW |
93 | }; |
94 | ||
95 | extern int vfio_register_iommu_driver(const struct vfio_iommu_driver_ops *ops); | |
96 | ||
97 | extern void vfio_unregister_iommu_driver( | |
98 | const struct vfio_iommu_driver_ops *ops); | |
99 | ||
6cdd9782 AK |
100 | /* |
101 | * External user API | |
102 | */ | |
103 | extern struct vfio_group *vfio_group_get_external_user(struct file *filep); | |
104 | extern void vfio_group_put_external_user(struct vfio_group *group); | |
c0560f51 YZ |
105 | extern struct vfio_group *vfio_group_get_external_user_from_dev(struct device |
106 | *dev); | |
5d6dee80 AW |
107 | extern bool vfio_external_group_match_file(struct vfio_group *group, |
108 | struct file *filep); | |
6cdd9782 | 109 | extern int vfio_external_user_iommu_id(struct vfio_group *group); |
88d7ab89 AW |
110 | extern long vfio_external_check_extension(struct vfio_group *group, |
111 | unsigned long arg); | |
6cdd9782 | 112 | |
2169037d KW |
113 | #define VFIO_PIN_PAGES_MAX_ENTRIES (PAGE_SIZE/sizeof(unsigned long)) |
114 | ||
115 | extern int vfio_pin_pages(struct device *dev, unsigned long *user_pfn, | |
116 | int npage, int prot, unsigned long *phys_pfn); | |
117 | extern int vfio_unpin_pages(struct device *dev, unsigned long *user_pfn, | |
118 | int npage); | |
119 | ||
40280cf7 YZ |
120 | extern int vfio_group_pin_pages(struct vfio_group *group, |
121 | unsigned long *user_iova_pfn, int npage, | |
122 | int prot, unsigned long *phys_pfn); | |
123 | extern int vfio_group_unpin_pages(struct vfio_group *group, | |
124 | unsigned long *user_iova_pfn, int npage); | |
125 | ||
8d46c0cc YZ |
126 | extern int vfio_dma_rw(struct vfio_group *group, dma_addr_t user_iova, |
127 | void *data, size_t len, bool write); | |
128 | ||
22195cbd JS |
129 | /* each type has independent events */ |
130 | enum vfio_notify_type { | |
131 | VFIO_IOMMU_NOTIFY = 0, | |
ccd46dba | 132 | VFIO_GROUP_NOTIFY = 1, |
22195cbd JS |
133 | }; |
134 | ||
135 | /* events for VFIO_IOMMU_NOTIFY */ | |
136 | #define VFIO_IOMMU_NOTIFY_DMA_UNMAP BIT(0) | |
c086de81 | 137 | |
ccd46dba JS |
138 | /* events for VFIO_GROUP_NOTIFY */ |
139 | #define VFIO_GROUP_NOTIFY_SET_KVM BIT(0) | |
140 | ||
c086de81 | 141 | extern int vfio_register_notifier(struct device *dev, |
22195cbd JS |
142 | enum vfio_notify_type type, |
143 | unsigned long *required_events, | |
c086de81 | 144 | struct notifier_block *nb); |
c086de81 | 145 | extern int vfio_unregister_notifier(struct device *dev, |
22195cbd | 146 | enum vfio_notify_type type, |
c086de81 KW |
147 | struct notifier_block *nb); |
148 | ||
ccd46dba JS |
149 | struct kvm; |
150 | extern void vfio_group_set_kvm(struct vfio_group *group, struct kvm *kvm); | |
151 | ||
d7a8d5ed AW |
152 | /* |
153 | * Sub-module helpers | |
154 | */ | |
155 | struct vfio_info_cap { | |
156 | struct vfio_info_cap_header *buf; | |
157 | size_t size; | |
158 | }; | |
159 | extern struct vfio_info_cap_header *vfio_info_cap_add( | |
160 | struct vfio_info_cap *caps, size_t size, u16 id, u16 version); | |
161 | extern void vfio_info_cap_shift(struct vfio_info_cap *caps, size_t offset); | |
162 | ||
b3c0a866 | 163 | extern int vfio_info_add_capability(struct vfio_info_cap *caps, |
dda01f78 AW |
164 | struct vfio_info_cap_header *cap, |
165 | size_t size); | |
b3c0a866 | 166 | |
c747f08a KW |
167 | extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr, |
168 | int num_irqs, int max_irq_type, | |
169 | size_t *data_size); | |
170 | ||
92d18a68 | 171 | struct pci_dev; |
bb67b496 | 172 | #if IS_ENABLED(CONFIG_VFIO_SPAPR_EEH) |
9b936c96 | 173 | extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev); |
1b69be5e GS |
174 | extern void vfio_spapr_pci_eeh_release(struct pci_dev *pdev); |
175 | extern long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group, | |
176 | unsigned int cmd, | |
177 | unsigned long arg); | |
178 | #else | |
9b936c96 | 179 | static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev) |
1b69be5e | 180 | { |
1b69be5e GS |
181 | } |
182 | ||
183 | static inline void vfio_spapr_pci_eeh_release(struct pci_dev *pdev) | |
184 | { | |
185 | } | |
186 | ||
187 | static inline long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group, | |
188 | unsigned int cmd, | |
189 | unsigned long arg) | |
190 | { | |
191 | return -ENOTTY; | |
192 | } | |
bb67b496 | 193 | #endif /* CONFIG_VFIO_SPAPR_EEH */ |
7e992d69 AM |
194 | |
195 | /* | |
196 | * IRQfd - generic | |
197 | */ | |
198 | struct virqfd { | |
199 | void *opaque; | |
200 | struct eventfd_ctx *eventfd; | |
201 | int (*handler)(void *, void *); | |
202 | void (*thread)(void *, void *); | |
203 | void *data; | |
204 | struct work_struct inject; | |
ac6424b9 | 205 | wait_queue_entry_t wait; |
7e992d69 AM |
206 | poll_table pt; |
207 | struct work_struct shutdown; | |
208 | struct virqfd **pvirqfd; | |
209 | }; | |
210 | ||
7e992d69 AM |
211 | extern int vfio_virqfd_enable(void *opaque, |
212 | int (*handler)(void *, void *), | |
213 | void (*thread)(void *, void *), | |
214 | void *data, struct virqfd **pvirqfd, int fd); | |
215 | extern void vfio_virqfd_disable(struct virqfd **pvirqfd); | |
216 | ||
cba3345c | 217 | #endif /* VFIO_H */ |