nxp,pca9420

Vendor: NXP Semiconductors N.V.

Note

An implementation of a driver matching this compatible is available in drivers/regulator/regulator_pca9420.c.

Description

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.

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

nxp,enable-modesel-pins

boolean

When enabled, the PMIC will be configured to allow mode selection using the MODESEL0/1 inputs.

nxp,vin-ilim-microamp

int

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

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

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

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.

Name

Type

Details

status

string

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: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

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 Important properties for more information.

reg

array

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 Important properties for more information.

reg-names

string-array

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

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 Important properties for more information.

interrupts-extended

compound

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

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

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

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 Important properties for more information.

clocks

phandle-array

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

Optional names given to each clock provider in the "clocks" property.

#address-cells

int

This property encodes the number of <u32> 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

This property encodes the number of <u32> 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

DMA channel specifiers relevant to the device.

dma-names

string-array

Optional names given to the DMA channel specifiers in the "dmas" property.

io-channels

phandle-array

IO channel specifiers relevant to the device.

io-channel-names

string-array

Optional names given to the IO channel specifiers in the "io-channels" property.

mboxes

phandle-array

Mailbox / IPM channel specifiers relevant to the device.

mbox-names

string-array

Optional names given to the mbox specifiers in the "mboxes" property.

power-domains

phandle-array

Power domain specifiers relevant to the device.

power-domain-names

string-array

Optional names given to the power domain specifiers in the "power-domains" property.

#power-domain-cells

int

Number of cells in power-domains property

zephyr,deferred-init

boolean

Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

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.

zephyr,pm-device-runtime-auto

boolean

Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

List of power states that will disable this device power.

Child node properties

Name

Type

Details

enable-inverted

boolean

If the enable bit should be zero to turn the regulator on, add this
property.

nxp,mode0-microvolt

int

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

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

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

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

smallest voltage consumers may set

regulator-max-microvolt

int

largest voltage 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.