blob: e97f23e8b2d9b0d1fd24cf07468224ad1e38522c [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 Asscheca6e8e12017-01-20 13:04:03 -0800167static inline void set_dma_ops(struct device *dev,
168 const struct dma_map_ops *dma_ops)
169{
170 dev->dma_ops = dma_ops;
171}
Dan Williams1b0fac42007-07-15 23:40:26 -0700172#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800173/*
174 * Define the dma api to allow compilation but not linking of
175 * dma dependent code. Code that depends on the dma-mapping
176 * API needs to set 'depends on HAS_DMA' in its Kconfig
177 */
Bart Van Assche52997092017-01-20 13:04:01 -0800178extern const struct dma_map_ops bad_dma_ops;
179static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800180{
181 return &bad_dma_ops;
182}
183#endif
184
185static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
186 size_t size,
187 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700188 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800189{
Bart Van Assche52997092017-01-20 13:04:01 -0800190 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800191 dma_addr_t addr;
192
193 kmemcheck_mark_initialized(ptr, size);
194 BUG_ON(!valid_dma_direction(dir));
195 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800196 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800197 dir, attrs);
198 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800199 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800200 dir, addr, true);
201 return addr;
202}
203
204static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
205 size_t size,
206 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700207 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800208{
Bart Van Assche52997092017-01-20 13:04:01 -0800209 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800210
211 BUG_ON(!valid_dma_direction(dir));
212 if (ops->unmap_page)
213 ops->unmap_page(dev, addr, size, dir, attrs);
214 debug_dma_unmap_page(dev, addr, size, dir, true);
215}
216
217/*
218 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
219 * It should never return a value < 0.
220 */
221static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
222 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700223 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800224{
Bart Van Assche52997092017-01-20 13:04:01 -0800225 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800226 int i, ents;
227 struct scatterlist *s;
228
229 for_each_sg(sg, s, nents, i)
230 kmemcheck_mark_initialized(sg_virt(s), s->length);
231 BUG_ON(!valid_dma_direction(dir));
232 ents = ops->map_sg(dev, sg, nents, dir, attrs);
233 BUG_ON(ents < 0);
234 debug_dma_map_sg(dev, sg, nents, ents, dir);
235
236 return ents;
237}
238
239static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
240 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700241 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800242{
Bart Van Assche52997092017-01-20 13:04:01 -0800243 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800244
245 BUG_ON(!valid_dma_direction(dir));
246 debug_dma_unmap_sg(dev, sg, nents, dir);
247 if (ops->unmap_sg)
248 ops->unmap_sg(dev, sg, nents, dir, attrs);
249}
250
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800251static inline dma_addr_t dma_map_page_attrs(struct device *dev,
252 struct page *page,
253 size_t offset, size_t size,
254 enum dma_data_direction dir,
255 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800256{
Bart Van Assche52997092017-01-20 13:04:01 -0800257 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800258 dma_addr_t addr;
259
260 kmemcheck_mark_initialized(page_address(page) + offset, size);
261 BUG_ON(!valid_dma_direction(dir));
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800262 addr = ops->map_page(dev, page, offset, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800263 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
264
265 return addr;
266}
267
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800268static inline void dma_unmap_page_attrs(struct device *dev,
269 dma_addr_t addr, size_t size,
270 enum dma_data_direction dir,
271 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800272{
Bart Van Assche52997092017-01-20 13:04:01 -0800273 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800274
275 BUG_ON(!valid_dma_direction(dir));
276 if (ops->unmap_page)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800277 ops->unmap_page(dev, addr, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800278 debug_dma_unmap_page(dev, addr, size, dir, false);
279}
280
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200281static inline dma_addr_t dma_map_resource(struct device *dev,
282 phys_addr_t phys_addr,
283 size_t size,
284 enum dma_data_direction dir,
285 unsigned long attrs)
286{
Bart Van Assche52997092017-01-20 13:04:01 -0800287 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200288 dma_addr_t addr;
289
290 BUG_ON(!valid_dma_direction(dir));
291
292 /* Don't allow RAM to be mapped */
Niklas Söderlund3757dc42016-09-29 12:02:40 +0200293 BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200294
295 addr = phys_addr;
296 if (ops->map_resource)
297 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
298
299 debug_dma_map_resource(dev, phys_addr, size, dir, addr);
300
301 return addr;
302}
303
304static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
305 size_t size, enum dma_data_direction dir,
306 unsigned long attrs)
307{
Bart Van Assche52997092017-01-20 13:04:01 -0800308 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200309
310 BUG_ON(!valid_dma_direction(dir));
311 if (ops->unmap_resource)
312 ops->unmap_resource(dev, addr, size, dir, attrs);
313 debug_dma_unmap_resource(dev, addr, size, dir);
314}
315
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800316static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
317 size_t size,
318 enum dma_data_direction dir)
319{
Bart Van Assche52997092017-01-20 13:04:01 -0800320 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800321
322 BUG_ON(!valid_dma_direction(dir));
323 if (ops->sync_single_for_cpu)
324 ops->sync_single_for_cpu(dev, addr, size, dir);
325 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
326}
327
328static inline void dma_sync_single_for_device(struct device *dev,
329 dma_addr_t addr, size_t size,
330 enum dma_data_direction dir)
331{
Bart Van Assche52997092017-01-20 13:04:01 -0800332 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800333
334 BUG_ON(!valid_dma_direction(dir));
335 if (ops->sync_single_for_device)
336 ops->sync_single_for_device(dev, addr, size, dir);
337 debug_dma_sync_single_for_device(dev, addr, size, dir);
338}
339
340static inline void dma_sync_single_range_for_cpu(struct device *dev,
341 dma_addr_t addr,
342 unsigned long offset,
343 size_t size,
344 enum dma_data_direction dir)
345{
346 const struct dma_map_ops *ops = get_dma_ops(dev);
347
348 BUG_ON(!valid_dma_direction(dir));
349 if (ops->sync_single_for_cpu)
350 ops->sync_single_for_cpu(dev, addr + offset, size, dir);
351 debug_dma_sync_single_range_for_cpu(dev, addr, offset, size, dir);
352}
353
354static inline void dma_sync_single_range_for_device(struct device *dev,
355 dma_addr_t addr,
356 unsigned long offset,
357 size_t size,
358 enum dma_data_direction dir)
359{
360 const struct dma_map_ops *ops = get_dma_ops(dev);
361
362 BUG_ON(!valid_dma_direction(dir));
363 if (ops->sync_single_for_device)
364 ops->sync_single_for_device(dev, addr + offset, size, dir);
365 debug_dma_sync_single_range_for_device(dev, addr, offset, size, dir);
366}
367
368static inline void
369dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
370 int nelems, enum dma_data_direction dir)
371{
Bart Van Assche52997092017-01-20 13:04:01 -0800372 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800373
374 BUG_ON(!valid_dma_direction(dir));
375 if (ops->sync_sg_for_cpu)
376 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
377 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
378}
379
380static inline void
381dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
382 int nelems, enum dma_data_direction dir)
383{
Bart Van Assche52997092017-01-20 13:04:01 -0800384 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800385
386 BUG_ON(!valid_dma_direction(dir));
387 if (ops->sync_sg_for_device)
388 ops->sync_sg_for_device(dev, sg, nelems, dir);
389 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
390
391}
392
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700393#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
394#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
395#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
396#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800397#define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
398#define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800399
400extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
401 void *cpu_addr, dma_addr_t dma_addr, size_t size);
402
403void *dma_common_contiguous_remap(struct page *page, size_t size,
404 unsigned long vm_flags,
405 pgprot_t prot, const void *caller);
406
407void *dma_common_pages_remap(struct page **pages, size_t size,
408 unsigned long vm_flags, pgprot_t prot,
409 const void *caller);
410void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
411
412/**
413 * dma_mmap_attrs - map a coherent DMA allocation into user space
414 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
415 * @vma: vm_area_struct describing requested user mapping
416 * @cpu_addr: kernel CPU-view address returned from dma_alloc_attrs
417 * @handle: device-view address returned from dma_alloc_attrs
418 * @size: size of memory originally requested in dma_alloc_attrs
419 * @attrs: attributes of mapping properties requested in dma_alloc_attrs
420 *
421 * Map a coherent DMA buffer previously allocated by dma_alloc_attrs
422 * into user space. The coherent DMA buffer must not be freed by the
423 * driver until the user space mapping has been released.
424 */
425static inline int
426dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700427 dma_addr_t dma_addr, size_t size, unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800428{
Bart Van Assche52997092017-01-20 13:04:01 -0800429 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800430 BUG_ON(!ops);
431 if (ops->mmap)
432 return ops->mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
433 return dma_common_mmap(dev, vma, cpu_addr, dma_addr, size);
434}
435
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700436#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 -0800437
438int
439dma_common_get_sgtable(struct device *dev, struct sg_table *sgt,
440 void *cpu_addr, dma_addr_t dma_addr, size_t size);
441
442static inline int
443dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt, void *cpu_addr,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700444 dma_addr_t dma_addr, size_t size,
445 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800446{
Bart Van Assche52997092017-01-20 13:04:01 -0800447 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800448 BUG_ON(!ops);
449 if (ops->get_sgtable)
450 return ops->get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
451 attrs);
452 return dma_common_get_sgtable(dev, sgt, cpu_addr, dma_addr, size);
453}
454
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700455#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 -0800456
457#ifndef arch_dma_alloc_attrs
458#define arch_dma_alloc_attrs(dev, flag) (true)
459#endif
460
461static inline void *dma_alloc_attrs(struct device *dev, size_t size,
462 dma_addr_t *dma_handle, gfp_t flag,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700463 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800464{
Bart Van Assche52997092017-01-20 13:04:01 -0800465 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800466 void *cpu_addr;
467
468 BUG_ON(!ops);
469
470 if (dma_alloc_from_coherent(dev, size, dma_handle, &cpu_addr))
471 return cpu_addr;
472
473 if (!arch_dma_alloc_attrs(&dev, &flag))
474 return NULL;
475 if (!ops->alloc)
476 return NULL;
477
478 cpu_addr = ops->alloc(dev, size, dma_handle, flag, attrs);
479 debug_dma_alloc_coherent(dev, size, *dma_handle, cpu_addr);
480 return cpu_addr;
481}
482
483static inline void dma_free_attrs(struct device *dev, size_t size,
484 void *cpu_addr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700485 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800486{
Bart Van Assche52997092017-01-20 13:04:01 -0800487 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800488
489 BUG_ON(!ops);
490 WARN_ON(irqs_disabled());
491
492 if (dma_release_from_coherent(dev, get_order(size), cpu_addr))
493 return;
494
Zhen Leid6b7eae2016-03-09 14:08:38 -0800495 if (!ops->free || !cpu_addr)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800496 return;
497
498 debug_dma_free_coherent(dev, size, cpu_addr, dma_handle);
499 ops->free(dev, size, cpu_addr, dma_handle, attrs);
500}
501
502static inline void *dma_alloc_coherent(struct device *dev, size_t size,
503 dma_addr_t *dma_handle, gfp_t flag)
504{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700505 return dma_alloc_attrs(dev, size, dma_handle, flag, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800506}
507
508static inline void dma_free_coherent(struct device *dev, size_t size,
509 void *cpu_addr, dma_addr_t dma_handle)
510{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700511 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800512}
513
514static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
515 dma_addr_t *dma_handle, gfp_t gfp)
516{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700517 return dma_alloc_attrs(dev, size, dma_handle, gfp,
518 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800519}
520
521static inline void dma_free_noncoherent(struct device *dev, size_t size,
522 void *cpu_addr, dma_addr_t dma_handle)
523{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700524 dma_free_attrs(dev, size, cpu_addr, dma_handle,
525 DMA_ATTR_NON_CONSISTENT);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800526}
527
528static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
529{
530 debug_dma_mapping_error(dev, dma_addr);
531
532 if (get_dma_ops(dev)->mapping_error)
533 return get_dma_ops(dev)->mapping_error(dev, dma_addr);
534
535#ifdef DMA_ERROR_CODE
536 return dma_addr == DMA_ERROR_CODE;
537#else
538 return 0;
539#endif
540}
541
542#ifndef HAVE_ARCH_DMA_SUPPORTED
543static inline int dma_supported(struct device *dev, u64 mask)
544{
Bart Van Assche52997092017-01-20 13:04:01 -0800545 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800546
547 if (!ops)
548 return 0;
549 if (!ops->dma_supported)
550 return 1;
551 return ops->dma_supported(dev, mask);
552}
553#endif
554
555#ifndef HAVE_ARCH_DMA_SET_MASK
556static inline int dma_set_mask(struct device *dev, u64 mask)
557{
Bart Van Assche52997092017-01-20 13:04:01 -0800558 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800559
560 if (ops->set_dma_mask)
561 return ops->set_dma_mask(dev, mask);
562
563 if (!dev->dma_mask || !dma_supported(dev, mask))
564 return -EIO;
565 *dev->dma_mask = mask;
566 return 0;
567}
Dan Williams1b0fac42007-07-15 23:40:26 -0700568#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900570static inline u64 dma_get_mask(struct device *dev)
571{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900572 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900573 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700574 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900575}
576
Rob Herring58af4a22012-03-20 14:33:01 -0500577#ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700578int dma_set_coherent_mask(struct device *dev, u64 mask);
579#else
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800580static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
581{
582 if (!dma_supported(dev, mask))
583 return -EIO;
584 dev->coherent_dma_mask = mask;
585 return 0;
586}
FUJITA Tomonori710224f2010-09-22 13:04:55 -0700587#endif
FUJITA Tomonori6a1961f2010-03-10 15:23:39 -0800588
Russell King4aa806b2013-06-26 13:49:44 +0100589/*
590 * Set both the DMA mask and the coherent DMA mask to the same thing.
591 * Note that we don't check the return value from dma_set_coherent_mask()
592 * as the DMA API guarantees that the coherent DMA mask can be set to
593 * the same or smaller than the streaming DMA mask.
594 */
595static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
596{
597 int rc = dma_set_mask(dev, mask);
598 if (rc == 0)
599 dma_set_coherent_mask(dev, mask);
600 return rc;
601}
602
Russell Kingfa6a8d62013-06-27 12:21:45 +0100603/*
604 * Similar to the above, except it deals with the case where the device
605 * does not have dev->dma_mask appropriately setup.
606 */
607static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
608{
609 dev->dma_mask = &dev->coherent_dma_mask;
610 return dma_set_mask_and_coherent(dev, mask);
611}
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613extern u64 dma_get_required_mask(struct device *dev);
614
Will Deacona3a60f82014-08-27 15:49:10 +0100615#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100616static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100617 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100618 bool coherent) { }
619#endif
620
621#ifndef arch_teardown_dma_ops
622static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee42014-04-24 11:30:04 -0400623#endif
624
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800625static inline unsigned int dma_get_max_seg_size(struct device *dev)
626{
Robin Murphy002edb62015-11-06 16:32:51 -0800627 if (dev->dma_parms && dev->dma_parms->max_segment_size)
628 return dev->dma_parms->max_segment_size;
629 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800630}
631
632static inline unsigned int dma_set_max_seg_size(struct device *dev,
633 unsigned int size)
634{
635 if (dev->dma_parms) {
636 dev->dma_parms->max_segment_size = size;
637 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800638 }
639 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800640}
641
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800642static inline unsigned long dma_get_seg_boundary(struct device *dev)
643{
Robin Murphy002edb62015-11-06 16:32:51 -0800644 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
645 return dev->dma_parms->segment_boundary_mask;
646 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800647}
648
649static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
650{
651 if (dev->dma_parms) {
652 dev->dma_parms->segment_boundary_mask = mask;
653 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800654 }
655 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800656}
657
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100658#ifndef dma_max_pfn
659static inline unsigned long dma_max_pfn(struct device *dev)
660{
661 return *dev->dma_mask >> PAGE_SHIFT;
662}
663#endif
664
Andrew Morton842fa692011-11-02 13:39:33 -0700665static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
666 dma_addr_t *dma_handle, gfp_t flag)
667{
Joe Perchesede23fa82013-08-26 22:45:23 -0700668 void *ret = dma_alloc_coherent(dev, size, dma_handle,
669 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700670 return ret;
671}
672
Heiko Carstense259f192010-08-13 09:39:18 +0200673#ifdef CONFIG_HAS_DMA
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700674static inline int dma_get_cache_alignment(void)
675{
676#ifdef ARCH_DMA_MINALIGN
677 return ARCH_DMA_MINALIGN;
678#endif
679 return 1;
680}
Heiko Carstense259f192010-08-13 09:39:18 +0200681#endif
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683/* flags for the coherent memory api */
684#define DMA_MEMORY_MAP 0x01
685#define DMA_MEMORY_IO 0x02
686#define DMA_MEMORY_INCLUDES_CHILDREN 0x04
687#define DMA_MEMORY_EXCLUSIVE 0x08
688
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800689#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
690int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
691 dma_addr_t device_addr, size_t size, int flags);
692void dma_release_declared_memory(struct device *dev);
693void *dma_mark_declared_memory_occupied(struct device *dev,
694 dma_addr_t device_addr, size_t size);
695#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600697dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 dma_addr_t device_addr, size_t size, int flags)
699{
700 return 0;
701}
702
703static inline void
704dma_release_declared_memory(struct device *dev)
705{
706}
707
708static inline void *
709dma_mark_declared_memory_occupied(struct device *dev,
710 dma_addr_t device_addr, size_t size)
711{
712 return ERR_PTR(-EBUSY);
713}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800714#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Tejun Heo9ac78492007-01-20 16:00:26 +0900716/*
717 * Managed DMA API
718 */
719extern void *dmam_alloc_coherent(struct device *dev, size_t size,
720 dma_addr_t *dma_handle, gfp_t gfp);
721extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
722 dma_addr_t dma_handle);
723extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
724 dma_addr_t *dma_handle, gfp_t gfp);
725extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
726 dma_addr_t dma_handle);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800727#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600728extern int dmam_declare_coherent_memory(struct device *dev,
729 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900730 dma_addr_t device_addr, size_t size,
731 int flags);
732extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800733#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900734static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600735 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900736 size_t size, gfp_t gfp)
737{
738 return 0;
739}
740
741static inline void dmam_release_declared_memory(struct device *dev)
742{
743}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800744#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900745
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800746static inline void *dma_alloc_wc(struct device *dev, size_t size,
747 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200748{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700749 return dma_alloc_attrs(dev, size, dma_addr, gfp,
750 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200751}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800752#ifndef dma_alloc_writecombine
753#define dma_alloc_writecombine dma_alloc_wc
754#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200755
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800756static inline void dma_free_wc(struct device *dev, size_t size,
757 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200758{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700759 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
760 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200761}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800762#ifndef dma_free_writecombine
763#define dma_free_writecombine dma_free_wc
764#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200765
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800766static inline int dma_mmap_wc(struct device *dev,
767 struct vm_area_struct *vma,
768 void *cpu_addr, dma_addr_t dma_addr,
769 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200770{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700771 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
772 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200773}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800774#ifndef dma_mmap_writecombine
775#define dma_mmap_writecombine dma_mmap_wc
776#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700777
Andrey Smirnov24813662016-09-28 15:22:33 -0700778#if defined(CONFIG_NEED_DMA_MAP_STATE) || defined(CONFIG_DMA_API_DEBUG)
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800779#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
780#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
781#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
782#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
783#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
784#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
785#else
786#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
787#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
788#define dma_unmap_addr(PTR, ADDR_NAME) (0)
789#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
790#define dma_unmap_len(PTR, LEN_NAME) (0)
791#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
792#endif
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794#endif