LXR linux/include/linux/dma-mapping.h

   1#ifndef _LINUX_DMA_MAPPING_H
   2#define _LINUX_DMA_MAPPING_H
   3
   4#include <linux/device.h>
   5#include <linux/err.h>
   6#include <linux/dma-attrs.h>
   7#include <linux/scatterlist.h>
   8
   9/* These definitions mirror those in pci.h, so they can be used
  10 * interchangeably with their PCI_ counterparts */
  11enum dma_data_direction {
  12        DMA_BIDIRECTIONAL = 0,
  13        DMA_TO_DEVICE = 1,
  14        DMA_FROM_DEVICE = 2,
  15        DMA_NONE = 3,
  16};
  17
  18struct dma_map_ops {
  19        void* (*alloc_coherent)(struct device *dev, size_t size,
  20                                dma_addr_t *dma_handle, gfp_t gfp);
  21        void (*free_coherent)(struct device *dev, size_t size,
  22                              void *vaddr, dma_addr_t dma_handle);
  23        dma_addr_t (*map_page)(struct device *dev, struct page *page,
  24                               unsigned long offset, size_t size,
  25                               enum dma_data_direction dir,
  26                               struct dma_attrs *attrs);
  27        void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  28                           size_t size, enum dma_data_direction dir,
  29                           struct dma_attrs *attrs);
  30        int (*map_sg)(struct device *dev, struct scatterlist *sg,
  31                      int nents, enum dma_data_direction dir,
  32                      struct dma_attrs *attrs);
  33        void (*unmap_sg)(struct device *dev,
  34                         struct scatterlist *sg, int nents,
  35                         enum dma_data_direction dir,
  36                         struct dma_attrs *attrs);
  37        void (*sync_single_for_cpu)(struct device *dev,
  38                                    dma_addr_t dma_handle, size_t size,
  39                                    enum dma_data_direction dir);
  40        void (*sync_single_for_device)(struct device *dev,
  41                                       dma_addr_t dma_handle, size_t size,
  42                                       enum dma_data_direction dir);
  43        void (*sync_single_range_for_cpu)(struct device *dev,
  44                                          dma_addr_t dma_handle,
  45                                          unsigned long offset,
  46                                          size_t size,
  47                                          enum dma_data_direction dir);
  48        void (*sync_single_range_for_device)(struct device *dev,
  49                                             dma_addr_t dma_handle,
  50                                             unsigned long offset,
  51                                             size_t size,
  52                                             enum dma_data_direction dir);
  53        void (*sync_sg_for_cpu)(struct device *dev,
  54                                struct scatterlist *sg, int nents,
  55                                enum dma_data_direction dir);
  56        void (*sync_sg_for_device)(struct device *dev,
  57                                   struct scatterlist *sg, int nents,
  58                                   enum dma_data_direction dir);
  59        int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
  60        int (*dma_supported)(struct device *dev, u64 mask);
  61        int is_phys;
  62};
  63
  64#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
  65
  66typedef u64 DMA_nnBIT_MASK __deprecated;
  67
  68/*
  69 * NOTE: do not use the below macros in new code and do not add new definitions
  70 * here.
  71 *
  72 * Instead, just open-code DMA_BIT_MASK(n) within your driver
  73 */
  74#define DMA_64BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(64)
  75#define DMA_48BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(48)
  76#define DMA_47BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(47)
  77#define DMA_40BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(40)
  78#define DMA_39BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(39)
  79#define DMA_35BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(35)
  80#define DMA_32BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(32)
  81#define DMA_31BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(31)
  82#define DMA_30BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(30)
  83#define DMA_29BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(29)
  84#define DMA_28BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(28)
  85#define DMA_24BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(24)
  86
  87#define DMA_MASK_NONE   0x0ULL
  88
  89static inline int valid_dma_direction(int dma_direction)
  90{
  91        return ((dma_direction == DMA_BIDIRECTIONAL) ||
  92                (dma_direction == DMA_TO_DEVICE) ||
  93                (dma_direction == DMA_FROM_DEVICE));
  94}
  95
  96static inline int is_device_dma_capable(struct device *dev)
  97{
  98        return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
  99}
 100
 101static inline int is_buffer_dma_capable(u64 mask, dma_addr_t addr, size_t size)
 102{
 103        return addr + size <= mask;
 104}
 105
 106#ifdef CONFIG_HAS_DMA
 107#include <asm/dma-mapping.h>
 108#else
 109#include <asm-generic/dma-mapping-broken.h>
 110#endif
 111
 112/* for backwards compatibility, removed soon */
 113static inline void __deprecated dma_sync_single(struct device *dev,
 114                                                dma_addr_t addr, size_t size,
 115                                                enum dma_data_direction dir)
 116{
 117        dma_sync_single_for_cpu(dev, addr, size, dir);
 118}
 119
 120static inline void __deprecated dma_sync_sg(struct device *dev,
 121                                            struct scatterlist *sg, int nelems,
 122                                            enum dma_data_direction dir)
 123{
 124        dma_sync_sg_for_cpu(dev, sg, nelems, dir);
 125}
 126
 127static inline u64 dma_get_mask(struct device *dev)
 128{
 129        if (dev && dev->dma_mask && *dev->dma_mask)
 130                return *dev->dma_mask;
 131        return DMA_BIT_MASK(32);
 132}
 133
 134extern u64 dma_get_required_mask(struct device *dev);
 135
 136static inline unsigned int dma_get_max_seg_size(struct device *dev)
 137{
 138        return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
 139}
 140
 141static inline unsigned int dma_set_max_seg_size(struct device *dev,
 142                                                unsigned int size)
 143{
 144        if (dev->dma_parms) {
 145                dev->dma_parms->max_segment_size = size;
 146                return 0;
 147        } else
 148                return -EIO;
 149}
 150
 151static inline unsigned long dma_get_seg_boundary(struct device *dev)
 152{
 153        return dev->dma_parms ?
 154                dev->dma_parms->segment_boundary_mask : 0xffffffff;
 155}
 156
 157static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
 158{
 159        if (dev->dma_parms) {
 160                dev->dma_parms->segment_boundary_mask = mask;
 161                return 0;
 162        } else
 163                return -EIO;
 164}
 165
 166/* flags for the coherent memory api */
 167#define DMA_MEMORY_MAP                  0x01
 168#define DMA_MEMORY_IO                   0x02
 169#define DMA_MEMORY_INCLUDES_CHILDREN    0x04
 170#define DMA_MEMORY_EXCLUSIVE            0x08
 171
 172#ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
 173static inline int
 174dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
 175                            dma_addr_t device_addr, size_t size, int flags)
 176{
 177        return 0;
 178}
 179
 180static inline void
 181dma_release_declared_memory(struct device *dev)
 182{
 183}
 184
 185static inline void *
 186dma_mark_declared_memory_occupied(struct device *dev,
 187                                  dma_addr_t device_addr, size_t size)
 188{
 189        return ERR_PTR(-EBUSY);
 190}
 191#endif
 192
 193/*
 194 * Managed DMA API
 195 */
 196extern void *dmam_alloc_coherent(struct device *dev, size_t size,
 197                                 dma_addr_t *dma_handle, gfp_t gfp);
 198extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
 199                               dma_addr_t dma_handle);
 200extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
 201                                    dma_addr_t *dma_handle, gfp_t gfp);
 202extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
 203                                  dma_addr_t dma_handle);
 204#ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
 205extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
 206                                        dma_addr_t device_addr, size_t size,
 207                                        int flags);
 208extern void dmam_release_declared_memory(struct device *dev);
 209#else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
 210static inline int dmam_declare_coherent_memory(struct device *dev,
 211                                dma_addr_t bus_addr, dma_addr_t device_addr,
 212                                size_t size, gfp_t gfp)
 213{
 214        return 0;
 215}
 216
 217static inline void dmam_release_declared_memory(struct device *dev)
 218{
 219}
 220#endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
 221
 222#ifndef CONFIG_HAVE_DMA_ATTRS
 223struct dma_attrs;
 224
 225#define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
 226        dma_map_single(dev, cpu_addr, size, dir)
 227
 228#define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
 229        dma_unmap_single(dev, dma_addr, size, dir)
 230
 231#define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
 232        dma_map_sg(dev, sgl, nents, dir)
 233
 234#define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
 235        dma_unmap_sg(dev, sgl, nents, dir)
 236
 237#endif /* CONFIG_HAVE_DMA_ATTRS */
 238
 239#endif
 240