Documentation/devicetree/bindings/regulator/maxim,max8973.yaml

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/regulator/maxim,max8973.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Maxim MAX8973/MAX77621 voltage regulator
   8
   9 maintainers:
  10   - Krzysztof Kozlowski <krzk@kernel.org>
  11
  12 allOf:
  13   - $ref: regulator.yaml#
  14
  15 properties:
  16   compatible:
  17     enum:
  18       - maxim,max8973
  19       - maxim,max77621
  20
  21   junction-warn-millicelsius:
  22     description: |
  23       Junction warning temperature threshold in millicelsius. If die
  24       temperature crosses this level then device generates the warning
  25       interrupts.
  26       Please note that thermal functionality is only supported on MAX77621. The
  27       supported threshold warning temperature for MAX77621 are 120 degC and 140
  28       degC.
  29
  30   maxim,dvs-gpio:
  31     maxItems: 1
  32     description: |
  33       GPIO which is connected to DVS pin of device.
  34
  35   maxim,dvs-default-state:
  36     $ref: /schemas/types.yaml#/definitions/uint32
  37     enum: [0, 1]
  38     description: |
  39       Default state of GPIO during initialisation.
  40       1 for HIGH and 0 for LOW.
  41
  42   maxim,externally-enable:
  43     type: boolean
  44     description: |
  45       Externally control the regulator output enable/disable.
  46
  47   maxim,enable-gpio:
  48     maxItems: 1
  49     description: |
  50       GPIO for enable control. If the valid GPIO is provided then externally
  51       enable control will be considered.
  52
  53   maxim,enable-remote-sense:
  54     type: boolean
  55     description: Enable remote sense.
  56
  57   maxim,enable-falling-slew-rate:
  58     type: boolean
  59     description: Enable falling slew rate.
  60
  61   maxim,enable-active-discharge:
  62     type: boolean
  63     description: Eable active discharge.
  64
  65   maxim,enable-frequency-shift:
  66     type: boolean
  67     description: Enable 9% frequency shift.
  68
  69   maxim,enable-bias-control:
  70     type: boolean
  71     description: |
  72       Enable bias control which can reduce the startup delay to 20us from 220us.
  73
  74   maxim,enable-etr:
  75     type: boolean
  76     description: Enable Enhanced Transient Response.
  77
  78   maxim,enable-high-etr-sensitivity:
  79     type: boolean
  80     description: |
  81       Enhanced transient response circuit is enabled and set for high
  82       sensitivity. If this property is available then etr will be enable
  83       default.
  84       Enhanced transient response (ETR) will affect the configuration of CKADV.
  85
  86   reg:
  87     maxItems: 1
  88
  89   interrupts:
  90     maxItems: 1
  91
  92 required:
  93   - compatible
  94   - reg
  95
  96 unevaluatedProperties: false
  97
  98 examples:
  99   - |
 100     i2c {
 101         #address-cells = <1>;
 102         #size-cells = <0>;
 103
 104         regulator@1b {
 105             compatible = "maxim,max8973";
 106             reg = <0x1b>;
 107
 108             regulator-min-microvolt = <935000>;
 109             regulator-max-microvolt = <1200000>;
 110             regulator-boot-on;
 111             regulator-always-on;
 112         };
 113     };
 114
 115   - |
 116     #include <dt-bindings/gpio/gpio.h>
 117     #include <dt-bindings/interrupt-controller/irq.h>
 118
 119     i2c {
 120         #address-cells = <1>;
 121         #size-cells = <0>;
 122
 123         regulator@1b {
 124             compatible = "maxim,max77621";
 125             reg = <0x1b>;
 126             interrupts = <1 IRQ_TYPE_LEVEL_LOW>;
 127
 128             regulator-always-on;
 129             regulator-boot-on;
 130             regulator-min-microvolt = <800000>;
 131             regulator-max-microvolt = <1231250>;
 132             regulator-name = "PPVAR_CPU";
 133             regulator-ramp-delay = <12500>;
 134             maxim,dvs-default-state = <1>;
 135             maxim,enable-active-discharge;
 136             maxim,enable-bias-control;
 137             maxim,enable-etr;
 138             maxim,enable-gpio = <&pmic 5 GPIO_ACTIVE_HIGH>;
 139             maxim,externally-enable;
 140         };
 141     };