Documentation/devicetree/bindings/rtc/rtc.yaml

   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
   7 title: RTC Generic Binding
   8
   9 maintainers:
  10   - Alexandre Belloni <alexandre.belloni@bootlin.com>
  11
  12 description: |
  13   This document describes generic bindings which can be used to
  14   describe Real Time Clock devices in a device tree.
  15
  16 properties:
  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     description:
  31       The capacitive load of the quartz(x-tal), expressed in femto
  32       Farad (fF). The default value shall be listed (if optional),
  33       and likewise all valid values.
  34
  35   start-year:
  36     $ref: /schemas/types.yaml#/definitions/uint32
  37     description:
  38       If provided, the default hardware range supported by the RTC is
  39       shifted so the first usable year is the specified one.
  40
  41   trickle-diode-disable:
  42     $ref: /schemas/types.yaml#/definitions/flag
  43     description:
  44       Do not use internal trickle charger diode. Should be given if
  45       internal trickle charger diode should be disabled.
  46     deprecated: true
  47
  48   trickle-resistor-ohms:
  49     description:
  50       Selected resistor for trickle charger. Should be given
  51       if trickle charger should be enabled.
  52
  53   trickle-voltage-millivolt:
  54     description:
  55       Selected voltage for trickle charger. Should be given
  56       if trickle charger should be enabled and the trickle voltage is different
  57       from the RTC main power supply.
  58
  59   wakeup-source:
  60     $ref: /schemas/types.yaml#/definitions/flag
  61     description:
  62       Enables wake up of host system on alarm.
  63
  64   reset-source:
  65     $ref: /schemas/types.yaml#/definitions/flag
  66     description:
  67       The RTC is able to reset the machine.
  68
  69 additionalProperties: true
  70
  71 ...