include/linux/rockchip/sysmmu.h

   1 /*
   2  * Rockchip - System MMU support
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  */
   8
   9 #ifndef _ARM_MACH_RK_SYSMMU_H_
  10 #define _ARM_MACH_RK_SYSMMU_H_
  11
  12 #include <linux/list.h>
  13 #include <linux/atomic.h>
  14 #include <linux/spinlock.h>
  15
  16 #define IEP_SYSMMU_COMPATIBLE_NAME "iommu,iep_mmu"
  17 #define VIP_SYSMMU_COMPATIBLE_NAME "iommu,vip_mmu"
  18
  19 #define ISP_SYSMMU0_COMPATIBLE_NAME "iommu,isp_mmu0"
  20 #define ISP_SYSMMU1_COMPATIBLE_NAME "iommu,isp_mmu1"
  21
  22 #define VOPB_SYSMMU_COMPATIBLE_NAME "iommu,vopb_mmu"
  23 #define VOPL_SYSMMU_COMPATIBLE_NAME "iommu,vopl_mmu"
  24
  25 #define HEVC_SYSMMU_COMPATIBLE_NAME "iommu,hevc_mmu"
  26 #define VPU_SYSMMU_COMPATIBLE_NAME "iommu,vpu_mmu"
  27
  28
  29 enum rk_sysmmu_inttype {
  30         SYSMMU_PAGEFAULT,
  31         SYSMMU_BUSERROR,
  32         SYSMMU_FAULT_UNKNOWN,
  33         SYSMMU_FAULTS_NUM
  34 };
  35
  36 struct sysmmu_drvdata;
  37 /*
  38  * @itype: type of fault.
  39  * @pgtable_base: the physical address of page table base. This is 0 if @itype
  40  *                                is SYSMMU_BUSERROR.
  41  * @fault_addr: the device (virtual) address that the System MMU tried to
  42  *                         translated. This is 0 if @itype is SYSMMU_BUSERROR.
  43  */
  44 typedef int (*sysmmu_fault_handler_t)(struct device *dev,
  45                                           enum rk_sysmmu_inttype itype,
  46                                           unsigned long pgtable_base,
  47                                           unsigned long fault_addr,
  48                                           unsigned int statu
  49                                           );
  50
  51 #ifdef CONFIG_ROCKCHIP_IOMMU
  52 /**
  53 * rockchip_sysmmu_enable() - enable system mmu
  54 * @owner: The device whose System MMU is about to be enabled.
  55 * @pgd: Base physical address of the 1st level page table
  56 *
  57 * This function enable system mmu to transfer address
  58 * from virtual address to physical address.
  59 * Return non-zero if it fails to enable System MMU.
  60 */
  61 int rockchip_sysmmu_enable(struct device *owner, unsigned long pgd);
  62
  63 /**
  64 * rockchip_sysmmu_disable() - disable sysmmu mmu of ip
  65 * @owner: The device whose System MMU is about to be disabled.
  66 *
  67 * This function disable system mmu to transfer address
  68  * from virtual address to physical address
  69  */
  70 bool rockchip_sysmmu_disable(struct device *owner);
  71
  72 /**
  73  * rockchip_sysmmu_tlb_invalidate() - flush all TLB entry in system mmu
  74  * @owner: The device whose System MMU.
  75  *
  76  * This function flush all TLB entry in system mmu
  77  */
  78 void rockchip_sysmmu_tlb_invalidate(struct device *owner);
  79
  80 /** rockchip_sysmmu_set_fault_handler() - Fault handler for System MMUs
  81  * Called when interrupt occurred by the System MMUs
  82  * The device drivers of peripheral devices that has a System MMU can implement
  83  * a fault handler to resolve address translation fault by System MMU.
  84  * The meanings of return value and parameters are described below.
  85  *
  86  * return value: non-zero if the fault is correctly resolved.
  87  *                 zero if the fault is not handled.
  88  */
  89 void rockchip_sysmmu_set_fault_handler(struct device *dev,sysmmu_fault_handler_t handler);
  90
  91 /** rockchip_sysmmu_set_prefbuf() - Initialize prefetch buffers of System MMU v3
  92  *      @owner: The device which need to set the prefetch buffers
  93  *      @base0: The start virtual address of the area of the @owner device that the
  94  *                      first prefetch buffer loads translation descriptors
  95  *      @size0: The last virtual address of the area of the @owner device that the
  96  *                      first prefetch buffer loads translation descriptors.
  97  *      @base1: The start virtual address of the area of the @owner device that the
  98  *                      second prefetch buffer loads translation descriptors. This will be
  99  *                      ignored if @size1 is 0 and this function assigns the 2 prefetch
 100  *                      buffers with each half of the area specified by @base0 and @size0
 101  *      @size1: The last virtual address of the area of the @owner device that the
 102  *                      prefetch buffer loads translation descriptors. This can be 0. See
 103  *                      the description of @base1 for more information with @size1 = 0
 104  */
 105 void rockchip_sysmmu_set_prefbuf(struct device *owner,
 106                                 unsigned long base0, unsigned long size0,
 107                                 unsigned long base1, unsigned long size1);
 108 #else /* CONFIG_ROCKCHIP_IOMMU */
 109 #define rockchip_sysmmu_enable(owner, pgd) do { } while (0)
 110 #define rockchip_sysmmu_disable(owner) do { } while (0)
 111 #define rockchip_sysmmu_tlb_invalidate(owner) do { } while (0)
 112 #define rockchip_sysmmu_set_fault_handler(sysmmu, handler) do { } while (0)
 113 #define rockchip_sysmmu_set_prefbuf(owner, b0, s0, b1, s1) do { } while (0)
 114 #endif
 115
 116 #ifdef CONFIG_IOMMU_API
 117 #include <linux/device.h>
 118 static inline void platform_set_sysmmu(struct device *sysmmu, struct device *dev)
 119 {
 120         dev->archdata.iommu = sysmmu;
 121 }
 122 #else
 123 #define platform_set_sysmmu(dev, sysmmu) do { } while (0)
 124 #endif
 125
 126 #endif /* _ARM_MACH_RK_SYSMMU_H_ */