charger: Adds basic stub API doc

Adds a short stub doc as a placeholder for future documentation in the
charger API.

Signed-off-by: Ricardo Rivera-Matos <rriveram@opensource.cirrus.com>
This commit is contained in:
Ricardo Rivera-Matos 2023-04-03 11:10:44 -05:00 committed by Anas Nashif
parent aee815f19d
commit a627035290
3 changed files with 34 additions and 0 deletions

View file

@ -57,6 +57,10 @@ between major releases are available in the :ref:`zephyr_release_notes`.
- Stable
- 1.14
* - :ref:`charger_api`
- Experimental
- 3.5
* - :ref:`counter_api`
- Unstable
- 1.14

View file

@ -0,0 +1,29 @@
.. _charger_api:
Chargers
########
The charger subsystem exposes an API to uniformly access battery charger devices. Currently,
only reading data is supported.
Basic Operation
***************
Properties
==========
Fundamentally, a property is a configurable setting, state, or quantity that a charger device can
measure.
Chargers typically support multiple properties, such as temperature readings of the battery-pack
or present-time current/voltage.
Properties are fetched using a client allocated array of :c:struct:`charger_get_property`. This
array is then populated by values as according to its `property_type` field.
.. _charger_api_reference:
API Reference
*************
.. doxygengroup:: charger_interface

View file

@ -17,6 +17,7 @@ Peripherals
bc12.rst
clock_control.rst
canbus/index.rst
charger.rst
coredump.rst
counter.rst
dac.rst