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.
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..f6721d6eee26c6d4590a12c19791b3d47a8145f3
--- /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
+
+ 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)
+
+ orientation-switch: true
+ retimer-switch: true
+
+ ports:
+ $ref: /schemas/graph.yaml#/properties/ports
+ properties:
+ port@0:
+ $ref: /schemas/graph.yaml#/properties/port
+ description: Super Speed (SS) Output endpoint to the Type-C connector
+
+ port@1:
+ $ref: /schemas/graph.yaml#/$defs/port-base
+ description: Super Speed (SS) Input endpoint from the Super-Speed PHY
+ unevaluatedProperties: false
+
+ port@2:
+ $ref: /schemas/graph.yaml#/properties/port
+ description:
+ Sideband Use (SBU) AUX lines endpoint to the Type-C connector for the purpose of
+ handling altmode muxing and orientation switching.
+
+required:
+ - compatible
+ - reg
+
+allOf:
+ - $ref: usb-switch.yaml#
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ typec-mux@8 {
+ compatible = "parade,ps8830";
+ reg = <0x8>;
+
+ 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 = <&pm8550_gpios 10 GPIO_ACTIVE_HIGH>;
+
+ retimer-switch;
+ orientation-switch;
+
+ ports {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ port@0 {
+ reg = <0>;
+ usb_con_ss: endpoint {
+ remote-endpoint = <&typec_con_ss>;
+ };
+ };
+ port@1 {
+ reg = <1>;
+ phy_con_ss: endpoint {
+ remote-endpoint = <&usb_phy_ss>;
+ data-lanes = <3 2 1 0>;
+ };
+ };
+ port@2 {
+ reg = <2>;
+ usb_con_sbu: endpoint {
+ remote-endpoint = <&typec_dp_aux>;
+ };
+ };
+ };
+ };
+ };
+...
--
2.34.1On Fri, Oct 04, 2024 at 04:57:37PM +0300, 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.
>
> Signed-off-by: Abel Vesa <abel.vesa@linaro.org>
> + clocks:
> + items:
> + - description: XO Clock
> +
> + clock-names:
> + items:
> + - const: xo
> + 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
Presumably all of the supplies are also required.
Similar for clocks, etc.
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + typec-mux@8 {
> + compatible = "parade,ps8830";
> + reg = <0x8>;
> +
> + 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 = <&pm8550_gpios 10 GPIO_ACTIVE_HIGH>;
The reset line is active low.
> +
> + retimer-switch;
> + orientation-switch;
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
Please add a newline before each child node for readability.
> + usb_con_ss: endpoint {
We typically avoid adding unused labels to the examples, but perhaps
here it serves as documentation?
> + remote-endpoint = <&typec_con_ss>;
> + };
> + };
Add newline here too, and similar below.
> + port@1 {
> + reg = <1>;
> + phy_con_ss: endpoint {
> + remote-endpoint = <&usb_phy_ss>;
> + data-lanes = <3 2 1 0>;
> + };
> + };
> + port@2 {
> + reg = <2>;
> + usb_con_sbu: endpoint {
> + remote-endpoint = <&typec_dp_aux>;
> + };
> + };
> + };
> + };
> + };
> +...
Johan
On Fri, Oct 04, 2024 at 04:57:37PM 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. > > 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..f6721d6eee26c6d4590a12c19791b3d47a8145f3 > --- /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 > + > + 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) > + > + orientation-switch: true > + retimer-switch: true > + > + ports: > + $ref: /schemas/graph.yaml#/properties/ports > + properties: > + port@0: > + $ref: /schemas/graph.yaml#/properties/port > + description: Super Speed (SS) Output endpoint to the Type-C connector > + > + port@1: > + $ref: /schemas/graph.yaml#/$defs/port-base > + description: Super Speed (SS) Input endpoint from the Super-Speed PHY > + unevaluatedProperties: false BTW: could you please also use usb/usb-switch.yaml for these ports ? Maybe we should also add port@2 to that schema. > + > + port@2: > + $ref: /schemas/graph.yaml#/properties/port > + description: > + Sideband Use (SBU) AUX lines endpoint to the Type-C connector for the purpose of > + handling altmode muxing and orientation switching. -- With best wishes Dmitry
On Fri, Oct 04, 2024 at 04:57:37PM 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. > > 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..f6721d6eee26c6d4590a12c19791b3d47a8145f3 > --- /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 > + > + 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) Any additional details? > + > + vddio-supply: > + description: power supply (1.2V or 1.8V) > + > + orientation-switch: true > + retimer-switch: true > + > + ports: > + $ref: /schemas/graph.yaml#/properties/ports > + properties: > + port@0: > + $ref: /schemas/graph.yaml#/properties/port > + description: Super Speed (SS) Output endpoint to the Type-C connector > + > + port@1: > + $ref: /schemas/graph.yaml#/$defs/port-base > + description: Super Speed (SS) Input endpoint from the Super-Speed PHY or from another SS signal source, which can be a mux, a switch or anything else. I'd say, just 'Input Super Speed (SS)' > + unevaluatedProperties: false > + > + port@2: > + $ref: /schemas/graph.yaml#/properties/port > + description: > + Sideband Use (SBU) AUX lines endpoint to the Type-C connector for the purpose of > + handling altmode muxing and orientation switching. > + > +required: > + - compatible > + - reg > + > +allOf: > + - $ref: usb-switch.yaml# > + > +additionalProperties: false > + -- With best wishes Dmitry
On 24-10-06 18:28:52, Dmitry Baryshkov wrote: > On Fri, Oct 04, 2024 at 04:57:37PM 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. > > > > 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..f6721d6eee26c6d4590a12c19791b3d47a8145f3 > > --- /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 > > + > > + 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) > > Any additional details? Documentation doesn't say anything more than this. > > > + > > + vddio-supply: > > + description: power supply (1.2V or 1.8V) > > + > > + orientation-switch: true > > + retimer-switch: true > > + > > + ports: > > + $ref: /schemas/graph.yaml#/properties/ports > > + properties: > > + port@0: > > + $ref: /schemas/graph.yaml#/properties/port > > + description: Super Speed (SS) Output endpoint to the Type-C connector > > + > > + port@1: > > + $ref: /schemas/graph.yaml#/$defs/port-base > > + description: Super Speed (SS) Input endpoint from the Super-Speed PHY > > or from another SS signal source, which can be a mux, a switch or > anything else. I'd say, just 'Input Super Speed (SS)' Will use that. > > > + unevaluatedProperties: false > > + > > + port@2: > > + $ref: /schemas/graph.yaml#/properties/port > > + description: > > + Sideband Use (SBU) AUX lines endpoint to the Type-C connector for the purpose of > > + handling altmode muxing and orientation switching. > > + > > +required: > > + - compatible > > + - reg > > + > > +allOf: > > + - $ref: usb-switch.yaml# > > + > > +additionalProperties: false > > + > > -- > With best wishes > Dmitry
On Fri, Oct 04, 2024 at 04:57:37PM +0300, 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. > > Signed-off-by: Abel Vesa <abel.vesa@linaro.org> > --- > .../devicetree/bindings/usb/parade,ps8830.yaml | 129 +++++++++++++++++++++ > 1 file changed, 129 insertions(+) Missing R-by from Krzysztof?
On Sat, Oct 05, 2024 at 12:36:47PM GMT, Rob Herring wrote: > On Fri, Oct 04, 2024 at 04:57:37PM +0300, 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. > > > > Signed-off-by: Abel Vesa <abel.vesa@linaro.org> > > --- > > .../devicetree/bindings/usb/parade,ps8830.yaml | 129 +++++++++++++++++++++ > > 1 file changed, 129 insertions(+) > > Missing R-by from Krzysztof? Quoting the changelog: Didn't pick Krzysztof's R-b tag because the bindings changed w.r.t supplies -- With best wishes Dmitry
© 2016 - 2026 Red Hat, Inc.