blob: dfc099e56a66187ba9d223eea924da5650e462bf [file] [log] [blame]
Robert P. J. Day96532ba2008-02-03 15:06:26 +02001#ifndef _LINUX_DMA_MAPPING_H
2#define _LINUX_DMA_MAPPING_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
Andrew Morton842fa692011-11-02 13:39:33 -07004#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/device.h>
6#include <linux/err.h>
FUJITA Tomonorif0402a22009-01-05 23:59:01 +09007#include <linux/dma-attrs.h>
Alexey Dobriyanb7f080c2011-06-16 11:01:34 +00008#include <linux/dma-direction.h>
FUJITA Tomonorif0402a22009-01-05 23:59:01 +09009#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090011struct dma_map_ops {
Marek Szyprowski613c4572012-03-28 16:36:27 +020012 void* (*alloc)(struct device *dev, size_t size,
13 dma_addr_t *dma_handle, gfp_t gfp,
14 struct dma_attrs *attrs);
15 void (*free)(struct device *dev, size_t size,
16 void *vaddr, dma_addr_t dma_handle,
17 struct dma_attrs *attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010018 int (*mmap)(struct device *, struct vm_area_struct *,
19 void *, dma_addr_t, size_t, struct dma_attrs *attrs);
20
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090021 dma_addr_t (*map_page)(struct device *dev, struct page *page,
22 unsigned long offset, size_t size,
23 enum dma_data_direction dir,
24 struct dma_attrs *attrs);
25 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
26 size_t size, enum dma_data_direction dir,
27 struct dma_attrs *attrs);
28 int (*map_sg)(struct device *dev, struct scatterlist *sg,
29 int nents, enum dma_data_direction dir,
30 struct dma_attrs *attrs);
31 void (*unmap_sg)(struct device *dev,
32 struct scatterlist *sg, int nents,
33 enum dma_data_direction dir,
34 struct dma_attrs *attrs);
35 void (*sync_single_for_cpu)(struct device *dev,
36 dma_addr_t dma_handle, size_t size,
37 enum dma_data_direction dir);
38 void (*sync_single_for_device)(struct device *dev,
39 dma_addr_t dma_handle, size_t size,
40 enum dma_data_direction dir);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090041 void (*sync_sg_for_cpu)(struct device *dev,
42 struct scatterlist *sg, int nents,
43 enum dma_data_direction dir);
44 void (*sync_sg_for_device)(struct device *dev,
45 struct scatterlist *sg, int nents,
46 enum dma_data_direction dir);
47 int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
48 int (*dma_supported)(struct device *dev, u64 mask);
FUJITA Tomonorif726f302009-08-04 19:08:24 +000049 int (*set_dma_mask)(struct device *dev, u64 mask);
Milton Miller3a8f7552011-06-24 09:05:23 +000050#ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
51 u64 (*get_required_mask)(struct device *dev);
52#endif
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090053 int is_phys;
54};
55
Andrew Morton8f286c32007-10-18 03:05:07 -070056#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
Borislav Petkov34c65382007-10-18 03:05:06 -070057
James Bottomley32e8f702007-10-16 01:23:55 -070058#define DMA_MASK_NONE 0x0ULL
59
Rolf Eike Beerd6bd3a32006-09-29 01:59:48 -070060static inline int valid_dma_direction(int dma_direction)
61{
62 return ((dma_direction == DMA_BIDIRECTIONAL) ||
63 (dma_direction == DMA_TO_DEVICE) ||
64 (dma_direction == DMA_FROM_DEVICE));
65}
66
James Bottomley32e8f702007-10-16 01:23:55 -070067static inline int is_device_dma_capable(struct device *dev)
68{
69 return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
70}
71
Dan Williams1b0fac42007-07-15 23:40:26 -070072#ifdef CONFIG_HAS_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#include <asm/dma-mapping.h>
Dan Williams1b0fac42007-07-15 23:40:26 -070074#else
75#include <asm-generic/dma-mapping-broken.h>
76#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +090078static inline u64 dma_get_mask(struct device *dev)
79{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +090080 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +090081 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -070082 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +090083}
84
Rob Herring58af4a22012-03-20 14:33:01 -050085#ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
FUJITA Tomonori710224f2010-09-22 13:04:55 -070086int dma_set_coherent_mask(struct device *dev, u64 mask);
87#else
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -080088static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
89{
90 if (!dma_supported(dev, mask))
91 return -EIO;
92 dev->coherent_dma_mask = mask;
93 return 0;
94}
FUJITA Tomonori710224f2010-09-22 13:04:55 -070095#endif
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -080096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097extern u64 dma_get_required_mask(struct device *dev);
98
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -080099static inline unsigned int dma_get_max_seg_size(struct device *dev)
100{
101 return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
102}
103
104static inline unsigned int dma_set_max_seg_size(struct device *dev,
105 unsigned int size)
106{
107 if (dev->dma_parms) {
108 dev->dma_parms->max_segment_size = size;
109 return 0;
110 } else
111 return -EIO;
112}
113
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800114static inline unsigned long dma_get_seg_boundary(struct device *dev)
115{
116 return dev->dma_parms ?
117 dev->dma_parms->segment_boundary_mask : 0xffffffff;
118}
119
120static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
121{
122 if (dev->dma_parms) {
123 dev->dma_parms->segment_boundary_mask = mask;
124 return 0;
125 } else
126 return -EIO;
127}
128
Andrew Morton842fa692011-11-02 13:39:33 -0700129static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
130 dma_addr_t *dma_handle, gfp_t flag)
131{
132 void *ret = dma_alloc_coherent(dev, size, dma_handle, flag);
133 if (ret)
134 memset(ret, 0, size);
135 return ret;
136}
137
Heiko Carstense259f192010-08-13 09:39:18 +0200138#ifdef CONFIG_HAS_DMA
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700139static inline int dma_get_cache_alignment(void)
140{
141#ifdef ARCH_DMA_MINALIGN
142 return ARCH_DMA_MINALIGN;
143#endif
144 return 1;
145}
Heiko Carstense259f192010-08-13 09:39:18 +0200146#endif
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/* flags for the coherent memory api */
149#define DMA_MEMORY_MAP 0x01
150#define DMA_MEMORY_IO 0x02
151#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
152#define DMA_MEMORY_EXCLUSIVE 0x08
153
154#ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
155static inline int
156dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
157 dma_addr_t device_addr, size_t size, int flags)
158{
159 return 0;
160}
161
162static inline void
163dma_release_declared_memory(struct device *dev)
164{
165}
166
167static inline void *
168dma_mark_declared_memory_occupied(struct device *dev,
169 dma_addr_t device_addr, size_t size)
170{
171 return ERR_PTR(-EBUSY);
172}
173#endif
174
Tejun Heo9ac78492007-01-20 16:00:26 +0900175/*
176 * Managed DMA API
177 */
178extern void *dmam_alloc_coherent(struct device *dev, size_t size,
179 dma_addr_t *dma_handle, gfp_t gfp);
180extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
181 dma_addr_t dma_handle);
182extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
183 dma_addr_t *dma_handle, gfp_t gfp);
184extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
185 dma_addr_t dma_handle);
186#ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
187extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
188 dma_addr_t device_addr, size_t size,
189 int flags);
190extern void dmam_release_declared_memory(struct device *dev);
191#else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
192static inline int dmam_declare_coherent_memory(struct device *dev,
193 dma_addr_t bus_addr, dma_addr_t device_addr,
194 size_t size, gfp_t gfp)
195{
196 return 0;
197}
198
199static inline void dmam_release_declared_memory(struct device *dev)
200{
201}
202#endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
203
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700204#ifndef CONFIG_HAVE_DMA_ATTRS
205struct dma_attrs;
206
207#define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
208 dma_map_single(dev, cpu_addr, size, dir)
209
210#define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
211 dma_unmap_single(dev, dma_addr, size, dir)
212
213#define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
214 dma_map_sg(dev, sgl, nents, dir)
215
216#define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
217 dma_unmap_sg(dev, sgl, nents, dir)
218
219#endif /* CONFIG_HAVE_DMA_ATTRS */
220
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800221#ifdef CONFIG_NEED_DMA_MAP_STATE
222#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
223#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
224#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
225#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
226#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
227#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
228#else
229#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
230#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
231#define dma_unmap_addr(PTR, ADDR_NAME) (0)
232#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
233#define dma_unmap_len(PTR, LEN_NAME) (0)
234#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
235#endif
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237#endif