Documentation/devicetree/bindings/iommu/mediatek,iommu.txt

   1 * Mediatek IOMMU Architecture Implementation
   2
   3   Some Mediatek SOCs contain a Multimedia Memory Management Unit (M4U), and
   4 this M4U have two generations of HW architecture. Generation one uses flat
   5 pagetable, and only supports 4K size page mapping. Generation two uses the
   6 ARM Short-Descriptor translation table format for address translation.
   7
   8   About the M4U Hardware Block Diagram, please check below:
   9
  10               EMI (External Memory Interface)
  11                |
  12               m4u (Multimedia Memory Management Unit)
  13                |
  14            SMI Common(Smart Multimedia Interface Common)
  15                |
  16        +----------------+-------
  17        |                |
  18        |                |
  19    SMI larb0        SMI larb1   ... SoCs have several SMI local arbiter(larb).
  20    (display)         (vdec)
  21        |                |
  22        |                |
  23  +-----+-----+     +----+----+
  24  |     |     |     |    |    |
  25  |     |     |...  |    |    |  ... There are different ports in each larb.
  26  |     |     |     |    |    |
  27 OVL0 RDMA0 WDMA0  MC   PP   VLD
  28
  29   As above, The Multimedia HW will go through SMI and M4U while it
  30 access EMI. SMI is a bridge between m4u and the Multimedia HW. It contain
  31 smi local arbiter and smi common. It will control whether the Multimedia
  32 HW should go though the m4u for translation or bypass it and talk
  33 directly with EMI. And also SMI help control the power domain and clocks for
  34 each local arbiter.
  35   Normally we specify a local arbiter(larb) for each multimedia HW
  36 like display, video decode, and camera. And there are different ports
  37 in each larb. Take a example, There are many ports like MC, PP, VLD in the
  38 video decode local arbiter, all these ports are according to the video HW.
  39
  40 Required properties:
  41 - compatible : must be one of the following string:
  42         "mediatek,mt2701-m4u" for mt2701 which uses generation one m4u HW.
  43         "mediatek,mt2712-m4u" for mt2712 which uses generation two m4u HW.
  44         "mediatek,mt7623-m4u", "mediatek,mt2701-m4u" for mt7623 which uses
  45                                                      generation one m4u HW.
  46         "mediatek,mt8173-m4u" for mt8173 which uses generation two m4u HW.
  47 - reg : m4u register base and size.
  48 - interrupts : the interrupt of m4u.
  49 - clocks : must contain one entry for each clock-names.
  50 - clock-names : must be "bclk", It is the block clock of m4u.
  51 - mediatek,larbs : List of phandle to the local arbiters in the current Socs.
  52         Refer to bindings/memory-controllers/mediatek,smi-larb.txt. It must sort
  53         according to the local arbiter index, like larb0, larb1, larb2...
  54 - iommu-cells : must be 1. This is the mtk_m4u_id according to the HW.
  55         Specifies the mtk_m4u_id as defined in
  56         dt-binding/memory/mt2701-larb-port.h for mt2701, mt7623
  57         dt-binding/memory/mt2712-larb-port.h for mt2712, and
  58         dt-binding/memory/mt8173-larb-port.h for mt8173.
  59
  60 Example:
  61         iommu: iommu@10205000 {
  62                 compatible = "mediatek,mt8173-m4u";
  63                 reg = <0 0x10205000 0 0x1000>;
  64                 interrupts = <GIC_SPI 139 IRQ_TYPE_LEVEL_LOW>;
  65                 clocks = <&infracfg CLK_INFRA_M4U>;
  66                 clock-names = "bclk";
  67                 mediatek,larbs = <&larb0 &larb1 &larb2 &larb3 &larb4 &larb5>;
  68                 #iommu-cells = <1>;
  69         };
  70
  71 Example for a client device:
  72         display {
  73                 compatible = "mediatek,mt8173-disp";
  74                 iommus = <&iommu M4U_PORT_DISP_OVL0>,
  75                          <&iommu M4U_PORT_DISP_RDMA0>;
  76                 ...
  77         };