include/linux/io-pgtable.h

   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_TLBI_ON_MAP: If the format forbids caching invalid
  73          *      (unmapped) entries but the hardware might do so anyway, perform
  74          *      TLB maintenance when mapping as well as when unmapping.
  75          *
  76          * IO_PGTABLE_QUIRK_ARM_MTK_EXT: (ARM v7s format) MediaTek IOMMUs extend
  77          *      to support up to 34 bits PA where the bit32 and bit33 are
  78          *      encoded in the bit9 and bit4 of the PTE respectively.
  79          *
  80          * IO_PGTABLE_QUIRK_NON_STRICT: Skip issuing synchronous leaf TLBIs
  81          *      on unmap, for DMA domains using the flush queue mechanism for
  82          *      delayed invalidation.
  83          *
  84          * IO_PGTABLE_QUIRK_ARM_TTBR1: (ARM LPAE format) Configure the table
  85          *      for use in the upper half of a split address space.
  86          *
  87          * IO_PGTABLE_QUIRK_ARM_OUTER_WBWA: Override the outer-cacheability
  88          *      attributes set in the TCR for a non-coherent page-table walker.
  89          */
  90         #define IO_PGTABLE_QUIRK_ARM_NS         BIT(0)
  91         #define IO_PGTABLE_QUIRK_NO_PERMS       BIT(1)
  92         #define IO_PGTABLE_QUIRK_TLBI_ON_MAP    BIT(2)
  93         #define IO_PGTABLE_QUIRK_ARM_MTK_EXT    BIT(3)
  94         #define IO_PGTABLE_QUIRK_NON_STRICT     BIT(4)
  95         #define IO_PGTABLE_QUIRK_ARM_TTBR1      BIT(5)
  96         #define IO_PGTABLE_QUIRK_ARM_OUTER_WBWA BIT(6)
  97         unsigned long                   quirks;
  98         unsigned long                   pgsize_bitmap;
  99         unsigned int                    ias;
 100         unsigned int                    oas;
 101         bool                            coherent_walk;
 102         const struct iommu_flush_ops    *tlb;
 103         struct device                   *iommu_dev;
 104
 105         /* Low-level data specific to the table format */
 106         union {
 107                 struct {
 108                         u64     ttbr;
 109                         struct {
 110                                 u32     ips:3;
 111                                 u32     tg:2;
 112                                 u32     sh:2;
 113                                 u32     orgn:2;
 114                                 u32     irgn:2;
 115                                 u32     tsz:6;
 116                         }       tcr;
 117                         u64     mair;
 118                 } arm_lpae_s1_cfg;
 119
 120                 struct {
 121                         u64     vttbr;
 122                         struct {
 123                                 u32     ps:3;
 124                                 u32     tg:2;
 125                                 u32     sh:2;
 126                                 u32     orgn:2;
 127                                 u32     irgn:2;
 128                                 u32     sl:2;
 129                                 u32     tsz:6;
 130                         }       vtcr;
 131                 } arm_lpae_s2_cfg;
 132
 133                 struct {
 134                         u32     ttbr;
 135                         u32     tcr;
 136                         u32     nmrr;
 137                         u32     prrr;
 138                 } arm_v7s_cfg;
 139
 140                 struct {
 141                         u64     transtab;
 142                         u64     memattr;
 143                 } arm_mali_lpae_cfg;
 144         };
 145 };
 146
 147 /**
 148  * struct io_pgtable_ops - Page table manipulation API for IOMMU drivers.
 149  *
 150  * @map:          Map a physically contiguous memory region.
 151  * @unmap:        Unmap a physically contiguous memory region.
 152  * @iova_to_phys: Translate iova to physical address.
 153  *
 154  * These functions map directly onto the iommu_ops member functions with
 155  * the same names.
 156  */
 157 struct io_pgtable_ops {
 158         int (*map)(struct io_pgtable_ops *ops, unsigned long iova,
 159                    phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
 160         size_t (*unmap)(struct io_pgtable_ops *ops, unsigned long iova,
 161                         size_t size, struct iommu_iotlb_gather *gather);
 162         phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops,
 163                                     unsigned long iova);
 164 };
 165
 166 /**
 167  * alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU.
 168  *
 169  * @fmt:    The page table format.
 170  * @cfg:    The page table configuration. This will be modified to represent
 171  *          the configuration actually provided by the allocator (e.g. the
 172  *          pgsize_bitmap may be restricted).
 173  * @cookie: An opaque token provided by the IOMMU driver and passed back to
 174  *          the callback routines in cfg->tlb.
 175  */
 176 struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
 177                                             struct io_pgtable_cfg *cfg,
 178                                             void *cookie);
 179
 180 /**
 181  * free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller
 182  *                         *must* ensure that the page table is no longer
 183  *                         live, but the TLB can be dirty.
 184  *
 185  * @ops: The ops returned from alloc_io_pgtable_ops.
 186  */
 187 void free_io_pgtable_ops(struct io_pgtable_ops *ops);
 188
 189
 190 /*
 191  * Internal structures for page table allocator implementations.
 192  */
 193
 194 /**
 195  * struct io_pgtable - Internal structure describing a set of page tables.
 196  *
 197  * @fmt:    The page table format.
 198  * @cookie: An opaque token provided by the IOMMU driver and passed back to
 199  *          any callback routines.
 200  * @cfg:    A copy of the page table configuration.
 201  * @ops:    The page table operations in use for this set of page tables.
 202  */
 203 struct io_pgtable {
 204         enum io_pgtable_fmt     fmt;
 205         void                    *cookie;
 206         struct io_pgtable_cfg   cfg;
 207         struct io_pgtable_ops   ops;
 208 };
 209
 210 #define io_pgtable_ops_to_pgtable(x) container_of((x), struct io_pgtable, ops)
 211
 212 struct io_pgtable_domain_attr {
 213         unsigned long quirks;
 214 };
 215
 216 static inline void io_pgtable_tlb_flush_all(struct io_pgtable *iop)
 217 {
 218         iop->cfg.tlb->tlb_flush_all(iop->cookie);
 219 }
 220
 221 static inline void
 222 io_pgtable_tlb_flush_walk(struct io_pgtable *iop, unsigned long iova,
 223                           size_t size, size_t granule)
 224 {
 225         iop->cfg.tlb->tlb_flush_walk(iova, size, granule, iop->cookie);
 226 }
 227
 228 static inline void
 229 io_pgtable_tlb_add_page(struct io_pgtable *iop,
 230                         struct iommu_iotlb_gather * gather, unsigned long iova,
 231                         size_t granule)
 232 {
 233         if (iop->cfg.tlb->tlb_add_page)
 234                 iop->cfg.tlb->tlb_add_page(gather, iova, granule, iop->cookie);
 235 }
 236
 237 /**
 238  * struct io_pgtable_init_fns - Alloc/free a set of page tables for a
 239  *                              particular format.
 240  *
 241  * @alloc: Allocate a set of page tables described by cfg.
 242  * @free:  Free the page tables associated with iop.
 243  */
 244 struct io_pgtable_init_fns {
 245         struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie);
 246         void (*free)(struct io_pgtable *iop);
 247 };
 248
 249 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s1_init_fns;
 250 extern struct io_pgtable_init_fns io_pgtable_arm_32_lpae_s2_init_fns;
 251 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s1_init_fns;
 252 extern struct io_pgtable_init_fns io_pgtable_arm_64_lpae_s2_init_fns;
 253 extern struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns;
 254 extern struct io_pgtable_init_fns io_pgtable_arm_mali_lpae_init_fns;
 255 extern struct io_pgtable_init_fns io_pgtable_amd_iommu_v1_init_fns;
 256
 257 #endif /* __IO_PGTABLE_H */