include/linux/dma-mapping.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_DMA_MAPPING_H
   3 #define _LINUX_DMA_MAPPING_H
   4
   5 #include <linux/sizes.h>
   6 #include <linux/string.h>
   7 #include <linux/device.h>
   8 #include <linux/err.h>
   9 #include <linux/dma-debug.h>
  10 #include <linux/dma-direction.h>
  11 #include <linux/scatterlist.h>
  12 #include <linux/bug.h>
  13 #include <linux/mem_encrypt.h>
  14
  15 /**
  16  * List of possible attributes associated with a DMA mapping. The semantics
  17  * of each attribute should be defined in Documentation/core-api/dma-attributes.rst.
  18  */
  19
  20 /*
  21  * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
  22  * may be weakly ordered, that is that reads and writes may pass each other.
  23  */
  24 #define DMA_ATTR_WEAK_ORDERING          (1UL << 1)
  25 /*
  26  * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
  27  * buffered to improve performance.
  28  */
  29 #define DMA_ATTR_WRITE_COMBINE          (1UL << 2)
  30 /*
  31  * DMA_ATTR_NON_CONSISTENT: Lets the platform to choose to return either
  32  * consistent or non-consistent memory as it sees fit.
  33  */
  34 #define DMA_ATTR_NON_CONSISTENT         (1UL << 3)
  35 /*
  36  * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
  37  * virtual mapping for the allocated buffer.
  38  */
  39 #define DMA_ATTR_NO_KERNEL_MAPPING      (1UL << 4)
  40 /*
  41  * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
  42  * the CPU cache for the given buffer assuming that it has been already
  43  * transferred to 'device' domain.
  44  */
  45 #define DMA_ATTR_SKIP_CPU_SYNC          (1UL << 5)
  46 /*
  47  * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
  48  * in physical memory.
  49  */
  50 #define DMA_ATTR_FORCE_CONTIGUOUS       (1UL << 6)
  51 /*
  52  * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
  53  * that it's probably not worth the time to try to allocate memory to in a way
  54  * that gives better TLB efficiency.
  55  */
  56 #define DMA_ATTR_ALLOC_SINGLE_PAGES     (1UL << 7)
  57 /*
  58  * DMA_ATTR_NO_WARN: This tells the DMA-mapping subsystem to suppress
  59  * allocation failure reports (similarly to __GFP_NOWARN).
  60  */
  61 #define DMA_ATTR_NO_WARN        (1UL << 8)
  62
  63 /*
  64  * DMA_ATTR_PRIVILEGED: used to indicate that the buffer is fully
  65  * accessible at an elevated privilege level (and ideally inaccessible or
  66  * at least read-only at lesser-privileged levels).
  67  */
  68 #define DMA_ATTR_PRIVILEGED             (1UL << 9)
  69
  70 /*
  71  * A dma_addr_t can hold any valid DMA or bus address for the platform.
  72  * It can be given to a device to use as a DMA source or target.  A CPU cannot
  73  * reference a dma_addr_t directly because there may be translation between
  74  * its physical address space and the bus address space.
  75  */
  76 struct dma_map_ops {
  77         void* (*alloc)(struct device *dev, size_t size,
  78                                 dma_addr_t *dma_handle, gfp_t gfp,
  79                                 unsigned long attrs);
  80         void (*free)(struct device *dev, size_t size,
  81                               void *vaddr, dma_addr_t dma_handle,
  82                               unsigned long attrs);
  83         int (*mmap)(struct device *, struct vm_area_struct *,
  84                           void *, dma_addr_t, size_t,
  85                           unsigned long attrs);
  86
  87         int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *,
  88                            dma_addr_t, size_t, unsigned long attrs);
  89
  90         dma_addr_t (*map_page)(struct device *dev, struct page *page,
  91                                unsigned long offset, size_t size,
  92                                enum dma_data_direction dir,
  93                                unsigned long attrs);
  94         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  95                            size_t size, enum dma_data_direction dir,
  96                            unsigned long attrs);
  97         /*
  98          * map_sg returns 0 on error and a value > 0 on success.
  99          * It should never return a value < 0.
 100          */
 101         int (*map_sg)(struct device *dev, struct scatterlist *sg,
 102                       int nents, enum dma_data_direction dir,
 103                       unsigned long attrs);
 104         void (*unmap_sg)(struct device *dev,
 105                          struct scatterlist *sg, int nents,
 106                          enum dma_data_direction dir,
 107                          unsigned long attrs);
 108         dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr,
 109                                size_t size, enum dma_data_direction dir,
 110                                unsigned long attrs);
 111         void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle,
 112                            size_t size, enum dma_data_direction dir,
 113                            unsigned long attrs);
 114         void (*sync_single_for_cpu)(struct device *dev,
 115                                     dma_addr_t dma_handle, size_t size,
 116                                     enum dma_data_direction dir);
 117         void (*sync_single_for_device)(struct device *dev,
 118                                        dma_addr_t dma_handle, size_t size,
 119                                        enum dma_data_direction dir);
 120         void (*sync_sg_for_cpu)(struct device *dev,
 121                                 struct scatterlist *sg, int nents,
 122                                 enum dma_data_direction dir);
 123         void (*sync_sg_for_device)(struct device *dev,
 124                                    struct scatterlist *sg, int nents,
 125                                    enum dma_data_direction dir);
 126         void (*cache_sync)(struct device *dev, void *vaddr, size_t size,
 127                         enum dma_data_direction direction);
 128         int (*dma_supported)(struct device *dev, u64 mask);
 129         u64 (*get_required_mask)(struct device *dev);
 130         size_t (*max_mapping_size)(struct device *dev);
 131         unsigned long (*get_merge_boundary)(struct device *dev);
 132 };
 133
 134 #define DMA_MAPPING_ERROR               (~(dma_addr_t)0)
 135
 136 extern const struct dma_map_ops dma_virt_ops;
 137 extern const struct dma_map_ops dma_dummy_ops;
 138
 139 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 140
 141 #define DMA_MASK_NONE   0x0ULL
 142
 143 static inline int valid_dma_direction(int dma_direction)
 144 {
 145         return ((dma_direction == DMA_BIDIRECTIONAL) ||
 146                 (dma_direction == DMA_TO_DEVICE) ||
 147                 (dma_direction == DMA_FROM_DEVICE));
 148 }
 149
 150 #ifdef CONFIG_DMA_DECLARE_COHERENT
 151 /*
 152  * These three functions are only for dma allocator.
 153  * Don't use them in device drivers.
 154  */
 155 int dma_alloc_from_dev_coherent(struct device *dev, ssize_t size,
 156                                        dma_addr_t *dma_handle, void **ret);
 157 int dma_release_from_dev_coherent(struct device *dev, int order, void *vaddr);
 158
 159 int dma_mmap_from_dev_coherent(struct device *dev, struct vm_area_struct *vma,
 160                             void *cpu_addr, size_t size, int *ret);
 161
 162 void *dma_alloc_from_global_coherent(struct device *dev, ssize_t size, dma_addr_t *dma_handle);
 163 int dma_release_from_global_coherent(int order, void *vaddr);
 164 int dma_mmap_from_global_coherent(struct vm_area_struct *vma, void *cpu_addr,
 165                                   size_t size, int *ret);
 166
 167 #else
 168 #define dma_alloc_from_dev_coherent(dev, size, handle, ret) (0)
 169 #define dma_release_from_dev_coherent(dev, order, vaddr) (0)
 170 #define dma_mmap_from_dev_coherent(dev, vma, vaddr, order, ret) (0)
 171
 172 static inline void *dma_alloc_from_global_coherent(struct device *dev, ssize_t size,
 173                                                    dma_addr_t *dma_handle)
 174 {
 175         return NULL;
 176 }
 177
 178 static inline int dma_release_from_global_coherent(int order, void *vaddr)
 179 {
 180         return 0;
 181 }
 182
 183 static inline int dma_mmap_from_global_coherent(struct vm_area_struct *vma,
 184                                                 void *cpu_addr, size_t size,
 185                                                 int *ret)
 186 {
 187         return 0;
 188 }
 189 #endif /* CONFIG_DMA_DECLARE_COHERENT */
 190
 191 #ifdef CONFIG_HAS_DMA
 192 #include <asm/dma-mapping.h>
 193
 194 #ifdef CONFIG_DMA_OPS
 195 static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
 196 {
 197         if (dev->dma_ops)
 198                 return dev->dma_ops;
 199         return get_arch_dma_ops(dev->bus);
 200 }
 201
 202 static inline void set_dma_ops(struct device *dev,
 203                                const struct dma_map_ops *dma_ops)
 204 {
 205         dev->dma_ops = dma_ops;
 206 }
 207 #else /* CONFIG_DMA_OPS */
 208 static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
 209 {
 210         return NULL;
 211 }
 212 static inline void set_dma_ops(struct device *dev,
 213                                const struct dma_map_ops *dma_ops)
 214 {
 215 }
 216 #endif /* CONFIG_DMA_OPS */
 217
 218 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 219 {
 220         debug_dma_mapping_error(dev, dma_addr);
 221
 222         if (dma_addr == DMA_MAPPING_ERROR)
 223                 return -ENOMEM;
 224         return 0;
 225 }
 226
 227 dma_addr_t dma_map_page_attrs(struct device *dev, struct page *page,
 228                 size_t offset, size_t size, enum dma_data_direction dir,
 229                 unsigned long attrs);
 230 void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr, size_t size,
 231                 enum dma_data_direction dir, unsigned long attrs);
 232 int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg, int nents,
 233                 enum dma_data_direction dir, unsigned long attrs);
 234 void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
 235                                       int nents, enum dma_data_direction dir,
 236                                       unsigned long attrs);
 237 dma_addr_t dma_map_resource(struct device *dev, phys_addr_t phys_addr,
 238                 size_t size, enum dma_data_direction dir, unsigned long attrs);
 239 void dma_unmap_resource(struct device *dev, dma_addr_t addr, size_t size,
 240                 enum dma_data_direction dir, unsigned long attrs);
 241 void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr, size_t size,
 242                 enum dma_data_direction dir);
 243 void dma_sync_single_for_device(struct device *dev, dma_addr_t addr,
 244                 size_t size, enum dma_data_direction dir);
 245 void dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
 246                     int nelems, enum dma_data_direction dir);
 247 void dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
 248                        int nelems, enum dma_data_direction dir);
 249 void *dma_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
 250                 gfp_t flag, unsigned long attrs);
 251 void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
 252                 dma_addr_t dma_handle, unsigned long attrs);
 253 void *dmam_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
 254                 gfp_t gfp, unsigned long attrs);
 255 void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
 256                 dma_addr_t dma_handle);
 257 void dma_cache_sync(struct device *dev, void *vaddr, size_t size,
 258                 enum dma_data_direction dir);
 259 int dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt,
 260                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 261                 unsigned long attrs);
 262 int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
 263                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 264                 unsigned long attrs);
 265 bool dma_can_mmap(struct device *dev);
 266 int dma_supported(struct device *dev, u64 mask);
 267 int dma_set_mask(struct device *dev, u64 mask);
 268 int dma_set_coherent_mask(struct device *dev, u64 mask);
 269 u64 dma_get_required_mask(struct device *dev);
 270 size_t dma_max_mapping_size(struct device *dev);
 271 bool dma_need_sync(struct device *dev, dma_addr_t dma_addr);
 272 unsigned long dma_get_merge_boundary(struct device *dev);
 273 #else /* CONFIG_HAS_DMA */
 274 static inline dma_addr_t dma_map_page_attrs(struct device *dev,
 275                 struct page *page, size_t offset, size_t size,
 276                 enum dma_data_direction dir, unsigned long attrs)
 277 {
 278         return DMA_MAPPING_ERROR;
 279 }
 280 static inline void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr,
 281                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 282 {
 283 }
 284 static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
 285                 int nents, enum dma_data_direction dir, unsigned long attrs)
 286 {
 287         return 0;
 288 }
 289 static inline void dma_unmap_sg_attrs(struct device *dev,
 290                 struct scatterlist *sg, int nents, enum dma_data_direction dir,
 291                 unsigned long attrs)
 292 {
 293 }
 294 static inline dma_addr_t dma_map_resource(struct device *dev,
 295                 phys_addr_t phys_addr, size_t size, enum dma_data_direction dir,
 296                 unsigned long attrs)
 297 {
 298         return DMA_MAPPING_ERROR;
 299 }
 300 static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
 301                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 302 {
 303 }
 304 static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
 305                 size_t size, enum dma_data_direction dir)
 306 {
 307 }
 308 static inline void dma_sync_single_for_device(struct device *dev,
 309                 dma_addr_t addr, size_t size, enum dma_data_direction dir)
 310 {
 311 }
 312 static inline void dma_sync_sg_for_cpu(struct device *dev,
 313                 struct scatterlist *sg, int nelems, enum dma_data_direction dir)
 314 {
 315 }
 316 static inline void dma_sync_sg_for_device(struct device *dev,
 317                 struct scatterlist *sg, int nelems, enum dma_data_direction dir)
 318 {
 319 }
 320 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 321 {
 322         return -ENOMEM;
 323 }
 324 static inline void *dma_alloc_attrs(struct device *dev, size_t size,
 325                 dma_addr_t *dma_handle, gfp_t flag, unsigned long attrs)
 326 {
 327         return NULL;
 328 }
 329 static void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
 330                 dma_addr_t dma_handle, unsigned long attrs)
 331 {
 332 }
 333 static inline void *dmam_alloc_attrs(struct device *dev, size_t size,
 334                 dma_addr_t *dma_handle, gfp_t gfp, unsigned long attrs)
 335 {
 336         return NULL;
 337 }
 338 static inline void dmam_free_coherent(struct device *dev, size_t size,
 339                 void *vaddr, dma_addr_t dma_handle)
 340 {
 341 }
 342 static inline void dma_cache_sync(struct device *dev, void *vaddr, size_t size,
 343                 enum dma_data_direction dir)
 344 {
 345 }
 346 static inline int dma_get_sgtable_attrs(struct device *dev,
 347                 struct sg_table *sgt, void *cpu_addr, dma_addr_t dma_addr,
 348                 size_t size, unsigned long attrs)
 349 {
 350         return -ENXIO;
 351 }
 352 static inline int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
 353                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 354                 unsigned long attrs)
 355 {
 356         return -ENXIO;
 357 }
 358 static inline bool dma_can_mmap(struct device *dev)
 359 {
 360         return false;
 361 }
 362 static inline int dma_supported(struct device *dev, u64 mask)
 363 {
 364         return 0;
 365 }
 366 static inline int dma_set_mask(struct device *dev, u64 mask)
 367 {
 368         return -EIO;
 369 }
 370 static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
 371 {
 372         return -EIO;
 373 }
 374 static inline u64 dma_get_required_mask(struct device *dev)
 375 {
 376         return 0;
 377 }
 378 static inline size_t dma_max_mapping_size(struct device *dev)
 379 {
 380         return 0;
 381 }
 382 static inline bool dma_need_sync(struct device *dev, dma_addr_t dma_addr)
 383 {
 384         return false;
 385 }
 386 static inline unsigned long dma_get_merge_boundary(struct device *dev)
 387 {
 388         return 0;
 389 }
 390 #endif /* CONFIG_HAS_DMA */
 391
 392 static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
 393                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 394 {
 395         /* DMA must never operate on areas that might be remapped. */
 396         if (dev_WARN_ONCE(dev, is_vmalloc_addr(ptr),
 397                           "rejecting DMA map of vmalloc memory\n"))
 398                 return DMA_MAPPING_ERROR;
 399         debug_dma_map_single(dev, ptr, size);
 400         return dma_map_page_attrs(dev, virt_to_page(ptr), offset_in_page(ptr),
 401                         size, dir, attrs);
 402 }
 403
 404 static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
 405                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 406 {
 407         return dma_unmap_page_attrs(dev, addr, size, dir, attrs);
 408 }
 409
 410 static inline void dma_sync_single_range_for_cpu(struct device *dev,
 411                 dma_addr_t addr, unsigned long offset, size_t size,
 412                 enum dma_data_direction dir)
 413 {
 414         return dma_sync_single_for_cpu(dev, addr + offset, size, dir);
 415 }
 416
 417 static inline void dma_sync_single_range_for_device(struct device *dev,
 418                 dma_addr_t addr, unsigned long offset, size_t size,
 419                 enum dma_data_direction dir)
 420 {
 421         return dma_sync_single_for_device(dev, addr + offset, size, dir);
 422 }
 423
 424 /**
 425  * dma_map_sgtable - Map the given buffer for DMA
 426  * @dev:        The device for which to perform the DMA operation
 427  * @sgt:        The sg_table object describing the buffer
 428  * @dir:        DMA direction
 429  * @attrs:      Optional DMA attributes for the map operation
 430  *
 431  * Maps a buffer described by a scatterlist stored in the given sg_table
 432  * object for the @dir DMA operation by the @dev device. After success the
 433  * ownership for the buffer is transferred to the DMA domain.  One has to
 434  * call dma_sync_sgtable_for_cpu() or dma_unmap_sgtable() to move the
 435  * ownership of the buffer back to the CPU domain before touching the
 436  * buffer by the CPU.
 437  *
 438  * Returns 0 on success or -EINVAL on error during mapping the buffer.
 439  */
 440 static inline int dma_map_sgtable(struct device *dev, struct sg_table *sgt,
 441                 enum dma_data_direction dir, unsigned long attrs)
 442 {
 443         int nents;
 444
 445         nents = dma_map_sg_attrs(dev, sgt->sgl, sgt->orig_nents, dir, attrs);
 446         if (nents <= 0)
 447                 return -EINVAL;
 448         sgt->nents = nents;
 449         return 0;
 450 }
 451
 452 /**
 453  * dma_unmap_sgtable - Unmap the given buffer for DMA
 454  * @dev:        The device for which to perform the DMA operation
 455  * @sgt:        The sg_table object describing the buffer
 456  * @dir:        DMA direction
 457  * @attrs:      Optional DMA attributes for the unmap operation
 458  *
 459  * Unmaps a buffer described by a scatterlist stored in the given sg_table
 460  * object for the @dir DMA operation by the @dev device. After this function
 461  * the ownership of the buffer is transferred back to the CPU domain.
 462  */
 463 static inline void dma_unmap_sgtable(struct device *dev, struct sg_table *sgt,
 464                 enum dma_data_direction dir, unsigned long attrs)
 465 {
 466         dma_unmap_sg_attrs(dev, sgt->sgl, sgt->orig_nents, dir, attrs);
 467 }
 468
 469 /**
 470  * dma_sync_sgtable_for_cpu - Synchronize the given buffer for CPU access
 471  * @dev:        The device for which to perform the DMA operation
 472  * @sgt:        The sg_table object describing the buffer
 473  * @dir:        DMA direction
 474  *
 475  * Performs the needed cache synchronization and moves the ownership of the
 476  * buffer back to the CPU domain, so it is safe to perform any access to it
 477  * by the CPU. Before doing any further DMA operations, one has to transfer
 478  * the ownership of the buffer back to the DMA domain by calling the
 479  * dma_sync_sgtable_for_device().
 480  */
 481 static inline void dma_sync_sgtable_for_cpu(struct device *dev,
 482                 struct sg_table *sgt, enum dma_data_direction dir)
 483 {
 484         dma_sync_sg_for_cpu(dev, sgt->sgl, sgt->orig_nents, dir);
 485 }
 486
 487 /**
 488  * dma_sync_sgtable_for_device - Synchronize the given buffer for DMA
 489  * @dev:        The device for which to perform the DMA operation
 490  * @sgt:        The sg_table object describing the buffer
 491  * @dir:        DMA direction
 492  *
 493  * Performs the needed cache synchronization and moves the ownership of the
 494  * buffer back to the DMA domain, so it is safe to perform the DMA operation.
 495  * Once finished, one has to call dma_sync_sgtable_for_cpu() or
 496  * dma_unmap_sgtable().
 497  */
 498 static inline void dma_sync_sgtable_for_device(struct device *dev,
 499                 struct sg_table *sgt, enum dma_data_direction dir)
 500 {
 501         dma_sync_sg_for_device(dev, sgt->sgl, sgt->orig_nents, dir);
 502 }
 503
 504 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
 505 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
 506 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
 507 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
 508 #define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
 509 #define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
 510 #define dma_get_sgtable(d, t, v, h, s) dma_get_sgtable_attrs(d, t, v, h, s, 0)
 511 #define dma_mmap_coherent(d, v, c, h, s) dma_mmap_attrs(d, v, c, h, s, 0)
 512
 513 extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
 514                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 515                 unsigned long attrs);
 516
 517 struct page **dma_common_find_pages(void *cpu_addr);
 518 void *dma_common_contiguous_remap(struct page *page, size_t size,
 519                         pgprot_t prot, const void *caller);
 520
 521 void *dma_common_pages_remap(struct page **pages, size_t size,
 522                         pgprot_t prot, const void *caller);
 523 void dma_common_free_remap(void *cpu_addr, size_t size);
 524
 525 void *dma_alloc_from_pool(struct device *dev, size_t size,
 526                           struct page **ret_page, gfp_t flags);
 527 bool dma_free_from_pool(struct device *dev, void *start, size_t size);
 528
 529 int
 530 dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, void *cpu_addr,
 531                 dma_addr_t dma_addr, size_t size, unsigned long attrs);
 532
 533 static inline void *dma_alloc_coherent(struct device *dev, size_t size,
 534                 dma_addr_t *dma_handle, gfp_t gfp)
 535 {
 536
 537         return dma_alloc_attrs(dev, size, dma_handle, gfp,
 538                         (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
 539 }
 540
 541 static inline void dma_free_coherent(struct device *dev, size_t size,
 542                 void *cpu_addr, dma_addr_t dma_handle)
 543 {
 544         return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
 545 }
 546
 547
 548 static inline u64 dma_get_mask(struct device *dev)
 549 {
 550         if (dev->dma_mask && *dev->dma_mask)
 551                 return *dev->dma_mask;
 552         return DMA_BIT_MASK(32);
 553 }
 554
 555 /*
 556  * Set both the DMA mask and the coherent DMA mask to the same thing.
 557  * Note that we don't check the return value from dma_set_coherent_mask()
 558  * as the DMA API guarantees that the coherent DMA mask can be set to
 559  * the same or smaller than the streaming DMA mask.
 560  */
 561 static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
 562 {
 563         int rc = dma_set_mask(dev, mask);
 564         if (rc == 0)
 565                 dma_set_coherent_mask(dev, mask);
 566         return rc;
 567 }
 568
 569 /*
 570  * Similar to the above, except it deals with the case where the device
 571  * does not have dev->dma_mask appropriately setup.
 572  */
 573 static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
 574 {
 575         dev->dma_mask = &dev->coherent_dma_mask;
 576         return dma_set_mask_and_coherent(dev, mask);
 577 }
 578
 579 /**
 580  * dma_addressing_limited - return if the device is addressing limited
 581  * @dev:        device to check
 582  *
 583  * Return %true if the devices DMA mask is too small to address all memory in
 584  * the system, else %false.  Lack of addressing bits is the prime reason for
 585  * bounce buffering, but might not be the only one.
 586  */
 587 static inline bool dma_addressing_limited(struct device *dev)
 588 {
 589         return min_not_zero(dma_get_mask(dev), dev->bus_dma_limit) <
 590                             dma_get_required_mask(dev);
 591 }
 592
 593 #ifdef CONFIG_ARCH_HAS_SETUP_DMA_OPS
 594 void arch_setup_dma_ops(struct device *dev, u64 dma_base, u64 size,
 595                 const struct iommu_ops *iommu, bool coherent);
 596 #else
 597 static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
 598                 u64 size, const struct iommu_ops *iommu, bool coherent)
 599 {
 600 }
 601 #endif /* CONFIG_ARCH_HAS_SETUP_DMA_OPS */
 602
 603 #ifdef CONFIG_ARCH_HAS_TEARDOWN_DMA_OPS
 604 void arch_teardown_dma_ops(struct device *dev);
 605 #else
 606 static inline void arch_teardown_dma_ops(struct device *dev)
 607 {
 608 }
 609 #endif /* CONFIG_ARCH_HAS_TEARDOWN_DMA_OPS */
 610
 611 static inline unsigned int dma_get_max_seg_size(struct device *dev)
 612 {
 613         if (dev->dma_parms && dev->dma_parms->max_segment_size)
 614                 return dev->dma_parms->max_segment_size;
 615         return SZ_64K;
 616 }
 617
 618 static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
 619 {
 620         if (dev->dma_parms) {
 621                 dev->dma_parms->max_segment_size = size;
 622                 return 0;
 623         }
 624         return -EIO;
 625 }
 626
 627 static inline unsigned long dma_get_seg_boundary(struct device *dev)
 628 {
 629         if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
 630                 return dev->dma_parms->segment_boundary_mask;
 631         return DMA_BIT_MASK(32);
 632 }
 633
 634 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
 635 {
 636         if (dev->dma_parms) {
 637                 dev->dma_parms->segment_boundary_mask = mask;
 638                 return 0;
 639         }
 640         return -EIO;
 641 }
 642
 643 static inline int dma_get_cache_alignment(void)
 644 {
 645 #ifdef ARCH_DMA_MINALIGN
 646         return ARCH_DMA_MINALIGN;
 647 #endif
 648         return 1;
 649 }
 650
 651 #ifdef CONFIG_DMA_DECLARE_COHERENT
 652 int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 653                                 dma_addr_t device_addr, size_t size);
 654 #else
 655 static inline int
 656 dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 657                             dma_addr_t device_addr, size_t size)
 658 {
 659         return -ENOSYS;
 660 }
 661 #endif /* CONFIG_DMA_DECLARE_COHERENT */
 662
 663 static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
 664                 dma_addr_t *dma_handle, gfp_t gfp)
 665 {
 666         return dmam_alloc_attrs(dev, size, dma_handle, gfp,
 667                         (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
 668 }
 669
 670 static inline void *dma_alloc_wc(struct device *dev, size_t size,
 671                                  dma_addr_t *dma_addr, gfp_t gfp)
 672 {
 673         unsigned long attrs = DMA_ATTR_WRITE_COMBINE;
 674
 675         if (gfp & __GFP_NOWARN)
 676                 attrs |= DMA_ATTR_NO_WARN;
 677
 678         return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
 679 }
 680
 681 static inline void dma_free_wc(struct device *dev, size_t size,
 682                                void *cpu_addr, dma_addr_t dma_addr)
 683 {
 684         return dma_free_attrs(dev, size, cpu_addr, dma_addr,
 685                               DMA_ATTR_WRITE_COMBINE);
 686 }
 687
 688 static inline int dma_mmap_wc(struct device *dev,
 689                               struct vm_area_struct *vma,
 690                               void *cpu_addr, dma_addr_t dma_addr,
 691                               size_t size)
 692 {
 693         return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
 694                               DMA_ATTR_WRITE_COMBINE);
 695 }
 696
 697 #ifdef CONFIG_NEED_DMA_MAP_STATE
 698 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)        dma_addr_t ADDR_NAME
 699 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)          __u32 LEN_NAME
 700 #define dma_unmap_addr(PTR, ADDR_NAME)           ((PTR)->ADDR_NAME)
 701 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  (((PTR)->ADDR_NAME) = (VAL))
 702 #define dma_unmap_len(PTR, LEN_NAME)             ((PTR)->LEN_NAME)
 703 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    (((PTR)->LEN_NAME) = (VAL))
 704 #else
 705 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
 706 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
 707 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
 708 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
 709 #define dma_unmap_len(PTR, LEN_NAME)             (0)
 710 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
 711 #endif
 712
 713 #endif