Commit 626e2b54 authored by Josua Mayer's avatar Josua Mayer Committed by Alexandre Belloni
Browse files

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: default avatarJosua Mayer <josua@solid-run.com>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240219-rtc-abracon-convert-bindings-v7-1-aca4fc3b8cec@solid-run.com


Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
parent 3100fd1a

Documentation/devicetree/bindings/rtc/abracon,abx80x.txt

deleted100644 → 0
+0 −31
Original line number Diff line number Diff line 
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.

Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml

0 → 100644
+79 −0
Original line number Diff line number Diff line 
# 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>;

        };

    };