This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

nordic,npm1300-regulator

Vendor: Nordic Semiconductor

Description

Nordic nPM1300 PMIC

The PMIC has two buck converters and two LDOs.
The regulators need to be defined as child nodes, strictly following the
BUCK1,2 LDO1..2, node names. For
example:

pmic@6b {
  reg = <0x6b>;
  ...
  regulators {
    compatible = "nordic,npm1300-regulator";

    BUCK1 {
      /* all properties for BUCK1 */
    };
    BUCK2 {
      /* all properties for BUCK2 */
    };
    LDO1 {
      /* all properties for LDO1 */
    };
    LDO2 {
      /* all properties for LDO2 */
    };
  };
};

Properties

Top level properties

These property descriptions apply to “nordic,npm1300-regulator” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name

Type

Details

dvs-gpios

phandle-array

List of SOC GPIOs connected to PMIC GPIOs.
Set_dvs_mode will drive these pins as follows:
  DVS mode 1 will enable the first pin
  DVS mode 2 will enable the second pin
  DVS mode 3 will drive the first and second pins
  etc.
The effect of the mode change is defined by the enable-gpios
and pwm_gpios fields for each of the regulator blocks.

Child node properties

Name

Type

Details

retention-microvolt

int

Retention mode voltage in microvolts.

enable-gpios

phandle-array

Regulator enable controlled by specified regulator GPIO pin.
When set regulator must be enabled/disabled using set_dvs_mode.

pwm-gpios

phandle-array

Regulator enable controlled by specified regulator GPIO pin.
When set regulator must be enabled/disabled using set_dvs_mode.

retention-gpios

phandle-array

Retention mode controlled by specified regulator GPIO pin.

soft-start-microamp

int

Soft start current limit in microamps.

Legal values: 10000, 20000, 35000, 50000

regulator-init-microvolt

int

Voltage set during initialisation

regulator-min-microvolt

int

smallest voltage consumers may set

regulator-max-microvolt

int

largest voltage consumers may set

regulator-min-microamp

int

smallest current consumers may set

regulator-max-microamp

int

largest current consumers may set

regulator-always-on

boolean

boolean, regulator should never be disabled

regulator-boot-on

boolean

bootloader/firmware enabled regulator.
It's expected that this regulator was left on by the bootloader.
If the bootloader didn't leave it on then OS should turn it on
at boot but shouldn't prevent it from being turned off later.
This property is intended to only be used for regulators where
software cannot read the state of the regulator.

regulator-boot-off

boolean

Regulator should be disabled on boot.

regulator-initial-mode

int

Initial operating mode. The set of possible operating modes depends on the
capabilities of every hardware so each device binding documentation
explains which values the regulator supports.

regulator-allowed-modes

array

List of operating modes that software is allowed to configure for the
regulator at run-time. Elements may be specified in any order. The set of
possible operating modes depends on the capabilities of every hardware so
each device binding document explains which values the regulator supports.

startup-delay-us

int

Startup time, in microseconds

off-on-delay-us

int

Off to on delay time, in microseconds