: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,fuel-gauge-composite
.. _dtbinding_zephyr_fuel_gauge_composite:

zephyr,fuel-gauge-composite
###########################

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

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/fuel_gauge/composite/fuel_gauge_composite.c`.

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



.. code-block:: none

   Composite fuel-gauge constructed from analog input values

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

         * - ``battery-voltage``
           - ``phandle``
           - .. code-block:: none

                Device to read battery voltage from.

                Device must implement the sensor API and provide the
                `SENSOR_CHAN_VOLTAGE` channel.



             This property is **required**.

         * - ``battery-current``
           - ``phandle``
           - .. code-block:: none

                Device to read battery current from.

                Device must implement the sensor API and provide the
                `SENSOR_CHAN_CURRENT` channel.



         * - ``device-chemistry``
           - ``string``
           - .. code-block:: none

                This describes the chemical technology of the battery. The "lithium-ion" value is a blanket type for all lithium-ion batteries. If the specific chemistry is unknown, this value can be used instead of the precise "lithium-ion-X" options.


             This property is **required**.

             Legal values: ``'nickel-cadmium'``, ``'nickel-metal-hydride'``, ``'lithium-ion'``, ``'lithium-ion-polymer'``, ``'lithium-ion-iron-phosphate'``, ``'lithium-ion-manganese-oxide'``

         * - ``ocv-capacity-table-0``
           - ``array``
           - .. code-block:: none

                An array providing the open circuit voltage (OCV) , which is used to look
                up battery capacity according to current OCV value. The OCV unit is
                microvolts.

                Unlike the linux equivalent this array is required to be 11 elements
                long, representing the voltages for 0-100% charge in 10% steps.



             This property is **required**.

         * - ``charge-full-design-microamp-hours``
           - ``int``
           - .. code-block:: none

                battery design capacity


         * - ``re-charge-voltage-microvolt``
           - ``int``
           - .. code-block:: none

                limit to automatically start charging again


         * - ``precharge-current-microamp``
           - ``int``
           - .. code-block:: none

                current for pre-charge phase


         * - ``charge-term-current-microamp``
           - ``int``
           - .. code-block:: none

                current for charge termination phase


         * - ``constant-charge-current-max-microamp``
           - ``int``
           - .. code-block:: none

                maximum constant input current


         * - ``constant-charge-voltage-max-microvolt``
           - ``int``
           - .. code-block:: none

                maximum constant input voltage




   .. 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,fuel-gauge-composite" compatible.

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

         * - Name
           - Type
           - Details

         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`zephyr:dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`zephyr:dt-important-props` for more information.

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``power-domains``
           - ``phandle-array``
           - .. code-block:: none

                Power domain specifiers


         * - ``power-domain-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of power domain specifiers


         * - ``#power-domain-cells``
           - ``int``
           - .. code-block:: none

                Number of cells in power-domains property


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().



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

                Property to identify that a device can be used as wake up source.

                When this property is provided a specific flag is set into the
                device that tells the system that the device is capable of
                wake up the system.

                Wake up capable devices are disabled (interruptions will not wake up
                the system) by default but they can be enabled at runtime if necessary.



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

                Automatically configure the device for runtime power management after the
                init function runs.



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.