Re: [PATCH] dt-bindings: mfd: Add bindings for the Mediatek MT6360 PMIC

From: Lee Jones <lee.jones@linaro.org>
To: Gene Chen <gene.chen.richtek@gmail.com>
Cc: robh+dt@kernel.org, matthias.bgg@gmail.com,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	linux-mediatek@lists.infradead.org, linux-kernel@vger.kernel.org,
	gene_chen@richtek.com, Wilma.Wu@mediatek.com,
	shufan_lee@richtek.com, cy_huang@richtek.com
Subject: Re: [PATCH] dt-bindings: mfd: Add bindings for the Mediatek MT6360 PMIC
Date: Tue, 16 Jun 2020 14:16:07 +0100	[thread overview]
Message-ID: <20200616131607.GQ2608702@dell> (raw)
In-Reply-To: <1592306876-3504-1-git-send-email-gene.chen.richtek@gmail.com>

On Tue, 16 Jun 2020, Gene Chen wrote:

> From: Gene Chen <gene_chen@richtek.com>
> 
> Add devicetree binding document support Mediatek MT6360 PMIC

This should have been submitted with the driver.

> Signed-off-by: Gene Chen <gene_chen@richtek.com>
> ---
>  Documentation/devicetree/bindings/mfd/mt6360.txt | 53 ++++++++++++++++++++++++
>  1 file changed, 53 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/mt6360.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/mt6360.txt b/Documentation/devicetree/bindings/mfd/mt6360.txt
> new file mode 100644
> index 0000000..e25b5c6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/mt6360.txt
> @@ -0,0 +1,53 @@
> +MediaTek MT6360 Multifunction Device Driver

No such thing as an MFD (we made it up!).

Please describe the device.

> +MT6360 is a multifunction device with the following sub modules:

As above.  MFD is a Linuxisum which is not allowed in DT.

> +- ADC
> +- Battery Charger/OTG boost
> +- Flash LED/RGB LED/moonlight LED
> +- 2-channel Buck
> +- 6-channel LDO
> +- USB_PD
> +
> +It is interfaced to host controller using I2C interface.
> +This document describes the binding for MFD device and its sub module.

As above.  This sentence should be at the top in any case.

> +Required properties:
> +- compatible:	Must be "mediatek,mt6360_pmu"

No '_'s in DT.

> +- reg:			Specifies the I2C slave address of PMIC block, Must be <0x34>
> +- interrupts:	I2C device IRQ line connected to the main SoC.
> +
> +Optional subnodes:
> +- ADC
> +	Required properties:
> +		- compatible: "mediatek,mt6360_adc"
> +- battery charger/OTG boost
> +	Required properties:
> +		- compatible: "mediatek,mt6360_chg"
> +- Flash LED/RGB LED/moonlight LED
> +	Required properties:
> +		- compatible: "mediatek,mt6360_led"
> +- 2-channel Buck
> +	Required properties:
> +		- compatible: "mediatek,mt6360_pmic"
> +- 6-channel LDO
> +	Required properties:
> +		- compatible: "mediatek,mt6360_ldo"
> +- USB_PD
> +	Required properties:
> +		- compatible: "mediatek,mt6360_tcpc"

No '_'s.  Must be '-'.

> +Example:
> +
> +	#include <dt-bindings/usb/pd.h>
> +
> +	pmu: mt6360_pmu@34 {
> +		status = "ok";

"okay" is more common I think.

Should be at the bottom if not omitted altogether.

> +		compatible = "mediatek,mt6360_pmu";
> +		reg = <0x34>;
> +		wakeup-source;
> +		interrupts-extended = <&gpio26 0 IRQ_TYPE_LEVEL_LOW>;
> +		interrupt-names = "IRQB";
> +		interrupt-controller;
> +		#interrupt-cells = <2>;
> +	};
> +

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog