diff mbox

[2/8] usb: bdc: Add Device Tree binding document for Broadcom BDC driver

Message ID 1498587806-24781-3-git-send-email-alcooperx@gmail.com
State Changes Requested, archived
Headers show

Commit Message

Alan Cooper June 27, 2017, 6:23 p.m. UTC
Add Device Tree binding document for Broadcom USB Device
Controller (BDC).

Signed-off-by: Al Cooper <alcooperx@gmail.com>
---
 .../devicetree/bindings/usb/brcm,bdc-udc.txt       | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt

Comments

Rob Herring July 6, 2017, 2:18 p.m. UTC | #1
On Tue, Jun 27, 2017 at 02:23:20PM -0400, Al Cooper wrote:
> Add Device Tree binding document for Broadcom USB Device
> Controller (BDC).
> 
> Signed-off-by: Al Cooper <alcooperx@gmail.com>
> ---
>  .../devicetree/bindings/usb/brcm,bdc-udc.txt       | 28 ++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
> 
> diff --git a/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
> new file mode 100644
> index 0000000..4eeaddb
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
> @@ -0,0 +1,28 @@
> +Broadcom USB Device Controller (BDC)
> +====================================
> +
> +Required properties:
> +
> +- compatible: must be one of:
> +                "brcm,bdc-udc-v0.16"
> +                "brcm,bdc-udc"

Isn't "bdc-udc" redundant?

Where does the version number come from?

> +- reg: the base register address and length
> +- interrupts: ther interrupt line for this controller

s/ther/the/

> +
> +Optional properties:
> +
> +On Broadcom STB platforms, these properties are required:
> +
> +- phys: phandle to the USB PHY blocks

How many?

> +- clocks: phandle to the functional clock of this block
> +
> +Example:
> +
> +        udc@f0b02000 {
> +                status = "disabled";

Don't show status in examples.

> +                compatible = "brcm,bdc-udc-v0.16";
> +                reg = <0xf0b02000 0xfc4>;
> +                interrupts = <0x0 0x60 0x0>;
> +                phys = <&usbphy_0 0x0>;
> +                clocks = <&sw_usbd>;
> +        };
> -- 
> 1.9.0.138.g2de3478
> 
--
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
Rob Herring July 6, 2017, 2:19 p.m. UTC | #2
On Tue, Jun 27, 2017 at 02:23:20PM -0400, Al Cooper wrote:
> Add Device Tree binding document for Broadcom USB Device
> Controller (BDC).

Also, "dt-bindings: usb: ..." for the subject.
--
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
Rob Herring July 7, 2017, 8:15 p.m. UTC | #3
Please only post plain text emails.

On Fri, Jul 7, 2017 at 2:03 PM, Al Cooper <al.cooper@broadcom.com> wrote:
>
>
> On Thu, Jul 6, 2017 at 10:18 AM, Rob Herring <robh@kernel.org> wrote:
>>
>> On Tue, Jun 27, 2017 at 02:23:20PM -0400, Al Cooper wrote:
>> > Add Device Tree binding document for Broadcom USB Device
>> > Controller (BDC).
>> >
>> > Signed-off-by: Al Cooper <alcooperx@gmail.com>
>> > ---
>> >  .../devicetree/bindings/usb/brcm,bdc-udc.txt       | 28 ++++++++++++++++++++++
>> >  1 file changed, 28 insertions(+)
>> >  create mode 100644 Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
>> >
>> > diff --git a/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
>> > new file mode 100644
>> > index 0000000..4eeaddb
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
>> > @@ -0,0 +1,28 @@
>> > +Broadcom USB Device Controller (BDC)
>> > +====================================
>> > +
>> > +Required properties:
>> > +
>> > +- compatible: must be one of:
>> > +                "brcm,bdc-udc-v0.16"
>> > +                "brcm,bdc-udc"
>>
>> Isn't "bdc-udc" redundant?
>
>
> I'll change the base name to "brcm-udc"

Well, it should be "brcm,<something>" with the vendor prefix followed
by a comma. If the block is known as the BDC, then I'd use that.

Rob
--
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/brcm,bdc-udc.txt b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
new file mode 100644
index 0000000..4eeaddb
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/brcm,bdc-udc.txt
@@ -0,0 +1,28 @@ 
+Broadcom USB Device Controller (BDC)
+====================================
+
+Required properties:
+
+- compatible: must be one of:
+                "brcm,bdc-udc-v0.16"
+                "brcm,bdc-udc"
+- reg: the base register address and length
+- interrupts: ther interrupt line for this controller
+
+Optional properties:
+
+On Broadcom STB platforms, these properties are required:
+
+- phys: phandle to the USB PHY blocks
+- clocks: phandle to the functional clock of this block
+
+Example:
+
+        udc@f0b02000 {
+                status = "disabled";
+                compatible = "brcm,bdc-udc-v0.16";
+                reg = <0xf0b02000 0xfc4>;
+                interrupts = <0x0 0x60 0x0>;
+                phys = <&usbphy_0 0x0>;
+                clocks = <&sw_usbd>;
+        };