zephyr,fuel-gauge-composite

Vendor: Zephyr-specific binding

Note

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

Description

Composite fuel-gauge constructed from analog input values

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

battery-voltage

phandle

 
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

 
Device to read battery current from.

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

device-chemistry

string

 
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

 
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

 
battery design capacity

re-charge-voltage-microvolt

int

 
limit to automatically start charging again

precharge-current-microamp

int

 
current for pre-charge phase

charge-term-current-microamp

int

 
current for charge termination phase

constant-charge-current-max-microamp

int

 
maximum constant input current

constant-charge-voltage-max-microvolt

int

 
maximum constant input voltage

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

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.

Name

Type

Details

status

string

 
indicates the operational status of a device

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

See Important properties for more information.

compatible

string-array

 
compatible strings

This property is required.

See Important properties for more information.

reg

array

 
register space

See Important properties for more information.

reg-names

string-array

 
name of each register space

interrupts

array

 
interrupts for device

See Important properties for more information.

interrupts-extended

compound

 
extended interrupt specifier for device

interrupt-names

string-array

 
name of each interrupt

interrupt-parent

phandle

 
phandle to interrupt controller node

label

string

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

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

 
Clock gate information

clock-names

string-array

 
name of each clock

#address-cells

int

 
number of address cells in reg property

#size-cells

int

 
number of size cells in reg property

dmas

phandle-array

 
DMA channels specifiers

dma-names

string-array

 
Provided names of DMA channel specifiers

io-channels

phandle-array

 
IO channels specifiers

io-channel-names

string-array

 
Provided names of IO channel specifiers

mboxes

phandle-array

 
mailbox / IPM channels specifiers

mbox-names

string-array

 
Provided names of mailbox / IPM channel specifiers

power-domains

phandle-array

 
Power domain specifiers

power-domain-names

string-array

 
Provided names of power domain specifiers

#power-domain-cells

int

 
Number of cells in power-domains property

zephyr,deferred-init

boolean

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

wakeup-source

boolean

 
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

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

zephyr,disabling-power-states

phandles

 
List of power states that will disable this device power.