Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt-bindings: rtc: Add YAML schemas for the generic RTC bindings

The real time clocks have a bunch of generic properties that are needed in
a device tree. Add a YAML schemas for those.

Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>

authored by

Maxime Ripard and committed by
Alexandre Belloni
7bdcb8e0 a3094fc1

+51 -33
+1 -33
Documentation/devicetree/bindings/rtc/rtc.txt
··· 1 - Generic device tree bindings for Real Time Clock devices 2 - ======================================================== 3 - 4 - This document describes generic bindings which can be used to describe Real Time 5 - Clock devices in a device tree. 6 - 7 - Required properties 8 - ------------------- 9 - 10 - - compatible : name of RTC device following generic names recommended practice. 11 - 12 - For other required properties e.g. to describe register sets, 13 - clocks, etc. check the binding documentation of the specific driver. 14 - 15 - Optional properties 16 - ------------------- 17 - 18 - - start-year : if provided, the default hardware range supported by the RTC is 19 - shifted so the first usable year is the specified one. 20 - 21 - The following properties may not be supported by all drivers. However, if a 22 - driver wants to support one of the below features, it should adapt the bindings 23 - below. 24 - - trickle-resistor-ohms : Selected resistor for trickle charger. Should be given 25 - if trickle charger should be enabled 26 - - trickle-diode-disable : Do not use internal trickle charger diode Should be 27 - given if internal trickle charger diode should be 28 - disabled 29 - - wakeup-source : Enables wake up of host system on alarm 30 - - quartz-load-femtofarads : The capacitive load of the quartz(x-tal), 31 - expressed in femto Farad (fF). 32 - The default value shall be listed (if optional), 33 - and likewise all valid values. 1 + This file has been moved to rtc.yaml. 34 2 35 3 Trivial RTCs 36 4 ------------
+50
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 + quartz-load-femtofarads: 21 + $ref: /schemas/types.yaml#/definitions/uint32 22 + description: 23 + The capacitive load of the quartz(x-tal), expressed in femto 24 + Farad (fF). The default value shall be listed (if optional), 25 + and likewise all valid values. 26 + 27 + start-year: 28 + $ref: /schemas/types.yaml#/definitions/uint32 29 + description: 30 + If provided, the default hardware range supported by the RTC is 31 + shifted so the first usable year is the specified one. 32 + 33 + trickle-diode-disable: 34 + $ref: /schemas/types.yaml#/definitions/flag 35 + description: 36 + Do not use internal trickle charger diode. Should be given if 37 + internal trickle charger diode should be disabled. 38 + 39 + trickle-resistor-ohms: 40 + $ref: /schemas/types.yaml#/definitions/uint32 41 + description: 42 + Selected resistor for trickle charger. Should be given 43 + if trickle charger should be enabled. 44 + 45 + wakeup-source: 46 + $ref: /schemas/types.yaml#/definitions/flag 47 + description: 48 + Enables wake up of host system on alarm. 49 + 50 + ...