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/device.h>
   6 #include <linux/dma-direction.h>
   7 #include <linux/init.h>
   8 #include <linux/types.h>
   9 #include <linux/limits.h>
  10 #include <linux/spinlock.h>
  11
  12 struct device;
  13 struct page;
  14 struct scatterlist;
  15
  16 #define SWIOTLB_VERBOSE (1 << 0) /* verbose initialization */
  17 #define SWIOTLB_FORCE   (1 << 1) /* force bounce buffering */
  18 #define SWIOTLB_ANY     (1 << 2) /* allow any memory for the buffer */
  19
  20 /*
  21  * Maximum allowable number of contiguous slabs to map,
  22  * must be a power of 2.  What is the appropriate value ?
  23  * The complexity of {map,unmap}_single is linearly dependent on this value.
  24  */
  25 #define IO_TLB_SEGSIZE  128
  26
  27 /*
  28  * log of the size of each IO TLB slab.  The number of slabs is command line
  29  * controllable.
  30  */
  31 #define IO_TLB_SHIFT 11
  32 #define IO_TLB_SIZE (1 << IO_TLB_SHIFT)
  33
  34 /* default to 64MB */
  35 #define IO_TLB_DEFAULT_SIZE (64UL<<20)
  36
  37 unsigned long swiotlb_size_or_default(void);
  38 void __init swiotlb_init_remap(bool addressing_limit, unsigned int flags,
  39         int (*remap)(void *tlb, unsigned long nslabs));
  40 int swiotlb_init_late(size_t size, gfp_t gfp_mask,
  41         int (*remap)(void *tlb, unsigned long nslabs));
  42 extern void __init swiotlb_update_mem_attributes(void);
  43
  44 phys_addr_t swiotlb_tbl_map_single(struct device *hwdev, phys_addr_t phys,
  45                 size_t mapping_size, size_t alloc_size,
  46                 unsigned int alloc_aligned_mask, enum dma_data_direction dir,
  47                 unsigned long attrs);
  48
  49 extern void swiotlb_tbl_unmap_single(struct device *hwdev,
  50                                      phys_addr_t tlb_addr,
  51                                      size_t mapping_size,
  52                                      enum dma_data_direction dir,
  53                                      unsigned long attrs);
  54
  55 void swiotlb_sync_single_for_device(struct device *dev, phys_addr_t tlb_addr,
  56                 size_t size, enum dma_data_direction dir);
  57 void swiotlb_sync_single_for_cpu(struct device *dev, phys_addr_t tlb_addr,
  58                 size_t size, enum dma_data_direction dir);
  59 dma_addr_t swiotlb_map(struct device *dev, phys_addr_t phys,
  60                 size_t size, enum dma_data_direction dir, unsigned long attrs);
  61
  62 #ifdef CONFIG_SWIOTLB
  63
  64 /**
  65  * struct io_tlb_mem - IO TLB Memory Pool Descriptor
  66  *
  67  * @start:      The start address of the swiotlb memory pool. Used to do a quick
  68  *              range check to see if the memory was in fact allocated by this
  69  *              API.
  70  * @end:        The end address of the swiotlb memory pool. Used to do a quick
  71  *              range check to see if the memory was in fact allocated by this
  72  *              API.
  73  * @vaddr:      The vaddr of the swiotlb memory pool. The swiotlb memory pool
  74  *              may be remapped in the memory encrypted case and store virtual
  75  *              address for bounce buffer operation.
  76  * @nslabs:     The number of IO TLB blocks (in groups of 64) between @start and
  77  *              @end. For default swiotlb, this is command line adjustable via
  78  *              setup_io_tlb_npages.
  79  * @list:       The free list describing the number of free entries available
  80  *              from each index.
  81  * @orig_addr:  The original address corresponding to a mapped entry.
  82  * @alloc_size: Size of the allocated buffer.
  83  * @debugfs:    The dentry to debugfs.
  84  * @late_alloc: %true if allocated using the page allocator
  85  * @force_bounce: %true if swiotlb bouncing is forced
  86  * @for_alloc:  %true if the pool is used for memory allocation
  87  * @nareas:  The area number in the pool.
  88  * @area_nslabs: The slot number in the area.
  89  * @total_used: The total number of slots in the pool that are currently used
  90  *              across all areas. Used only for calculating used_hiwater in
  91  *              debugfs.
  92  * @used_hiwater: The high water mark for total_used.  Used only for reporting
  93  *              in debugfs.
  94  */
  95 struct io_tlb_mem {
  96         phys_addr_t start;
  97         phys_addr_t end;
  98         void *vaddr;
  99         unsigned long nslabs;
 100         struct dentry *debugfs;
 101         bool late_alloc;
 102         bool force_bounce;
 103         bool for_alloc;
 104         unsigned int nareas;
 105         unsigned int area_nslabs;
 106         struct io_tlb_area *areas;
 107         struct io_tlb_slot *slots;
 108 #ifdef CONFIG_DEBUG_FS
 109         atomic_long_t total_used;
 110         atomic_long_t used_hiwater;
 111 #endif
 112 };
 113 extern struct io_tlb_mem io_tlb_default_mem;
 114
 115 static inline bool is_swiotlb_buffer(struct device *dev, phys_addr_t paddr)
 116 {
 117         struct io_tlb_mem *mem = dev->dma_io_tlb_mem;
 118
 119         return mem && paddr >= mem->start && paddr < mem->end;
 120 }
 121
 122 static inline bool is_swiotlb_force_bounce(struct device *dev)
 123 {
 124         struct io_tlb_mem *mem = dev->dma_io_tlb_mem;
 125
 126         return mem && mem->force_bounce;
 127 }
 128
 129 void swiotlb_init(bool addressing_limited, unsigned int flags);
 130 void __init swiotlb_exit(void);
 131 size_t swiotlb_max_mapping_size(struct device *dev);
 132 bool is_swiotlb_active(struct device *dev);
 133 void __init swiotlb_adjust_size(unsigned long size);
 134 #else
 135 static inline void swiotlb_init(bool addressing_limited, unsigned int flags)
 136 {
 137 }
 138 static inline bool is_swiotlb_buffer(struct device *dev, phys_addr_t paddr)
 139 {
 140         return false;
 141 }
 142 static inline bool is_swiotlb_force_bounce(struct device *dev)
 143 {
 144         return false;
 145 }
 146 static inline void swiotlb_exit(void)
 147 {
 148 }
 149 static inline size_t swiotlb_max_mapping_size(struct device *dev)
 150 {
 151         return SIZE_MAX;
 152 }
 153
 154 static inline bool is_swiotlb_active(struct device *dev)
 155 {
 156         return false;
 157 }
 158
 159 static inline void swiotlb_adjust_size(unsigned long size)
 160 {
 161 }
 162 #endif /* CONFIG_SWIOTLB */
 163
 164 extern void swiotlb_print_info(void);
 165
 166 #ifdef CONFIG_DMA_RESTRICTED_POOL
 167 struct page *swiotlb_alloc(struct device *dev, size_t size);
 168 bool swiotlb_free(struct device *dev, struct page *page, size_t size);
 169
 170 static inline bool is_swiotlb_for_alloc(struct device *dev)
 171 {
 172         return dev->dma_io_tlb_mem->for_alloc;
 173 }
 174 #else
 175 static inline struct page *swiotlb_alloc(struct device *dev, size_t size)
 176 {
 177         return NULL;
 178 }
 179 static inline bool swiotlb_free(struct device *dev, struct page *page,
 180                                 size_t size)
 181 {
 182         return false;
 183 }
 184 static inline bool is_swiotlb_for_alloc(struct device *dev)
 185 {
 186         return false;
 187 }
 188 #endif /* CONFIG_DMA_RESTRICTED_POOL */
 189
 190 #endif /* __LINUX_SWIOTLB_H */