:orphan:
.. raw:: html
.. dtcompatible:: nxp,pca9420
.. _dtbinding_nxp_pca9420:
nxp,pca9420
###########
Vendor: :ref:`NXP Semiconductors `
Description
***********
.. code-block:: none
NXP PCA9420 PMIC
The PMIC has two buck converters and two LDOs. All need to be defined as
children nodes, strictly following the BUCK1, BUCK2, LDO1 and LDO2 node names.
For example:
pmic@61 {
reg = <0x61>;
...
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 "nxp,pca9420"
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
* - ``nxp,enable-modesel-pins``
- ``boolean``
- .. code-block:: none
When enabled, the PMIC will be configured to allow mode selection using the MODESEL0/1 inputs.
* - ``nxp,vin-ilim-microamp``
- ``int``
- .. code-block:: none
VIN input current limit, in microamperes. Value reflects typical value,
below you can find min/typical/max values:
- 74 mA/85 mA/98 mA
- 222 mA/255 mA/293 mA
- 370 mA/425 mA/489 mA
- 517 mA/595 mA/684 mA
- 665 mA/765 mA/880 mA
- 813 mA/935 mA/1075 mA
- 961 mA/1105 mA/1271 mA
To disable current limit, set property to zero. Defaults to 425mA, the IC
default value.
Default value: ``425000``
Legal values: ``85000``, ``255000``, ``425000``, ``595000``, ``765000``, ``935000``, ``1105000``
* - ``nxp,asys-uvlo-sel-millivolt``
- ``int``
- .. code-block:: none
ASYS UVLO (under voltage lock out) threshold, in millivolts. Defaults to
2700mV to match the IC default value.
Default value: ``2700``
Legal values: ``2400``, ``2500``, ``2600``, ``2700``
.. 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 "nxp,pca9420" 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:`dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
See :ref:`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:`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:`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.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``enable-inverted``
- ``boolean``
- .. code-block:: none
If the enable bit should be zero to turn the regulator on, add this
property.
* - ``nxp,mode0-microvolt``
- ``int``
- .. code-block:: none
The voltage level to be configured for mode 0, in microvolts. Setting
this value to zero will disable the source in mode 0.
* - ``nxp,mode1-microvolt``
- ``int``
- .. code-block:: none
The voltage level to be configured for mode 1, in microvolts. Setting
this value to zero will disable the source in mode 1.
* - ``nxp,mode2-microvolt``
- ``int``
- .. code-block:: none
The voltage level to be configured for mode 2, in microvolts. Setting
this value to zero will disable the source in mode 2.
* - ``nxp,mode3-microvolt``
- ``int``
- .. code-block:: none
The voltage level to be configured for mode 3, in microvolts. Setting
this value to zero will disable the source in mode 3.
* - ``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-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.