[mirror_ubuntu-jammy-kernel.git] / include / linux / vfio.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * 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>
#include <linux/workqueue.h>
#include <linux/poll.h>
#include <uapi/linux/vfio.h>

struct vfio_device {
	struct device *dev;
	const struct vfio_device_ops *ops;
	struct vfio_group *group;

	/* Members below here are private, not for driver use */
	refcount_t refcount;
	struct completion comp;
	struct list_head group_next;
};

/**
 * 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
 * @request: Request for the bus driver to release the device
 * @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)
 */
struct vfio_device_ops {
	char	*name;
	int	(*open)(struct vfio_device *vdev);
	void	(*release)(struct vfio_device *vdev);
	ssize_t	(*read)(struct vfio_device *vdev, char __user *buf,
			size_t count, loff_t *ppos);
	ssize_t	(*write)(struct vfio_device *vdev, const char __user *buf,
			 size_t count, loff_t *size);
	long	(*ioctl)(struct vfio_device *vdev, unsigned int cmd,
			 unsigned long arg);
	int	(*mmap)(struct vfio_device *vdev, struct vm_area_struct *vma);
	void	(*request)(struct vfio_device *vdev, unsigned int count);
	int	(*match)(struct vfio_device *vdev, char *buf);
};

extern struct iommu_group *vfio_iommu_group_get(struct device *dev);
extern void vfio_iommu_group_put(struct iommu_group *group, struct device *dev);

void vfio_init_group_dev(struct vfio_device *device, struct device *dev,
			 const struct vfio_device_ops *ops);
int vfio_register_group_dev(struct vfio_device *device);
void vfio_unregister_group_dev(struct vfio_device *device);
extern struct vfio_device *vfio_device_get_from_dev(struct device *dev);
extern void vfio_device_put(struct vfio_device *device);

/* events for the backend driver notify callback */
enum vfio_iommu_notify_type {
	VFIO_IOMMU_CONTAINER_CLOSE = 0,
};

/**
 * 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);
	int		(*pin_pages)(void *iommu_data,
				     struct iommu_group *group,
				     unsigned long *user_pfn,
				     int npage, int prot,
				     unsigned long *phys_pfn);
	int		(*unpin_pages)(void *iommu_data,
				       unsigned long *user_pfn, int npage);
	int		(*register_notifier)(void *iommu_data,
					     unsigned long *events,
					     struct notifier_block *nb);
	int		(*unregister_notifier)(void *iommu_data,
					       struct notifier_block *nb);
	int		(*dma_rw)(void *iommu_data, dma_addr_t user_iova,
				  void *data, size_t count, bool write);
	struct iommu_domain *(*group_iommu_domain)(void *iommu_data,
						   struct iommu_group *group);
	void		(*notify)(void *iommu_data,
				  enum vfio_iommu_notify_type event);
};

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);

/*
 * 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);
extern struct vfio_group *vfio_group_get_external_user_from_dev(struct device
								*dev);
extern bool vfio_external_group_match_file(struct vfio_group *group,
					   struct file *filep);
extern int vfio_external_user_iommu_id(struct vfio_group *group);
extern long vfio_external_check_extension(struct vfio_group *group,
					  unsigned long arg);

#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);

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);

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

extern struct iommu_domain *vfio_group_iommu_domain(struct vfio_group *group);

/* each type has independent events */
enum vfio_notify_type {
	VFIO_IOMMU_NOTIFY = 0,
	VFIO_GROUP_NOTIFY = 1,
};

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

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

extern int vfio_register_notifier(struct device *dev,
				  enum vfio_notify_type type,
				  unsigned long *required_events,
				  struct notifier_block *nb);
extern int vfio_unregister_notifier(struct device *dev,
				    enum vfio_notify_type type,
				    struct notifier_block *nb);

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

/*
 * 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);

extern int vfio_info_add_capability(struct vfio_info_cap *caps,
				    struct vfio_info_cap_header *cap,
				    size_t size);

extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr,
					      int num_irqs, int max_irq_type,
					      size_t *data_size);

struct pci_dev;
#if IS_ENABLED(CONFIG_VFIO_SPAPR_EEH)
extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev);
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
static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev)
{
}

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;
}
#endif /* CONFIG_VFIO_SPAPR_EEH */

/*
 * IRQfd - generic
 */
struct virqfd {
	void			*opaque;
	struct eventfd_ctx	*eventfd;
	int			(*handler)(void *, void *);
	void			(*thread)(void *, void *);
	void			*data;
	struct work_struct	inject;
	wait_queue_entry_t		wait;
	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);

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