Re: [PATCH v4 2/5] dt-bindings: rtc: abx80x: convert to yaml

Conor Dooley
2024-02-03T15:09:21Z

[-- Attachment #1.1: Type: text/plain, Size: 4967 bytes --]

Hey,

On Fri, Feb 02, 2024 at 05:10:49PM +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 <josua@solid-run.com>
> ---
> .../devicetree/bindings/rtc/abracon,abx80x.txt | 31 ---------
> .../devicetree/bindings/rtc/abracon,abx80x.yaml | 74 ++++++++++++++++++++++
> 2 files changed, 74 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..405b386a54b0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml
> @@ -0,0 +1,74 @@
> +# 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:
> + - devicetree@vger.kernel.org

Ideally you put someone here, not the DT list. Usually the original
author is a good choice, which I think happens to be the subsystem
maintainer... Failing that, the rtc subsystem list is likely a better
choice than the DT one.

> +
> +allOf:
> + - $ref: rtc.yaml#

> + - $ref: /schemas/interrupts.yaml#

This should not be need.

> +
> +properties:
> + compatible:
> + description:
> + Select a specific compatible chip.

I'd drop this line.

> + 'abracon,abx80x' has special meaning,
> + it provides auto-dection based on ID register.

And reword this. The compatible itself does not provide auto-detection,
it's the opposite - the driver must perform auto detection if this
compatible is used.

> + enum:
> + - abracon,abx80x
> + - abracon,ab0801
> + - abracon,ab0803
> + - abracon,ab0804
> + - abracon,ab0805
> + - abracon,ab1801
> + - abracon,ab1803
> + - abracon,ab1804
> + - abracon,ab1805
> + - microcrystal,rv1805
> +
> + reg:
> + 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>
> +
> + rtc@69 {
> + compatible = "abracon,abx80x";
> + reg = <0x69>;

You'll have to make a "fake" i2c bus here to satisfy the tooling. There
should be lots of examples for how to do this in other rtc bindings.

Thanks,
Conor.

> + abracon,tc-diode = "schottky";
> + abracon,tc-resistor = <3>;
> + interrupt-parent = <&fake_intc0>;
> + interrupts = <44 IRQ_TYPE_EDGE_FALLING>;
> + };
>
> --
> 2.35.3
>

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

[-- Attachment #2: Type: text/plain, Size: 176 bytes --]