Re: [PATCH v4 06/18] dt-bindings: usb: Add Qualcomm PMIC Type-C controller YAML schema

Krzysztof Kozlowski
2023-03-19T11:54:10Z

On 18/03/2023 13:18, Bryan O'Donoghue wrote:
> Add a YAML binding for the Type-C silicon interface inside Qualcomm's
> pm8150b hardware block.
>
> The Type-C driver operates with a pdphy driver inside of a high level
> single TCPM device.
>
> Based on original work by Wesley.
>
> Signed-off-by: Wesley Cheng <wcheng@codeaurora.org>
> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
> ---
> .../bindings/usb/qcom,pmic-typec.yaml | 88 +++++++++++++++++++
> 1 file changed, 88 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
>
> diff --git a/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml b/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
> new file mode 100644
> index 0000000000000..d87bbab88d8be
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/qcom,pmic-typec.yaml
> @@ -0,0 +1,88 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/usb/qcom,pmic-typec.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

Drop quotes.

> +
> +title: Qualcomm PMIC based USB type C Detection Driver

Drop "Driver"

> +
> +maintainers:
> + - Bryan O'Donoghue <bryan.odonoghue@linaro.org>
> +
> +description: |
> + Qualcomm PMIC Type C Detect

Drop description - it is useless here - or make it something more, a
proper description.

> +
> +properties:
> + compatible:
> + enum:
> + - qcom,pm8150b-typec
> +
> + reg:
> + maxItems: 1
> + description: Type C base address

Drop description

> +
> + interrupts:
> + items:
> + - description: Bitmask of CC attach, VBUS error, tCCDebounce done and more
> + - description: VCONN Powered Detection
> + - description: CC state change
> + - description: VCONN over-current condition
> + - description: VBUS state change
> + - description: Attach Deteach notification
> + - description: Legacy cable detect
> + - description: Try.Src Try.Snk state change

These are the same as binding headers, thus it suggests header change is
meaningless.

> +
> + interrupt-names:
> + items:
> + - const: or-rid-detect-change
> + - const: vpd-detect
> + - const: cc-state-change
> + - const: vconn-oc
> + - const: vbus-change
> + - const: attach-detach
> + - const: legacy-cable-detect
> + - const: try-snk-src-detect
> +
> + vdd-vbus-supply:
> + description: VBUS power supply.

The name is usually vbus-supply.

> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - interrupt-names
> + - vdd-vbus-supply
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/usb/typec/qcom,pmic-typec.h>
> + pm8150b {

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

> + #address-cells = <1>;
> + #size-cells = <0>;
> +

Best regards,
Krzysztof