2024-02-12 17:39:04

by Josua Mayer

[permalink] [raw]
Subject: [PATCH v6 2/7] dt-bindings: rtc: abx80x: convert to yaml

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 <[email protected]>
---
.../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:
+ - [email protected]
+
+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>;
+ };
+ };

--
2.35.3



2024-02-12 20:07:21

by Alexandre Belloni

[permalink] [raw]
Subject: Re: [PATCH v6 2/7] dt-bindings: rtc: abx80x: convert to yaml

On 12/02/2024 18:38:09+0100, Josua Mayer wrote:
> 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 <[email protected]>

Did something change since v6? If not, why didn't you collect the
reviewed-by tag?

> ---
> .../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:
> + - [email protected]
> +
> +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>;
> + };
> + };
>
> --
> 2.35.3
>

--
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

2024-02-15 14:37:32

by Josua Mayer

[permalink] [raw]
Subject: Re: [PATCH v6 2/7] dt-bindings: rtc: abx80x: convert to yaml

Am 12.02.24 um 21:06 schrieb Alexandre Belloni:
> On 12/02/2024 18:38:09+0100, Josua Mayer wrote:
>> 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 <[email protected]>
> Did something change since v6? If not, why didn't you collect the
> reviewed-by tag?
I forgot about seeing the tag by Krzysztof ... which is why I didn't
collect it.
Nothing changed since v6, so this still valid:

Reviewed-by: Krzysztof Kozlowski<[email protected]>

>
>> ---
>> .../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:
>> + - [email protected]
>> +
>> +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>;
>> + };
>> + };
>>
>> --
>> 2.35.3
>>