Device-tree binding documentation of Xilinx Central DMA Engine.
Signed-off-by: Srikanth Thokala <[email protected]>
Signed-off-by: Kedareswara rao Appana <[email protected]>
---
This patch is rebased on the commit
Merge tag 'nfs-for-4.1-2' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
Changes in v4:
- None.
Changes in v3:
- Used proper alignment for all the properties.
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..d1637de
--- /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 = "cdma";
+} ;
--
2.1.2
Ping!
> -----Original Message-----
> From: Kedareswara rao Appana [mailto:[email protected]]
> Sent: Thursday, May 21, 2015 10:40 PM
> To: [email protected]; [email protected]; [email protected];
> [email protected]; Michal Simek; [email protected];
> [email protected]; Soren Brinkmann
> Cc: [email protected]; [email protected]; linux-
> [email protected]; Appana Durga Kedareswara Rao; Srikanth Thokala
> Subject: [PATCH v4 1/2] dma: Add Xilinx Central DMA DT Binding
> Documentation
>
> Device-tree binding documentation of Xilinx Central DMA Engine.
>
> Signed-off-by: Srikanth Thokala <[email protected]>
> Signed-off-by: Kedareswara rao Appana <[email protected]>
> ---
> This patch is rebased on the commit
> Merge tag 'nfs-for-4.1-2' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
>
> Changes in v4:
> - None.
> Changes in v3:
> - Used proper alignment for all the properties.
> 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..d1637de
> --- /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 = "cdma";
> +} ;
> --
> 2.1.2
This email and any attachments are intended for the sole use of the named recipient(s) and contain(s) confidential information that may be proprietary, privileged or copyrighted under applicable law. If you are not the intended recipient, do not read, copy, or forward this email message or any attachments. Delete this email message and any attachments immediately.