xref: /freebsd/sys/contrib/device-tree/Bindings/rtc/rtc.yaml (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1c66ec88fSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0
2c66ec88fSEmmanuel Vadot%YAML 1.2
3c66ec88fSEmmanuel Vadot---
4c66ec88fSEmmanuel Vadot$id: http://devicetree.org/schemas/rtc/rtc.yaml#
5c66ec88fSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6c66ec88fSEmmanuel Vadot
78bab661aSEmmanuel Vadottitle: Real Time Clock Common Properties
8c66ec88fSEmmanuel Vadot
9c66ec88fSEmmanuel Vadotmaintainers:
10c66ec88fSEmmanuel Vadot  - Alexandre Belloni <alexandre.belloni@bootlin.com>
11c66ec88fSEmmanuel Vadot
12c66ec88fSEmmanuel Vadotdescription: |
13c66ec88fSEmmanuel Vadot  This document describes generic bindings which can be used to
14c66ec88fSEmmanuel Vadot  describe Real Time Clock devices in a device tree.
15c66ec88fSEmmanuel Vadot
16c66ec88fSEmmanuel Vadotproperties:
17c66ec88fSEmmanuel Vadot  $nodename:
18*f126890aSEmmanuel Vadot    pattern: "^rtc(@.*|-([0-9]|[1-9][0-9]+))?$"
19c66ec88fSEmmanuel Vadot
206be33864SEmmanuel Vadot  aux-voltage-chargeable:
216be33864SEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
226be33864SEmmanuel Vadot    enum: [0, 1]
236be33864SEmmanuel Vadot    description: |
246be33864SEmmanuel Vadot      Tells whether the battery/supercap of the RTC (if any) is
256be33864SEmmanuel Vadot      chargeable or not:
266be33864SEmmanuel Vadot      0: not chargeable
276be33864SEmmanuel Vadot      1: chargeable
286be33864SEmmanuel Vadot
29c66ec88fSEmmanuel Vadot  quartz-load-femtofarads:
30c66ec88fSEmmanuel Vadot    description:
31c66ec88fSEmmanuel Vadot      The capacitive load of the quartz(x-tal), expressed in femto
32c66ec88fSEmmanuel Vadot      Farad (fF). The default value shall be listed (if optional),
33c66ec88fSEmmanuel Vadot      and likewise all valid values.
34c66ec88fSEmmanuel Vadot
35c66ec88fSEmmanuel Vadot  start-year:
36c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
37c66ec88fSEmmanuel Vadot    description:
38c66ec88fSEmmanuel Vadot      If provided, the default hardware range supported by the RTC is
39c66ec88fSEmmanuel Vadot      shifted so the first usable year is the specified one.
40c66ec88fSEmmanuel Vadot
41c66ec88fSEmmanuel Vadot  trickle-diode-disable:
42c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/flag
43c66ec88fSEmmanuel Vadot    description:
44c66ec88fSEmmanuel Vadot      Do not use internal trickle charger diode. Should be given if
45c66ec88fSEmmanuel Vadot      internal trickle charger diode should be disabled.
466be33864SEmmanuel Vadot    deprecated: true
47c66ec88fSEmmanuel Vadot
48c66ec88fSEmmanuel Vadot  trickle-resistor-ohms:
49c66ec88fSEmmanuel Vadot    description:
50c66ec88fSEmmanuel Vadot      Selected resistor for trickle charger. Should be given
51c66ec88fSEmmanuel Vadot      if trickle charger should be enabled.
52c66ec88fSEmmanuel Vadot
536be33864SEmmanuel Vadot  trickle-voltage-millivolt:
546be33864SEmmanuel Vadot    description:
556be33864SEmmanuel Vadot      Selected voltage for trickle charger. Should be given
566be33864SEmmanuel Vadot      if trickle charger should be enabled and the trickle voltage is different
576be33864SEmmanuel Vadot      from the RTC main power supply.
586be33864SEmmanuel Vadot
59c66ec88fSEmmanuel Vadot  wakeup-source:
60c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/flag
61c66ec88fSEmmanuel Vadot    description:
62c66ec88fSEmmanuel Vadot      Enables wake up of host system on alarm.
63c66ec88fSEmmanuel Vadot
645def4c47SEmmanuel Vadot  reset-source:
655def4c47SEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/flag
665def4c47SEmmanuel Vadot    description:
675def4c47SEmmanuel Vadot      The RTC is able to reset the machine.
685def4c47SEmmanuel Vadot
696be33864SEmmanuel VadotadditionalProperties: true
706be33864SEmmanuel Vadot
71c66ec88fSEmmanuel Vadot...
72