xref: /freebsd/sys/contrib/device-tree/Bindings/rtc/rtc.yaml (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0
2*c66ec88fSEmmanuel Vadot%YAML 1.2
3*c66ec88fSEmmanuel Vadot---
4*c66ec88fSEmmanuel Vadot$id: http://devicetree.org/schemas/rtc/rtc.yaml#
5*c66ec88fSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*c66ec88fSEmmanuel Vadot
7*c66ec88fSEmmanuel Vadottitle: RTC Generic Binding
8*c66ec88fSEmmanuel Vadot
9*c66ec88fSEmmanuel Vadotmaintainers:
10*c66ec88fSEmmanuel Vadot  - Alexandre Belloni <alexandre.belloni@bootlin.com>
11*c66ec88fSEmmanuel Vadot
12*c66ec88fSEmmanuel Vadotdescription: |
13*c66ec88fSEmmanuel Vadot  This document describes generic bindings which can be used to
14*c66ec88fSEmmanuel Vadot  describe Real Time Clock devices in a device tree.
15*c66ec88fSEmmanuel Vadot
16*c66ec88fSEmmanuel Vadotproperties:
17*c66ec88fSEmmanuel Vadot  $nodename:
18*c66ec88fSEmmanuel Vadot    pattern: "^rtc(@.*|-[0-9a-f])*$"
19*c66ec88fSEmmanuel Vadot
20*c66ec88fSEmmanuel Vadot  quartz-load-femtofarads:
21*c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
22*c66ec88fSEmmanuel Vadot    description:
23*c66ec88fSEmmanuel Vadot      The capacitive load of the quartz(x-tal), expressed in femto
24*c66ec88fSEmmanuel Vadot      Farad (fF). The default value shall be listed (if optional),
25*c66ec88fSEmmanuel Vadot      and likewise all valid values.
26*c66ec88fSEmmanuel Vadot
27*c66ec88fSEmmanuel Vadot  start-year:
28*c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
29*c66ec88fSEmmanuel Vadot    description:
30*c66ec88fSEmmanuel Vadot      If provided, the default hardware range supported by the RTC is
31*c66ec88fSEmmanuel Vadot      shifted so the first usable year is the specified one.
32*c66ec88fSEmmanuel Vadot
33*c66ec88fSEmmanuel Vadot  trickle-diode-disable:
34*c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/flag
35*c66ec88fSEmmanuel Vadot    description:
36*c66ec88fSEmmanuel Vadot      Do not use internal trickle charger diode. Should be given if
37*c66ec88fSEmmanuel Vadot      internal trickle charger diode should be disabled.
38*c66ec88fSEmmanuel Vadot
39*c66ec88fSEmmanuel Vadot  trickle-resistor-ohms:
40*c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
41*c66ec88fSEmmanuel Vadot    description:
42*c66ec88fSEmmanuel Vadot      Selected resistor for trickle charger. Should be given
43*c66ec88fSEmmanuel Vadot      if trickle charger should be enabled.
44*c66ec88fSEmmanuel Vadot
45*c66ec88fSEmmanuel Vadot  wakeup-source:
46*c66ec88fSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/flag
47*c66ec88fSEmmanuel Vadot    description:
48*c66ec88fSEmmanuel Vadot      Enables wake up of host system on alarm.
49*c66ec88fSEmmanuel Vadot
50*c66ec88fSEmmanuel Vadot...
51