nordic,npm1300-regulator

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.

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “nordic,npm1300-regulator” compatible.

Name	Type	Details
`status`	`string`	indicates the operational status of a device Legal values: `'ok'`, `'okay'`, `'disabled'`, `'reserved'`, `'fail'`, `'fail-sss'` See Important properties for more information.
`compatible`	`string-array`	compatible strings This property is required. See Important properties for more information.
`reg`	`array`	register space See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device See Important properties for more information.
`interrupts-extended`	`compound`	extended interrupt specifier for device
`interrupt-names`	`string-array`	name of each interrupt
`interrupt-parent`	`phandle`	phandle to interrupt controller node
`label`	`string`	Human readable string describing the device (used as device_get_binding() argument) See Important properties for more information. This property is deprecated.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property
`#size-cells`	`int`	number of size cells in reg property
`dmas`	`phandle-array`	DMA channels specifiers
`dma-names`	`string-array`	Provided names of DMA channel specifiers
`io-channels`	`phandle-array`	IO channels specifiers
`io-channel-names`	`string-array`	Provided names of IO channel specifiers
`mboxes`	`phandle-array`	mailbox / IPM channels specifiers
`mbox-names`	`string-array`	Provided names of mailbox / IPM channel specifiers
`wakeup-source`	`boolean`	Property to identify that a device can be used as wake up source. When this property is provided a specific flag is set into the device that tells the system that the device is capable of wake up the system. Wake up capable devices are disabled (interruptions will not wake up the system) by default but they can be enabled at runtime if necessary.
`power-domain`	`phandle`	Power domain the device belongs to. The device will be notified when the power domain it belongs to is either suspended or resumed.
`zephyr,pm-device-runtime-auto`	`boolean`	Automatically configure the device for runtime power management after the init function runs.

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