From patchwork Wed Jun 7 18:37:50 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liam Breck X-Patchwork-Id: 9772283 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 87C5C6034B for ; Wed, 7 Jun 2017 18:38:35 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6844E2842B for ; Wed, 7 Jun 2017 18:38:35 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5C6E2284EA; Wed, 7 Jun 2017 18:38:35 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id D62732842B for ; Wed, 7 Jun 2017 18:38:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752283AbdFGSi3 (ORCPT ); Wed, 7 Jun 2017 14:38:29 -0400 Received: from mail-pg0-f65.google.com ([74.125.83.65]:35457 "EHLO mail-pg0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752264AbdFGSi1 (ORCPT ); Wed, 7 Jun 2017 14:38:27 -0400 Received: by mail-pg0-f65.google.com with SMTP id f127so2160999pgc.2; Wed, 07 Jun 2017 11:38:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=NGupIx1TTkEGg2SBnTfKRDTbz3ZHhA0HAUUGq4HlOcs=; b=QBhbqHNiu/igHvvx0J/v/VdKgXYbRjfrYj7SpyMZYTNN7Um465q6sF0LapKMpRY9xN w+Wf1NSaNJrwY/IsIuCN4MDNXOTjxpttkidyBkWjSvwSIm0qezAGkv19i0yqj6sOuz/N oC65hTQDVDzuezXcmvA0LkTVqHp3dwvcipOSAJkXxPSwhEBoGTTZgS9dbhZJnD9ys44g Ll20u9JUXZ+YvFNk+6R9qmKEwrplJVRkbIY1XYixs5NUEQ3KuntVdOcgRsW04QASpbko 5vsb7hB8FQFWGPKWYjjg3ZT5kK8olR5sKmJJuukUGxP6rtyCxRBBHCs4mx5gN/cYVN2H ZfHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references; bh=NGupIx1TTkEGg2SBnTfKRDTbz3ZHhA0HAUUGq4HlOcs=; b=DFMybQ0kNxpA5EjHtdI+lumrLWUJAYgXlPDme243VGoE2WRGuk1i6lzxCKkrcbFYvS cthVVDzlGq9Q2U/yxJ5SemuDP8uldsrGRHmvqFVyPbuJPNAXbL5G3qv6U/se29uSHYs1 rRkwSi29hra4uKbgIelyoByvIqLqkU95Oio6B0tF42tAqNP+ntx9b3Lld7CgnFEQhsvx JJ7QOBazgQ7v8ptCaBssiZheAp1X+2fmkIydyuMRQurjNQHzQAfObvgASHu4jUa6rSs+ n0CG8vXWhitCNR+7GjxsWPu0vpId2486BbsjCvfcE4yHT/Xcd7PcSBtdLwbpTzFQmSJ4 0chw== X-Gm-Message-State: AODbwcB6tWheikm5jTql/N0Emj47GF3uQeqtsWRC3zeyJYkr0/f6alr6 JCDhh2/elV8maAJ6adWoqA== X-Received: by 10.84.130.67 with SMTP id 61mr29558448plc.150.1496860705936; Wed, 07 Jun 2017 11:38:25 -0700 (PDT) Received: from localhost.localdomain (c-73-223-93-234.hsd1.ca.comcast.net. [73.223.93.234]) by smtp.gmail.com with ESMTPSA id q85sm319529pfd.7.2017.06.07.11.38.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 07 Jun 2017 11:38:25 -0700 (PDT) From: Liam Breck To: Sebastian Reichel , "Pali Rohar" , linux-pm@vger.kernel.org Cc: Enric Balletbo , Paul Kocialkowski , Quentin Schulz , Rob Herring , devicetree@vger.kernel.org, Matt Ranostay , Liam Breck Subject: [PATCH v14 02/11] dt-bindings: power: supply: Add battery.txt with simple-battery binding Date: Wed, 7 Jun 2017 11:37:50 -0700 Message-Id: <20170607183759.20261-3-liam@networkimprov.net> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20170607183759.20261-1-liam@networkimprov.net> References: <20170607183759.20261-1-liam@networkimprov.net> Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Liam Breck 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 constant-charge-current-max-microamp constant-charge-voltage-max-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 Cc: devicetree@vger.kernel.org Signed-off-by: Matt Ranostay Signed-off-by: Liam Breck Acked-by: Rob Herring --- .../devicetree/bindings/power/supply/battery.txt | 57 ++++++++++++++++++++++ 1 file changed, 57 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 00000000..f4d3b4a1 --- /dev/null +++ b/Documentation/devicetree/bindings/power/supply/battery.txt @@ -0,0 +1,57 @@ +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 + - constant-charge-current-max-microamp: maximum constant input current + - constant-charge-voltage-max-microvolt: maximum constant input voltage + +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>; + constant-charge-current-max-microamp = <900000>; + constant-charge-voltage-max-microvolt = <4200000>; + }; + + charger: charger@11 { + .... + monitored-battery = <&bat>; + ... + }; + + fuel_gauge: fuel-gauge@22 { + .... + monitored-battery = <&bat>; + ... + };