Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
charger_driver_api Struct Reference

Driver Operations Charger driver operations More...

#include <zephyr/drivers/charger.h>

Data Fields

charger_get_property_t get_property
  REQ Fetch a battery charger property.
charger_set_property_t set_property
  REQ Set a battery charger property.
charger_charge_enable_t charge_enable
  REQ Enable or disable a charge cycle.

Detailed Description

Driver Operations Charger driver operations

This is the driver API structure any Charger driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Caching is entirely on the onus of the client.

Field Documentation

◆ charge_enable

charger_charge_enable_t charger_driver_api::charge_enable

REQ Enable or disable a charge cycle.

◆ get_property

charger_get_property_t charger_driver_api::get_property

REQ Fetch a battery charger property.

◆ set_property

charger_set_property_t charger_driver_api::set_property

REQ Set a battery charger property.


The documentation for this struct was generated from the following file: