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