: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,cpu-freq-thermal-cap
.. _dtbinding_zephyr_cpu_freq_thermal_cap:

zephyr,cpu-freq-thermal-cap
###########################

.. sidebar:: Overview

   :Name: ``zephyr,cpu-freq-thermal-cap``
   :Vendor: :ref:`Zephyr Project <dt_vendor_zephyr>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=zephyr,cpu-freq-thermal-cap>` using
               this compatible

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



.. code-block:: none

   CPU frequency thermal cap.

   Thermal cap constraints use the performance-states child order as the
   CPU frequency ordering: lower index P-states are treated as higher-performance,
   higher index P-states are treated as lower-performance and more restrictive.

Properties
**********

Top level properties
====================


These property descriptions apply to "zephyr,cpu-freq-thermal-cap"
nodes themselves. This page also describes child node
properties in the following sections.

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

         * - ``sensor``
           - ``phandle``
           - .. code-block:: none

                Temperature sensor used to compute the CPU frequency thermal cap.



             This property is **required**.

         * - ``sensor-channel``
           - ``string``
           - .. code-block:: none

                Sensor channel used for temperature samples.



             Default value: ``die-temp``

             Legal values: ``die-temp``, ``ambient-temp``

         * - ``polling-delay-ms``
           - ``int``
           - .. code-block:: none

                Polling interval in milliseconds while no thermal trip is active.



             Default value: ``1000``

         * - ``trip-active-polling-delay-ms``
           - ``int``
           - .. code-block:: none

                Polling interval in milliseconds while one or more thermal trips are active.
                This is typically shorter than polling-delay-ms so cap changes and release
                decisions are reflected promptly.



             Default value: ``100``



   .. 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,cpu-freq-thermal-cap" compatible.

      (None)


Child node properties
=====================

.. list-table::
   :widths: 1 1 4
   :header-rows: 1

   * - Name
     - Type
     - Details

   * - ``temperature-millicelsius``
     - ``int``
     - .. code-block:: none

          Temperature threshold in millicelsius. When this threshold is reached, the
          trip becomes active and constrains CPU frequency to cap-pstate or lower.



       This property is **required**.

   * - ``hysteresis-millicelsius``
     - ``int``
     - .. code-block:: none

          Hysteresis in millicelsius. An active trip is released when the measured
          temperature falls to temperature-millicelsius minus this value.



       This property is **required**.

   * - ``cap-pstate``
     - ``phandle``
     - .. code-block:: none

          Highest-performance P-state allowed while this trip is active.
          The referenced P-state must belong to the ordered performance-states table.



       This property is **required**.