: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:: infineon,hibernate-wakeup
.. _dtbinding_infineon_hibernate_wakeup:

infineon,hibernate-wakeup
#########################

.. sidebar:: Overview

   :Name: ``infineon,hibernate-wakeup``
   :Vendor: :ref:`Infineon Technologies <dt_vendor_infineon>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=infineon,hibernate-wakeup>` using
               this compatible

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



.. code-block:: none

   Infineon hibernate / hibernate-RAM wakeup source configuration.

   Infineon SoCs provide a set of dedicated hardware sources that can wake the
   device from the hibernate (and, where supported, hibernate-RAM) power modes.
   This binding describes the hibernate wakeup sources:

     PIN0, PIN1, LPCOMP0, LPCOMP1, WDT, RTC alarm

   The pin-to-pad mapping is fixed in silicon and differs per device; consult
   the SoC datasheet or the SoC devicetree for the mapping.  A device enables
   only the sources it uses - set only the applicable properties below.

   Each pin and LPCOMP source can be independently enabled and configured to wake
   on a high or low logic level.

   Example (wake on the first dedicated pin, active low):

     hibernate_wakeup: hibernate-wakeup {
         compatible = "infineon,hibernate-wakeup";
         wakeup-pin0-trigger = "low";
     };

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

         * - ``wakeup-pin0-trigger``
           - ``string``
           - .. code-block:: none

                Enable dedicated wake PIN0 as a hibernate wakeup source.  The physical pad
                is device-specific (see the SoC devicetree/datasheet).  Set to "low" to
                wake on a low logic level, "high" for a high level.  Omit to disable PIN0.



             Legal values: ``low``, ``high``

         * - ``wakeup-pin1-trigger``
           - ``string``
           - .. code-block:: none

                Enable dedicated wake PIN1 as a hibernate wakeup source.  The physical pad
                is device-specific (see the SoC devicetree/datasheet).  Set to "low" to
                wake on a low logic level, "high" for a high level.  Omit to disable PIN1.



             Legal values: ``low``, ``high``

         * - ``wakeup-lpcomp0-trigger``
           - ``string``
           - .. code-block:: none

                Enable low-power comparator 0 (LPCOMP0) as a hibernate wakeup source.
                Set to "low" to wake on a low output level, "high" for a high level.
                Omit to disable LPCOMP0.



             Legal values: ``low``, ``high``

         * - ``wakeup-lpcomp1-trigger``
           - ``string``
           - .. code-block:: none

                Enable low-power comparator 1 (LPCOMP1) as a hibernate wakeup source.
                Set to "low" to wake on a low output level, "high" for a high level.
                Omit to disable LPCOMP1.



             Legal values: ``low``, ``high``

         * - ``wakeup-wdt``
           - ``boolean``
           - .. code-block:: none

                Enable the watchdog timer as a hibernate wakeup source.


         * - ``wakeup-rtc-alarm``
           - ``boolean``
           - .. code-block:: none

                Enable RTC alarm as a hibernate wakeup source.




   .. 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 "infineon,hibernate-wakeup" compatible.

      (None)