Commit 326fa439 authored by Luca Ceresoli's avatar Luca Ceresoli Committed by Lee Jones
Browse files

dt-bindings: mfd: lp87565: Convert to yaml 



Also apply a few smaller improvements:

 - document that the only possible I2C slave address is 0x60 as per the
   datasheet and fix the second example accordingly
 - The definition of "xxx-in-supply" was generic, thus define in detail the
   possible cases for each chip variant
 - remove "MFD driver" from the title as it is implementation specific
 - replace "PMIC" with "buck converter" in title as it is more informative

Signed-off-by: default avatarLuca Ceresoli <luca@lucaceresoli.net>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
parent d38eac29

Documentation/devicetree/bindings/mfd/lp87565.txt

deleted100644 → 0
+0 −79
Original line number Diff line number Diff line 
TI LP87565 PMIC MFD driver



Required properties:

  - compatible:	"ti,lp87565", "ti,lp87565-q1"

  - reg:		I2C slave address.

  - gpio-controller:	Marks the device node as a GPIO Controller.

  - #gpio-cells:	Should be two.  The first cell is the pin number and

			the second cell is used to specify flags.

			See ../gpio/gpio.txt for more information.

  - xxx-in-supply:	Phandle to parent supply node of each regulator

			populated under regulators node. xxx should match

			the supply_name populated in driver.

Example:



lp87565_pmic: pmic@60 {

	compatible = "ti,lp87565-q1";

	reg = <0x60>;

	gpio-controller;

	#gpio-cells = <2>;



	buck10-in-supply = <&vsys_3v3>;

	buck23-in-supply = <&vsys_3v3>;



	regulators: regulators {

		buck10_reg: buck10 {

			/* VDD_MPU */

			regulator-name = "buck10";

			regulator-min-microvolt = <850000>;

			regulator-max-microvolt = <1250000>;

			regulator-always-on;

			regulator-boot-on;

		};



		buck23_reg: buck23 {

			/* VDD_GPU */

			regulator-name = "buck23";

			regulator-min-microvolt = <850000>;

			regulator-max-microvolt = <1250000>;

			regulator-boot-on;

			regulator-always-on;

		};

	};

};



TI LP87561 PMIC:



This is a single output 4-phase regulator configuration



Required properties:

  - compatible:	"ti,lp87561-q1"

  - reg:		I2C slave address.

  - gpio-controller:	Marks the device node as a GPIO Controller.

  - #gpio-cells:	Should be two.  The first cell is the pin number and

			the second cell is used to specify flags.

			See ../gpio/gpio.txt for more information.

  - xxx-in-supply:	Phandle to parent supply node of each regulator

			populated under regulators node. xxx should match

			the supply_name populated in driver.

Example:



lp87561_pmic: pmic@62 {

	compatible = "ti,lp87561-q1";

	reg = <0x62>;

	gpio-controller;

	#gpio-cells = <2>;



	buck3210-in-supply = <&vsys_3v3>;



	regulators: regulators {

		buck3210_reg: buck3210 {

			/* VDD_CORE */

			regulator-name = "buck3210";

			regulator-min-microvolt = <800000>;

			regulator-max-microvolt = <800000>;

			regulator-always-on;

			regulator-boot-on;

		};

	};

};

Documentation/devicetree/bindings/mfd/ti,lp87561-q1.yaml

0 → 100644
+83 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/mfd/ti,lp87561-q1.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: TI LP87561-Q1 single 4-phase output buck converter



maintainers:

  - Keerthy <j-keerthy@ti.com>



properties:

  compatible:

    const: ti,lp87561-q1



  reg:

    description: I2C slave address

    const: 0x60



  gpio-controller: true



  '#gpio-cells':

    description:

      The first cell is the pin number.

      The second cell is is used to specify flags.

      See ../gpio/gpio.txt for more information.

    const: 2



  buck3210-in-supply:

    description:

      Voltage regulator supply for all the four BUCK converters.



  regulators:

    type: object



    properties:

      buck3210:

        type: object

        $ref: /schemas/regulator/regulator.yaml#



    required:

      - buck3210



    additionalProperties: false



required:

  - compatible

  - reg

  - gpio-controller

  - '#gpio-cells'

  - buck3210-in-supply



additionalProperties: false



examples:

  - |

    i2c@0 {

        reg = <0x0 0x100>;

        #address-cells = <1>;

        #size-cells = <0>;



        pmic@60 {

            compatible = "ti,lp87561-q1";

            reg = <0x60>;

            gpio-controller;

            #gpio-cells = <2>;



            buck3210-in-supply = <&vsys_3v3>;



            regulators {

                buck3210_reg: buck3210 {

                    /* VDD_CORE */

                    regulator-name = "buck3210";

                    regulator-min-microvolt = <800000>;

                    regulator-max-microvolt = <800000>;

                    regulator-always-on;

                    regulator-boot-on;

                };

            };

        };

    };



...

Documentation/devicetree/bindings/mfd/ti,lp87565-q1.yaml

0 → 100644
+101 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/mfd/ti,lp87565-q1.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: TI LP87565-Q1 / LP87565 dual 2-phase output buck converter



maintainers:

  - Keerthy <j-keerthy@ti.com>



properties:

  compatible:

    oneOf:

      - const: ti,lp87565

      - const: ti,lp87565-q1



  reg:

    description: I2C slave address

    const: 0x60



  gpio-controller: true



  '#gpio-cells':

    description:

      The first cell is the pin number.

      The second cell is is used to specify flags.

      See ../gpio/gpio.txt for more information.

    const: 2



  buck10-in-supply:

    description:

      Voltage regulator supply for BUCK0 and BUCK1 converters.



  buck23-in-supply:

    description:

      Voltage regulator supply for BUCK2 and BUCK3 converters.



  regulators:

    type: object



    patternProperties:

      "^buck(10|23)$":

        type: object

        $ref: /schemas/regulator/regulator.yaml#



    required:

      - buck10

      - buck23



    additionalProperties: false



required:

  - compatible

  - reg

  - gpio-controller

  - '#gpio-cells'

  - buck10-in-supply

  - buck23-in-supply



additionalProperties: false



examples:

  - |

    i2c@0 {

        reg = <0x0 0x100>;

        #address-cells = <1>;

        #size-cells = <0>;



        pmic@60 {

            compatible = "ti,lp87565-q1";

            reg = <0x60>;

            gpio-controller;

            #gpio-cells = <2>;



            buck10-in-supply = <&vsys_3v3>;

            buck23-in-supply = <&vsys_3v3>;



            regulators {

                buck10_reg: buck10 {

                    /* VDD_MPU */

                    regulator-name = "buck10";

                    regulator-min-microvolt = <850000>;

                    regulator-max-microvolt = <1250000>;

                    regulator-always-on;

                    regulator-boot-on;

                };



                buck23_reg: buck23 {

                    /* VDD_GPU */

                    regulator-name = "buck23";

                    regulator-min-microvolt = <850000>;

                    regulator-max-microvolt = <1250000>;

                    regulator-boot-on;

                    regulator-always-on;

                };

            };

        };

    };



...

CRA Git | Maintained and supported by SUSTech CRA and CCSE