blob: 7a7c3c762f5f71f6dde0b67ca7bcb0d2e47aadab [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef ASMARM_DMA_MAPPING_H
2#define ASMARM_DMA_MAPPING_H
3
4#ifdef __KERNEL__
5
Russell King98ed7d42008-08-10 12:10:49 +01006#include <linux/mm_types.h>
Jens Axboedee9ba82007-10-23 12:37:59 +02007#include <linux/scatterlist.h>
Russell King24056f52011-01-03 11:29:28 +00008#include <linux/dma-debug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
Dmitry Baryshkov1fe53262008-07-18 13:30:14 +040010#include <asm-generic/dma-coherent.h>
Russell King98ed7d42008-08-10 12:10:49 +010011#include <asm/memory.h>
12
Marek Szyprowski553ac782012-02-29 14:45:28 +010013#define DMA_ERROR_CODE (~0)
Marek Szyprowski2dc6a012012-02-10 19:55:20 +010014extern struct dma_map_ops arm_dma_ops;
15
16static inline struct dma_map_ops *get_dma_ops(struct device *dev)
17{
18 if (dev && dev->archdata.dma_ops)
19 return dev->archdata.dma_ops;
20 return &arm_dma_ops;
21}
22
23static inline void set_dma_ops(struct device *dev, struct dma_map_ops *ops)
24{
25 BUG_ON(!dev);
26 dev->archdata.dma_ops = ops;
27}
28
29#include <asm-generic/dma-mapping-common.h>
30
31static inline int dma_set_mask(struct device *dev, u64 mask)
32{
33 return get_dma_ops(dev)->set_dma_mask(dev, mask);
34}
Marek Szyprowski553ac782012-02-29 14:45:28 +010035
Russell King9eedd962011-01-03 00:00:17 +000036#ifdef __arch_page_to_dma
37#error Please update to __arch_pfn_to_dma
38#endif
39
Russell King98ed7d42008-08-10 12:10:49 +010040/*
Russell King9eedd962011-01-03 00:00:17 +000041 * dma_to_pfn/pfn_to_dma/dma_to_virt/virt_to_dma are architecture private
42 * functions used internally by the DMA-mapping API to provide DMA
43 * addresses. They must not be used by drivers.
Russell King98ed7d42008-08-10 12:10:49 +010044 */
Russell King9eedd962011-01-03 00:00:17 +000045#ifndef __arch_pfn_to_dma
46static inline dma_addr_t pfn_to_dma(struct device *dev, unsigned long pfn)
Nicolas Pitre58edb512008-09-09 15:54:13 -040047{
Russell King9eedd962011-01-03 00:00:17 +000048 return (dma_addr_t)__pfn_to_bus(pfn);
Nicolas Pitre58edb512008-09-09 15:54:13 -040049}
Russell King98ed7d42008-08-10 12:10:49 +010050
Russell King9eedd962011-01-03 00:00:17 +000051static inline unsigned long dma_to_pfn(struct device *dev, dma_addr_t addr)
Russell Kingef1baed2009-10-31 16:07:16 +000052{
Russell King9eedd962011-01-03 00:00:17 +000053 return __bus_to_pfn(addr);
Russell Kingef1baed2009-10-31 16:07:16 +000054}
55
Russell King98ed7d42008-08-10 12:10:49 +010056static inline void *dma_to_virt(struct device *dev, dma_addr_t addr)
57{
Catalin Marinas01f461a2011-08-23 13:59:14 +010058 return (void *)__bus_to_virt((unsigned long)addr);
Russell King98ed7d42008-08-10 12:10:49 +010059}
60
61static inline dma_addr_t virt_to_dma(struct device *dev, void *addr)
62{
63 return (dma_addr_t)__virt_to_bus((unsigned long)(addr));
64}
65#else
Russell King9eedd962011-01-03 00:00:17 +000066static inline dma_addr_t pfn_to_dma(struct device *dev, unsigned long pfn)
Russell King98ed7d42008-08-10 12:10:49 +010067{
Russell King9eedd962011-01-03 00:00:17 +000068 return __arch_pfn_to_dma(dev, pfn);
Russell King98ed7d42008-08-10 12:10:49 +010069}
70
Russell King9eedd962011-01-03 00:00:17 +000071static inline unsigned long dma_to_pfn(struct device *dev, dma_addr_t addr)
Russell Kingef1baed2009-10-31 16:07:16 +000072{
Russell King9eedd962011-01-03 00:00:17 +000073 return __arch_dma_to_pfn(dev, addr);
Russell Kingef1baed2009-10-31 16:07:16 +000074}
75
Russell King98ed7d42008-08-10 12:10:49 +010076static inline void *dma_to_virt(struct device *dev, dma_addr_t addr)
77{
78 return __arch_dma_to_virt(dev, addr);
79}
80
81static inline dma_addr_t virt_to_dma(struct device *dev, void *addr)
82{
83 return __arch_virt_to_dma(dev, addr);
84}
85#endif
Dmitry Baryshkov1fe53262008-07-18 13:30:14 +040086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 * DMA errors are defined by all-bits-set in the DMA address.
89 */
FUJITA Tomonori8d8bb392008-07-25 19:44:49 -070090static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Marek Szyprowski553ac782012-02-29 14:45:28 +010092 return dma_addr == DMA_ERROR_CODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093}
94
Russell Kingf454aa62007-02-12 19:26:05 +000095/*
96 * Dummy noncoherent implementation. We don't provide a dma_cache_sync
97 * function so drivers using this API are highlighted with build warnings.
98 */
Russell King3216a972008-09-25 22:23:31 +010099static inline void *dma_alloc_noncoherent(struct device *dev, size_t size,
100 dma_addr_t *handle, gfp_t gfp)
Russell Kingf454aa62007-02-12 19:26:05 +0000101{
102 return NULL;
103}
104
Russell King3216a972008-09-25 22:23:31 +0100105static inline void dma_free_noncoherent(struct device *dev, size_t size,
106 void *cpu_addr, dma_addr_t handle)
Russell Kingf454aa62007-02-12 19:26:05 +0000107{
108}
109
Marek Szyprowski15237e12012-02-10 19:55:20 +0100110extern int dma_supported(struct device *dev, u64 mask);
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/**
113 * dma_alloc_coherent - allocate consistent memory for DMA
114 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
115 * @size: required memory size
116 * @handle: bus-specific DMA address
117 *
118 * Allocate some uncached, unbuffered memory for a device for
119 * performing DMA. This function allocates pages, and will
120 * return the CPU-viewed address, and sets @handle to be the
121 * device-viewed address.
122 */
Russell King3216a972008-09-25 22:23:31 +0100123extern void *dma_alloc_coherent(struct device *, size_t, dma_addr_t *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125/**
126 * dma_free_coherent - free memory allocated by dma_alloc_coherent
127 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
128 * @size: size of memory originally requested in dma_alloc_coherent
129 * @cpu_addr: CPU-view address returned from dma_alloc_coherent
130 * @handle: device-view address returned from dma_alloc_coherent
131 *
132 * Free (and unmap) a DMA buffer previously allocated by
133 * dma_alloc_coherent().
134 *
135 * References to memory and mappings associated with cpu_addr/handle
136 * during and after this call executing are illegal.
137 */
Russell King3216a972008-09-25 22:23:31 +0100138extern void dma_free_coherent(struct device *, size_t, void *, dma_addr_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140/**
141 * dma_mmap_coherent - map a coherent DMA allocation into user space
142 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
143 * @vma: vm_area_struct describing requested user mapping
144 * @cpu_addr: kernel CPU-view address returned from dma_alloc_coherent
145 * @handle: device-view address returned from dma_alloc_coherent
146 * @size: size of memory originally requested in dma_alloc_coherent
147 *
148 * Map a coherent DMA buffer previously allocated by dma_alloc_coherent
149 * into user space. The coherent DMA buffer must not be freed by the
150 * driver until the user space mapping has been released.
151 */
Russell King3216a972008-09-25 22:23:31 +0100152int dma_mmap_coherent(struct device *, struct vm_area_struct *,
153 void *, dma_addr_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155
156/**
157 * dma_alloc_writecombine - allocate writecombining memory for DMA
158 * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
159 * @size: required memory size
160 * @handle: bus-specific DMA address
161 *
162 * Allocate some uncached, buffered memory for a device for
163 * performing DMA. This function allocates pages, and will
164 * return the CPU-viewed address, and sets @handle to be the
165 * device-viewed address.
166 */
Russell King3216a972008-09-25 22:23:31 +0100167extern void *dma_alloc_writecombine(struct device *, size_t, dma_addr_t *,
168 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170#define dma_free_writecombine(dev,size,cpu_addr,handle) \
171 dma_free_coherent(dev,size,cpu_addr,handle)
172
Russell King3216a972008-09-25 22:23:31 +0100173int dma_mmap_writecombine(struct device *, struct vm_area_struct *,
174 void *, dma_addr_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Jon Medhurst99d17172011-08-02 17:28:27 +0100176/*
177 * This can be called during boot to increase the size of the consistent
178 * DMA region above it's default value of 2MB. It must be called before the
179 * memory allocator is initialised, i.e. before any core_initcall.
180 */
181extern void __init init_consistent_dma_size(unsigned long size);
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Russell King8c8a0ec52008-09-25 21:52:49 +0100184/*
185 * For SA-1111, IXP425, and ADI systems the dma-mapping functions are "magic"
186 * and utilize bounce buffers as needed to work around limited DMA windows.
187 *
188 * On the SA-1111, a bug limits DMA to only certain regions of RAM.
189 * On the IXP425, the PCI inbound window is 64MB (256MB total RAM)
190 * On some ADI engineering systems, PCI inbound window is 32MB (12MB total RAM)
191 *
192 * The following are helper functions used by the dmabounce subystem
193 *
194 */
195
196/**
197 * dmabounce_register_dev
198 *
199 * @dev: valid struct device pointer
200 * @small_buf_size: size of buffers to use with small buffer pool
201 * @large_buf_size: size of buffers to use with large buffer pool (can be 0)
Russell King0703ed22011-07-04 08:32:21 +0100202 * @needs_bounce_fn: called to determine whether buffer needs bouncing
Russell King8c8a0ec52008-09-25 21:52:49 +0100203 *
204 * This function should be called by low-level platform code to register
205 * a device as requireing DMA buffer bouncing. The function will allocate
206 * appropriate DMA pools for the device.
Russell King8c8a0ec52008-09-25 21:52:49 +0100207 */
Russell King3216a972008-09-25 22:23:31 +0100208extern int dmabounce_register_dev(struct device *, unsigned long,
Russell King0703ed22011-07-04 08:32:21 +0100209 unsigned long, int (*)(struct device *, dma_addr_t, size_t));
Russell King8c8a0ec52008-09-25 21:52:49 +0100210
211/**
212 * dmabounce_unregister_dev
213 *
214 * @dev: valid struct device pointer
215 *
216 * This function should be called by low-level platform code when device
217 * that was previously registered with dmabounce_register_dev is removed
218 * from the system.
219 *
220 */
221extern void dmabounce_unregister_dev(struct device *);
222
Russell King125ab122008-09-25 22:16:22 +0100223
Russell King24056f52011-01-03 11:29:28 +0000224
Russell Kingafd1a322008-09-25 16:30:57 +0100225/*
226 * The scatter list versions of the above methods.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 */
Marek Szyprowski2dc6a012012-02-10 19:55:20 +0100228extern int arm_dma_map_sg(struct device *, struct scatterlist *, int,
229 enum dma_data_direction, struct dma_attrs *attrs);
230extern void arm_dma_unmap_sg(struct device *, struct scatterlist *, int,
231 enum dma_data_direction, struct dma_attrs *attrs);
232extern void arm_dma_sync_sg_for_cpu(struct device *, struct scatterlist *, int,
Russell King3216a972008-09-25 22:23:31 +0100233 enum dma_data_direction);
Marek Szyprowski2dc6a012012-02-10 19:55:20 +0100234extern void arm_dma_sync_sg_for_device(struct device *, struct scatterlist *, int,
Russell King3216a972008-09-25 22:23:31 +0100235 enum dma_data_direction);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237#endif /* __KERNEL__ */
238#endif