linux-kernel - Re: [PATCH 1/3] dt-bindings usb: typec: rt1711h: Add binding for Richtek RT1711H

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20220720213900.GA4021129-robh@kernel.org>
Date:   Wed, 20 Jul 2022 15:39:00 -0600
From:   Rob Herring <robh@...nel.org>
To:     Gene Chen <gene.chen.richtek@...il.com>
Cc:     linux@...ck-us.net, heikki.krogerus@...ux.intel.com,
        gregkh@...uxfoundation.org, krzysztof.kozlowski+dt@...aro.org,
        linux-usb@...r.kernel.org, linux-kernel@...r.kernel.org,
        devicetree@...r.kernel.org, gene_chen@...htek.com,
        cy_huang@...htek.com
Subject: Re: [PATCH 1/3] dt-bindings usb: typec: rt1711h: Add binding for
 Richtek RT1711H

On Fri, Jul 15, 2022 at 06:04:16PM +0800, Gene Chen wrote:
> From: Gene Chen <gene_chen@...htek.com>
> 
> Add binding for Richtek RT1711H
> 
> Signed-off-by: Gene Chen <gene_chen@...htek.com>
> ---
>  .../bindings/usb/richtek,rt1711h.yaml         | 96 +++++++++++++++++++
>  1 file changed, 96 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> new file mode 100644
> index 000000000000..b6daca71429b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> @@ -0,0 +1,96 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/richtek,rt1711h.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Richtek RT1711H Type-C Port Switch and Power Delivery controller DT bindings

s/ DT bindings//

> +
> +maintainers:
> +  - Gene Chen <gene_chen@...htek.com>
> +
> +description: |

Don't need '|' if no formatting.

> +  - Richtek RT1711H TypeC PD Controller.

'-' should be dropped. Though if you can't say more than the title, you 
might as well drop entirely.

> +
> +properties:
> +  compatible:
> +    oneOf:

Don't need oneOf with only 1 entry.

> +      - enum:
> +          - richtek,rt1711h
> +          - richtek,rt1715

Perhaps 'description' should detail the differences in these parts.

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  wakeup-source:
> +    description: enable IRQ remote wakeup, see power/wakeup-source.txt

Drop generic descriptions.

> +    type: boolean
> +
> +  connector:
> +    type: object
> +    $ref: ../connector/usb-connector.yaml#

full path:

/schemas/connector/...

> +    description:
> +      Properties for usb c connector.
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - connector
> +  - interrupts
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/usb/pd.h>
> +    i2c0 {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      rt1711h@4e {
> +        compatible = "richtek,rt1711h";
> +        reg = <0x4e>;
> +        interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;
> +        wakeup-source;
> +
> +        connector {
> +          compatible = "usb-c-connector";
> +          label = "USB-C";
> +          data-role = "dual";
> +          power-role = "dual";
> +          try-power-role = "sink";
> +          source-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
> +          sink-pdos = <PDO_FIXED(5000, 2000, PDO_FIXED_DUAL_ROLE | PDO_FIXED_DATA_SWAP)>;
> +          op-sink-microwatt = <10000000>;
> +
> +          ports {
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +
> +            port@0 {
> +              reg = <0>;
> +              endpoint {
> +                remote-endpoint = <&usb_hs>;
> +              };
> +            };
> +            port@1 {
> +              reg = <1>;
> +              endpoint {
> +                remote-endpoint = <&usb_ss>;
> +              };
> +            };
> +            port@2 {
> +              reg = <2>;
> +              endpoint {
> +                remote-endpoint = <&dp_aux>;
> +              };
> +            };
> +          };
> +        };
> +      };
> +    };
> +...
> -- 
> 2.25.1
> 
>