This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

regulator-pmic

Vendor: Generic or vendor-independent

Description

PMIC controlled regulator

Properties

Properties not inherited from the base binding file.

Name

Type

Details

voltage-range

array

array of voltage values in uV, followed by the register value that
must be written to enable the voltage. For example, [3300000, 0x3]
denotes a value of 0x3 must be written to the register to set 3.3V

This property is required.

num-voltages

int

number of voltages present in the voltage-range array.

This property is required.

vsel-reg

int

I2C register to write voltage selection value to

This property is required.

vsel-mask

int

Mask to apply to the voltage range value when written to vsel
register

This property is required.

enable-reg

int

I2C register to write enable value to

This property is required.

enable-mask

int

Mask to apply to the enable bit (either 1 for enabled,
or 0 for disabled) when writing it to the I2C enable register.

This property is required.

enable-val

int

value to apply enable-mask to, and write to enable-reg in order
to enable the regulator output.

This property is required.

min-uV

int

Minimum voltage in microvolts that this regulator supports

This property is required.

max-uV

int

Maximum voltage in microvolts that this regulator supports

This property is required.

enable-inverted

boolean

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

current-levels

array

Array of current limit values in uA, followed by the register value
that must be written to enable the current limit. For example,
[800000, 0x3] denotes a value of 0x3 must be written to the register
to set a current limit of 800mA

num-current-levels

int

Number of current limit levels this regulator supports. If left as
default, regulator current support will be disabled.

ilim-reg

int

Register to write the register value given in current-levels into
to set the current limit

ilim-mask

int

Mask to apply to the current-levels value before writing it to the
ilim-reg value to set the current limit

regulator-always-on

boolean

regulator should always be on

regulator-boot-on

boolean

regulator should be turned on at startup

supply-gpios

phandle-array

GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.