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