linux-kernel - Re: [PATCH 1/2] dt-bindings usb: typec: rt1718s: Add binding for Richtek RT1718S

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <3aa83ec3-228d-1add-5e4b-c100340b127e@linaro.org>
Date:   Mon, 9 Jan 2023 11:14:03 +0100
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     gene_chen@...htek.com, robh+dt@...nel.org,
        krzysztof.kozlowski+dt@...aro.org, linux@...ck-us.net,
        heikki.krogerus@...ux.intel.com
Cc:     gregkh@...uxfoundation.org, linux-usb@...r.kernel.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/2] dt-bindings usb: typec: rt1718s: Add binding for
 Richtek RT1718S

On 09/01/2023 10:31, gene_chen@...htek.com wrote:
> From: Gene Chen <gene_chen@...htek.com>
> 

Subject: drop second, redundant "binding for".

> Add binding for Richtek RT1718s
> 
> Signed-off-by: Gene Chen <gene_chen@...htek.com>
> ---
>  .../devicetree/bindings/usb/richtek,rt1718s.yaml   | 98 ++++++++++++++++++++++
>  1 file changed, 98 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/usb/richtek,rt1718s.yaml
> 
> diff --git a/Documentation/devicetree/bindings/usb/richtek,rt1718s.yaml b/Documentation/devicetree/bindings/usb/richtek,rt1718s.yaml
> new file mode 100644
> index 00000000..7797fc6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/richtek,rt1718s.yaml
> @@ -0,0 +1,98 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/richtek,rt1718s.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

Drop quotes from both.

> +
> +title: Richtek RT1718S Type-C Port Switch and Power Delivery controller
> +
> +maintainers:
> +  - Gene Chen <gene_chen@...htek.com>
> +
> +description: |
> +  The RT1718S is a USB Type-C controller that complies with the latest
> +  USB Type-C and PD standards. It does the USB Type-C detection including attach
> +  and orientation. It integrates the physical layer of the USB BMC power
> +  delivery protocol to allow up to 100W of power. The BMC PD block enables full
> +  support for alternative interfaces of the Type-C specification.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - richtek,rt1718s
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  wakeup-source:
> +    description: enable IRQ remote wakeup, see power/wakeup-source.txt

Drop description, you are copying generic description.

> +    type: boolean

Drop. Just wakeup-soource: true

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

Full path, so /schemas/usb/connector ....

> +    description:
> +      Properties for usb c connector.

That's not accurate description. Everything in properties is a property,
so no need to say that properties are properties.

Actually this looks the same as existing rt1711, so please do not
duplicate stuff. Especially, do not duplicate mistakes...

> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - connector
> +  - interrupts
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/usb/pd.h>
> +    i2c0 {

i2c

> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      rt1718s@43 {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


Best regards,
Krzysztof