Re: [PATCH v4 4/9] dt-bindings: mfd: mediatek: Add bindings for MT6357 PMIC

Krzysztof Kozlowski
2022-11-11T14:52:17Z

On 08/11/2022 19:43, Alexandre Mergnat wrote:
> Currently, almost all MT63XX PMIC are documented mfd/mt6397.txt.
> Unfortunately, the PMICs haven't always similar HW sub-features.
> To have a better human readable schema, I chose to make one PMIC schema
> to match the exact HW capabilities instead of convert mt6397.txt to
> mediatek,mt63xx.yaml and put a bunch of properties behind
> "if contain ... then ..."
>
> - add interrupt property
> - change property refs to match with new yaml documentation
>
> Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com>
> ---
> .../devicetree/bindings/mfd/mediatek,mt6357.yaml | 102 +++++++++++++++++++++
> 1 file changed, 102 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml
> new file mode 100644
> index 000000000000..7b421f21d3f5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/mediatek,mt6357.yaml
> @@ -0,0 +1,102 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/mediatek,mt6357.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek MT6357 Multifunction Device Driver

Multifunction Device is Linux specific, drop.
Driver is not hardware related, drop.

Instead describe the hardware. It's PMIC right? So call it a PMIC.

> +
> +maintainers:
> + - Alexandre Mergnat <amergnat@baylibre.com>
> +
> +description: |
> + MT6357 is a power management system chip containing 5 buck
> + converters and 29 LDOs. Supported features are audio codec,
> + USB battery charging, fuel gauge, RTC
> +
> + This is a multifunction device with the following sub modules:
> + - Regulator
> + - RTC
> + - Keys
> +
> + It is interfaced to host controller using SPI interface by a proprietary hardware
> + called PMIC wrapper or pwrap. This MFD is a child device of pwrap.
> + See the following for pwrap node definitions:
> + ../soc/mediatek/mediatek,pwrap.yaml
> +
> +properties:
> + compatible:
> + const: mediatek,mt6357
> +
> + interrupts:
> + maxItems: 1
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> +
> + regulators:
> + type: object
> + $ref: ../regulator/mediatek,mt6357-regulator.yaml

Full path, so /schemas/regulator/......

> + description:
> + Child node that specify the regulator.

Improve your descriptions. "Child node" - it is obvious, it's an object.
"Specify" - no need.
"the regulator" one regulator?

> +
> + rtc:
> + type: object
> + $ref: ../rtc/mediatek,mt6397-rtc.yaml

Ditto

> + description:
> + Child node that specify the RTC.

MT6357 Real Time Clock

> +
> + keys:
> + type: object
> + $ref: ../input/mediatek,pmic-keys.yaml

ditto

> + description:
> + Child node that specify the keys.

MT6357 ...

> +
> +required:
> + - compatible
> + - regulators
> +
Best regards,
Krzysztof