1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __IO_PGTABLE_H 3 #define __IO_PGTABLE_H 4 5 #include <linux/bitops.h> 6 #include <linux/iommu.h> 7 8 /* 9 * Public API for use by IOMMU drivers 10 */ 11 enum io_pgtable_fmt { 12 ARM_32_LPAE_S1, 13 ARM_32_LPAE_S2, 14 ARM_64_LPAE_S1, 15 ARM_64_LPAE_S2, 16 ARM_V7S, 17 ARM_MALI_LPAE, 18 IO_PGTABLE_NUM_FMTS, 19 }; 20 21 /** 22 * struct iommu_flush_ops - IOMMU callbacks for TLB and page table management. 23 * 24 * @tlb_flush_all: Synchronously invalidate the entire TLB context. 25 * @tlb_flush_walk: Synchronously invalidate all intermediate TLB state 26 * (sometimes referred to as the "walk cache") for a virtual 27 * address range. 28 * @tlb_flush_leaf: Synchronously invalidate all leaf TLB state for a virtual 29 * address range. 30 * @tlb_add_page: Optional callback to queue up leaf TLB invalidation for a 31 * single page. IOMMUs that cannot batch TLB invalidation 32 * operations efficiently will typically issue them here, but 33 * others may decide to update the iommu_iotlb_gather structure 34 * and defer the invalidation until iommu_iotlb_sync() instead. 35 * 36 * Note that these can all be called in atomic context and must therefore 37 * not block. 38 */ 39 struct iommu_flush_ops { 40 void (*tlb_flush_all)(void *cookie); 41 void (*tlb_flush_walk)(unsigned long iova, size_t size, size_t granule, 42 void *cookie); 43 void (*tlb_flush_leaf)(unsigned long iova, size_t size, size_t granule, 44 void *cookie); 45 void (*tlb_add_page)(struct iommu_iotlb_gather *gather, 46 unsigned long iova, size_t granule, void *cookie); 47 }; 48 49 /** 50 * struct io_pgtable_cfg - Configuration data for a set of page tables. 51 * 52 * @quirks: A bitmap of hardware quirks that require some special 53 * action by the low-level page table allocator. 54 * @pgsize_bitmap: A bitmap of page sizes supported by this set of page 55 * tables. 56 * @ias: Input address (iova) size, in bits. 57 * @oas: Output address (paddr) size, in bits. 58 * @coherent_walk A flag to indicate whether or not page table walks made 59 * by the IOMMU are coherent with the CPU caches. 60 * @tlb: TLB management callbacks for this set of tables. 61 * @iommu_dev: The device representing the DMA configuration for the 62 * page table walker. 63 */ 64 struct io_pgtable_cfg { 65 /* 66 * IO_PGTABLE_QUIRK_ARM_NS: (ARM formats) Set NS and NSTABLE bits in 67 * stage 1 PTEs, for hardware which insists on validating them 68 * even in non-secure state where they should normally be ignored. 69 * 70 * IO_PGTABLE_QUIRK_NO_PERMS: Ignore the IOMMU_READ, IOMMU_WRITE and 71 * IOMMU_NOEXEC flags and map everything with full access, for 72 * hardware which does not implement the permissions of a given 73 * format, and/or requires some format-specific default value. 74 * 75 * IO_PGTABLE_QUIRK_TLBI_ON_MAP: If the format forbids caching invalid 76 * (unmapped) entries but the hardware might do so anyway, perform 77 * TLB maintenance when mapping as well as when unmapping. 78 * 79 * IO_PGTABLE_QUIRK_ARM_MTK_EXT: (ARM v7s format) MediaTek IOMMUs extend 80 * to support up to 34 bits PA where the bit32 and bit33 are 81 * encoded in the bit9 and bit4 of the PTE respectively. 82 * 83 * IO_PGTABLE_QUIRK_NON_STRICT: Skip issuing synchronous leaf TLBIs 84 * on unmap, for DMA domains using the flush queue mechanism for 85 * delayed invalidation. 86 * 87 * IO_PGTABLE_QUIRK_ARM_TTBR1: (ARM LPAE format) Configure the table 88 * for use in the upper half of a split address space. 89 * 90 * IO_PGTABLE_QUIRK_ARM_OUTER_WBWA: Override the outer-cacheability 91 * attributes set in the TCR for a non-coherent page-table walker. 92 */ 93 #define IO_PGTABLE_QUIRK_ARM_NS BIT(0) 94 #define IO_PGTABLE_QUIRK_NO_PERMS BIT(1) 95 #define IO_PGTABLE_QUIRK_TLBI_ON_MAP BIT(2) 96 #define IO_PGTABLE_QUIRK_ARM_MTK_EXT BIT(3) 97 #define IO_PGTABLE_QUIRK_NON_STRICT BIT(4) 98 #define IO_PGTABLE_QUIRK_ARM_TTBR1 BIT(5) 99 #define IO_PGTABLE_QUIRK_ARM_OUTER_WBWA BIT(6) 100 unsigned long quirks; 101 unsigned long pgsize_bitmap; 102 unsigned int ias; 103 unsigned int oas; 104 bool coherent_walk; 105 const struct iommu_flush_ops *tlb; 106 struct device *iommu_dev; 107 108 /* Low-level data specific to the table format */ 109 union { 110 struct { 111 u64 ttbr; 112 struct { 113 u32 ips:3; 114 u32 tg:2; 115 u32 sh:2; 116 u32 orgn:2; 117 u32 irgn:2; 118 u32 tsz:6; 119 } tcr; 120 u64 mair; 121 } arm_lpae_s1_cfg; 122 123 struct { 124 u64 vttbr; 125 struct { 126 u32 ps:3; 127 u32 tg:2; 128 u32 sh:2; 129 u32 orgn:2; 130 u32 irgn:2; 131 u32 sl:2; 132 u32 tsz:6; 133 } vtcr; 134 } arm_lpae_s2_cfg; 135 136 struct { 137 u32 ttbr; 138 u32 tcr; 139 u32 nmrr; 140 u32 prrr; 141 } arm_v7s_cfg; 142 143 struct { 144 u64 transtab; 145 u64 memattr; 146 } arm_mali_lpae_cfg; 147 }; 148 }; 149 150 /** 151 * struct io_pgtable_ops - Page table manipulation API for IOMMU drivers. 152 * 153 * @map: Map a physically contiguous memory region. 154 * @unmap: Unmap a physically contiguous memory region. 155 * @iova_to_phys: Translate iova to physical address. 156 * 157 * These functions map directly onto the iommu_ops member functions with 158 * the same names. 159 */ 160 struct io_pgtable_ops { 161 int (*map)(struct io_pgtable_ops *ops, unsigned long iova, 162 phys_addr_t paddr, size_t size, int prot, gfp_t gfp); 163 size_t (*unmap)(struct io_pgtable_ops *ops, unsigned long iova, 164 size_t size, struct iommu_iotlb_gather *gather); 165 phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops, 166 unsigned long iova); 167 }; 168 169 /** 170 * alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU. 171 * 172 * @fmt: The page table format. 173 * @cfg: The page table configuration. This will be modified to represent 174 * the configuration actually provided by the allocator (e.g. the 175 * pgsize_bitmap may be restricted). 176 * @cookie: An opaque token provided by the IOMMU driver and passed back to 177 * the callback routines in cfg->tlb. 178 */ 179 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt, 180 struct io_pgtable_cfg *cfg, 181 void *cookie); 182 183 /** 184 * free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller 185 * *must* ensure that the page table is no longer 186 * live, but the TLB can be dirty. 187 * 188 * @ops: The ops returned from alloc_io_pgtable_ops. 189 */ 190 void free_io_pgtable_ops(struct io_pgtable_ops *ops); 191 192 193 /* 194 * Internal structures for page table allocator implementations. 195 */ 196 197 /** 198 * struct io_pgtable - Internal structure describing a set of page tables. 199 * 200 * @fmt: The page table format. 201 * @cookie: An opaque token provided by the IOMMU driver and passed back to 202 * any callback routines. 203 * @cfg: A copy of the page table configuration. 204 * @ops: The page table operations in use for this set of page tables. 205 */ 206 struct io_pgtable { 207 enum io_pgtable_fmt fmt; 208 void *cookie; 209 struct io_pgtable_cfg cfg; 210 struct io_pgtable_ops ops; 211 }; 212 213 #define io_pgtable_ops_to_pgtable(x) container_of((x), struct io_pgtable, ops) 214 215 struct io_pgtable_domain_attr { 216 unsigned long quirks; 217 }; 218 219 static inline void io_pgtable_tlb_flush_all(struct io_pgtable *iop) 220 { 221 iop->cfg.tlb->tlb_flush_all(iop->cookie); 222 } 223 224 static inline void 225 io_pgtable_tlb_flush_walk(struct io_pgtable *iop, unsigned long iova, 226 size_t size, size_t granule) 227 { 228 iop->cfg.tlb->tlb_flush_walk(iova, size, granule, iop->cookie); 229 } 230 231 static inline void 232 io_pgtable_tlb_flush_leaf(struct io_pgtable *iop, unsigned long iova, 233 size_t size, size_t granule) 234 { 235 iop->cfg.tlb->tlb_flush_leaf(iova, size, granule, iop->cookie); 236 } 237 238 static inline void 239 io_pgtable_tlb_add_page(struct io_pgtable *iop, 240 struct iommu_iotlb_gather * gather, unsigned long iova, 241 size_t granule) 242 { 243 if (iop->cfg.tlb->tlb_add_page) 244 iop->cfg.tlb->tlb_add_page(gather, iova, granule, iop->cookie); 245 } 246 247 /** 248 * struct io_pgtable_init_fns - Alloc/free a set of page tables for a 249 * particular format. 250 * 251 * @alloc: Allocate a set of page tables described by cfg. 252 * @free: Free the page tables associated with iop. 253 */ 254 struct io_pgtable_init_fns { 255 struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie); 256 void (*free)(struct io_pgtable *iop); 257 }; 258 259 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns; 260 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns; 261 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns; 262 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns; 263 extern struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns; 264 extern struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns; 265 266 #endif /* __IO_PGTABLE_H */ 267