blob: 673b7be85f7a81cc90267ebf53d1a574817305db [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)
59
Bjorn Helgaas77f2ea22014-04-30 11:20:53 -060060/*
61 * A dma_addr_t can hold any valid DMA or bus address for the platform.
62 * It can be given to a device to use as a DMA source or target. A CPU cannot
63 * reference a dma_addr_t directly because there may be translation between
64 * its physical address space and the bus address space.
65 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090066struct dma_map_ops {
Marek Szyprowski613c4572012-03-28 16:36:27 +020067 void* (*alloc)(struct device *dev, size_t size,
68 dma_addr_t *dma_handle, gfp_t gfp,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070069 unsigned long attrs);
Marek Szyprowski613c4572012-03-28 16:36:27 +020070 void (*free)(struct device *dev, size_t size,
71 void *vaddr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070072 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010073 int (*mmap)(struct device *, struct vm_area_struct *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070074 void *, dma_addr_t, size_t,
75 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010076
Marek Szyprowskid2b74282012-06-13 10:05:52 +020077 int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070078 dma_addr_t, size_t, unsigned long attrs);
Marek Szyprowskid2b74282012-06-13 10:05:52 +020079
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090080 dma_addr_t (*map_page)(struct device *dev, struct page *page,
81 unsigned long offset, size_t size,
82 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070083 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090084 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
85 size_t size, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070086 unsigned long attrs);
Ricardo Ribalda Delgado04abab62015-02-11 13:53:15 +010087 /*
88 * map_sg returns 0 on error and a value > 0 on success.
89 * It should never return a value < 0.
90 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090091 int (*map_sg)(struct device *dev, struct scatterlist *sg,
92 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070093 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090094 void (*unmap_sg)(struct device *dev,
95 struct scatterlist *sg, int nents,
96 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070097 unsigned long attrs);
Niklas Söderlundba409b32016-08-10 13:22:14 +020098 dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr,
99 size_t size, enum dma_data_direction dir,
100 unsigned long attrs);
101 void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle,
102 size_t size, enum dma_data_direction dir,
103 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900104 void (*sync_single_for_cpu)(struct device *dev,
105 dma_addr_t dma_handle, size_t size,
106 enum dma_data_direction dir);
107 void (*sync_single_for_device)(struct device *dev,
108 dma_addr_t dma_handle, size_t size,
109 enum dma_data_direction dir);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900110 void (*sync_sg_for_cpu)(struct device *dev,
111 struct scatterlist *sg, int nents,
112 enum dma_data_direction dir);
113 void (*sync_sg_for_device)(struct device *dev,
114 struct scatterlist *sg, int nents,
115 enum dma_data_direction dir);
116 int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
117 int (*dma_supported)(struct device *dev, u64 mask);
FUJITA Tomonorif726f30e2009-08-04 19:08:24 +0000118 int (*set_dma_mask)(struct device *dev, u64 mask);
Milton Miller3a8f7552011-06-24 09:05:23 +0000119#ifdef ARCH_HAS_DMA_GET_REQUIRED_MASK
120 u64 (*get_required_mask)(struct device *dev);
121#endif
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900122 int is_phys;
123};
124
Christian Borntraegera8463d42016-02-02 21:46:32 -0800125extern struct dma_map_ops dma_noop_ops;
126
Andrew Morton8f286c32007-10-18 03:05:07 -0700127#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
Borislav Petkov34c65382007-10-18 03:05:06 -0700128
James Bottomley32e8f702007-10-16 01:23:55 -0700129#define DMA_MASK_NONE 0x0ULL
130
Rolf Eike Beerd6bd3a32006-09-29 01:59:48 -0700131static inline int valid_dma_direction(int dma_direction)
132{
133 return ((dma_direction == DMA_BIDIRECTIONAL) ||
134 (dma_direction == DMA_TO_DEVICE) ||
135 (dma_direction == DMA_FROM_DEVICE));
136}
137
James Bottomley32e8f702007-10-16 01:23:55 -0700138static inline int is_device_dma_capable(struct device *dev)
139{
140 return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
141}
142
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800143#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
144/*
145 * These three functions are only for dma allocator.
146 * Don't use them in device drivers.
147 */
148int dma_alloc_from_coherent(struct device *dev, ssize_t size,
149 dma_addr_t *dma_handle, void **ret);
150int dma_release_from_coherent(struct device *dev, int order, void *vaddr);
151
152int dma_mmap_from_coherent(struct device *dev, struct vm_area_struct *vma,
153 void *cpu_addr, size_t size, int *ret);
154#else
155#define dma_alloc_from_coherent(dev, size, handle, ret) (0)
156#define dma_release_from_coherent(dev, order, vaddr) (0)
157#define dma_mmap_from_coherent(dev, vma, vaddr, order, ret) (0)
158#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
159
Dan Williams1b0fac42007-07-15 23:40:26 -0700160#ifdef CONFIG_HAS_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#include <asm/dma-mapping.h>
Dan Williams1b0fac42007-07-15 23:40:26 -0700162#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800163/*
164 * Define the dma api to allow compilation but not linking of
165 * dma dependent code. Code that depends on the dma-mapping
166 * API needs to set 'depends on HAS_DMA' in its Kconfig
167 */
168extern struct dma_map_ops bad_dma_ops;
169static inline struct dma_map_ops *get_dma_ops(struct device *dev)
170{
171 return &bad_dma_ops;
172}
173#endif
174
175static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
176 size_t size,
177 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700178 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800179{
180 struct dma_map_ops *ops = get_dma_ops(dev);
181 dma_addr_t addr;
182
183 kmemcheck_mark_initialized(ptr, size);
184 BUG_ON(!valid_dma_direction(dir));
185 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800186 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800187 dir, attrs);
188 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800189 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800190 dir, addr, true);
191 return addr;
192}
193
194static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
195 size_t size,
196 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700197 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800198{
199 struct dma_map_ops *ops = get_dma_ops(dev);
200
201 BUG_ON(!valid_dma_direction(dir));
202 if (ops->unmap_page)
203 ops->unmap_page(dev, addr, size, dir, attrs);
204 debug_dma_unmap_page(dev, addr, size, dir, true);
205}
206
207/*
208 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
209 * It should never return a value < 0.
210 */
211static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
212 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700213 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800214{
215 struct dma_map_ops *ops = get_dma_ops(dev);
216 int i, ents;
217 struct scatterlist *s;
218
219 for_each_sg(sg, s, nents, i)
220 kmemcheck_mark_initialized(sg_virt(s), s->length);
221 BUG_ON(!valid_dma_direction(dir));
222 ents = ops->map_sg(dev, sg, nents, dir, attrs);
223 BUG_ON(ents < 0);
224 debug_dma_map_sg(dev, sg, nents, ents, dir);
225
226 return ents;
227}
228
229static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
230 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700231 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800232{
233 struct dma_map_ops *ops = get_dma_ops(dev);
234
235 BUG_ON(!valid_dma_direction(dir));
236 debug_dma_unmap_sg(dev, sg, nents, dir);
237 if (ops->unmap_sg)
238 ops->unmap_sg(dev, sg, nents, dir, attrs);
239}
240
241static inline dma_addr_t dma_map_page(struct device *dev, struct page *page,
242 size_t offset, size_t size,
243 enum dma_data_direction dir)
244{
245 struct dma_map_ops *ops = get_dma_ops(dev);
246 dma_addr_t addr;
247
248 kmemcheck_mark_initialized(page_address(page) + offset, size);
249 BUG_ON(!valid_dma_direction(dir));
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700250 addr = ops->map_page(dev, page, offset, size, dir, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800251 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
252
253 return addr;
254}
255
256static inline void dma_unmap_page(struct device *dev, dma_addr_t addr,
257 size_t size, enum dma_data_direction dir)
258{
259 struct dma_map_ops *ops = get_dma_ops(dev);
260
261 BUG_ON(!valid_dma_direction(dir));
262 if (ops->unmap_page)
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700263 ops->unmap_page(dev, addr, size, dir, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800264 debug_dma_unmap_page(dev, addr, size, dir, false);
265}
266
267static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
268 size_t size,
269 enum dma_data_direction dir)
270{
271 struct dma_map_ops *ops = get_dma_ops(dev);
272
273 BUG_ON(!valid_dma_direction(dir));
274 if (ops->sync_single_for_cpu)
275 ops->sync_single_for_cpu(dev, addr, size, dir);
276 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
277}
278
279static inline void dma_sync_single_for_device(struct device *dev,
280 dma_addr_t addr, size_t size,
281 enum dma_data_direction dir)
282{
283 struct dma_map_ops *ops = get_dma_ops(dev);
284
285 BUG_ON(!valid_dma_direction(dir));
286 if (ops->sync_single_for_device)
287 ops->sync_single_for_device(dev, addr, size, dir);
288 debug_dma_sync_single_for_device(dev, addr, size, dir);
289}
290
291static inline void dma_sync_single_range_for_cpu(struct device *dev,
292 dma_addr_t addr,
293 unsigned long offset,
294 size_t size,
295 enum dma_data_direction dir)
296{
297 const struct dma_map_ops *ops = get_dma_ops(dev);
298
299 BUG_ON(!valid_dma_direction(dir));
300 if (ops->sync_single_for_cpu)
301 ops->sync_single_for_cpu(dev, addr + offset, size, dir);
302 debug_dma_sync_single_range_for_cpu(dev, addr, offset, size, dir);
303}
304
305static inline void dma_sync_single_range_for_device(struct device *dev,
306 dma_addr_t addr,
307 unsigned long offset,
308 size_t size,
309 enum dma_data_direction dir)
310{
311 const struct dma_map_ops *ops = get_dma_ops(dev);
312
313 BUG_ON(!valid_dma_direction(dir));
314 if (ops->sync_single_for_device)
315 ops->sync_single_for_device(dev, addr + offset, size, dir);
316 debug_dma_sync_single_range_for_device(dev, addr, offset, size, dir);
317}
318
319static inline void
320dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
321 int nelems, enum dma_data_direction dir)
322{
323 struct dma_map_ops *ops = get_dma_ops(dev);
324
325 BUG_ON(!valid_dma_direction(dir));
326 if (ops->sync_sg_for_cpu)
327 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
328 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
329}
330
331static inline void
332dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
333 int nelems, enum dma_data_direction dir)
334{
335 struct dma_map_ops *ops = get_dma_ops(dev);
336
337 BUG_ON(!valid_dma_direction(dir));
338 if (ops->sync_sg_for_device)
339 ops->sync_sg_for_device(dev, sg, nelems, dir);
340 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
341
342}
343
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700344#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
345#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
346#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
347#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800348
349extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
350 void *cpu_addr, dma_addr_t dma_addr, size_t size);
351
352void *dma_common_contiguous_remap(struct page *page, size_t size,
353 unsigned long vm_flags,
354 pgprot_t prot, const void *caller);
355
356void *dma_common_pages_remap(struct page **pages, size_t size,
357 unsigned long vm_flags, pgprot_t prot,
358 const void *caller);
359void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
360
361/**
362 * dma_mmap_attrs - map a coherent DMA allocation into user space
363 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
364 * @vma: vm_area_struct describing requested user mapping
365 * @cpu_addr: kernel CPU-view address returned from dma_alloc_attrs
366 * @handle: device-view address returned from dma_alloc_attrs
367 * @size: size of memory originally requested in dma_alloc_attrs
368 * @attrs: attributes of mapping properties requested in dma_alloc_attrs
369 *
370 * Map a coherent DMA buffer previously allocated by dma_alloc_attrs
371 * into user space. The coherent DMA buffer must not be freed by the
372 * driver until the user space mapping has been released.
373 */
374static inline int
375dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700376 dma_addr_t dma_addr, size_t size, unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800377{
378 struct dma_map_ops *ops = get_dma_ops(dev);
379 BUG_ON(!ops);
380 if (ops->mmap)
381 return ops->mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
382 return dma_common_mmap(dev, vma, cpu_addr, dma_addr, size);
383}
384
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700385#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 -0800386
387int
388dma_common_get_sgtable(struct device *dev, struct sg_table *sgt,
389 void *cpu_addr, dma_addr_t dma_addr, size_t size);
390
391static inline int
392dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700393 dma_addr_t dma_addr, size_t size,
394 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800395{
396 struct dma_map_ops *ops = get_dma_ops(dev);
397 BUG_ON(!ops);
398 if (ops->get_sgtable)
399 return ops->get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
400 attrs);
401 return dma_common_get_sgtable(dev, sgt, cpu_addr, dma_addr, size);
402}
403
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700404#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 -0800405
406#ifndef arch_dma_alloc_attrs
407#define arch_dma_alloc_attrs(dev, flag) (true)
408#endif
409
410static inline void *dma_alloc_attrs(struct device *dev, size_t size,
411 dma_addr_t *dma_handle, gfp_t flag,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700412 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800413{
414 struct dma_map_ops *ops = get_dma_ops(dev);
415 void *cpu_addr;
416
417 BUG_ON(!ops);
418
419 if (dma_alloc_from_coherent(dev, size, dma_handle, &cpu_addr))
420 return cpu_addr;
421
422 if (!arch_dma_alloc_attrs(&dev, &flag))
423 return NULL;
424 if (!ops->alloc)
425 return NULL;
426
427 cpu_addr = ops->alloc(dev, size, dma_handle, flag, attrs);
428 debug_dma_alloc_coherent(dev, size, *dma_handle, cpu_addr);
429 return cpu_addr;
430}
431
432static inline void dma_free_attrs(struct device *dev, size_t size,
433 void *cpu_addr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700434 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800435{
436 struct dma_map_ops *ops = get_dma_ops(dev);
437
438 BUG_ON(!ops);
439 WARN_ON(irqs_disabled());
440
441 if (dma_release_from_coherent(dev, get_order(size), cpu_addr))
442 return;
443
Zhen Leid6b7eae2016-03-09 14:08:38 -0800444 if (!ops->free || !cpu_addr)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800445 return;
446
447 debug_dma_free_coherent(dev, size, cpu_addr, dma_handle);
448 ops->free(dev, size, cpu_addr, dma_handle, attrs);
449}
450
451static inline void *dma_alloc_coherent(struct device *dev, size_t size,
452 dma_addr_t *dma_handle, gfp_t flag)
453{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700454 return dma_alloc_attrs(dev, size, dma_handle, flag, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800455}
456
457static inline void dma_free_coherent(struct device *dev, size_t size,
458 void *cpu_addr, dma_addr_t dma_handle)
459{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700460 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800461}
462
463static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
464 dma_addr_t *dma_handle, gfp_t gfp)
465{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700466 return dma_alloc_attrs(dev, size, dma_handle, gfp,
467 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800468}
469
470static inline void dma_free_noncoherent(struct device *dev, size_t size,
471 void *cpu_addr, dma_addr_t dma_handle)
472{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700473 dma_free_attrs(dev, size, cpu_addr, dma_handle,
474 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800475}
476
477static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
478{
479 debug_dma_mapping_error(dev, dma_addr);
480
481 if (get_dma_ops(dev)->mapping_error)
482 return get_dma_ops(dev)->mapping_error(dev, dma_addr);
483
484#ifdef DMA_ERROR_CODE
485 return dma_addr == DMA_ERROR_CODE;
486#else
487 return 0;
488#endif
489}
490
491#ifndef HAVE_ARCH_DMA_SUPPORTED
492static inline int dma_supported(struct device *dev, u64 mask)
493{
494 struct dma_map_ops *ops = get_dma_ops(dev);
495
496 if (!ops)
497 return 0;
498 if (!ops->dma_supported)
499 return 1;
500 return ops->dma_supported(dev, mask);
501}
502#endif
503
504#ifndef HAVE_ARCH_DMA_SET_MASK
505static inline int dma_set_mask(struct device *dev, u64 mask)
506{
507 struct dma_map_ops *ops = get_dma_ops(dev);
508
509 if (ops->set_dma_mask)
510 return ops->set_dma_mask(dev, mask);
511
512 if (!dev->dma_mask || !dma_supported(dev, mask))
513 return -EIO;
514 *dev->dma_mask = mask;
515 return 0;
516}
Dan Williams1b0fac42007-07-15 23:40:26 -0700517#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900519static inline u64 dma_get_mask(struct device *dev)
520{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900521 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900522 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700523 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900524}
525
Rob Herring58af4a22012-03-20 14:33:01 -0500526#ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700527int dma_set_coherent_mask(struct device *dev, u64 mask);
528#else
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800529static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
530{
531 if (!dma_supported(dev, mask))
532 return -EIO;
533 dev->coherent_dma_mask = mask;
534 return 0;
535}
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700536#endif
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800537
Russell King4aa806b2013-06-26 13:49:44 +0100538/*
539 * Set both the DMA mask and the coherent DMA mask to the same thing.
540 * Note that we don't check the return value from dma_set_coherent_mask()
541 * as the DMA API guarantees that the coherent DMA mask can be set to
542 * the same or smaller than the streaming DMA mask.
543 */
544static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
545{
546 int rc = dma_set_mask(dev, mask);
547 if (rc == 0)
548 dma_set_coherent_mask(dev, mask);
549 return rc;
550}
551
Russell Kingfa6a8d62013-06-27 12:21:45 +0100552/*
553 * Similar to the above, except it deals with the case where the device
554 * does not have dev->dma_mask appropriately setup.
555 */
556static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
557{
558 dev->dma_mask = &dev->coherent_dma_mask;
559 return dma_set_mask_and_coherent(dev, mask);
560}
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562extern u64 dma_get_required_mask(struct device *dev);
563
Will Deacona3a60f82014-08-27 15:49:10 +0100564#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100565static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100566 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100567 bool coherent) { }
568#endif
569
570#ifndef arch_teardown_dma_ops
571static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee2014-04-24 11:30:04 -0400572#endif
573
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800574static inline unsigned int dma_get_max_seg_size(struct device *dev)
575{
Robin Murphy002edb62015-11-06 16:32:51 -0800576 if (dev->dma_parms && dev->dma_parms->max_segment_size)
577 return dev->dma_parms->max_segment_size;
578 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800579}
580
581static inline unsigned int dma_set_max_seg_size(struct device *dev,
582 unsigned int size)
583{
584 if (dev->dma_parms) {
585 dev->dma_parms->max_segment_size = size;
586 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800587 }
588 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800589}
590
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800591static inline unsigned long dma_get_seg_boundary(struct device *dev)
592{
Robin Murphy002edb62015-11-06 16:32:51 -0800593 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
594 return dev->dma_parms->segment_boundary_mask;
595 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800596}
597
598static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
599{
600 if (dev->dma_parms) {
601 dev->dma_parms->segment_boundary_mask = mask;
602 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800603 }
604 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800605}
606
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100607#ifndef dma_max_pfn
608static inline unsigned long dma_max_pfn(struct device *dev)
609{
610 return *dev->dma_mask >> PAGE_SHIFT;
611}
612#endif
613
Andrew Morton842fa692011-11-02 13:39:33 -0700614static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
615 dma_addr_t *dma_handle, gfp_t flag)
616{
Joe Perchesede23fa82013-08-26 22:45:23 -0700617 void *ret = dma_alloc_coherent(dev, size, dma_handle,
618 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700619 return ret;
620}
621
Heiko Carstense259f192010-08-13 09:39:18 +0200622#ifdef CONFIG_HAS_DMA
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700623static inline int dma_get_cache_alignment(void)
624{
625#ifdef ARCH_DMA_MINALIGN
626 return ARCH_DMA_MINALIGN;
627#endif
628 return 1;
629}
Heiko Carstense259f192010-08-13 09:39:18 +0200630#endif
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632/* flags for the coherent memory api */
633#define DMA_MEMORY_MAP 0x01
634#define DMA_MEMORY_IO 0x02
635#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
636#define DMA_MEMORY_EXCLUSIVE 0x08
637
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800638#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
639int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
640 dma_addr_t device_addr, size_t size, int flags);
641void dma_release_declared_memory(struct device *dev);
642void *dma_mark_declared_memory_occupied(struct device *dev,
643 dma_addr_t device_addr, size_t size);
644#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600646dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 dma_addr_t device_addr, size_t size, int flags)
648{
649 return 0;
650}
651
652static inline void
653dma_release_declared_memory(struct device *dev)
654{
655}
656
657static inline void *
658dma_mark_declared_memory_occupied(struct device *dev,
659 dma_addr_t device_addr, size_t size)
660{
661 return ERR_PTR(-EBUSY);
662}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800663#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Tejun Heo9ac78492007-01-20 16:00:26 +0900665/*
666 * Managed DMA API
667 */
668extern void *dmam_alloc_coherent(struct device *dev, size_t size,
669 dma_addr_t *dma_handle, gfp_t gfp);
670extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
671 dma_addr_t dma_handle);
672extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
673 dma_addr_t *dma_handle, gfp_t gfp);
674extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
675 dma_addr_t dma_handle);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800676#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600677extern int dmam_declare_coherent_memory(struct device *dev,
678 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900679 dma_addr_t device_addr, size_t size,
680 int flags);
681extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800682#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900683static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600684 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900685 size_t size, gfp_t gfp)
686{
687 return 0;
688}
689
690static inline void dmam_release_declared_memory(struct device *dev)
691{
692}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800693#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900694
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800695static inline void *dma_alloc_wc(struct device *dev, size_t size,
696 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200697{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700698 return dma_alloc_attrs(dev, size, dma_addr, gfp,
699 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200700}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800701#ifndef dma_alloc_writecombine
702#define dma_alloc_writecombine dma_alloc_wc
703#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200704
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800705static inline void dma_free_wc(struct device *dev, size_t size,
706 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200707{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700708 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
709 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200710}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800711#ifndef dma_free_writecombine
712#define dma_free_writecombine dma_free_wc
713#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200714
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800715static inline int dma_mmap_wc(struct device *dev,
716 struct vm_area_struct *vma,
717 void *cpu_addr, dma_addr_t dma_addr,
718 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200719{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700720 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
721 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200722}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800723#ifndef dma_mmap_writecombine
724#define dma_mmap_writecombine dma_mmap_wc
725#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700726
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800727#ifdef CONFIG_NEED_DMA_MAP_STATE
728#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
729#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
730#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
731#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
732#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
733#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
734#else
735#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
736#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
737#define dma_unmap_addr(PTR, ADDR_NAME) (0)
738#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
739#define dma_unmap_len(PTR, LEN_NAME) (0)
740#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
741#endif
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743#endif