Unverified Commit 19cd2b14 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Mark Brown
Browse files

regulator: dt-bindings: maxim,max8973: convert to dtschema



Convert the Maxim MAX8973 regulator to DT schema format.  Extend the
examples with more advanced one for MAX77621 copied from kernel's
nvidia/tegra210-smaug.dts, licensed under GPL-2.0.

Signed-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Message-Id: <20211008114755.148279-1-krzysztof.kozlowski@canonical.com>
Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 1d2104f2
Loading
Loading
Loading
Loading
+0 −52
Original line number Diff line number Diff line
* Maxim MAX8973 Voltage Regulator

Required properties:

- compatible:	must be one of following:
			"maxim,max8973"
			"maxim,max77621".
- reg:		the i2c slave address of the regulator. It should be 0x1b.

Any standard regulator properties can be used to configure the single max8973
DCDC.

Optional properties:

-maxim,externally-enable: boolean, externally control the regulator output
		enable/disable.
-maxim,enable-gpio: GPIO for enable control. If the valid GPIO is provided
		then externally enable control will be considered.
-maxim,dvs-gpio: GPIO which is connected to DVS pin of device.
-maxim,dvs-default-state: Default state of GPIO during initialisation.
		1 for HIGH and 0 for LOW.
-maxim,enable-remote-sense: boolean, enable reote sense.
-maxim,enable-falling-slew-rate: boolean, enable falling slew rate.
-maxim,enable-active-discharge: boolean: enable active discharge.
-maxim,enable-frequency-shift: boolean, enable 9% frequency shift.
-maxim,enable-bias-control: boolean, enable bias control. By enabling this
		startup delay can be reduce to 20us from 220us.
-maxim,enable-etr: boolean, enable Enhanced Transient Response.
-maxim,enable-high-etr-sensitivity: boolean, Enhanced transient response
		circuit is enabled and set for high sensitivity. If this
		property is available then etr will be enable default.

Enhanced transient response (ETR) will affect the configuration of CKADV.

-junction-warn-millicelsius: u32, junction warning temperature threshold
		in millicelsius. If die temperature crosses this level then
		device generates the warning interrupts.

Please note that thermal functionality is only supported on MAX77621. The
supported threshold warning temperature for MAX77621 are 120 degC and 140 degC.

Example:

	max8973@1b {
		compatible = "maxim,max8973";
		reg = <0x1b>;

		regulator-min-microvolt = <935000>;
		regulator-max-microvolt = <1200000>;
		regulator-boot-on;
		regulator-always-on;
	};
+139 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0-only
%YAML 1.2
---
$id: http://devicetree.org/schemas/regulator/maxim,max8973.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Maxim MAX8973/MAX77621 voltage regulator

maintainers:
  - Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>

allOf:
  - $ref: regulator.yaml#

properties:
  compatible:
    enum:
      - maxim,max8973
      - maxim,max77621

  junction-warn-millicelsius:
    description: |
      Junction warning temperature threshold in millicelsius. If die
      temperature crosses this level then device generates the warning
      interrupts.
      Please note that thermal functionality is only supported on MAX77621. The
      supported threshold warning temperature for MAX77621 are 120 degC and 140
      degC.

  maxim,dvs-gpio:
    maxItems: 1
    description: |
      GPIO which is connected to DVS pin of device.

  maxim,dvs-default-state:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [0, 1]
    description: |
      Default state of GPIO during initialisation.
      1 for HIGH and 0 for LOW.

  maxim,externally-enable:
    type: boolean
    description: |
      Externally control the regulator output enable/disable.

  maxim,enable-gpio:
    maxItems: 1
    description: |
      GPIO for enable control. If the valid GPIO is provided then externally
      enable control will be considered.

  maxim,enable-remote-sense:
    type: boolean
    description: Enable remote sense.

  maxim,enable-falling-slew-rate:
    type: boolean
    description: Enable falling slew rate.

  maxim,enable-active-discharge:
    type: boolean
    description: Eable active discharge.

  maxim,enable-frequency-shift:
    type: boolean
    description: Enable 9% frequency shift.

  maxim,enable-bias-control:
    type: boolean
    description: |
      Enable bias control which can reduce the startup delay to 20us from 220us.

  maxim,enable-etr:
    type: boolean
    description: Enable Enhanced Transient Response.

  maxim,enable-high-etr-sensitivity:
    type: boolean
    description: |
      Enhanced transient response circuit is enabled and set for high
      sensitivity. If this property is available then etr will be enable
      default.
      Enhanced transient response (ETR) will affect the configuration of CKADV.

  reg:
    maxItems: 1

required:
  - compatible
  - reg

unevaluatedProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        regulator@1b {
            compatible = "maxim,max8973";
            reg = <0x1b>;

            regulator-min-microvolt = <935000>;
            regulator-max-microvolt = <1200000>;
            regulator-boot-on;
            regulator-always-on;
        };
    };

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

    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        regulator@1b {
            compatible = "maxim,max77621";
            reg = <0x1b>;
            interrupt-parent = <&gpio>;
            interrupts = <TEGRA_GPIO(Y, 1) IRQ_TYPE_LEVEL_LOW>;

            regulator-always-on;
            regulator-boot-on;
            regulator-min-microvolt = <800000>;
            regulator-max-microvolt = <1231250>;
            regulator-name = "PPVAR_CPU";
            regulator-ramp-delay = <12500>;
            maxim,dvs-default-state = <1>;
            maxim,enable-active-discharge;
            maxim,enable-bias-control;
            maxim,enable-etr;
            maxim,enable-gpio = <&pmic 5 GPIO_ACTIVE_HIGH>;
            maxim,externally-enable;
        };
    };