Re: [PATCH v4 2/8] devicetree: power: add battery state machine documentation

[Sebastian Reichel <sre@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 2086 bytes --]

Hi,

On Sun, Jan 29, 2017 at 03:22:31PM -0800, Liam Breck wrote:
> On Sun, Jan 29, 2017 at 9:20 AM, Sebastian Reichel <sre@kernel.org> wrote:
> > On Wed, Jan 25, 2017 at 11:02:03PM -0800, Matt Ranostay wrote:
> >> On Wed, Jan 25, 2017 at 10:19 PM, Liam Breck <liam@networkimprov.net> wrote:
> >> > On Sun, Jan 22, 2017 at 2:22 PM, Liam Breck <liam@networkimprov.net> wrote:
> >> >
> >> >> diff --git a/Documentation/devicetree/bindings/power/supply/battery.txt b/Documentation/devicetree/bindings/power/supply/battery.txt
> >> >> new file mode 100644
> >> >> index 000000000000..398b4d622883
> >> >> --- /dev/null
> >> >> +++ b/Documentation/devicetree/bindings/power/supply/battery.txt
> >> >> @@ -0,0 +1,34 @@
> >> >> +Battery Characteristics
> >> >> +
> >> >> +Required Properties:
> >> >> + - compatible: Must be "fixed-battery"
> >> >> +
> >> >> +Optional Properties:
> >> >> + - termination-microvolt: dead battery voltage
> >> >> + - design-microwatt-hours: battery design energy
> >> >> + - design-microamp-hours: battery design capacity
> >> >
> >> > Also I suspect the members of struct power_supply_battery_info should
> >> > use the same names as appear in dts:
> >>
> >> These are internal and we can't be thinking just device tree.. ACPI
> >> and platform data is also an option.
> >
> > well platform data just uses the struct. ACPI is probably not
> > relevant, since in ACPI world one usually has smart batteries.
> > But yes, the names can be different.
> >
> > The important part is, that the API is used correctly, so it
> > should be clear what each property is used for. For example
> > termination_microvolt is not clear: Is this charge termination
> > voltage or system shutdown voltage? Also we do not need to add
> > "micro", since the power-supply subsystem always uses micro
> > based units.
> 
> It's the min battery voltage. So...
> drained_voltage, depleted_voltage, sapped_voltage, spent_voltage...

This is often called EOD (end of discharge) voltage, so let's use
end_of_discharge_voltage.

-- Sebastian

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]