: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:: nuvoton,npcx-power-state
.. _dtbinding_nuvoton_npcx_power_state:

nuvoton,npcx-power-state
########################

.. sidebar:: Overview

   :Name: ``nuvoton,npcx-power-state``
   :Vendor: :ref:`Nuvoton Technology Corporation <dt_vendor_nuvoton>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=nuvoton,npcx-power-state>` using
               this compatible

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



.. code-block:: none

   NPCX power management idle state. Extends the generic power state with the
   NPCX specific properties of the deep sleep sub-states.

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

         * - ``unlimited-instant-wakeup``
           - ``boolean``
           - .. code-block:: none

                The instant wake-up path stays valid for an unlimited residency in deep
                sleep. When omitted, instant wake-up is only guaranteed for a residency
                shorter than 200 ms and the standard wake-up sub-state must be used
                beyond that. Only supported since the NPCX4 series, earlier series have
                no such control bit and ignore the property.



         * - ``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.

                How much time the residency in a given idle state must last for state entry
                to be worthwhile energywise. It includes the time to enter into this state
                and represents the "break-even" time to justify the time and power spent
                on the work needed for entering and exiting the state based on how much actual energy
                is saved once in the state, compared to choosing the next shallowest 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 "nuvoton,npcx-power-state" compatible.

      (None)