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/DMA-attributes.txt.
  18  *
  19  * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute
  20  * forces all pending DMA writes to complete.
  21  */
  22 #define DMA_ATTR_WRITE_BARRIER          (1UL << 0)
  23 /*
  24  * DMA_ATTR_WEAK_ORDERING: Specifies that reads and writes to the mapping
  25  * may be weakly ordered, that is that reads and writes may pass each other.
  26  */
  27 #define DMA_ATTR_WEAK_ORDERING          (1UL << 1)
  28 /*
  29  * DMA_ATTR_WRITE_COMBINE: Specifies that writes to the mapping may be
  30  * buffered to improve performance.
  31  */
  32 #define DMA_ATTR_WRITE_COMBINE          (1UL << 2)
  33 /*
  34  * DMA_ATTR_NON_CONSISTENT: Lets the platform to choose to return either
  35  * consistent or non-consistent memory as it sees fit.
  36  */
  37 #define DMA_ATTR_NON_CONSISTENT         (1UL << 3)
  38 /*
  39  * DMA_ATTR_NO_KERNEL_MAPPING: Lets the platform to avoid creating a kernel
  40  * virtual mapping for the allocated buffer.
  41  */
  42 #define DMA_ATTR_NO_KERNEL_MAPPING      (1UL << 4)
  43 /*
  44  * DMA_ATTR_SKIP_CPU_SYNC: Allows platform code to skip synchronization of
  45  * the CPU cache for the given buffer assuming that it has been already
  46  * transferred to 'device' domain.
  47  */
  48 #define DMA_ATTR_SKIP_CPU_SYNC          (1UL << 5)
  49 /*
  50  * DMA_ATTR_FORCE_CONTIGUOUS: Forces contiguous allocation of the buffer
  51  * in physical memory.
  52  */
  53 #define DMA_ATTR_FORCE_CONTIGUOUS       (1UL << 6)
  54 /*
  55  * DMA_ATTR_ALLOC_SINGLE_PAGES: This is a hint to the DMA-mapping subsystem
  56  * that it's probably not worth the time to try to allocate memory to in a way
  57  * that gives better TLB efficiency.
  58  */
  59 #define DMA_ATTR_ALLOC_SINGLE_PAGES     (1UL << 7)
  60 /*
  61  * DMA_ATTR_NO_WARN: This tells the DMA-mapping subsystem to suppress
  62  * allocation failure reports (similarly to __GFP_NOWARN).
  63  */
  64 #define DMA_ATTR_NO_WARN        (1UL << 8)
  65
  66 /*
  67  * DMA_ATTR_PRIVILEGED: used to indicate that the buffer is fully
  68  * accessible at an elevated privilege level (and ideally inaccessible or
  69  * at least read-only at lesser-privileged levels).
  70  */
  71 #define DMA_ATTR_PRIVILEGED             (1UL << 9)
  72
  73 /*
  74  * A dma_addr_t can hold any valid DMA or bus address for the platform.
  75  * It can be given to a device to use as a DMA source or target.  A CPU cannot
  76  * reference a dma_addr_t directly because there may be translation between
  77  * its physical address space and the bus address space.
  78  */
  79 struct dma_map_ops {
  80         void* (*alloc)(struct device *dev, size_t size,
  81                                 dma_addr_t *dma_handle, gfp_t gfp,
  82                                 unsigned long attrs);
  83         void (*free)(struct device *dev, size_t size,
  84                               void *vaddr, dma_addr_t dma_handle,
  85                               unsigned long attrs);
  86         int (*mmap)(struct device *, struct vm_area_struct *,
  87                           void *, dma_addr_t, size_t,
  88                           unsigned long attrs);
  89
  90         int (*get_sgtable)(struct device *dev, struct sg_table *sgt, void *,
  91                            dma_addr_t, size_t, unsigned long attrs);
  92
  93         dma_addr_t (*map_page)(struct device *dev, struct page *page,
  94                                unsigned long offset, size_t size,
  95                                enum dma_data_direction dir,
  96                                unsigned long attrs);
  97         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
  98                            size_t size, enum dma_data_direction dir,
  99                            unsigned long attrs);
 100         /*
 101          * map_sg returns 0 on error and a value > 0 on success.
 102          * It should never return a value < 0.
 103          */
 104         int (*map_sg)(struct device *dev, struct scatterlist *sg,
 105                       int nents, enum dma_data_direction dir,
 106                       unsigned long attrs);
 107         void (*unmap_sg)(struct device *dev,
 108                          struct scatterlist *sg, int nents,
 109                          enum dma_data_direction dir,
 110                          unsigned long attrs);
 111         dma_addr_t (*map_resource)(struct device *dev, phys_addr_t phys_addr,
 112                                size_t size, enum dma_data_direction dir,
 113                                unsigned long attrs);
 114         void (*unmap_resource)(struct device *dev, dma_addr_t dma_handle,
 115                            size_t size, enum dma_data_direction dir,
 116                            unsigned long attrs);
 117         void (*sync_single_for_cpu)(struct device *dev,
 118                                     dma_addr_t dma_handle, size_t size,
 119                                     enum dma_data_direction dir);
 120         void (*sync_single_for_device)(struct device *dev,
 121                                        dma_addr_t dma_handle, size_t size,
 122                                        enum dma_data_direction dir);
 123         void (*sync_sg_for_cpu)(struct device *dev,
 124                                 struct scatterlist *sg, int nents,
 125                                 enum dma_data_direction dir);
 126         void (*sync_sg_for_device)(struct device *dev,
 127                                    struct scatterlist *sg, int nents,
 128                                    enum dma_data_direction dir);
 129         void (*cache_sync)(struct device *dev, void *vaddr, size_t size,
 130                         enum dma_data_direction direction);
 131         int (*dma_supported)(struct device *dev, u64 mask);
 132         u64 (*get_required_mask)(struct device *dev);
 133 };
 134
 135 #define DMA_MAPPING_ERROR               (~(dma_addr_t)0)
 136
 137 extern const struct dma_map_ops dma_direct_ops;
 138 extern const struct dma_map_ops dma_virt_ops;
 139
 140 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
 141
 142 #define DMA_MASK_NONE   0x0ULL
 143
 144 static inline int valid_dma_direction(int dma_direction)
 145 {
 146         return ((dma_direction == DMA_BIDIRECTIONAL) ||
 147                 (dma_direction == DMA_TO_DEVICE) ||
 148                 (dma_direction == DMA_FROM_DEVICE));
 149 }
 150
 151 static inline int is_device_dma_capable(struct device *dev)
 152 {
 153         return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
 154 }
 155
 156 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
 157 /*
 158  * These three functions are only for dma allocator.
 159  * Don't use them in device drivers.
 160  */
 161 int dma_alloc_from_dev_coherent(struct device *dev, ssize_t size,
 162                                        dma_addr_t *dma_handle, void **ret);
 163 int dma_release_from_dev_coherent(struct device *dev, int order, void *vaddr);
 164
 165 int dma_mmap_from_dev_coherent(struct device *dev, struct vm_area_struct *vma,
 166                             void *cpu_addr, size_t size, int *ret);
 167
 168 void *dma_alloc_from_global_coherent(ssize_t size, dma_addr_t *dma_handle);
 169 int dma_release_from_global_coherent(int order, void *vaddr);
 170 int dma_mmap_from_global_coherent(struct vm_area_struct *vma, void *cpu_addr,
 171                                   size_t size, int *ret);
 172
 173 #else
 174 #define dma_alloc_from_dev_coherent(dev, size, handle, ret) (0)
 175 #define dma_release_from_dev_coherent(dev, order, vaddr) (0)
 176 #define dma_mmap_from_dev_coherent(dev, vma, vaddr, order, ret) (0)
 177
 178 static inline void *dma_alloc_from_global_coherent(ssize_t size,
 179                                                    dma_addr_t *dma_handle)
 180 {
 181         return NULL;
 182 }
 183
 184 static inline int dma_release_from_global_coherent(int order, void *vaddr)
 185 {
 186         return 0;
 187 }
 188
 189 static inline int dma_mmap_from_global_coherent(struct vm_area_struct *vma,
 190                                                 void *cpu_addr, size_t size,
 191                                                 int *ret)
 192 {
 193         return 0;
 194 }
 195 #endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 196
 197 #ifdef CONFIG_HAS_DMA
 198 #include <asm/dma-mapping.h>
 199 static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
 200 {
 201         if (dev && dev->dma_ops)
 202                 return dev->dma_ops;
 203         return get_arch_dma_ops(dev ? dev->bus : NULL);
 204 }
 205
 206 static inline void set_dma_ops(struct device *dev,
 207                                const struct dma_map_ops *dma_ops)
 208 {
 209         dev->dma_ops = dma_ops;
 210 }
 211 #else
 212 /*
 213  * Define the dma api to allow compilation of dma dependent code.
 214  * Code that depends on the dma-mapping API needs to set 'depends on HAS_DMA'
 215  * in its Kconfig, unless it already depends on <something> || COMPILE_TEST,
 216  * where <something> guarantuees the availability of the dma-mapping API.
 217  */
 218 static inline const struct dma_map_ops *get_dma_ops(struct device *dev)
 219 {
 220         return NULL;
 221 }
 222 #endif
 223
 224 static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
 225                                               size_t size,
 226                                               enum dma_data_direction dir,
 227                                               unsigned long attrs)
 228 {
 229         const struct dma_map_ops *ops = get_dma_ops(dev);
 230         dma_addr_t addr;
 231
 232         BUG_ON(!valid_dma_direction(dir));
 233         debug_dma_map_single(dev, ptr, size);
 234         addr = ops->map_page(dev, virt_to_page(ptr),
 235                              offset_in_page(ptr), size,
 236                              dir, attrs);
 237         debug_dma_map_page(dev, virt_to_page(ptr),
 238                            offset_in_page(ptr), size,
 239                            dir, addr, true);
 240         return addr;
 241 }
 242
 243 static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
 244                                           size_t size,
 245                                           enum dma_data_direction dir,
 246                                           unsigned long attrs)
 247 {
 248         const struct dma_map_ops *ops = get_dma_ops(dev);
 249
 250         BUG_ON(!valid_dma_direction(dir));
 251         if (ops->unmap_page)
 252                 ops->unmap_page(dev, addr, size, dir, attrs);
 253         debug_dma_unmap_page(dev, addr, size, dir, true);
 254 }
 255
 256 /*
 257  * dma_maps_sg_attrs returns 0 on error and > 0 on success.
 258  * It should never return a value < 0.
 259  */
 260 static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
 261                                    int nents, enum dma_data_direction dir,
 262                                    unsigned long attrs)
 263 {
 264         const struct dma_map_ops *ops = get_dma_ops(dev);
 265         int ents;
 266
 267         BUG_ON(!valid_dma_direction(dir));
 268         ents = ops->map_sg(dev, sg, nents, dir, attrs);
 269         BUG_ON(ents < 0);
 270         debug_dma_map_sg(dev, sg, nents, ents, dir);
 271
 272         return ents;
 273 }
 274
 275 static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
 276                                       int nents, enum dma_data_direction dir,
 277                                       unsigned long attrs)
 278 {
 279         const struct dma_map_ops *ops = get_dma_ops(dev);
 280
 281         BUG_ON(!valid_dma_direction(dir));
 282         debug_dma_unmap_sg(dev, sg, nents, dir);
 283         if (ops->unmap_sg)
 284                 ops->unmap_sg(dev, sg, nents, dir, attrs);
 285 }
 286
 287 static inline dma_addr_t dma_map_page_attrs(struct device *dev,
 288                                             struct page *page,
 289                                             size_t offset, size_t size,
 290                                             enum dma_data_direction dir,
 291                                             unsigned long attrs)
 292 {
 293         const struct dma_map_ops *ops = get_dma_ops(dev);
 294         dma_addr_t addr;
 295
 296         BUG_ON(!valid_dma_direction(dir));
 297         addr = ops->map_page(dev, page, offset, size, dir, attrs);
 298         debug_dma_map_page(dev, page, offset, size, dir, addr, false);
 299
 300         return addr;
 301 }
 302
 303 static inline void dma_unmap_page_attrs(struct device *dev,
 304                                         dma_addr_t addr, size_t size,
 305                                         enum dma_data_direction dir,
 306                                         unsigned long attrs)
 307 {
 308         const struct dma_map_ops *ops = get_dma_ops(dev);
 309
 310         BUG_ON(!valid_dma_direction(dir));
 311         if (ops->unmap_page)
 312                 ops->unmap_page(dev, addr, size, dir, attrs);
 313         debug_dma_unmap_page(dev, addr, size, dir, false);
 314 }
 315
 316 static inline dma_addr_t dma_map_resource(struct device *dev,
 317                                           phys_addr_t phys_addr,
 318                                           size_t size,
 319                                           enum dma_data_direction dir,
 320                                           unsigned long attrs)
 321 {
 322         const struct dma_map_ops *ops = get_dma_ops(dev);
 323         dma_addr_t addr;
 324
 325         BUG_ON(!valid_dma_direction(dir));
 326
 327         /* Don't allow RAM to be mapped */
 328         BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
 329
 330         addr = phys_addr;
 331         if (ops->map_resource)
 332                 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
 333
 334         debug_dma_map_resource(dev, phys_addr, size, dir, addr);
 335
 336         return addr;
 337 }
 338
 339 static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
 340                                       size_t size, enum dma_data_direction dir,
 341                                       unsigned long attrs)
 342 {
 343         const struct dma_map_ops *ops = get_dma_ops(dev);
 344
 345         BUG_ON(!valid_dma_direction(dir));
 346         if (ops->unmap_resource)
 347                 ops->unmap_resource(dev, addr, size, dir, attrs);
 348         debug_dma_unmap_resource(dev, addr, size, dir);
 349 }
 350
 351 static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
 352                                            size_t size,
 353                                            enum dma_data_direction dir)
 354 {
 355         const struct dma_map_ops *ops = get_dma_ops(dev);
 356
 357         BUG_ON(!valid_dma_direction(dir));
 358         if (ops->sync_single_for_cpu)
 359                 ops->sync_single_for_cpu(dev, addr, size, dir);
 360         debug_dma_sync_single_for_cpu(dev, addr, size, dir);
 361 }
 362
 363 static inline void dma_sync_single_for_device(struct device *dev,
 364                                               dma_addr_t addr, size_t size,
 365                                               enum dma_data_direction dir)
 366 {
 367         const struct dma_map_ops *ops = get_dma_ops(dev);
 368
 369         BUG_ON(!valid_dma_direction(dir));
 370         if (ops->sync_single_for_device)
 371                 ops->sync_single_for_device(dev, addr, size, dir);
 372         debug_dma_sync_single_for_device(dev, addr, size, dir);
 373 }
 374
 375 static inline void dma_sync_single_range_for_cpu(struct device *dev,
 376                                                  dma_addr_t addr,
 377                                                  unsigned long offset,
 378                                                  size_t size,
 379                                                  enum dma_data_direction dir)
 380 {
 381         const struct dma_map_ops *ops = get_dma_ops(dev);
 382
 383         BUG_ON(!valid_dma_direction(dir));
 384         if (ops->sync_single_for_cpu)
 385                 ops->sync_single_for_cpu(dev, addr + offset, size, dir);
 386         debug_dma_sync_single_range_for_cpu(dev, addr, offset, size, dir);
 387 }
 388
 389 static inline void dma_sync_single_range_for_device(struct device *dev,
 390                                                     dma_addr_t addr,
 391                                                     unsigned long offset,
 392                                                     size_t size,
 393                                                     enum dma_data_direction dir)
 394 {
 395         const struct dma_map_ops *ops = get_dma_ops(dev);
 396
 397         BUG_ON(!valid_dma_direction(dir));
 398         if (ops->sync_single_for_device)
 399                 ops->sync_single_for_device(dev, addr + offset, size, dir);
 400         debug_dma_sync_single_range_for_device(dev, addr, offset, size, dir);
 401 }
 402
 403 static inline void
 404 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
 405                     int nelems, enum dma_data_direction dir)
 406 {
 407         const struct dma_map_ops *ops = get_dma_ops(dev);
 408
 409         BUG_ON(!valid_dma_direction(dir));
 410         if (ops->sync_sg_for_cpu)
 411                 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
 412         debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
 413 }
 414
 415 static inline void
 416 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
 417                        int nelems, enum dma_data_direction dir)
 418 {
 419         const struct dma_map_ops *ops = get_dma_ops(dev);
 420
 421         BUG_ON(!valid_dma_direction(dir));
 422         if (ops->sync_sg_for_device)
 423                 ops->sync_sg_for_device(dev, sg, nelems, dir);
 424         debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
 425
 426 }
 427
 428 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
 429 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
 430 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
 431 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
 432 #define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
 433 #define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
 434
 435 static inline void
 436 dma_cache_sync(struct device *dev, void *vaddr, size_t size,
 437                 enum dma_data_direction dir)
 438 {
 439         const struct dma_map_ops *ops = get_dma_ops(dev);
 440
 441         BUG_ON(!valid_dma_direction(dir));
 442         if (ops->cache_sync)
 443                 ops->cache_sync(dev, vaddr, size, dir);
 444 }
 445
 446 extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
 447                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 448                 unsigned long attrs);
 449
 450 void *dma_common_contiguous_remap(struct page *page, size_t size,
 451                         unsigned long vm_flags,
 452                         pgprot_t prot, const void *caller);
 453
 454 void *dma_common_pages_remap(struct page **pages, size_t size,
 455                         unsigned long vm_flags, pgprot_t prot,
 456                         const void *caller);
 457 void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
 458
 459 int __init dma_atomic_pool_init(gfp_t gfp, pgprot_t prot);
 460 bool dma_in_atomic_pool(void *start, size_t size);
 461 void *dma_alloc_from_pool(size_t size, struct page **ret_page, gfp_t flags);
 462 bool dma_free_from_pool(void *start, size_t size);
 463
 464 /**
 465  * dma_mmap_attrs - map a coherent DMA allocation into user space
 466  * @dev: valid struct device pointer, or NULL for ISA and EISA-like devices
 467  * @vma: vm_area_struct describing requested user mapping
 468  * @cpu_addr: kernel CPU-view address returned from dma_alloc_attrs
 469  * @handle: device-view address returned from dma_alloc_attrs
 470  * @size: size of memory originally requested in dma_alloc_attrs
 471  * @attrs: attributes of mapping properties requested in dma_alloc_attrs
 472  *
 473  * Map a coherent DMA buffer previously allocated by dma_alloc_attrs
 474  * into user space.  The coherent DMA buffer must not be freed by the
 475  * driver until the user space mapping has been released.
 476  */
 477 static inline int
 478 dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma, void *cpu_addr,
 479                dma_addr_t dma_addr, size_t size, unsigned long attrs)
 480 {
 481         const struct dma_map_ops *ops = get_dma_ops(dev);
 482         BUG_ON(!ops);
 483         if (ops->mmap)
 484                 return ops->mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
 485         return dma_common_mmap(dev, vma, cpu_addr, dma_addr, size, attrs);
 486 }
 487
 488 #define dma_mmap_coherent(d, v, c, h, s) dma_mmap_attrs(d, v, c, h, s, 0)
 489
 490 int
 491 dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, void *cpu_addr,
 492                 dma_addr_t dma_addr, size_t size, unsigned long attrs);
 493
 494 static inline int
 495 dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt, void *cpu_addr,
 496                       dma_addr_t dma_addr, size_t size,
 497                       unsigned long attrs)
 498 {
 499         const struct dma_map_ops *ops = get_dma_ops(dev);
 500         BUG_ON(!ops);
 501         if (ops->get_sgtable)
 502                 return ops->get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
 503                                         attrs);
 504         return dma_common_get_sgtable(dev, sgt, cpu_addr, dma_addr, size,
 505                         attrs);
 506 }
 507
 508 #define dma_get_sgtable(d, t, v, h, s) dma_get_sgtable_attrs(d, t, v, h, s, 0)
 509
 510 #ifndef arch_dma_alloc_attrs
 511 #define arch_dma_alloc_attrs(dev)       (true)
 512 #endif
 513
 514 static inline void *dma_alloc_attrs(struct device *dev, size_t size,
 515                                        dma_addr_t *dma_handle, gfp_t flag,
 516                                        unsigned long attrs)
 517 {
 518         const struct dma_map_ops *ops = get_dma_ops(dev);
 519         void *cpu_addr;
 520
 521         BUG_ON(!ops);
 522         WARN_ON_ONCE(dev && !dev->coherent_dma_mask);
 523
 524         if (dma_alloc_from_dev_coherent(dev, size, dma_handle, &cpu_addr))
 525                 return cpu_addr;
 526
 527         /* let the implementation decide on the zone to allocate from: */
 528         flag &= ~(__GFP_DMA | __GFP_DMA32 | __GFP_HIGHMEM);
 529
 530         if (!arch_dma_alloc_attrs(&dev))
 531                 return NULL;
 532         if (!ops->alloc)
 533                 return NULL;
 534
 535         cpu_addr = ops->alloc(dev, size, dma_handle, flag, attrs);
 536         debug_dma_alloc_coherent(dev, size, *dma_handle, cpu_addr);
 537         return cpu_addr;
 538 }
 539
 540 static inline void dma_free_attrs(struct device *dev, size_t size,
 541                                      void *cpu_addr, dma_addr_t dma_handle,
 542                                      unsigned long attrs)
 543 {
 544         const struct dma_map_ops *ops = get_dma_ops(dev);
 545
 546         BUG_ON(!ops);
 547
 548         if (dma_release_from_dev_coherent(dev, get_order(size), cpu_addr))
 549                 return;
 550         /*
 551          * On non-coherent platforms which implement DMA-coherent buffers via
 552          * non-cacheable remaps, ops->free() may call vunmap(). Thus getting
 553          * this far in IRQ context is a) at risk of a BUG_ON() or trying to
 554          * sleep on some machines, and b) an indication that the driver is
 555          * probably misusing the coherent API anyway.
 556          */
 557         WARN_ON(irqs_disabled());
 558
 559         if (!ops->free || !cpu_addr)
 560                 return;
 561
 562         debug_dma_free_coherent(dev, size, cpu_addr, dma_handle);
 563         ops->free(dev, size, cpu_addr, dma_handle, attrs);
 564 }
 565
 566 static inline void *dma_alloc_coherent(struct device *dev, size_t size,
 567                 dma_addr_t *dma_handle, gfp_t gfp)
 568 {
 569
 570         return dma_alloc_attrs(dev, size, dma_handle, gfp,
 571                         (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
 572 }
 573
 574 static inline void dma_free_coherent(struct device *dev, size_t size,
 575                 void *cpu_addr, dma_addr_t dma_handle)
 576 {
 577         return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
 578 }
 579
 580 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 581 {
 582         debug_dma_mapping_error(dev, dma_addr);
 583
 584         if (dma_addr == DMA_MAPPING_ERROR)
 585                 return 1;
 586         return 0;
 587 }
 588
 589 static inline void dma_check_mask(struct device *dev, u64 mask)
 590 {
 591         if (sme_active() && (mask < (((u64)sme_get_me_mask() << 1) - 1)))
 592                 dev_warn(dev, "SME is active, device will require DMA bounce buffers\n");
 593 }
 594
 595 static inline int dma_supported(struct device *dev, u64 mask)
 596 {
 597         const struct dma_map_ops *ops = get_dma_ops(dev);
 598
 599         if (!ops)
 600                 return 0;
 601         if (!ops->dma_supported)
 602                 return 1;
 603         return ops->dma_supported(dev, mask);
 604 }
 605
 606 #ifndef HAVE_ARCH_DMA_SET_MASK
 607 static inline int dma_set_mask(struct device *dev, u64 mask)
 608 {
 609         if (!dev->dma_mask || !dma_supported(dev, mask))
 610                 return -EIO;
 611
 612         dma_check_mask(dev, mask);
 613
 614         *dev->dma_mask = mask;
 615         return 0;
 616 }
 617 #endif
 618
 619 static inline u64 dma_get_mask(struct device *dev)
 620 {
 621         if (dev && dev->dma_mask && *dev->dma_mask)
 622                 return *dev->dma_mask;
 623         return DMA_BIT_MASK(32);
 624 }
 625
 626 #ifdef CONFIG_ARCH_HAS_DMA_SET_COHERENT_MASK
 627 int dma_set_coherent_mask(struct device *dev, u64 mask);
 628 #else
 629 static inline int dma_set_coherent_mask(struct device *dev, u64 mask)
 630 {
 631         if (!dma_supported(dev, mask))
 632                 return -EIO;
 633
 634         dma_check_mask(dev, mask);
 635
 636         dev->coherent_dma_mask = mask;
 637         return 0;
 638 }
 639 #endif
 640
 641 /*
 642  * Set both the DMA mask and the coherent DMA mask to the same thing.
 643  * Note that we don't check the return value from dma_set_coherent_mask()
 644  * as the DMA API guarantees that the coherent DMA mask can be set to
 645  * the same or smaller than the streaming DMA mask.
 646  */
 647 static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
 648 {
 649         int rc = dma_set_mask(dev, mask);
 650         if (rc == 0)
 651                 dma_set_coherent_mask(dev, mask);
 652         return rc;
 653 }
 654
 655 /*
 656  * Similar to the above, except it deals with the case where the device
 657  * does not have dev->dma_mask appropriately setup.
 658  */
 659 static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
 660 {
 661         dev->dma_mask = &dev->coherent_dma_mask;
 662         return dma_set_mask_and_coherent(dev, mask);
 663 }
 664
 665 extern u64 dma_get_required_mask(struct device *dev);
 666
 667 #ifndef arch_setup_dma_ops
 668 static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
 669                                       u64 size, const struct iommu_ops *iommu,
 670                                       bool coherent) { }
 671 #endif
 672
 673 #ifndef arch_teardown_dma_ops
 674 static inline void arch_teardown_dma_ops(struct device *dev) { }
 675 #endif
 676
 677 static inline unsigned int dma_get_max_seg_size(struct device *dev)
 678 {
 679         if (dev->dma_parms && dev->dma_parms->max_segment_size)
 680                 return dev->dma_parms->max_segment_size;
 681         return SZ_64K;
 682 }
 683
 684 static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
 685 {
 686         if (dev->dma_parms) {
 687                 dev->dma_parms->max_segment_size = size;
 688                 return 0;
 689         }
 690         return -EIO;
 691 }
 692
 693 static inline unsigned long dma_get_seg_boundary(struct device *dev)
 694 {
 695         if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
 696                 return dev->dma_parms->segment_boundary_mask;
 697         return DMA_BIT_MASK(32);
 698 }
 699
 700 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
 701 {
 702         if (dev->dma_parms) {
 703                 dev->dma_parms->segment_boundary_mask = mask;
 704                 return 0;
 705         }
 706         return -EIO;
 707 }
 708
 709 #ifndef dma_max_pfn
 710 static inline unsigned long dma_max_pfn(struct device *dev)
 711 {
 712         return (*dev->dma_mask >> PAGE_SHIFT) + dev->dma_pfn_offset;
 713 }
 714 #endif
 715
 716 static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
 717                                         dma_addr_t *dma_handle, gfp_t flag)
 718 {
 719         void *ret = dma_alloc_coherent(dev, size, dma_handle,
 720                                        flag | __GFP_ZERO);
 721         return ret;
 722 }
 723
 724 static inline int dma_get_cache_alignment(void)
 725 {
 726 #ifdef ARCH_DMA_MINALIGN
 727         return ARCH_DMA_MINALIGN;
 728 #endif
 729         return 1;
 730 }
 731
 732 /* flags for the coherent memory api */
 733 #define DMA_MEMORY_EXCLUSIVE            0x01
 734
 735 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
 736 int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 737                                 dma_addr_t device_addr, size_t size, int flags);
 738 void dma_release_declared_memory(struct device *dev);
 739 void *dma_mark_declared_memory_occupied(struct device *dev,
 740                                         dma_addr_t device_addr, size_t size);
 741 #else
 742 static inline int
 743 dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 744                             dma_addr_t device_addr, size_t size, int flags)
 745 {
 746         return -ENOSYS;
 747 }
 748
 749 static inline void
 750 dma_release_declared_memory(struct device *dev)
 751 {
 752 }
 753
 754 static inline void *
 755 dma_mark_declared_memory_occupied(struct device *dev,
 756                                   dma_addr_t device_addr, size_t size)
 757 {
 758         return ERR_PTR(-EBUSY);
 759 }
 760 #endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 761
 762 /*
 763  * Managed DMA API
 764  */
 765 #ifdef CONFIG_HAS_DMA
 766 extern void *dmam_alloc_coherent(struct device *dev, size_t size,
 767                                  dma_addr_t *dma_handle, gfp_t gfp);
 768 extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
 769                                dma_addr_t dma_handle);
 770 #else /* !CONFIG_HAS_DMA */
 771 static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
 772                                         dma_addr_t *dma_handle, gfp_t gfp)
 773 { return NULL; }
 774 static inline void dmam_free_coherent(struct device *dev, size_t size,
 775                                       void *vaddr, dma_addr_t dma_handle) { }
 776 #endif /* !CONFIG_HAS_DMA */
 777
 778 extern void *dmam_alloc_attrs(struct device *dev, size_t size,
 779                               dma_addr_t *dma_handle, gfp_t gfp,
 780                               unsigned long attrs);
 781 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
 782 extern int dmam_declare_coherent_memory(struct device *dev,
 783                                         phys_addr_t phys_addr,
 784                                         dma_addr_t device_addr, size_t size,
 785                                         int flags);
 786 extern void dmam_release_declared_memory(struct device *dev);
 787 #else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 788 static inline int dmam_declare_coherent_memory(struct device *dev,
 789                                 phys_addr_t phys_addr, dma_addr_t device_addr,
 790                                 size_t size, gfp_t gfp)
 791 {
 792         return 0;
 793 }
 794
 795 static inline void dmam_release_declared_memory(struct device *dev)
 796 {
 797 }
 798 #endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 799
 800 static inline void *dma_alloc_wc(struct device *dev, size_t size,
 801                                  dma_addr_t *dma_addr, gfp_t gfp)
 802 {
 803         unsigned long attrs = DMA_ATTR_NO_WARN;
 804
 805         if (gfp & __GFP_NOWARN)
 806                 attrs |= DMA_ATTR_NO_WARN;
 807
 808         return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
 809 }
 810 #ifndef dma_alloc_writecombine
 811 #define dma_alloc_writecombine dma_alloc_wc
 812 #endif
 813
 814 static inline void dma_free_wc(struct device *dev, size_t size,
 815                                void *cpu_addr, dma_addr_t dma_addr)
 816 {
 817         return dma_free_attrs(dev, size, cpu_addr, dma_addr,
 818                               DMA_ATTR_WRITE_COMBINE);
 819 }
 820 #ifndef dma_free_writecombine
 821 #define dma_free_writecombine dma_free_wc
 822 #endif
 823
 824 static inline int dma_mmap_wc(struct device *dev,
 825                               struct vm_area_struct *vma,
 826                               void *cpu_addr, dma_addr_t dma_addr,
 827                               size_t size)
 828 {
 829         return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
 830                               DMA_ATTR_WRITE_COMBINE);
 831 }
 832 #ifndef dma_mmap_writecombine
 833 #define dma_mmap_writecombine dma_mmap_wc
 834 #endif
 835
 836 #ifdef CONFIG_NEED_DMA_MAP_STATE
 837 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)        dma_addr_t ADDR_NAME
 838 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)          __u32 LEN_NAME
 839 #define dma_unmap_addr(PTR, ADDR_NAME)           ((PTR)->ADDR_NAME)
 840 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  (((PTR)->ADDR_NAME) = (VAL))
 841 #define dma_unmap_len(PTR, LEN_NAME)             ((PTR)->LEN_NAME)
 842 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    (((PTR)->LEN_NAME) = (VAL))
 843 #else
 844 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
 845 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
 846 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
 847 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
 848 #define dma_unmap_len(PTR, LEN_NAME)             (0)
 849 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
 850 #endif
 851
 852 #endif