:orphan:
.. raw:: html
.. dtcompatible:: adi,adp5360-fuel-gauge
.. _dtbinding_adi_adp5360_fuel_gauge:
adi,adp5360-fuel-gauge
######################
.. sidebar:: Overview
:Name: ``adi,adp5360-fuel-gauge``
:Vendor: :ref:`Analog Devices, Inc. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=adi,adp5360-fuel-gauge>` using
this compatible
:Driver: :zephyr_file:`drivers/fuel_gauge/adp5360/fuel_gauge_adp5360.c`
Description
***********
.. code-block:: none
Analog Devices ADP5360 fuel gauge
The ADP5360 is a multi-function power management IC (PMIC)
that includes a battery charger, regulator, and fuel gauge.
This binding describes the fuel gauge function.
The fuel gauge provides battery monitoring including:
- State of charge (SOC)
- Battery voltage
- Charge cycle accumulation
- Programmable SOC voltage table
The fuel gauge is modeled in DT as a child device of "adi,adp5360" compatible node.
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
* - ``v-soc-0``
- ``int``
- .. code-block:: none
Voltage corresponding to 0% state of charge (SOC) in mV.
The device default for this setting is 3.5V.
Default value: ``3500``
* - ``v-soc-5``
- ``int``
- .. code-block:: none
Voltage corresponding to 5% SOC in mV.
The device default for this setting is 3.66V.
Default value: ``3660``
* - ``v-soc-11``
- ``int``
- .. code-block:: none
Voltage corresponding to 11% SOC in mV.
The device default for this setting is 3.684V.
Default value: ``3684``
* - ``v-soc-19``
- ``int``
- .. code-block:: none
Voltage corresponding to 19% SOC in mV.
The device default for this setting is 3.724V.
Default value: ``3724``
* - ``v-soc-28``
- ``int``
- .. code-block:: none
Voltage corresponding to 28% SOC in mV.
The device default for this setting is 3.764V.
Default value: ``3764``
* - ``v-soc-41``
- ``int``
- .. code-block:: none
Voltage corresponding to 41% SOC in mV.
The device default for this setting is 3.804V.
Default value: ``3804``
* - ``v-soc-55``
- ``int``
- .. code-block:: none
Voltage corresponding to 55% SOC in mV.
The device default for this setting is 3.868V.
Default value: ``3868``
* - ``v-soc-69``
- ``int``
- .. code-block:: none
Voltage corresponding to 69% SOC in mV.
The device default for this setting is 3.948V.
Default value: ``3948``
* - ``v-soc-84``
- ``int``
- .. code-block:: none
Voltage corresponding to 84% SOC in mV.
The device default for this setting is 4.068V.
Default value: ``4068``
* - ``v-soc-100``
- ``int``
- .. code-block:: none
Voltage corresponding to 100% SOC in mV.
The device default for this setting is 4.204V.
Default value: ``4204``
* - ``bat-cap``
- ``int``
- .. code-block:: none
Battery capacity in mAh.
The device default for this setting is 100 mAh.
Default value: ``100``
* - ``bat-cap-age``
- ``int``
- .. code-block:: none
Battery Capacity Reduction Percentage When BAT_SOCACM Overflows.
The device default for this setting is 1.5% reduction.
Default value: ``1``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``bat-cap-temp``
- ``int``
- .. code-block:: none
Battery Capacity Compensation with Temperature Coefficient.
The device default for this setting is 0.2% / °C.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``bat-cap-temp-en``
- ``boolean``
- .. code-block:: none
Enable battery capacity compensation with temperature coefficient.
Default value corresponds to reset value of compensation.
* - ``bat-cap-age-en``
- ``boolean``
- .. code-block:: none
Enable battery capacity reduction when BAT_SOCACM overflows.
Default value corresponds to reset value of reduction.
* - ``soc-low-threshold``
- ``int``
- .. code-block:: none
SOC low threshold in percentage.
The device default for this setting is 11% SOC low threshold.
Default value: ``1``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``sleep-mode-current-threshold``
- ``int``
- .. code-block:: none
Sleep mode current threshold in mA.
The device default for this setting is 10 mA sleep mode current threshold.
Default value: ``1``
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``sleep-mode-update-rate``
- ``int``
- .. code-block:: none
Sleep mode update rate in seconds.
The device default for this setting is 1 minute sleep mode update rate.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``fuel-gauge-operation-mode``
- ``int``
- .. code-block:: none
Fuel gauge operation mode.
The device default for this setting is Normal mode.
Legal values: ``0``, ``1``
* - ``fuel-gauge-enable``
- ``boolean``
- .. code-block:: none
Enables fuel gauge on initialization.
.. 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 "adi,adp5360-fuel-gauge" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" 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.