vfio.h 7.0 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0-only */
A
Alex Williamson 已提交
2 3 4 5 6 7 8 9 10 11 12 13
/*
 * VFIO API definition
 *
 * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
 *     Author: Alex Williamson <alex.williamson@redhat.com>
 */
#ifndef VFIO_H
#define VFIO_H


#include <linux/iommu.h>
#include <linux/mm.h>
14 15
#include <linux/workqueue.h>
#include <linux/poll.h>
16
#include <uapi/linux/vfio.h>
A
Alex Williamson 已提交
17 18 19 20 21 22 23 24 25 26 27

/**
 * struct vfio_device_ops - VFIO bus driver device callbacks
 *
 * @open: Called when userspace creates new file descriptor for device
 * @release: Called when userspace releases file descriptor for device
 * @read: Perform read(2) on device file descriptor
 * @write: Perform write(2) on device file descriptor
 * @ioctl: Perform ioctl(2) on device file descriptor, supporting VFIO_DEVICE_*
 *         operations documented below
 * @mmap: Perform mmap(2) on a region of the device file descriptor
28
 * @request: Request for the bus driver to release the device
29 30 31
 * @match: Optional device name match callback (return: 0 for no-match, >0 for
 *         match, -errno for abort (ex. match with insufficient or incorrect
 *         additional args)
A
Alex Williamson 已提交
32 33 34 35 36 37 38 39 40 41 42 43
 */
struct vfio_device_ops {
	char	*name;
	int	(*open)(void *device_data);
	void	(*release)(void *device_data);
	ssize_t	(*read)(void *device_data, char __user *buf,
			size_t count, loff_t *ppos);
	ssize_t	(*write)(void *device_data, const char __user *buf,
			 size_t count, loff_t *size);
	long	(*ioctl)(void *device_data, unsigned int cmd,
			 unsigned long arg);
	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);
A
Alex Williamson 已提交
46 47
};

A
Alex Williamson 已提交
48 49 50
extern struct iommu_group *vfio_iommu_group_get(struct device *dev);
extern void vfio_iommu_group_put(struct iommu_group *group, struct device *dev);

A
Alex Williamson 已提交
51 52 53 54 55
extern int vfio_add_group_dev(struct device *dev,
			      const struct vfio_device_ops *ops,
			      void *device_data);

extern void *vfio_del_group_dev(struct device *dev);
56 57 58
extern struct vfio_device *vfio_device_get_from_dev(struct device *dev);
extern void vfio_device_put(struct vfio_device *device);
extern void *vfio_device_data(struct vfio_device *device);
A
Alex Williamson 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78

/**
 * struct vfio_iommu_driver_ops - VFIO IOMMU driver callbacks
 */
struct vfio_iommu_driver_ops {
	char		*name;
	struct module	*owner;
	void		*(*open)(unsigned long arg);
	void		(*release)(void *iommu_data);
	ssize_t		(*read)(void *iommu_data, char __user *buf,
				size_t count, loff_t *ppos);
	ssize_t		(*write)(void *iommu_data, const char __user *buf,
				 size_t count, loff_t *size);
	long		(*ioctl)(void *iommu_data, unsigned int cmd,
				 unsigned long arg);
	int		(*mmap)(void *iommu_data, struct vm_area_struct *vma);
	int		(*attach_group)(void *iommu_data,
					struct iommu_group *group);
	void		(*detach_group)(void *iommu_data,
					struct iommu_group *group);
79 80 81 82 83
	int		(*pin_pages)(void *iommu_data, unsigned long *user_pfn,
				     int npage, int prot,
				     unsigned long *phys_pfn);
	int		(*unpin_pages)(void *iommu_data,
				       unsigned long *user_pfn, int npage);
84
	int		(*register_notifier)(void *iommu_data,
85
					     unsigned long *events,
86 87 88
					     struct notifier_block *nb);
	int		(*unregister_notifier)(void *iommu_data,
					       struct notifier_block *nb);
89 90
	int		(*dma_rw)(void *iommu_data, dma_addr_t user_iova,
				  void *data, size_t count, bool write);
A
Alex Williamson 已提交
91 92 93 94 95 96 97
};

extern int vfio_register_iommu_driver(const struct vfio_iommu_driver_ops *ops);

extern void vfio_unregister_iommu_driver(
				const struct vfio_iommu_driver_ops *ops);

98 99 100 101 102
/*
 * External user API
 */
extern struct vfio_group *vfio_group_get_external_user(struct file *filep);
extern void vfio_group_put_external_user(struct vfio_group *group);
103 104
extern struct vfio_group *vfio_group_get_external_user_from_dev(struct device
								*dev);
105 106
extern bool vfio_external_group_match_file(struct vfio_group *group,
					   struct file *filep);
107
extern int vfio_external_user_iommu_id(struct vfio_group *group);
108 109
extern long vfio_external_check_extension(struct vfio_group *group,
					  unsigned long arg);
110

111 112 113 114 115 116 117
#define VFIO_PIN_PAGES_MAX_ENTRIES	(PAGE_SIZE/sizeof(unsigned long))

extern int vfio_pin_pages(struct device *dev, unsigned long *user_pfn,
			  int npage, int prot, unsigned long *phys_pfn);
extern int vfio_unpin_pages(struct device *dev, unsigned long *user_pfn,
			    int npage);

118 119 120 121 122 123
extern int vfio_group_pin_pages(struct vfio_group *group,
				unsigned long *user_iova_pfn, int npage,
				int prot, unsigned long *phys_pfn);
extern int vfio_group_unpin_pages(struct vfio_group *group,
				  unsigned long *user_iova_pfn, int npage);

124 125 126
extern int vfio_dma_rw(struct vfio_group *group, dma_addr_t user_iova,
		       void *data, size_t len, bool write);

127 128 129
/* each type has independent events */
enum vfio_notify_type {
	VFIO_IOMMU_NOTIFY = 0,
130
	VFIO_GROUP_NOTIFY = 1,
131 132 133 134
};

/* events for VFIO_IOMMU_NOTIFY */
#define VFIO_IOMMU_NOTIFY_DMA_UNMAP	BIT(0)
135

136 137 138
/* events for VFIO_GROUP_NOTIFY */
#define VFIO_GROUP_NOTIFY_SET_KVM	BIT(0)

139
extern int vfio_register_notifier(struct device *dev,
140 141
				  enum vfio_notify_type type,
				  unsigned long *required_events,
142 143
				  struct notifier_block *nb);
extern int vfio_unregister_notifier(struct device *dev,
144
				    enum vfio_notify_type type,
145 146
				    struct notifier_block *nb);

147 148 149
struct kvm;
extern void vfio_group_set_kvm(struct vfio_group *group, struct kvm *kvm);

150 151 152 153 154 155 156 157 158 159 160
/*
 * Sub-module helpers
 */
struct vfio_info_cap {
	struct vfio_info_cap_header *buf;
	size_t size;
};
extern struct vfio_info_cap_header *vfio_info_cap_add(
		struct vfio_info_cap *caps, size_t size, u16 id, u16 version);
extern void vfio_info_cap_shift(struct vfio_info_cap *caps, size_t offset);

161
extern int vfio_info_add_capability(struct vfio_info_cap *caps,
A
Alex Williamson 已提交
162 163
				    struct vfio_info_cap_header *cap,
				    size_t size);
164

165 166 167 168
extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr,
					      int num_irqs, int max_irq_type,
					      size_t *data_size);

G
Gavin Shan 已提交
169
struct pci_dev;
170
#if IS_ENABLED(CONFIG_VFIO_SPAPR_EEH)
171
extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev);
172 173 174 175 176
extern void vfio_spapr_pci_eeh_release(struct pci_dev *pdev);
extern long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
				       unsigned int cmd,
				       unsigned long arg);
#else
177
static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev)
178 179 180 181 182 183 184 185 186 187 188 189 190
{
}

static inline void vfio_spapr_pci_eeh_release(struct pci_dev *pdev)
{
}

static inline long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
					      unsigned int cmd,
					      unsigned long arg)
{
	return -ENOTTY;
}
191
#endif /* CONFIG_VFIO_SPAPR_EEH */
192 193 194 195 196 197 198 199 200 201 202

/*
 * IRQfd - generic
 */
struct virqfd {
	void			*opaque;
	struct eventfd_ctx	*eventfd;
	int			(*handler)(void *, void *);
	void			(*thread)(void *, void *);
	void			*data;
	struct work_struct	inject;
203
	wait_queue_entry_t		wait;
204 205 206 207 208 209 210 211 212 213 214
	poll_table		pt;
	struct work_struct	shutdown;
	struct virqfd		**pvirqfd;
};

extern int vfio_virqfd_enable(void *opaque,
			      int (*handler)(void *, void *),
			      void (*thread)(void *, void *),
			      void *data, struct virqfd **pvirqfd, int fd);
extern void vfio_virqfd_disable(struct virqfd **pvirqfd);

A
Alex Williamson 已提交
215
#endif /* VFIO_H */