:orphan:
.. raw:: html
.. dtcompatible:: nordic,npm6001-regulator
.. _dtbinding_nordic_npm6001_regulator:
nordic,npm6001-regulator
########################
Vendor: :ref:`Nordic Semiconductor `
Description
***********
.. code-block:: none
Nordic nPM6001 PMIC
The PMIC has four buck converters and two LDOs. All need to be defined as
children nodes, strictly following the BUCK0..3, LDO0..1 node names. For
example:
pmic@70 {
reg = <0x70>;
...
regulators {
compatible = "nordic,npm6001-regulator";
BUCK0 {
/* all properties for BUCK0 */
};
BUCK1 {
/* all properties for BUCK1 */
};
BUCK2 {
/* all properties for BUCK2 */
};
BUCK3 {
/* all properties for BUCK3 */
};
LDO0 {
/* all properties for LDO0 */
};
LDO1 {
/* all properties for LDO1 */
};
};
};
Properties
**********
Top level properties
====================
These property descriptions apply to "nordic,npm6001-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
* - ``nordic,ready-high-drive``
- ``boolean``
- .. code-block:: none
Set drive strength to high for READY pin.
* - ``nordic,nint-high-drive``
- ``boolean``
- .. code-block:: none
Set drive strength to high for NINT pin.
* - ``nordic,sda-high-drive``
- ``boolean``
- .. code-block:: none
Set drive strength to high for SDA pin.
* - ``nordic,buck-mode0-input-type``
- ``string``
- .. code-block:: none
Input type for BUCK_MODE0 pin. Defaults IC boot-time value.
Default value: ``schmitt``
Legal values: ``'schmitt'``, ``'cmos'``
* - ``nordic,buck-mode0-pull-down``
- ``boolean``
- .. code-block:: none
Enable pull-down resistor for BUCK_MODE0 pin.
* - ``nordic,buck-mode1-input-type``
- ``string``
- .. code-block:: none
Input type for BUCK_MODE1 pin. Defaults IC boot-time value.
Default value: ``schmitt``
Legal values: ``'schmitt'``, ``'cmos'``
* - ``nordic,buck-mode1-pull-down``
- ``boolean``
- .. code-block:: none
Enable pull-down resistor for BUCK_MODE1 pin.
* - ``nordic,buck-mode2-input-type``
- ``string``
- .. code-block:: none
Input type for BUCK_MODE2 pin. Defaults IC boot-time value.
Default value: ``schmitt``
Legal values: ``'schmitt'``, ``'cmos'``
* - ``nordic,buck-mode2-pull-down``
- ``boolean``
- .. code-block:: none
Enable pull-down resistor for BUCK_MODE2 pin.
.. 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,npm6001-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
* - ``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.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``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-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-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.