[PATCH v2 03/12] dt-bindings: phy: add rockchip usbdp combo phy document

[Rob Herring]

On Tue, Feb 13, 2024 at 05:32:37PM +0100, Sebastian Reichel wrote:
> Add device tree binding document for Rockchip USBDP Combo PHY
> with Samsung IP block.
> 
> Co-developed-by: Frank Wang <frank.wang at rock-chips.com>
> Signed-off-by: Frank Wang <frank.wang at rock-chips.com>
> Signed-off-by: Sebastian Reichel <sebastian.reichel at collabora.com>
> ---
>  .../bindings/phy/phy-rockchip-usbdp.yaml      | 169 ++++++++++++++++++
>  1 file changed, 169 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml
> 
> diff --git a/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml
> new file mode 100644
> index 000000000000..4ac1825144d7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/phy-rockchip-usbdp.yaml
> @@ -0,0 +1,169 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/phy/phy-rockchip-usbdp.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Rockchip USBDP Combo PHY with Samsung IP block
> +
> +maintainers:
> +  - Frank Wang <frank.wang at rock-chips.com>
> +  - Zhang Yubing <yubing.zhang at rock-chips.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - rockchip,rk3588-usbdp-phy
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 4
> +
> +  clock-names:
> +    items:
> +      - const: refclk
> +      - const: immortal
> +      - const: pclk
> +      - const: utmi
> +
> +  resets:
> +    maxItems: 5
> +
> +  reset-names:
> +    items:
> +      - const: init
> +      - const: cmn
> +      - const: lane
> +      - const: pcs_apb
> +      - const: pma_apb
> +
> +  rockchip,dp-lane-mux:
> +    $ref: /schemas/types.yaml#/definitions/uint32-array
> +    minItems: 2
> +    maxItems: 4

items:
  maximum: 3

> +    description:
> +      An array of physical Type-C lanes indexes. Position of an entry
> +      determines the DisplayPort (DP) lane index, while the value of an entry
> +      indicates physical Type-C lane. The supported DP lanes number are 2 or 4.
> +      e.g. for 2 lanes DP lanes map, we could have "rockchip,dp-lane-mux = <2,
> +      3>;", assuming DP lane0 on Type-C phy lane2, DP lane1 on Type-C phy
> +      lane3. For 4 lanes DP lanes map, we could have "rockchip,dp-lane-mux =
> +      <0, 1, 2, 3>;", assuming DP lane0 on Type-C phy lane0, DP lane1 on Type-C
> +      phy lane1, DP lane2 on Type-C phy lane2, DP lane3 on Type-C phy lane3. If
> +      DP lane map by DisplayPort Alt mode, this property is not need.
> +
> +  rockchip,u2phy-grf:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      Phandle to the syscon managing the 'usb2 phy general register files'.
> +
> +  rockchip,usb-grf:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      Phandle to the syscon managing the 'usb general register files'.
> +
> +  rockchip,usbdpphy-grf:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      Phandle to the syscon managing the 'usbdp phy general register files'.
> +
> +  rockchip,vo-grf:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      Phandle to the syscon managing the 'video output general register files'.
> +      When select the DP lane mapping will request its phandle.
> +
> +  sbu1-dc-gpios:
> +    description:
> +      GPIO connected to the SBU1 line of the USB-C connector via a big resistor
> +      (~100K) to apply a DC offset for signalling the connector orientation.
> +    maxItems: 1
> +
> +  sbu2-dc-gpios:
> +    description:
> +      GPIO connected to the SBU2 line of the USB-C connector via a big resistor
> +      (~100K) to apply a DC offset for signalling the connector orientation.
> +    maxItems: 1
> +
> +  orientation-switch:
> +    description: Flag the port as possible handler of orientation switching
> +    type: boolean
> +
> +  mode-switch:
> +    description: Flag the port as possible handler of altmode switching
> +    type: boolean
> +
> +  dp-port:
> +    type: object
> +    additionalProperties: false
> +
> +    properties:
> +      "#phy-cells":
> +        const: 0
> +
> +    required:
> +      - "#phy-cells"
> +
> +  usb3-port:
> +    type: object
> +    additionalProperties: false
> +
> +    properties:
> +      "#phy-cells":
> +        const: 0
> +
> +    required:
> +      - "#phy-cells"


I don't see why these child nodes are needed. Just use a cell to define 
DP and USB3 phys.

> +
> +  port:
> +    $ref: /schemas/graph.yaml#/properties/port
> +    description:
> +      A port node to link the PHY to a TypeC controller for the purpose of
> +      handling orientation switching.
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - resets
> +  - reset-names
> +  - dp-port
> +  - usb3-port
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/rockchip,rk3588-cru.h>
> +    #include <dt-bindings/reset/rockchip,rk3588-cru.h>
> +
> +    usbdp_phy0: phy at fed80000 {
> +      compatible = "rockchip,rk3588-usbdp-phy";
> +      reg = <0xfed80000 0x10000>;
> +      clocks = <&cru CLK_USBDPPHY_MIPIDCPPHY_REF>,
> +               <&cru CLK_USBDP_PHY0_IMMORTAL>,
> +               <&cru PCLK_USBDPPHY0>,
> +               <&u2phy0>;
> +      clock-names = "refclk", "immortal", "pclk", "utmi";
> +      resets = <&cru SRST_USBDP_COMBO_PHY0_INIT>,
> +               <&cru SRST_USBDP_COMBO_PHY0_CMN>,
> +               <&cru SRST_USBDP_COMBO_PHY0_LANE>,
> +               <&cru SRST_USBDP_COMBO_PHY0_PCS>,
> +               <&cru SRST_P_USBDPPHY0>;
> +      reset-names = "init", "cmn", "lane", "pcs_apb", "pma_apb";
> +      rockchip,u2phy-grf = <&usb2phy0_grf>;
> +      rockchip,usb-grf = <&usb_grf>;
> +      rockchip,usbdpphy-grf = <&usbdpphy0_grf>;
> +      rockchip,vo-grf = <&vo0_grf>;
> +
> +      usbdp_phy0_dp: dp-port {
> +        #phy-cells = <0>;
> +      };
> +
> +      usbdp_phy0_u3: usb3-port {
> +        #phy-cells = <0>;
> +      };
> +    };
> -- 
> 2.43.0
>