Re: [RESEND PATCH 2/6] Documentation: bindings: add dt doc for Rockchip USB Type-C PHY

Rob Herring
2016-06-01T14:54:04Z

On Fri, May 27, 2016 at 06:45:38PM +0800, Chris Zhong wrote:
> This patch adds a binding that describes the Rockchip USB Type-C PHY
> for rk3399.
>
> Signed-off-by: Chris Zhong <zyw@rock-chips.com>
> ---
>
> .../devicetree/bindings/phy/phy-rockchip-typec.txt | 55 ++++++++++++++++++++++
> 1 file changed, 55 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt
>
> diff --git a/Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt b/Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt
> new file mode 100644
> index 0000000..402f667
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/phy-rockchip-typec.txt
> @@ -0,0 +1,55 @@
> +ROCKCHIP type-c PHY
> +
> +Required properties:
> + - compatible: should be "rockchip,rk3399-typec-phy"
> + - reg : Address and length of the usb phy control register set
> + - rockchip,grf : phandle to the syscon managing the "general
> + register files"
> + - clocks : phandle + clock specifier for the phy clocks
> + - clock-names: string, clock name, must be "tcpdcore", "tcpdphy_ref";
> + - resets : a list of phandle + reset specifier pairs
> + - reset-names : string reset name, must be:
> + "tcphy_rst", "tcphy_pipe_rst", "uphy_tcphy_rst"
> + - #phy-cells: Must be 0. See ./phy-bindings.txt for details.
> + - rockchip,usb3phy*: phy registers embed in grf

You need to document each one and state the number of cells and what the
contain. Also, don't use '_' in the names.

> +
> +Example:
> + tcphy0: phy@ff7c0000 {
> + compatible = "rockchip,rk3399-typec-phy";
> + reg = <0x0 0xff7c0000 0x0 0x40000>;
> + #phy-cells = <0>;
> + rockchip,grf = <&grf>;
> + clocks = <&cru SCLK_UPHY0_TCPDCORE>,
> + <&cru SCLK_UPHY0_TCPDPHY_REF>;
> + clock-names = "tcpdcore", "tcpdphy_ref";
> + resets = <&cru SRST_UPHY0>,
> + <&cru SRST_UPHY0_PIPE_L00>,
> + <&cru SRST_P_UPHY0_TCPHY>;
> + reset-names = "tcphy_rst", "tcphy_pipe_rst", "uphy_tcphy_rst";
> + rockchip,usb3phy_con0 = <0x0e580 0 16>;
> + rockchip,usb3phy_con1 = <0x0e584 0 16>;
> + rockchip,usb3phy_con2 = <0x0e588 0 16>;
> + rockchip,usb3phy_status0 = <0x0e5c0 0 13>;
> + rockchip,usb3phy_status1 = <0x0e5c4 0 12>;
> + status = "disabled";
> + };
> +
> + tcphy1: phy@ff800000 {
> + compatible = "rockchip,rk3399-typec-phy";
> + reg = <0x0 0xff800000 0x0 0x40000>;
> + #phy-cells = <0>;
> + rockchip,grf = <&grf>;
> + clocks = <&cru SCLK_UPHY1_TCPDCORE>,
> + <&cru SCLK_UPHY1_TCPDPHY_REF>;
> + clock-names = "tcpdcore", "tcpdphy_ref";
> + resets = <&cru SRST_UPHY1>,
> + <&cru SRST_UPHY1_PIPE_L00>,
> + <&cru SRST_P_UPHY1_TCPHY>;
> + reset-names = "tcphy_rst", "tcphy_pipe_rst", "uphy_tcphy_rst";
> + rockchip,usb3phy_con0 = <0x0e58c 0 16>;
> + rockchip,usb3phy_con1 = <0x0e590 0 16>;
> + rockchip,usb3phy_con2 = <0x0e594 0 16>;
> + rockchip,usb3phy_status0 = <0x0e5c0 16 13>;
> + rockchip,usb3phy_status1 = <0x0e5c4 16 12>;
> + status = "disabled";
> + };
> --
> 2.6.3
>