devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
  • * [PATCH v13 02/11] dt-bindings: power: supply: Add battery.txt with simple-battery binding
           [not found] <20170504061811.18107-1-liam@networkimprov.net>
           [not found] ` <20170504061811.18107-1-liam-RYWXG+zxWwBdeoIcmNTgJF6hYfS7NtTn@public.gmane.org>
    @ 2017-05-04  6:18 ` Liam Breck
      1 sibling, 0 replies; 3+ messages in thread
    From: Liam Breck @ 2017-05-04  6:18 UTC (permalink / raw)
      To: Sebastian Reichel, Andrew F. Davis, linux-pm
      Cc: Rob Herring, devicetree, Matt Ranostay, Liam Breck
    
    From: Liam Breck <kernel@networkimprov.net>
    
    Documentation of static battery characteristics that can be defined
    for batteries that do not embed this data, which are required by
    fuel-gauge and charger chips for proper handling of the battery.
    
    The following properties are defined:
      voltage-min-design-microvolt
      charge-full-design-microamp-hours
      energy-full-design-microwatt-hours
      precharge-current-microamp
      charge-term-current-microamp
    
    Property names are derived from corresponding elements in
    enum power_supply_property from include/linux/power_supply.h
    https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/linux/power_supply.h
    
    Cc: Rob Herring <robh@kernel.org>
    Cc: devicetree@vger.kernel.org
    Signed-off-by: Matt Ranostay <matt@ranostay.consulting>
    Signed-off-by: Liam Breck <kernel@networkimprov.net>
    Acked-by: Rob Herring <robh@kernel.org>
    ---
     .../devicetree/bindings/power/supply/battery.txt   | 53 ++++++++++++++++++++++
     1 file changed, 53 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..61d9153
    --- /dev/null
    +++ b/Documentation/devicetree/bindings/power/supply/battery.txt
    @@ -0,0 +1,53 @@
    +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.
    +
    +Upstream dts files should not include battery nodes, unless the battery
    +represented cannot easily be replaced in the system by one of a
    +different type. This prevents unpredictable, potentially harmful,
    +behavior should a replacement that changes the battery type occur
    +without a corresponding update to the dtb.
    +
    +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
    + - precharge-current-microamp: current for pre-charge phase
    + - charge-term-current-microamp: current for charge termination phase
    +
    +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
    +
    +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>;
    +		precharge-current-microamp = <256000>;
    +		charge-term-current-microamp = <128000>;
    +	};
    +
    +	charger: charger@11 {
    +		....
    +		monitored-battery = <&bat>;
    +		...
    +	};
    +
    +	fuel_gauge: fuel-gauge@22 {
    +		....
    +		monitored-battery = <&bat>;
    +		...
    +	};
    -- 
    2.9.3
    
    ^ permalink raw reply related	[flat|nested] 3+ messages in thread

  • end of thread, other threads:[~2017-05-04  6:18 UTC | newest]
    
    Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
    -- links below jump to the message on this page --
         [not found] <20170504061811.18107-1-liam@networkimprov.net>
         [not found] ` <20170504061811.18107-1-liam-RYWXG+zxWwBdeoIcmNTgJF6hYfS7NtTn@public.gmane.org>
    2017-05-04  6:18   ` [PATCH v13 01/11] devicetree: property-units: Add uWh and uAh units Liam Breck
    2017-05-04  6:18   ` [PATCH v13 05/11] dt-bindings: power: supply: bq27xxx: Add monitored-battery documentation Liam Breck
    2017-05-04  6:18 ` [PATCH v13 02/11] dt-bindings: power: supply: Add battery.txt with simple-battery binding Liam Breck
    

    This is a public inbox, see mirroring instructions
    for how to clone and mirror all data and code used for this inbox;
    as well as URLs for NNTP newsgroup(s).