2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License version 2 as
4 * published by the Free Software Foundation.
7 #ifndef __ASM_PLAT_IOVMM_H
8 #define __ASM_PLAT_IOVMM_H
10 #include <linux/list.h>
11 #include <linux/atomic.h>
12 #include <linux/spinlock.h>
14 #define IEP_IOMMU_COMPATIBLE_NAME "rockchip,iep_mmu"
15 #define VIP_IOMMU_COMPATIBLE_NAME "rockchip,vip_mmu"
16 #define ISP_IOMMU_COMPATIBLE_NAME "rockchip,isp_mmu"
17 #define VOPB_IOMMU_COMPATIBLE_NAME "rockchip,vopb_mmu"
18 #define VOPL_IOMMU_COMPATIBLE_NAME "rockchip,vopl_mmu"
19 #define VOP_IOMMU_COMPATIBLE_NAME "rockchip,vop_mmu"
20 #define HEVC_IOMMU_COMPATIBLE_NAME "rockchip,hevc_mmu"
21 #define VPU_IOMMU_COMPATIBLE_NAME "rockchip,vpu_mmu"
23 enum rk_iommu_inttype {
33 * @itype: type of fault.
34 * @pgtable_base: the physical address of page table base. This is 0 if @itype
36 * @fault_addr: the device (virtual) address that the System MMU tried to
37 * translated. This is 0 if @itype is IOMMU_BUSERROR.
39 typedef int (*rockchip_iommu_fault_handler_t)(struct device *dev,
40 enum rk_iommu_inttype itype,
41 unsigned long pgtable_base,
42 unsigned long fault_addr,
50 #ifdef CONFIG_ROCKCHIP_IOVMM
52 int rockchip_iovmm_activate(struct device *dev);
53 void rockchip_iovmm_deactivate(struct device *dev);
55 /* rockchip_iovmm_map() - Maps a list of physical memory chunks
56 * @dev: the owner of the IO address space where the mapping is created
57 * @sg: list of physical memory chunks to map
58 * @offset: length in bytes where the mapping starts
59 * @size: how much memory to map in bytes. @offset + @size must not exceed
62 * This function returns mapped IO address in the address space of @dev.
63 * Returns minus error number if mapping fails.
64 * Caller must check its return code with IS_ERROR_VALUE() if the function
67 * The caller of this function must ensure that iovmm_cleanup() is not called
68 * while this function is called.
71 dma_addr_t rockchip_iovmm_map(struct device *dev, struct scatterlist *sg,
72 off_t offset, size_t size);
74 /* rockchip_iovmm_unmap() - unmaps the given IO address
75 * @dev: the owner of the IO address space where @iova belongs
76 * @iova: IO address that needs to be unmapped and freed.
78 * The caller of this function must ensure that iovmm_cleanup() is not called
79 * while this function is called.
81 void rockchip_iovmm_unmap(struct device *dev, dma_addr_t iova);
83 /* rockchip_iovmm_map_oto - create one to one mapping for the given physical address
84 * @dev: the owner of the IO address space to map
85 * @phys: physical address to map
86 * @size: size of the mapping to create
88 * This function return 0 if mapping is successful. Otherwise, minus error
91 int rockchip_iovmm_map_oto(struct device *dev, phys_addr_t phys, size_t size);
93 /* rockchip_iovmm_unmap_oto - remove one to one mapping
94 * @dev: the owner ofthe IO address space
95 * @phys: physical address to remove mapping
97 void rockchip_iovmm_unmap_oto(struct device *dev, phys_addr_t phys);
99 void rockchip_iovmm_set_fault_handler(struct device *dev,
100 rockchip_iommu_fault_handler_t handler);
101 /** rockchip_iovmm_set_fault_handler() - Fault handler for IOMMUs
102 * Called when interrupt occurred by the IOMMUs
103 * The device drivers of peripheral devices that has a IOMMU can implement
104 * a fault handler to resolve address translation fault by IOMMU.
105 * The meanings of return value and parameters are described below.
107 * return value: non-zero if the fault is correctly resolved.
108 * zero if the fault is not handled.
111 int rockchip_iovmm_invalidate_tlb(struct device *dev);
113 static inline int rockchip_iovmm_activate(struct device *dev)
118 static inline void rockchip_iovmm_deactivate(struct device *dev)
122 static inline dma_addr_t rockchip_iovmm_map(struct device *dev,
123 struct scatterlist *sg, off_t offset, size_t size)
128 static inline void rockchip_iovmm_unmap(struct device *dev, dma_addr_t iova)
132 static inline int rockchip_iovmm_map_oto(struct device *dev, phys_addr_t phys,
138 static inline void rockchip_iovmm_unmap_oto(struct device *dev, phys_addr_t phys)
142 static inline void rockchip_iovmm_set_fault_handler(struct device *dev,
143 rockchip_iommu_fault_handler_t handler)
146 static inline int rockchip_iovmm_invalidate_tlb(struct device *dev)
151 #endif /* CONFIG_ROCKCHIP_IOVMM */
153 #endif /*__ASM_PLAT_IOVMM_H*/