blob: ab8710888ddffba4c0c3d0bf761e9a9a46908cc0 [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
Robin Murphy002edb62015-11-06 16:32:51 -08004#include <linux/sizes.h>
Andrew Morton842fa692011-11-02 13:39:33 -07005#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/device.h>
7#include <linux/err.h>
Christoph Hellwige1c7e322016-01-20 15:02:05 -08008#include <linux/dma-debug.h>
Alexey Dobriyanb7f080c2011-06-16 11:01:34 +00009#include <linux/dma-direction.h>
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090010#include <linux/scatterlist.h>
Christoph Hellwige1c7e322016-01-20 15:02:05 -080011#include <linux/kmemcheck.h>
12#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070014/**
15 * List of possible attributes associated with a DMA mapping. The semantics
16 * of each attribute should be defined in Documentation/DMA-attributes.txt.
17 *
18 * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute
19 * forces all pending DMA writes to complete.
20 */
21#define DMA_ATTR_WRITE_BARRIER (1UL << 0)
22/*
23 * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
24 * may be weakly ordered, that is that reads and writes may pass each other.
25 */
26#define DMA_ATTR_WEAK_ORDERING (1UL << 1)
27/*
28 * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
29 * buffered to improve performance.
30 */
31#define DMA_ATTR_WRITE_COMBINE (1UL << 2)
32/*
33 * DMA_ATTR_NON_CONSISTENT: Lets the platform to choose to return either
34 * consistent or non-consistent memory as it sees fit.
35 */
36#define DMA_ATTR_NON_CONSISTENT (1UL << 3)
37/*
38 * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
39 * virtual mapping for the allocated buffer.
40 */
41#define DMA_ATTR_NO_KERNEL_MAPPING (1UL << 4)
42/*
43 * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
44 * the CPU cache for the given buffer assuming that it has been already
45 * transferred to 'device' domain.
46 */
47#define DMA_ATTR_SKIP_CPU_SYNC (1UL << 5)
48/*
49 * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
50 * in physical memory.
51 */
52#define DMA_ATTR_FORCE_CONTIGUOUS (1UL << 6)
53/*
54 * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
55 * that it's probably not worth the time to try to allocate memory to in a way
56 * that gives better TLB efficiency.
57 */
58#define DMA_ATTR_ALLOC_SINGLE_PAGES (1UL << 7)
Mauricio Faria de Oliveiraa9a62c92016-10-11 13:54:14 -070059/*
60 * DMA_ATTR_NO_WARN: This tells the DMA-mapping subsystem to suppress
61 * allocation failure reports (similarly to __GFP_NOWARN).
62 */
63#define DMA_ATTR_NO_WARN (1UL << 8)
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070064
Bjorn Helgaas77f2ea22014-04-30 11:20:53 -060065/*
66 * A dma_addr_t can hold any valid DMA or bus address for the platform.
67 * It can be given to a device to use as a DMA source or target. A CPU cannot
68 * reference a dma_addr_t directly because there may be translation between
69 * its physical address space and the bus address space.
70 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090071struct dma_map_ops {
Marek Szyprowski613c4572012-03-28 16:36:27 +020072 void* (*alloc)(struct device *dev, size_t size,
73 dma_addr_t *dma_handle, gfp_t gfp,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070074 unsigned long attrs);
Marek Szyprowski613c4572012-03-28 16:36:27 +020075 void (*free)(struct device *dev, size_t size,
76 void *vaddr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070077 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010078 int (*mmap)(struct device *, struct vm_area_struct *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070079 void *, dma_addr_t, size_t,
80 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010081
Marek Szyprowskid2b74282012-06-13 10:05:52 +020082 int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070083 dma_addr_t, size_t, unsigned long attrs);
Marek Szyprowskid2b74282012-06-13 10:05:52 +020084
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090085 dma_addr_t (*map_page)(struct device *dev, struct page *page,
86 unsigned long offset, size_t size,
87 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070088 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090089 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
90 size_t size, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070091 unsigned long attrs);
Ricardo Ribalda Delgado04abab62015-02-11 13:53:15 +010092 /*
93 * map_sg returns 0 on error and a value > 0 on success.
94 * It should never return a value < 0.
95 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090096 int (*map_sg)(struct device *dev, struct scatterlist *sg,
97 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070098 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090099 void (*unmap_sg)(struct device *dev,
100 struct scatterlist *sg, int nents,
101 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700102 unsigned long attrs);
Niklas Söderlundba409b32016-08-10 13:22:14 +0200103 dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr,
104 size_t size, enum dma_data_direction dir,
105 unsigned long attrs);
106 void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle,
107 size_t size, enum dma_data_direction dir,
108 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900109 void (*sync_single_for_cpu)(struct device *dev,
110 dma_addr_t dma_handle, size_t size,
111 enum dma_data_direction dir);
112 void (*sync_single_for_device)(struct device *dev,
113 dma_addr_t dma_handle, size_t size,
114 enum dma_data_direction dir);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900115 void (*sync_sg_for_cpu)(struct device *dev,
116 struct scatterlist *sg, int nents,
117 enum dma_data_direction dir);
118 void (*sync_sg_for_device)(struct device *dev,
119 struct scatterlist *sg, int nents,
120 enum dma_data_direction dir);
121 int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
122 int (*dma_supported)(struct device *dev, u64 mask);
FUJITA Tomonorif726f30e2009-08-04 19:08:24 +0000123 int (*set_dma_mask)(struct device *dev, u64 mask);
Milton Miller3a8f7552011-06-24 09:05:23 +0000124#ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
125 u64 (*get_required_mask)(struct device *dev);
126#endif
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900127 int is_phys;
128};
129
Bart Van Assche52997092017-01-20 13:04:01 -0800130extern const struct dma_map_ops dma_noop_ops;
Christian Borntraegera8463d42016-02-02 21:46:32 -0800131
Andrew Morton8f286c32007-10-18 03:05:07 -0700132#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
Borislav Petkov34c65382007-10-18 03:05:06 -0700133
James Bottomley32e8f702007-10-16 01:23:55 -0700134#define DMA_MASK_NONE 0x0ULL
135
Rolf Eike Beerd6bd3a32006-09-29 01:59:48 -0700136static inline int valid_dma_direction(int dma_direction)
137{
138 return ((dma_direction == DMA_BIDIRECTIONAL) ||
139 (dma_direction == DMA_TO_DEVICE) ||
140 (dma_direction == DMA_FROM_DEVICE));
141}
142
James Bottomley32e8f702007-10-16 01:23:55 -0700143static inline int is_device_dma_capable(struct device *dev)
144{
145 return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
146}
147
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800148#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
149/*
150 * These three functions are only for dma allocator.
151 * Don't use them in device drivers.
152 */
153int dma_alloc_from_coherent(struct device *dev, ssize_t size,
154 dma_addr_t *dma_handle, void **ret);
155int dma_release_from_coherent(struct device *dev, int order, void *vaddr);
156
157int dma_mmap_from_coherent(struct device *dev, struct vm_area_struct *vma,
158 void *cpu_addr, size_t size, int *ret);
159#else
160#define dma_alloc_from_coherent(dev, size, handle, ret) (0)
161#define dma_release_from_coherent(dev, order, vaddr) (0)
162#define dma_mmap_from_coherent(dev, vma, vaddr, order, ret) (0)
163#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
164
Dan Williams1b0fac42007-07-15 23:40:26 -0700165#ifdef CONFIG_HAS_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166#include <asm/dma-mapping.h>
Bart Van Assche815dd182017-01-20 13:04:04 -0800167static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
168{
169 if (dev && dev->dma_ops)
170 return dev->dma_ops;
171 return get_arch_dma_ops(dev ? dev->bus : NULL);
172}
173
Bart Van Asscheca6e8e12017-01-20 13:04:03 -0800174static inline void set_dma_ops(struct device *dev,
175 const struct dma_map_ops *dma_ops)
176{
177 dev->dma_ops = dma_ops;
178}
Dan Williams1b0fac42007-07-15 23:40:26 -0700179#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800180/*
181 * Define the dma api to allow compilation but not linking of
182 * dma dependent code. Code that depends on the dma-mapping
183 * API needs to set 'depends on HAS_DMA' in its Kconfig
184 */
Bart Van Assche52997092017-01-20 13:04:01 -0800185extern const struct dma_map_ops bad_dma_ops;
186static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800187{
188 return &bad_dma_ops;
189}
190#endif
191
192static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
193 size_t size,
194 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700195 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800196{
Bart Van Assche52997092017-01-20 13:04:01 -0800197 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800198 dma_addr_t addr;
199
200 kmemcheck_mark_initialized(ptr, size);
201 BUG_ON(!valid_dma_direction(dir));
202 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800203 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800204 dir, attrs);
205 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800206 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800207 dir, addr, true);
208 return addr;
209}
210
211static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
212 size_t size,
213 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700214 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800215{
Bart Van Assche52997092017-01-20 13:04:01 -0800216 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800217
218 BUG_ON(!valid_dma_direction(dir));
219 if (ops->unmap_page)
220 ops->unmap_page(dev, addr, size, dir, attrs);
221 debug_dma_unmap_page(dev, addr, size, dir, true);
222}
223
224/*
225 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
226 * It should never return a value < 0.
227 */
228static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
229 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700230 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800231{
Bart Van Assche52997092017-01-20 13:04:01 -0800232 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800233 int i, ents;
234 struct scatterlist *s;
235
236 for_each_sg(sg, s, nents, i)
237 kmemcheck_mark_initialized(sg_virt(s), s->length);
238 BUG_ON(!valid_dma_direction(dir));
239 ents = ops->map_sg(dev, sg, nents, dir, attrs);
240 BUG_ON(ents < 0);
241 debug_dma_map_sg(dev, sg, nents, ents, dir);
242
243 return ents;
244}
245
246static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
247 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700248 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800249{
Bart Van Assche52997092017-01-20 13:04:01 -0800250 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800251
252 BUG_ON(!valid_dma_direction(dir));
253 debug_dma_unmap_sg(dev, sg, nents, dir);
254 if (ops->unmap_sg)
255 ops->unmap_sg(dev, sg, nents, dir, attrs);
256}
257
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800258static inline dma_addr_t dma_map_page_attrs(struct device *dev,
259 struct page *page,
260 size_t offset, size_t size,
261 enum dma_data_direction dir,
262 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800263{
Bart Van Assche52997092017-01-20 13:04:01 -0800264 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800265 dma_addr_t addr;
266
267 kmemcheck_mark_initialized(page_address(page) + offset, size);
268 BUG_ON(!valid_dma_direction(dir));
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800269 addr = ops->map_page(dev, page, offset, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800270 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
271
272 return addr;
273}
274
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800275static inline void dma_unmap_page_attrs(struct device *dev,
276 dma_addr_t addr, size_t size,
277 enum dma_data_direction dir,
278 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800279{
Bart Van Assche52997092017-01-20 13:04:01 -0800280 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800281
282 BUG_ON(!valid_dma_direction(dir));
283 if (ops->unmap_page)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800284 ops->unmap_page(dev, addr, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800285 debug_dma_unmap_page(dev, addr, size, dir, false);
286}
287
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200288static inline dma_addr_t dma_map_resource(struct device *dev,
289 phys_addr_t phys_addr,
290 size_t size,
291 enum dma_data_direction dir,
292 unsigned long attrs)
293{
Bart Van Assche52997092017-01-20 13:04:01 -0800294 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200295 dma_addr_t addr;
296
297 BUG_ON(!valid_dma_direction(dir));
298
299 /* Don't allow RAM to be mapped */
Niklas Söderlund3757dc42016-09-29 12:02:40 +0200300 BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200301
302 addr = phys_addr;
303 if (ops->map_resource)
304 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
305
306 debug_dma_map_resource(dev, phys_addr, size, dir, addr);
307
308 return addr;
309}
310
311static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
312 size_t size, enum dma_data_direction dir,
313 unsigned long attrs)
314{
Bart Van Assche52997092017-01-20 13:04:01 -0800315 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200316
317 BUG_ON(!valid_dma_direction(dir));
318 if (ops->unmap_resource)
319 ops->unmap_resource(dev, addr, size, dir, attrs);
320 debug_dma_unmap_resource(dev, addr, size, dir);
321}
322
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800323static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
324 size_t size,
325 enum dma_data_direction dir)
326{
Bart Van Assche52997092017-01-20 13:04:01 -0800327 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800328
329 BUG_ON(!valid_dma_direction(dir));
330 if (ops->sync_single_for_cpu)
331 ops->sync_single_for_cpu(dev, addr, size, dir);
332 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
333}
334
335static inline void dma_sync_single_for_device(struct device *dev,
336 dma_addr_t addr, size_t size,
337 enum dma_data_direction dir)
338{
Bart Van Assche52997092017-01-20 13:04:01 -0800339 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800340
341 BUG_ON(!valid_dma_direction(dir));
342 if (ops->sync_single_for_device)
343 ops->sync_single_for_device(dev, addr, size, dir);
344 debug_dma_sync_single_for_device(dev, addr, size, dir);
345}
346
347static inline void dma_sync_single_range_for_cpu(struct device *dev,
348 dma_addr_t addr,
349 unsigned long offset,
350 size_t size,
351 enum dma_data_direction dir)
352{
353 const struct dma_map_ops *ops = get_dma_ops(dev);
354
355 BUG_ON(!valid_dma_direction(dir));
356 if (ops->sync_single_for_cpu)
357 ops->sync_single_for_cpu(dev, addr + offset, size, dir);
358 debug_dma_sync_single_range_for_cpu(dev, addr, offset, size, dir);
359}
360
361static inline void dma_sync_single_range_for_device(struct device *dev,
362 dma_addr_t addr,
363 unsigned long offset,
364 size_t size,
365 enum dma_data_direction dir)
366{
367 const struct dma_map_ops *ops = get_dma_ops(dev);
368
369 BUG_ON(!valid_dma_direction(dir));
370 if (ops->sync_single_for_device)
371 ops->sync_single_for_device(dev, addr + offset, size, dir);
372 debug_dma_sync_single_range_for_device(dev, addr, offset, size, dir);
373}
374
375static inline void
376dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
377 int nelems, enum dma_data_direction dir)
378{
Bart Van Assche52997092017-01-20 13:04:01 -0800379 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800380
381 BUG_ON(!valid_dma_direction(dir));
382 if (ops->sync_sg_for_cpu)
383 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
384 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
385}
386
387static inline void
388dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
389 int nelems, enum dma_data_direction dir)
390{
Bart Van Assche52997092017-01-20 13:04:01 -0800391 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800392
393 BUG_ON(!valid_dma_direction(dir));
394 if (ops->sync_sg_for_device)
395 ops->sync_sg_for_device(dev, sg, nelems, dir);
396 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
397
398}
399
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700400#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
401#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
402#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
403#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800404#define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
405#define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800406
407extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
408 void *cpu_addr, dma_addr_t dma_addr, size_t size);
409
410void *dma_common_contiguous_remap(struct page *page, size_t size,
411 unsigned long vm_flags,
412 pgprot_t prot, const void *caller);
413
414void *dma_common_pages_remap(struct page **pages, size_t size,
415 unsigned long vm_flags, pgprot_t prot,
416 const void *caller);
417void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
418
419/**
420 * dma_mmap_attrs - map a coherent DMA allocation into user space
421 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
422 * @vma: vm_area_struct describing requested user mapping
423 * @cpu_addr: kernel CPU-view address returned from dma_alloc_attrs
424 * @handle: device-view address returned from dma_alloc_attrs
425 * @size: size of memory originally requested in dma_alloc_attrs
426 * @attrs: attributes of mapping properties requested in dma_alloc_attrs
427 *
428 * Map a coherent DMA buffer previously allocated by dma_alloc_attrs
429 * into user space. The coherent DMA buffer must not be freed by the
430 * driver until the user space mapping has been released.
431 */
432static inline int
433dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700434 dma_addr_t dma_addr, size_t size, unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800435{
Bart Van Assche52997092017-01-20 13:04:01 -0800436 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800437 BUG_ON(!ops);
438 if (ops->mmap)
439 return ops->mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
440 return dma_common_mmap(dev, vma, cpu_addr, dma_addr, size);
441}
442
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700443#define dma_mmap_coherent(d, v, c, h, s) dma_mmap_attrs(d, v, c, h, s, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800444
445int
446dma_common_get_sgtable(struct device *dev, struct sg_table *sgt,
447 void *cpu_addr, dma_addr_t dma_addr, size_t size);
448
449static inline int
450dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700451 dma_addr_t dma_addr, size_t size,
452 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800453{
Bart Van Assche52997092017-01-20 13:04:01 -0800454 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800455 BUG_ON(!ops);
456 if (ops->get_sgtable)
457 return ops->get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
458 attrs);
459 return dma_common_get_sgtable(dev, sgt, cpu_addr, dma_addr, size);
460}
461
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700462#define dma_get_sgtable(d, t, v, h, s) dma_get_sgtable_attrs(d, t, v, h, s, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800463
464#ifndef arch_dma_alloc_attrs
465#define arch_dma_alloc_attrs(dev, flag) (true)
466#endif
467
468static inline void *dma_alloc_attrs(struct device *dev, size_t size,
469 dma_addr_t *dma_handle, gfp_t flag,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700470 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800471{
Bart Van Assche52997092017-01-20 13:04:01 -0800472 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800473 void *cpu_addr;
474
475 BUG_ON(!ops);
476
477 if (dma_alloc_from_coherent(dev, size, dma_handle, &cpu_addr))
478 return cpu_addr;
479
480 if (!arch_dma_alloc_attrs(&dev, &flag))
481 return NULL;
482 if (!ops->alloc)
483 return NULL;
484
485 cpu_addr = ops->alloc(dev, size, dma_handle, flag, attrs);
486 debug_dma_alloc_coherent(dev, size, *dma_handle, cpu_addr);
487 return cpu_addr;
488}
489
490static inline void dma_free_attrs(struct device *dev, size_t size,
491 void *cpu_addr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700492 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800493{
Bart Van Assche52997092017-01-20 13:04:01 -0800494 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800495
496 BUG_ON(!ops);
497 WARN_ON(irqs_disabled());
498
499 if (dma_release_from_coherent(dev, get_order(size), cpu_addr))
500 return;
501
Zhen Leid6b7eae2016-03-09 14:08:38 -0800502 if (!ops->free || !cpu_addr)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800503 return;
504
505 debug_dma_free_coherent(dev, size, cpu_addr, dma_handle);
506 ops->free(dev, size, cpu_addr, dma_handle, attrs);
507}
508
509static inline void *dma_alloc_coherent(struct device *dev, size_t size,
510 dma_addr_t *dma_handle, gfp_t flag)
511{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700512 return dma_alloc_attrs(dev, size, dma_handle, flag, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800513}
514
515static inline void dma_free_coherent(struct device *dev, size_t size,
516 void *cpu_addr, dma_addr_t dma_handle)
517{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700518 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800519}
520
521static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
522 dma_addr_t *dma_handle, gfp_t gfp)
523{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700524 return dma_alloc_attrs(dev, size, dma_handle, gfp,
525 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800526}
527
528static inline void dma_free_noncoherent(struct device *dev, size_t size,
529 void *cpu_addr, dma_addr_t dma_handle)
530{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700531 dma_free_attrs(dev, size, cpu_addr, dma_handle,
532 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800533}
534
535static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
536{
537 debug_dma_mapping_error(dev, dma_addr);
538
539 if (get_dma_ops(dev)->mapping_error)
540 return get_dma_ops(dev)->mapping_error(dev, dma_addr);
541
542#ifdef DMA_ERROR_CODE
543 return dma_addr == DMA_ERROR_CODE;
544#else
545 return 0;
546#endif
547}
548
549#ifndef HAVE_ARCH_DMA_SUPPORTED
550static inline int dma_supported(struct device *dev, u64 mask)
551{
Bart Van Assche52997092017-01-20 13:04:01 -0800552 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800553
554 if (!ops)
555 return 0;
556 if (!ops->dma_supported)
557 return 1;
558 return ops->dma_supported(dev, mask);
559}
560#endif
561
562#ifndef HAVE_ARCH_DMA_SET_MASK
563static inline int dma_set_mask(struct device *dev, u64 mask)
564{
Bart Van Assche52997092017-01-20 13:04:01 -0800565 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800566
567 if (ops->set_dma_mask)
568 return ops->set_dma_mask(dev, mask);
569
570 if (!dev->dma_mask || !dma_supported(dev, mask))
571 return -EIO;
572 *dev->dma_mask = mask;
573 return 0;
574}
Dan Williams1b0fac42007-07-15 23:40:26 -0700575#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900577static inline u64 dma_get_mask(struct device *dev)
578{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900579 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900580 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700581 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900582}
583
Rob Herring58af4a22012-03-20 14:33:01 -0500584#ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700585int dma_set_coherent_mask(struct device *dev, u64 mask);
586#else
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800587static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
588{
589 if (!dma_supported(dev, mask))
590 return -EIO;
591 dev->coherent_dma_mask = mask;
592 return 0;
593}
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700594#endif
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800595
Russell King4aa806b2013-06-26 13:49:44 +0100596/*
597 * Set both the DMA mask and the coherent DMA mask to the same thing.
598 * Note that we don't check the return value from dma_set_coherent_mask()
599 * as the DMA API guarantees that the coherent DMA mask can be set to
600 * the same or smaller than the streaming DMA mask.
601 */
602static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
603{
604 int rc = dma_set_mask(dev, mask);
605 if (rc == 0)
606 dma_set_coherent_mask(dev, mask);
607 return rc;
608}
609
Russell Kingfa6a8d62013-06-27 12:21:45 +0100610/*
611 * Similar to the above, except it deals with the case where the device
612 * does not have dev->dma_mask appropriately setup.
613 */
614static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
615{
616 dev->dma_mask = &dev->coherent_dma_mask;
617 return dma_set_mask_and_coherent(dev, mask);
618}
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620extern u64 dma_get_required_mask(struct device *dev);
621
Will Deacona3a60f82014-08-27 15:49:10 +0100622#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100623static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100624 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100625 bool coherent) { }
626#endif
627
628#ifndef arch_teardown_dma_ops
629static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee42014-04-24 11:30:04 -0400630#endif
631
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800632static inline unsigned int dma_get_max_seg_size(struct device *dev)
633{
Robin Murphy002edb62015-11-06 16:32:51 -0800634 if (dev->dma_parms && dev->dma_parms->max_segment_size)
635 return dev->dma_parms->max_segment_size;
636 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800637}
638
639static inline unsigned int dma_set_max_seg_size(struct device *dev,
640 unsigned int size)
641{
642 if (dev->dma_parms) {
643 dev->dma_parms->max_segment_size = size;
644 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800645 }
646 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800647}
648
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800649static inline unsigned long dma_get_seg_boundary(struct device *dev)
650{
Robin Murphy002edb62015-11-06 16:32:51 -0800651 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
652 return dev->dma_parms->segment_boundary_mask;
653 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800654}
655
656static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
657{
658 if (dev->dma_parms) {
659 dev->dma_parms->segment_boundary_mask = mask;
660 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800661 }
662 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800663}
664
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100665#ifndef dma_max_pfn
666static inline unsigned long dma_max_pfn(struct device *dev)
667{
668 return *dev->dma_mask >> PAGE_SHIFT;
669}
670#endif
671
Andrew Morton842fa692011-11-02 13:39:33 -0700672static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
673 dma_addr_t *dma_handle, gfp_t flag)
674{
Joe Perchesede23fa82013-08-26 22:45:23 -0700675 void *ret = dma_alloc_coherent(dev, size, dma_handle,
676 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700677 return ret;
678}
679
Heiko Carstense259f192010-08-13 09:39:18 +0200680#ifdef CONFIG_HAS_DMA
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700681static inline int dma_get_cache_alignment(void)
682{
683#ifdef ARCH_DMA_MINALIGN
684 return ARCH_DMA_MINALIGN;
685#endif
686 return 1;
687}
Heiko Carstense259f192010-08-13 09:39:18 +0200688#endif
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690/* flags for the coherent memory api */
691#define DMA_MEMORY_MAP 0x01
692#define DMA_MEMORY_IO 0x02
693#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
694#define DMA_MEMORY_EXCLUSIVE 0x08
695
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800696#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
697int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
698 dma_addr_t device_addr, size_t size, int flags);
699void dma_release_declared_memory(struct device *dev);
700void *dma_mark_declared_memory_occupied(struct device *dev,
701 dma_addr_t device_addr, size_t size);
702#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600704dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 dma_addr_t device_addr, size_t size, int flags)
706{
707 return 0;
708}
709
710static inline void
711dma_release_declared_memory(struct device *dev)
712{
713}
714
715static inline void *
716dma_mark_declared_memory_occupied(struct device *dev,
717 dma_addr_t device_addr, size_t size)
718{
719 return ERR_PTR(-EBUSY);
720}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800721#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Tejun Heo9ac78492007-01-20 16:00:26 +0900723/*
724 * Managed DMA API
725 */
726extern void *dmam_alloc_coherent(struct device *dev, size_t size,
727 dma_addr_t *dma_handle, gfp_t gfp);
728extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
729 dma_addr_t dma_handle);
730extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
731 dma_addr_t *dma_handle, gfp_t gfp);
732extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
733 dma_addr_t dma_handle);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800734#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600735extern int dmam_declare_coherent_memory(struct device *dev,
736 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900737 dma_addr_t device_addr, size_t size,
738 int flags);
739extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800740#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900741static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600742 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900743 size_t size, gfp_t gfp)
744{
745 return 0;
746}
747
748static inline void dmam_release_declared_memory(struct device *dev)
749{
750}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800751#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900752
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800753static inline void *dma_alloc_wc(struct device *dev, size_t size,
754 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200755{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700756 return dma_alloc_attrs(dev, size, dma_addr, gfp,
757 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200758}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800759#ifndef dma_alloc_writecombine
760#define dma_alloc_writecombine dma_alloc_wc
761#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200762
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800763static inline void dma_free_wc(struct device *dev, size_t size,
764 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200765{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700766 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
767 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200768}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800769#ifndef dma_free_writecombine
770#define dma_free_writecombine dma_free_wc
771#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200772
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800773static inline int dma_mmap_wc(struct device *dev,
774 struct vm_area_struct *vma,
775 void *cpu_addr, dma_addr_t dma_addr,
776 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200777{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700778 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
779 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200780}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800781#ifndef dma_mmap_writecombine
782#define dma_mmap_writecombine dma_mmap_wc
783#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700784
Andrey Smirnov24813662016-09-28 15:22:33 -0700785#if defined(CONFIG_NEED_DMA_MAP_STATE) || defined(CONFIG_DMA_API_DEBUG)
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800786#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
787#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
788#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
789#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
790#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
791#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
792#else
793#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
794#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
795#define dma_unmap_addr(PTR, ADDR_NAME) (0)
796#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
797#define dma_unmap_len(PTR, LEN_NAME) (0)
798#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
799#endif
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801#endif