[deliverable/linux.git] / include / linux / iommu.h

/*
 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
 * Author: Joerg Roedel <joerg.roedel@amd.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#ifndef __LINUX_IOMMU_H
#define __LINUX_IOMMU_H

#include <linux/errno.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/types.h>
#include <linux/scatterlist.h>
#include <trace/events/iommu.h>

#define IOMMU_READ	(1 << 0)
#define IOMMU_WRITE	(1 << 1)
#define IOMMU_CACHE	(1 << 2) /* DMA cache coherency */
#define IOMMU_NOEXEC	(1 << 3)

struct iommu_ops;
struct iommu_group;
struct bus_type;
struct device;
struct iommu_domain;
struct notifier_block;

/* iommu fault flags */
#define IOMMU_FAULT_READ	0x0
#define IOMMU_FAULT_WRITE	0x1

typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
			struct device *, unsigned long, int, void *);

struct iommu_domain_geometry {
	dma_addr_t aperture_start; /* First address that can be mapped    */
	dma_addr_t aperture_end;   /* Last address that can be mapped     */
	bool force_aperture;       /* DMA only allowed in mappable range? */
};

/* Domain feature flags */
#define __IOMMU_DOMAIN_PAGING	(1U << 0)  /* Support for iommu_map/unmap */
#define __IOMMU_DOMAIN_DMA_API	(1U << 1)  /* Domain for use in DMA-API
					      implementation              */
#define __IOMMU_DOMAIN_PT	(1U << 2)  /* Domain is identity mapped   */

/*
 * This are the possible domain-types
 *
 *	IOMMU_DOMAIN_BLOCKED	- All DMA is blocked, can be used to isolate
 *				  devices
 *	IOMMU_DOMAIN_IDENTITY	- DMA addresses are system physical addresses
 *	IOMMU_DOMAIN_UNMANAGED	- DMA mappings managed by IOMMU-API user, used
 *				  for VMs
 *	IOMMU_DOMAIN_DMA	- Internally used for DMA-API implementations.
 *				  This flag allows IOMMU drivers to implement
 *				  certain optimizations for these domains
 */
#define IOMMU_DOMAIN_BLOCKED	(0U)
#define IOMMU_DOMAIN_IDENTITY	(__IOMMU_DOMAIN_PT)
#define IOMMU_DOMAIN_UNMANAGED	(__IOMMU_DOMAIN_PAGING)
#define IOMMU_DOMAIN_DMA	(__IOMMU_DOMAIN_PAGING |	\
				 __IOMMU_DOMAIN_DMA_API)

struct iommu_domain {
	unsigned type;
	const struct iommu_ops *ops;
	iommu_fault_handler_t handler;
	void *handler_token;
	struct iommu_domain_geometry geometry;
};

enum iommu_cap {
	IOMMU_CAP_CACHE_COHERENCY,	/* IOMMU can enforce cache coherent DMA
					   transactions */
	IOMMU_CAP_INTR_REMAP,		/* IOMMU supports interrupt isolation */
	IOMMU_CAP_NOEXEC,		/* IOMMU_NOEXEC flag */
};

/*
 * Following constraints are specifc to FSL_PAMUV1:
 *  -aperture must be power of 2, and naturally aligned
 *  -number of windows must be power of 2, and address space size
 *   of each window is determined by aperture size / # of windows
 *  -the actual size of the mapped region of a window must be power
 *   of 2 starting with 4KB and physical address must be naturally
 *   aligned.
 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
 * The caller can invoke iommu_domain_get_attr to check if the underlying
 * iommu implementation supports these constraints.
 */

enum iommu_attr {
	DOMAIN_ATTR_GEOMETRY,
	DOMAIN_ATTR_PAGING,
	DOMAIN_ATTR_WINDOWS,
	DOMAIN_ATTR_FSL_PAMU_STASH,
	DOMAIN_ATTR_FSL_PAMU_ENABLE,
	DOMAIN_ATTR_FSL_PAMUV1,
	DOMAIN_ATTR_NESTING,	/* two stages of translation */
	DOMAIN_ATTR_MAX,
};

#ifdef CONFIG_IOMMU_API

/**
 * struct iommu_ops - iommu ops and capabilities
 * @domain_init: init iommu domain
 * @domain_destroy: destroy iommu domain
 * @attach_dev: attach device to an iommu domain
 * @detach_dev: detach device from an iommu domain
 * @map: map a physically contiguous memory region to an iommu domain
 * @unmap: unmap a physically contiguous memory region from an iommu domain
 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
 * to an iommu domain
 * @iova_to_phys: translate iova to physical address
 * @add_device: add device to iommu grouping
 * @remove_device: remove device from iommu grouping
 * @domain_get_attr: Query domain attributes
 * @domain_set_attr: Change domain attributes
 * @of_xlate: add OF master IDs to iommu grouping
 * @pgsize_bitmap: bitmap of supported page sizes
 * @priv: per-instance data private to the iommu driver
 */
struct iommu_ops {
	bool (*capable)(enum iommu_cap);

	/* Domain allocation and freeing by the iommu driver */
	struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
	void (*domain_free)(struct iommu_domain *);

	int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
	void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
	int (*map)(struct iommu_domain *domain, unsigned long iova,
		   phys_addr_t paddr, size_t size, int prot);
	size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
		     size_t size);
	size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
			 struct scatterlist *sg, unsigned int nents, int prot);
	phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
	int (*add_device)(struct device *dev);
	void (*remove_device)(struct device *dev);
	int (*device_group)(struct device *dev, unsigned int *groupid);
	int (*domain_get_attr)(struct iommu_domain *domain,
			       enum iommu_attr attr, void *data);
	int (*domain_set_attr)(struct iommu_domain *domain,
			       enum iommu_attr attr, void *data);

	/* Window handling functions */
	int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
				    phys_addr_t paddr, u64 size, int prot);
	void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
	/* Set the numer of window per domain */
	int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
	/* Get the numer of window per domain */
	u32 (*domain_get_windows)(struct iommu_domain *domain);

#ifdef CONFIG_OF_IOMMU
	int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
#endif

	unsigned long pgsize_bitmap;
	void *priv;
};

#define IOMMU_GROUP_NOTIFY_ADD_DEVICE		1 /* Device added */
#define IOMMU_GROUP_NOTIFY_DEL_DEVICE		2 /* Pre Device removed */
#define IOMMU_GROUP_NOTIFY_BIND_DRIVER		3 /* Pre Driver bind */
#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER		4 /* Post Driver bind */
#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER	5 /* Pre Driver unbind */
#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER	6 /* Post Driver unbind */

extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
extern bool iommu_present(struct bus_type *bus);
extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
extern struct iommu_group *iommu_group_get_by_id(int id);
extern void iommu_domain_free(struct iommu_domain *domain);
extern int iommu_attach_device(struct iommu_domain *domain,
			       struct device *dev);
extern void iommu_detach_device(struct iommu_domain *domain,
				struct device *dev);
extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
		     phys_addr_t paddr, size_t size, int prot);
extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
		       size_t size);
extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
				struct scatterlist *sg,unsigned int nents,
				int prot);
extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
extern void iommu_set_fault_handler(struct iommu_domain *domain,
			iommu_fault_handler_t handler, void *token);

extern int iommu_attach_group(struct iommu_domain *domain,
			      struct iommu_group *group);
extern void iommu_detach_group(struct iommu_domain *domain,
			       struct iommu_group *group);
extern struct iommu_group *iommu_group_alloc(void);
extern void *iommu_group_get_iommudata(struct iommu_group *group);
extern void iommu_group_set_iommudata(struct iommu_group *group,
				      void *iommu_data,
				      void (*release)(void *iommu_data));
extern int iommu_group_set_name(struct iommu_group *group, const char *name);
extern int iommu_group_add_device(struct iommu_group *group,
				  struct device *dev);
extern void iommu_group_remove_device(struct device *dev);
extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
				    int (*fn)(struct device *, void *));
extern struct iommu_group *iommu_group_get(struct device *dev);
extern void iommu_group_put(struct iommu_group *group);
extern int iommu_group_register_notifier(struct iommu_group *group,
					 struct notifier_block *nb);
extern int iommu_group_unregister_notifier(struct iommu_group *group,
					   struct notifier_block *nb);
extern int iommu_group_id(struct iommu_group *group);
extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);

extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
				 void *data);
extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
				 void *data);
struct device *iommu_device_create(struct device *parent, void *drvdata,
				   const struct attribute_group **groups,
				   const char *fmt, ...);
void iommu_device_destroy(struct device *dev);
int iommu_device_link(struct device *dev, struct device *link);
void iommu_device_unlink(struct device *dev, struct device *link);

/* Window handling function prototypes */
extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
				      phys_addr_t offset, u64 size,
				      int prot);
extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
/**
 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 * @domain: the iommu domain where the fault has happened
 * @dev: the device where the fault has happened
 * @iova: the faulting address
 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 *
 * This function should be called by the low-level IOMMU implementations
 * whenever IOMMU faults happen, to allow high-level users, that are
 * interested in such events, to know about them.
 *
 * This event may be useful for several possible use cases:
 * - mere logging of the event
 * - dynamic TLB/PTE loading
 * - if restarting of the faulting device is required
 *
 * Returns 0 on success and an appropriate error code otherwise (if dynamic
 * PTE/TLB loading will one day be supported, implementations will be able
 * to tell whether it succeeded or not according to this return value).
 *
 * Specifically, -ENOSYS is returned if a fault handler isn't installed
 * (though fault handlers can also return -ENOSYS, in case they want to
 * elicit the default behavior of the IOMMU drivers).
 */
static inline int report_iommu_fault(struct iommu_domain *domain,
		struct device *dev, unsigned long iova, int flags)
{
	int ret = -ENOSYS;

	/*
	 * if upper layers showed interest and installed a fault handler,
	 * invoke it.
	 */
	if (domain->handler)
		ret = domain->handler(domain, dev, iova, flags,
						domain->handler_token);

	trace_io_page_fault(dev, iova, flags);
	return ret;
}

static inline size_t iommu_map_sg(struct iommu_domain *domain,
				  unsigned long iova, struct scatterlist *sg,
				  unsigned int nents, int prot)
{
	return domain->ops->map_sg(domain, iova, sg, nents, prot);
}

#else /* CONFIG_IOMMU_API */

struct iommu_ops {};
struct iommu_group {};

static inline bool iommu_present(struct bus_type *bus)
{
	return false;
}

static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
{
	return false;
}

static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
{
	return NULL;
}

static inline struct iommu_group *iommu_group_get_by_id(int id)
{
	return NULL;
}

static inline void iommu_domain_free(struct iommu_domain *domain)
{
}

static inline int iommu_attach_device(struct iommu_domain *domain,
				      struct device *dev)
{
	return -ENODEV;
}

static inline void iommu_detach_device(struct iommu_domain *domain,
				       struct device *dev)
{
}

static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
{
	return NULL;
}

static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
			    phys_addr_t paddr, int gfp_order, int prot)
{
	return -ENODEV;
}

static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
			      int gfp_order)
{
	return -ENODEV;
}

static inline size_t iommu_map_sg(struct iommu_domain *domain,
				  unsigned long iova, struct scatterlist *sg,
				  unsigned int nents, int prot)
{
	return -ENODEV;
}

static inline int iommu_domain_window_enable(struct iommu_domain *domain,
					     u32 wnd_nr, phys_addr_t paddr,
					     u64 size, int prot)
{
	return -ENODEV;
}

static inline void iommu_domain_window_disable(struct iommu_domain *domain,
					       u32 wnd_nr)
{
}

static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
{
	return 0;
}

static inline void iommu_set_fault_handler(struct iommu_domain *domain,
				iommu_fault_handler_t handler, void *token)
{
}

static inline int iommu_attach_group(struct iommu_domain *domain,
				     struct iommu_group *group)
{
	return -ENODEV;
}

static inline void iommu_detach_group(struct iommu_domain *domain,
				      struct iommu_group *group)
{
}

static inline struct iommu_group *iommu_group_alloc(void)
{
	return ERR_PTR(-ENODEV);
}

static inline void *iommu_group_get_iommudata(struct iommu_group *group)
{
	return NULL;
}

static inline void iommu_group_set_iommudata(struct iommu_group *group,
					     void *iommu_data,
					     void (*release)(void *iommu_data))
{
}

static inline int iommu_group_set_name(struct iommu_group *group,
				       const char *name)
{
	return -ENODEV;
}

static inline int iommu_group_add_device(struct iommu_group *group,
					 struct device *dev)
{
	return -ENODEV;
}

static inline void iommu_group_remove_device(struct device *dev)
{
}

static inline int iommu_group_for_each_dev(struct iommu_group *group,
					   void *data,
					   int (*fn)(struct device *, void *))
{
	return -ENODEV;
}

static inline struct iommu_group *iommu_group_get(struct device *dev)
{
	return NULL;
}

static inline void iommu_group_put(struct iommu_group *group)
{
}

static inline int iommu_group_register_notifier(struct iommu_group *group,
						struct notifier_block *nb)
{
	return -ENODEV;
}

static inline int iommu_group_unregister_notifier(struct iommu_group *group,
						  struct notifier_block *nb)
{
	return 0;
}

static inline int iommu_group_id(struct iommu_group *group)
{
	return -ENODEV;
}

static inline int iommu_domain_get_attr(struct iommu_domain *domain,
					enum iommu_attr attr, void *data)
{
	return -EINVAL;
}

static inline int iommu_domain_set_attr(struct iommu_domain *domain,
					enum iommu_attr attr, void *data)
{
	return -EINVAL;
}

static inline struct device *iommu_device_create(struct device *parent,
					void *drvdata,
					const struct attribute_group **groups,
					const char *fmt, ...)
{
	return ERR_PTR(-ENODEV);
}

static inline void iommu_device_destroy(struct device *dev)
{
}

static inline int iommu_device_link(struct device *dev, struct device *link)
{
	return -EINVAL;
}

static inline void iommu_device_unlink(struct device *dev, struct device *link)
{
}

#endif /* CONFIG_IOMMU_API */

#endif /* __LINUX_IOMMU_H */
Commit	Line	Data
4a77a6cf JR	1	/*
	2	* Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
	3	* Author: Joerg Roedel <joerg.roedel@amd.com>
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License version 2 as published
	7	* by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17	*/
	18
	19	#ifndef __LINUX_IOMMU_H
	20	#define __LINUX_IOMMU_H
	21
74315ccc	22	#include <linux/errno.h>
9a08d376	23	#include <linux/err.h>
d0f60a44	24	#include <linux/of.h>
76582d0a	25	#include <linux/types.h>
315786eb	26	#include <linux/scatterlist.h>
56fa4849	27	#include <trace/events/iommu.h>
74315ccc	28
ca13bb3d WD	29	#define IOMMU_READ (1 << 0)
	30	#define IOMMU_WRITE (1 << 1)
	31	#define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
a720b41c	32	#define IOMMU_NOEXEC (1 << 3)
4a77a6cf	33
905d66c1	34	struct iommu_ops;
d72e31c9	35	struct iommu_group;
ff21776d	36	struct bus_type;
4a77a6cf	37	struct device;
4f3f8d9d	38	struct iommu_domain;
ba1eabfa	39	struct notifier_block;
4f3f8d9d OBC	40
	41	/* iommu fault flags */
	42	#define IOMMU_FAULT_READ 0x0
	43	#define IOMMU_FAULT_WRITE 0x1
	44
	45	typedef int (iommu_fault_handler_t)(struct iommu_domain ,
77ca2332	46	struct device , unsigned long, int, void );
4a77a6cf	47
0ff64f80 JR	48	struct iommu_domain_geometry {
	49	dma_addr_t aperture_start; /* First address that can be mapped */
	50	dma_addr_t aperture_end; /* Last address that can be mapped */
	51	bool force_aperture; /* DMA only allowed in mappable range? */
	52	};
	53
8539c7c1 JR	54	/* Domain feature flags */
	55	#define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
	56	#define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
	57	implementation */
	58	#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
	59
	60	/*
	61	* This are the possible domain-types
	62	*
	63	* IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
	64	* devices
	65	* IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
	66	* IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
	67	* for VMs
	68	* IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
	69	* This flag allows IOMMU drivers to implement
	70	* certain optimizations for these domains
	71	*/
	72	#define IOMMU_DOMAIN_BLOCKED (0U)
	73	#define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
	74	#define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
	75	#define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING \| \
	76	__IOMMU_DOMAIN_DMA_API)
	77
4a77a6cf	78	struct iommu_domain {
8539c7c1	79	unsigned type;
b22f6434	80	const struct iommu_ops *ops;
4f3f8d9d	81	iommu_fault_handler_t handler;
77ca2332	82	void *handler_token;
0ff64f80	83	struct iommu_domain_geometry geometry;
4a77a6cf JR	84	};
4a77a6cf JR	85
1aed0748 JR	86	enum iommu_cap {
	87	IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
	88	transactions */
	89	IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
c4986649	90	IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
1aed0748	91	};
dbb9fd86	92
7cabf491 VS	93	/*
	94	* Following constraints are specifc to FSL_PAMUV1:
	95	* -aperture must be power of 2, and naturally aligned
	96	* -number of windows must be power of 2, and address space size
	97	* of each window is determined by aperture size / # of windows
	98	* -the actual size of the mapped region of a window must be power
	99	* of 2 starting with 4KB and physical address must be naturally
	100	* aligned.
	101	* DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
	102	* The caller can invoke iommu_domain_get_attr to check if the underlying
	103	* iommu implementation supports these constraints.
	104	*/
	105
0cd76dd1	106	enum iommu_attr {
0ff64f80	107	DOMAIN_ATTR_GEOMETRY,
d2e12160	108	DOMAIN_ATTR_PAGING,
69356712	109	DOMAIN_ATTR_WINDOWS,
7cabf491 VS	110	DOMAIN_ATTR_FSL_PAMU_STASH,
	111	DOMAIN_ATTR_FSL_PAMU_ENABLE,
	112	DOMAIN_ATTR_FSL_PAMUV1,
c02607aa	113	DOMAIN_ATTR_NESTING, /* two stages of translation */
a8b8a88a	114	DOMAIN_ATTR_MAX,
0cd76dd1 JR	115	};
0cd76dd1 JR	116
39d4ebb9 JR	117	#ifdef CONFIG_IOMMU_API
39d4ebb9 JR	118
7d3002cc OBC	119	/**
	120	* struct iommu_ops - iommu ops and capabilities
	121	* @domain_init: init iommu domain
	122	* @domain_destroy: destroy iommu domain
	123	* @attach_dev: attach device to an iommu domain
	124	* @detach_dev: detach device from an iommu domain
	125	* @map: map a physically contiguous memory region to an iommu domain
	126	* @unmap: unmap a physically contiguous memory region from an iommu domain
315786eb OH	127	* @map_sg: map a scatter-gather list of physically contiguous memory chunks
315786eb OH	128	* to an iommu domain
7d3002cc	129	* @iova_to_phys: translate iova to physical address
d72e31c9 AW	130	* @add_device: add device to iommu grouping
d72e31c9 AW	131	* @remove_device: remove device from iommu grouping
0cd76dd1 JR	132	* @domain_get_attr: Query domain attributes
0cd76dd1 JR	133	* @domain_set_attr: Change domain attributes
d0f60a44	134	* @of_xlate: add OF master IDs to iommu grouping
7d3002cc	135	* @pgsize_bitmap: bitmap of supported page sizes
1cd076bf	136	* @priv: per-instance data private to the iommu driver
7d3002cc	137	*/
4a77a6cf	138	struct iommu_ops {
3c0e0ca0	139	bool (*capable)(enum iommu_cap);
938c4709 JR	140
938c4709 JR	141	/* Domain allocation and freeing by the iommu driver */
8539c7c1	142	struct iommu_domain (domain_alloc)(unsigned iommu_domain_type);
938c4709 JR	143	void (domain_free)(struct iommu_domain );
938c4709 JR	144
4a77a6cf JR	145	int (attach_dev)(struct iommu_domain domain, struct device *dev);
4a77a6cf JR	146	void (detach_dev)(struct iommu_domain domain, struct device *dev);
67651786	147	int (map)(struct iommu_domain domain, unsigned long iova,
5009065d OBC	148	phys_addr_t paddr, size_t size, int prot);
	149	size_t (unmap)(struct iommu_domain domain, unsigned long iova,
	150	size_t size);
315786eb OH	151	size_t (map_sg)(struct iommu_domain domain, unsigned long iova,
315786eb OH	152	struct scatterlist *sg, unsigned int nents, int prot);
bb5547ac	153	phys_addr_t (iova_to_phys)(struct iommu_domain domain, dma_addr_t iova);
d72e31c9 AW	154	int (add_device)(struct device dev);
d72e31c9 AW	155	void (remove_device)(struct device dev);
1460432c	156	int (device_group)(struct device dev, unsigned int *groupid);
0cd76dd1 JR	157	int (domain_get_attr)(struct iommu_domain domain,
	158	enum iommu_attr attr, void *data);
	159	int (domain_set_attr)(struct iommu_domain domain,
	160	enum iommu_attr attr, void *data);
d7787d57 JR	161
	162	/* Window handling functions */
	163	int (domain_window_enable)(struct iommu_domain domain, u32 wnd_nr,
80f97f0f	164	phys_addr_t paddr, u64 size, int prot);
d7787d57	165	void (domain_window_disable)(struct iommu_domain domain, u32 wnd_nr);
69356712 JR	166	/* Set the numer of window per domain */
	167	int (domain_set_windows)(struct iommu_domain domain, u32 w_count);
	168	/* Get the numer of window per domain */
	169	u32 (domain_get_windows)(struct iommu_domain domain);
d7787d57	170
d0f60a44 WD	171	#ifdef CONFIG_OF_IOMMU
	172	int (of_xlate)(struct device dev, struct of_phandle_args *args);
	173	#endif
	174
7d3002cc	175	unsigned long pgsize_bitmap;
1cd076bf	176	void *priv;
4a77a6cf JR	177	};
4a77a6cf JR	178
d72e31c9 AW	179	#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
	180	#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
	181	#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
	182	#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
	183	#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
	184	#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
	185
b22f6434	186	extern int bus_set_iommu(struct bus_type bus, const struct iommu_ops ops);
a1b60c1c	187	extern bool iommu_present(struct bus_type *bus);
3c0e0ca0	188	extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
905d66c1	189	extern struct iommu_domain iommu_domain_alloc(struct bus_type bus);
aa16bea9	190	extern struct iommu_group *iommu_group_get_by_id(int id);
4a77a6cf JR	191	extern void iommu_domain_free(struct iommu_domain *domain);
	192	extern int iommu_attach_device(struct iommu_domain *domain,
	193	struct device *dev);
	194	extern void iommu_detach_device(struct iommu_domain *domain,
	195	struct device *dev);
2c1296d9	196	extern struct iommu_domain iommu_get_domain_for_dev(struct device dev);
cefc53c7	197	extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
7d3002cc OBC	198	phys_addr_t paddr, size_t size, int prot);
	199	extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
	200	size_t size);
315786eb OH	201	extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
	202	struct scatterlist *sg,unsigned int nents,
	203	int prot);
bb5547ac	204	extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
4f3f8d9d	205	extern void iommu_set_fault_handler(struct iommu_domain *domain,
77ca2332	206	iommu_fault_handler_t handler, void *token);
d72e31c9 AW	207
	208	extern int iommu_attach_group(struct iommu_domain *domain,
	209	struct iommu_group *group);
	210	extern void iommu_detach_group(struct iommu_domain *domain,
	211	struct iommu_group *group);
	212	extern struct iommu_group *iommu_group_alloc(void);
	213	extern void iommu_group_get_iommudata(struct iommu_group group);
	214	extern void iommu_group_set_iommudata(struct iommu_group *group,
	215	void *iommu_data,
	216	void (release)(void iommu_data));
	217	extern int iommu_group_set_name(struct iommu_group group, const char name);
	218	extern int iommu_group_add_device(struct iommu_group *group,
	219	struct device *dev);
	220	extern void iommu_group_remove_device(struct device *dev);
	221	extern int iommu_group_for_each_dev(struct iommu_group group, void data,
	222	int (fn)(struct device , void *));
	223	extern struct iommu_group iommu_group_get(struct device dev);
	224	extern void iommu_group_put(struct iommu_group *group);
	225	extern int iommu_group_register_notifier(struct iommu_group *group,
	226	struct notifier_block *nb);
	227	extern int iommu_group_unregister_notifier(struct iommu_group *group,
	228	struct notifier_block *nb);
	229	extern int iommu_group_id(struct iommu_group *group);
104a1c13	230	extern struct iommu_group iommu_group_get_for_dev(struct device dev);
4f3f8d9d	231
0cd76dd1 JR	232	extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
	233	void *data);
	234	extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
	235	void *data);
c61959ec AW	236	struct device iommu_device_create(struct device parent, void *drvdata,
	237	const struct attribute_group **groups,
	238	const char *fmt, ...);
	239	void iommu_device_destroy(struct device *dev);
	240	int iommu_device_link(struct device dev, struct device link);
	241	void iommu_device_unlink(struct device dev, struct device link);
4f3f8d9d	242
d7787d57 JR	243	/* Window handling function prototypes */
d7787d57 JR	244	extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
80f97f0f VS	245	phys_addr_t offset, u64 size,
80f97f0f VS	246	int prot);
d7787d57	247	extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
4f3f8d9d OBC	248	/**
	249	* report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
	250	* @domain: the iommu domain where the fault has happened
	251	* @dev: the device where the fault has happened
	252	* @iova: the faulting address
	253	* @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
	254	*
	255	* This function should be called by the low-level IOMMU implementations
	256	* whenever IOMMU faults happen, to allow high-level users, that are
	257	* interested in such events, to know about them.
	258	*
	259	* This event may be useful for several possible use cases:
	260	* - mere logging of the event
	261	* - dynamic TLB/PTE loading
	262	* - if restarting of the faulting device is required
	263	*
	264	* Returns 0 on success and an appropriate error code otherwise (if dynamic
	265	* PTE/TLB loading will one day be supported, implementations will be able
	266	* to tell whether it succeeded or not according to this return value).
0ed6d2d2 OBC	267	*
	268	* Specifically, -ENOSYS is returned if a fault handler isn't installed
	269	* (though fault handlers can also return -ENOSYS, in case they want to
	270	* elicit the default behavior of the IOMMU drivers).
4f3f8d9d OBC	271	*/
	272	static inline int report_iommu_fault(struct iommu_domain *domain,
	273	struct device *dev, unsigned long iova, int flags)
	274	{
0ed6d2d2	275	int ret = -ENOSYS;
4a77a6cf	276
4f3f8d9d OBC	277	/*
	278	* if upper layers showed interest and installed a fault handler,
	279	* invoke it.
	280	*/
	281	if (domain->handler)
77ca2332 OBC	282	ret = domain->handler(domain, dev, iova, flags,
77ca2332 OBC	283	domain->handler_token);
4a77a6cf	284
56fa4849	285	trace_io_page_fault(dev, iova, flags);
4f3f8d9d	286	return ret;
4a77a6cf JR	287	}
4a77a6cf JR	288
315786eb OH	289	static inline size_t iommu_map_sg(struct iommu_domain *domain,
	290	unsigned long iova, struct scatterlist *sg,
	291	unsigned int nents, int prot)
	292	{
	293	return domain->ops->map_sg(domain, iova, sg, nents, prot);
	294	}
	295
4a77a6cf JR	296	#else /* CONFIG_IOMMU_API */
4a77a6cf JR	297
39d4ebb9	298	struct iommu_ops {};
d72e31c9	299	struct iommu_group {};
4a77a6cf	300
a1b60c1c	301	static inline bool iommu_present(struct bus_type *bus)
4a77a6cf JR	302	{
	303	return false;
	304	}
	305
3c0e0ca0 JR	306	static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
	307	{
	308	return false;
	309	}
	310
905d66c1	311	static inline struct iommu_domain iommu_domain_alloc(struct bus_type bus)
4a77a6cf JR	312	{
	313	return NULL;
	314	}
	315
b62dfd29 AK	316	static inline struct iommu_group *iommu_group_get_by_id(int id)
	317	{
	318	return NULL;
	319	}
	320
4a77a6cf JR	321	static inline void iommu_domain_free(struct iommu_domain *domain)
	322	{
	323	}
	324
	325	static inline int iommu_attach_device(struct iommu_domain *domain,
	326	struct device *dev)
	327	{
	328	return -ENODEV;
	329	}
	330
	331	static inline void iommu_detach_device(struct iommu_domain *domain,
	332	struct device *dev)
	333	{
	334	}
	335
2c1296d9 JR	336	static inline struct iommu_domain iommu_get_domain_for_dev(struct device dev)
	337	{
	338	return NULL;
	339	}
	340
cefc53c7 JR	341	static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
	342	phys_addr_t paddr, int gfp_order, int prot)
	343	{
	344	return -ENODEV;
	345	}
	346
	347	static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
	348	int gfp_order)
	349	{
	350	return -ENODEV;
	351	}
	352
315786eb OH	353	static inline size_t iommu_map_sg(struct iommu_domain *domain,
	354	unsigned long iova, struct scatterlist *sg,
	355	unsigned int nents, int prot)
	356	{
	357	return -ENODEV;
	358	}
	359
d7787d57 JR	360	static inline int iommu_domain_window_enable(struct iommu_domain *domain,
d7787d57 JR	361	u32 wnd_nr, phys_addr_t paddr,
80f97f0f	362	u64 size, int prot)
d7787d57 JR	363	{
	364	return -ENODEV;
	365	}
	366
	367	static inline void iommu_domain_window_disable(struct iommu_domain *domain,
	368	u32 wnd_nr)
	369	{
	370	}
	371
bb5547ac	372	static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
4a77a6cf JR	373	{
	374	return 0;
	375	}
	376
4f3f8d9d	377	static inline void iommu_set_fault_handler(struct iommu_domain *domain,
77ca2332	378	iommu_fault_handler_t handler, void *token)
4f3f8d9d OBC	379	{
	380	}
	381
bef83de5 AW	382	static inline int iommu_attach_group(struct iommu_domain *domain,
bef83de5 AW	383	struct iommu_group *group)
d72e31c9 AW	384	{
	385	return -ENODEV;
	386	}
	387
bef83de5 AW	388	static inline void iommu_detach_group(struct iommu_domain *domain,
bef83de5 AW	389	struct iommu_group *group)
d72e31c9 AW	390	{
	391	}
	392
bef83de5	393	static inline struct iommu_group *iommu_group_alloc(void)
d72e31c9 AW	394	{
	395	return ERR_PTR(-ENODEV);
	396	}
	397
bef83de5	398	static inline void iommu_group_get_iommudata(struct iommu_group group)
d72e31c9 AW	399	{
	400	return NULL;
	401	}
	402
bef83de5 AW	403	static inline void iommu_group_set_iommudata(struct iommu_group *group,
	404	void *iommu_data,
	405	void (release)(void iommu_data))
d72e31c9 AW	406	{
	407	}
	408
bef83de5 AW	409	static inline int iommu_group_set_name(struct iommu_group *group,
bef83de5 AW	410	const char *name)
d72e31c9 AW	411	{
	412	return -ENODEV;
	413	}
	414
bef83de5 AW	415	static inline int iommu_group_add_device(struct iommu_group *group,
bef83de5 AW	416	struct device *dev)
d72e31c9 AW	417	{
	418	return -ENODEV;
	419	}
	420
bef83de5	421	static inline void iommu_group_remove_device(struct device *dev)
d72e31c9 AW	422	{
	423	}
	424
bef83de5 AW	425	static inline int iommu_group_for_each_dev(struct iommu_group *group,
	426	void *data,
	427	int (fn)(struct device , void *))
d72e31c9 AW	428	{
	429	return -ENODEV;
	430	}
	431
bef83de5	432	static inline struct iommu_group iommu_group_get(struct device dev)
d72e31c9 AW	433	{
	434	return NULL;
	435	}
	436
bef83de5	437	static inline void iommu_group_put(struct iommu_group *group)
d72e31c9 AW	438	{
	439	}
	440
bef83de5 AW	441	static inline int iommu_group_register_notifier(struct iommu_group *group,
bef83de5 AW	442	struct notifier_block *nb)
1460432c AW	443	{
	444	return -ENODEV;
	445	}
	446
bef83de5 AW	447	static inline int iommu_group_unregister_notifier(struct iommu_group *group,
bef83de5 AW	448	struct notifier_block *nb)
d72e31c9 AW	449	{
	450	return 0;
	451	}
	452
bef83de5	453	static inline int iommu_group_id(struct iommu_group *group)
d72e31c9 AW	454	{
	455	return -ENODEV;
	456	}
1460432c	457
0cd76dd1 JR	458	static inline int iommu_domain_get_attr(struct iommu_domain *domain,
	459	enum iommu_attr attr, void *data)
	460	{
	461	return -EINVAL;
	462	}
	463
	464	static inline int iommu_domain_set_attr(struct iommu_domain *domain,
	465	enum iommu_attr attr, void *data)
	466	{
	467	return -EINVAL;
	468	}
	469
e09f8ea5 AW	470	static inline struct device iommu_device_create(struct device parent,
	471	void *drvdata,
	472	const struct attribute_group **groups,
	473	const char *fmt, ...)
c61959ec AW	474	{
	475	return ERR_PTR(-ENODEV);
	476	}
	477
e09f8ea5	478	static inline void iommu_device_destroy(struct device *dev)
c61959ec AW	479	{
	480	}
	481
e09f8ea5	482	static inline int iommu_device_link(struct device dev, struct device link)
c61959ec AW	483	{
	484	return -EINVAL;
	485	}
	486
e09f8ea5	487	static inline void iommu_device_unlink(struct device dev, struct device link)
c61959ec AW	488	{
	489	}
	490
4a77a6cf JR	491	#endif /* CONFIG_IOMMU_API */
	492
	493	#endif /* __LINUX_IOMMU_H */