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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright © 2015 Intel Corporation.
 *
 * Authors: David Woodhouse <David.Woodhouse@intel.com>
 */

#ifndef __INTEL_SVM_H__
#define __INTEL_SVM_H__

struct device;

struct svm_dev_ops {
	void (*fault_cb)(struct device *dev, u32 pasid, u64 address,
			 void *private, int rwxp, int response);
};

/* Values for rxwp in fault_cb callback */
#define SVM_REQ_READ	(1<<3)
#define SVM_REQ_WRITE	(1<<2)
#define SVM_REQ_EXEC	(1<<1)
#define SVM_REQ_PRIV	(1<<0)

/*
 * The SVM_FLAG_PRIVATE_PASID flag requests a PASID which is *not* the "main"
 * PASID for the current process. Even if a PASID already exists, a new one
 * will be allocated. And the PASID allocated with SVM_FLAG_PRIVATE_PASID
 * will not be given to subsequent callers. This facility allows a driver to
 * disambiguate between multiple device contexts which access the same MM,
 * if there is no other way to do so. It should be used sparingly, if at all.
 */
#define SVM_FLAG_PRIVATE_PASID		(1<<0)

/*
 * The SVM_FLAG_SUPERVISOR_MODE flag requests a PASID which can be used only
 * for access to kernel addresses. No IOTLB flushes are automatically done
 * for kernel mappings; it is valid only for access to the kernel's static
 * 1:1 mapping of physical memory — not to vmalloc or even module mappings.
 * A future API addition may permit the use of such ranges, by means of an
 * explicit IOTLB flush call (akin to the DMA API's unmap method).
 *
 * It is unlikely that we will ever hook into flush_tlb_kernel_range() to
 * do such IOTLB flushes automatically.
 */
#define SVM_FLAG_SUPERVISOR_MODE	(1<<1)
/*
 * The SVM_FLAG_GUEST_MODE flag is used when a PASID bind is for guest
 * processes. Compared to the host bind, the primary differences are:
 * 1. mm life cycle management
 * 2. fault reporting
 */
#define SVM_FLAG_GUEST_MODE		(1<<2)
/*
 * The SVM_FLAG_GUEST_PASID flag is used when a guest has its own PASID space,
 * which requires guest and host PASID translation at both directions.
 */
#define SVM_FLAG_GUEST_PASID		(1<<3)

#endif /* __INTEL_SVM_H__ */
Commit	Line	Data
2025cf9e	1	/* SPDX-License-Identifier: GPL-2.0-only */
2f26e0a9 DW	2	/*
	3	* Copyright © 2015 Intel Corporation.
	4	*
	5	* Authors: David Woodhouse <David.Woodhouse@intel.com>
2f26e0a9 DW	6	*/
	7
	8	#ifndef __INTEL_SVM_H__
	9	#define __INTEL_SVM_H__
	10
2f26e0a9 DW	11	struct device;
2f26e0a9 DW	12
0204a496	13	struct svm_dev_ops {
c7b6bac9	14	void (fault_cb)(struct device dev, u32 pasid, u64 address,
5b438f4b	15	void *private, int rwxp, int response);
0204a496 DW	16	};
	17
	18	/* Values for rxwp in fault_cb callback */
	19	#define SVM_REQ_READ (1<<3)
	20	#define SVM_REQ_WRITE (1<<2)
	21	#define SVM_REQ_EXEC (1<<1)
	22	#define SVM_REQ_PRIV (1<<0)
	23
569e4f77 DW	24	/*
	25	* The SVM_FLAG_PRIVATE_PASID flag requests a PASID which is not the "main"
	26	* PASID for the current process. Even if a PASID already exists, a new one
	27	* will be allocated. And the PASID allocated with SVM_FLAG_PRIVATE_PASID
	28	* will not be given to subsequent callers. This facility allows a driver to
	29	* disambiguate between multiple device contexts which access the same MM,
	30	* if there is no other way to do so. It should be used sparingly, if at all.
	31	*/
5cec7537 DW	32	#define SVM_FLAG_PRIVATE_PASID (1<<0)
	33
	34	/*
	35	* The SVM_FLAG_SUPERVISOR_MODE flag requests a PASID which can be used only
	36	* for access to kernel addresses. No IOTLB flushes are automatically done
	37	* for kernel mappings; it is valid only for access to the kernel's static
	38	* 1:1 mapping of physical memory — not to vmalloc or even module mappings.
	39	* A future API addition may permit the use of such ranges, by means of an
	40	* explicit IOTLB flush call (akin to the DMA API's unmap method).
	41	*
	42	* It is unlikely that we will ever hook into flush_tlb_kernel_range() to
	43	* do such IOTLB flushes automatically.
	44	*/
	45	#define SVM_FLAG_SUPERVISOR_MODE (1<<1)
56722a43 JP	46	/*
	47	* The SVM_FLAG_GUEST_MODE flag is used when a PASID bind is for guest
	48	* processes. Compared to the host bind, the primary differences are:
	49	* 1. mm life cycle management
	50	* 2. fault reporting
	51	*/
	52	#define SVM_FLAG_GUEST_MODE (1<<2)
	53	/*
	54	* The SVM_FLAG_GUEST_PASID flag is used when a guest has its own PASID space,
	55	* which requires guest and host PASID translation at both directions.
	56	*/
	57	#define SVM_FLAG_GUEST_PASID (1<<3)
569e4f77	58
2f26e0a9	59	#endif /* __INTEL_SVM_H__ */