Documentation/devicetree/bindings/dma/fsl-edma.txt

   1 * Freescale enhanced Direct Memory Access(eDMA) Controller
   2
   3   The eDMA channels have multiplex capability by programmble memory-mapped
   4 registers. channels are split into two groups, called DMAMUX0 and DMAMUX1,
   5 specific DMA request source can only be multiplexed by any channel of certain
   6 group, DMAMUX0 or DMAMUX1, but not both.
   7
   8 * eDMA Controller
   9 Required properties:
  10 - compatible :
  11         - "fsl,vf610-edma" for eDMA used similar to that on Vybrid vf610 SoC
  12         - "fsl,imx7ulp-edma" for eDMA2 used similar to that on i.mx7ulp
  13         - "fsl,fsl,ls1028a-edma" for eDMA used similar to that on Vybrid vf610 SoC
  14 - reg : Specifies base physical address(s) and size of the eDMA registers.
  15         The 1st region is eDMA control register's address and size.
  16         The 2nd and the 3rd regions are programmable channel multiplexing
  17         control register's address and size.
  18 - interrupts : A list of interrupt-specifiers, one for each entry in
  19         interrupt-names on vf610 similar SoC. But for i.mx7ulp per channel
  20         per transmission interrupt, total 16 channel interrupt and 1
  21         error interrupt(located in the last), no interrupt-names list on
  22         i.mx7ulp for clean on dts.
  23 - #dma-cells : Must be <2>.
  24         The 1st cell specifies the DMAMUX(0 for DMAMUX0 and 1 for DMAMUX1).
  25         Specific request source can only be multiplexed by specific channels
  26         group called DMAMUX.
  27         The 2nd cell specifies the request source(slot) ID.
  28         See the SoC's reference manual for all the supported request sources.
  29 - dma-channels : Number of channels supported by the controller
  30 - clock-names : A list of channel group clock names. Should contain:
  31         "dmamux0" - clock name of mux0 group
  32         "dmamux1" - clock name of mux1 group
  33         Note: No dmamux0 on i.mx7ulp, but another 'dma' clk added on i.mx7ulp.
  34 - clocks : A list of phandle and clock-specifier pairs, one for each entry in
  35         clock-names.
  36
  37 Optional properties:
  38 - big-endian: If present registers and hardware scatter/gather descriptors
  39         of the eDMA are implemented in big endian mode, otherwise in little
  40         mode.
  41 - interrupt-names : Should contain the below on vf610 similar SoC but not used
  42         on i.mx7ulp similar SoC:
  43         "edma-tx" - the transmission interrupt
  44         "edma-err" - the error interrupt
  45
  46
  47 Examples:
  48
  49 edma0: dma-controller@40018000 {
  50         #dma-cells = <2>;
  51         compatible = "fsl,vf610-edma";
  52         reg = <0x40018000 0x2000>,
  53                 <0x40024000 0x1000>,
  54                 <0x40025000 0x1000>;
  55         interrupts = <0 8 IRQ_TYPE_LEVEL_HIGH>,
  56                 <0 9 IRQ_TYPE_LEVEL_HIGH>;
  57         interrupt-names = "edma-tx", "edma-err";
  58         dma-channels = <32>;
  59         clock-names = "dmamux0", "dmamux1";
  60         clocks = <&clks VF610_CLK_DMAMUX0>,
  61                 <&clks VF610_CLK_DMAMUX1>;
  62 }; /* vf610 */
  63
  64 edma1: dma-controller@40080000 {
  65         #dma-cells = <2>;
  66         compatible = "fsl,imx7ulp-edma";
  67         reg = <0x40080000 0x2000>,
  68                 <0x40210000 0x1000>;
  69         dma-channels = <32>;
  70         interrupts = <GIC_SPI 0 IRQ_TYPE_LEVEL_HIGH>,
  71                      <GIC_SPI 1 IRQ_TYPE_LEVEL_HIGH>,
  72                      <GIC_SPI 2 IRQ_TYPE_LEVEL_HIGH>,
  73                      <GIC_SPI 3 IRQ_TYPE_LEVEL_HIGH>,
  74                      <GIC_SPI 4 IRQ_TYPE_LEVEL_HIGH>,
  75                      <GIC_SPI 5 IRQ_TYPE_LEVEL_HIGH>,
  76                      <GIC_SPI 6 IRQ_TYPE_LEVEL_HIGH>,
  77                      <GIC_SPI 7 IRQ_TYPE_LEVEL_HIGH>,
  78                      <GIC_SPI 8 IRQ_TYPE_LEVEL_HIGH>,
  79                      <GIC_SPI 9 IRQ_TYPE_LEVEL_HIGH>,
  80                      <GIC_SPI 10 IRQ_TYPE_LEVEL_HIGH>,
  81                      <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>,
  82                      <GIC_SPI 12 IRQ_TYPE_LEVEL_HIGH>,
  83                      <GIC_SPI 13 IRQ_TYPE_LEVEL_HIGH>,
  84                      <GIC_SPI 14 IRQ_TYPE_LEVEL_HIGH>,
  85                      <GIC_SPI 15 IRQ_TYPE_LEVEL_HIGH>,
  86                      /* last is eDMA2-ERR interrupt */
  87                      <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
  88         clock-names = "dma", "dmamux0";
  89         clocks = <&pcc2 IMX7ULP_CLK_DMA1>,
  90                  <&pcc2 IMX7ULP_CLK_DMA_MUX1>;
  91 }; /* i.mx7ulp */
  92
  93 * DMA clients
  94 DMA client drivers that uses the DMA function must use the format described
  95 in the dma.txt file, using a two-cell specifier for each channel: the 1st
  96 specifies the channel group(DMAMUX) in which this request can be multiplexed,
  97 and the 2nd specifies the request source.
  98
  99 Examples:
 100
 101 sai2: sai@40031000 {
 102         compatible = "fsl,vf610-sai";
 103         reg = <0x40031000 0x1000>;
 104         interrupts = <0 86 IRQ_TYPE_LEVEL_HIGH>;
 105         clock-names = "sai";
 106         clocks = <&clks VF610_CLK_SAI2>;
 107         dma-names = "tx", "rx";
 108         dmas = <&edma0 0 21>,
 109                 <&edma0 0 20>;
 110 };