Re: [PATCH v3 1/4] dt-bindings: usb: Add Parade PS8830 Type-C retimer bindings

Bjorn Andersson
2024-10-23T00:29:58Z

On Tue, Oct 22, 2024 at 01:26:54PM GMT, Abel Vesa wrote:
> Document bindings for the Parade PS8830 Type-C retimer. This retimer is
> currently found on all boards featuring Qualcomm Snapdragon X Elite SoCs
> and it is needed to provide altmode muxing between DP and USB, but also
> connector orientation handling between.

This sentence ends a bit weird to me, please polish it (although
preferably, rewrite it according to "describe your changes")

>
> Signed-off-by: Abel Vesa <abel.vesa@linaro.org>
> ---
> .../devicetree/bindings/usb/parade,ps8830.yaml | 129 +++++++++++++++++++++
> 1 file changed, 129 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/usb/parade,ps8830.yaml b/Documentation/devicetree/bindings/usb/parade,ps8830.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..ee4c69eca6066e4da0373fad6c25d6e9fff83366
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/parade,ps8830.yaml
> @@ -0,0 +1,129 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/parade,ps8830.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Parade PS8830 USB and DisplayPort Retimer
> +
> +maintainers:
> + - Abel Vesa <abel.vesa@linaro.org>
> +
> +properties:
> + compatible:
> + enum:
> + - parade,ps8830
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + items:
> + - description: XO Clock
> +
> + clock-names:
> + items:
> + - const: xo

Don't know if the guidelines has changed on this, but for a single clock
we used to omit clock-names, as it doesn't add any/much value.

Regards,
Bjorn

> +
> + ps8830,boot-on:
> + description: Left enabled at boot, so skip resetting
> + type: boolean
> +
> + reset-gpios:
> + maxItems: 1
> +
> + vdd-supply:
> + description: power supply (1.07V)
> +
> + vdd33-supply:
> + description: power supply (3.3V)
> +
> + vdd33-cap-supply:
> + description: power supply (3.3V)
> +
> + vddar-supply:
> + description: power supply (1.07V)
> +
> + vddat-supply:
> + description: power supply (1.07V)
> +
> + vddio-supply:
> + description: power supply (1.2V or 1.8V)
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - reset-gpios
> + - vdd-supply
> + - vdd33-supply
> + - vdd33-cap-supply
> + - vddat-supply
> + - vddio-supply
> + - orientation-switch
> + - retimer-switch
> +
> +allOf:
> + - $ref: usb-switch.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + typec-mux@8 {
> + compatible = "parade,ps8830";
> + reg = <0x8>;
> +
> + clocks = <&clk_rtmr_xo>;
> + clock-names = "xo";
> +
> + vdd-supply = <&vreg_rtmr_1p15>;
> + vdd33-supply = <&vreg_rtmr_3p3>;
> + vdd33-cap-supply = <&vreg_rtmr_3p3>;
> + vddar-supply = <&vreg_rtmr_1p15>;
> + vddat-supply = <&vreg_rtmr_1p15>;
> + vddio-supply = <&vreg_rtmr_1p8>;
> +
> + reset-gpios = <&tlmm 10 GPIO_ACTIVE_LOW>;
> +
> + retimer-switch;
> + orientation-switch;
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
> +
> + endpoint {
> + remote-endpoint = <&typec_con_ss>;
> + };
> + };
> +
> + port@1 {
> + reg = <1>;
> +
> + endpoint {
> + remote-endpoint = <&usb_phy_ss>;
> + };
> + };
> +
> + port@2 {
> + reg = <2>;
> +
> + endpoint {
> + remote-endpoint = <&typec_dp_aux>;
> + };
> + };
> + };
> + };
> + };
> +...
>
> --
> 2.34.1
>