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_virt_ops;
 138 extern const struct dma_map_ops dma_dummy_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 bool dma_is_direct(const struct dma_map_ops *ops)
 225 {
 226         return likely(!ops);
 227 }
 228
 229 /*
 230  * All the dma_direct_* declarations are here just for the indirect call bypass,
 231  * and must not be used directly drivers!
 232  */
 233 dma_addr_t dma_direct_map_page(struct device *dev, struct page *page,
 234                 unsigned long offset, size_t size, enum dma_data_direction dir,
 235                 unsigned long attrs);
 236 int dma_direct_map_sg(struct device *dev, struct scatterlist *sgl, int nents,
 237                 enum dma_data_direction dir, unsigned long attrs);
 238
 239 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
 240     defined(CONFIG_SWIOTLB)
 241 void dma_direct_sync_single_for_device(struct device *dev,
 242                 dma_addr_t addr, size_t size, enum dma_data_direction dir);
 243 void dma_direct_sync_sg_for_device(struct device *dev,
 244                 struct scatterlist *sgl, int nents, enum dma_data_direction dir);
 245 #else
 246 static inline void dma_direct_sync_single_for_device(struct device *dev,
 247                 dma_addr_t addr, size_t size, enum dma_data_direction dir)
 248 {
 249 }
 250 static inline void dma_direct_sync_sg_for_device(struct device *dev,
 251                 struct scatterlist *sgl, int nents, enum dma_data_direction dir)
 252 {
 253 }
 254 #endif
 255
 256 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
 257     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) || \
 258     defined(CONFIG_SWIOTLB)
 259 void dma_direct_unmap_page(struct device *dev, dma_addr_t addr,
 260                 size_t size, enum dma_data_direction dir, unsigned long attrs);
 261 void dma_direct_unmap_sg(struct device *dev, struct scatterlist *sgl,
 262                 int nents, enum dma_data_direction dir, unsigned long attrs);
 263 void dma_direct_sync_single_for_cpu(struct device *dev,
 264                 dma_addr_t addr, size_t size, enum dma_data_direction dir);
 265 void dma_direct_sync_sg_for_cpu(struct device *dev,
 266                 struct scatterlist *sgl, int nents, enum dma_data_direction dir);
 267 #else
 268 static inline void dma_direct_unmap_page(struct device *dev, dma_addr_t addr,
 269                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 270 {
 271 }
 272 static inline void dma_direct_unmap_sg(struct device *dev,
 273                 struct scatterlist *sgl, int nents, enum dma_data_direction dir,
 274                 unsigned long attrs)
 275 {
 276 }
 277 static inline void dma_direct_sync_single_for_cpu(struct device *dev,
 278                 dma_addr_t addr, size_t size, enum dma_data_direction dir)
 279 {
 280 }
 281 static inline void dma_direct_sync_sg_for_cpu(struct device *dev,
 282                 struct scatterlist *sgl, int nents, enum dma_data_direction dir)
 283 {
 284 }
 285 #endif
 286
 287 static inline dma_addr_t dma_map_single_attrs(struct device *dev, void *ptr,
 288                                               size_t size,
 289                                               enum dma_data_direction dir,
 290                                               unsigned long attrs)
 291 {
 292         const struct dma_map_ops *ops = get_dma_ops(dev);
 293         dma_addr_t addr;
 294
 295         BUG_ON(!valid_dma_direction(dir));
 296         debug_dma_map_single(dev, ptr, size);
 297         if (dma_is_direct(ops))
 298                 addr = dma_direct_map_page(dev, virt_to_page(ptr),
 299                                 offset_in_page(ptr), size, dir, attrs);
 300         else
 301                 addr = ops->map_page(dev, virt_to_page(ptr),
 302                                 offset_in_page(ptr), size, dir, attrs);
 303         debug_dma_map_page(dev, virt_to_page(ptr),
 304                            offset_in_page(ptr), size,
 305                            dir, addr, true);
 306         return addr;
 307 }
 308
 309 static inline void dma_unmap_single_attrs(struct device *dev, dma_addr_t addr,
 310                                           size_t size,
 311                                           enum dma_data_direction dir,
 312                                           unsigned long attrs)
 313 {
 314         const struct dma_map_ops *ops = get_dma_ops(dev);
 315
 316         BUG_ON(!valid_dma_direction(dir));
 317         if (dma_is_direct(ops))
 318                 dma_direct_unmap_page(dev, addr, size, dir, attrs);
 319         else if (ops->unmap_page)
 320                 ops->unmap_page(dev, addr, size, dir, attrs);
 321         debug_dma_unmap_page(dev, addr, size, dir, true);
 322 }
 323
 324 static inline void dma_unmap_page_attrs(struct device *dev, dma_addr_t addr,
 325                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 326 {
 327         return dma_unmap_single_attrs(dev, addr, size, dir, attrs);
 328 }
 329
 330 /*
 331  * dma_maps_sg_attrs returns 0 on error and > 0 on success.
 332  * It should never return a value < 0.
 333  */
 334 static inline int dma_map_sg_attrs(struct device *dev, struct scatterlist *sg,
 335                                    int nents, enum dma_data_direction dir,
 336                                    unsigned long attrs)
 337 {
 338         const struct dma_map_ops *ops = get_dma_ops(dev);
 339         int ents;
 340
 341         BUG_ON(!valid_dma_direction(dir));
 342         if (dma_is_direct(ops))
 343                 ents = dma_direct_map_sg(dev, sg, nents, dir, attrs);
 344         else
 345                 ents = ops->map_sg(dev, sg, nents, dir, attrs);
 346         BUG_ON(ents < 0);
 347         debug_dma_map_sg(dev, sg, nents, ents, dir);
 348
 349         return ents;
 350 }
 351
 352 static inline void dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg,
 353                                       int nents, enum dma_data_direction dir,
 354                                       unsigned long attrs)
 355 {
 356         const struct dma_map_ops *ops = get_dma_ops(dev);
 357
 358         BUG_ON(!valid_dma_direction(dir));
 359         debug_dma_unmap_sg(dev, sg, nents, dir);
 360         if (dma_is_direct(ops))
 361                 dma_direct_unmap_sg(dev, sg, nents, dir, attrs);
 362         else if (ops->unmap_sg)
 363                 ops->unmap_sg(dev, sg, nents, dir, attrs);
 364 }
 365
 366 static inline dma_addr_t dma_map_page_attrs(struct device *dev,
 367                                             struct page *page,
 368                                             size_t offset, size_t size,
 369                                             enum dma_data_direction dir,
 370                                             unsigned long attrs)
 371 {
 372         const struct dma_map_ops *ops = get_dma_ops(dev);
 373         dma_addr_t addr;
 374
 375         BUG_ON(!valid_dma_direction(dir));
 376         if (dma_is_direct(ops))
 377                 addr = dma_direct_map_page(dev, page, offset, size, dir, attrs);
 378         else
 379                 addr = ops->map_page(dev, page, offset, size, dir, attrs);
 380         debug_dma_map_page(dev, page, offset, size, dir, addr, false);
 381
 382         return addr;
 383 }
 384
 385 static inline dma_addr_t dma_map_resource(struct device *dev,
 386                                           phys_addr_t phys_addr,
 387                                           size_t size,
 388                                           enum dma_data_direction dir,
 389                                           unsigned long attrs)
 390 {
 391         const struct dma_map_ops *ops = get_dma_ops(dev);
 392         dma_addr_t addr;
 393
 394         BUG_ON(!valid_dma_direction(dir));
 395
 396         /* Don't allow RAM to be mapped */
 397         BUG_ON(pfn_valid(PHYS_PFN(phys_addr)));
 398
 399         addr = phys_addr;
 400         if (ops && ops->map_resource)
 401                 addr = ops->map_resource(dev, phys_addr, size, dir, attrs);
 402
 403         debug_dma_map_resource(dev, phys_addr, size, dir, addr);
 404
 405         return addr;
 406 }
 407
 408 static inline void dma_unmap_resource(struct device *dev, dma_addr_t addr,
 409                                       size_t size, enum dma_data_direction dir,
 410                                       unsigned long attrs)
 411 {
 412         const struct dma_map_ops *ops = get_dma_ops(dev);
 413
 414         BUG_ON(!valid_dma_direction(dir));
 415         if (ops && ops->unmap_resource)
 416                 ops->unmap_resource(dev, addr, size, dir, attrs);
 417         debug_dma_unmap_resource(dev, addr, size, dir);
 418 }
 419
 420 static inline void dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr,
 421                                            size_t size,
 422                                            enum dma_data_direction dir)
 423 {
 424         const struct dma_map_ops *ops = get_dma_ops(dev);
 425
 426         BUG_ON(!valid_dma_direction(dir));
 427         if (dma_is_direct(ops))
 428                 dma_direct_sync_single_for_cpu(dev, addr, size, dir);
 429         else if (ops->sync_single_for_cpu)
 430                 ops->sync_single_for_cpu(dev, addr, size, dir);
 431         debug_dma_sync_single_for_cpu(dev, addr, size, dir);
 432 }
 433
 434 static inline void dma_sync_single_range_for_cpu(struct device *dev,
 435                 dma_addr_t addr, unsigned long offset, size_t size,
 436                 enum dma_data_direction dir)
 437 {
 438         return dma_sync_single_for_cpu(dev, addr + offset, size, dir);
 439 }
 440
 441 static inline void dma_sync_single_for_device(struct device *dev,
 442                                               dma_addr_t addr, size_t size,
 443                                               enum dma_data_direction dir)
 444 {
 445         const struct dma_map_ops *ops = get_dma_ops(dev);
 446
 447         BUG_ON(!valid_dma_direction(dir));
 448         if (dma_is_direct(ops))
 449                 dma_direct_sync_single_for_device(dev, addr, size, dir);
 450         else if (ops->sync_single_for_device)
 451                 ops->sync_single_for_device(dev, addr, size, dir);
 452         debug_dma_sync_single_for_device(dev, addr, size, dir);
 453 }
 454
 455 static inline void dma_sync_single_range_for_device(struct device *dev,
 456                 dma_addr_t addr, unsigned long offset, size_t size,
 457                 enum dma_data_direction dir)
 458 {
 459         return dma_sync_single_for_device(dev, addr + offset, size, dir);
 460 }
 461
 462 static inline void
 463 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
 464                     int nelems, enum dma_data_direction dir)
 465 {
 466         const struct dma_map_ops *ops = get_dma_ops(dev);
 467
 468         BUG_ON(!valid_dma_direction(dir));
 469         if (dma_is_direct(ops))
 470                 dma_direct_sync_sg_for_cpu(dev, sg, nelems, dir);
 471         else if (ops->sync_sg_for_cpu)
 472                 ops->sync_sg_for_cpu(dev, sg, nelems, dir);
 473         debug_dma_sync_sg_for_cpu(dev, sg, nelems, dir);
 474 }
 475
 476 static inline void
 477 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
 478                        int nelems, enum dma_data_direction dir)
 479 {
 480         const struct dma_map_ops *ops = get_dma_ops(dev);
 481
 482         BUG_ON(!valid_dma_direction(dir));
 483         if (dma_is_direct(ops))
 484                 dma_direct_sync_sg_for_device(dev, sg, nelems, dir);
 485         else if (ops->sync_sg_for_device)
 486                 ops->sync_sg_for_device(dev, sg, nelems, dir);
 487         debug_dma_sync_sg_for_device(dev, sg, nelems, dir);
 488
 489 }
 490
 491 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0)
 492 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0)
 493 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0)
 494 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0)
 495 #define dma_map_page(d, p, o, s, r) dma_map_page_attrs(d, p, o, s, r, 0)
 496 #define dma_unmap_page(d, a, s, r) dma_unmap_page_attrs(d, a, s, r, 0)
 497
 498 void dma_cache_sync(struct device *dev, void *vaddr, size_t size,
 499                 enum dma_data_direction dir);
 500
 501 extern int dma_common_mmap(struct device *dev, struct vm_area_struct *vma,
 502                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 503                 unsigned long attrs);
 504
 505 void *dma_common_contiguous_remap(struct page *page, size_t size,
 506                         unsigned long vm_flags,
 507                         pgprot_t prot, const void *caller);
 508
 509 void *dma_common_pages_remap(struct page **pages, size_t size,
 510                         unsigned long vm_flags, pgprot_t prot,
 511                         const void *caller);
 512 void dma_common_free_remap(void *cpu_addr, size_t size, unsigned long vm_flags);
 513
 514 int __init dma_atomic_pool_init(gfp_t gfp, pgprot_t prot);
 515 bool dma_in_atomic_pool(void *start, size_t size);
 516 void *dma_alloc_from_pool(size_t size, struct page **ret_page, gfp_t flags);
 517 bool dma_free_from_pool(void *start, size_t size);
 518
 519 int dma_mmap_attrs(struct device *dev, struct vm_area_struct *vma,
 520                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 521                 unsigned long attrs);
 522 #define dma_mmap_coherent(d, v, c, h, s) dma_mmap_attrs(d, v, c, h, s, 0)
 523
 524 int
 525 dma_common_get_sgtable(struct device *dev, struct sg_table *sgt, void *cpu_addr,
 526                 dma_addr_t dma_addr, size_t size, unsigned long attrs);
 527
 528 int dma_get_sgtable_attrs(struct device *dev, struct sg_table *sgt,
 529                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
 530                 unsigned long attrs);
 531 #define dma_get_sgtable(d, t, v, h, s) dma_get_sgtable_attrs(d, t, v, h, s, 0)
 532
 533 void *dma_alloc_attrs(struct device *dev, size_t size, dma_addr_t *dma_handle,
 534                 gfp_t flag, unsigned long attrs);
 535 void dma_free_attrs(struct device *dev, size_t size, void *cpu_addr,
 536                 dma_addr_t dma_handle, unsigned long attrs);
 537
 538 static inline void *dma_alloc_coherent(struct device *dev, size_t size,
 539                 dma_addr_t *dma_handle, gfp_t gfp)
 540 {
 541
 542         return dma_alloc_attrs(dev, size, dma_handle, gfp,
 543                         (gfp & __GFP_NOWARN) ? DMA_ATTR_NO_WARN : 0);
 544 }
 545
 546 static inline void dma_free_coherent(struct device *dev, size_t size,
 547                 void *cpu_addr, dma_addr_t dma_handle)
 548 {
 549         return dma_free_attrs(dev, size, cpu_addr, dma_handle, 0);
 550 }
 551
 552 static inline int dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 553 {
 554         debug_dma_mapping_error(dev, dma_addr);
 555
 556         if (dma_addr == DMA_MAPPING_ERROR)
 557                 return -ENOMEM;
 558         return 0;
 559 }
 560
 561 int dma_supported(struct device *dev, u64 mask);
 562 int dma_set_mask(struct device *dev, u64 mask);
 563 int dma_set_coherent_mask(struct device *dev, u64 mask);
 564
 565 static inline u64 dma_get_mask(struct device *dev)
 566 {
 567         if (dev && dev->dma_mask && *dev->dma_mask)
 568                 return *dev->dma_mask;
 569         return DMA_BIT_MASK(32);
 570 }
 571
 572 /*
 573  * Set both the DMA mask and the coherent DMA mask to the same thing.
 574  * Note that we don't check the return value from dma_set_coherent_mask()
 575  * as the DMA API guarantees that the coherent DMA mask can be set to
 576  * the same or smaller than the streaming DMA mask.
 577  */
 578 static inline int dma_set_mask_and_coherent(struct device *dev, u64 mask)
 579 {
 580         int rc = dma_set_mask(dev, mask);
 581         if (rc == 0)
 582                 dma_set_coherent_mask(dev, mask);
 583         return rc;
 584 }
 585
 586 /*
 587  * Similar to the above, except it deals with the case where the device
 588  * does not have dev->dma_mask appropriately setup.
 589  */
 590 static inline int dma_coerce_mask_and_coherent(struct device *dev, u64 mask)
 591 {
 592         dev->dma_mask = &dev->coherent_dma_mask;
 593         return dma_set_mask_and_coherent(dev, mask);
 594 }
 595
 596 extern u64 dma_get_required_mask(struct device *dev);
 597
 598 #ifndef arch_setup_dma_ops
 599 static inline void arch_setup_dma_ops(struct device *dev, u64 dma_base,
 600                                       u64 size, const struct iommu_ops *iommu,
 601                                       bool coherent) { }
 602 #endif
 603
 604 #ifndef arch_teardown_dma_ops
 605 static inline void arch_teardown_dma_ops(struct device *dev) { }
 606 #endif
 607
 608 static inline unsigned int dma_get_max_seg_size(struct device *dev)
 609 {
 610         if (dev->dma_parms && dev->dma_parms->max_segment_size)
 611                 return dev->dma_parms->max_segment_size;
 612         return SZ_64K;
 613 }
 614
 615 static inline int dma_set_max_seg_size(struct device *dev, unsigned int size)
 616 {
 617         if (dev->dma_parms) {
 618                 dev->dma_parms->max_segment_size = size;
 619                 return 0;
 620         }
 621         return -EIO;
 622 }
 623
 624 static inline unsigned long dma_get_seg_boundary(struct device *dev)
 625 {
 626         if (dev->dma_parms && dev->dma_parms->segment_boundary_mask)
 627                 return dev->dma_parms->segment_boundary_mask;
 628         return DMA_BIT_MASK(32);
 629 }
 630
 631 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
 632 {
 633         if (dev->dma_parms) {
 634                 dev->dma_parms->segment_boundary_mask = mask;
 635                 return 0;
 636         }
 637         return -EIO;
 638 }
 639
 640 #ifndef dma_max_pfn
 641 static inline unsigned long dma_max_pfn(struct device *dev)
 642 {
 643         return (*dev->dma_mask >> PAGE_SHIFT) + dev->dma_pfn_offset;
 644 }
 645 #endif
 646
 647 /*
 648  * Please always use dma_alloc_coherent instead as it already zeroes the memory!
 649  */
 650 static inline void *dma_zalloc_coherent(struct device *dev, size_t size,
 651                                         dma_addr_t *dma_handle, gfp_t flag)
 652 {
 653         return dma_alloc_coherent(dev, size, dma_handle, flag);
 654 }
 655
 656 static inline int dma_get_cache_alignment(void)
 657 {
 658 #ifdef ARCH_DMA_MINALIGN
 659         return ARCH_DMA_MINALIGN;
 660 #endif
 661         return 1;
 662 }
 663
 664 /* flags for the coherent memory api */
 665 #define DMA_MEMORY_EXCLUSIVE            0x01
 666
 667 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
 668 int dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 669                                 dma_addr_t device_addr, size_t size, int flags);
 670 void dma_release_declared_memory(struct device *dev);
 671 void *dma_mark_declared_memory_occupied(struct device *dev,
 672                                         dma_addr_t device_addr, size_t size);
 673 #else
 674 static inline int
 675 dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
 676                             dma_addr_t device_addr, size_t size, int flags)
 677 {
 678         return -ENOSYS;
 679 }
 680
 681 static inline void
 682 dma_release_declared_memory(struct device *dev)
 683 {
 684 }
 685
 686 static inline void *
 687 dma_mark_declared_memory_occupied(struct device *dev,
 688                                   dma_addr_t device_addr, size_t size)
 689 {
 690         return ERR_PTR(-EBUSY);
 691 }
 692 #endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 693
 694 /*
 695  * Managed DMA API
 696  */
 697 #ifdef CONFIG_HAS_DMA
 698 extern void *dmam_alloc_coherent(struct device *dev, size_t size,
 699                                  dma_addr_t *dma_handle, gfp_t gfp);
 700 extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
 701                                dma_addr_t dma_handle);
 702 #else /* !CONFIG_HAS_DMA */
 703 static inline void *dmam_alloc_coherent(struct device *dev, size_t size,
 704                                         dma_addr_t *dma_handle, gfp_t gfp)
 705 { return NULL; }
 706 static inline void dmam_free_coherent(struct device *dev, size_t size,
 707                                       void *vaddr, dma_addr_t dma_handle) { }
 708 #endif /* !CONFIG_HAS_DMA */
 709
 710 extern void *dmam_alloc_attrs(struct device *dev, size_t size,
 711                               dma_addr_t *dma_handle, gfp_t gfp,
 712                               unsigned long attrs);
 713 #ifdef CONFIG_HAVE_GENERIC_DMA_COHERENT
 714 extern int dmam_declare_coherent_memory(struct device *dev,
 715                                         phys_addr_t phys_addr,
 716                                         dma_addr_t device_addr, size_t size,
 717                                         int flags);
 718 extern void dmam_release_declared_memory(struct device *dev);
 719 #else /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 720 static inline int dmam_declare_coherent_memory(struct device *dev,
 721                                 phys_addr_t phys_addr, dma_addr_t device_addr,
 722                                 size_t size, gfp_t gfp)
 723 {
 724         return 0;
 725 }
 726
 727 static inline void dmam_release_declared_memory(struct device *dev)
 728 {
 729 }
 730 #endif /* CONFIG_HAVE_GENERIC_DMA_COHERENT */
 731
 732 static inline void *dma_alloc_wc(struct device *dev, size_t size,
 733                                  dma_addr_t *dma_addr, gfp_t gfp)
 734 {
 735         unsigned long attrs = DMA_ATTR_NO_WARN;
 736
 737         if (gfp & __GFP_NOWARN)
 738                 attrs |= DMA_ATTR_NO_WARN;
 739
 740         return dma_alloc_attrs(dev, size, dma_addr, gfp, attrs);
 741 }
 742 #ifndef dma_alloc_writecombine
 743 #define dma_alloc_writecombine dma_alloc_wc
 744 #endif
 745
 746 static inline void dma_free_wc(struct device *dev, size_t size,
 747                                void *cpu_addr, dma_addr_t dma_addr)
 748 {
 749         return dma_free_attrs(dev, size, cpu_addr, dma_addr,
 750                               DMA_ATTR_WRITE_COMBINE);
 751 }
 752 #ifndef dma_free_writecombine
 753 #define dma_free_writecombine dma_free_wc
 754 #endif
 755
 756 static inline int dma_mmap_wc(struct device *dev,
 757                               struct vm_area_struct *vma,
 758                               void *cpu_addr, dma_addr_t dma_addr,
 759                               size_t size)
 760 {
 761         return dma_mmap_attrs(dev, vma, cpu_addr, dma_addr, size,
 762                               DMA_ATTR_WRITE_COMBINE);
 763 }
 764 #ifndef dma_mmap_writecombine
 765 #define dma_mmap_writecombine dma_mmap_wc
 766 #endif
 767
 768 #ifdef CONFIG_NEED_DMA_MAP_STATE
 769 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)        dma_addr_t ADDR_NAME
 770 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)          __u32 LEN_NAME
 771 #define dma_unmap_addr(PTR, ADDR_NAME)           ((PTR)->ADDR_NAME)
 772 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  (((PTR)->ADDR_NAME) = (VAL))
 773 #define dma_unmap_len(PTR, LEN_NAME)             ((PTR)->LEN_NAME)
 774 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    (((PTR)->LEN_NAME) = (VAL))
 775 #else
 776 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
 777 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
 778 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
 779 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
 780 #define dma_unmap_len(PTR, LEN_NAME)             (0)
 781 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
 782 #endif
 783
 784 #endif