:orphan:
.. raw:: html
.. dtcompatible:: nordic,npm10xx-regulator
.. _dtbinding_nordic_npm10xx_regulator:
nordic,npm10xx-regulator
########################
.. sidebar:: Overview
:Name: ``nordic,npm10xx-regulator``
:Vendor: :ref:`Nordic Semiconductor `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=nordic,npm10xx-regulator>` using
this compatible
:Driver: :zephyr_file:`drivers/regulator/regulator_npm10xx.c`
Description
***********
.. code-block:: none
Nordic nPM10xx PMIC regulator
Examples
********
.. code-block:: dts
npm1012: pmic@6a {
reg = <0x6a>;
compatible = "nordic,npm10xx";
/* ... */
regulators {
compatible = "nordic,npm10xx-regulator";
dvs-gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>, <&gpio0 1 GPIO_ACTIVE_HIGH>;
BUCK {
regulator-init-microvolt = <2500000>;
pwr-mode-gpio-config = <0 GPIO_ACTIVE_HIGH>;
/* ... */
};
LDO {
regulator-init-microvolt = <1800000>;
enable-gpio-config = <1 GPIO_ACTIVE_HIGH>;
/* ... */
};
LDSW {
regulator-boot-off;
regulator-soft-start-microamp = <10000>;
/* ... */
};
};
/* ... */
};
Properties
**********
Top level properties
====================
These property descriptions apply to "nordic,npm10xx-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 as regulator control GPIOs.
regulator_parent_dvs_state_set will drive these pins according to the bits set in the state
identifier, that is:
0 (0b000) - deactivate all pins
1 (0b001) - activate only the first pin
2 (0b010) - activate only the second pin
3 (0b011) - activate both the first and the second pin
etc.
The effect of the state change is defined by the *-gpio-config properties for each of the
regulator blocks. Provide up to three pins (nPM10xx has 3 GPIOs).
.. 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,npm10xx-regulator" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" 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
* - ``regulator-init-microvolt``
- ``int``
- .. code-block:: none
Valid range is 1V to 3V3 with 50mV steps. BUCK and LDO.
* - ``regulator-min-microvolt``
- ``int``
- .. code-block:: none
Valid range is 1V to 3V3 with 50mV steps. BUCK and LDO.
* - ``regulator-max-microvolt``
- ``int``
- .. code-block:: none
Valid range is 1V to 3V3 with 50mV steps. BUCK and LDO.
* - ``regulator-alternate-microvolt``
- ``int``
- .. code-block:: none
Alternate output voltage. Valid range is 1V to 3V3 with 50mV steps. BUCK only.
* - ``regulator-init-microamp``
- ``int``
- .. code-block:: none
Peak current limit to set during initialization. BUCK only.
Legal values: ``66000``, ``91000``, ``117000``, ``142000``, ``167000``, ``192000``, ``217000``, ``291000``
* - ``regulator-min-microamp``
- ``int``
- .. code-block:: none
Minimum allowed peak current limit. BUCK only.
Legal values: ``66000``, ``91000``, ``117000``, ``142000``, ``167000``, ``192000``, ``217000``, ``291000``
* - ``regulator-max-microamp``
- ``int``
- .. code-block:: none
Maximum allowed peak current limit. BUCK only.
Legal values: ``66000``, ``91000``, ``117000``, ``142000``, ``167000``, ``192000``, ``217000``, ``291000``
* - ``regulator-allow-bypass``
- ``boolean``
- .. code-block:: none
Enable automatic pass-through mode when BUCK output does not reach the target due to low
supply voltage. BUCK only.
* - ``regulator-soft-start-microamp``
- ``int``
- .. code-block:: none
Peak current limit for startup. The values are:
10mA, 20mA, 35mA, 50mA - for LDO and LOADSW
66mA, 91mA, 117mA, 142mA, 167mA, 192mA, 217mA, 291mA - for BUCK
Legal values: ``10000``, ``20000``, ``35000``, ``50000``, ``66000``, ``91000``, ``117000``, ``142000``, ``167000``, ``192000``, ``217000``, ``291000``
* - ``regulator-soft-start-us``
- ``int``
- .. code-block:: none
Soft start time. LDO and LOADSW.
Legal values: ``1500``, ``4500``, ``7500``, ``10500``
* - ``regulator-pull-down-ohms``
- ``int``
- .. code-block:: none
Pull-down resistance in Ohms. BUCK only.
Legal values: ``250``, ``500``, ``1000``, ``2000``
* - ``regulator-ripple``
- ``string``
- .. code-block:: none
Output voltage ripple. BUCK only.
Legal values: ``default``, ``low``, ``high``
* - ``enable-gpio-config``
- ``array``
- .. code-block:: none
Regulator enable controlled by specified GPIO pin .
* - ``pwr-mode-gpio-config``
- ``array``
- .. code-block:: none
Regulator power mode controlled by specified GPIO pin . BUCK only.
* - ``alternate-vout-gpio-config``
- ``array``
- .. code-block:: none
Regulator alternate output voltage controlled by specified GPIO pin . BUCK only.
* - ``regulator-name``
- ``string``
- .. code-block:: none
A string used as a descriptive name for regulator outputs
* - ``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.
* - ``regulator-over-current-protection``
- ``boolean``
- .. code-block:: none
Enable over current protection.
* - ``regulator-active-discharge``
- ``int``
- .. code-block:: none
tristate, enable/disable active discharge of regulators. The values are:
0: Disable active discharge.
1: Enable active discharge.
Absence of this property will leave configuration to default.
Legal values: ``0``, ``1``