:orphan:
.. raw:: html
.. dtcompatible:: regulator-gpio
.. _dtbinding_regulator_gpio:
regulator-gpio
##############
Vendor: :ref:`Generic or vendor-independent `
Description
***********
.. code-block:: none
GPIO-controlled voltage of regulators
Example of dts node:
vccq_sd0: regulator-vccq-sd0 {
compatible = "regulator-gpio";
regulator-name = "SD0 VccQ";
regulator-min-microvolt = <1800000>;
regulator-max-microvolt = <3300000>;
enable-gpios = <&gpio5 3 GPIO_ACTIVE_HIGH>;
gpios = <&gpio5 1 GPIO_ACTIVE_HIGH>, <&gpio5 2 GPIO_ACTIVE_HIGH>;
states = <3300000 2>, <2700000 1>, <1800000 0>;
regulator-boot-on;
};
In the above example, three GPIO pins are used for controlling the regulator:
* two of them for controlling voltage;
* third for enabling/disabling the regulator.
Properties
**********
.. 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
* - ``regulator-name``
- ``string``
- .. code-block:: none
A string used as a descriptive name for regulator outputs
This property is **required**.
* - ``gpios``
- ``phandle-array``
- .. code-block:: none
GPIO to use to switch voltage.
This property is **required**.
* - ``states``
- ``array``
- .. code-block:: none
Selection of available voltages provided by this regulator and matching
GPIO configurations to achieve them. If there are no states in the
"states" array, use a fixed regulator instead. First value in an array
item is voltage in microvolts and the second is GPIO group state value.
* - ``enable-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO to use to enable/disable the regulator.
Unlike the gpio property in the Linux bindings this array must provide
the GPIO polarity and open-drain status in the phandle selector. The
Linux enable-active-high and gpio-open-drain properties are not valid
for Zephyr devicetree files. Moreover, the driver isn't capable of
working with more than one GPIO and this property does not have a state
array. The driver simply sets or clears the appropriate GPIO bit when
it is requested to enable or disable the regulator.
Example:
enable-gpios = <&gpio5 2 GPIO_ACTIVE_HIGH>;
* - ``regulator-init-microvolt``
- ``int``
- .. code-block:: none
Voltage set during initialisation
* - ``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.
* - ``startup-delay-us``
- ``int``
- .. code-block:: none
Startup time, in microseconds
.. 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 "regulator-gpio" 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.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.