blob: 269ee27fc3d9867a241d134a7e14252929287cba [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;
Robin Murphy90ac7062018-12-06 13:14:44 -0800139extern const struct dma_map_ops dma_dummy_ops;
Christian Borntraegera8463d42016-02-02 21:46:32 -0800140
Andrew Morton8f286c32007-10-18 03:05:07 -0700141#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
Borislav Petkov34c65382007-10-18 03:05:06 -0700142
James Bottomley32e8f702007-10-16 01:23:55 -0700143#define DMA_MASK_NONE 0x0ULL
144
Rolf Eike Beerd6bd3a32006-09-29 01:59:48 -0700145static inline int valid_dma_direction(int dma_direction)
146{
147 return ((dma_direction == DMA_BIDIRECTIONAL) ||
148 (dma_direction == DMA_TO_DEVICE) ||
149 (dma_direction == DMA_FROM_DEVICE));
150}
151
James Bottomley32e8f702007-10-16 01:23:55 -0700152static inline int is_device_dma_capable(struct device *dev)
153{
154 return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
155}
156
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800157#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
158/*
159 * These three functions are only for dma allocator.
160 * Don't use them in device drivers.
161 */
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100162int dma_alloc_from_dev_coherent(struct device *dev, ssize_t size,
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800163 dma_addr_t *dma_handle, void **ret);
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100164int dma_release_from_dev_coherent(struct device *dev, int order, void *vaddr);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800165
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100166int dma_mmap_from_dev_coherent(struct device *dev, struct vm_area_struct *vma,
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800167 void *cpu_addr, size_t size, int *ret);
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100168
169void *dma_alloc_from_global_coherent(ssize_t size, dma_addr_t *dma_handle);
170int dma_release_from_global_coherent(int order, void *vaddr);
171int dma_mmap_from_global_coherent(struct vm_area_struct *vma, void *cpu_addr,
172 size_t size, int *ret);
173
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800174#else
Vladimir Murzin43fc5092017-07-20 11:19:58 +0100175#define dma_alloc_from_dev_coherent(dev, size, handle, ret) (0)
176#define dma_release_from_dev_coherent(dev, order, vaddr) (0)
177#define dma_mmap_from_dev_coherent(dev, vma, vaddr, order, ret) (0)
178
179static inline void *dma_alloc_from_global_coherent(ssize_t size,
180 dma_addr_t *dma_handle)
181{
182 return NULL;
183}
184
185static inline int dma_release_from_global_coherent(int order, void *vaddr)
186{
187 return 0;
188}
189
190static inline int dma_mmap_from_global_coherent(struct vm_area_struct *vma,
191 void *cpu_addr, size_t size,
192 int *ret)
193{
194 return 0;
195}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800196#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
197
Dan Williams1b0fac42007-07-15 23:40:26 -0700198#ifdef CONFIG_HAS_DMA
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199#include <asm/dma-mapping.h>
Bart Van Assche815dd182017-01-20 13:04:04 -0800200static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
201{
202 if (dev && dev->dma_ops)
203 return dev->dma_ops;
204 return get_arch_dma_ops(dev ? dev->bus : NULL);
205}
206
Bart Van Asscheca6e8e12017-01-20 13:04:03 -0800207static inline void set_dma_ops(struct device *dev,
208 const struct dma_map_ops *dma_ops)
209{
210 dev->dma_ops = dma_ops;
211}
Dan Williams1b0fac42007-07-15 23:40:26 -0700212#else
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800213/*
Geert Uytterhoevenf29ab492018-03-16 14:25:40 +0100214 * Define the dma api to allow compilation of dma dependent code.
215 * Code that depends on the dma-mapping API needs to set 'depends on HAS_DMA'
216 * in its Kconfig, unless it already depends on <something> || COMPILE_TEST,
217 * where <something> guarantuees the availability of the dma-mapping API.
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800218 */
Bart Van Assche52997092017-01-20 13:04:01 -0800219static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800220{
Geert Uytterhoevenf29ab492018-03-16 14:25:40 +0100221 return NULL;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800222}
223#endif
224
225static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
226 size_t size,
227 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700228 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800229{
Bart Van Assche52997092017-01-20 13:04:01 -0800230 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800231 dma_addr_t addr;
232
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800233 BUG_ON(!valid_dma_direction(dir));
Stephen Boyd99c65fa2018-10-08 00:20:07 -0700234 debug_dma_map_single(dev, ptr, size);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800235 addr = ops->map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800236 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800237 dir, attrs);
238 debug_dma_map_page(dev, virt_to_page(ptr),
Geliang Tang8e994692016-01-20 15:02:12 -0800239 offset_in_page(ptr), size,
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800240 dir, addr, true);
241 return addr;
242}
243
244static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
245 size_t size,
246 enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700247 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800248{
Bart Van Assche52997092017-01-20 13:04:01 -0800249 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800250
251 BUG_ON(!valid_dma_direction(dir));
252 if (ops->unmap_page)
253 ops->unmap_page(dev, addr, size, dir, attrs);
254 debug_dma_unmap_page(dev, addr, size, dir, true);
255}
256
Christoph Hellwig7f0fee22018-12-06 12:24:27 -0800257static inline void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr,
258 size_t size, enum dma_data_direction dir, unsigned long attrs)
259{
260 return dma_unmap_single_attrs(dev, addr, size, dir, attrs);
261}
262
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800263/*
264 * dma_maps_sg_attrs returns 0 on error and > 0 on success.
265 * It should never return a value < 0.
266 */
267static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
268 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700269 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800270{
Bart Van Assche52997092017-01-20 13:04:01 -0800271 const struct dma_map_ops *ops = get_dma_ops(dev);
Levin, Alexander (Sasha Levin)49502762017-11-15 17:35:51 -0800272 int ents;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800273
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800274 BUG_ON(!valid_dma_direction(dir));
275 ents = ops->map_sg(dev, sg, nents, dir, attrs);
276 BUG_ON(ents < 0);
277 debug_dma_map_sg(dev, sg, nents, ents, dir);
278
279 return ents;
280}
281
282static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
283 int nents, enum dma_data_direction dir,
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700284 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800285{
Bart Van Assche52997092017-01-20 13:04:01 -0800286 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800287
288 BUG_ON(!valid_dma_direction(dir));
289 debug_dma_unmap_sg(dev, sg, nents, dir);
290 if (ops->unmap_sg)
291 ops->unmap_sg(dev, sg, nents, dir, attrs);
292}
293
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800294static inline dma_addr_t dma_map_page_attrs(struct device *dev,
295 struct page *page,
296 size_t offset, size_t size,
297 enum dma_data_direction dir,
298 unsigned long attrs)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800299{
Bart Van Assche52997092017-01-20 13:04:01 -0800300 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800301 dma_addr_t addr;
302
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800303 BUG_ON(!valid_dma_direction(dir));
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800304 addr = ops->map_page(dev, page, offset, size, dir, attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800305 debug_dma_map_page(dev, page, offset, size, dir, addr, false);
306
307 return addr;
308}
309
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200310static inline dma_addr_t dma_map_resource(struct device *dev,
311 phys_addr_t phys_addr,
312 size_t size,
313 enum dma_data_direction dir,
314 unsigned long attrs)
315{
Bart Van Assche52997092017-01-20 13:04:01 -0800316 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200317 dma_addr_t addr;
318
319 BUG_ON(!valid_dma_direction(dir));
320
321 /* Don't allow RAM to be mapped */
Niklas Söderlund3757dc42016-09-29 12:02:40 +0200322 BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200323
324 addr = phys_addr;
325 if (ops->map_resource)
326 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
327
328 debug_dma_map_resource(dev, phys_addr, size, dir, addr);
329
330 return addr;
331}
332
333static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
334 size_t size, enum dma_data_direction dir,
335 unsigned long attrs)
336{
Bart Van Assche52997092017-01-20 13:04:01 -0800337 const struct dma_map_ops *ops = get_dma_ops(dev);
Niklas Söderlund6f3d8792016-08-10 13:22:16 +0200338
339 BUG_ON(!valid_dma_direction(dir));
340 if (ops->unmap_resource)
341 ops->unmap_resource(dev, addr, size, dir, attrs);
342 debug_dma_unmap_resource(dev, addr, size, dir);
343}
344
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800345static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
346 size_t size,
347 enum dma_data_direction dir)
348{
Bart Van Assche52997092017-01-20 13:04:01 -0800349 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800350
351 BUG_ON(!valid_dma_direction(dir));
352 if (ops->sync_single_for_cpu)
353 ops->sync_single_for_cpu(dev, addr, size, dir);
354 debug_dma_sync_single_for_cpu(dev, addr, size, dir);
355}
356
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100357static inline void dma_sync_single_range_for_cpu(struct device *dev,
358 dma_addr_t addr, unsigned long offset, size_t size,
359 enum dma_data_direction dir)
360{
361 return dma_sync_single_for_cpu(dev, addr + offset, size, dir);
362}
363
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800364static inline void dma_sync_single_for_device(struct device *dev,
365 dma_addr_t addr, size_t size,
366 enum dma_data_direction dir)
367{
Bart Van Assche52997092017-01-20 13:04:01 -0800368 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800369
370 BUG_ON(!valid_dma_direction(dir));
371 if (ops->sync_single_for_device)
372 ops->sync_single_for_device(dev, addr, size, dir);
373 debug_dma_sync_single_for_device(dev, addr, size, dir);
374}
375
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800376static inline void dma_sync_single_range_for_device(struct device *dev,
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100377 dma_addr_t addr, unsigned long offset, size_t size,
378 enum dma_data_direction dir)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800379{
Christoph Hellwig8d59b5f2018-12-03 14:58:59 +0100380 return dma_sync_single_for_device(dev, addr + offset, size, dir);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800381}
382
383static inline void
384dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
385 int nelems, enum dma_data_direction dir)
386{
Bart Van Assche52997092017-01-20 13:04:01 -0800387 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800388
389 BUG_ON(!valid_dma_direction(dir));
390 if (ops->sync_sg_for_cpu)
391 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
392 debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
393}
394
395static inline void
396dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
397 int nelems, enum dma_data_direction dir)
398{
Bart Van Assche52997092017-01-20 13:04:01 -0800399 const struct dma_map_ops *ops = get_dma_ops(dev);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800400
401 BUG_ON(!valid_dma_direction(dir));
402 if (ops->sync_sg_for_device)
403 ops->sync_sg_for_device(dev, sg, nelems, dir);
404 debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
405
406}
407
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700408#define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
409#define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
410#define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
411#define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
Alexander Duyck0495c3d2016-12-14 15:05:23 -0800412#define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
413#define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800414
Christoph Hellwig8ddbe592018-12-06 12:47:50 -0800415void dma_cache_sync(struct device *dev, void *vaddr, size_t size,
416 enum dma_data_direction dir);
Christoph Hellwigc9eb6172017-08-27 10:37:15 +0200417
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800418extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
Christoph Hellwig58b04402018-09-11 08:55:28 +0200419 void *cpu_addr, dma_addr_t dma_addr, size_t size,
420 unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800421
422void *dma_common_contiguous_remap(struct page *page, size_t size,
423 unsigned long vm_flags,
424 pgprot_t prot, const void *caller);
425
426void *dma_common_pages_remap(struct page **pages, size_t size,
427 unsigned long vm_flags, pgprot_t prot,
428 const void *caller);
429void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
430
Christoph Hellwig0c3b3172018-11-04 20:29:28 +0100431int __init dma_atomic_pool_init(gfp_t gfp, pgprot_t prot);
432bool dma_in_atomic_pool(void *start, size_t size);
433void *dma_alloc_from_pool(size_t size, struct page **ret_page, gfp_t flags);
434bool dma_free_from_pool(void *start, size_t size);
435
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800436int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
437 void *cpu_addr, dma_addr_t dma_addr, size_t size,
438 unsigned long attrs);
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700439#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 -0800440
441int
Christoph Hellwig9406a492018-08-23 09:39:38 +0200442dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, void *cpu_addr,
443 dma_addr_t dma_addr, size_t size, unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800444
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800445int dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt,
446 void *cpu_addr, dma_addr_t dma_addr, size_t size,
447 unsigned long attrs);
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700448#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 -0800449
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800450void *dma_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
451 gfp_t flag, unsigned long attrs);
452void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
453 dma_addr_t dma_handle, unsigned long attrs);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800454
455static inline void *dma_alloc_coherent(struct device *dev, size_t size,
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200456 dma_addr_t *dma_handle, gfp_t gfp)
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800457{
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200458
459 return dma_alloc_attrs(dev, size, dma_handle, gfp,
460 (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800461}
462
463static inline void dma_free_coherent(struct device *dev, size_t size,
464 void *cpu_addr, dma_addr_t dma_handle)
465{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700466 return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800467}
468
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800469static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
470{
Robin Murphy5237e952017-07-24 18:29:27 +0100471 debug_dma_mapping_error(dev, dma_addr);
Christoph Hellwig42ee3ca2018-11-21 18:52:35 +0100472
Christoph Hellwig42ee3ca2018-11-21 18:52:35 +0100473 if (dma_addr == DMA_MAPPING_ERROR)
Christoph Hellwigb14b9d22018-11-30 10:59:37 +0100474 return -ENOMEM;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800475 return 0;
Christoph Hellwige1c7e322016-01-20 15:02:05 -0800476}
477
Christoph Hellwig7249c1a2018-12-06 12:43:30 -0800478int dma_supported(struct device *dev, u64 mask);
479int dma_set_mask(struct device *dev, u64 mask);
480int dma_set_coherent_mask(struct device *dev, u64 mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900482static inline u64 dma_get_mask(struct device *dev)
483{
FUJITA Tomonori07a2c012008-09-19 02:02:05 +0900484 if (dev && dev->dma_mask && *dev->dma_mask)
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900485 return *dev->dma_mask;
Yang Hongyang284901a2009-04-06 19:01:15 -0700486 return DMA_BIT_MASK(32);
FUJITA Tomonori589fc9a2008-09-12 19:42:34 +0900487}
488
Russell King4aa806b2013-06-26 13:49:44 +0100489/*
490 * Set both the DMA mask and the coherent DMA mask to the same thing.
491 * Note that we don't check the return value from dma_set_coherent_mask()
492 * as the DMA API guarantees that the coherent DMA mask can be set to
493 * the same or smaller than the streaming DMA mask.
494 */
495static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
496{
497 int rc = dma_set_mask(dev, mask);
498 if (rc == 0)
499 dma_set_coherent_mask(dev, mask);
500 return rc;
501}
502
Russell Kingfa6a8d62013-06-27 12:21:45 +0100503/*
504 * Similar to the above, except it deals with the case where the device
505 * does not have dev->dma_mask appropriately setup.
506 */
507static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
508{
509 dev->dma_mask = &dev->coherent_dma_mask;
510 return dma_set_mask_and_coherent(dev, mask);
511}
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513extern u64 dma_get_required_mask(struct device *dev);
514
Will Deacona3a60f82014-08-27 15:49:10 +0100515#ifndef arch_setup_dma_ops
Will Deacon97890ba2014-08-27 16:24:20 +0100516static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
Robin Murphy53c92d72016-04-07 18:42:05 +0100517 u64 size, const struct iommu_ops *iommu,
Will Deacon97890ba2014-08-27 16:24:20 +0100518 bool coherent) { }
519#endif
520
521#ifndef arch_teardown_dma_ops
Christoph Hellwig1a0afc12018-09-25 13:16:55 -0700522static inline void arch_teardown_dma_ops(struct device *dev) { }
Santosh Shilimkar591c1ee2014-04-24 11:30:04 -0400523#endif
524
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800525static inline unsigned int dma_get_max_seg_size(struct device *dev)
526{
Robin Murphy002edb62015-11-06 16:32:51 -0800527 if (dev->dma_parms && dev->dma_parms->max_segment_size)
528 return dev->dma_parms->max_segment_size;
529 return SZ_64K;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800530}
531
Niklas Söderlundc9d76d02018-08-29 23:29:21 +0200532static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800533{
534 if (dev->dma_parms) {
535 dev->dma_parms->max_segment_size = size;
536 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800537 }
538 return -EIO;
FUJITA Tomonori6b7b6512008-02-04 22:27:55 -0800539}
540
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800541static inline unsigned long dma_get_seg_boundary(struct device *dev)
542{
Robin Murphy002edb62015-11-06 16:32:51 -0800543 if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
544 return dev->dma_parms->segment_boundary_mask;
545 return DMA_BIT_MASK(32);
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800546}
547
548static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
549{
550 if (dev->dma_parms) {
551 dev->dma_parms->segment_boundary_mask = mask;
552 return 0;
Robin Murphy002edb62015-11-06 16:32:51 -0800553 }
554 return -EIO;
FUJITA Tomonorid22a6962008-02-04 22:28:13 -0800555}
556
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100557#ifndef dma_max_pfn
558static inline unsigned long dma_max_pfn(struct device *dev)
559{
Christoph Hellwiga41ef1e2017-11-30 07:32:51 -0800560 return (*dev->dma_mask >> PAGE_SHIFT) + dev->dma_pfn_offset;
Santosh Shilimkar00c8f162013-07-29 14:18:48 +0100561}
562#endif
563
Andrew Morton842fa692011-11-02 13:39:33 -0700564static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
565 dma_addr_t *dma_handle, gfp_t flag)
566{
Joe Perchesede23fa82013-08-26 22:45:23 -0700567 void *ret = dma_alloc_coherent(dev, size, dma_handle,
568 flag | __GFP_ZERO);
Andrew Morton842fa692011-11-02 13:39:33 -0700569 return ret;
570}
571
FUJITA Tomonori4565f012010-08-10 18:03:22 -0700572static inline int dma_get_cache_alignment(void)
573{
574#ifdef ARCH_DMA_MINALIGN
575 return ARCH_DMA_MINALIGN;
576#endif
577 return 1;
578}
579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580/* flags for the coherent memory api */
Christoph Hellwig2436bdc2017-08-25 17:13:09 +0200581#define DMA_MEMORY_EXCLUSIVE 0x01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800583#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
584int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
585 dma_addr_t device_addr, size_t size, int flags);
586void dma_release_declared_memory(struct device *dev);
587void *dma_mark_declared_memory_occupied(struct device *dev,
588 dma_addr_t device_addr, size_t size);
589#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590static inline int
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600591dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 dma_addr_t device_addr, size_t size, int flags)
593{
Christoph Hellwig2436bdc2017-08-25 17:13:09 +0200594 return -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
596
597static inline void
598dma_release_declared_memory(struct device *dev)
599{
600}
601
602static inline void *
603dma_mark_declared_memory_occupied(struct device *dev,
604 dma_addr_t device_addr, size_t size)
605{
606 return ERR_PTR(-EBUSY);
607}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800608#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Tejun Heo9ac78492007-01-20 16:00:26 +0900610/*
611 * Managed DMA API
612 */
Geert Uytterhoevenab642e92018-03-16 14:25:41 +0100613#ifdef CONFIG_HAS_DMA
Tejun Heo9ac78492007-01-20 16:00:26 +0900614extern void *dmam_alloc_coherent(struct device *dev, size_t size,
615 dma_addr_t *dma_handle, gfp_t gfp);
616extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
617 dma_addr_t dma_handle);
Geert Uytterhoevenab642e92018-03-16 14:25:41 +0100618#else /* !CONFIG_HAS_DMA */
619static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
620 dma_addr_t *dma_handle, gfp_t gfp)
621{ return NULL; }
622static inline void dmam_free_coherent(struct device *dev, size_t size,
623 void *vaddr, dma_addr_t dma_handle) { }
624#endif /* !CONFIG_HAS_DMA */
625
Christoph Hellwig63d36c92017-06-12 19:15:04 +0200626extern void *dmam_alloc_attrs(struct device *dev, size_t size,
627 dma_addr_t *dma_handle, gfp_t gfp,
628 unsigned long attrs);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800629#ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600630extern int dmam_declare_coherent_memory(struct device *dev,
631 phys_addr_t phys_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900632 dma_addr_t device_addr, size_t size,
633 int flags);
634extern void dmam_release_declared_memory(struct device *dev);
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800635#else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900636static inline int dmam_declare_coherent_memory(struct device *dev,
Bjorn Helgaas88a984b2014-05-20 16:54:22 -0600637 phys_addr_t phys_addr, dma_addr_t device_addr,
Tejun Heo9ac78492007-01-20 16:00:26 +0900638 size_t size, gfp_t gfp)
639{
640 return 0;
641}
642
643static inline void dmam_release_declared_memory(struct device *dev)
644{
645}
Christoph Hellwig20d666e2016-01-20 15:02:09 -0800646#endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
Tejun Heo9ac78492007-01-20 16:00:26 +0900647
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800648static inline void *dma_alloc_wc(struct device *dev, size_t size,
649 dma_addr_t *dma_addr, gfp_t gfp)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200650{
Christoph Hellwig7ed1d912018-09-24 13:06:58 +0200651 unsigned long attrs = DMA_ATTR_NO_WARN;
652
653 if (gfp & __GFP_NOWARN)
654 attrs |= DMA_ATTR_NO_WARN;
655
656 return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200657}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800658#ifndef dma_alloc_writecombine
659#define dma_alloc_writecombine dma_alloc_wc
660#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200661
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800662static inline void dma_free_wc(struct device *dev, size_t size,
663 void *cpu_addr, dma_addr_t dma_addr)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200664{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700665 return dma_free_attrs(dev, size, cpu_addr, dma_addr,
666 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200667}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800668#ifndef dma_free_writecombine
669#define dma_free_writecombine dma_free_wc
670#endif
Thierry Redingb4bbb102014-06-27 11:56:58 +0200671
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800672static inline int dma_mmap_wc(struct device *dev,
673 struct vm_area_struct *vma,
674 void *cpu_addr, dma_addr_t dma_addr,
675 size_t size)
Thierry Redingb4bbb102014-06-27 11:56:58 +0200676{
Krzysztof Kozlowski00085f12016-08-03 13:46:00 -0700677 return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
678 DMA_ATTR_WRITE_COMBINE);
Thierry Redingb4bbb102014-06-27 11:56:58 +0200679}
Luis R. Rodriguezf6e45662016-01-22 18:34:22 -0800680#ifndef dma_mmap_writecombine
681#define dma_mmap_writecombine dma_mmap_wc
682#endif
Arthur Kepner74bc7ce2008-04-29 01:00:30 -0700683
Christoph Hellwigf616ab52018-05-09 06:53:49 +0200684#ifdef CONFIG_NEED_DMA_MAP_STATE
FUJITA Tomonori0acedc12010-03-10 15:23:31 -0800685#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME) dma_addr_t ADDR_NAME
686#define DEFINE_DMA_UNMAP_LEN(LEN_NAME) __u32 LEN_NAME
687#define dma_unmap_addr(PTR, ADDR_NAME) ((PTR)->ADDR_NAME)
688#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) (((PTR)->ADDR_NAME) = (VAL))
689#define dma_unmap_len(PTR, LEN_NAME) ((PTR)->LEN_NAME)
690#define dma_unmap_len_set(PTR, LEN_NAME, VAL) (((PTR)->LEN_NAME) = (VAL))
691#else
692#define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
693#define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
694#define dma_unmap_addr(PTR, ADDR_NAME) (0)
695#define dma_unmap_addr_set(PTR, ADDR_NAME, VAL) do { } while (0)
696#define dma_unmap_len(PTR, LEN_NAME) (0)
697#define dma_unmap_len_set(PTR, LEN_NAME, VAL) do { } while (0)
698#endif
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700#endif