[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/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_EXEC	(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? */
};

struct iommu_domain {
	const struct iommu_ops *ops;
	void *priv;
	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 */
};

/*
 * 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
 * @pgsize_bitmap: bitmap of supported page sizes
 */
struct iommu_ops {
	bool (*capable)(enum iommu_cap);
	int (*domain_init)(struct iommu_domain *domain);
	void (*domain_destroy)(struct iommu_domain *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);

	unsigned long pgsize_bitmap;
};

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