sys/compat/linuxkpi/common/include/linux/dma-mapping.h

   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
  51 enum dma_data_direction {
  52         DMA_BIDIRECTIONAL = 0,
  53         DMA_TO_DEVICE = 1,
  54         DMA_FROM_DEVICE = 2,
  55         DMA_NONE = 3,
  56 };
  57
  58 struct dma_map_ops {
  59         void* (*alloc_coherent)(struct device *dev, size_t size,
  60             dma_addr_t *dma_handle, gfp_t gfp);
  61         void (*free_coherent)(struct device *dev, size_t size,
  62             void *vaddr, dma_addr_t dma_handle);
  63         dma_addr_t (*map_page)(struct device *dev, struct page *page,
  64             unsigned long offset, size_t size, enum dma_data_direction dir,
  65             struct dma_attrs *attrs);
  66         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  67             size_t size, enum dma_data_direction dir, struct dma_attrs *attrs);
  68         int (*map_sg)(struct device *dev, struct scatterlist *sg,
  69             int nents, enum dma_data_direction dir, struct dma_attrs *attrs);
  70         void (*unmap_sg)(struct device *dev, struct scatterlist *sg, int nents,
  71             enum dma_data_direction dir, struct dma_attrs *attrs);
  72         void (*sync_single_for_cpu)(struct device *dev, dma_addr_t dma_handle,
  73             size_t size, enum dma_data_direction dir);
  74         void (*sync_single_for_device)(struct device *dev,
  75             dma_addr_t dma_handle, size_t size, enum dma_data_direction dir);
  76         void (*sync_single_range_for_cpu)(struct device *dev,
  77             dma_addr_t dma_handle, unsigned long offset, size_t size,
  78             enum dma_data_direction dir);
  79         void (*sync_single_range_for_device)(struct device *dev,
  80             dma_addr_t dma_handle, unsigned long offset, size_t size,
  81             enum dma_data_direction dir);
  82         void (*sync_sg_for_cpu)(struct device *dev, struct scatterlist *sg,
  83             int nents, enum dma_data_direction dir);
  84         void (*sync_sg_for_device)(struct device *dev, struct scatterlist *sg,
  85             int nents, enum dma_data_direction dir);
  86         int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
  87         int (*dma_supported)(struct device *dev, u64 mask);
  88         int is_phys;
  89 };
  90
  91 #define DMA_BIT_MASK(n) ((2ULL << ((n) - 1)) - 1ULL)
  92
  93 static inline int
  94 dma_supported(struct device *dev, u64 mask)
  95 {
  96
  97         /* XXX busdma takes care of this elsewhere. */
  98         return (1);
  99 }
 100
 101 static inline int
 102 dma_set_mask(struct device *dev, u64 dma_mask)
 103 {
 104
 105         if (!dev->dma_mask || !dma_supported(dev, dma_mask))
 106                 return -EIO;
 107
 108         *dev->dma_mask = dma_mask;
 109         return (0);
 110 }
 111
 112 static inline int
 113 dma_set_coherent_mask(struct device *dev, u64 mask)
 114 {
 115
 116         if (!dma_supported(dev, mask))
 117                 return -EIO;
 118         /* XXX Currently we don't support a separate coherent mask. */
 119         return 0;
 120 }
 121
 122 static inline int
 123 dma_set_mask_and_coherent(struct device *dev, u64 mask)
 124 {
 125         int r;
 126
 127         r = dma_set_mask(dev, mask);
 128         if (r == 0)
 129                 dma_set_coherent_mask(dev, mask);
 130         return (r);
 131 }
 132
 133 static inline void *
 134 dma_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
 135     gfp_t flag)
 136 {
 137         vm_paddr_t high;
 138         size_t align;
 139         void *mem;
 140
 141         if (dev != NULL && dev->dma_mask)
 142                 high = *dev->dma_mask;
 143         else if (flag & GFP_DMA32)
 144                 high = BUS_SPACE_MAXADDR_32BIT;
 145         else
 146                 high = BUS_SPACE_MAXADDR;
 147         align = PAGE_SIZE << get_order(size);
 148         mem = (void *)kmem_alloc_contig(kmem_arena, size, flag, 0, high, align,
 149             0, VM_MEMATTR_DEFAULT);
 150         if (mem)
 151                 *dma_handle = vtophys(mem);
 152         else
 153                 *dma_handle = 0;
 154         return (mem);
 155 }
 156
 157 static inline void *
 158 dma_zalloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
 159     gfp_t flag)
 160 {
 161
 162         return (dma_alloc_coherent(dev, size, dma_handle, flag | __GFP_ZERO));
 163 }
 164
 165 static inline void
 166 dma_free_coherent(struct device *dev, size_t size, void *cpu_addr,
 167     dma_addr_t dma_handle)
 168 {
 169
 170         kmem_free(kmem_arena, (vm_offset_t)cpu_addr, size);
 171 }
 172
 173 /* XXX This only works with no iommu. */
 174 static inline dma_addr_t
 175 dma_map_single_attrs(struct device *dev, void *ptr, size_t size,
 176     enum dma_data_direction dir, struct dma_attrs *attrs)
 177 {
 178
 179         return vtophys(ptr);
 180 }
 181
 182 static inline void
 183 dma_unmap_single_attrs(struct device *dev, dma_addr_t addr, size_t size,
 184     enum dma_data_direction dir, struct dma_attrs *attrs)
 185 {
 186 }
 187
 188 static inline int
 189 dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl, int nents,
 190     enum dma_data_direction dir, struct dma_attrs *attrs)
 191 {
 192         struct scatterlist *sg;
 193         int i;
 194
 195         for_each_sg(sgl, sg, nents, i)
 196                 sg_dma_address(sg) = sg_phys(sg);
 197
 198         return (nents);
 199 }
 200
 201 static inline void
 202 dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg, int nents,
 203     enum dma_data_direction dir, struct dma_attrs *attrs)
 204 {
 205 }
 206
 207 static inline dma_addr_t
 208 dma_map_page(struct device *dev, struct page *page,
 209     unsigned long offset, size_t size, enum dma_data_direction direction)
 210 {
 211
 212         return VM_PAGE_TO_PHYS(page) + offset;
 213 }
 214
 215 static inline void
 216 dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size,
 217     enum dma_data_direction direction)
 218 {
 219 }
 220
 221 static inline void
 222 dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle, size_t size,
 223     enum dma_data_direction direction)
 224 {
 225 }
 226
 227 static inline void
 228 dma_sync_single(struct device *dev, dma_addr_t addr, size_t size,
 229     enum dma_data_direction dir)
 230 {
 231         dma_sync_single_for_cpu(dev, addr, size, dir);
 232 }
 233
 234 static inline void
 235 dma_sync_single_for_device(struct device *dev, dma_addr_t dma_handle,
 236     size_t size, enum dma_data_direction direction)
 237 {
 238 }
 239
 240 static inline void
 241 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg, int nelems,
 242     enum dma_data_direction direction)
 243 {
 244 }
 245
 246 static inline void
 247 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg, int nelems,
 248     enum dma_data_direction direction)
 249 {
 250 }
 251
 252 static inline void
 253 dma_sync_single_range_for_cpu(struct device *dev, dma_addr_t dma_handle,
 254     unsigned long offset, size_t size, int direction)
 255 {
 256 }
 257
 258 static inline void
 259 dma_sync_single_range_for_device(struct device *dev, dma_addr_t dma_handle,
 260     unsigned long offset, size_t size, int direction)
 261 {
 262 }
 263
 264 static inline int
 265 dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 266 {
 267
 268         return (0);
 269 }
 270
 271 static inline unsigned int dma_set_max_seg_size(struct device *dev,
 272     unsigned int size)
 273 {
 274         return (0);
 275 }
 276
 277
 278 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, NULL)
 279 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, NULL)
 280 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, NULL)
 281 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, NULL)
 282
 283 #define DEFINE_DMA_UNMAP_ADDR(name)             dma_addr_t name
 284 #define DEFINE_DMA_UNMAP_LEN(name)              __u32 name
 285 #define dma_unmap_addr(p, name)                 ((p)->name)
 286 #define dma_unmap_addr_set(p, name, v)          (((p)->name) = (v))
 287 #define dma_unmap_len(p, name)                  ((p)->name)
 288 #define dma_unmap_len_set(p, name, v)           (((p)->name) = (v))
 289
 290 extern int uma_align_cache;
 291 #define dma_get_cache_alignment()       uma_align_cache
 292
 293 #endif  /* _LINUX_DMA_MAPPING_H_ */