blob: 0f0078490df492c8ab60f618ccfd089f190e00d0 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Robert P. J. Day96532ba2008-02-03 15:06:26 +02002#ifndef _LINUX_DMA_MAPPING_H
3#define _LINUX_DMA_MAPPING_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
Robin Murphy002edb62015-11-06 16:32:51 -08005#include <linux/sizes.h>
Andrew Morton842fa692011-11-02 13:39:33 -07006#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/device.h>
8#include <linux/err.h>
Christoph Hellwige1c7e322016-01-20 15:02:05 -08009#include <linux/dma-debug.h>
Alexey Dobriyanb7f080c2011-06-16 11:01:34 +000010#include <linux/dma-direction.h>
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090011#include <linux/scatterlist.h>
Christoph Hellwige1c7e322016-01-20 15:02:05 -080012#include <linux/bug.h>
Tom Lendacky648babb2017-07-17 16:10:22 -050013#include <linux/mem_encrypt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070015/**
16 * List of possible attributes associated with a DMA mapping. The semantics
17 * of each attribute should be defined in Documentation/DMA-attributes.txt.
18 *
19 * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute
20 * forces all pending DMA writes to complete.
21 */
22#define DMA_ATTR_WRITE_BARRIER (1UL << 0)
23/*
24 * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
25 * may be weakly ordered, that is that reads and writes may pass each other.
26 */
27#define DMA_ATTR_WEAK_ORDERING (1UL << 1)
28/*
29 * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
30 * buffered to improve performance.
31 */
32#define DMA_ATTR_WRITE_COMBINE (1UL << 2)
33/*
34 * DMA_ATTR_NON_CONSISTENT: Lets the platform to choose to return either
35 * consistent or non-consistent memory as it sees fit.
36 */
37#define DMA_ATTR_NON_CONSISTENT (1UL << 3)
38/*
39 * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
40 * virtual mapping for the allocated buffer.
41 */
42#define DMA_ATTR_NO_KERNEL_MAPPING (1UL << 4)
43/*
44 * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
45 * the CPU cache for the given buffer assuming that it has been already
46 * transferred to 'device' domain.
47 */
48#define DMA_ATTR_SKIP_CPU_SYNC (1UL << 5)
49/*
50 * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
51 * in physical memory.
52 */
53#define DMA_ATTR_FORCE_CONTIGUOUS (1UL << 6)
54/*
55 * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
56 * that it's probably not worth the time to try to allocate memory to in a way
57 * that gives better TLB efficiency.
58 */
59#define DMA_ATTR_ALLOC_SINGLE_PAGES (1UL << 7)
Mauricio Faria de Oliveiraa9a62c92016-10-11 13:54:14 -070060/*
61 * DMA_ATTR_NO_WARN: This tells the DMA-mapping subsystem to suppress
62 * allocation failure reports (similarly to __GFP_NOWARN).
63 */
64#define DMA_ATTR_NO_WARN (1UL << 8)
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070065
Bjorn Helgaas77f2ea22014-04-30 11:20:53 -060066/*
Mitchel Humpherysb2fb3662017-01-06 18:58:11 +053067 * DMA_ATTR_PRIVILEGED: used to indicate that the buffer is fully
68 * accessible at an elevated privilege level (and ideally inaccessible or
69 * at least read-only at lesser-privileged levels).
70 */
71#define DMA_ATTR_PRIVILEGED (1UL << 9)
72
73/*
Bjorn Helgaas77f2ea22014-04-30 11:20:53 -060074 * A dma_addr_t can hold any valid DMA or bus address for the platform.
75 * It can be given to a device to use as a DMA source or target. A CPU cannot
76 * reference a dma_addr_t directly because there may be translation between
77 * its physical address space and the bus address space.
78 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090079struct dma_map_ops {
Marek Szyprowski613c4572012-03-28 16:36:27 +020080 void* (*alloc)(struct device *dev, size_t size,
81 dma_addr_t *dma_handle, gfp_t gfp,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070082 unsigned long attrs);
Marek Szyprowski613c4572012-03-28 16:36:27 +020083 void (*free)(struct device *dev, size_t size,
84 void *vaddr, dma_addr_t dma_handle,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070085 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010086 int (*mmap)(struct device *, struct vm_area_struct *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070087 void *, dma_addr_t, size_t,
88 unsigned long attrs);
Marek Szyprowski9adc5372011-12-21 16:55:33 +010089
Marek Szyprowskid2b74282012-06-13 10:05:52 +020090 int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070091 dma_addr_t, size_t, unsigned long attrs);
Marek Szyprowskid2b74282012-06-13 10:05:52 +020092
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090093 dma_addr_t (*map_page)(struct device *dev, struct page *page,
94 unsigned long offset, size_t size,
95 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070096 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +090097 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
98 size_t size, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -070099 unsigned long attrs);
Ricardo Ribalda Delgado04abab62015-02-11 13:53:15 +0100100 /*
101 * map_sg returns 0 on error and a value > 0 on success.
102 * It should never return a value < 0.
103 */
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900104 int (*map_sg)(struct device *dev, struct scatterlist *sg,
105 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700106 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900107 void (*unmap_sg)(struct device *dev,
108 struct scatterlist *sg, int nents,
109 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700110 unsigned long attrs);
Niklas Söderlundba409b32016-08-10 13:22:14 +0200111 dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr,
112 size_t size, enum dma_data_direction dir,
113 unsigned long attrs);
114 void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle,
115 size_t size, enum dma_data_direction dir,
116 unsigned long attrs);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900117 void (*sync_single_for_cpu)(struct device *dev,
118 dma_addr_t dma_handle, size_t size,
119 enum dma_data_direction dir);
120 void (*sync_single_for_device)(struct device *dev,
121 dma_addr_t dma_handle, size_t size,
122 enum dma_data_direction dir);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900123 void (*sync_sg_for_cpu)(struct device *dev,
124 struct scatterlist *sg, int nents,
125 enum dma_data_direction dir);
126 void (*sync_sg_for_device)(struct device *dev,
127 struct scatterlist *sg, int nents,
128 enum dma_data_direction dir);
Christoph Hellwigc9eb6172017-08-27 10:37:15 +0200129 void (*cache_sync)(struct device *dev, void *vaddr, size_t size,
130 enum dma_data_direction direction);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900131 int (*dma_supported)(struct device *dev, u64 mask);
Milton Miller3a8f7552011-06-24 09:05:23 +0000132 u64 (*get_required_mask)(struct device *dev);
FUJITA Tomonorif0402a22009-01-05 23:59:01 +0900133};
134
Christoph Hellwig42ee3ca2018-11-21 18:52:35 +0100135#define DMA_MAPPING_ERROR (~(dma_addr_t)0)
136
Christoph Hellwig002e6742018-01-09 16:30:23 +0100137extern const struct dma_map_ops dma_direct_ops;
Bart Van Assche551199a2017-01-20 13:04:07 -0800138extern const struct dma_map_ops dma_virt_ops;
Christian Borntraegera8463d42016-02-02 21:46:32 -0800139
Andrew Morton8f286c32007-10-18 03:05:07 -0700140#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
Borislav Petkov34c65382007-10-18 03:05:06 -0700141
James Bottomley32e8f702007-10-16 01:23:55 -0700142#define DMA_MASK_NONE 0x0ULL
143
Rolf Eike Beerd6bd3a32006-09-29 01:59:48 -0700144static inline int valid_dma_direction(int dma_direction)
145{
146 return ((dma_direction == DMA_BIDIRECTIONAL) ||
147 (dma_direction == DMA_TO_DEVICE) ||
148 (dma_direction == DMA_FROM_DEVICE));
149}
150
James Bottomley32e8f702007-10-16 01:23:55 -0700151static inline int is_device_dma_capable(struct device *dev)
152{
153 return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
154}
155
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800156#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
157/*
158 * These three functions are only for dma allocator.
159 * Don't use them in device drivers.
160 */
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100161int dma_alloc_from_dev_coherent(struct device *dev, ssize_t size,
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800162 dma_addr_t *dma_handle, void **ret);
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100163int dma_release_from_dev_coherent(struct device *dev, int order, void *vaddr);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800164
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100165int dma_mmap_from_dev_coherent(struct device *dev, struct vm_area_struct *vma,
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800166 void *cpu_addr, size_t size, int *ret);
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100167
168void *dma_alloc_from_global_coherent(ssize_t size, dma_addr_t *dma_handle);
169int dma_release_from_global_coherent(int order, void *vaddr);
170int dma_mmap_from_global_coherent(struct vm_area_struct *vma, void *cpu_addr,
171 size_t size, int *ret);
172
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800173#else
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100174#define dma_alloc_from_dev_coherent(dev, size, handle, ret) (0)
175#define dma_release_from_dev_coherent(dev, order, vaddr) (0)
176#define dma_mmap_from_dev_coherent(dev, vma, vaddr, order, ret) (0)
177
178static inline void *dma_alloc_from_global_coherent(ssize_t size,
179 dma_addr_t *dma_handle)
180{
181 return NULL;
182}
183
184static inline int dma_release_from_global_coherent(int order, void *vaddr)
185{
186 return 0;
187}
188
189static inline int dma_mmap_from_global_coherent(struct vm_area_struct *vma,
190 void *cpu_addr, size_t size,
191 int *ret)
192{
193 return 0;
194}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800195#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
196
Dan Williams1b0fac42007-07-15 23:40:26 -0700197#ifdef CONFIG_HAS_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198#include <asm/dma-mapping.h>
Bart Van Assche815dd182017-01-20 13:04:04 -0800199static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
200{
201 if (dev && dev->dma_ops)
202 return dev->dma_ops;
203 return get_arch_dma_ops(dev ? dev->bus : NULL);
204}
205
Bart Van Asscheca6e8e12017-01-20 13:04:03 -0800206static inline void set_dma_ops(struct device *dev,
207 const struct dma_map_ops *dma_ops)
208{
209 dev->dma_ops = dma_ops;
210}
Dan Williams1b0fac42007-07-15 23:40:26 -0700211#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800212/*
Geert Uytterhoevenf29ab492018-03-16 14:25:40 +0100213 * Define the dma api to allow compilation of dma dependent code.
214 * Code that depends on the dma-mapping API needs to set 'depends on HAS_DMA'
215 * in its Kconfig, unless it already depends on <something> || COMPILE_TEST,
216 * where <something> guarantuees the availability of the dma-mapping API.
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800217 */
Bart Van Assche52997092017-01-20 13:04:01 -0800218static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800219{
Geert Uytterhoevenf29ab492018-03-16 14:25:40 +0100220 return NULL;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800221}
222#endif
223
224static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
225 size_t size,
226 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700227 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800228{
Bart Van Assche52997092017-01-20 13:04:01 -0800229 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800230 dma_addr_t addr;
231
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800232 BUG_ON(!valid_dma_direction(dir));
Stephen Boyd99c65fa2018-10-08 00:20:07 -0700233 debug_dma_map_single(dev, ptr, size);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800234 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800235 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800236 dir, attrs);
237 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800238 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800239 dir, addr, true);
240 return addr;
241}
242
243static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
244 size_t size,
245 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700246 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800247{
Bart Van Assche52997092017-01-20 13:04:01 -0800248 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800249
250 BUG_ON(!valid_dma_direction(dir));
251 if (ops->unmap_page)
252 ops->unmap_page(dev, addr, size, dir, attrs);
253 debug_dma_unmap_page(dev, addr, size, dir, true);
254}
255
Christoph Hellwig7f0fee22018-12-06 12:24:27 -0800256static inline void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr,
257 size_t size, enum dma_data_direction dir, unsigned long attrs)
258{
259 return dma_unmap_single_attrs(dev, addr, size, dir, attrs);
260}
261
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800262/*
263 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
264 * It should never return a value < 0.
265 */
266static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
267 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700268 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800269{
Bart Van Assche52997092017-01-20 13:04:01 -0800270 const struct dma_map_ops *ops = get_dma_ops(dev);
Levin, Alexander (Sasha Levin)49502762017-11-15 17:35:51 -0800271 int ents;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800272
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800273 BUG_ON(!valid_dma_direction(dir));
274 ents = ops->map_sg(dev, sg, nents, dir, attrs);
275 BUG_ON(ents < 0);
276 debug_dma_map_sg(dev, sg, nents, ents, dir);
277
278 return ents;
279}
280
281static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
282 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700283 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800284{
Bart Van Assche52997092017-01-20 13:04:01 -0800285 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800286
287 BUG_ON(!valid_dma_direction(dir));
288 debug_dma_unmap_sg(dev, sg, nents, dir);
289 if (ops->unmap_sg)
290 ops->unmap_sg(dev, sg, nents, dir, attrs);
291}
292
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800293static inline dma_addr_t dma_map_page_attrs(struct device *dev,
294 struct page *page,
295 size_t offset, size_t size,
296 enum dma_data_direction dir,
297 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800298{
Bart Van Assche52997092017-01-20 13:04:01 -0800299 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800300 dma_addr_t addr;
301
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800302 BUG_ON(!valid_dma_direction(dir));
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800303 addr = ops->map_page(dev, page, offset, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800304 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
305
306 return addr;
307}
308
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200309static inline dma_addr_t dma_map_resource(struct device *dev,
310 phys_addr_t phys_addr,
311 size_t size,
312 enum dma_data_direction dir,
313 unsigned long attrs)
314{
Bart Van Assche52997092017-01-20 13:04:01 -0800315 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200316 dma_addr_t addr;
317
318 BUG_ON(!valid_dma_direction(dir));
319
320 /* Don't allow RAM to be mapped */
Niklas Söderlund3757dc42016-09-29 12:02:40 +0200321 BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200322
323 addr = phys_addr;
324 if (ops->map_resource)
325 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
326
327 debug_dma_map_resource(dev, phys_addr, size, dir, addr);
328
329 return addr;
330}
331
332static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
333 size_t size, enum dma_data_direction dir,
334 unsigned long attrs)
335{
Bart Van Assche52997092017-01-20 13:04:01 -0800336 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200337
338 BUG_ON(!valid_dma_direction(dir));
339 if (ops->unmap_resource)
340 ops->unmap_resource(dev, addr, size, dir, attrs);
341 debug_dma_unmap_resource(dev, addr, size, dir);
342}
343
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800344static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
345 size_t size,
346 enum dma_data_direction dir)
347{
Bart Van Assche52997092017-01-20 13:04:01 -0800348 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800349
350 BUG_ON(!valid_dma_direction(dir));
351 if (ops->sync_single_for_cpu)
352 ops->sync_single_for_cpu(dev, addr, size, dir);
353 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
354}
355
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100356static inline void dma_sync_single_range_for_cpu(struct device *dev,
357 dma_addr_t addr, unsigned long offset, size_t size,
358 enum dma_data_direction dir)
359{
360 return dma_sync_single_for_cpu(dev, addr + offset, size, dir);
361}
362
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800363static inline void dma_sync_single_for_device(struct device *dev,
364 dma_addr_t addr, size_t size,
365 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_single_for_device)
371 ops->sync_single_for_device(dev, addr, size, dir);
372 debug_dma_sync_single_for_device(dev, addr, size, dir);
373}
374
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800375static inline void dma_sync_single_range_for_device(struct device *dev,
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100376 dma_addr_t addr, unsigned long offset, size_t size,
377 enum dma_data_direction dir)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800378{
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100379 return dma_sync_single_for_device(dev, addr + offset, size, dir);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800380}
381
382static inline void
383dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
384 int nelems, enum dma_data_direction dir)
385{
Bart Van Assche52997092017-01-20 13:04:01 -0800386 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800387
388 BUG_ON(!valid_dma_direction(dir));
389 if (ops->sync_sg_for_cpu)
390 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
391 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
392}
393
394static inline void
395dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
396 int nelems, enum dma_data_direction dir)
397{
Bart Van Assche52997092017-01-20 13:04:01 -0800398 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800399
400 BUG_ON(!valid_dma_direction(dir));
401 if (ops->sync_sg_for_device)
402 ops->sync_sg_for_device(dev, sg, nelems, dir);
403 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
404
405}
406
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700407#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
408#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
409#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
410#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800411#define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
412#define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800413
Christoph Hellwig8ddbe592018-12-06 12:47:50 -0800414void dma_cache_sync(struct device *dev, void *vaddr, size_t size,
415 enum dma_data_direction dir);
Christoph Hellwigc9eb6172017-08-27 10:37:15 +0200416
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800417extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
Christoph Hellwig58b04402018-09-11 08:55:28 +0200418 void *cpu_addr, dma_addr_t dma_addr, size_t size,
419 unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800420
421void *dma_common_contiguous_remap(struct page *page, size_t size,
422 unsigned long vm_flags,
423 pgprot_t prot, const void *caller);
424
425void *dma_common_pages_remap(struct page **pages, size_t size,
426 unsigned long vm_flags, pgprot_t prot,
427 const void *caller);
428void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
429
Christoph Hellwig0c3b3172018-11-04 20:29:28 +0100430int __init dma_atomic_pool_init(gfp_t gfp, pgprot_t prot);
431bool dma_in_atomic_pool(void *start, size_t size);
432void *dma_alloc_from_pool(size_t size, struct page **ret_page, gfp_t flags);
433bool dma_free_from_pool(void *start, size_t size);
434
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800435int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
436 void *cpu_addr, dma_addr_t dma_addr, size_t size,
437 unsigned long attrs);
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700438#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 -0800439
440int
Christoph Hellwig9406a492018-08-23 09:39:38 +0200441dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, void *cpu_addr,
442 dma_addr_t dma_addr, size_t size, unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800443
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800444int dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt,
445 void *cpu_addr, dma_addr_t dma_addr, size_t size,
446 unsigned long attrs);
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700447#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 -0800448
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800449void *dma_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
450 gfp_t flag, unsigned long attrs);
451void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
452 dma_addr_t dma_handle, unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800453
454static inline void *dma_alloc_coherent(struct device *dev, size_t size,
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200455 dma_addr_t *dma_handle, gfp_t gfp)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800456{
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200457
458 return dma_alloc_attrs(dev, size, dma_handle, gfp,
459 (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800460}
461
462static inline void dma_free_coherent(struct device *dev, size_t size,
463 void *cpu_addr, dma_addr_t dma_handle)
464{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700465 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800466}
467
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800468static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
469{
Robin Murphy5237e952017-07-24 18:29:27 +0100470 debug_dma_mapping_error(dev, dma_addr);
Christoph Hellwig42ee3ca2018-11-21 18:52:35 +0100471
Christoph Hellwig42ee3ca2018-11-21 18:52:35 +0100472 if (dma_addr == DMA_MAPPING_ERROR)
Christoph Hellwigb14b9d22018-11-30 10:59:37 +0100473 return -ENOMEM;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800474 return 0;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800475}
476
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800477int dma_supported(struct device *dev, u64 mask);
478int dma_set_mask(struct device *dev, u64 mask);
479int dma_set_coherent_mask(struct device *dev, u64 mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900481static inline u64 dma_get_mask(struct device *dev)
482{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900483 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900484 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700485 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900486}
487
Russell King4aa806b2013-06-26 13:49:44 +0100488/*
489 * Set both the DMA mask and the coherent DMA mask to the same thing.
490 * Note that we don't check the return value from dma_set_coherent_mask()
491 * as the DMA API guarantees that the coherent DMA mask can be set to
492 * the same or smaller than the streaming DMA mask.
493 */
494static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
495{
496 int rc = dma_set_mask(dev, mask);
497 if (rc == 0)
498 dma_set_coherent_mask(dev, mask);
499 return rc;
500}
501
Russell Kingfa6a8d62013-06-27 12:21:45 +0100502/*
503 * Similar to the above, except it deals with the case where the device
504 * does not have dev->dma_mask appropriately setup.
505 */
506static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
507{
508 dev->dma_mask = &dev->coherent_dma_mask;
509 return dma_set_mask_and_coherent(dev, mask);
510}
511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512extern u64 dma_get_required_mask(struct device *dev);
513
Will Deacona3a60f82014-08-27 15:49:10 +0100514#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100515static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100516 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100517 bool coherent) { }
518#endif
519
520#ifndef arch_teardown_dma_ops
Christoph Hellwig1a0afc12018-09-25 13:16:55 -0700521static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee42014-04-24 11:30:04 -0400522#endif
523
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800524static inline unsigned int dma_get_max_seg_size(struct device *dev)
525{
Robin Murphy002edb62015-11-06 16:32:51 -0800526 if (dev->dma_parms && dev->dma_parms->max_segment_size)
527 return dev->dma_parms->max_segment_size;
528 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800529}
530
Niklas Söderlundc9d76d02018-08-29 23:29:21 +0200531static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800532{
533 if (dev->dma_parms) {
534 dev->dma_parms->max_segment_size = size;
535 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800536 }
537 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800538}
539
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800540static inline unsigned long dma_get_seg_boundary(struct device *dev)
541{
Robin Murphy002edb62015-11-06 16:32:51 -0800542 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
543 return dev->dma_parms->segment_boundary_mask;
544 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800545}
546
547static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
548{
549 if (dev->dma_parms) {
550 dev->dma_parms->segment_boundary_mask = mask;
551 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800552 }
553 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800554}
555
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100556#ifndef dma_max_pfn
557static inline unsigned long dma_max_pfn(struct device *dev)
558{
Christoph Hellwiga41ef1e2017-11-30 07:32:51 -0800559 return (*dev->dma_mask >> PAGE_SHIFT) + dev->dma_pfn_offset;
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100560}
561#endif
562
Andrew Morton842fa692011-11-02 13:39:33 -0700563static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
564 dma_addr_t *dma_handle, gfp_t flag)
565{
Joe Perchesede23fa82013-08-26 22:45:23 -0700566 void *ret = dma_alloc_coherent(dev, size, dma_handle,
567 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700568 return ret;
569}
570
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700571static inline int dma_get_cache_alignment(void)
572{
573#ifdef ARCH_DMA_MINALIGN
574 return ARCH_DMA_MINALIGN;
575#endif
576 return 1;
577}
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/* flags for the coherent memory api */
Christoph Hellwig2436bdc2017-08-25 17:13:09 +0200580#define DMA_MEMORY_EXCLUSIVE 0x01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800582#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
583int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
584 dma_addr_t device_addr, size_t size, int flags);
585void dma_release_declared_memory(struct device *dev);
586void *dma_mark_declared_memory_occupied(struct device *dev,
587 dma_addr_t device_addr, size_t size);
588#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600590dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 dma_addr_t device_addr, size_t size, int flags)
592{
Christoph Hellwig2436bdc2017-08-25 17:13:09 +0200593 return -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594}
595
596static inline void
597dma_release_declared_memory(struct device *dev)
598{
599}
600
601static inline void *
602dma_mark_declared_memory_occupied(struct device *dev,
603 dma_addr_t device_addr, size_t size)
604{
605 return ERR_PTR(-EBUSY);
606}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800607#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Tejun Heo9ac78492007-01-20 16:00:26 +0900609/*
610 * Managed DMA API
611 */
Geert Uytterhoevenab642e92018-03-16 14:25:41 +0100612#ifdef CONFIG_HAS_DMA
Tejun Heo9ac78492007-01-20 16:00:26 +0900613extern void *dmam_alloc_coherent(struct device *dev, size_t size,
614 dma_addr_t *dma_handle, gfp_t gfp);
615extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
616 dma_addr_t dma_handle);
Geert Uytterhoevenab642e92018-03-16 14:25:41 +0100617#else /* !CONFIG_HAS_DMA */
618static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
619 dma_addr_t *dma_handle, gfp_t gfp)
620{ return NULL; }
621static inline void dmam_free_coherent(struct device *dev, size_t size,
622 void *vaddr, dma_addr_t dma_handle) { }
623#endif /* !CONFIG_HAS_DMA */
624
Christoph Hellwig63d36c92017-06-12 19:15:04 +0200625extern void *dmam_alloc_attrs(struct device *dev, size_t size,
626 dma_addr_t *dma_handle, gfp_t gfp,
627 unsigned long attrs);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800628#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600629extern int dmam_declare_coherent_memory(struct device *dev,
630 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900631 dma_addr_t device_addr, size_t size,
632 int flags);
633extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800634#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900635static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600636 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900637 size_t size, gfp_t gfp)
638{
639 return 0;
640}
641
642static inline void dmam_release_declared_memory(struct device *dev)
643{
644}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800645#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900646
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800647static inline void *dma_alloc_wc(struct device *dev, size_t size,
648 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200649{
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200650 unsigned long attrs = DMA_ATTR_NO_WARN;
651
652 if (gfp & __GFP_NOWARN)
653 attrs |= DMA_ATTR_NO_WARN;
654
655 return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200656}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800657#ifndef dma_alloc_writecombine
658#define dma_alloc_writecombine dma_alloc_wc
659#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200660
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800661static inline void dma_free_wc(struct device *dev, size_t size,
662 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200663{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700664 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
665 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200666}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800667#ifndef dma_free_writecombine
668#define dma_free_writecombine dma_free_wc
669#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200670
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800671static inline int dma_mmap_wc(struct device *dev,
672 struct vm_area_struct *vma,
673 void *cpu_addr, dma_addr_t dma_addr,
674 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200675{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700676 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
677 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200678}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800679#ifndef dma_mmap_writecombine
680#define dma_mmap_writecombine dma_mmap_wc
681#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700682
Christoph Hellwigf616ab52018-05-09 06:53:49 +0200683#ifdef CONFIG_NEED_DMA_MAP_STATE
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800684#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
685#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
686#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
687#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
688#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
689#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
690#else
691#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
692#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
693#define dma_unmap_addr(PTR, ADDR_NAME) (0)
694#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
695#define dma_unmap_len(PTR, LEN_NAME) (0)
696#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
697#endif
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699#endif