Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7e4cda70 authored by Kedareswara rao Appana's avatar Kedareswara rao Appana Committed by Vinod Koul
Browse files

Documentation: DT: vdma: update binding doc for AXI DMA 



This patch updates the device-tree binding doc for
adding support for AXI DMA.
Also this patch differentiates required properties b/w
DMA and VDMA.

Signed-off-by: default avatarKedareswara rao Appana <appanad@xilinx.com>
Signed-off-by: default avatarVinod Koul <vinod.koul@intel.com>
parent 42c1a2ed

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

+11 −2
Original line number Diff line number Diff line
@@ -3,20 +3,28 @@ It can be configured to have one channel or two channels. If configured 
as two channels, one is to transmit to the video device and another is

to receive from the video device.



Xilinx AXI DMA engine, it does transfers between memory and AXI4 stream

target devices. It can be configured to have one channel or two channels.

If configured as two channels, one is to transmit to the device and another

is to receive from the device.



Required properties:

- compatible: Should be "xlnx,axi-vdma-1.00.a"

- compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"

- #dma-cells: Should be <1>, see "dmas" property below

- reg: Should contain VDMA registers location and length.

- xlnx,num-fstores: Should be the number of framebuffers as configured in h/w.

- xlnx,addrwidth: Should be the vdma addressing size in bits(ex: 32 bits).

- dma-ranges: Should be as the following <dma_addr cpu_addr max_len>.

- dma-channel child node: Should have at least one channel and can have up to

	two channels per device. This node specifies the properties of each

	DMA channel (see child node properties below).



Required properties for VDMA:

- xlnx,num-fstores: Should be the number of framebuffers as configured in h/w.



Optional properties:

- xlnx,include-sg: Tells configured for Scatter-mode in

	the hardware.

Optional properties for VDMA:

- xlnx,flush-fsync: Tells which channel to Flush on Frame sync.

	It takes following values:

	{1}, flush both channels
@@ -33,6 +41,7 @@ Required child node properties: 
Optional child node properties:

- xlnx,include-dre: Tells hardware is configured for Data

	Realignment Engine.

Optional child node properties for VDMA:

- xlnx,genlock-mode: Tells Genlock synchronization is

	enabled/disabled in hardware.