From d929fc513c2b511e079bfc42cb686cb461f19d64 Mon Sep 17 00:00:00 2001 From: Ricardo Rivera-Matos Date: Mon, 22 Apr 2024 11:34:34 -0500 Subject: [PATCH] doc: charger: Adds introductory context to documentation Adds some introductory context to the charger documentation. This is being aided to help developers understand what a charger device is and how the charger_driver_api is relevant to system operation. Signed-off-by: Ricardo Rivera-Matos --- doc/hardware/peripherals/charger.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/hardware/peripherals/charger.rst b/doc/hardware/peripherals/charger.rst index 0198fe11f65..e0285d036d0 100644 --- a/doc/hardware/peripherals/charger.rst +++ b/doc/hardware/peripherals/charger.rst @@ -5,6 +5,18 @@ Chargers The charger subsystem exposes an API to uniformly access battery charger devices. +A charger device, or charger peripheral, is a device used to take external power provided to the +system as an input and provide power as an output downstream to the battery pack(s) and system. +The charger device can exist as a module, an integrated circuit, or as a functional block in a power +management integrated circuit (PMIC). + +The action of charging a battery pack is referred to as a charge cycle. When the charge cycle is +executed the battery pack is charged according to the charge profile configured on the charger +device. The charge profile is defined in the battery pack's specification that is provided by the +manufacturer. On charger devices with a control port, the charge profile can be configured by the +host controller by setting the relevant properties, and can be adjusted at runtime to respond to +environmental changes. + Basic Operation ***************