xref: /freebsd/sys/contrib/device-tree/Bindings/usb/parade,ps8830.yaml (revision ae5de77ed78ae54d86cead5604869212e8008e6b)

# 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 PS883x USB and DisplayPort Retimer

maintainers:
  - Abel Vesa <abel.vesa@linaro.org>

properties:
  compatible:
    oneOf:
      - items:
          - const: parade,ps8833
          - const: parade,ps8830
      - const: parade,ps8830

  reg:
    maxItems: 1

  clocks:
    items:
      - description: XO Clock

  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
  - clocks
  - reset-gpios
  - vdd-supply
  - vdd33-supply
  - vdd33-cap-supply
  - vddat-supply
  - vddio-supply
  - orientation-switch
  - retimer-switch

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>;

            clocks = <&clk_rtmr_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>;
                    };
                };
            };
        };
    };
...