Battery charger class.
More...
|
| int | pbl_charger_is_online (const struct pbl_charger *charger, bool *online) |
| | Check whether external power is present.
|
| |
| int | pbl_charger_get_status (const struct pbl_charger *charger, enum pbl_charger_status *status) |
| | Get the charge status.
|
| |
| int | pbl_charger_is_charging (const struct pbl_charger *charger, bool *charging) |
| | Check whether the battery is charging: trickle, constant current or constant voltage.
|
| |
| int | pbl_charger_get_measurements (const struct pbl_charger *charger, struct pbl_charger_measurements *meas) |
| | Measure the battery voltage, current and temperature.
|
| |
| int | pbl_charger_enable (const struct pbl_charger *charger, bool enable) |
| | Allow charging or not.
|
| |
| int | pbl_charger_high_load_request (const struct pbl_charger *charger) |
| | Request a high discharge current, e.g.
|
| |
| int | pbl_charger_high_load_release (const struct pbl_charger *charger) |
| | Release a request made with pbl_charger_high_load_request().
|
| |
| void | pbl_charger_set_listener (const struct pbl_charger *charger, const struct pbl_charger_listener *listener) |
| | Set the listener of a charger.
|
| |
| void | pbl_charger_report_online_changed (const struct pbl_charger *charger) |
| | Report that external power was connected or removed, for drivers.
|
| |
Battery charger class.
A charger is a struct pbl_charger device: it reports whether external power is present, the charge status and the battery voltage, current and temperature, and lets the battery be charged or not. Every call into the driver runs with the device lock held, a recursive mutex.
Drivers report external power changes with pbl_charger_report_online_changed(), from thread context, to the listener set with pbl_charger_set_listener().
}
Battery measurements.
Definition charger.h:50
const struct pbl_charger *const CHARGER
The board's charger.
int pbl_charger_get_measurements(const struct pbl_charger *charger, struct pbl_charger_measurements *meas)
Measure the battery voltage, current and temperature.
◆ pbl_charger_measurements
| struct pbl_charger_measurements |
| Data Fields |
|
int32_t |
current_ua |
Current in uA, positive while discharging. |
|
int32_t |
temp_mc |
Temperature in millidegrees Celsius. |
|
int32_t |
voltage_mv |
Voltage in mV. |
◆ pbl_charger_state
| Data Fields |
|
uint8_t |
high_load_count |
Number of high load requests held. |
|
const struct pbl_charger_listener * |
listener |
Listener, or NULL. |
|
struct pbl_mutex |
lock |
Device lock. |
◆ pbl_charger
◆ PBL_CHARGER_INIT
| #define PBL_CHARGER_INIT |
( |
|
sym, |
|
|
|
_name, |
|
|
|
_parent, |
|
|
|
_ops |
|
) |
| |
Value: { \
.ops = (_ops), \
.state = &sym##_charger_state, \
}
#define PBL_DEVICE_INIT_CLASS(sym, _name, _init, _parent, _cls)
Initializer for the struct pbl_device of device instance sym, in class _cls.
Definition device.h:153
Initialize a struct pbl_charger.
- Parameters
-
| sym | Symbol of the instance, as passed to PBL_CHARGER_STATE_DEFINE(). |
| _name | Device name. |
| _parent | Parent device, or NULL. |
| _ops | Driver operations. |
◆ PBL_CHARGER_STATE_DEFINE
| #define PBL_CHARGER_STATE_DEFINE |
( |
|
sym | ) |
|
Value:
struct pbl_mutex lock
Device lock.
Definition charger.h:84
Charger runtime state.
Definition charger.h:82
#define PBL_DEVICE_STATE_DEFINE(sym)
Define the runtime state of device instance sym.
Definition device.h:132
#define PBL_MUTEX_INITIALIZER
Static initializer for an unlocked mutex.
Definition mutex.h:50
Define the class state of a charger.
- Parameters
-
| sym | Symbol of the instance. |
◆ pbl_charger_status
Charge status.
| Enumerator |
|---|
| PBL_CHARGER_STATUS_UNKNOWN | Not charging, or not reported.
|
| PBL_CHARGER_STATUS_FULL | Charge complete, battery full.
|
| PBL_CHARGER_STATUS_TRICKLE | Trickle charging.
|
| PBL_CHARGER_STATUS_CONSTANT_CURRENT | Constant current charging.
|
| PBL_CHARGER_STATUS_CONSTANT_VOLTAGE | Constant voltage charging.
|
◆ pbl_charger_enable()
| int pbl_charger_enable |
( |
const struct pbl_charger * |
charger, |
|
|
bool |
enable |
|
) |
| |
Allow charging or not.
- Parameters
-
| charger | Charger. |
| enable | True to allow charging. |
- Returns
- 0 or a negative errno.
◆ pbl_charger_get_measurements()
Measure the battery voltage, current and temperature.
- Parameters
-
| charger | Charger. |
| [out] | meas | Measurements. |
- Returns
- 0 or a negative errno.
◆ pbl_charger_get_status()
Get the charge status.
- Parameters
-
| charger | Charger. |
| [out] | status | Charge status. |
- Returns
- 0 or a negative errno.
◆ pbl_charger_high_load_release()
| int pbl_charger_high_load_release |
( |
const struct pbl_charger * |
charger | ) |
|
◆ pbl_charger_high_load_request()
| int pbl_charger_high_load_request |
( |
const struct pbl_charger * |
charger | ) |
|
Request a high discharge current, e.g.
for the speaker.
Requests nest: the battery may supply a high current until each one is released.
- Parameters
-
- Returns
- 0,
-ENOTSUP if the charger has no such limit, or a negative errno.
◆ pbl_charger_is_charging()
| int pbl_charger_is_charging |
( |
const struct pbl_charger * |
charger, |
|
|
bool * |
charging |
|
) |
| |
Check whether the battery is charging: trickle, constant current or constant voltage.
- Parameters
-
| charger | Charger. |
| [out] | charging | True while charging. |
- Returns
- 0 or a negative errno.
◆ pbl_charger_is_online()
| int pbl_charger_is_online |
( |
const struct pbl_charger * |
charger, |
|
|
bool * |
online |
|
) |
| |
Check whether external power is present.
- Parameters
-
| charger | Charger. |
| [out] | online | True if external power is present. |
- Returns
- 0 or a negative errno.
◆ pbl_charger_report_online_changed()
| void pbl_charger_report_online_changed |
( |
const struct pbl_charger * |
charger | ) |
|
Report that external power was connected or removed, for drivers.
From thread context.
- Parameters
-
◆ pbl_charger_set_listener()
Set the listener of a charger.
- Parameters
-
| charger | Charger. |
| listener | Listener, or NULL for none. |
◆ CHARGER