devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sebastian Reichel <sre@kernel.org>
To: Sebastian Reichel <sre@kernel.org>
Cc: Linus Walleij <linus.walleij@linaro.org>,
	Matti Vaittinen <mazziesaccount@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org,
	devicetree@vger.kernel.org,
	Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Subject: [PATCHv3 01/14] dt-bindings: power: supply: adc-battery: add binding
Date: Fri, 17 Mar 2023 23:56:54 +0100	[thread overview]
Message-ID: <20230317225707.1552512-2-sre@kernel.org> (raw)
In-Reply-To: <20230317225707.1552512-1-sre@kernel.org>

Add binding for a battery that is only monitored via ADC
channels and simple status GPIOs.

Reviewed-by: Matti Vaittinen <mazziesaccount@gmail.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Sebastian Reichel <sre@kernel.org>
---
 .../bindings/power/supply/adc-battery.yaml    | 70 +++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/adc-battery.yaml

diff --git a/Documentation/devicetree/bindings/power/supply/adc-battery.yaml b/Documentation/devicetree/bindings/power/supply/adc-battery.yaml
new file mode 100644
index 000000000000..ed9702caedff
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/adc-battery.yaml
@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/supply/adc-battery.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADC battery
+
+maintainers:
+  - Sebastian Reichel <sre@kernel.org>
+
+description:
+  Basic battery capacity meter, which only reports basic battery data
+  via ADC channels and optionally indicate that the battery is full by
+  polling a GPIO line.
+
+  The voltage is expected to be measured between the battery terminals
+  and mandatory. The optional current/power channel is expected to
+  monitor the current/power flowing out of the battery. Last but not
+  least the temperature channel is supposed to measure the battery
+  temperature.
+
+allOf:
+  - $ref: power-supply.yaml#
+
+properties:
+  compatible:
+    const: adc-battery
+
+  charged-gpios:
+    description:
+      GPIO which signals that the battery is fully charged. The GPIO is
+      often provided by charger ICs, that are not software controllable.
+    maxItems: 1
+
+  io-channels:
+    minItems: 1
+    maxItems: 4
+
+  io-channel-names:
+    minItems: 1
+    items:
+      - const: voltage
+      - enum: [ current, power, temperature ]
+      - enum: [ power, temperature ]
+      - const: temperature
+
+  monitored-battery: true
+
+required:
+  - compatible
+  - io-channels
+  - io-channel-names
+  - monitored-battery
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    fuel-gauge {
+        compatible = "adc-battery";
+        charged-gpios = <&gpio 42 GPIO_ACTIVE_HIGH>;
+        io-channels = <&adc 13>, <&adc 37>;
+        io-channel-names = "voltage", "current";
+
+        power-supplies = <&charger>;
+        monitored-battery = <&battery>;
+    };
-- 
2.39.2


  reply	other threads:[~2023-03-17 22:57 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-17 22:56 [PATCHv3 00/14] Add DT support for generic ADC battery Sebastian Reichel
2023-03-17 22:56 ` Sebastian Reichel [this message]
2023-03-17 22:56 ` [PATCHv3 02/14] power: supply: core: auto-exposure of simple-battery data Sebastian Reichel
2023-03-19 21:11   ` Linus Walleij
2023-03-21  9:17   ` Matti Vaittinen
2023-03-29 23:24   ` Sebastian Reichel
2023-03-17 22:56 ` [PATCHv3 03/14] power: supply: generic-adc-battery: convert to managed resources Sebastian Reichel
2023-03-17 22:56 ` [PATCHv3 04/14] power: supply: generic-adc-battery: fix unit scaling Sebastian Reichel
2023-03-17 22:56 ` [PATCHv3 05/14] power: supply: generic-adc-battery: drop jitter delay support Sebastian Reichel
2023-03-17 22:56 ` [PATCHv3 06/14] power: supply: generic-adc-battery: drop charge now support Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 07/14] power: supply: generic-adc-battery: drop memory alloc error message Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 08/14] power: supply: generic-adc-battery: use simple-battery API Sebastian Reichel
2023-03-19 12:45   ` Matti Vaittinen
2023-03-17 22:57 ` [PATCHv3 09/14] power: supply: generic-adc-battery: simplify read_channel logic Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 10/14] power: supply: generic-adc-battery: add temperature support Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 11/14] power: supply: generic-adc-battery: add DT support Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 12/14] power: supply: generic-adc-battery: update copyright info Sebastian Reichel
2023-03-17 22:57 ` [PATCHv3 13/14] power: supply: generic-adc-battery: improve error message Sebastian Reichel
2023-03-19 21:13   ` Linus Walleij
2023-03-21  9:18   ` Matti Vaittinen
2023-03-17 22:57 ` [PATCHv3 14/14] power: supply: generic-adc-battery: style fixes Sebastian Reichel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230317225707.1552512-2-sre@kernel.org \
    --to=sre@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=krzysztof.kozlowski@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mazziesaccount@gmail.com \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).