[linux-block.git] / include / linux / iommufd.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2021 Intel Corporation
 * Copyright (c) 2021-2022, NVIDIA CORPORATION & AFFILIATES
 */
#ifndef __LINUX_IOMMUFD_H
#define __LINUX_IOMMUFD_H

#include <linux/err.h>
#include <linux/errno.h>
#include <linux/types.h>

struct device;
struct file;
struct iommu_group;
struct iommufd_access;
struct iommufd_ctx;
struct iommufd_device;
struct page;

struct iommufd_device *iommufd_device_bind(struct iommufd_ctx *ictx,
					   struct device *dev, u32 *id);
void iommufd_device_unbind(struct iommufd_device *idev);

int iommufd_device_attach(struct iommufd_device *idev, u32 *pt_id);
int iommufd_device_replace(struct iommufd_device *idev, u32 *pt_id);
void iommufd_device_detach(struct iommufd_device *idev);

struct iommufd_ctx *iommufd_device_to_ictx(struct iommufd_device *idev);
u32 iommufd_device_to_id(struct iommufd_device *idev);

struct iommufd_access_ops {
	u8 needs_pin_pages : 1;
	void (*unmap)(void *data, unsigned long iova, unsigned long length);
};

enum {
	IOMMUFD_ACCESS_RW_READ = 0,
	IOMMUFD_ACCESS_RW_WRITE = 1 << 0,
	/* Set if the caller is in a kthread then rw will use kthread_use_mm() */
	IOMMUFD_ACCESS_RW_KTHREAD = 1 << 1,

	/* Only for use by selftest */
	__IOMMUFD_ACCESS_RW_SLOW_PATH = 1 << 2,
};

struct iommufd_access *
iommufd_access_create(struct iommufd_ctx *ictx,
		      const struct iommufd_access_ops *ops, void *data, u32 *id);
void iommufd_access_destroy(struct iommufd_access *access);
int iommufd_access_attach(struct iommufd_access *access, u32 ioas_id);
int iommufd_access_replace(struct iommufd_access *access, u32 ioas_id);
void iommufd_access_detach(struct iommufd_access *access);

void iommufd_ctx_get(struct iommufd_ctx *ictx);

#if IS_ENABLED(CONFIG_IOMMUFD)
struct iommufd_ctx *iommufd_ctx_from_file(struct file *file);
struct iommufd_ctx *iommufd_ctx_from_fd(int fd);
void iommufd_ctx_put(struct iommufd_ctx *ictx);
bool iommufd_ctx_has_group(struct iommufd_ctx *ictx, struct iommu_group *group);

int iommufd_access_pin_pages(struct iommufd_access *access, unsigned long iova,
			     unsigned long length, struct page **out_pages,
			     unsigned int flags);
void iommufd_access_unpin_pages(struct iommufd_access *access,
				unsigned long iova, unsigned long length);
int iommufd_access_rw(struct iommufd_access *access, unsigned long iova,
		      void *data, size_t len, unsigned int flags);
int iommufd_vfio_compat_ioas_get_id(struct iommufd_ctx *ictx, u32 *out_ioas_id);
int iommufd_vfio_compat_ioas_create(struct iommufd_ctx *ictx);
int iommufd_vfio_compat_set_no_iommu(struct iommufd_ctx *ictx);
#else /* !CONFIG_IOMMUFD */
static inline struct iommufd_ctx *iommufd_ctx_from_file(struct file *file)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline void iommufd_ctx_put(struct iommufd_ctx *ictx)
{
}

static inline int iommufd_access_pin_pages(struct iommufd_access *access,
					   unsigned long iova,
					   unsigned long length,
					   struct page **out_pages,
					   unsigned int flags)
{
	return -EOPNOTSUPP;
}

static inline void iommufd_access_unpin_pages(struct iommufd_access *access,
					      unsigned long iova,
					      unsigned long length)
{
}

static inline int iommufd_access_rw(struct iommufd_access *access, unsigned long iova,
		      void *data, size_t len, unsigned int flags)
{
	return -EOPNOTSUPP;
}

static inline int iommufd_vfio_compat_ioas_create(struct iommufd_ctx *ictx)
{
	return -EOPNOTSUPP;
}

static inline int iommufd_vfio_compat_set_no_iommu(struct iommufd_ctx *ictx)
{
	return -EOPNOTSUPP;
}
#endif /* CONFIG_IOMMUFD */
#endif
Commit	Line	Data
2ff4bed7 JG	1	/* SPDX-License-Identifier: GPL-2.0-only */
	2	/*
	3	* Copyright (C) 2021 Intel Corporation
	4	* Copyright (c) 2021-2022, NVIDIA CORPORATION & AFFILIATES
	5	*/
	6	#ifndef __LINUX_IOMMUFD_H
	7	#define __LINUX_IOMMUFD_H
	8
2ff4bed7	9	#include <linux/err.h>
1d4684fb NC	10	#include <linux/errno.h>
1d4684fb NC	11	#include <linux/types.h>
2ff4bed7	12
8d40205f	13	struct device;
2ff4bed7	14	struct file;
86b0a96c	15	struct iommu_group;
3e6a7e3c NC	16	struct iommufd_access;
	17	struct iommufd_ctx;
	18	struct iommufd_device;
	19	struct page;
2ff4bed7	20
e8d57210 JG	21	struct iommufd_device iommufd_device_bind(struct iommufd_ctx ictx,
	22	struct device dev, u32 id);
	23	void iommufd_device_unbind(struct iommufd_device *idev);
	24
	25	int iommufd_device_attach(struct iommufd_device idev, u32 pt_id);
fa1ffdb9	26	int iommufd_device_replace(struct iommufd_device idev, u32 pt_id);
e8d57210 JG	27	void iommufd_device_detach(struct iommufd_device *idev);
e8d57210 JG	28
78d3df45 YL	29	struct iommufd_ctx iommufd_device_to_ictx(struct iommufd_device idev);
	30	u32 iommufd_device_to_id(struct iommufd_device *idev);
	31
8d40205f JG	32	struct iommufd_access_ops {
	33	u8 needs_pin_pages : 1;
	34	void (unmap)(void data, unsigned long iova, unsigned long length);
	35	};
	36
f394576e JG	37	enum {
	38	IOMMUFD_ACCESS_RW_READ = 0,
	39	IOMMUFD_ACCESS_RW_WRITE = 1 << 0,
	40	/* Set if the caller is in a kthread then rw will use kthread_use_mm() */
	41	IOMMUFD_ACCESS_RW_KTHREAD = 1 << 1,
f4b20bb3 JG	42
	43	/* Only for use by selftest */
	44	__IOMMUFD_ACCESS_RW_SLOW_PATH = 1 << 2,
f394576e JG	45	};
f394576e JG	46
8d40205f	47	struct iommufd_access *
54b47585	48	iommufd_access_create(struct iommufd_ctx *ictx,
632fda7f	49	const struct iommufd_access_ops ops, void data, u32 *id);
8d40205f	50	void iommufd_access_destroy(struct iommufd_access *access);
54b47585	51	int iommufd_access_attach(struct iommufd_access *access, u32 ioas_id);
70c16123	52	int iommufd_access_replace(struct iommufd_access *access, u32 ioas_id);
e23a6217	53	void iommufd_access_detach(struct iommufd_access *access);
8d40205f	54
2ff4bed7 JG	55	void iommufd_ctx_get(struct iommufd_ctx *ictx);
	56
	57	#if IS_ENABLED(CONFIG_IOMMUFD)
	58	struct iommufd_ctx iommufd_ctx_from_file(struct file file);
1c9dc074	59	struct iommufd_ctx *iommufd_ctx_from_fd(int fd);
2ff4bed7	60	void iommufd_ctx_put(struct iommufd_ctx *ictx);
86b0a96c	61	bool iommufd_ctx_has_group(struct iommufd_ctx ictx, struct iommu_group group);
8d40205f JG	62
	63	int iommufd_access_pin_pages(struct iommufd_access *access, unsigned long iova,
	64	unsigned long length, struct page **out_pages,
	65	unsigned int flags);
	66	void iommufd_access_unpin_pages(struct iommufd_access *access,
	67	unsigned long iova, unsigned long length);
	68	int iommufd_access_rw(struct iommufd_access *access, unsigned long iova,
	69	void *data, size_t len, unsigned int flags);
c9a397ce JG	70	int iommufd_vfio_compat_ioas_get_id(struct iommufd_ctx ictx, u32 out_ioas_id);
	71	int iommufd_vfio_compat_ioas_create(struct iommufd_ctx *ictx);
	72	int iommufd_vfio_compat_set_no_iommu(struct iommufd_ctx *ictx);
2ff4bed7 JG	73	#else /* !CONFIG_IOMMUFD */
	74	static inline struct iommufd_ctx iommufd_ctx_from_file(struct file file)
	75	{
	76	return ERR_PTR(-EOPNOTSUPP);
	77	}
	78
	79	static inline void iommufd_ctx_put(struct iommufd_ctx *ictx)
	80	{
	81	}
8d40205f JG	82
	83	static inline int iommufd_access_pin_pages(struct iommufd_access *access,
	84	unsigned long iova,
	85	unsigned long length,
	86	struct page **out_pages,
	87	unsigned int flags)
	88	{
	89	return -EOPNOTSUPP;
	90	}
	91
	92	static inline void iommufd_access_unpin_pages(struct iommufd_access *access,
	93	unsigned long iova,
	94	unsigned long length)
	95	{
	96	}
	97
	98	static inline int iommufd_access_rw(struct iommufd_access *access, unsigned long iova,
	99	void *data, size_t len, unsigned int flags)
	100	{
	101	return -EOPNOTSUPP;
	102	}
d624d665	103
c9a397ce JG	104	static inline int iommufd_vfio_compat_ioas_create(struct iommufd_ctx *ictx)
	105	{
	106	return -EOPNOTSUPP;
	107	}
	108
	109	static inline int iommufd_vfio_compat_set_no_iommu(struct iommufd_ctx *ictx)
d624d665 JG	110	{
	111	return -EOPNOTSUPP;
	112	}
2ff4bed7 JG	113	#endif /* CONFIG_IOMMUFD */
2ff4bed7 JG	114	#endif