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 _LINUXKPI_LINUX_DMA_MAPPING_H_
  32 #define _LINUXKPI_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 #include <linux/sizes.h>
  42
  43 #include <sys/systm.h>
  44 #include <sys/malloc.h>
  45
  46 #include <vm/vm.h>
  47 #include <vm/vm_page.h>
  48 #include <vm/pmap.h>
  49
  50 #include <machine/bus.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             unsigned long attrs);
  67         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  68             size_t size, enum dma_data_direction dir, unsigned long attrs);
  69         int (*map_sg)(struct device *dev, struct scatterlist *sg,
  70             int nents, enum dma_data_direction dir, unsigned long attrs);
  71         void (*unmap_sg)(struct device *dev, struct scatterlist *sg, int nents,
  72             enum dma_data_direction dir, unsigned long 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 int linux_dma_tag_init(struct device *, u64);
  95 int linux_dma_tag_init_coherent(struct device *, u64);
  96 void *linux_dma_alloc_coherent(struct device *dev, size_t size,
  97     dma_addr_t *dma_handle, gfp_t flag);
  98 dma_addr_t linux_dma_map_phys(struct device *dev, vm_paddr_t phys, size_t len);
  99 void linux_dma_unmap(struct device *dev, dma_addr_t dma_addr, size_t size);
 100 int linux_dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl,
 101     int nents, enum dma_data_direction dir __unused,
 102     unsigned long attrs __unused);
 103 void linux_dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
 104     int nents __unused, enum dma_data_direction dir __unused,
 105     unsigned long attrs __unused);
 106
 107 static inline int
 108 dma_supported(struct device *dev, u64 dma_mask)
 109 {
 110
 111         /* XXX busdma takes care of this elsewhere. */
 112         return (1);
 113 }
 114
 115 static inline int
 116 dma_set_mask(struct device *dev, u64 dma_mask)
 117 {
 118
 119         if (!dev->dma_priv || !dma_supported(dev, dma_mask))
 120                 return -EIO;
 121
 122         return (linux_dma_tag_init(dev, dma_mask));
 123 }
 124
 125 static inline int
 126 dma_set_coherent_mask(struct device *dev, u64 dma_mask)
 127 {
 128
 129         if (!dev->dma_priv || !dma_supported(dev, dma_mask))
 130                 return -EIO;
 131
 132         return (linux_dma_tag_init_coherent(dev, dma_mask));
 133 }
 134
 135 static inline int
 136 dma_set_mask_and_coherent(struct device *dev, u64 dma_mask)
 137 {
 138         int r;
 139
 140         r = dma_set_mask(dev, dma_mask);
 141         if (r == 0)
 142                 dma_set_coherent_mask(dev, dma_mask);
 143         return (r);
 144 }
 145
 146 static inline void *
 147 dma_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
 148     gfp_t flag)
 149 {
 150         return (linux_dma_alloc_coherent(dev, size, dma_handle, flag));
 151 }
 152
 153 static inline void *
 154 dma_zalloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
 155     gfp_t flag)
 156 {
 157
 158         return (dma_alloc_coherent(dev, size, dma_handle, flag | __GFP_ZERO));
 159 }
 160
 161 static inline void
 162 dma_free_coherent(struct device *dev, size_t size, void *cpu_addr,
 163     dma_addr_t dma_addr)
 164 {
 165
 166         linux_dma_unmap(dev, dma_addr, size);
 167         kmem_free((vm_offset_t)cpu_addr, size);
 168 }
 169
 170 #define dma_map_single_attrs(dev, ptr, size, dir, attrs)        \
 171         linux_dma_map_phys(dev, vtophys(ptr), size)
 172
 173 #define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
 174         linux_dma_unmap(dev, dma_addr, size)
 175
 176 static inline dma_addr_t
 177 dma_map_page_attrs(struct device *dev, struct page *page, size_t offset,
 178     size_t size, enum dma_data_direction dir, unsigned long attrs)
 179 {
 180
 181         return (linux_dma_map_phys(dev, VM_PAGE_TO_PHYS(page) + offset, size));
 182 }
 183
 184 /* linux_dma_(un)map_sg_attrs does not support attrs yet */
 185 #define dma_map_sg_attrs(dev, sgl, nents, dir, attrs)   \
 186         linux_dma_map_sg_attrs(dev, sgl, nents, dir, 0)
 187
 188 #define dma_unmap_sg_attrs(dev, sg, nents, dir, attrs)  \
 189         linux_dma_unmap_sg_attrs(dev, sg, nents, dir, 0)
 190
 191 static inline dma_addr_t
 192 dma_map_page(struct device *dev, struct page *page,
 193     unsigned long offset, size_t size, enum dma_data_direction direction)
 194 {
 195
 196         return (linux_dma_map_phys(dev, VM_PAGE_TO_PHYS(page) + offset, size));
 197 }
 198
 199 static inline void
 200 dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size,
 201     enum dma_data_direction direction)
 202 {
 203
 204         linux_dma_unmap(dev, dma_address, size);
 205 }
 206
 207 static inline void
 208 dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle, size_t size,
 209     enum dma_data_direction direction)
 210 {
 211 }
 212
 213 static inline void
 214 dma_sync_single(struct device *dev, dma_addr_t addr, size_t size,
 215     enum dma_data_direction dir)
 216 {
 217         dma_sync_single_for_cpu(dev, addr, size, dir);
 218 }
 219
 220 static inline void
 221 dma_sync_single_for_device(struct device *dev, dma_addr_t dma_handle,
 222     size_t size, enum dma_data_direction direction)
 223 {
 224 }
 225
 226 static inline void
 227 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg, int nelems,
 228     enum dma_data_direction direction)
 229 {
 230 }
 231
 232 static inline void
 233 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg, int nelems,
 234     enum dma_data_direction direction)
 235 {
 236 }
 237
 238 static inline void
 239 dma_sync_single_range_for_cpu(struct device *dev, dma_addr_t dma_handle,
 240     unsigned long offset, size_t size, int direction)
 241 {
 242 }
 243
 244 static inline void
 245 dma_sync_single_range_for_device(struct device *dev, dma_addr_t dma_handle,
 246     unsigned long offset, size_t size, int direction)
 247 {
 248 }
 249
 250 static inline int
 251 dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 252 {
 253
 254         return (dma_addr == 0);
 255 }
 256
 257 static inline unsigned int dma_set_max_seg_size(struct device *dev,
 258     unsigned int size)
 259 {
 260         return (0);
 261 }
 262
 263 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
 264 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
 265 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
 266 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
 267
 268 #define DEFINE_DMA_UNMAP_ADDR(name)             dma_addr_t name
 269 #define DEFINE_DMA_UNMAP_LEN(name)              __u32 name
 270 #define dma_unmap_addr(p, name)                 ((p)->name)
 271 #define dma_unmap_addr_set(p, name, v)          (((p)->name) = (v))
 272 #define dma_unmap_len(p, name)                  ((p)->name)
 273 #define dma_unmap_len_set(p, name, v)           (((p)->name) = (v))
 274
 275 extern int uma_align_cache;
 276 #define dma_get_cache_alignment()       uma_align_cache
 277
 278 #endif  /* _LINUXKPI_LINUX_DMA_MAPPING_H_ */