Hi, On Thu, Mar 23, 2017 at 03:30:42AM -0700, Liam Breck wrote: > On Thu, Mar 23, 2017 at 3:20 AM, Sebastian Reichel <sre@xxxxxxxxxx> wrote: > > Hi, > > > > On Mon, Mar 20, 2017 at 02:43:26AM -0700, Liam Breck wrote: > >> From: Liam Breck <kernel@xxxxxxxxxxxxxxxxx> > >> > >> Documentation of static battery characteristics that can be defined > >> for batteries which cannot self-identify. This information is required > >> by fuel-gauge and charger chips for proper handling of the battery. > >> > >> Cc: Rob Herring <robh@xxxxxxxxxx> > >> Cc: devicetree@xxxxxxxxxxxxxxx > >> Signed-off-by: Matt Ranostay <matt@ranostay.consulting> > >> Signed-off-by: Liam Breck <kernel@xxxxxxxxxxxxxxxxx> > >> --- > >> .../devicetree/bindings/power/supply/battery.txt | 43 ++++++++++++++++++++++ > >> 1 file changed, 43 insertions(+) > >> create mode 100644 Documentation/devicetree/bindings/power/supply/battery.txt > >> > >> diff --git a/Documentation/devicetree/bindings/power/supply/battery.txt b/Documentation/devicetree/bindings/power/supply/battery.txt > >> new file mode 100644 > >> index 0000000..53a68c0 > >> --- /dev/null > >> +++ b/Documentation/devicetree/bindings/power/supply/battery.txt > >> @@ -0,0 +1,43 @@ > >> +Battery Characteristics > >> + > >> +The devicetree battery node provides static battery characteristics. > >> +In smart batteries, these are typically stored in non-volatile memory > >> +on a fuel gauge chip. The battery node should be used where there is > >> +no appropriate non-volatile memory, or it is unprogrammed/incorrect. > >> + > >> +Required Properties: > >> + - compatible: Must be "simple-battery" > >> + > >> +Optional Properties: > >> + - voltage-min-design-microvolt: drained battery voltage > >> + - energy-full-design-microwatt-hours: battery design energy > >> + - charge-full-design-microamp-hours: battery design capacity > >> + > >> +Battery properties are named, where possible, for the corresponding > >> +elements in enum power_supply_property, defined in > >> +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/linux/power_supply.h#n86 > > > > The above paragraph does not belong into DT bindings. Apart > > from that > > > > Acked-by: Sebastian Reichel <sre@xxxxxxxxxx> > > How then should I indicate that there is a method to the madness of > the above names? More information in the docs is helpful than less! You don't. This does not belong into the DT binding document. DT binding documents are _not_ Linux FW API. I thought we were through this already. FWIW if anything is not named like the power-supply subsystem names it, then that's not nice, but ok. Also if anybody adds stuff he will 1. send patches to the power-supply subsystem maintainer (me at the moment), who can reject patches. 2. implement the parsing in the driver, which asks for power-supply naming to be used if possible. -- Sebastian > > FYI: I will wait for Acked-by from Rob Herring on this patch. > > > > -- Sebastian > > > >> +Batteries must be referenced by chargers and/or fuel-gauges > >> +using a phandle. The phandle's property should be named > >> +"monitored-battery". > >> + > >> +Example: > >> + > >> + bat: battery { > >> + compatible = "simple-battery"; > >> + voltage-min-design-microvolt = <3200000>; > >> + energy-full-design-microwatt-hours = <5290000>; > >> + charge-full-design-microamp-hours = <1430000>; > >> + }; > >> + > >> + charger: charger@11 { > >> + .... > >> + monitored-battery = <&bat>; > >> + ... > >> + }; > >> + > >> + fuel_gauge: fuel-gauge@22 { > >> + .... > >> + monitored-battery = <&bat>; > >> + ... > >> + }; > >> -- > >> 2.9.3 > >>
Attachment:
signature.asc
Description: PGP signature
