devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sebastian Reichel <sebastian.reichel@collabora.com>
To: Sebastian Reichel <sre@kernel.org>, Rob Herring <robh+dt@kernel.org>
Cc: linux-pm@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Sebastian Reichel <sebastian.reichel@collabora.com>,
	kernel@collabora.com
Subject: [PATCH 20/38] dt-bindings: power: supply: max17040: Convert to DT schema format
Date: Fri, 12 Mar 2021 16:43:39 +0100	[thread overview]
Message-ID: <20210312154357.1561730-21-sebastian.reichel@collabora.com> (raw)
In-Reply-To: <20210312154357.1561730-1-sebastian.reichel@collabora.com>

Convert the binding to DT schema format.

Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
---
 .../power/supply/max17040_battery.txt         | 52 ----------
 .../bindings/power/supply/maxim,max17040.yaml | 95 +++++++++++++++++++
 2 files changed, 95 insertions(+), 52 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/power/supply/max17040_battery.txt
 create mode 100644 Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml

diff --git a/Documentation/devicetree/bindings/power/supply/max17040_battery.txt b/Documentation/devicetree/bindings/power/supply/max17040_battery.txt
deleted file mode 100644
index c802f664b508..000000000000
--- a/Documentation/devicetree/bindings/power/supply/max17040_battery.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-max17040_battery
-~~~~~~~~~~~~~~~~
-
-Required properties :
- - compatible : "maxim,max17040", "maxim,max17041", "maxim,max17043",
-		"maxim,max17044", "maxim,max17048", "maxim,max17049",
-		"maxim,max17058", "maxim,max17059" or "maxim,max77836-battery"
- - reg: i2c slave address
-
-Optional properties :
-- maxim,alert-low-soc-level :	The alert threshold that sets the state of
-				charge level (%) where an interrupt is
-				generated. Can be configured from 1 up to 32
-				(%). If skipped the power up default value of
-				4 (%) will be used.
-- maxim,double-soc : 		Certain devices return double the capacity.
-				Specify this boolean property to divide the
-				reported value in 2 and thus normalize it.
-				SOC == State of Charge == Capacity.
-- maxim,rcomp :			A value to compensate readings for various
-				battery chemistries and operating temperatures.
-				max17040,41 have 2 byte rcomp, default to
-				0x97 0x00. All other devices have one byte
-				rcomp, default to 0x97.
-- interrupts : 			Interrupt line see Documentation/devicetree/
-				bindings/interrupt-controller/interrupts.txt
-- wakeup-source :		This device has wakeup capabilities. Use this
-				property to use alert low SOC level interrupt
-				as wake up source.
-
-Optional properties support interrupt functionality for alert low state of
-charge level, present in some ICs in the same family, and should be used with
-compatible "maxim,max77836-battery".
-
-Example:
-
-	battery-fuel-gauge@36 {
-		compatible = "maxim,max77836-battery";
-		reg = <0x36>;
-		maxim,alert-low-soc-level = <10>;
-		interrupt-parent = <&gpio7>;
-		interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
-		wakeup-source;
-	};
-
-	battery-fuel-gauge@36 {
-		compatible = "maxim,max17048";
-		reg = <0x36>;
-		maxim,rcomp = /bits/ 8 <0x56>;
-		maxim,alert-low-soc-level = <10>;
-		maxim,double-soc;
-	};
diff --git a/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
new file mode 100644
index 000000000000..de91cf3f058c
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/maxim,max17040.yaml
@@ -0,0 +1,95 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/power/supply/maxim,max17040.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Maxim 17040 fuel gauge series
+
+maintainers:
+  - Sebastian Reichel <sre@kernel.org>
+
+allOf:
+  - $ref: power-supply.yaml#
+
+properties:
+  compatible:
+    enum:
+      - maxim,max17040
+      - maxim,max17041
+      - maxim,max17043
+      - maxim,max17044
+      - maxim,max17048
+      - maxim,max17049
+      - maxim,max17058
+      - maxim,max17059
+      - maxim,max77836-battery
+
+  reg:
+    maxItems: 1
+
+  maxim,alert-low-soc-level:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 32
+    description: |
+      The alert threshold that sets the state of charge level (%) where an interrupt is generated.
+      If skipped the power up default value of 4 (%) will be used.
+
+  maxim,double-soc:
+    type: boolean
+    description: |
+      Certain devices return double the capacity.
+      Specify this to divide the reported value in 2 and thus normalize it.
+      SoC == State of Charge == Capacity.
+
+  maxim,rcomp:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      A value to compensate readings for various battery chemistries and operating temperatures.
+      max17040,41 have 2 byte rcomp, default to 0x97 0x00.
+      All other devices have one byte rcomp, default to 0x97.
+
+  interrupts:
+    maxItems: 1
+
+  wakeup-source:
+    type: boolean
+    description: |
+      Use this property to use alert low SoC level interrupt as wake up source.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      battery@36 {
+        compatible = "maxim,max17048";
+        reg = <0x36>;
+        maxim,rcomp = /bits/ 8 <0x56>;
+        maxim,alert-low-soc-level = <10>;
+        maxim,double-soc;
+      };
+    };
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c0 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      battery@36 {
+        compatible = "maxim,max77836-battery";
+        reg = <0x36>;
+        maxim,alert-low-soc-level = <10>;
+        interrupt-parent = <&gpio7>;
+        interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
+        wakeup-source;
+      };
+    };
-- 
2.30.1


  parent reply	other threads:[~2021-03-12 15:45 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-12 15:43 [PATCH 00/38] Convert power-supply DT bindings to YAML Sebastian Reichel
2021-03-12 15:43 ` [PATCH 01/38] ARM: dts: motorola-cpcap-mapphone: Prepare for dtbs_check parsing Sebastian Reichel
2021-03-12 15:43 ` [PATCH 02/38] dt-bindings: power: supply: cpcap-battery: Convert to DT schema format Sebastian Reichel
2021-03-12 15:43 ` [PATCH 03/38] dt-bindings: power: supply: cpcap-charger: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 04/38] dt-bindings: power: supply: bq25890: " Sebastian Reichel
2021-03-15 18:21   ` Rob Herring
2021-03-16 16:46     ` Sebastian Reichel
2021-03-16 17:50       ` Rob Herring
2021-03-12 15:43 ` [PATCH 05/38] dt-bindings: power: supply: bq24257: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 06/38] dt-bindings: power: supply: bq24190: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 07/38] dt-bindings: power: supply: bq2415x: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 08/38] dt-bindings: power: supply: bq24735: " Sebastian Reichel
2021-03-15 18:24   ` Rob Herring
2021-03-16 16:22     ` Sebastian Reichel
2021-03-16 17:45       ` Rob Herring
2021-03-12 15:43 ` [PATCH 09/38] dt-bindings: power: supply: isp1704: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 10/38] dt-bindings: power: supply: sbs-charger: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 11/38] dt-bindings: power: supply: sbs-manager: " Sebastian Reichel
2021-03-15 18:27   ` Rob Herring
2021-03-12 15:43 ` [PATCH 12/38] dt-bindings: power: supply: ds2760: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 13/38] dt-bindings: power: supply: sc27xx-fg: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 14/38] dt-bindings: power: supply: sc2731-charger: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 15/38] dt-bindings: power: supply: tps65090: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 16/38] dt-bindings: power: supply: tps65217: " Sebastian Reichel
2021-03-15 18:33   ` Rob Herring
2021-03-16 16:20     ` Sebastian Reichel
2021-03-16 17:52       ` Rob Herring
2021-03-12 15:43 ` [PATCH 17/38] dt-bindings: power: supply: twl4030: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 18/38] dt-bindings: power: supply: n900-battery: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 19/38] dt-bindings: power: supply: lego-ev3-battery: " Sebastian Reichel
2021-03-12 16:04   ` David Lechner
2021-03-12 15:43 ` Sebastian Reichel [this message]
2021-03-12 15:43 ` [PATCH 21/38] dt-bindings: power: supply: max14656: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 22/38] dt-bindings: power: supply: max17042: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 23/38] dt-bindings: power: supply: max8903: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 24/38] dt-bindings: power: supply: ucs1002: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 25/38] dt-bindings: power: supply: pm8941-charger: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 26/38] dt-bindings: power: supply: pm8941-coincell: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 27/38] dt-bindings: power: supply: act8945a: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 28/38] dt-bindings: power: supply: axp20x: " Sebastian Reichel
2021-03-24  3:02   ` Chen-Yu Tsai
2021-03-12 15:43 ` [PATCH 29/38] dt-bindings: power: supply: da9150: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 30/38] dt-bindings: power: supply: lp8727: " Sebastian Reichel
2021-03-15 18:37   ` Rob Herring
2021-03-12 15:43 ` [PATCH 31/38] dt-bindings: power: supply: lt3651: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 32/38] dt-bindings: power: supply: ltc294x: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 33/38] dt-bindings: power: supply: rt9455: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 34/38] dt-bindings: power: supply: olpc-battery: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 35/38] dt-bindings: power: supply: ab8500: " Sebastian Reichel
2021-03-12 15:43 ` [PATCH 36/38] dt-bindings: power: supply: sbs-battery: Fix dtbs_check Sebastian Reichel
2021-03-12 15:43 ` [PATCH 37/38] dt-bindings: power: supply: Fix remaining battery.txt links Sebastian Reichel
2021-03-12 15:43 ` [PATCH 38/38] dt-bindings: power: supply: Drop power_supply.txt Sebastian Reichel
2021-03-15 19:44 ` [PATCH 00/38] Convert power-supply DT bindings to YAML Rob Herring

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=20210312154357.1561730-21-sebastian.reichel@collabora.com \
    --to=sebastian.reichel@collabora.com \
    --cc=devicetree@vger.kernel.org \
    --cc=kernel@collabora.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    --cc=sre@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).