From patchwork Thu May 4 06:18:02 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liam Breck X-Patchwork-Id: 9710809 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 AA58C60387 for ; Thu, 4 May 2017 06:19:27 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9BB4B28557 for ; Thu, 4 May 2017 06:19:27 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 90AB42860E; Thu, 4 May 2017 06:19:27 +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.3 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI, RCVD_IN_SORBS_SPAM, 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 7DCDE28557 for ; Thu, 4 May 2017 06:19:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753893AbdEDGTZ (ORCPT ); Thu, 4 May 2017 02:19:25 -0400 Received: from mail-pf0-f196.google.com ([209.85.192.196]:35216 "EHLO mail-pf0-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751362AbdEDGTJ (ORCPT ); Thu, 4 May 2017 02:19:09 -0400 Received: by mail-pf0-f196.google.com with SMTP id u26so31791pfd.2; Wed, 03 May 2017 23:19:08 -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=QEn1V0i6PBuhz46/sj0IenFV9IdKgtGqQ0EbZiI1sBY=; b=AK0cy5zzP8h5yRFGyoYaTeM8FTKN0Hk6G65bMcBERxu8i4Qzm6QjUkO4F9EjIy2WAd Ji6A1IBRCzY+1UumM1AGzPiwxAAmwk/7r4Gi54rjNeX/lgg3mE9HUeZsaoNzyr+feUVh EQR6HjWfLfF6rpAUpCX2Xn865qidZsS5yG+0CoYCW8QyK4RyxoV+WIxN0LWCyJxCkfaK tAlIK4eJiLcRDvWyn2jsyQrzE7SH6vJoe0be4ixmhknsqQGHAvktFQKQfpNy5dcq65Hk wSyfXgjEl5dwPElrUGQi9+MTF3xjjh0qpEkC7oU8ynkgUAjSG6FCmf948ppYYc2horku KU/Q== 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=QEn1V0i6PBuhz46/sj0IenFV9IdKgtGqQ0EbZiI1sBY=; b=eCgD/499vVz9e34X6AxPzJ5YJTgnhVEDZvPxvZHiqUGys9nZra4AtCP/N+iw8Pyf0P Ew8asfIrIggfT792dbIIOKa9CiP74rAFUjk5nZq7syFAAYzXJZPKjRzczzE/49dVYt5W TXDplna6/5m+eBVzxMSWkcRWM8t/mQWpMOqMfR8P18/GfZvEXPbNoSmRo2NJ9fRQOU31 8VcJ0cu1rGkaH9Q6fOdfzq/D4SKY2rPSgzTd0BGmRcfRKW6TlC2rH9DI2lhOGUT7Xipc jFKBwxMS4v6QoO8KFJvULlIANaaBp5tq4EmJ/kNJqjGrNwKyVCirSjpVdppkWEECIfRW nTsw== X-Gm-Message-State: AN3rC/4//fKnprwZ0+F7lIQpL+ZC7BsPC5CMAtoB/0XDms4f7nSFZvf7 NB6mVHh9c9PWsg== X-Received: by 10.84.232.71 with SMTP id f7mr21073722pln.168.1493878748391; Wed, 03 May 2017 23:19:08 -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 f24sm1870455pfk.88.2017.05.03.23.19.07 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 03 May 2017 23:19:07 -0700 (PDT) From: Liam Breck To: Sebastian Reichel , "Andrew F. Davis" , linux-pm@vger.kernel.org Cc: Rob Herring , devicetree@vger.kernel.org, Matt Ranostay , Liam Breck Subject: [PATCH v13 02/11] dt-bindings: power: supply: Add battery.txt with simple-battery binding Date: Wed, 3 May 2017 23:18:02 -0700 Message-Id: <20170504061811.18107-3-liam@networkimprov.net> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170504061811.18107-1-liam@networkimprov.net> References: <20170504061811.18107-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 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 | 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>; + ... + };