blob: f1da68b82c63950c1efdbc78a6583017cef29189 [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>
Dan Williams1b0fac42007-07-15 23:40:26 -0700167#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800168/*
169 * Define the dma api to allow compilation but not linking of
170 * dma dependent code. Code that depends on the dma-mapping
171 * API needs to set 'depends on HAS_DMA' in its Kconfig
172 */
Bart Van Assche52997092017-01-20 13:04:01 -0800173extern const struct dma_map_ops bad_dma_ops;
174static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800175{
176 return &bad_dma_ops;
177}
178#endif
179
180static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
181 size_t size,
182 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700183 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800184{
Bart Van Assche52997092017-01-20 13:04:01 -0800185 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800186 dma_addr_t addr;
187
188 kmemcheck_mark_initialized(ptr, size);
189 BUG_ON(!valid_dma_direction(dir));
190 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800191 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800192 dir, attrs);
193 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800194 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800195 dir, addr, true);
196 return addr;
197}
198
199static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
200 size_t size,
201 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700202 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800203{
Bart Van Assche52997092017-01-20 13:04:01 -0800204 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800205
206 BUG_ON(!valid_dma_direction(dir));
207 if (ops->unmap_page)
208 ops->unmap_page(dev, addr, size, dir, attrs);
209 debug_dma_unmap_page(dev, addr, size, dir, true);
210}
211
212/*
213 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
214 * It should never return a value < 0.
215 */
216static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
217 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700218 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800219{
Bart Van Assche52997092017-01-20 13:04:01 -0800220 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800221 int i, ents;
222 struct scatterlist *s;
223
224 for_each_sg(sg, s, nents, i)
225 kmemcheck_mark_initialized(sg_virt(s), s->length);
226 BUG_ON(!valid_dma_direction(dir));
227 ents = ops->map_sg(dev, sg, nents, dir, attrs);
228 BUG_ON(ents < 0);
229 debug_dma_map_sg(dev, sg, nents, ents, dir);
230
231 return ents;
232}
233
234static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
235 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700236 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800237{
Bart Van Assche52997092017-01-20 13:04:01 -0800238 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800239
240 BUG_ON(!valid_dma_direction(dir));
241 debug_dma_unmap_sg(dev, sg, nents, dir);
242 if (ops->unmap_sg)
243 ops->unmap_sg(dev, sg, nents, dir, attrs);
244}
245
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800246static inline dma_addr_t dma_map_page_attrs(struct device *dev,
247 struct page *page,
248 size_t offset, size_t size,
249 enum dma_data_direction dir,
250 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800251{
Bart Van Assche52997092017-01-20 13:04:01 -0800252 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800253 dma_addr_t addr;
254
255 kmemcheck_mark_initialized(page_address(page) + offset, size);
256 BUG_ON(!valid_dma_direction(dir));
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800257 addr = ops->map_page(dev, page, offset, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800258 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
259
260 return addr;
261}
262
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800263static inline void dma_unmap_page_attrs(struct device *dev,
264 dma_addr_t addr, size_t size,
265 enum dma_data_direction dir,
266 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800267{
Bart Van Assche52997092017-01-20 13:04:01 -0800268 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800269
270 BUG_ON(!valid_dma_direction(dir));
271 if (ops->unmap_page)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800272 ops->unmap_page(dev, addr, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800273 debug_dma_unmap_page(dev, addr, size, dir, false);
274}
275
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200276static inline dma_addr_t dma_map_resource(struct device *dev,
277 phys_addr_t phys_addr,
278 size_t size,
279 enum dma_data_direction dir,
280 unsigned long attrs)
281{
Bart Van Assche52997092017-01-20 13:04:01 -0800282 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200283 dma_addr_t addr;
284
285 BUG_ON(!valid_dma_direction(dir));
286
287 /* Don't allow RAM to be mapped */
Niklas Söderlund3757dc42016-09-29 12:02:40 +0200288 BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200289
290 addr = phys_addr;
291 if (ops->map_resource)
292 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
293
294 debug_dma_map_resource(dev, phys_addr, size, dir, addr);
295
296 return addr;
297}
298
299static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
300 size_t size, enum dma_data_direction dir,
301 unsigned long attrs)
302{
Bart Van Assche52997092017-01-20 13:04:01 -0800303 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200304
305 BUG_ON(!valid_dma_direction(dir));
306 if (ops->unmap_resource)
307 ops->unmap_resource(dev, addr, size, dir, attrs);
308 debug_dma_unmap_resource(dev, addr, size, dir);
309}
310
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800311static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
312 size_t size,
313 enum dma_data_direction dir)
314{
Bart Van Assche52997092017-01-20 13:04:01 -0800315 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800316
317 BUG_ON(!valid_dma_direction(dir));
318 if (ops->sync_single_for_cpu)
319 ops->sync_single_for_cpu(dev, addr, size, dir);
320 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
321}
322
323static inline void dma_sync_single_for_device(struct device *dev,
324 dma_addr_t addr, 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_device)
331 ops->sync_single_for_device(dev, addr, size, dir);
332 debug_dma_sync_single_for_device(dev, addr, size, dir);
333}
334
335static inline void dma_sync_single_range_for_cpu(struct device *dev,
336 dma_addr_t addr,
337 unsigned long offset,
338 size_t size,
339 enum dma_data_direction dir)
340{
341 const struct dma_map_ops *ops = get_dma_ops(dev);
342
343 BUG_ON(!valid_dma_direction(dir));
344 if (ops->sync_single_for_cpu)
345 ops->sync_single_for_cpu(dev, addr + offset, size, dir);
346 debug_dma_sync_single_range_for_cpu(dev, addr, offset, size, dir);
347}
348
349static inline void dma_sync_single_range_for_device(struct device *dev,
350 dma_addr_t addr,
351 unsigned long offset,
352 size_t size,
353 enum dma_data_direction dir)
354{
355 const struct dma_map_ops *ops = get_dma_ops(dev);
356
357 BUG_ON(!valid_dma_direction(dir));
358 if (ops->sync_single_for_device)
359 ops->sync_single_for_device(dev, addr + offset, size, dir);
360 debug_dma_sync_single_range_for_device(dev, addr, offset, size, dir);
361}
362
363static inline void
364dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
365 int nelems, enum dma_data_direction dir)
366{
Bart Van Assche52997092017-01-20 13:04:01 -0800367 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800368
369 BUG_ON(!valid_dma_direction(dir));
370 if (ops->sync_sg_for_cpu)
371 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
372 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
373}
374
375static inline void
376dma_sync_sg_for_device(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_device)
383 ops->sync_sg_for_device(dev, sg, nelems, dir);
384 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
385
386}
387
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700388#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
389#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
390#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
391#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800392#define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
393#define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800394
395extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
396 void *cpu_addr, dma_addr_t dma_addr, size_t size);
397
398void *dma_common_contiguous_remap(struct page *page, size_t size,
399 unsigned long vm_flags,
400 pgprot_t prot, const void *caller);
401
402void *dma_common_pages_remap(struct page **pages, size_t size,
403 unsigned long vm_flags, pgprot_t prot,
404 const void *caller);
405void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
406
407/**
408 * dma_mmap_attrs - map a coherent DMA allocation into user space
409 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
410 * @vma: vm_area_struct describing requested user mapping
411 * @cpu_addr: kernel CPU-view address returned from dma_alloc_attrs
412 * @handle: device-view address returned from dma_alloc_attrs
413 * @size: size of memory originally requested in dma_alloc_attrs
414 * @attrs: attributes of mapping properties requested in dma_alloc_attrs
415 *
416 * Map a coherent DMA buffer previously allocated by dma_alloc_attrs
417 * into user space. The coherent DMA buffer must not be freed by the
418 * driver until the user space mapping has been released.
419 */
420static inline int
421dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700422 dma_addr_t dma_addr, size_t size, unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800423{
Bart Van Assche52997092017-01-20 13:04:01 -0800424 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800425 BUG_ON(!ops);
426 if (ops->mmap)
427 return ops->mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
428 return dma_common_mmap(dev, vma, cpu_addr, dma_addr, size);
429}
430
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700431#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 -0800432
433int
434dma_common_get_sgtable(struct device *dev, struct sg_table *sgt,
435 void *cpu_addr, dma_addr_t dma_addr, size_t size);
436
437static inline int
438dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700439 dma_addr_t dma_addr, size_t size,
440 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800441{
Bart Van Assche52997092017-01-20 13:04:01 -0800442 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800443 BUG_ON(!ops);
444 if (ops->get_sgtable)
445 return ops->get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
446 attrs);
447 return dma_common_get_sgtable(dev, sgt, cpu_addr, dma_addr, size);
448}
449
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700450#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 -0800451
452#ifndef arch_dma_alloc_attrs
453#define arch_dma_alloc_attrs(dev, flag) (true)
454#endif
455
456static inline void *dma_alloc_attrs(struct device *dev, size_t size,
457 dma_addr_t *dma_handle, gfp_t flag,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700458 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800459{
Bart Van Assche52997092017-01-20 13:04:01 -0800460 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800461 void *cpu_addr;
462
463 BUG_ON(!ops);
464
465 if (dma_alloc_from_coherent(dev, size, dma_handle, &cpu_addr))
466 return cpu_addr;
467
468 if (!arch_dma_alloc_attrs(&dev, &flag))
469 return NULL;
470 if (!ops->alloc)
471 return NULL;
472
473 cpu_addr = ops->alloc(dev, size, dma_handle, flag, attrs);
474 debug_dma_alloc_coherent(dev, size, *dma_handle, cpu_addr);
475 return cpu_addr;
476}
477
478static inline void dma_free_attrs(struct device *dev, size_t size,
479 void *cpu_addr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700480 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800481{
Bart Van Assche52997092017-01-20 13:04:01 -0800482 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800483
484 BUG_ON(!ops);
485 WARN_ON(irqs_disabled());
486
487 if (dma_release_from_coherent(dev, get_order(size), cpu_addr))
488 return;
489
Zhen Leid6b7eae2016-03-09 14:08:38 -0800490 if (!ops->free || !cpu_addr)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800491 return;
492
493 debug_dma_free_coherent(dev, size, cpu_addr, dma_handle);
494 ops->free(dev, size, cpu_addr, dma_handle, attrs);
495}
496
497static inline void *dma_alloc_coherent(struct device *dev, size_t size,
498 dma_addr_t *dma_handle, gfp_t flag)
499{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700500 return dma_alloc_attrs(dev, size, dma_handle, flag, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800501}
502
503static inline void dma_free_coherent(struct device *dev, size_t size,
504 void *cpu_addr, dma_addr_t dma_handle)
505{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700506 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800507}
508
509static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
510 dma_addr_t *dma_handle, gfp_t gfp)
511{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700512 return dma_alloc_attrs(dev, size, dma_handle, gfp,
513 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800514}
515
516static inline void dma_free_noncoherent(struct device *dev, size_t size,
517 void *cpu_addr, dma_addr_t dma_handle)
518{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700519 dma_free_attrs(dev, size, cpu_addr, dma_handle,
520 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800521}
522
523static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
524{
525 debug_dma_mapping_error(dev, dma_addr);
526
527 if (get_dma_ops(dev)->mapping_error)
528 return get_dma_ops(dev)->mapping_error(dev, dma_addr);
529
530#ifdef DMA_ERROR_CODE
531 return dma_addr == DMA_ERROR_CODE;
532#else
533 return 0;
534#endif
535}
536
537#ifndef HAVE_ARCH_DMA_SUPPORTED
538static inline int dma_supported(struct device *dev, u64 mask)
539{
Bart Van Assche52997092017-01-20 13:04:01 -0800540 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800541
542 if (!ops)
543 return 0;
544 if (!ops->dma_supported)
545 return 1;
546 return ops->dma_supported(dev, mask);
547}
548#endif
549
550#ifndef HAVE_ARCH_DMA_SET_MASK
551static inline int dma_set_mask(struct device *dev, u64 mask)
552{
Bart Van Assche52997092017-01-20 13:04:01 -0800553 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800554
555 if (ops->set_dma_mask)
556 return ops->set_dma_mask(dev, mask);
557
558 if (!dev->dma_mask || !dma_supported(dev, mask))
559 return -EIO;
560 *dev->dma_mask = mask;
561 return 0;
562}
Dan Williams1b0fac42007-07-15 23:40:26 -0700563#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900565static inline u64 dma_get_mask(struct device *dev)
566{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900567 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900568 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700569 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900570}
571
Rob Herring58af4a22012-03-20 14:33:01 -0500572#ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700573int dma_set_coherent_mask(struct device *dev, u64 mask);
574#else
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800575static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
576{
577 if (!dma_supported(dev, mask))
578 return -EIO;
579 dev->coherent_dma_mask = mask;
580 return 0;
581}
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700582#endif
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800583
Russell King4aa806b2013-06-26 13:49:44 +0100584/*
585 * Set both the DMA mask and the coherent DMA mask to the same thing.
586 * Note that we don't check the return value from dma_set_coherent_mask()
587 * as the DMA API guarantees that the coherent DMA mask can be set to
588 * the same or smaller than the streaming DMA mask.
589 */
590static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
591{
592 int rc = dma_set_mask(dev, mask);
593 if (rc == 0)
594 dma_set_coherent_mask(dev, mask);
595 return rc;
596}
597
Russell Kingfa6a8d62013-06-27 12:21:45 +0100598/*
599 * Similar to the above, except it deals with the case where the device
600 * does not have dev->dma_mask appropriately setup.
601 */
602static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
603{
604 dev->dma_mask = &dev->coherent_dma_mask;
605 return dma_set_mask_and_coherent(dev, mask);
606}
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608extern u64 dma_get_required_mask(struct device *dev);
609
Will Deacona3a60f82014-08-27 15:49:10 +0100610#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100611static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100612 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100613 bool coherent) { }
614#endif
615
616#ifndef arch_teardown_dma_ops
617static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee2014-04-24 11:30:04 -0400618#endif
619
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800620static inline unsigned int dma_get_max_seg_size(struct device *dev)
621{
Robin Murphy002edb62015-11-06 16:32:51 -0800622 if (dev->dma_parms && dev->dma_parms->max_segment_size)
623 return dev->dma_parms->max_segment_size;
624 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800625}
626
627static inline unsigned int dma_set_max_seg_size(struct device *dev,
628 unsigned int size)
629{
630 if (dev->dma_parms) {
631 dev->dma_parms->max_segment_size = size;
632 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800633 }
634 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800635}
636
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800637static inline unsigned long dma_get_seg_boundary(struct device *dev)
638{
Robin Murphy002edb62015-11-06 16:32:51 -0800639 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
640 return dev->dma_parms->segment_boundary_mask;
641 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800642}
643
644static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
645{
646 if (dev->dma_parms) {
647 dev->dma_parms->segment_boundary_mask = mask;
648 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800649 }
650 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800651}
652
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100653#ifndef dma_max_pfn
654static inline unsigned long dma_max_pfn(struct device *dev)
655{
656 return *dev->dma_mask >> PAGE_SHIFT;
657}
658#endif
659
Andrew Morton842fa692011-11-02 13:39:33 -0700660static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
661 dma_addr_t *dma_handle, gfp_t flag)
662{
Joe Perchesede23fa82013-08-26 22:45:23 -0700663 void *ret = dma_alloc_coherent(dev, size, dma_handle,
664 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700665 return ret;
666}
667
Heiko Carstense259f192010-08-13 09:39:18 +0200668#ifdef CONFIG_HAS_DMA
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700669static inline int dma_get_cache_alignment(void)
670{
671#ifdef ARCH_DMA_MINALIGN
672 return ARCH_DMA_MINALIGN;
673#endif
674 return 1;
675}
Heiko Carstense259f192010-08-13 09:39:18 +0200676#endif
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678/* flags for the coherent memory api */
679#define DMA_MEMORY_MAP 0x01
680#define DMA_MEMORY_IO 0x02
681#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
682#define DMA_MEMORY_EXCLUSIVE 0x08
683
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800684#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
685int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
686 dma_addr_t device_addr, size_t size, int flags);
687void dma_release_declared_memory(struct device *dev);
688void *dma_mark_declared_memory_occupied(struct device *dev,
689 dma_addr_t device_addr, size_t size);
690#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600692dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 dma_addr_t device_addr, size_t size, int flags)
694{
695 return 0;
696}
697
698static inline void
699dma_release_declared_memory(struct device *dev)
700{
701}
702
703static inline void *
704dma_mark_declared_memory_occupied(struct device *dev,
705 dma_addr_t device_addr, size_t size)
706{
707 return ERR_PTR(-EBUSY);
708}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800709#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Tejun Heo9ac78492007-01-20 16:00:26 +0900711/*
712 * Managed DMA API
713 */
714extern void *dmam_alloc_coherent(struct device *dev, size_t size,
715 dma_addr_t *dma_handle, gfp_t gfp);
716extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
717 dma_addr_t dma_handle);
718extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
719 dma_addr_t *dma_handle, gfp_t gfp);
720extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
721 dma_addr_t dma_handle);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800722#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600723extern int dmam_declare_coherent_memory(struct device *dev,
724 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900725 dma_addr_t device_addr, size_t size,
726 int flags);
727extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800728#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900729static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600730 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900731 size_t size, gfp_t gfp)
732{
733 return 0;
734}
735
736static inline void dmam_release_declared_memory(struct device *dev)
737{
738}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800739#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900740
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800741static inline void *dma_alloc_wc(struct device *dev, size_t size,
742 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200743{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700744 return dma_alloc_attrs(dev, size, dma_addr, gfp,
745 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200746}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800747#ifndef dma_alloc_writecombine
748#define dma_alloc_writecombine dma_alloc_wc
749#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200750
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800751static inline void dma_free_wc(struct device *dev, size_t size,
752 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200753{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700754 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
755 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200756}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800757#ifndef dma_free_writecombine
758#define dma_free_writecombine dma_free_wc
759#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200760
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800761static inline int dma_mmap_wc(struct device *dev,
762 struct vm_area_struct *vma,
763 void *cpu_addr, dma_addr_t dma_addr,
764 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200765{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700766 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
767 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200768}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800769#ifndef dma_mmap_writecombine
770#define dma_mmap_writecombine dma_mmap_wc
771#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700772
Andrey Smirnov24813662016-09-28 15:22:33 -0700773#if defined(CONFIG_NEED_DMA_MAP_STATE) || defined(CONFIG_DMA_API_DEBUG)
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800774#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
775#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
776#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
777#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
778#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
779#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
780#else
781#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
782#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
783#define dma_unmap_addr(PTR, ADDR_NAME) (0)
784#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
785#define dma_unmap_len(PTR, LEN_NAME) (0)
786#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
787#endif
788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789#endif