diff mbox series

[1/5] dt-bindings: Add Broadcom STB OHCI, EHCI and XHCI binding document

Message ID 1538000414-24873-2-git-send-email-alcooperx@gmail.com
State Changes Requested, archived
Headers show
Series Add XHCI, EHCI and OHCI drivers for Broadcom STB SoCs | expand

Checks

Context Check Description
robh/checkpatch success

Commit Message

Alan Cooper Sept. 26, 2018, 10:20 p.m. UTC
Add DT bindings document for Broadcom STB USB OHCI, EHCI and
XHCI drivers.

Signed-off-by: Al Cooper <alcooperx@gmail.com>
---
 .../devicetree/bindings/usb/brcm,ehci-brcm.txt     | 22 +++++++++++++++++++++
 .../devicetree/bindings/usb/brcm,ohci-brcm.txt     | 22 +++++++++++++++++++++
 .../devicetree/bindings/usb/brcm,xhci-brcm.txt     | 23 ++++++++++++++++++++++
 3 files changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
 create mode 100644 Documentation/devicetree/bindings/usb/brcm,ohci-brcm.txt
 create mode 100644 Documentation/devicetree/bindings/usb/brcm,xhci-brcm.txt

Comments

Rob Herring Oct. 15, 2018, 6:22 p.m. UTC | #1
On Wed, Sep 26, 2018 at 06:20:10PM -0400, Al Cooper wrote:
> Add DT bindings document for Broadcom STB USB OHCI, EHCI and
> XHCI drivers.
> 
> Signed-off-by: Al Cooper <alcooperx@gmail.com>
> ---
>  .../devicetree/bindings/usb/brcm,ehci-brcm.txt     | 22 +++++++++++++++++++++
>  .../devicetree/bindings/usb/brcm,ohci-brcm.txt     | 22 +++++++++++++++++++++
>  .../devicetree/bindings/usb/brcm,xhci-brcm.txt     | 23 ++++++++++++++++++++++
>  3 files changed, 67 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/brcm,ohci-brcm.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/brcm,xhci-brcm.txt
> 
> diff --git a/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt b/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
> new file mode 100644
> index 000000000000..020b5ec40f5b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
> @@ -0,0 +1,22 @@
> +Broadcom STB USB EHCI controller
> +
> +Required properties:
> +- compatible: should be "brcm,ehci-brcm-v2"

Needs an SoC specific compatible string.

> +- reg: should contain one register range i.e. start and length
> +- interrupts: description of the interrupt line
> +- phys: phandle + phy specifier pair
> +  The specifier should be 0 for the OHCI/EHCI PHY and 1 for the XHCI PHY

0 or 1 depends on the phy binding. This binding just needs to say how 
many phy specifiers there are.

> +
> +Optional properties:
> +- clocks: A list of phandles for the clocks

Need to say how many and the order.

> +
> +Example:
> +
> +ehci@f0b00300 {
> +	compatible = "brcm,ehci-brcm-v2";
> +	reg = <0xf0b00300 0xa8>;
> +	interrupts = <0x0 0x5a 0x0>;
> +	interrupt-names = "usb0_ehci_0";
> +	phys = <&usbphy_0 0x0>;
> +	clocks = <&usb20>
> +};

Similar comments in the other 2 files.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt b/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
new file mode 100644
index 000000000000..020b5ec40f5b
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/brcm,ehci-brcm.txt
@@ -0,0 +1,22 @@ 
+Broadcom STB USB EHCI controller
+
+Required properties:
+- compatible: should be "brcm,ehci-brcm-v2"
+- reg: should contain one register range i.e. start and length
+- interrupts: description of the interrupt line
+- phys: phandle + phy specifier pair
+  The specifier should be 0 for the OHCI/EHCI PHY and 1 for the XHCI PHY
+
+Optional properties:
+- clocks: A list of phandles for the clocks
+
+Example:
+
+ehci@f0b00300 {
+	compatible = "brcm,ehci-brcm-v2";
+	reg = <0xf0b00300 0xa8>;
+	interrupts = <0x0 0x5a 0x0>;
+	interrupt-names = "usb0_ehci_0";
+	phys = <&usbphy_0 0x0>;
+	clocks = <&usb20>
+};
diff --git a/Documentation/devicetree/bindings/usb/brcm,ohci-brcm.txt b/Documentation/devicetree/bindings/usb/brcm,ohci-brcm.txt
new file mode 100644
index 000000000000..c7bb56f30540
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/brcm,ohci-brcm.txt
@@ -0,0 +1,22 @@ 
+Broadcom STB USB OHCI controller
+
+Required properties:
+- compatible: should be "brcm,ohci-brcm-v2"
+- reg: should contain one register range i.e. start and length
+- interrupts: description of the interrupt line
+- phys: phandle + phy specifier pair
+  The specifier should be 0 for the OHCI/EHCI PHY and 1 for the XHCI PHY
+
+Optional properties:
+- clocks: A list of phandles for the clocks
+
+Example:
+
+ohci@f0b00400 {
+	compatible = "brcm,ohci-brcm-v2";
+	reg = <0xf0b00400 0x58>;
+	interrupts = <0x0 0x5b 0x0>;
+	interrupt-names = "usb0_ohci_0";
+	phys = <&usbphy_0 0x0>;
+	clocks = <&usb20>;
+};
diff --git a/Documentation/devicetree/bindings/usb/brcm,xhci-brcm.txt b/Documentation/devicetree/bindings/usb/brcm,xhci-brcm.txt
new file mode 100644
index 000000000000..7ca5f126c2f6
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/brcm,xhci-brcm.txt
@@ -0,0 +1,23 @@ 
+Broadcom STB USB XHCI controller
+
+Required properties:
+- compatible: should be "brcm,xhci-brcm-v2"
+- reg: should contain one register range i.e. start and length
+- interrupts: description of the interrupt line
+- phys: phandle + phy specifier pair
+  The specifier should be 0 for the OHCI/EHCI PHY and 1 for the XHCI PHY
+
+Optional properties:
+- clocks: A list of phandles for the clocks
+- usb3-lpm-capable: determines if platform is USB3 LPM capable
+
+Example:
+
+xhci_0_0: xhci@f0b01000 {
+	compatible = "brcm,xhci-brcm-v2";
+	reg = <0xf0b01000 0x1000>;
+	interrupts = <0x0 0x5c 0x0>;
+	interrupt-names = "usb0_xhci_0";
+	phys = <&usbphy_0 0x1>;
+	clocks = <&usb30>;
+};