:orphan:
.. raw:: html
.. dtcompatible:: nordic,npm1300-regulator
.. _dtbinding_nordic_npm1300_regulator:
nordic,npm1300-regulator
########################
Vendor: :ref:`Nordic Semiconductor `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/regulator/regulator_npm1300.c`.
Description
***********
.. code-block:: none
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.
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``dvs-gpios``
- ``phandle-array``
- .. code-block:: none
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.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
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.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`zephyr:dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Provided names of power domain specifiers
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
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.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``retention-microvolt``
- ``int``
- .. code-block:: none
Retention mode voltage in microvolts.
* - ``enable-gpios``
- ``phandle-array``
- .. code-block:: none
Regulator enable controlled by specified regulator GPIO pin.
When set regulator must be enabled/disabled using set_dvs_mode.
* - ``pwm-gpios``
- ``phandle-array``
- .. code-block:: none
Regulator enable controlled by specified regulator GPIO pin.
When set regulator must be enabled/disabled using set_dvs_mode.
* - ``retention-gpios``
- ``phandle-array``
- .. code-block:: none
Retention mode controlled by specified regulator GPIO pin.
* - ``soft-start-microamp``
- ``int``
- .. code-block:: none
Soft start current limit in microamps.
Legal values: ``10000``, ``20000``, ``35000``, ``50000``
* - ``regulator-init-microvolt``
- ``int``
- .. code-block:: none
Voltage set during initialisation
* - ``regulator-min-microvolt``
- ``int``
- .. code-block:: none
smallest voltage consumers may set
* - ``regulator-max-microvolt``
- ``int``
- .. code-block:: none
largest voltage consumers may set
* - ``regulator-min-microamp``
- ``int``
- .. code-block:: none
smallest current consumers may set
* - ``regulator-max-microamp``
- ``int``
- .. code-block:: none
largest current consumers may set
* - ``regulator-always-on``
- ``boolean``
- .. code-block:: none
boolean, regulator should never be disabled
* - ``regulator-boot-on``
- ``boolean``
- .. code-block:: none
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``
- .. code-block:: none
Regulator should be disabled on boot.
* - ``regulator-initial-mode``
- ``int``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
Startup time, in microseconds
* - ``off-on-delay-us``
- ``int``
- .. code-block:: none
Off to on delay time, in microseconds