[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 <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
 * @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
 * @priv: per-instance data private to the iommu driver
 */
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);
	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;
	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 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 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;
}

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