diff mbox

[v3,3/4] mfd: Add DT binding for Maxim MAX77802 IC

Message ID 1438252327-28427-4-git-send-email-javier@osg.samsung.com
State Superseded, archived
Headers show

Commit Message

Javier Martinez Canillas July 30, 2015, 10:32 a.m. UTC
The MAX77802 is a chip that contains regulators, 2 32kHz clocks,
a RTC and an I2C interface to program the individual components.

The are already DT bindings for the regulators and clocks and
these reference to a bindings/mfd/max77802.txt file, that didn't
exist, for the details about the PMIC.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
Reviewed-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>

---

Changes in v3:
- Add Krzysztof Kozlowski Reviewed-by tag to patch #3.
- Capitalise all acronyms. Suggested by Lee Jones.
- Use relative path to refer other bindings. Suggested by Lee Jones.
- Use IRQ_TYPE_NONE instead of 0 in example. Suggested by Lee Jones.

Changes in v2:
- Use the correct "maxim,max77802" compatible string.
  Suggested by Krzysztof Kozlowski
- Use a pmic generic node name for the max77802 node example.
  Suggested by Sergei Shtylyov.

 Documentation/devicetree/bindings/mfd/max77802.txt | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/max77802.txt

Comments

Lee Jones Aug. 11, 2015, 11:47 a.m. UTC | #1
On Thu, 30 Jul 2015, Javier Martinez Canillas wrote:

> The MAX77802 is a chip that contains regulators, 2 32kHz clocks,
> a RTC and an I2C interface to program the individual components.
> 
> The are already DT bindings for the regulators and clocks and
> these reference to a bindings/mfd/max77802.txt file, that didn't
> exist, for the details about the PMIC.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> Reviewed-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
> 
> ---
> 
> Changes in v3:
> - Add Krzysztof Kozlowski Reviewed-by tag to patch #3.
> - Capitalise all acronyms. Suggested by Lee Jones.
> - Use relative path to refer other bindings. Suggested by Lee Jones.
> - Use IRQ_TYPE_NONE instead of 0 in example. Suggested by Lee Jones.
> 
> Changes in v2:
> - Use the correct "maxim,max77802" compatible string.
>   Suggested by Krzysztof Kozlowski
> - Use a pmic generic node name for the max77802 node example.
>   Suggested by Sergei Shtylyov.
> 
>  Documentation/devicetree/bindings/mfd/max77802.txt | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/max77802.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/max77802.txt b/Documentation/devicetree/bindings/mfd/max77802.txt
> new file mode 100644
> index 000000000000..911ec5fcaefd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/max77802.txt
> @@ -0,0 +1,26 @@
> +Maxim MAX77802 multi-function device
> +
> +The Maxim MAX77802 is a Power Management IC (PMIC) that contains 10 high
> +efficiency Buck regulators, 32 Low-DropOut (LDO) regulators used to power
> +up application processors and peripherals, a 2-channel 32kHz clock outputs,
> +a Real-Time-Clock (RTC) and a I2C interface to program the individual
> +regulators, clocks outputs and the RTC.
> +
> +Binding for the built-in 32k clock generator block is defined separately
> +in the ../clk/maxim,max77802.txt file and binding for the regulators
> +is defined in the ../regulator/max77802.txt file.

  "Bindings for the built-in 32k clock generator block and
   regulators are defined in ../clk/maxim,max77802.txt and
   ../regulator/max77802.txt respectively."

> +Required properties:
> +- compatible : Must be "maxim,max77802";

';' ?

> +- reg : Specifies the I2C slave address of PMIC block.
> +- interrupts : This I2C device has an IRQ line connected to the main SoC.
> +- interrupt-parent : The parent interrupt controller.

I always find this easier on the eye when you:

Required properties:
- compatible		: Must be "maxim,max77802"
- reg			: Specifies the I2C slave address of PMIC block.
- interrupts		: This I2C device has an IRQ line connected to the main SoC.
- interrupt-parent	: The parent interrupt controller.

> +Example:
> +
> +	max77802: pmic@09 {
> +		compatible = "maxim,max77802";
> +		interrupt-parent = <&intc>;
> +		interrupts = <26 IRQ_TYPE_NONE>;
> +		reg = <0x09>;
> +	};
Javier Martinez Canillas Aug. 11, 2015, 3:25 p.m. UTC | #2
Hello Lee,

On 08/11/2015 01:47 PM, Lee Jones wrote:
> On Thu, 30 Jul 2015, Javier Martinez Canillas wrote:
> 
>> The MAX77802 is a chip that contains regulators, 2 32kHz clocks,
>> a RTC and an I2C interface to program the individual components.
>>
>> The are already DT bindings for the regulators and clocks and
>> these reference to a bindings/mfd/max77802.txt file, that didn't
>> exist, for the details about the PMIC.
>>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>> Reviewed-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
>>
>> ---
>>
>> Changes in v3:
>> - Add Krzysztof Kozlowski Reviewed-by tag to patch #3.
>> - Capitalise all acronyms. Suggested by Lee Jones.
>> - Use relative path to refer other bindings. Suggested by Lee Jones.
>> - Use IRQ_TYPE_NONE instead of 0 in example. Suggested by Lee Jones.
>>
>> Changes in v2:
>> - Use the correct "maxim,max77802" compatible string.
>>   Suggested by Krzysztof Kozlowski
>> - Use a pmic generic node name for the max77802 node example.
>>   Suggested by Sergei Shtylyov.
>>
>>  Documentation/devicetree/bindings/mfd/max77802.txt | 26 ++++++++++++++++++++++
>>  1 file changed, 26 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/mfd/max77802.txt
>>
>> diff --git a/Documentation/devicetree/bindings/mfd/max77802.txt b/Documentation/devicetree/bindings/mfd/max77802.txt
>> new file mode 100644
>> index 000000000000..911ec5fcaefd
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mfd/max77802.txt
>> @@ -0,0 +1,26 @@
>> +Maxim MAX77802 multi-function device
>> +
>> +The Maxim MAX77802 is a Power Management IC (PMIC) that contains 10 high
>> +efficiency Buck regulators, 32 Low-DropOut (LDO) regulators used to power
>> +up application processors and peripherals, a 2-channel 32kHz clock outputs,
>> +a Real-Time-Clock (RTC) and a I2C interface to program the individual
>> +regulators, clocks outputs and the RTC.
>> +
>> +Binding for the built-in 32k clock generator block is defined separately
>> +in the ../clk/maxim,max77802.txt file and binding for the regulators
>> +is defined in the ../regulator/max77802.txt file.
> 
>   "Bindings for the built-in 32k clock generator block and
>    regulators are defined in ../clk/maxim,max77802.txt and
>    ../regulator/max77802.txt respectively."
> 
>> +Required properties:
>> +- compatible : Must be "maxim,max77802";
> 
> ';' ?
>

err... I've no idea how that ended there. It seems I didn't completely
context switch from coding :-)
 
>> +- reg : Specifies the I2C slave address of PMIC block.
>> +- interrupts : This I2C device has an IRQ line connected to the main SoC.
>> +- interrupt-parent : The parent interrupt controller.
> 
> I always find this easier on the eye when you:
>
> Required properties:
> - compatible		: Must be "maxim,max77802"
> - reg			: Specifies the I2C slave address of PMIC block.
> - interrupts		: This I2C device has an IRQ line connected to the main SoC.
> - interrupt-parent	: The parent interrupt controller.
>

Ok, I'll wait for Mark's feedback and repost with your suggestions. Thanks!

>> +Example:
>> +
>> +	max77802: pmic@09 {
>> +		compatible = "maxim,max77802";
>> +		interrupt-parent = <&intc>;
>> +		interrupts = <26 IRQ_TYPE_NONE>;
>> +		reg = <0x09>;
>> +	};
> 

Best regards,
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/max77802.txt b/Documentation/devicetree/bindings/mfd/max77802.txt
new file mode 100644
index 000000000000..911ec5fcaefd
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/max77802.txt
@@ -0,0 +1,26 @@ 
+Maxim MAX77802 multi-function device
+
+The Maxim MAX77802 is a Power Management IC (PMIC) that contains 10 high
+efficiency Buck regulators, 32 Low-DropOut (LDO) regulators used to power
+up application processors and peripherals, a 2-channel 32kHz clock outputs,
+a Real-Time-Clock (RTC) and a I2C interface to program the individual
+regulators, clocks outputs and the RTC.
+
+Binding for the built-in 32k clock generator block is defined separately
+in the ../clk/maxim,max77802.txt file and binding for the regulators
+is defined in the ../regulator/max77802.txt file.
+
+Required properties:
+- compatible : Must be "maxim,max77802";
+- reg : Specifies the I2C slave address of PMIC block.
+- interrupts : This I2C device has an IRQ line connected to the main SoC.
+- interrupt-parent : The parent interrupt controller.
+
+Example:
+
+	max77802: pmic@09 {
+		compatible = "maxim,max77802";
+		interrupt-parent = <&intc>;
+		interrupts = <26 IRQ_TYPE_NONE>;
+		reg = <0x09>;
+	};