[mirror_ubuntu-artful-kernel.git] / include / linux / dma-mapping.h

#ifndef _LINUX_DMA_MAPPING_H
#define _LINUX_DMA_MAPPING_H

#include <linux/device.h>
#include <linux/err.h>
#include <linux/dma-attrs.h>
#include <linux/scatterlist.h>

/* These definitions mirror those in pci.h, so they can be used
 * interchangeably with their PCI_ counterparts */
enum dma_data_direction {
	DMA_BIDIRECTIONAL = 0,
	DMA_TO_DEVICE = 1,
	DMA_FROM_DEVICE = 2,
	DMA_NONE = 3,
};

struct dma_map_ops {
	void* (*alloc_coherent)(struct device *dev, size_t size,
				dma_addr_t *dma_handle, gfp_t gfp);
	void (*free_coherent)(struct device *dev, size_t size,
			      void *vaddr, dma_addr_t dma_handle);
	dma_addr_t (*map_page)(struct device *dev, struct page *page,
			       unsigned long offset, size_t size,
			       enum dma_data_direction dir,
			       struct dma_attrs *attrs);
	void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
			   size_t size, enum dma_data_direction dir,
			   struct dma_attrs *attrs);
	int (*map_sg)(struct device *dev, struct scatterlist *sg,
		      int nents, enum dma_data_direction dir,
		      struct dma_attrs *attrs);
	void (*unmap_sg)(struct device *dev,
			 struct scatterlist *sg, int nents,
			 enum dma_data_direction dir,
			 struct dma_attrs *attrs);
	void (*sync_single_for_cpu)(struct device *dev,
				    dma_addr_t dma_handle, size_t size,
				    enum dma_data_direction dir);
	void (*sync_single_for_device)(struct device *dev,
				       dma_addr_t dma_handle, size_t size,
				       enum dma_data_direction dir);
	void (*sync_single_range_for_cpu)(struct device *dev,
					  dma_addr_t dma_handle,
					  unsigned long offset,
					  size_t size,
					  enum dma_data_direction dir);
	void (*sync_single_range_for_device)(struct device *dev,
					     dma_addr_t dma_handle,
					     unsigned long offset,
					     size_t size,
					     enum dma_data_direction dir);
	void (*sync_sg_for_cpu)(struct device *dev,
				struct scatterlist *sg, int nents,
				enum dma_data_direction dir);
	void (*sync_sg_for_device)(struct device *dev,
				   struct scatterlist *sg, int nents,
				   enum dma_data_direction dir);
	int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
	int (*dma_supported)(struct device *dev, u64 mask);
	int is_phys;
};

#define DMA_BIT_MASK(n)	(((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))

typedef u64 DMA_nnBIT_MASK __deprecated;

/*
 * NOTE: do not use the below macros in new code and do not add new definitions
 * here.
 *
 * Instead, just open-code DMA_BIT_MASK(n) within your driver
 */
#define DMA_64BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(64)
#define DMA_48BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(48)
#define DMA_47BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(47)
#define DMA_40BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(40)
#define DMA_39BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(39)
#define DMA_35BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(35)
#define DMA_32BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(32)
#define DMA_31BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(31)
#define DMA_30BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(30)
#define DMA_29BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(29)
#define DMA_28BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(28)
#define DMA_24BIT_MASK	(DMA_nnBIT_MASK)DMA_BIT_MASK(24)

#define DMA_MASK_NONE	0x0ULL

static inline int valid_dma_direction(int dma_direction)
{
	return ((dma_direction == DMA_BIDIRECTIONAL) ||
		(dma_direction == DMA_TO_DEVICE) ||
		(dma_direction == DMA_FROM_DEVICE));
}

static inline int is_device_dma_capable(struct device *dev)
{
	return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
}

#ifdef CONFIG_HAS_DMA
#include <asm/dma-mapping.h>
#else
#include <asm-generic/dma-mapping-broken.h>
#endif

/* for backwards compatibility, removed soon */
static inline void __deprecated dma_sync_single(struct device *dev,
						dma_addr_t addr, size_t size,
						enum dma_data_direction dir)
{
	dma_sync_single_for_cpu(dev, addr, size, dir);
}

static inline void __deprecated dma_sync_sg(struct device *dev,
					    struct scatterlist *sg, int nelems,
					    enum dma_data_direction dir)
{
	dma_sync_sg_for_cpu(dev, sg, nelems, dir);
}

static inline u64 dma_get_mask(struct device *dev)
{
	if (dev && dev->dma_mask && *dev->dma_mask)
		return *dev->dma_mask;
	return DMA_BIT_MASK(32);
}

extern u64 dma_get_required_mask(struct device *dev);

static inline unsigned int dma_get_max_seg_size(struct device *dev)
{
	return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
}

static inline unsigned int dma_set_max_seg_size(struct device *dev,
						unsigned int size)
{
	if (dev->dma_parms) {
		dev->dma_parms->max_segment_size = size;
		return 0;
	} else
		return -EIO;
}

static inline unsigned long dma_get_seg_boundary(struct device *dev)
{
	return dev->dma_parms ?
		dev->dma_parms->segment_boundary_mask : 0xffffffff;
}

static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
{
	if (dev->dma_parms) {
		dev->dma_parms->segment_boundary_mask = mask;
		return 0;
	} else
		return -EIO;
}

/* flags for the coherent memory api */
#define	DMA_MEMORY_MAP			0x01
#define DMA_MEMORY_IO			0x02
#define DMA_MEMORY_INCLUDES_CHILDREN	0x04
#define DMA_MEMORY_EXCLUSIVE		0x08

#ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
static inline int
dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
			    dma_addr_t device_addr, size_t size, int flags)
{
	return 0;
}

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

static inline void *
dma_mark_declared_memory_occupied(struct device *dev,
				  dma_addr_t device_addr, size_t size)
{
	return ERR_PTR(-EBUSY);
}
#endif

/*
 * Managed DMA API
 */
extern void *dmam_alloc_coherent(struct device *dev, size_t size,
				 dma_addr_t *dma_handle, gfp_t gfp);
extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
			       dma_addr_t dma_handle);
extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
				    dma_addr_t *dma_handle, gfp_t gfp);
extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
				  dma_addr_t dma_handle);
#ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
					dma_addr_t device_addr, size_t size,
					int flags);
extern void dmam_release_declared_memory(struct device *dev);
#else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
static inline int dmam_declare_coherent_memory(struct device *dev,
				dma_addr_t bus_addr, dma_addr_t device_addr,
				size_t size, gfp_t gfp)
{
	return 0;
}

static inline void dmam_release_declared_memory(struct device *dev)
{
}
#endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */

#ifndef CONFIG_HAVE_DMA_ATTRS
struct dma_attrs;

#define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
	dma_map_single(dev, cpu_addr, size, dir)

#define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
	dma_unmap_single(dev, dma_addr, size, dir)

#define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
	dma_map_sg(dev, sgl, nents, dir)

#define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
	dma_unmap_sg(dev, sgl, nents, dir)

#endif /* CONFIG_HAVE_DMA_ATTRS */

#endif
Commit	Line	Data
96532bab RD	1	#ifndef _LINUX_DMA_MAPPING_H
96532bab RD	2	#define _LINUX_DMA_MAPPING_H
1da177e4 LT	3
	4	#include <linux/device.h>
	5	#include <linux/err.h>
f0402a26 FT	6	#include <linux/dma-attrs.h>
f0402a26 FT	7	#include <linux/scatterlist.h>
1da177e4 LT	8
	9	/* These definitions mirror those in pci.h, so they can be used
	10	* interchangeably with their PCI_ counterparts */
	11	enum dma_data_direction {
	12	DMA_BIDIRECTIONAL = 0,
	13	DMA_TO_DEVICE = 1,
	14	DMA_FROM_DEVICE = 2,
	15	DMA_NONE = 3,
	16	};
	17
f0402a26 FT	18	struct dma_map_ops {
	19	void* (alloc_coherent)(struct device dev, size_t size,
	20	dma_addr_t *dma_handle, gfp_t gfp);
	21	void (free_coherent)(struct device dev, size_t size,
	22	void *vaddr, dma_addr_t dma_handle);
	23	dma_addr_t (map_page)(struct device dev, struct page *page,
	24	unsigned long offset, size_t size,
	25	enum dma_data_direction dir,
	26	struct dma_attrs *attrs);
	27	void (unmap_page)(struct device dev, dma_addr_t dma_handle,
	28	size_t size, enum dma_data_direction dir,
	29	struct dma_attrs *attrs);
	30	int (map_sg)(struct device dev, struct scatterlist *sg,
	31	int nents, enum dma_data_direction dir,
	32	struct dma_attrs *attrs);
	33	void (unmap_sg)(struct device dev,
	34	struct scatterlist *sg, int nents,
	35	enum dma_data_direction dir,
	36	struct dma_attrs *attrs);
	37	void (sync_single_for_cpu)(struct device dev,
	38	dma_addr_t dma_handle, size_t size,
	39	enum dma_data_direction dir);
	40	void (sync_single_for_device)(struct device dev,
	41	dma_addr_t dma_handle, size_t size,
	42	enum dma_data_direction dir);
	43	void (sync_single_range_for_cpu)(struct device dev,
	44	dma_addr_t dma_handle,
	45	unsigned long offset,
	46	size_t size,
	47	enum dma_data_direction dir);
	48	void (sync_single_range_for_device)(struct device dev,
	49	dma_addr_t dma_handle,
	50	unsigned long offset,
	51	size_t size,
	52	enum dma_data_direction dir);
	53	void (sync_sg_for_cpu)(struct device dev,
	54	struct scatterlist *sg, int nents,
	55	enum dma_data_direction dir);
	56	void (sync_sg_for_device)(struct device dev,
	57	struct scatterlist *sg, int nents,
	58	enum dma_data_direction dir);
	59	int (mapping_error)(struct device dev, dma_addr_t dma_addr);
	60	int (dma_supported)(struct device dev, u64 mask);
	61	int is_phys;
	62	};
	63
8f286c33	64	#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
34c65384	65
d68412b6 JS	66	typedef u64 DMA_nnBIT_MASK __deprecated;
d68412b6 JS	67
8f286c33 AM	68	/*
	69	* NOTE: do not use the below macros in new code and do not add new definitions
	70	* here.
	71	*
	72	* Instead, just open-code DMA_BIT_MASK(n) within your driver
	73	*/
d68412b6 JS	74	#define DMA_64BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(64)
	75	#define DMA_48BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(48)
	76	#define DMA_47BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(47)
	77	#define DMA_40BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(40)
	78	#define DMA_39BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(39)
	79	#define DMA_35BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(35)
	80	#define DMA_32BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(32)
	81	#define DMA_31BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(31)
	82	#define DMA_30BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(30)
	83	#define DMA_29BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(29)
	84	#define DMA_28BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(28)
	85	#define DMA_24BIT_MASK (DMA_nnBIT_MASK)DMA_BIT_MASK(24)
1da177e4	86
32e8f702 JB	87	#define DMA_MASK_NONE 0x0ULL
32e8f702 JB	88
d6bd3a39 REB	89	static inline int valid_dma_direction(int dma_direction)
	90	{
	91	return ((dma_direction == DMA_BIDIRECTIONAL) \|\|
	92	(dma_direction == DMA_TO_DEVICE) \|\|
	93	(dma_direction == DMA_FROM_DEVICE));
	94	}
	95
32e8f702 JB	96	static inline int is_device_dma_capable(struct device *dev)
	97	{
	98	return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
	99	}
	100
1b0fac45	101	#ifdef CONFIG_HAS_DMA
1da177e4	102	#include <asm/dma-mapping.h>
1b0fac45 DW	103	#else
	104	#include <asm-generic/dma-mapping-broken.h>
	105	#endif
1da177e4	106
dbe6f186 FT	107	/* for backwards compatibility, removed soon */
	108	static inline void __deprecated dma_sync_single(struct device *dev,
	109	dma_addr_t addr, size_t size,
	110	enum dma_data_direction dir)
	111	{
	112	dma_sync_single_for_cpu(dev, addr, size, dir);
	113	}
	114
	115	static inline void __deprecated dma_sync_sg(struct device *dev,
	116	struct scatterlist *sg, int nelems,
	117	enum dma_data_direction dir)
	118	{
	119	dma_sync_sg_for_cpu(dev, sg, nelems, dir);
	120	}
1da177e4	121
589fc9a6 FT	122	static inline u64 dma_get_mask(struct device *dev)
589fc9a6 FT	123	{
07a2c01a	124	if (dev && dev->dma_mask && *dev->dma_mask)
589fc9a6	125	return *dev->dma_mask;
284901a9	126	return DMA_BIT_MASK(32);
589fc9a6 FT	127	}
589fc9a6 FT	128
1da177e4 LT	129	extern u64 dma_get_required_mask(struct device *dev);
1da177e4 LT	130
6b7b6510 FT	131	static inline unsigned int dma_get_max_seg_size(struct device *dev)
	132	{
	133	return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
	134	}
	135
	136	static inline unsigned int dma_set_max_seg_size(struct device *dev,
	137	unsigned int size)
	138	{
	139	if (dev->dma_parms) {
	140	dev->dma_parms->max_segment_size = size;
	141	return 0;
	142	} else
	143	return -EIO;
	144	}
	145
d22a6966 FT	146	static inline unsigned long dma_get_seg_boundary(struct device *dev)
	147	{
	148	return dev->dma_parms ?
	149	dev->dma_parms->segment_boundary_mask : 0xffffffff;
	150	}
	151
	152	static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
	153	{
	154	if (dev->dma_parms) {
	155	dev->dma_parms->segment_boundary_mask = mask;
	156	return 0;
	157	} else
	158	return -EIO;
	159	}
	160
1da177e4 LT	161	/* flags for the coherent memory api */
	162	#define DMA_MEMORY_MAP 0x01
	163	#define DMA_MEMORY_IO 0x02
	164	#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
	165	#define DMA_MEMORY_EXCLUSIVE 0x08
	166
	167	#ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
	168	static inline int
	169	dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
	170	dma_addr_t device_addr, size_t size, int flags)
	171	{
	172	return 0;
	173	}
	174
	175	static inline void
	176	dma_release_declared_memory(struct device *dev)
	177	{
	178	}
	179
	180	static inline void *
	181	dma_mark_declared_memory_occupied(struct device *dev,
	182	dma_addr_t device_addr, size_t size)
	183	{
	184	return ERR_PTR(-EBUSY);
	185	}
	186	#endif
	187
9ac7849e TH	188	/*
	189	* Managed DMA API
	190	*/
	191	extern void dmam_alloc_coherent(struct device dev, size_t size,
	192	dma_addr_t *dma_handle, gfp_t gfp);
	193	extern void dmam_free_coherent(struct device dev, size_t size, void vaddr,
	194	dma_addr_t dma_handle);
	195	extern void dmam_alloc_noncoherent(struct device dev, size_t size,
	196	dma_addr_t *dma_handle, gfp_t gfp);
	197	extern void dmam_free_noncoherent(struct device dev, size_t size, void vaddr,
	198	dma_addr_t dma_handle);
	199	#ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
	200	extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
	201	dma_addr_t device_addr, size_t size,
	202	int flags);
	203	extern void dmam_release_declared_memory(struct device *dev);
	204	#else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
	205	static inline int dmam_declare_coherent_memory(struct device *dev,
	206	dma_addr_t bus_addr, dma_addr_t device_addr,
	207	size_t size, gfp_t gfp)
	208	{
	209	return 0;
	210	}
1da177e4	211
9ac7849e TH	212	static inline void dmam_release_declared_memory(struct device *dev)
	213	{
	214	}
	215	#endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
1da177e4	216
74bc7cee AK	217	#ifndef CONFIG_HAVE_DMA_ATTRS
	218	struct dma_attrs;
	219
	220	#define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
	221	dma_map_single(dev, cpu_addr, size, dir)
	222
	223	#define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
	224	dma_unmap_single(dev, dma_addr, size, dir)
	225
	226	#define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
	227	dma_map_sg(dev, sgl, nents, dir)
	228
	229	#define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
	230	dma_unmap_sg(dev, sgl, nents, dir)
	231
	232	#endif /* CONFIG_HAVE_DMA_ATTRS */
	233
9ac7849e	234	#endif