: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,generic-pstate
.. _dtbinding_zephyr_generic_pstate:

zephyr,generic-pstate
#####################

.. sidebar:: Overview

   :Name: ``zephyr,generic-pstate``
   :Vendor: :ref:`The Zephyr Project <dt_vendor_zephyr>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=zephyr,generic-pstate>` using
               this compatible

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



.. code-block:: none

   Generic Performance State (P-state) binding

   Implement a generic P-state device node.

   Example configuration:

   performance-states {
           pstate_0: pstate_0 {
                   compatible = "zephyr,generic-pstate";
                   load-threshold = <50>;
                   pstate-id = <0>;
           };
           pstate_1: pstate_1 {
                   compatible = "zephyr,generic-pstate";
                   load-threshold = <20>;
                   pstate-id = <1>;
           };
           pstate_2: pstate_2 {
                   compatible = "zephyr,generic-pstate";
                   load-threshold = <0>;
                   pstate-id = <2>;
           };
   };

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

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

                Identifier of performance state. The state IDs shall be unique among all
                sibling nodes. It is recommended that they begin at 0 and monotonically
                increase with decreasing performance (increasing power savings).



             This property is **required**.

         * - ``load-threshold``
           - ``int``
           - .. code-block:: none

                CPU load threshold, in percent, for entering this performance state. Once
                the CPU load exceeds this threshold, it becomes a valid performance state
                for the P-state driver to switch to.





   .. 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,generic-pstate" compatible.

      (None)