diff mbox

[v2,5/6] Documentation: DT: vdma: update binding doc for AXI CDMA

Message ID 1459101966-9932-2-git-send-email-appanad@xilinx.com (mailing list archive)
State New, archived
Headers show

Commit Message

Appana Durga Kedareswara rao March 27, 2016, 6:06 p.m. UTC
This patch updates the device-tree binding doc for
adding support for AXI CDMA.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
---
---> Modified commit message as suggested by Vinod.
---> Moved the patch to forward in the series as suggested by vinod.

 .../devicetree/bindings/dma/xilinx/xilinx_vdma.txt     | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

Comments

Soren Brinkmann March 27, 2016, 7:27 p.m. UTC | #1
On Sun, 2016-03-27 at 23:36:06 +0530, Kedareswara rao Appana wrote:
> This patch updates the device-tree binding doc for
> adding support for AXI CDMA.
> 
> Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
> ---
> ---> Modified commit message as suggested by Vinod.
> ---> Moved the patch to forward in the series as suggested by vinod.
> 
>  .../devicetree/bindings/dma/xilinx/xilinx_vdma.txt     | 18 +++++++++++++++++-
>  1 file changed, 17 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> index 5841421..2b0c12b 100644
> --- a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> @@ -8,8 +8,12 @@ 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.
>  
> +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-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"
> +- compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a" or
> +	      "xlnx,axi-cdma-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.
> @@ -80,6 +84,18 @@ axi_dma_0: axidma@40400000 {
>  	} ;
>  } ;
>  
> +axi_cdma_0: axicdma@7e200000 {
> +       compatible = "xlnx,axi-cdma-1.00.a";
> +       #dma-cells = <1>;
> +       reg = < 0x7e200000 0x10000 >;
> +       xlnx,addrwidth = <0x20>;
> +       dma-channel@7e200000 {
> +               compatible = "xlnx,axi-dma-mm2s-channel";
> +               interrupts = < 0 55 4 >;
> +               xlnx,datawidth = <0x40>;
> +       } ;
> +} ;

As in the other patch, the node name should be 'dma-controller@...' and
the inconsistend spacing could be fixed.

Also, it seems this adds pretty much identical examples that just differ
in the compat string. Is that really needed?

	Sören
Appana Durga Kedareswara rao March 28, 2016, 5:27 a.m. UTC | #2
Hi Soren,

> -----Original Message-----

> From: Sören Brinkmann [mailto:soren.brinkmann@xilinx.com]

> Sent: Monday, March 28, 2016 12:58 AM

> To: Appana Durga Kedareswara Rao

> Cc: robh+dt@kernel.org; pawel.moll@arm.com; mark.rutland@arm.com;

> ijc+devicetree@hellion.org.uk; galak@codeaurora.org; Michal Simek;

> vinod.koul@intel.com; dan.j.williams@intel.com; Anurag Kumar Vulisha; Appana

> Durga Kedareswara Rao; moritz.fischer@ettus.com;

> laurent.pinchart@ideasonboard.com; luis@debethencourt.com; Srikanth

> Vemula; Anirudha Sarangi; devicetree@vger.kernel.org; linux-arm-

> kernel@lists.infradead.org; linux-kernel@vger.kernel.org;

> dmaengine@vger.kernel.org

> Subject: Re: [PATCH v2 5/6] Documentation: DT: vdma: update binding doc for

> AXI CDMA

> 

> On Sun, 2016-03-27 at 23:36:06 +0530, Kedareswara rao Appana wrote:

> > This patch updates the device-tree binding doc for adding support for

> > AXI CDMA.

> >

> > Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>

> > ---

> > ---> Modified commit message as suggested by Vinod.

> > ---> Moved the patch to forward in the series as suggested by vinod.

> >

> >  .../devicetree/bindings/dma/xilinx/xilinx_vdma.txt     | 18

> +++++++++++++++++-

> >  1 file changed, 17 insertions(+), 1 deletion(-)

> >

> > diff --git

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

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

> > index 5841421..2b0c12b 100644

> > --- a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt

> > +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt

> > @@ -8,8 +8,12 @@ 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.

> >

> > +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-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"

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

> > +	      "xlnx,axi-cdma-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.

> > @@ -80,6 +84,18 @@ axi_dma_0: axidma@40400000 {

> >  	} ;

> >  } ;

> >

> > +axi_cdma_0: axicdma@7e200000 {

> > +       compatible = "xlnx,axi-cdma-1.00.a";

> > +       #dma-cells = <1>;

> > +       reg = < 0x7e200000 0x10000 >;

> > +       xlnx,addrwidth = <0x20>;

> > +       dma-channel@7e200000 {

> > +               compatible = "xlnx,axi-dma-mm2s-channel";

> > +               interrupts = < 0 55 4 >;

> > +               xlnx,datawidth = <0x40>;

> > +       } ;

> > +} ;

> 

> As in the other patch, the node name should be 'dma-controller@...' and the

> inconsistend spacing could be fixed.


Ok will fix...

> 

> Also, it seems this adds pretty much identical examples that just differ in the

> compat string. Is that really needed?


Most of the properties are same across the three DMA's
For AXI VDMA there are few required properties that are not required for AXI DMA/CDMA.
That's why added example for the other IP's as well I mean for AXI DMA and CDMA.

Regards,
Kedar.

> 

> 	Sören
Rob Herring March 28, 2016, 8:55 p.m. UTC | #3
On Mon, Mar 28, 2016 at 05:27:01AM +0000, Appana Durga Kedareswara Rao wrote:
> Hi Soren,
> 
> > -----Original Message-----
> > From: Sören Brinkmann [mailto:soren.brinkmann@xilinx.com]
> > Sent: Monday, March 28, 2016 12:58 AM
> > To: Appana Durga Kedareswara Rao
> > Cc: robh+dt@kernel.org; pawel.moll@arm.com; mark.rutland@arm.com;
> > ijc+devicetree@hellion.org.uk; galak@codeaurora.org; Michal Simek;
> > vinod.koul@intel.com; dan.j.williams@intel.com; Anurag Kumar Vulisha; Appana
> > Durga Kedareswara Rao; moritz.fischer@ettus.com;
> > laurent.pinchart@ideasonboard.com; luis@debethencourt.com; Srikanth
> > Vemula; Anirudha Sarangi; devicetree@vger.kernel.org; linux-arm-
> > kernel@lists.infradead.org; linux-kernel@vger.kernel.org;
> > dmaengine@vger.kernel.org
> > Subject: Re: [PATCH v2 5/6] Documentation: DT: vdma: update binding doc for
> > AXI CDMA
> > 
> > On Sun, 2016-03-27 at 23:36:06 +0530, Kedareswara rao Appana wrote:
> > > This patch updates the device-tree binding doc for adding support for
> > > AXI CDMA.
> > >
> > > Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
> > > ---
> > > ---> Modified commit message as suggested by Vinod.
> > > ---> Moved the patch to forward in the series as suggested by vinod.
> > >
> > >  .../devicetree/bindings/dma/xilinx/xilinx_vdma.txt     | 18
> > +++++++++++++++++-
> > >  1 file changed, 17 insertions(+), 1 deletion(-)
> > >
> > > diff --git
> > > a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > index 5841421..2b0c12b 100644
> > > --- a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > @@ -8,8 +8,12 @@ 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.
> > >
> > > +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-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"
> > > +- compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a" or
> > > +	      "xlnx,axi-cdma-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.
> > > @@ -80,6 +84,18 @@ axi_dma_0: axidma@40400000 {
> > >  	} ;
> > >  } ;
> > >
> > > +axi_cdma_0: axicdma@7e200000 {
> > > +       compatible = "xlnx,axi-cdma-1.00.a";
> > > +       #dma-cells = <1>;
> > > +       reg = < 0x7e200000 0x10000 >;
> > > +       xlnx,addrwidth = <0x20>;
> > > +       dma-channel@7e200000 {
> > > +               compatible = "xlnx,axi-dma-mm2s-channel";
> > > +               interrupts = < 0 55 4 >;
> > > +               xlnx,datawidth = <0x40>;
> > > +       } ;
> > > +} ;
> > 
> > As in the other patch, the node name should be 'dma-controller@...' and the
> > inconsistend spacing could be fixed.
> 
> Ok will fix...
> 
> > 
> > Also, it seems this adds pretty much identical examples that just differ in the
> > compat string. Is that really needed?
> 
> Most of the properties are same across the three DMA's
> For AXI VDMA there are few required properties that are not required for AXI DMA/CDMA.
> That's why added example for the other IP's as well I mean for AXI DMA and CDMA.

It needs to be clear what properties are required/valid for each 
compatible string rather than relying on examples. I should be able to 
write or validate the examples based on the rest of the text.

Rob
Appana Durga Kedareswara rao March 29, 2016, 5:48 a.m. UTC | #4
Hi Rob,

> -----Original Message-----
> From: Rob Herring [mailto:robh@kernel.org]
> Sent: Tuesday, March 29, 2016 2:26 AM
> To: Appana Durga Kedareswara Rao
> Cc: Soren Brinkmann; pawel.moll@arm.com; mark.rutland@arm.com;
> ijc+devicetree@hellion.org.uk; galak@codeaurora.org; Michal Simek;
> vinod.koul@intel.com; dan.j.williams@intel.com; Anurag Kumar Vulisha;
> moritz.fischer@ettus.com; laurent.pinchart@ideasonboard.com;
> luis@debethencourt.com; Srikanth Vemula; Anirudha Sarangi;
> devicetree@vger.kernel.org; linux-arm-kernel@lists.infradead.org; linux-
> kernel@vger.kernel.org; dmaengine@vger.kernel.org
> Subject: Re: [PATCH v2 5/6] Documentation: DT: vdma: update binding doc for
> AXI CDMA
> 
> On Mon, Mar 28, 2016 at 05:27:01AM +0000, Appana Durga Kedareswara Rao
> wrote:
> > Hi Soren,
> >
> > > -----Original Message-----
> > > From: Sören Brinkmann [mailto:soren.brinkmann@xilinx.com]
> > > Sent: Monday, March 28, 2016 12:58 AM
> > > To: Appana Durga Kedareswara Rao
> > > Cc: robh+dt@kernel.org; pawel.moll@arm.com; mark.rutland@arm.com;
> > > ijc+devicetree@hellion.org.uk; galak@codeaurora.org; Michal Simek;
> > > vinod.koul@intel.com; dan.j.williams@intel.com; Anurag Kumar
> > > Vulisha; Appana Durga Kedareswara Rao; moritz.fischer@ettus.com;
> > > laurent.pinchart@ideasonboard.com; luis@debethencourt.com; Srikanth
> > > Vemula; Anirudha Sarangi; devicetree@vger.kernel.org; linux-arm-
> > > kernel@lists.infradead.org; linux-kernel@vger.kernel.org;
> > > dmaengine@vger.kernel.org
> > > Subject: Re: [PATCH v2 5/6] Documentation: DT: vdma: update binding
> > > doc for AXI CDMA
> > >
> > > On Sun, 2016-03-27 at 23:36:06 +0530, Kedareswara rao Appana wrote:
> > > > This patch updates the device-tree binding doc for adding support
> > > > for AXI CDMA.
> > > >
> > > > Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
> > > > ---
> > > > ---> Modified commit message as suggested by Vinod.
> > > > ---> Moved the patch to forward in the series as suggested by vinod.
> > > >
> > > >  .../devicetree/bindings/dma/xilinx/xilinx_vdma.txt     | 18
> > > +++++++++++++++++-
> > > >  1 file changed, 17 insertions(+), 1 deletion(-)
> > > >
> > > > diff --git
> > > > a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > > b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > > index 5841421..2b0c12b 100644
> > > > --- a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > > +++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
> > > > @@ -8,8 +8,12 @@ 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.
> > > >
> > > > +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-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"
> > > > +- compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"
> or
> > > > +	      "xlnx,axi-cdma-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.
> > > > @@ -80,6 +84,18 @@ axi_dma_0: axidma@40400000 {
> > > >  	} ;
> > > >  } ;
> > > >
> > > > +axi_cdma_0: axicdma@7e200000 {
> > > > +       compatible = "xlnx,axi-cdma-1.00.a";
> > > > +       #dma-cells = <1>;
> > > > +       reg = < 0x7e200000 0x10000 >;
> > > > +       xlnx,addrwidth = <0x20>;
> > > > +       dma-channel@7e200000 {
> > > > +               compatible = "xlnx,axi-dma-mm2s-channel";
> > > > +               interrupts = < 0 55 4 >;
> > > > +               xlnx,datawidth = <0x40>;
> > > > +       } ;
> > > > +} ;
> > >
> > > As in the other patch, the node name should be 'dma-controller@...'
> > > and the inconsistend spacing could be fixed.
> >
> > Ok will fix...
> >
> > >
> > > Also, it seems this adds pretty much identical examples that just
> > > differ in the compat string. Is that really needed?
> >
> > Most of the properties are same across the three DMA's For AXI VDMA
> > there are few required properties that are not required for AXI DMA/CDMA.
> > That's why added example for the other IP's as well I mean for AXI DMA and
> CDMA.
> 
> It needs to be clear what properties are required/valid for each compatible
> string rather than relying on examples. I should be able to write or validate the
> examples based on the rest of the text.

Ok will fix it in the next version of the patch.

Regards,
Kedar.

> 
> Rob
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
index 5841421..2b0c12b 100644
--- a/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
+++ b/Documentation/devicetree/bindings/dma/xilinx/xilinx_vdma.txt
@@ -8,8 +8,12 @@  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.
 
+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-vdma-1.00.a" or "xlnx,axi-dma-1.00.a"
+- compatible: Should be "xlnx,axi-vdma-1.00.a" or "xlnx,axi-dma-1.00.a" or
+	      "xlnx,axi-cdma-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.
@@ -80,6 +84,18 @@  axi_dma_0: axidma@40400000 {
 	} ;
 } ;
 
+axi_cdma_0: axicdma@7e200000 {
+       compatible = "xlnx,axi-cdma-1.00.a";
+       #dma-cells = <1>;
+       reg = < 0x7e200000 0x10000 >;
+       xlnx,addrwidth = <0x20>;
+       dma-channel@7e200000 {
+               compatible = "xlnx,axi-dma-mm2s-channel";
+               interrupts = < 0 55 4 >;
+               xlnx,datawidth = <0x40>;
+       } ;
+} ;
+
 * DMA client
 
 Required properties: