Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * VFIO API definition
4 *
5 * Copyright (C) 2012 Red Hat, Inc. All rights reserved.
6 * Author: Alex Williamson <alex.williamson@redhat.com>
7 */
8#ifndef VFIO_H
9#define VFIO_H
10
11
12#include <linux/iommu.h>
13#include <linux/mm.h>
14#include <linux/workqueue.h>
15#include <linux/poll.h>
16#include <uapi/linux/vfio.h>
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
28 * @request: Request for the bus driver to release the device
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)
32 */
33struct 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);
44 void (*request)(void *device_data, unsigned int count);
45 int (*match)(void *device_data, char *buf);
46};
47
48extern struct iommu_group *vfio_iommu_group_get(struct device *dev);
49extern void vfio_iommu_group_put(struct iommu_group *group, struct device *dev);
50
51extern int vfio_add_group_dev(struct device *dev,
52 const struct vfio_device_ops *ops,
53 void *device_data);
54
55extern void *vfio_del_group_dev(struct device *dev);
56extern struct vfio_device *vfio_device_get_from_dev(struct device *dev);
57extern void vfio_device_put(struct vfio_device *device);
58extern void *vfio_device_data(struct vfio_device *device);
59
60/**
61 * struct vfio_iommu_driver_ops - VFIO IOMMU driver callbacks
62 */
63struct 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);
79 int (*pin_pages)(void *iommu_data, unsigned long *user_pfn,
80 int npage, int prot,
81 unsigned long *phys_pfn);
82 int (*unpin_pages)(void *iommu_data,
83 unsigned long *user_pfn, int npage);
84 int (*register_notifier)(void *iommu_data,
85 unsigned long *events,
86 struct notifier_block *nb);
87 int (*unregister_notifier)(void *iommu_data,
88 struct notifier_block *nb);
89 int (*dma_rw)(void *iommu_data, dma_addr_t user_iova,
90 void *data, size_t count, bool write);
91};
92
93extern int vfio_register_iommu_driver(const struct vfio_iommu_driver_ops *ops);
94
95extern void vfio_unregister_iommu_driver(
96 const struct vfio_iommu_driver_ops *ops);
97
98/*
99 * External user API
100 */
101extern struct vfio_group *vfio_group_get_external_user(struct file *filep);
102extern void vfio_group_put_external_user(struct vfio_group *group);
103extern struct vfio_group *vfio_group_get_external_user_from_dev(struct device
104 *dev);
105extern bool vfio_external_group_match_file(struct vfio_group *group,
106 struct file *filep);
107extern int vfio_external_user_iommu_id(struct vfio_group *group);
108extern long vfio_external_check_extension(struct vfio_group *group,
109 unsigned long arg);
110
111#define VFIO_PIN_PAGES_MAX_ENTRIES (PAGE_SIZE/sizeof(unsigned long))
112
113extern int vfio_pin_pages(struct device *dev, unsigned long *user_pfn,
114 int npage, int prot, unsigned long *phys_pfn);
115extern int vfio_unpin_pages(struct device *dev, unsigned long *user_pfn,
116 int npage);
117
118extern int vfio_group_pin_pages(struct vfio_group *group,
119 unsigned long *user_iova_pfn, int npage,
120 int prot, unsigned long *phys_pfn);
121extern int vfio_group_unpin_pages(struct vfio_group *group,
122 unsigned long *user_iova_pfn, int npage);
123
124extern int vfio_dma_rw(struct vfio_group *group, dma_addr_t user_iova,
125 void *data, size_t len, bool write);
126
127/* each type has independent events */
128enum vfio_notify_type {
129 VFIO_IOMMU_NOTIFY = 0,
130 VFIO_GROUP_NOTIFY = 1,
131};
132
133/* events for VFIO_IOMMU_NOTIFY */
134#define VFIO_IOMMU_NOTIFY_DMA_UNMAP BIT(0)
135
136/* events for VFIO_GROUP_NOTIFY */
137#define VFIO_GROUP_NOTIFY_SET_KVM BIT(0)
138
139extern int vfio_register_notifier(struct device *dev,
140 enum vfio_notify_type type,
141 unsigned long *required_events,
142 struct notifier_block *nb);
143extern int vfio_unregister_notifier(struct device *dev,
144 enum vfio_notify_type type,
145 struct notifier_block *nb);
146
147struct kvm;
148extern void vfio_group_set_kvm(struct vfio_group *group, struct kvm *kvm);
149
150/*
151 * Sub-module helpers
152 */
153struct vfio_info_cap {
154 struct vfio_info_cap_header *buf;
155 size_t size;
156};
157extern struct vfio_info_cap_header *vfio_info_cap_add(
158 struct vfio_info_cap *caps, size_t size, u16 id, u16 version);
159extern void vfio_info_cap_shift(struct vfio_info_cap *caps, size_t offset);
160
161extern int vfio_info_add_capability(struct vfio_info_cap *caps,
162 struct vfio_info_cap_header *cap,
163 size_t size);
164
165extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr,
166 int num_irqs, int max_irq_type,
167 size_t *data_size);
168
169struct pci_dev;
170#if IS_ENABLED(CONFIG_VFIO_SPAPR_EEH)
171extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev);
172extern void vfio_spapr_pci_eeh_release(struct pci_dev *pdev);
173extern long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
174 unsigned int cmd,
175 unsigned long arg);
176#else
177static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev)
178{
179}
180
181static inline void vfio_spapr_pci_eeh_release(struct pci_dev *pdev)
182{
183}
184
185static inline long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
186 unsigned int cmd,
187 unsigned long arg)
188{
189 return -ENOTTY;
190}
191#endif /* CONFIG_VFIO_SPAPR_EEH */
192
193/*
194 * IRQfd - generic
195 */
196struct virqfd {
197 void *opaque;
198 struct eventfd_ctx *eventfd;
199 int (*handler)(void *, void *);
200 void (*thread)(void *, void *);
201 void *data;
202 struct work_struct inject;
203 wait_queue_entry_t wait;
204 poll_table pt;
205 struct work_struct shutdown;
206 struct virqfd **pvirqfd;
207};
208
209extern int vfio_virqfd_enable(void *opaque,
210 int (*handler)(void *, void *),
211 void (*thread)(void *, void *),
212 void *data, struct virqfd **pvirqfd, int fd);
213extern void vfio_virqfd_disable(struct virqfd **pvirqfd);
214
215#endif /* VFIO_H */