With all current users now opted in to DMA API operations, make the iommu_dev pointer mandatory, rendering the flush_pgtable callback redundant for cache maintenance. However, since the DMA calls could be nops in the case of a coherent IOMMU, we still need to ensure the page table updates are fully synchronised against a subsequent page table walk. In the unmap path, the TLB sync will usually need to do this anyway, so just cement that requirement; in the map path which may consist solely of cacheable memory writes (in the coherent case), insert an appropriate barrier at the end of the operation, and obviate the need to call flush_pgtable on every individual update for synchronisation. Signed-off-by: Robin Murphy <robin.murphy@arm.com> [will: slight clarification to tlb_sync comment] Signed-off-by: Will Deacon <will.deacon@arm.com>
148 lines
4.5 KiB
C
148 lines
4.5 KiB
C
#ifndef __IO_PGTABLE_H
|
|
#define __IO_PGTABLE_H
|
|
|
|
/*
|
|
* Public API for use by IOMMU drivers
|
|
*/
|
|
enum io_pgtable_fmt {
|
|
ARM_32_LPAE_S1,
|
|
ARM_32_LPAE_S2,
|
|
ARM_64_LPAE_S1,
|
|
ARM_64_LPAE_S2,
|
|
IO_PGTABLE_NUM_FMTS,
|
|
};
|
|
|
|
/**
|
|
* struct iommu_gather_ops - IOMMU callbacks for TLB and page table management.
|
|
*
|
|
* @tlb_flush_all: Synchronously invalidate the entire TLB context.
|
|
* @tlb_add_flush: Queue up a TLB invalidation for a virtual address range.
|
|
* @tlb_sync: Ensure any queued TLB invalidation has taken effect, and
|
|
* any corresponding page table updates are visible to the
|
|
* IOMMU.
|
|
* @flush_pgtable: Ensure page table updates are visible to the IOMMU.
|
|
*
|
|
* Note that these can all be called in atomic context and must therefore
|
|
* not block.
|
|
*/
|
|
struct iommu_gather_ops {
|
|
void (*tlb_flush_all)(void *cookie);
|
|
void (*tlb_add_flush)(unsigned long iova, size_t size, bool leaf,
|
|
void *cookie);
|
|
void (*tlb_sync)(void *cookie);
|
|
void (*flush_pgtable)(void *ptr, size_t size, void *cookie);
|
|
};
|
|
|
|
/**
|
|
* struct io_pgtable_cfg - Configuration data for a set of page tables.
|
|
*
|
|
* @quirks: A bitmap of hardware quirks that require some special
|
|
* action by the low-level page table allocator.
|
|
* @pgsize_bitmap: A bitmap of page sizes supported by this set of page
|
|
* tables.
|
|
* @ias: Input address (iova) size, in bits.
|
|
* @oas: Output address (paddr) size, in bits.
|
|
* @tlb: TLB management callbacks for this set of tables.
|
|
* @iommu_dev: The device representing the DMA configuration for the
|
|
* page table walker.
|
|
*/
|
|
struct io_pgtable_cfg {
|
|
#define IO_PGTABLE_QUIRK_ARM_NS (1 << 0) /* Set NS bit in PTEs */
|
|
int quirks;
|
|
unsigned long pgsize_bitmap;
|
|
unsigned int ias;
|
|
unsigned int oas;
|
|
const struct iommu_gather_ops *tlb;
|
|
struct device *iommu_dev;
|
|
|
|
/* Low-level data specific to the table format */
|
|
union {
|
|
struct {
|
|
u64 ttbr[2];
|
|
u64 tcr;
|
|
u64 mair[2];
|
|
} arm_lpae_s1_cfg;
|
|
|
|
struct {
|
|
u64 vttbr;
|
|
u64 vtcr;
|
|
} arm_lpae_s2_cfg;
|
|
};
|
|
};
|
|
|
|
/**
|
|
* struct io_pgtable_ops - Page table manipulation API for IOMMU drivers.
|
|
*
|
|
* @map: Map a physically contiguous memory region.
|
|
* @unmap: Unmap a physically contiguous memory region.
|
|
* @iova_to_phys: Translate iova to physical address.
|
|
*
|
|
* These functions map directly onto the iommu_ops member functions with
|
|
* the same names.
|
|
*/
|
|
struct io_pgtable_ops {
|
|
int (*map)(struct io_pgtable_ops *ops, unsigned long iova,
|
|
phys_addr_t paddr, size_t size, int prot);
|
|
int (*unmap)(struct io_pgtable_ops *ops, unsigned long iova,
|
|
size_t size);
|
|
phys_addr_t (*iova_to_phys)(struct io_pgtable_ops *ops,
|
|
unsigned long iova);
|
|
};
|
|
|
|
/**
|
|
* alloc_io_pgtable_ops() - Allocate a page table allocator for use by an IOMMU.
|
|
*
|
|
* @fmt: The page table format.
|
|
* @cfg: The page table configuration. This will be modified to represent
|
|
* the configuration actually provided by the allocator (e.g. the
|
|
* pgsize_bitmap may be restricted).
|
|
* @cookie: An opaque token provided by the IOMMU driver and passed back to
|
|
* the callback routines in cfg->tlb.
|
|
*/
|
|
struct io_pgtable_ops *alloc_io_pgtable_ops(enum io_pgtable_fmt fmt,
|
|
struct io_pgtable_cfg *cfg,
|
|
void *cookie);
|
|
|
|
/**
|
|
* free_io_pgtable_ops() - Free an io_pgtable_ops structure. The caller
|
|
* *must* ensure that the page table is no longer
|
|
* live, but the TLB can be dirty.
|
|
*
|
|
* @ops: The ops returned from alloc_io_pgtable_ops.
|
|
*/
|
|
void free_io_pgtable_ops(struct io_pgtable_ops *ops);
|
|
|
|
|
|
/*
|
|
* Internal structures for page table allocator implementations.
|
|
*/
|
|
|
|
/**
|
|
* struct io_pgtable - Internal structure describing a set of page tables.
|
|
*
|
|
* @fmt: The page table format.
|
|
* @cookie: An opaque token provided by the IOMMU driver and passed back to
|
|
* any callback routines.
|
|
* @cfg: A copy of the page table configuration.
|
|
* @ops: The page table operations in use for this set of page tables.
|
|
*/
|
|
struct io_pgtable {
|
|
enum io_pgtable_fmt fmt;
|
|
void *cookie;
|
|
struct io_pgtable_cfg cfg;
|
|
struct io_pgtable_ops ops;
|
|
};
|
|
|
|
/**
|
|
* struct io_pgtable_init_fns - Alloc/free a set of page tables for a
|
|
* particular format.
|
|
*
|
|
* @alloc: Allocate a set of page tables described by cfg.
|
|
* @free: Free the page tables associated with iop.
|
|
*/
|
|
struct io_pgtable_init_fns {
|
|
struct io_pgtable *(*alloc)(struct io_pgtable_cfg *cfg, void *cookie);
|
|
void (*free)(struct io_pgtable *iop);
|
|
};
|
|
|
|
#endif /* __IO_PGTABLE_H */
|