diff mbox

[v2,1/2] dma: Add Xilinx Central DMA DT Binding Documentation

Message ID 1407238791-3370-1-git-send-email-sthokal@xilinx.com (mailing list archive)
State Accepted
Delegated to: Vinod Koul
Headers show

Commit Message

Srikanth Thokala Aug. 5, 2014, 11:39 a.m. UTC
Device-tree binding documentation of Xilinx Central DMA Engine

Signed-off-by: Srikanth Thokala <sthokal@xilinx.com>
---
Changes in v2:
- Change property 'xlnx,data-width' to 'xlnx,datawidth' in the description
  to match the implementation.

---
 .../devicetree/bindings/dma/xilinx/xilinx_cdma.txt |   54 ++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt

Comments

Varka Bhadram Aug. 5, 2014, 11:59 a.m. UTC | #1
On 08/05/2014 05:09 PM, Srikanth Thokala wrote:
> Device-tree binding documentation of Xilinx Central DMA Engine
>
> Signed-off-by: Srikanth Thokala <sthokal@xilinx.com>
> ---
> Changes in v2:
> - Change property 'xlnx,data-width' to 'xlnx,datawidth' in the description
>    to match the implementation.
>
> ---
>   .../devicetree/bindings/dma/xilinx/xilinx_cdma.txt |   54 ++++++++++++++++++++
>   1 file changed, 54 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
>
> diff --git a/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
> new file mode 100644
> index 0000000..b04f76b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
> @@ -0,0 +1,54 @@
> +Xilinx AXI CDMA engine, it does transfers between memory-mapped source
> +address and a memory-mapped destination address.
> +
> +Required properties:
> +- compatible: Should be "xlnx,axi-cdma-1.00.a"
> +- #dma-cells: Should be <1>, see "dmas" property below
> +- reg: Should contain cdma registers location and length.
> +- dma-channel child node: Should have only one channel
> +
> +

proper alignment for all the properties...
Required properties:
- compatible	: Should be "xlnx,axi-cdma-1.00.a"
- #dma-cells	: Should be <1>, see "dmas" property below
- reg		: Should contain cdma registers location and length.
.....
Srikanth Thokala Aug. 18, 2014, 9:37 a.m. UTC | #2
Hi Varka Bhadram,

On Tue, Aug 5, 2014 at 5:29 PM, Varka Bhadram <varkabhadram@gmail.com> wrote:
> On 08/05/2014 05:09 PM, Srikanth Thokala wrote:
>>
>> Device-tree binding documentation of Xilinx Central DMA Engine
>>
>> Signed-off-by: Srikanth Thokala <sthokal@xilinx.com>
>> ---
>> Changes in v2:
>> - Change property 'xlnx,data-width' to 'xlnx,datawidth' in the description
>>    to match the implementation.
>>
>> ---
>>   .../devicetree/bindings/dma/xilinx/xilinx_cdma.txt |   54
>> ++++++++++++++++++++
>>   1 file changed, 54 insertions(+)
>>   create mode 100644
>> Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
>>
>> diff --git a/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
>> b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
>> new file mode 100644
>> index 0000000..b04f76b
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
>> @@ -0,0 +1,54 @@
>> +Xilinx AXI CDMA engine, it does transfers between memory-mapped source
>> +address and a memory-mapped destination address.
>> +
>> +Required properties:
>> +- compatible: Should be "xlnx,axi-cdma-1.00.a"
>> +- #dma-cells: Should be <1>, see "dmas" property below
>> +- reg: Should contain cdma registers location and length.
>> +- dma-channel child node: Should have only one channel
>> +
>> +
>
>
> proper alignment for all the properties...
> Required properties:
> - compatible    : Should be "xlnx,axi-cdma-1.00.a"
>
> - #dma-cells    : Should be <1>, see "dmas" property below
> - reg           : Should contain cdma registers location and length.
> .....

I would like to change, but is it documented anywhere? Because, I didn't
receive any such comments on other drivers, so I am just wondering.

Thanks
Srikanth

>
>
>
> --
> Regards,
> Varka Bhadram.
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/
--
To unsubscribe from this list: send the line "unsubscribe dmaengine" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
new file mode 100644
index 0000000..b04f76b
--- /dev/null
+++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_cdma.txt
@@ -0,0 +1,54 @@ 
+Xilinx AXI CDMA engine, it does transfers between memory-mapped source
+address and a memory-mapped destination address.
+
+Required properties:
+- compatible: Should be "xlnx,axi-cdma-1.00.a"
+- #dma-cells: Should be <1>, see "dmas" property below
+- reg: Should contain cdma registers location and length.
+- dma-channel child node: Should have only one channel
+
+Optional properties:
+- xlnx,include-sg: Tells whether configured for Scatter-mode in
+	the hardware.
+
+Required child node properties:
+- compatible: It should be "xlnx,axi-cdma-channel".
+- interrupts: Should contain per channel CDMA interrupts.
+- xlnx,datawidth: Should contain the stream data width, take values
+	{32,64...1024}.
+
+Option child node properties:
+- xlnx,include-dre: Tells whether hardware is configured for Data
+	Realignment Engine.
+
+Example:
+++++++++
+
+axi_cdma_0: axicdma@7e200000 {
+	compatible = "xlnx,axi-cdma-1.00.a";
+	#dma_cells = <1>;
+	reg = < 0x7e200000 0x10000 >;
+	dma-channel@7e200000 {
+		compatible = "xlnx,axi-cdma-channel";
+		interrupts = < 0 55 4 >;
+		xlnx,datawidth = <0x40>;
+	} ;
+} ;
+
+
+* DMA client
+
+Required properties:
+- dmas: a list of <[Central DMA device phandle] [Channel ID]> pairs,
+	where Channel ID is '0' for write/tx and '1' for read/rx
+	channel.
+- dma-names: a list of DMA channel names, one per "dmas" entry
+
+Example:
+++++++++
+
+cdmatest_0: cdmatest@0 {
+	compatible ="xlnx,axi-cdma-test-1.00.a";
+	dmas = <&axi_cdma_0 0>;
+	dma-names = "cdma0";
+} ;