xref: /freebsd/sys/compat/linuxkpi/common/include/linux/dma-mapping.h (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUX_DMA_MAPPING_H_
32 #define _LINUX_DMA_MAPPING_H_
33 
34 #include <linux/types.h>
35 #include <linux/device.h>
36 #include <linux/err.h>
37 #include <linux/dma-attrs.h>
38 #include <linux/scatterlist.h>
39 #include <linux/mm.h>
40 #include <linux/page.h>
41 
42 #include <sys/systm.h>
43 #include <sys/malloc.h>
44 
45 #include <vm/vm.h>
46 #include <vm/vm_page.h>
47 #include <vm/pmap.h>
48 
49 #include <machine/bus.h>
50 #include <machine/pmap.h>
51 
52 enum dma_data_direction {
53 	DMA_BIDIRECTIONAL = 0,
54 	DMA_TO_DEVICE = 1,
55 	DMA_FROM_DEVICE = 2,
56 	DMA_NONE = 3,
57 };
58 
59 struct dma_map_ops {
60 	void* (*alloc_coherent)(struct device *dev, size_t size,
61 	    dma_addr_t *dma_handle, gfp_t gfp);
62 	void (*free_coherent)(struct device *dev, size_t size,
63 	    void *vaddr, dma_addr_t dma_handle);
64 	dma_addr_t (*map_page)(struct device *dev, struct page *page,
65 	    unsigned long offset, size_t size, enum dma_data_direction dir,
66 	    struct dma_attrs *attrs);
67 	void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
68 	    size_t size, enum dma_data_direction dir, struct dma_attrs *attrs);
69 	int (*map_sg)(struct device *dev, struct scatterlist *sg,
70 	    int nents, enum dma_data_direction dir, struct dma_attrs *attrs);
71 	void (*unmap_sg)(struct device *dev, struct scatterlist *sg, int nents,
72 	    enum dma_data_direction dir, struct dma_attrs *attrs);
73 	void (*sync_single_for_cpu)(struct device *dev, dma_addr_t dma_handle,
74 	    size_t size, enum dma_data_direction dir);
75 	void (*sync_single_for_device)(struct device *dev,
76 	    dma_addr_t dma_handle, size_t size, enum dma_data_direction dir);
77 	void (*sync_single_range_for_cpu)(struct device *dev,
78 	    dma_addr_t dma_handle, unsigned long offset, size_t size,
79 	    enum dma_data_direction dir);
80 	void (*sync_single_range_for_device)(struct device *dev,
81 	    dma_addr_t dma_handle, unsigned long offset, size_t size,
82 	    enum dma_data_direction dir);
83 	void (*sync_sg_for_cpu)(struct device *dev, struct scatterlist *sg,
84 	    int nents, enum dma_data_direction dir);
85 	void (*sync_sg_for_device)(struct device *dev, struct scatterlist *sg,
86 	    int nents, enum dma_data_direction dir);
87 	int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
88 	int (*dma_supported)(struct device *dev, u64 mask);
89 	int is_phys;
90 };
91 
92 #define	DMA_BIT_MASK(n)	((2ULL << ((n) - 1)) - 1ULL)
93 
94 static inline int
95 dma_supported(struct device *dev, u64 mask)
96 {
97 
98 	/* XXX busdma takes care of this elsewhere. */
99 	return (1);
100 }
101 
102 static inline int
103 dma_set_mask(struct device *dev, u64 dma_mask)
104 {
105 
106 	if (!dev->dma_mask || !dma_supported(dev, dma_mask))
107 		return -EIO;
108 
109 	*dev->dma_mask = dma_mask;
110 	return (0);
111 }
112 
113 static inline int
114 dma_set_coherent_mask(struct device *dev, u64 mask)
115 {
116 
117 	if (!dma_supported(dev, mask))
118 		return -EIO;
119 	/* XXX Currently we don't support a seperate coherent mask. */
120 	return 0;
121 }
122 
123 static inline void *
124 dma_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
125     gfp_t flag)
126 {
127 	vm_paddr_t high;
128 	size_t align;
129 	void *mem;
130 
131 	if (dev->dma_mask)
132 		high = *dev->dma_mask;
133 	else
134 		high = BUS_SPACE_MAXADDR_32BIT;
135 	align = PAGE_SIZE << get_order(size);
136 	mem = (void *)kmem_alloc_contig(kmem_arena, size, flag, 0, high, align,
137 	    0, VM_MEMATTR_DEFAULT);
138 	if (mem)
139 		*dma_handle = vtophys(mem);
140 	else
141 		*dma_handle = 0;
142 	return (mem);
143 }
144 
145 static inline void *
146 dma_zalloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
147     gfp_t flag)
148 {
149 
150 	return (dma_alloc_coherent(dev, size, dma_handle, flag | __GFP_ZERO));
151 }
152 
153 static inline void
154 dma_free_coherent(struct device *dev, size_t size, void *cpu_addr,
155     dma_addr_t dma_handle)
156 {
157 
158 	kmem_free(kmem_arena, (vm_offset_t)cpu_addr, size);
159 }
160 
161 /* XXX This only works with no iommu. */
162 static inline dma_addr_t
163 dma_map_single_attrs(struct device *dev, void *ptr, size_t size,
164     enum dma_data_direction dir, struct dma_attrs *attrs)
165 {
166 
167 	return vtophys(ptr);
168 }
169 
170 static inline void
171 dma_unmap_single_attrs(struct device *dev, dma_addr_t addr, size_t size,
172     enum dma_data_direction dir, struct dma_attrs *attrs)
173 {
174 }
175 
176 static inline int
177 dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl, int nents,
178     enum dma_data_direction dir, struct dma_attrs *attrs)
179 {
180 	struct scatterlist *sg;
181 	int i;
182 
183 	for_each_sg(sgl, sg, nents, i)
184 		sg_dma_address(sg) = sg_phys(sg);
185 
186 	return (nents);
187 }
188 
189 static inline void
190 dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg, int nents,
191     enum dma_data_direction dir, struct dma_attrs *attrs)
192 {
193 }
194 
195 static inline dma_addr_t
196 dma_map_page(struct device *dev, struct page *page,
197     unsigned long offset, size_t size, enum dma_data_direction direction)
198 {
199 
200 	return VM_PAGE_TO_PHYS(page) + offset;
201 }
202 
203 static inline void
204 dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size,
205     enum dma_data_direction direction)
206 {
207 }
208 
209 static inline void
210 dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle, size_t size,
211     enum dma_data_direction direction)
212 {
213 }
214 
215 static inline void
216 dma_sync_single(struct device *dev, dma_addr_t addr, size_t size,
217     enum dma_data_direction dir)
218 {
219 	dma_sync_single_for_cpu(dev, addr, size, dir);
220 }
221 
222 static inline void
223 dma_sync_single_for_device(struct device *dev, dma_addr_t dma_handle,
224     size_t size, enum dma_data_direction direction)
225 {
226 }
227 
228 static inline void
229 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg, int nelems,
230     enum dma_data_direction direction)
231 {
232 }
233 
234 static inline void
235 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg, int nelems,
236     enum dma_data_direction direction)
237 {
238 }
239 
240 static inline void
241 dma_sync_single_range_for_cpu(struct device *dev, dma_addr_t dma_handle,
242     unsigned long offset, size_t size, int direction)
243 {
244 }
245 
246 static inline void
247 dma_sync_single_range_for_device(struct device *dev, dma_addr_t dma_handle,
248     unsigned long offset, size_t size, int direction)
249 {
250 }
251 
252 static inline int
253 dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
254 {
255 
256 	return (0);
257 }
258 
259 static inline unsigned int dma_set_max_seg_size(struct device *dev,
260                                                  unsigned int size)
261 {
262         return (0);
263 }
264 
265 
266 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, NULL)
267 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, NULL)
268 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, NULL)
269 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, NULL)
270 
271 #define	DEFINE_DMA_UNMAP_ADDR(name)		dma_addr_t name
272 #define	DEFINE_DMA_UNMAP_LEN(name)		__u32 name
273 #define	dma_unmap_addr(p, name)			((p)->name)
274 #define	dma_unmap_addr_set(p, name, v)		(((p)->name) = (v))
275 #define	dma_unmap_len(p, name)			((p)->name)
276 #define	dma_unmap_len_set(p, name, v)		(((p)->name) = (v))
277 
278 extern int uma_align_cache;
279 #define	dma_get_cache_alignment()	uma_align_cache
280 
281 #endif	/* _LINUX_DMA_MAPPING_H_ */
282