Documentation/devicetree/bindings/dma/xilinx/xilinx_dma.txt

   1 Xilinx AXI VDMA engine, it does transfers between memory and video devices.
   2 It can be configured to have one channel or two channels. If configured
   3 as two channels, one is to transmit to the video device and another is
   4 to receive from the video device.
   5
   6 Xilinx AXI DMA engine, it does transfers between memory and AXI4 stream
   7 target devices. It can be configured to have one channel or two channels.
   8 If configured as two channels, one is to transmit to the device and another
   9 is to receive from the device.
  10
  11 Xilinx AXI CDMA engine, it does transfers between memory-mapped source
  12 address and a memory-mapped destination address.
  13
  14 Required properties:
  15 - compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a" or
  16               "xlnx,axi-cdma-1.00.a""
  17 - #dma-cells: Should be <1>, see "dmas" property below
  18 - reg: Should contain DMA registers location and length.
  19 - xlnx,addrwidth: Should be the vdma addressing size in bits(ex: 32 bits).
  20 - dma-ranges: Should be as the following <dma_addr cpu_addr max_len>.
  21 - dma-channel child node: Should have at least one channel and can have up to
  22         two channels per device. This node specifies the properties of each
  23         DMA channel (see child node properties below).
  24 - clocks: Input clock specifier. Refer to common clock bindings.
  25 - clock-names: List of input clocks
  26         For VDMA:
  27         Required elements: "s_axi_lite_aclk"
  28         Optional elements: "m_axi_mm2s_aclk" "m_axi_s2mm_aclk",
  29                            "m_axis_mm2s_aclk", "s_axis_s2mm_aclk"
  30         For CDMA:
  31         Required elements: "s_axi_lite_aclk", "m_axi_aclk"
  32         FOR AXIDMA:
  33         Required elements: "s_axi_lite_aclk"
  34         Optional elements: "m_axi_mm2s_aclk", "m_axi_s2mm_aclk",
  35                            "m_axi_sg_aclk"
  36
  37 Required properties for VDMA:
  38 - xlnx,num-fstores: Should be the number of framebuffers as configured in h/w.
  39
  40 Optional properties:
  41 - xlnx,include-sg: Tells configured for Scatter-mode in
  42         the hardware.
  43 Optional properties for AXI DMA:
  44 - xlnx,mcdma: Tells whether configured for multi-channel mode in the hardware.
  45 Optional properties for VDMA:
  46 - xlnx,flush-fsync: Tells which channel to Flush on Frame sync.
  47         It takes following values:
  48         {1}, flush both channels
  49         {2}, flush mm2s channel
  50         {3}, flush s2mm channel
  51
  52 Required child node properties:
  53 - compatible:
  54         For VDMA: It should be either "xlnx,axi-vdma-mm2s-channel" or
  55         "xlnx,axi-vdma-s2mm-channel".
  56         For CDMA: It should be "xlnx,axi-cdma-channel".
  57         For AXIDMA: It should be either "xlnx,axi-dma-mm2s-channel" or
  58         "xlnx,axi-dma-s2mm-channel".
  59 - interrupts: Should contain per channel VDMA interrupts.
  60 - xlnx,datawidth: Should contain the stream data width, take values
  61         {32,64...1024}.
  62
  63 Optional child node properties:
  64 - xlnx,include-dre: Tells hardware is configured for Data
  65         Realignment Engine.
  66 Optional child node properties for VDMA:
  67 - xlnx,genlock-mode: Tells Genlock synchronization is
  68         enabled/disabled in hardware.
  69 - xlnx,fstore-enable: boolean; if defined, it indicates that controller
  70         supports frame store configuration.
  71 Optional child node properties for AXI DMA:
  72 -dma-channels: Number of dma channels in child node.
  73
  74 Example:
  75 ++++++++
  76
  77 axi_vdma_0: axivdma@40030000 {
  78         compatible = "xlnx,axi-vdma-1.00.a";
  79         #dma-cells = <1>;
  80         reg = < 0x40030000 0x10000 >;
  81         dma-ranges = <0x00000000 0x00000000 0x40000000>;
  82         xlnx,num-fstores = <0x8>;
  83         xlnx,flush-fsync = <0x1>;
  84         xlnx,addrwidth = <0x20>;
  85         clocks = <&clk 0>, <&clk 1>, <&clk 2>, <&clk 3>, <&clk 4>;
  86         clock-names = "s_axi_lite_aclk", "m_axi_mm2s_aclk", "m_axi_s2mm_aclk",
  87                       "m_axis_mm2s_aclk", "s_axis_s2mm_aclk";
  88         dma-channel@40030000 {
  89                 compatible = "xlnx,axi-vdma-mm2s-channel";
  90                 interrupts = < 0 54 4 >;
  91                 xlnx,datawidth = <0x40>;
  92         } ;
  93         dma-channel@40030030 {
  94                 compatible = "xlnx,axi-vdma-s2mm-channel";
  95                 interrupts = < 0 53 4 >;
  96                 xlnx,datawidth = <0x40>;
  97         } ;
  98 } ;
  99
 100
 101 * DMA client
 102
 103 Required properties:
 104 - dmas: a list of <[Video DMA device phandle] [Channel ID]> pairs,
 105         where Channel ID is '0' for write/tx and '1' for read/rx
 106         channel if both channels are enabled.
 107         If only one channel is enabled either tx or rx the Channel ID is '0'.
 108 - dma-names: a list of DMA channel names, one per "dmas" entry
 109
 110 Example:
 111 ++++++++
 112
 113 vdmatest_0: vdmatest@0 {
 114         compatible ="xlnx,axi-vdma-test-1.00.a";
 115         dmas = <&axi_vdma_0 0
 116                 &axi_vdma_0 1>;
 117         dma-names = "vdma0", "vdma1";
 118 } ;