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