xref: /linux/Documentation/devicetree/bindings/rtc/abracon,abx80x.yaml (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/rtc/abracon,abx80x.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Abracon ABX80X I2C ultra low power RTC/Alarm chip
8
9maintainers:
10  - linux-rtc@vger.kernel.org
11
12properties:
13  compatible:
14    description:
15      The wildcard 'abracon,abx80x' may be used to support a mix
16      of different abracon rtc`s. In this case the driver
17      must perform auto-detection from ID register.
18    enum:
19      - abracon,abx80x
20      - abracon,ab0801
21      - abracon,ab0803
22      - abracon,ab0804
23      - abracon,ab0805
24      - abracon,ab1801
25      - abracon,ab1803
26      - abracon,ab1804
27      - abracon,ab1805
28      - microcrystal,rv1805
29
30  reg:
31    maxItems: 1
32
33  interrupts:
34    maxItems: 1
35
36  abracon,tc-diode:
37    description:
38      Trickle-charge diode type.
39      Required to enable charging backup battery.
40
41      Supported are 'standard' diodes with a 0.6V drop
42      and 'schottky' diodes with a 0.3V drop.
43    $ref: /schemas/types.yaml#/definitions/string
44    enum:
45      - standard
46      - schottky
47
48  abracon,tc-resistor:
49    description:
50      Trickle-charge resistor value in kOhm.
51      Required to enable charging backup battery.
52    $ref: /schemas/types.yaml#/definitions/uint32
53    enum: [0, 3, 6, 11]
54
55dependentRequired:
56  abracon,tc-diode: ["abracon,tc-resistor"]
57  abracon,tc-resistor: ["abracon,tc-diode"]
58
59required:
60  - compatible
61  - reg
62
63allOf:
64  - $ref: rtc.yaml#
65  - if:
66      properties:
67        compatible:
68          not:
69            contains:
70              enum:
71                - abracon,abx80x
72                - abracon,ab0804
73                - abracon,ab1804
74                - abracon,ab0805
75                - abracon,ab1805
76    then:
77      properties:
78        abracon,tc-diode: false
79        abracon,tc-resistor: false
80
81unevaluatedProperties: false
82
83examples:
84  - |
85    #include <dt-bindings/interrupt-controller/irq.h>
86
87    i2c {
88        #address-cells = <1>;
89        #size-cells = <0>;
90
91        rtc@69 {
92            compatible = "abracon,abx80x";
93            reg = <0x69>;
94            abracon,tc-diode = "schottky";
95            abracon,tc-resistor = <3>;
96            interrupts = <44 IRQ_TYPE_EDGE_FALLING>;
97        };
98    };
99