diff mbox series

dt-bindings: mfd: Add bindings for the Mediatek MT6360 PMIC

Message ID 1592306876-3504-1-git-send-email-gene.chen.richtek@gmail.com
State Changes Requested
Headers show
Series dt-bindings: mfd: Add bindings for the Mediatek MT6360 PMIC | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 53 lines checked

Commit Message

Gene Chen June 16, 2020, 11:27 a.m. UTC
From: Gene Chen <gene_chen@richtek.com>

Add devicetree binding document support Mediatek MT6360 PMIC

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

Comments

Lee Jones June 16, 2020, 1:16 p.m. UTC | #1
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>;
> +	};
> +
Rob Herring July 15, 2020, 7:06 p.m. UTC | #2
On Tue, Jun 16, 2020 at 07:27:56PM +0800, Gene Chen wrote:
> From: Gene Chen <gene_chen@richtek.com>
> 
> Add devicetree binding document support Mediatek MT6360 PMIC
> 
> 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

Bindings are in DT schema format now.

Rob
diff mbox series

Patch

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
+
+MT6360 is a multifunction device with the following sub modules:
+- 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.
+
+Required properties:
+- compatible:	Must be "mediatek,mt6360_pmu"
+- 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"
+
+Example:
+
+	#include <dt-bindings/usb/pd.h>
+
+	pmu: mt6360_pmu@34 {
+		status = "ok";
+		compatible = "mediatek,mt6360_pmu";
+		reg = <0x34>;
+		wakeup-source;
+		interrupts-extended = <&gpio26 0 IRQ_TYPE_LEVEL_LOW>;
+		interrupt-names = "IRQB";
+		interrupt-controller;
+		#interrupt-cells = <2>;
+	};
+