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