include/linux/swiotlb.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LINUX_SWIOTLB_H
   3 #define __LINUX_SWIOTLB_H
   4
   5 #include <linux/dma-direction.h>
   6 #include <linux/init.h>
   7 #include <linux/types.h>
   8
   9 struct device;
  10 struct page;
  11 struct scatterlist;
  12
  13 enum swiotlb_force {
  14         SWIOTLB_NORMAL,         /* Default - depending on HW DMA mask etc. */
  15         SWIOTLB_FORCE,          /* swiotlb=force */
  16         SWIOTLB_NO_FORCE,       /* swiotlb=noforce */
  17 };
  18
  19 extern enum swiotlb_force swiotlb_force;
  20
  21 /*
  22  * Maximum allowable number of contiguous slabs to map,
  23  * must be a power of 2.  What is the appropriate value ?
  24  * The complexity of {map,unmap}_single is linearly dependent on this value.
  25  */
  26 #define IO_TLB_SEGSIZE  128
  27
  28 /*
  29  * log of the size of each IO TLB slab.  The number of slabs is command line
  30  * controllable.
  31  */
  32 #define IO_TLB_SHIFT 11
  33
  34 extern void swiotlb_init(int verbose);
  35 int swiotlb_init_with_tbl(char *tlb, unsigned long nslabs, int verbose);
  36 extern unsigned long swiotlb_nr_tbl(void);
  37 unsigned long swiotlb_size_or_default(void);
  38 extern int swiotlb_late_init_with_tbl(char *tlb, unsigned long nslabs);
  39 extern void __init swiotlb_update_mem_attributes(void);
  40
  41 /*
  42  * Enumeration for sync targets
  43  */
  44 enum dma_sync_target {
  45         SYNC_FOR_CPU = 0,
  46         SYNC_FOR_DEVICE = 1,
  47 };
  48
  49 /* define the last possible byte of physical address space as a mapping error */
  50 #define SWIOTLB_MAP_ERROR (~(phys_addr_t)0x0)
  51
  52 extern phys_addr_t swiotlb_tbl_map_single(struct device *hwdev,
  53                                           dma_addr_t tbl_dma_addr,
  54                                           phys_addr_t phys, size_t size,
  55                                           enum dma_data_direction dir,
  56                                           unsigned long attrs);
  57
  58 extern void swiotlb_tbl_unmap_single(struct device *hwdev,
  59                                      phys_addr_t tlb_addr,
  60                                      size_t size, enum dma_data_direction dir,
  61                                      unsigned long attrs);
  62
  63 extern void swiotlb_tbl_sync_single(struct device *hwdev,
  64                                     phys_addr_t tlb_addr,
  65                                     size_t size, enum dma_data_direction dir,
  66                                     enum dma_sync_target target);
  67
  68 /* Accessory functions. */
  69
  70 void *swiotlb_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle,
  71                 gfp_t flags, unsigned long attrs);
  72 void swiotlb_free(struct device *dev, size_t size, void *vaddr,
  73                 dma_addr_t dma_addr, unsigned long attrs);
  74
  75 extern void
  76 *swiotlb_alloc_coherent(struct device *hwdev, size_t size,
  77                         dma_addr_t *dma_handle, gfp_t flags);
  78
  79 extern void
  80 swiotlb_free_coherent(struct device *hwdev, size_t size,
  81                       void *vaddr, dma_addr_t dma_handle);
  82
  83 extern dma_addr_t swiotlb_map_page(struct device *dev, struct page *page,
  84                                    unsigned long offset, size_t size,
  85                                    enum dma_data_direction dir,
  86                                    unsigned long attrs);
  87 extern void swiotlb_unmap_page(struct device *hwdev, dma_addr_t dev_addr,
  88                                size_t size, enum dma_data_direction dir,
  89                                unsigned long attrs);
  90
  91 extern int
  92 swiotlb_map_sg_attrs(struct device *hwdev, struct scatterlist *sgl, int nelems,
  93                      enum dma_data_direction dir,
  94                      unsigned long attrs);
  95
  96 extern void
  97 swiotlb_unmap_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
  98                        int nelems, enum dma_data_direction dir,
  99                        unsigned long attrs);
 100
 101 extern void
 102 swiotlb_sync_single_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
 103                             size_t size, enum dma_data_direction dir);
 104
 105 extern void
 106 swiotlb_sync_sg_for_cpu(struct device *hwdev, struct scatterlist *sg,
 107                         int nelems, enum dma_data_direction dir);
 108
 109 extern void
 110 swiotlb_sync_single_for_device(struct device *hwdev, dma_addr_t dev_addr,
 111                                size_t size, enum dma_data_direction dir);
 112
 113 extern void
 114 swiotlb_sync_sg_for_device(struct device *hwdev, struct scatterlist *sg,
 115                            int nelems, enum dma_data_direction dir);
 116
 117 extern int
 118 swiotlb_dma_mapping_error(struct device *hwdev, dma_addr_t dma_addr);
 119
 120 extern int
 121 swiotlb_dma_supported(struct device *hwdev, u64 mask);
 122
 123 #ifdef CONFIG_SWIOTLB
 124 extern void __init swiotlb_exit(void);
 125 unsigned int swiotlb_max_segment(void);
 126 #else
 127 static inline void swiotlb_exit(void) { }
 128 static inline unsigned int swiotlb_max_segment(void) { return 0; }
 129 #endif
 130
 131 extern void swiotlb_print_info(void);
 132 extern int is_swiotlb_buffer(phys_addr_t paddr);
 133 extern void swiotlb_set_max_segment(unsigned int);
 134
 135 extern const struct dma_map_ops swiotlb_dma_ops;
 136
 137 #endif /* __LINUX_SWIOTLB_H */