iova.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2006, Intel Corporation.
  4. *
  5. * Copyright (C) 2006-2008 Intel Corporation
  6. * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
  7. */
  8. #ifndef _IOVA_H_
  9. #define _IOVA_H_
  10. #include <linux/types.h>
  11. #include <linux/kernel.h>
  12. #include <linux/rbtree.h>
  13. #include <linux/atomic.h>
  14. #include <linux/dma-mapping.h>
  15. /* iova structure */
  16. struct iova {
  17. struct rb_node node;
  18. unsigned long pfn_hi; /* Highest allocated pfn */
  19. unsigned long pfn_lo; /* Lowest allocated pfn */
  20. };
  21. struct iova_magazine;
  22. struct iova_cpu_rcache;
  23. #define IOVA_RANGE_CACHE_MAX_SIZE 6 /* log of max cached IOVA range size (in pages) */
  24. #define MAX_GLOBAL_MAGS 32 /* magazines per bin */
  25. struct iova_rcache {
  26. spinlock_t lock;
  27. unsigned long depot_size;
  28. struct iova_magazine *depot[MAX_GLOBAL_MAGS];
  29. struct iova_cpu_rcache __percpu *cpu_rcaches;
  30. };
  31. struct iova_domain;
  32. /* Call-Back from IOVA code into IOMMU drivers */
  33. typedef void (* iova_flush_cb)(struct iova_domain *domain);
  34. /* Destructor for per-entry data */
  35. typedef void (* iova_entry_dtor)(unsigned long data);
  36. /* Number of entries per Flush Queue */
  37. #define IOVA_FQ_SIZE 256
  38. /* Timeout (in ms) after which entries are flushed from the Flush-Queue */
  39. #define IOVA_FQ_TIMEOUT 10
  40. /* Flush Queue entry for defered flushing */
  41. struct iova_fq_entry {
  42. unsigned long iova_pfn;
  43. unsigned long pages;
  44. unsigned long data;
  45. u64 counter; /* Flush counter when this entrie was added */
  46. };
  47. /* Per-CPU Flush Queue structure */
  48. struct iova_fq {
  49. struct iova_fq_entry entries[IOVA_FQ_SIZE];
  50. unsigned head, tail;
  51. spinlock_t lock;
  52. };
  53. /* holds all the iova translations for a domain */
  54. struct iova_domain {
  55. spinlock_t iova_rbtree_lock; /* Lock to protect update of rbtree */
  56. struct rb_root rbroot; /* iova domain rbtree root */
  57. struct rb_node *cached_node; /* Save last alloced node */
  58. struct rb_node *cached32_node; /* Save last 32-bit alloced node */
  59. unsigned long granule; /* pfn granularity for this domain */
  60. unsigned long start_pfn; /* Lower limit for this domain */
  61. unsigned long dma_32bit_pfn;
  62. unsigned long max32_alloc_size; /* Size of last failed allocation */
  63. struct iova_fq __percpu *fq; /* Flush Queue */
  64. atomic64_t fq_flush_start_cnt; /* Number of TLB flushes that
  65. have been started */
  66. atomic64_t fq_flush_finish_cnt; /* Number of TLB flushes that
  67. have been finished */
  68. struct iova anchor; /* rbtree lookup anchor */
  69. struct iova_rcache rcaches[IOVA_RANGE_CACHE_MAX_SIZE]; /* IOVA range caches */
  70. iova_flush_cb flush_cb; /* Call-Back function to flush IOMMU
  71. TLBs */
  72. iova_entry_dtor entry_dtor; /* IOMMU driver specific destructor for
  73. iova entry */
  74. struct timer_list fq_timer; /* Timer to regularily empty the
  75. flush-queues */
  76. atomic_t fq_timer_on; /* 1 when timer is active, 0
  77. when not */
  78. bool best_fit;
  79. };
  80. static inline unsigned long iova_size(struct iova *iova)
  81. {
  82. return iova->pfn_hi - iova->pfn_lo + 1;
  83. }
  84. static inline unsigned long iova_shift(struct iova_domain *iovad)
  85. {
  86. return __ffs(iovad->granule);
  87. }
  88. static inline unsigned long iova_mask(struct iova_domain *iovad)
  89. {
  90. return iovad->granule - 1;
  91. }
  92. static inline size_t iova_offset(struct iova_domain *iovad, dma_addr_t iova)
  93. {
  94. return iova & iova_mask(iovad);
  95. }
  96. static inline size_t iova_align(struct iova_domain *iovad, size_t size)
  97. {
  98. return ALIGN(size, iovad->granule);
  99. }
  100. static inline dma_addr_t iova_dma_addr(struct iova_domain *iovad, struct iova *iova)
  101. {
  102. return (dma_addr_t)iova->pfn_lo << iova_shift(iovad);
  103. }
  104. static inline unsigned long iova_pfn(struct iova_domain *iovad, dma_addr_t iova)
  105. {
  106. return iova >> iova_shift(iovad);
  107. }
  108. #if IS_ENABLED(CONFIG_IOMMU_IOVA)
  109. int iova_cache_get(void);
  110. void iova_cache_put(void);
  111. struct iova *alloc_iova_mem(void);
  112. void free_iova_mem(struct iova *iova);
  113. void free_iova(struct iova_domain *iovad, unsigned long pfn);
  114. void __free_iova(struct iova_domain *iovad, struct iova *iova);
  115. struct iova *alloc_iova(struct iova_domain *iovad, unsigned long size,
  116. unsigned long limit_pfn,
  117. bool size_aligned);
  118. void free_iova_fast(struct iova_domain *iovad, unsigned long pfn,
  119. unsigned long size);
  120. void queue_iova(struct iova_domain *iovad,
  121. unsigned long pfn, unsigned long pages,
  122. unsigned long data);
  123. unsigned long alloc_iova_fast(struct iova_domain *iovad, unsigned long size,
  124. unsigned long limit_pfn, bool flush_rcache);
  125. struct iova *reserve_iova(struct iova_domain *iovad, unsigned long pfn_lo,
  126. unsigned long pfn_hi);
  127. void copy_reserved_iova(struct iova_domain *from, struct iova_domain *to);
  128. void init_iova_domain(struct iova_domain *iovad, unsigned long granule,
  129. unsigned long start_pfn);
  130. bool has_iova_flush_queue(struct iova_domain *iovad);
  131. int init_iova_flush_queue(struct iova_domain *iovad,
  132. iova_flush_cb flush_cb, iova_entry_dtor entry_dtor);
  133. struct iova *find_iova(struct iova_domain *iovad, unsigned long pfn);
  134. void put_iova_domain(struct iova_domain *iovad);
  135. struct iova *split_and_remove_iova(struct iova_domain *iovad,
  136. struct iova *iova, unsigned long pfn_lo, unsigned long pfn_hi);
  137. void free_cpu_cached_iovas(unsigned int cpu, struct iova_domain *iovad);
  138. void free_global_cached_iovas(struct iova_domain *iovad);
  139. #else
  140. static inline int iova_cache_get(void)
  141. {
  142. return -ENOTSUPP;
  143. }
  144. static inline void iova_cache_put(void)
  145. {
  146. }
  147. static inline struct iova *alloc_iova_mem(void)
  148. {
  149. return NULL;
  150. }
  151. static inline void free_iova_mem(struct iova *iova)
  152. {
  153. }
  154. static inline void free_iova(struct iova_domain *iovad, unsigned long pfn)
  155. {
  156. }
  157. static inline void __free_iova(struct iova_domain *iovad, struct iova *iova)
  158. {
  159. }
  160. static inline struct iova *alloc_iova(struct iova_domain *iovad,
  161. unsigned long size,
  162. unsigned long limit_pfn,
  163. bool size_aligned)
  164. {
  165. return NULL;
  166. }
  167. static inline void free_iova_fast(struct iova_domain *iovad,
  168. unsigned long pfn,
  169. unsigned long size)
  170. {
  171. }
  172. static inline void queue_iova(struct iova_domain *iovad,
  173. unsigned long pfn, unsigned long pages,
  174. unsigned long data)
  175. {
  176. }
  177. static inline unsigned long alloc_iova_fast(struct iova_domain *iovad,
  178. unsigned long size,
  179. unsigned long limit_pfn,
  180. bool flush_rcache)
  181. {
  182. return 0;
  183. }
  184. static inline struct iova *reserve_iova(struct iova_domain *iovad,
  185. unsigned long pfn_lo,
  186. unsigned long pfn_hi)
  187. {
  188. return NULL;
  189. }
  190. static inline void copy_reserved_iova(struct iova_domain *from,
  191. struct iova_domain *to)
  192. {
  193. }
  194. static inline void init_iova_domain(struct iova_domain *iovad,
  195. unsigned long granule,
  196. unsigned long start_pfn)
  197. {
  198. }
  199. static inline bool has_iova_flush_queue(struct iova_domain *iovad)
  200. {
  201. return false;
  202. }
  203. static inline int init_iova_flush_queue(struct iova_domain *iovad,
  204. iova_flush_cb flush_cb,
  205. iova_entry_dtor entry_dtor)
  206. {
  207. return -ENODEV;
  208. }
  209. static inline struct iova *find_iova(struct iova_domain *iovad,
  210. unsigned long pfn)
  211. {
  212. return NULL;
  213. }
  214. static inline void put_iova_domain(struct iova_domain *iovad)
  215. {
  216. }
  217. static inline struct iova *split_and_remove_iova(struct iova_domain *iovad,
  218. struct iova *iova,
  219. unsigned long pfn_lo,
  220. unsigned long pfn_hi)
  221. {
  222. return NULL;
  223. }
  224. static inline void free_cpu_cached_iovas(unsigned int cpu,
  225. struct iova_domain *iovad)
  226. {
  227. }
  228. static inline void free_global_cached_iovas(struct iova_domain *iovad)
  229. {
  230. }
  231. #endif
  232. #endif