:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: zephyr,power-state
.. _dtbinding_zephyr_power_state:

zephyr,power-state
##################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

Description
***********



.. code-block:: none

   Properties for power management state

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

         * - ``power-state-name``
           - ``string``
           - .. code-block:: none

                indicates a power state


             This property is **required**.

             Legal values: ``'active'``, ``'runtime-idle'``, ``'suspend-to-idle'``, ``'standby'``, ``'suspend-to-ram'``, ``'suspend-to-disk'``, ``'soft-off'``

         * - ``substate-id``
           - ``int``
           - .. code-block:: none

                Platform specific identification.


         * - ``min-residency-us``
           - ``int``
           - .. code-block:: none

                Minimum residency duration in microseconds. It is the minimum time for a
                given idle state to be worthwhile energywise. It includes the time to enter
                in this state.



         * - ``exit-latency-us``
           - ``int``
           - .. code-block:: none

                Worst case latency in microseconds required to exit the idle state.



         * - ``zephyr,pm-device-disabled``
           - ``boolean``
           - .. code-block:: none

                Disable system managed device power management for this state. When set,
                the power management subsystem will not suspend devices before entering
                this state.





   .. 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 "zephyr,power-state" compatible.

      (None)