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