power: supply: core: Add kerneldoc to battery struct
authorLinus Walleij <linus.walleij@linaro.org>
Tue, 16 Nov 2021 22:44:28 +0000 (23:44 +0100)
committerSebastian Reichel <sebastian.reichel@collabora.com>
Wed, 17 Nov 2021 16:51:04 +0000 (17:51 +0100)
commite0dbd7b0ed021fb9250f7ba4d759325678efefb5
tree9bb5edd6596f0f0f3a95f65fe3f6ab2cfe2f5847
parenta4585ba2050f460f749bbaf2b67bd56c41e30283
power: supply: core: Add kerneldoc to battery struct

This complements the struct power_supply_battery_info with
extensive kerneldoc explaining the different semantics of the
fields, including an overview of the CC/CV charging concepts
implicit in some of the struct members.

This is done to first establish semantics before I can
add more charging methods by breaking out the CC/CV parameters
to its own struct.

Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
include/linux/power_supply.h