diff mbox

[v3,1/2] usb: doc: udc-xilinx: Add devicetree bindings

Message ID b0dfcba4-7319-4687-a455-bfcddf61b7d1@BN1AFFO11FD028.protection.gbl
State Superseded, archived
Headers show

Commit Message

Subbaraya Sundeep Bhatta June 10, 2014, 12:04 p.m. UTC
From: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>

Add devicetree bindings for Xilinx axi udc driver.

Signed-off-by: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
---
Changes for v3:
	- None
Changes for v2:
	- replaced xlnx,include-dma with xlnx,has-builtin-dma

 .../devicetree/bindings/usb/udc-xilinx.txt         |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/usb/udc-xilinx.txt

Comments

sundeep subbaraya June 24, 2014, 6:44 a.m. UTC | #1
Ping

Thanks,
Sundeep.B.S.

On Tue, Jun 10, 2014 at 5:34 PM,  <subbaraya.sundeep.bhatta@xilinx.com> wrote:
> From: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
>
> Add devicetree bindings for Xilinx axi udc driver.
>
> Signed-off-by: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> ---
> Changes for v3:
>         - None
> Changes for v2:
>         - replaced xlnx,include-dma with xlnx,has-builtin-dma
>
>  .../devicetree/bindings/usb/udc-xilinx.txt         |   20 ++++++++++++++++++++
>  1 files changed, 20 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/usb/udc-xilinx.txt
>
> diff --git a/Documentation/devicetree/bindings/usb/udc-xilinx.txt b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
> new file mode 100644
> index 0000000..7c24fac
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
> @@ -0,0 +1,20 @@
> +Xilinx AXI USB2 device controller
> +
> +Required properties:
> +- compatible           : Should be "xlnx,axi-usb2-device-4.00.a"
> +- reg                  : Physical base address and size of the Axi USB2
> +                         device registers map.
> +- interrupts           : Property with a value describing the interrupt
> +                         number.
> +- interrupt-parent     : Must be core interrupt controller
> +- xlnx,include-dma     : if DMA is included
> +
> +Example:
> +               axi-usb2-device@42e00000 {
> +                        compatible = "xlnx,axi-usb2-device-4.00.a";
> +                        interrupt-parent = <0x1>;
> +                        interrupts = <0x0 0x39 0x1>;
> +                        reg = <0x42e00000 0x10000>;
> +                        xlnx,has-builtin-dma;
> +                };
> +
> --
> 1.7.4
>
>
> --
> 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 devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Mark Rutland July 4, 2014, 4:40 p.m. UTC | #2
On Tue, Jun 24, 2014 at 07:44:10AM +0100, sundeep subbaraya wrote:
> Ping
> 
> Thanks,
> Sundeep.B.S.
> 
> On Tue, Jun 10, 2014 at 5:34 PM,  <subbaraya.sundeep.bhatta@xilinx.com> wrote:
> > From: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> >
> > Add devicetree bindings for Xilinx axi udc driver.
> >
> > Signed-off-by: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> > ---
> > Changes for v3:
> >         - None
> > Changes for v2:
> >         - replaced xlnx,include-dma with xlnx,has-builtin-dma
> >
> >  .../devicetree/bindings/usb/udc-xilinx.txt         |   20 ++++++++++++++++++++
> >  1 files changed, 20 insertions(+), 0 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/usb/udc-xilinx.txt
> >
> > diff --git a/Documentation/devicetree/bindings/usb/udc-xilinx.txt b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
> > new file mode 100644
> > index 0000000..7c24fac
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
> > @@ -0,0 +1,20 @@
> > +Xilinx AXI USB2 device controller
> > +
> > +Required properties:
> > +- compatible           : Should be "xlnx,axi-usb2-device-4.00.a"

That's an interesting name. What's the product name? Is the a manual?

> > +- reg                  : Physical base address and size of the Axi USB2
> > +                         device registers map.
> > +- interrupts           : Property with a value describing the interrupt
> > +                         number.

Describe what this logically is. Everyone knows that this is a property
with a value, and everyone knows that an interrupts property describes
interrupts.

The ket point is _which_ interrupts this describes.

> > +- interrupt-parent     : Must be core interrupt controller

This isn't strictly necessary anyway.

> > +- xlnx,include-dma     : if DMA is included

You appear to have forgotten to fix this name, judging by the changelog
and example.

> > +
> > +Example:
> > +               axi-usb2-device@42e00000 {
> > +                        compatible = "xlnx,axi-usb2-device-4.00.a";
> > +                        interrupt-parent = <0x1>;

Huh? Who writes a raw phandle value?

> > +                        interrupts = <0x0 0x39 0x1>;
> > +                        reg = <0x42e00000 0x10000>;
> > +                        xlnx,has-builtin-dma;

As mentioned above, this conflicts with the binding documentation.
Please ensure the example is aligned with the documentation.

Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
sundeep subbaraya July 7, 2014, 6:25 a.m. UTC | #3
Hi,

On Fri, Jul 4, 2014 at 10:10 PM, Mark Rutland <mark.rutland@arm.com> wrote:
> On Tue, Jun 24, 2014 at 07:44:10AM +0100, sundeep subbaraya wrote:
>> Ping
>>
>> Thanks,
>> Sundeep.B.S.
>>
>> On Tue, Jun 10, 2014 at 5:34 PM,  <subbaraya.sundeep.bhatta@xilinx.com> wrote:
>> > From: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
>> >
>> > Add devicetree bindings for Xilinx axi udc driver.
>> >
>> > Signed-off-by: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
>> > ---
>> > Changes for v3:
>> >         - None
>> > Changes for v2:
>> >         - replaced xlnx,include-dma with xlnx,has-builtin-dma
>> >
>> >  .../devicetree/bindings/usb/udc-xilinx.txt         |   20 ++++++++++++++++++++
>> >  1 files changed, 20 insertions(+), 0 deletions(-)
>> >  create mode 100644 Documentation/devicetree/bindings/usb/udc-xilinx.txt
>> >
>> > diff --git a/Documentation/devicetree/bindings/usb/udc-xilinx.txt b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
>> > new file mode 100644
>> > index 0000000..7c24fac
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
>> > @@ -0,0 +1,20 @@
>> > +Xilinx AXI USB2 device controller
>> > +
>> > +Required properties:
>> > +- compatible           : Should be "xlnx,axi-usb2-device-4.00.a"
>
> That's an interesting name. What's the product name? Is the a manual?

Here is the manual for the IP :

http://www.xilinx.com/support/documentation/ip_documentation/axi_usb2_device/v5_0/pg137-axi-usb2-device.pdf

This driver works with PLB IP version that's why maybe make more sense
to use skip axi from compatible string and use just
xlnx,usb2-device-4.00.a.

>
>> > +- reg                  : Physical base address and size of the Axi USB2
>> > +                         device registers map.
>> > +- interrupts           : Property with a value describing the interrupt
>> > +                         number.
>
> Describe what this logically is. Everyone knows that this is a property
> with a value, and everyone knows that an interrupts property describes
> interrupts.
>
> The ket point is _which_ interrupts this describes.

Ok

>
>> > +- interrupt-parent     : Must be core interrupt controller
>
> This isn't strictly necessary anyway.
>
>> > +- xlnx,include-dma     : if DMA is included
>
> You appear to have forgotten to fix this name, judging by the changelog
> and example.
>
>> > +
>> > +Example:
>> > +               axi-usb2-device@42e00000 {
>> > +                        compatible = "xlnx,axi-usb2-device-4.00.a";
>> > +                        interrupt-parent = <0x1>;
>
> Huh? Who writes a raw phandle value?
>
>> > +                        interrupts = <0x0 0x39 0x1>;
>> > +                        reg = <0x42e00000 0x10000>;
>> > +                        xlnx,has-builtin-dma;
>
> As mentioned above, this conflicts with the binding documentation.
> Please ensure the example is aligned with the documentation.

Thank you for pointing this i sent an old one, will fix this.

Sundeep.B.S.

>
> Thanks,
> Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" 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/usb/udc-xilinx.txt b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
new file mode 100644
index 0000000..7c24fac
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/udc-xilinx.txt
@@ -0,0 +1,20 @@ 
+Xilinx AXI USB2 device controller
+
+Required properties:
+- compatible		: Should be "xlnx,axi-usb2-device-4.00.a"
+- reg			: Physical base address and size of the Axi USB2
+			  device registers map.
+- interrupts		: Property with a value describing the interrupt
+			  number.
+- interrupt-parent	: Must be core interrupt controller
+- xlnx,include-dma	: if DMA is included
+
+Example:
+ 		axi-usb2-device@42e00000 {
+                        compatible = "xlnx,axi-usb2-device-4.00.a";
+                        interrupt-parent = <0x1>;
+                        interrupts = <0x0 0x39 0x1>;
+                        reg = <0x42e00000 0x10000>;
+                        xlnx,has-builtin-dma;
+                };
+