1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/rtc/rtc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: RTC Generic Binding
8
9maintainers:
10  - Alexandre Belloni <alexandre.belloni@bootlin.com>
11
12description: |
13  This document describes generic bindings which can be used to
14  describe Real Time Clock devices in a device tree.
15
16properties:
17  $nodename:
18    pattern: "^rtc(@.*|-[0-9a-f])*$"
19
20  aux-voltage-chargeable:
21    $ref: /schemas/types.yaml#/definitions/uint32
22    enum: [0, 1]
23    description: |
24      Tells whether the battery/supercap of the RTC (if any) is
25      chargeable or not:
26      0: not chargeable
27      1: chargeable
28
29  quartz-load-femtofarads:
30    $ref: /schemas/types.yaml#/definitions/uint32
31    description:
32      The capacitive load of the quartz(x-tal), expressed in femto
33      Farad (fF). The default value shall be listed (if optional),
34      and likewise all valid values.
35
36  start-year:
37    $ref: /schemas/types.yaml#/definitions/uint32
38    description:
39      If provided, the default hardware range supported by the RTC is
40      shifted so the first usable year is the specified one.
41
42  trickle-diode-disable:
43    $ref: /schemas/types.yaml#/definitions/flag
44    description:
45      Do not use internal trickle charger diode. Should be given if
46      internal trickle charger diode should be disabled.
47    deprecated: true
48
49  trickle-resistor-ohms:
50    $ref: /schemas/types.yaml#/definitions/uint32
51    description:
52      Selected resistor for trickle charger. Should be given
53      if trickle charger should be enabled.
54
55  trickle-voltage-millivolt:
56    description:
57      Selected voltage for trickle charger. Should be given
58      if trickle charger should be enabled and the trickle voltage is different
59      from the RTC main power supply.
60
61  wakeup-source:
62    $ref: /schemas/types.yaml#/definitions/flag
63    description:
64      Enables wake up of host system on alarm.
65
66  reset-source:
67    $ref: /schemas/types.yaml#/definitions/flag
68    description:
69      The RTC is able to reset the machine.
70
71additionalProperties: true
72
73...
74