Commit 3f5117be authored by David Heidelberg's avatar David Heidelberg Committed by Rob Herring
Browse files

dt-bindings: mfd: convert to yaml Qualcomm SPMI PMIC 



Convert Qualcomm SPMI PMIC binding to yaml format.

Additional changes:
 - filled many missing compatibles

Co-developed-by: default avatarCaleb Connolly <caleb@connolly.tech>
Signed-off-by: default avatarDavid Heidelberg <david@ixit.cz>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20220626191630.176835-1-david@ixit.cz
parent 331753ff

Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.txt

deleted100644 → 0
+0 −94
Original line number Diff line number Diff line 
          Qualcomm SPMI PMICs multi-function device bindings



The Qualcomm SPMI series presently includes PM8941, PM8841 and PMA8084

PMICs.  These PMICs use a QPNP scheme through SPMI interface.

QPNP is effectively a partitioning scheme for dividing the SPMI extended

register space up into logical pieces, and set of fixed register

locations/definitions within these regions, with some of these regions

specifically used for interrupt handling.



The QPNP PMICs are used with the Qualcomm Snapdragon series SoCs, and are

interfaced to the chip via the SPMI (System Power Management Interface) bus.

Support for multiple independent functions are implemented by splitting the

16-bit SPMI slave address space into 256 smaller fixed-size regions, 256 bytes

each. A function can consume one or more of these fixed-size register regions.



Required properties:

- compatible:      Should contain one of:

                   "qcom,pm660",

                   "qcom,pm660l",

                   "qcom,pm7325",

                   "qcom,pm8004",

                   "qcom,pm8005",

                   "qcom,pm8019",

                   "qcom,pm8028",

                   "qcom,pm8110",

                   "qcom,pm8150",

                   "qcom,pm8150b",

                   "qcom,pm8150c",

                   "qcom,pm8150l",

                   "qcom,pm8226",

                   "qcom,pm8350c",

                   "qcom,pm8841",

                   "qcom,pm8901",

                   "qcom,pm8909",

                   "qcom,pm8916",

                   "qcom,pm8941",

                   "qcom,pm8950",

                   "qcom,pm8953",

                   "qcom,pm8994",

                   "qcom,pm8998",

                   "qcom,pma8084",

                   "qcom,pmd9635",

                   "qcom,pmi8950",

                   "qcom,pmi8962",

                   "qcom,pmi8994",

                   "qcom,pmi8998",

                   "qcom,pmk8002",

                   "qcom,pmk8350",

                   "qcom,pmr735a",

                   "qcom,smb2351",

                   or generalized "qcom,spmi-pmic".

- reg:             Specifies the SPMI USID slave address for this device.

                   For more information see:

                   Documentation/devicetree/bindings/spmi/spmi.yaml



Required properties for peripheral child nodes:

- compatible:      Should contain "qcom,xxx", where "xxx" is a peripheral name.



Optional properties for peripheral child nodes:

- interrupts:      Interrupts are specified as a 4-tuple. For more information

                   see:

                   Documentation/devicetree/bindings/spmi/qcom,spmi-pmic-arb.yaml

- interrupt-names: Corresponding interrupt name to the interrupts property



Each child node of SPMI slave id represents a function of the PMIC. In the

example below the rtc device node represents a peripheral of pm8941

SID = 0. The regulator device node represents a peripheral of pm8941 SID = 1.



Example:



	spmi {

		compatible = "qcom,spmi-pmic-arb";



		pm8941@0 {

			compatible = "qcom,pm8941", "qcom,spmi-pmic";

			reg = <0x0 SPMI_USID>;



			rtc {

				compatible = "qcom,rtc";

				interrupts = <0x0 0x61 0x1 IRQ_TYPE_EDGE_RISING>;

				interrupt-names = "alarm";

			};

		};



		pm8941@1 {

			compatible = "qcom,pm8941", "qcom,spmi-pmic";

			reg = <0x1 SPMI_USID>;



			regulator {

				compatible = "qcom,regulator";

				regulator-name = "8941_boost";

			};

		};

	};

Documentation/devicetree/bindings/mfd/qcom,spmi-pmic.yaml

0 → 100644
+190 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

%YAML 1.2

---

$id: http://devicetree.org/schemas/mfd/qcom,spmi-pmic.yaml#

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



title: Qualcomm SPMI PMICs multi-function device



description: |

  Some Qualcomm PMICs used with the Snapdragon series SoCs are interfaced

  to the chip via the SPMI (System Power Management Interface) bus.

  Support for multiple independent functions are implemented by splitting the

  16-bit SPMI peripheral address space into 256 smaller fixed-size regions, 256 bytes

  each. A function can consume one or more of these fixed-size register regions.



  The Qualcomm SPMI series includes the PM8941, PM8841, PMA8084, PM8998 and other

  PMICs.  These PMICs use a "QPNP" scheme through SPMI interface.

  QPNP is effectively a partitioning scheme for dividing the SPMI extended

  register space up into logical pieces, and set of fixed register

  locations/definitions within these regions, with some of these regions

  specifically used for interrupt handling.



maintainers:

  - Stephen Boyd <sboyd@kernel.org>



properties:

  $nodename:

    oneOf:

      - pattern: '^pmic@.*$'

      - pattern: '^pm(a|s)?[0-9]*@.*$'

        deprecated: true



  compatible:

    items:

      - enum:

          - qcom,pm660

          - qcom,pm660l

          - qcom,pm6150

          - qcom,pm6150l

          - qcom,pm6350

          - qcom,pm7325

          - qcom,pm8004

          - qcom,pm8005

          - qcom,pm8009

          - qcom,pm8019

          - qcom,pm8110

          - qcom,pm8150

          - qcom,pm8150b

          - qcom,pm8150l

          - qcom,pm8226

          - qcom,pm8350

          - qcom,pm8350b

          - qcom,pm8350c

          - qcom,pm8841

          - qcom,pm8909

          - qcom,pm8916

          - qcom,pm8941

          - qcom,pm8950

          - qcom,pm8994

          - qcom,pm8998

          - qcom,pma8084

          - qcom,pmd9635

          - qcom,pmi8950

          - qcom,pmi8962

          - qcom,pmi8994

          - qcom,pmi8998

          - qcom,pmk8350

          - qcom,pmm8155au

          - qcom,pmr735a

          - qcom,pmr735b

          - qcom,pms405

          - qcom,pmx55

          - qcom,pmx65

          - qcom,smb2351

      - const: qcom,spmi-pmic



  reg:

    minItems: 1

    maxItems: 2



  '#address-cells':

    const: 1



  '#size-cells':

    const: 0



  labibb:

    type: object

    $ref: /schemas/regulator/qcom-labibb-regulator.yaml#



  regulators:

    type: object

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



patternProperties:

  "^adc@[0-9a-f]+$":

    type: object

    $ref: /schemas/iio/adc/qcom,spmi-vadc.yaml#



  "^adc-tm@[0-9a-f]+$":

    type: object

    $ref: /schemas/thermal/qcom-spmi-adc-tm5.yaml#



  "^audio-codec@[0-9a-f]+$":

    type: object

    additionalProperties: true # FIXME qcom,pm8916-wcd-analog-codec binding not converted yet



  "extcon@[0-9a-f]+$":

    type: object

    $ref: /schemas/extcon/qcom,pm8941-misc.yaml#



  "gpio(s)?@[0-9a-f]+$":

    type: object

    $ref: /schemas/pinctrl/qcom,pmic-gpio.yaml#



  "pon@[0-9a-f]+$":

    type: object

    $ref: /schemas/power/reset/qcom,pon.yaml#



  "pwm@[0-9a-f]+$":

    type: object

    $ref: /schemas/leds/leds-qcom-lpg.yaml#



  "^rtc@[0-9a-f]+$":

    type: object

    $ref: /schemas/rtc/qcom-pm8xxx-rtc.yaml#



  "^temp-alarm@[0-9a-f]+$":

    type: object

    $ref: /schemas/thermal/qcom,spmi-temp-alarm.yaml#



  "^vibrator@[0-9a-f]+$":

    type: object

    additionalProperties: true # FIXME qcom,pm8916-vib binding not converted yet



  "^mpps@[0-9a-f]+$":

    type: object

    $ref: /schemas/pinctrl/qcom,pmic-mpp.yaml#



  "(.*)?(wled|leds)@[0-9a-f]+$":

    type: object

    $ref: /schemas/leds/backlight/qcom-wled.yaml#

    unevaluatedProperties: false



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    #include <dt-bindings/spmi/spmi.h>

    #include <dt-bindings/interrupt-controller/irq.h>

    #include <dt-bindings/interrupt-controller/arm-gic.h>



    spmi@c440000 {

        compatible = "qcom,spmi-pmic-arb";

        reg = <0x0c440000 0x1100>,

              <0x0c600000 0x2000000>,

              <0x0e600000 0x100000>,

              <0x0e700000 0xa0000>,

              <0x0c40a000 0x26000>;

        reg-names = "core", "chnls", "obsrvr", "intr", "cnfg";

        interrupt-names = "periph_irq";

        interrupts = <GIC_SPI 481 IRQ_TYPE_LEVEL_HIGH>;

        qcom,ee = <0>;

        qcom,channel = <0>;

        #address-cells = <2>;

        #size-cells = <0>;

        interrupt-controller;

        #interrupt-cells = <4>;



        pmi8998_lsid0: pmic@2 {

            compatible = "qcom,pmi8998", "qcom,spmi-pmic";

            reg = <0x2 SPMI_USID>;

            #address-cells = <1>;

            #size-cells = <0>;



            pmi8998_gpio: gpios@c000 {

                compatible = "qcom,pmi8998-gpio", "qcom,spmi-gpio";

                reg = <0xc000>;

                gpio-controller;

                gpio-ranges = <&pmi8998_gpio 0 0 14>;

                #gpio-cells = <2>;

                interrupt-controller;

                #interrupt-cells = <2>;

            };

        };

    };