Charger Interface

Charger Interface. More...

Data Structures
union	charger_propval
	container for a charger_property value More...
struct	charger_driver_api
	Charging device API. More...

Typedefs
typedef uint16_t	charger_prop_t
	A charger property's identifier.
typedef int(*	charger_get_property_t) (const struct device *dev, const charger_prop_t prop, union charger_propval *val)
	Callback API for getting a charger property.
typedef int(*	charger_set_property_t) (const struct device *dev, const charger_prop_t prop, const union charger_propval *val)
	Callback API for setting a charger property.

Enumerations
enum	charger_property {   CHARGER_PROP_ONLINE = 0 , CHARGER_PROP_PRESENT , CHARGER_PROP_STATUS , CHARGER_PROP_COMMON_COUNT ,   CHARGER_PROP_CUSTOM_BEGIN = CHARGER_PROP_COMMON_COUNT + 1 , CHARGER_PROP_MAX = UINT16_MAX }
	Runtime Dynamic Battery Parameters. More...
enum	charger_online { CHARGER_ONLINE_OFFLINE = 0 , CHARGER_ONLINE_FIXED , CHARGER_ONLINE_PROGRAMMABLE }
	External supply states. More...
enum	charger_status {   CHARGER_STATUS_UNKNOWN = 0 , CHARGER_STATUS_CHARGING , CHARGER_STATUS_DISCHARGING , CHARGER_STATUS_NOT_CHARGING ,   CHARGER_STATUS_FULL }
	Charging states. More...

Functions
int	charger_get_prop (const struct device *dev, const charger_prop_t prop, union charger_propval *val)
	Fetch a battery charger property.
int	charger_set_prop (const struct device *dev, const charger_prop_t prop, const union charger_propval *val)
	Set a battery charger property.

Detailed Description

Charger Interface.

Typedef Documentation

charger_get_property_t

charger_get_property_t

#include <zephyr/drivers/charger.h>

Callback API for getting a charger property.

See charger_get_property() for argument description

charger_prop_t

charger_prop_t

#include <zephyr/drivers/charger.h>

A charger property's identifier.

See charger_property for a list of identifiers

charger_set_property_t

charger_set_property_t

#include <zephyr/drivers/charger.h>

Callback API for setting a charger property.

See charger_set_property() for argument description

Enumeration Type Documentation

charger_online

enum charger_online

#include <zephyr/drivers/charger.h>

External supply states.

Enumerator
CHARGER_ONLINE_OFFLINE	External supply not present.
CHARGER_ONLINE_FIXED	External supply is present and of fixed output.
CHARGER_ONLINE_PROGRAMMABLE	External supply is present and of programmable output.

charger_property

enum charger_property

#include <zephyr/drivers/charger.h>

Runtime Dynamic Battery Parameters.

Enumerator
CHARGER_PROP_ONLINE	Indicates if external supply is present for the charger. Value should be of type enum charger_online
CHARGER_PROP_PRESENT	Reports whether or not a battery is present. Value should be of type bool
CHARGER_PROP_STATUS	Represents the charging status of the charger. Value should be of type enum charger_status
CHARGER_PROP_COMMON_COUNT	Reserved to demark end of common charger properties.
CHARGER_PROP_CUSTOM_BEGIN	Reserved to demark downstream custom properties - use this value as the actual value may change over future versions of this API.
CHARGER_PROP_MAX	Reserved to demark end of valid enum properties.

charger_status

enum charger_status

#include <zephyr/drivers/charger.h>

Charging states.

Enumerator
CHARGER_STATUS_UNKNOWN	Charging device state is unknown.
CHARGER_STATUS_CHARGING	Charging device is charging a battery.
CHARGER_STATUS_DISCHARGING	Charging device is not able to charge a battery.
CHARGER_STATUS_NOT_CHARGING	Charging device is not charging a battery.
CHARGER_STATUS_FULL	The battery is full and the charging device will not attempt charging.

Function Documentation

charger_get_prop()

int charger_get_prop	(	const struct device *	dev,
		const charger_prop_t	prop,
		union charger_propval *	val
	)

#include <zephyr/drivers/charger.h>

Fetch a battery charger property.

Parameters

dev	Pointer to the battery charger device
prop	Charger property to get
val	Pointer to charger_propval union

Return values

0	if successful
<	0 if getting property failed

charger_set_prop()

int charger_set_prop	(	const struct device *	dev,
		const charger_prop_t	prop,
		const union charger_propval *	val
	)

#include <zephyr/drivers/charger.h>

Set a battery charger property.

Parameters

dev	Pointer to the battery charger device
prop	Charger property to set
val	Pointer to charger_propval union

Return values

0	if successful
<	0 if setting property failed