diff mbox

[2/3] dt-bindings: Add Broadcom STB USB PHY binding document

Message ID 1496426512-10590-3-git-send-email-alcooperx@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Alan Cooper June 2, 2017, 6:01 p.m. UTC
Add DT bindings document for Broadcom STB USB PHYs

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

Comments

Kishon Vijay Abraham I June 7, 2017, 12:32 p.m. UTC | #1
Hi,

On Friday 02 June 2017 11:31 PM, Al Cooper wrote:
> Add DT bindings document for Broadcom STB USB PHYs
> 
> Signed-off-by: Al Cooper <alcooperx@gmail.com>
> ---
>  .../bindings/phy/brcm,brcmstb-usb-phy.txt          | 37 ++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> 
> diff --git a/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> new file mode 100644
> index 0000000..e1e9b16
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> @@ -0,0 +1,37 @@
> +Broadcom STB USB PHY
> +
> +Required properties:
> + - compatible: brcm,brcmstb-usb-phy
> + - reg: two offset and length pairs. The second pair specifies optional
> +        registers used by some of the SoCs that support USB 3.x

and the first pair?
> + - #phy-cells: Shall be 1 as it expects one argument for setting
> +	       the type of the PHY. Possible values are 0 (1.1 and 2.0),
> +	       1 (3.x)

It should use PHY_TYPE_USB2 or PHY_TYPE_USB3 (see include/dt-bindings/phy/phy.h).

Thanks
Kishon
Rob Herring June 8, 2017, 10:11 p.m. UTC | #2
On Fri, Jun 02, 2017 at 02:01:51PM -0400, Al Cooper wrote:
> Add DT bindings document for Broadcom STB USB PHYs
> 
> Signed-off-by: Al Cooper <alcooperx@gmail.com>
> ---
>  .../bindings/phy/brcm,brcmstb-usb-phy.txt          | 37 ++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> 
> diff --git a/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> new file mode 100644
> index 0000000..e1e9b16
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
> @@ -0,0 +1,37 @@
> +Broadcom STB USB PHY
> +
> +Required properties:
> + - compatible: brcm,brcmstb-usb-phy
> + - reg: two offset and length pairs. The second pair specifies optional
> +        registers used by some of the SoCs that support USB 3.x
> + - #phy-cells: Shall be 1 as it expects one argument for setting
> +	       the type of the PHY. Possible values are 0 (1.1 and 2.0),
> +	       1 (3.x)
> +
> +Optional Properties:
> +- clocks : clock phandles.
> +- clock-names: String, clock name.
> +- brcm,ipp: Boolean, Invert Port Power.
> +  Possible values are: 0 (Don't invert), 1 (Invert)
> +- brcm,ioc: Boolean, Invert Over Current detection.
> +  Possible values are: 0 (Don't invert), 1 (Invert)
> +- brcm,has-xhci: Boolean indicating an optional 3.x only XHCI controller.
> +- brcm,has-xhci-only: Boolean indicating an XHCI controller that supports
> +  1.1, 2.0 and 3.0 devices
> +- brcm,device: String, PHY Device mode.
> +  Possible values are: off (Host), on (Device), dual (DRD)
> +  or typec-pd (Type-C PD control)

I believe we have standard property for this though maybe not type C.

off/on seem strange for meaning host/device as well.

> +
> +Example:
> +
> +usbphy_0: usb-phy@f0470200 {
> +	reg = <0xf0470200 0xb8>,
> +		<0xf0471940 0x6c0>;
> +	compatible = "brcm,brcmstb-usb-phy";
> +	#phy-cells = <1>;
> +	brcm,ioc = <1>;
> +	brcm,ipp = <1>;
> +	brcm,has-xhci;
> +	clocks = <&usb20>, <&usb30>;
> +	clock-names = "sw_usb", "sw_usb3";
> +};
> -- 
> 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
Al Cooper June 12, 2017, 8:19 p.m. UTC | #3
On Thu, Jun 8, 2017 at 6:11 PM, Rob Herring <robh@kernel.org> wrote:
>> +- brcm,device: String, PHY Device mode.
>> +  Possible values are: off (Host), on (Device), dual (DRD)
>> +  or typec-pd (Type-C PD control)
>
> I believe we have standard property for this though maybe not type C.
>
> off/on seem strange for meaning host/device as well.

I'll change this to:

mode: String, PHY Device mode.
Possible values are: "host", "device", "drd" or "typec-pd"

Al
Al Cooper June 12, 2017, 8:53 p.m. UTC | #4
On Mon, Jun 12, 2017 at 4:19 PM, Al Cooper <al.cooper@broadcom.com> wrote:
> On Thu, Jun 8, 2017 at 6:11 PM, Rob Herring <robh@kernel.org> wrote:
>>> +- brcm,device: String, PHY Device mode.
>>> +  Possible values are: off (Host), on (Device), dual (DRD)
>>> +  or typec-pd (Type-C PD control)
>>
>> I believe we have standard property for this though maybe not type C.
>>
>> off/on seem strange for meaning host/device as well.
>
> I'll change this to:
>
> mode: String, PHY Device mode.
> Possible values are: "host", "device", "drd" or "typec-pd"

I just found "dr_mode" in Documentation/devicetree/bindings/usb/generic.txt.
I'd like to change this to:

dr_mode: String, PHY Device mode.
Possible values are: "host", "device", "drd" or "typec-pd"

I used a standard property name ("dr_mode") and 2 of the standard
values ("host", "device") and added 2 new values "drd" and "typec_pd".

Thanks
Al
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
new file mode 100644
index 0000000..e1e9b16
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/brcm,brcmstb-usb-phy.txt
@@ -0,0 +1,37 @@ 
+Broadcom STB USB PHY
+
+Required properties:
+ - compatible: brcm,brcmstb-usb-phy
+ - reg: two offset and length pairs. The second pair specifies optional
+        registers used by some of the SoCs that support USB 3.x
+ - #phy-cells: Shall be 1 as it expects one argument for setting
+	       the type of the PHY. Possible values are 0 (1.1 and 2.0),
+	       1 (3.x)
+
+Optional Properties:
+- clocks : clock phandles.
+- clock-names: String, clock name.
+- brcm,ipp: Boolean, Invert Port Power.
+  Possible values are: 0 (Don't invert), 1 (Invert)
+- brcm,ioc: Boolean, Invert Over Current detection.
+  Possible values are: 0 (Don't invert), 1 (Invert)
+- brcm,has-xhci: Boolean indicating an optional 3.x only XHCI controller.
+- brcm,has-xhci-only: Boolean indicating an XHCI controller that supports
+  1.1, 2.0 and 3.0 devices
+- brcm,device: String, PHY Device mode.
+  Possible values are: off (Host), on (Device), dual (DRD)
+  or typec-pd (Type-C PD control)
+
+Example:
+
+usbphy_0: usb-phy@f0470200 {
+	reg = <0xf0470200 0xb8>,
+		<0xf0471940 0x6c0>;
+	compatible = "brcm,brcmstb-usb-phy";
+	#phy-cells = <1>;
+	brcm,ioc = <1>;
+	brcm,ipp = <1>;
+	brcm,has-xhci;
+	clocks = <&usb20>, <&usb30>;
+	clock-names = "sw_usb", "sw_usb3";
+};