include/linux/dma-mapping.h

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