[PATCH v2 2/4] dt-bindings: usb: Add binding for PS5511 hub controller

Pin-yen Lin posted 4 patches 8 months, 1 week ago
There is a newer version of this series
[PATCH v2 2/4] dt-bindings: usb: Add binding for PS5511 hub controller
Posted by Pin-yen Lin 8 months, 1 week ago
Parade PS5511 is USB hub with 4 USB 3.2 compliant 5Gbps downstream(DS)
ports, and 1 extra USB 2.0 downstream port. The hub has one reset pin
control and two power supplies (3V3 and 1V1).

Signed-off-by: Pin-yen Lin <treapking@chromium.org>

---

Changes in v2:
- Inherit usb-hub.yaml
- Fix bindings to reject port@5/device@5 for 3.0 hub correctly
- Minor string fixes

 .../bindings/usb/parade,ps5511.yaml           | 115 ++++++++++++++++++
 1 file changed, 115 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/usb/parade,ps5511.yaml

diff --git a/Documentation/devicetree/bindings/usb/parade,ps5511.yaml b/Documentation/devicetree/bindings/usb/parade,ps5511.yaml
new file mode 100644
index 00000000000000..86c75d69ee35b2
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/parade,ps5511.yaml
@@ -0,0 +1,115 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/parade,ps5511.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Parade PS5511 4+1 Port USB 3.2 Gen 1 Hub Controller
+
+maintainers:
+  - Pin-yen Lin <treapking@chromium.org>
+
+properties:
+  compatible:
+    enum:
+      - usb1da0,5511
+      - usb1da0,55a1
+
+  reg: true
+
+  '#address-cells': true
+
+  '#size-cells': true
+
+  reset-gpios:
+    items:
+      - description: GPIO specifier for RESETB pin.
+
+  vddd11-supply:
+    description:
+      1V1 power supply to the hub
+
+  vdd33-supply:
+    description:
+      3V3 power supply to the hub
+
+  peer-hub: true
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    properties:
+      '#address-cells': true
+
+      '#size-cells': true
+
+    patternProperties:
+      '^port@[1-5]$': true
+
+    additionalProperties: false
+
+patternProperties:
+  '^.*@[1-5]$': true
+
+required:
+  - compatible
+  - reg
+  - peer-hub
+
+additionalProperties: false
+
+allOf:
+  - $ref: usb-hub.yaml#
+  - if:
+      not:
+        properties:
+          compatible:
+            enum:
+              - usb1da0,55a1
+    then:
+      properties:
+        ports:
+          properties:
+            port@5: false
+      patternProperties:
+        '^.*@5$': false
+
+examples:
+  - |
+    usb {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        /* 2.0 hub on port 1 */
+        hub_2_0: hub@1 {
+            compatible = "usb1da0,55a1";
+            reg = <1>;
+            peer-hub = <&hub_3_0>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+            /* USB 2.0 device on port 5 */
+            device@5 {
+                reg = <5>;
+                compatible = "usb123,4567";
+            };
+        };
+
+        /* 3.0 hub on port 2 */
+        hub_3_0: hub@2 {
+            compatible = "usb1da0,5511";
+            reg = <2>;
+            peer-hub = <&hub_2_0>;
+
+            ports {
+                #address-cells = <1>;
+                #size-cells = <0>;
+                /* Type-A connector on port 3 */
+                port@3 {
+                    reg = <3>;
+                    endpoint {
+                        remote-endpoint = <&usb_a0_ss>;
+                    };
+                };
+            };
+        };
+    };
-- 
2.49.0.777.g153de2bbd5-goog
Re: [PATCH v2 2/4] dt-bindings: usb: Add binding for PS5511 hub controller
Posted by Rob Herring 8 months ago
On Tue, Apr 15, 2025 at 05:41:59PM +0800, Pin-yen Lin wrote:
> Parade PS5511 is USB hub with 4 USB 3.2 compliant 5Gbps downstream(DS)
> ports, and 1 extra USB 2.0 downstream port. The hub has one reset pin
> control and two power supplies (3V3 and 1V1).
> 
> Signed-off-by: Pin-yen Lin <treapking@chromium.org>
> 
> ---
> 
> Changes in v2:
> - Inherit usb-hub.yaml
> - Fix bindings to reject port@5/device@5 for 3.0 hub correctly
> - Minor string fixes
> 
>  .../bindings/usb/parade,ps5511.yaml           | 115 ++++++++++++++++++
>  1 file changed, 115 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/parade,ps5511.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/parade,ps5511.yaml b/Documentation/devicetree/bindings/usb/parade,ps5511.yaml
> new file mode 100644
> index 00000000000000..86c75d69ee35b2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/parade,ps5511.yaml
> @@ -0,0 +1,115 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/parade,ps5511.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Parade PS5511 4+1 Port USB 3.2 Gen 1 Hub Controller
> +
> +maintainers:
> +  - Pin-yen Lin <treapking@chromium.org>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - usb1da0,5511
> +      - usb1da0,55a1
> +
> +  reg: true
> +
> +  '#address-cells': true
> +
> +  '#size-cells': true

Drop these 3.

> +
> +  reset-gpios:
> +    items:
> +      - description: GPIO specifier for RESETB pin.
> +
> +  vddd11-supply:
> +    description:
> +      1V1 power supply to the hub
> +
> +  vdd33-supply:
> +    description:
> +      3V3 power supply to the hub
> +
> +  peer-hub: true
> +
> +  ports:
> +    $ref: /schemas/graph.yaml#/properties/ports
> +
> +    properties:
> +      '#address-cells': true
> +
> +      '#size-cells': true
> +
> +    patternProperties:
> +      '^port@[1-5]$': true
> +
> +    additionalProperties: false

I would do this instead:

ports:
  $ref: /schemas/graph.yaml#/properties/ports

  patternProperties:
    '^port@':
      $ref: /schemas/graph.yaml#/properties/port

      properties:
        reg:
          minimum: 1
          maximum: 5

> +
> +patternProperties:
> +  '^.*@[1-5]$': true

And here:

additionalProperties: true
properties:
  reg:
    minimum: 1
    maximum: 5
    
> +
> +required:
> +  - compatible
> +  - reg

Already required by usb-hub.yaml.

> +  - peer-hub
> +
> +additionalProperties: false

Use unevaluatedProperties instead.

> +
> +allOf:
> +  - $ref: usb-hub.yaml#
> +  - if:
> +      not:
> +        properties:
> +          compatible:
> +            enum:
> +              - usb1da0,55a1
> +    then:
> +      properties:
> +        ports:
> +          properties:
> +            port@5: false
> +      patternProperties:
> +        '^.*@5$': false
> +
> +examples:
> +  - |
> +    usb {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        /* 2.0 hub on port 1 */
> +        hub_2_0: hub@1 {
> +            compatible = "usb1da0,55a1";
> +            reg = <1>;
> +            peer-hub = <&hub_3_0>;
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +            /* USB 2.0 device on port 5 */
> +            device@5 {
> +                reg = <5>;
> +                compatible = "usb123,4567";
> +            };
> +        };
> +
> +        /* 3.0 hub on port 2 */
> +        hub_3_0: hub@2 {
> +            compatible = "usb1da0,5511";
> +            reg = <2>;
> +            peer-hub = <&hub_2_0>;
> +
> +            ports {
> +                #address-cells = <1>;
> +                #size-cells = <0>;
> +                /* Type-A connector on port 3 */
> +                port@3 {
> +                    reg = <3>;
> +                    endpoint {
> +                        remote-endpoint = <&usb_a0_ss>;
> +                    };
> +                };
> +            };
> +        };
> +    };
> -- 
> 2.49.0.777.g153de2bbd5-goog
>