Received-SPF: pass (google.com: domain of linux-kernel+bounces-71479-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: Josua Mayer <josua@solid-run.com>
Date: Mon, 19 Feb 2024 15:29:45 +0100
Subject: [PATCH v7] dt-bindings: rtc: abx80x: convert to yaml
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240219-rtc-abracon-convert-bindings-v7-1-aca4fc3b8cec@solid-run.com>
To: Alexandre Belloni <alexandre.belloni@bootlin.com>, 
 Rob Herring <robh+dt@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, linux-rtc@vger.kernel.org
Cc: Yazan Shhady <yazan.shhady@solid-run.com>, devicetree@vger.kernel.org, 
 linux-kernel@vger.kernel.org, Josua Mayer <josua@solid-run.com>, 
 Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?ZHRObHE1aTltV3lsdk5IMldGTmZBWm9uRFA1bng1QlVHS1RMd0ZQb0h0YUZY?=
 =?utf-8?B?VkFtMGtaWXBiTHZYYWc1cHdleGlYdHl1SkxpdjhXVy8xUU1GV09KeG5BL3Ju?=
 =?utf-8?B?S1NuQ1ZDOVdtSkhHSFJ2elJkK2ZoMVBXc3JmQzZLZS9qWS9FNzNhd0Yvc2NO?=
 =?utf-8?B?ODVtZGFmRkN1NmZWZUxENk5wTGtWMFU0bmN2QXhxeS91a0Z6aG5QUFZGR2Nt?=
 =?utf-8?B?b0NXSGhJdVJEWDJLT2toVDNLRW1qWU5xM2h3aWlneUMxSVlyQXMzQVdVMDNy?=
 =?utf-8?B?Ujg1V2t4K3dQTWQ2V0VaZXRMYStyVnJIcklMK1U2bnBRMGZjdzVYRW9wdFRu?=
 =?utf-8?B?bWM1LzJCT1BJbHVUNjRtamg4VUlnaFFMZEdRK0lFRUFyTXhNdUZyYUJZQXl6?=
 =?utf-8?B?SjRrS295dG1iaTlnZG5ES2s1YVVud0xYQkY2S0Q3cnZXWlI5aVloZko3YkdO?=
 =?utf-8?B?cExoY3UvdGNXRng2Zy9nZjFtQUVTUnA3Q3RZdVJRQm1CdFI2emIxWHFJOWJZ?=
 =?utf-8?B?M3pMeVA1UXdyalVIZUZueGVWb3ordkN1OHlTQ1F4dEExQm1tZzNNeU42a2Vt?=
 =?utf-8?B?c3llS2RSV1RhWGRGajRMY1VGNkJTYWZiZzlrcElNczdVV0Rkd0ZOQ3BmQ3Vp?=
 =?utf-8?B?TXo4WnRVb3lXZHo1T1A2Z0Nmbi9YaGpjMGFQUjV3RTZ5TUY3cXhZUzhpK2R6?=
 =?utf-8?B?Vlh3bmdwZ3gzd1VrYU9OVlVSUWFjMGpzdXNET01kdEJ4cHdYd1djTm1hcGRY?=
 =?utf-8?B?cUsxaTdGQWx3VXVGdk1tYUFXOE5UQmgvSE54cHh1UXR2RWFSNlBGU2hiSjAw?=
 =?utf-8?B?eHpXdUhrSWtXOFpLRmJKMnNRQ2owclRBazBaZGdBcHg2aDYvNGF0VldFbjRa?=
 =?utf-8?B?SG4wMG9UVHNabk5GTVhnc3hFMVgyWkpvcmw0MWtCT3ljZEdEbHA2Y3pWbUxC?=
 =?utf-8?B?QW1oMDlCL2pmTzdKVGt1WXNLdkFueXF0cnNpQUhsVDZQR2VwTFFoYWE2YmUz?=
 =?utf-8?B?U3R4VnpyUWJNaW9GZFlteVBDMW5MVFJ1WFpISTdka3YzZFFqZHV2MGZUdkxY?=
 =?utf-8?B?bTRnSU90ZkIydzkxV0RIMElUakZ5eEViMXdscExuU2FLcG5BSEl5bWhBVEk1?=
 =?utf-8?B?T2FGMGViSGpOQWFRYVE0Q2ladUY1Und0Y1FXbjZwck16YjNDWG1raU55RUxq?=
 =?utf-8?B?bTRFbEhaSHd0RnV2S0c0Z0FBYXBGcHFyVFRTK01kdEVkdGJrWW9QV3lISUlk?=
 =?utf-8?B?cUQ3T2tTVXdUZUxaVmFQcGp0cUpkanUyTzh4Vnc2a3E3NWxqS21xbVhwS1VL?=
 =?utf-8?B?dFRSWnlabWNDdkh6REkwUHU1c3VRQWI1WExSSUZwMGVXM1haNnAySHd0b0t1?=
 =?utf-8?B?TDR1cnEwRURsRnNTaEN2WlJQZnlpZHhpVWZUSmtsckIybDdPSU90N1JvdTYr?=
 =?utf-8?B?SVFkZFUxN3F4aFFKakdXWExUdElQMVVaSW4wVXUvaVhKT2lxTmQ4bHBuYXlw?=
 =?utf-8?B?QTVINWlWZDBOMHc0M0ZJYlZBODlVUDFGQnJjcDV1bmZDY3VWcTdPQXZtSXEx?=
 =?utf-8?B?Q3kxSzBvMSt6anBJSVQyYVVtYStUMWdxVGNUNjBaYWk2cTR2cEtOMFZETVhx?=
 =?utf-8?B?MDZSRWs2d2paZ1loeGJ1NmlBdGVlYzZDVlRJbXN5OEg0eHVGakd4aFZ0cVVT?=
 =?utf-8?B?QzE2UVFzMmhzNHA1aDk0V28wUDZtUmxWcHFwak04eXN1T3lWVHphWFpFUVlE?=
 =?utf-8?B?QTZjVTdGSzlqNUcvVGM4RU1jTlRFNWd1ZDRyNHJxbWo1b3EvZFFXVHdzUkdm?=
 =?utf-8?B?UjVEU1ArczBuRWtkaWN6eVFBcUUzK0VOY2hsQ0NLSnlZMXVoMEJwYk1RM015?=
 =?utf-8?B?N2txbEpHZE5VOEhnamN2TGt3WVFmRHd3Q0ZOMkl3eTBSSkZ3dTdQbWlvYnRq?=
 =?utf-8?B?bjdxcHFGQTNGOHlyRVFTUFZnNDB5WFQ4eVNyMkJVc3ZFdjB6YXlVNkN5djl6?=
 =?utf-8?B?VlI0SFIyc1FtbTh4bnJHd3IycHNmVXhGRmJXTllkVUhFZHFqSnBGNWNqaUNj?=
 =?utf-8?B?QlVBSkRObWV4S2VnZHNnTWsvL2R6YzZOSDlYY1g3OFVQUkpLL2JXZEZ2aExG?=
 =?utf-8?Q?24uCRaW6QTxiFpqweYmOS6/TQ?=
X-OriginatorOrg: solid-run.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 064727cc-b3f9-4c22-428f-08dc31574d07
X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB7586.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Feb 2024 14:30:20.4848
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: a4a8aaf3-fd27-4e27-add2-604707ce5b82
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Sh4pHs9wJSfD0uy96Y2Q3I9y3G+DG9j0lJ5hCUWr/Il4fIDAMQBHCHB5WZOqQaYne/+rL2Hb7MRqi/yTjfIufg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR04MB7106

Convert the abracon abx80x rtc text bindings to dt-schema format.

In addition to the text description reference generic interrupts
properties and add an example.

Signed-off-by: Josua Mayer <josua@solid-run.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
Changes in v7:
- split out of original patchset because it should go by rtc tree
- collected reviewed-by from v5
  (Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>)
- Link to v6: https://lore.kernel.org/r/20240212-add-am64-som-v6-0-b59edb2bc8c3@solid-run.com
---
 .../devicetree/bindings/rtc/abracon,abx80x.txt     | 31 ---------
 .../devicetree/bindings/rtc/abracon,abx80x.yaml    | 79 ++++++++++++++++++++++
 2 files changed, 79 insertions(+), 31 deletions(-)

diff --git a/Documentation/devicetree/bindings/rtc/abracon,abx80x.txt b/Documentation/devicetree/bindings/rtc/abracon,abx80x.txt
deleted file mode 100644
index 2405e35a1bc0..000000000000
--- a/Documentation/devicetree/bindings/rtc/abracon,abx80x.txt
+++ /dev/null
@@ -1,31 +0,0 @@
-Abracon ABX80X I2C ultra low power RTC/Alarm chip
-
-The Abracon ABX80X family consist of the ab0801, ab0803, ab0804, ab0805, ab1801,
-ab1803, ab1804 and ab1805. The ab0805 is the superset of ab080x and the ab1805
-is the superset of ab180x.
-
-Required properties:
-
- - "compatible": should one of:
-        "abracon,abx80x"
-        "abracon,ab0801"
-        "abracon,ab0803"
-        "abracon,ab0804"
-        "abracon,ab0805"
-        "abracon,ab1801"
-        "abracon,ab1803"
-        "abracon,ab1804"
-        "abracon,ab1805"
-        "microcrystal,rv1805"
-	Using "abracon,abx80x" will enable chip autodetection.
- - "reg": I2C bus address of the device
-
-Optional properties:
-
-The abx804 and abx805 have a trickle charger that is able to charge the
-connected battery or supercap. Both the following properties have to be defined
-and valid to enable charging:
-
- - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)
- - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
-                          resistor, the other values are in kOhm.
diff --git a/Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml b/Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml
new file mode 100644
index 000000000000..58dbbca27deb
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml
@@ -0,0 +1,79 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/abracon,abx80x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Abracon ABX80X I2C ultra low power RTC/Alarm chip
+
+maintainers:
+  - linux-rtc@vger.kernel.org
+
+allOf:
+  - $ref: rtc.yaml#
+
+properties:
+  compatible:
+    description:
+      The wildcard 'abracon,abx80x' may be used to support a mix
+      of different abracon rtc`s. In this case the driver
+      must perform auto-detection from ID register.
+    enum:
+      - abracon,abx80x
+      - abracon,ab0801
+      - abracon,ab0803
+      - abracon,ab0804
+      - abracon,ab0805
+      - abracon,ab1801
+      - abracon,ab1803
+      - abracon,ab1804
+      - abracon,ab1805
+      - microcrystal,rv1805
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  abracon,tc-diode:
+    description:
+      Trickle-charge diode type.
+      Required to enable charging backup battery.
+
+      Supported are 'standard' diodes with a 0.6V drop
+      and 'schottky' diodes with a 0.3V drop.
+    $ref: /schemas/types.yaml#/definitions/string
+    enum:
+      - standard
+      - schottky
+
+  abracon,tc-resistor:
+    description:
+      Trickle-charge resistor value in kOhm.
+      Required to enable charging backup battery.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0, 3, 6, 11]
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        rtc@69 {
+            compatible = "abracon,abx80x";
+            reg = <0x69>;
+            abracon,tc-diode = "schottky";
+            abracon,tc-resistor = <3>;
+            interrupts = <44 IRQ_TYPE_EDGE_FALLING>;
+        };
+    };

---
base-commit: 6613476e225e090cc9aad49be7fa504e290dd33d
change-id: 20240219-rtc-abracon-convert-bindings-50743f95ce2b

Best regards,
-- 
Josua Mayer <josua@solid-run.com>