PebbleOS v4.47.0-505-g4bbc630fa
Loading...
Searching...
No Matches
Charger

Battery charger class. More...

Modules

 Simulator
 Simulated charger, with a full battery and no external power until pbl_charger_sim_set() changes it.
 

Data Structures

struct  pbl_charger_measurements
 Battery measurements. More...
 
struct  pbl_charger_listener
 Charger listener. More...
 
struct  pbl_charger_ops
 Charger driver operations, called with the device lock held. More...
 
struct  pbl_charger_state
 Charger runtime state. More...
 
struct  pbl_charger
 Charger. More...
 

Macros

#define PBL_CHARGER_STATE_DEFINE(sym)
 Define the class state of a charger.
 
#define PBL_CHARGER_INIT(sym, _name, _parent, _ops)
 Initialize a struct pbl_charger.
 

Enumerations

enum  pbl_charger_status {
  PBL_CHARGER_STATUS_UNKNOWN , PBL_CHARGER_STATUS_FULL , PBL_CHARGER_STATUS_TRICKLE , PBL_CHARGER_STATUS_CONSTANT_CURRENT ,
  PBL_CHARGER_STATUS_CONSTANT_VOLTAGE
}
 Charge status. More...
 

Functions

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.
 

Variables

const struct pbl_charger *const CHARGER
 The board's charger.
 

Detailed Description

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().

// meas.voltage_mv, meas.current_ua, meas.temp_mc
}
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.

Data Structure Documentation

◆ pbl_charger_measurements

struct pbl_charger_measurements

Battery 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

struct pbl_charger_state

Charger runtime 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

struct pbl_charger

Charger.

Data Fields
struct pbl_device dev Device.
const struct pbl_charger_ops * ops Driver operations.
struct pbl_charger_state * state Runtime state.

Macro Definition Documentation

◆ PBL_CHARGER_INIT

#define PBL_CHARGER_INIT (   sym,
  _name,
  _parent,
  _ops 
)
Value:
{ \
.dev = PBL_DEVICE_INIT_CLASS(sym, _name, pbl_charger_dev_init, _parent, &pbl_charger_class), \
.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
symSymbol of the instance, as passed to PBL_CHARGER_STATE_DEFINE().
_nameDevice name.
_parentParent device, or NULL.
_opsDriver operations.

◆ PBL_CHARGER_STATE_DEFINE

#define PBL_CHARGER_STATE_DEFINE (   sym)
Value:
static struct pbl_charger_state sym##_charger_state = {.lock = PBL_MUTEX_INITIALIZER}
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
symSymbol of the instance.

Enumeration Type Documentation

◆ 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.

Function Documentation

◆ pbl_charger_enable()

int pbl_charger_enable ( const struct pbl_charger *  charger,
bool  enable 
)

Allow charging or not.

Parameters
chargerCharger.
enableTrue to allow charging.
Returns
0 or a negative errno.

◆ pbl_charger_get_measurements()

int pbl_charger_get_measurements ( const struct pbl_charger *  charger,
struct pbl_charger_measurements *  meas 
)

Measure the battery voltage, current and temperature.

Parameters
chargerCharger.
[out]measMeasurements.
Returns
0 or a negative errno.

◆ pbl_charger_get_status()

int pbl_charger_get_status ( const struct pbl_charger *  charger,
enum pbl_charger_status *  status 
)

Get the charge status.

Parameters
chargerCharger.
[out]statusCharge status.
Returns
0 or a negative errno.

◆ pbl_charger_high_load_release()

int pbl_charger_high_load_release ( const struct pbl_charger *  charger)

Release a request made with pbl_charger_high_load_request().

Parameters
chargerCharger.
Returns
0, -EALREADY if no request is held, or a negative errno.

◆ 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
chargerCharger.
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
chargerCharger.
[out]chargingTrue 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
chargerCharger.
[out]onlineTrue 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
chargerCharger.

◆ pbl_charger_set_listener()

void pbl_charger_set_listener ( const struct pbl_charger *  charger,
const struct pbl_charger_listener *  listener 
)

Set the listener of a charger.

Parameters
chargerCharger.
listenerListener, or NULL for none.

Variable Documentation

◆ CHARGER

const struct pbl_charger* const CHARGER
extern

The board's charger.