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

dt-bindings: rtc: Convert and update jz4740-rtc doc to YAML

Convert the jz4740-rtc doc to YAML, and update it to reflect the new
changes in the driver:
- More compatible strings are specified, with fallbacks if needed,
- The vendor-specific properties are now properly prefixed with the
'ingenic,' prefix.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
Reviewed-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20200311182318.22154-3-paul@crapouillou.net
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>

authored by

Paul Cercueil and committed by
Alexandre Belloni
f1cd2233 91b298f5

+83 -37
-37
Documentation/devicetree/bindings/rtc/ingenic,jz4740-rtc.txt
··· 1 - JZ4740 and similar SoCs real-time clock driver 2 - 3 - Required properties: 4 - 5 - - compatible: One of: 6 - - "ingenic,jz4740-rtc" - for use with the JZ4740 SoC 7 - - "ingenic,jz4780-rtc" - for use with the JZ4780 SoC 8 - - reg: Address range of rtc register set 9 - - interrupts: IRQ number for the alarm interrupt 10 - - clocks: phandle to the "rtc" clock 11 - - clock-names: must be "rtc" 12 - 13 - Optional properties: 14 - - system-power-controller: To use this component as the 15 - system power controller 16 - - reset-pin-assert-time-ms: Reset pin low-level assertion 17 - time after wakeup (default 60ms; range 0-125ms if RTC clock 18 - at 32 kHz) 19 - - min-wakeup-pin-assert-time-ms: Minimum wakeup pin assertion 20 - time (default 100ms; range 0-2s if RTC clock at 32 kHz) 21 - 22 - Example: 23 - 24 - rtc@10003000 { 25 - compatible = "ingenic,jz4740-rtc"; 26 - reg = <0x10003000 0x40>; 27 - 28 - interrupt-parent = <&intc>; 29 - interrupts = <32>; 30 - 31 - clocks = <&rtc_clock>; 32 - clock-names = "rtc"; 33 - 34 - system-power-controller; 35 - reset-pin-assert-time-ms = <60>; 36 - min-wakeup-pin-assert-time-ms = <100>; 37 - };
+83
Documentation/devicetree/bindings/rtc/ingenic,rtc.yaml
··· 1 + # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/rtc/ingenic,rtc.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: Ingenic SoCs Real-Time Clock DT bindings 8 + 9 + maintainers: 10 + - Paul Cercueil <paul@crapouillou.net> 11 + 12 + allOf: 13 + - $ref: rtc.yaml# 14 + 15 + properties: 16 + compatible: 17 + oneOf: 18 + - enum: 19 + - ingenic,jz4740-rtc 20 + - ingenic,jz4760-rtc 21 + - items: 22 + - const: ingenic,jz4725b-rtc 23 + - const: ingenic,jz4740-rtc 24 + - items: 25 + - enum: 26 + - ingenic,jz4770-rtc 27 + - ingenic,jz4780-rtc 28 + - const: ingenic,jz4760-rtc 29 + 30 + reg: 31 + maxItems: 1 32 + 33 + interrupts: 34 + maxItems: 1 35 + 36 + clocks: 37 + maxItems: 1 38 + 39 + clock-names: 40 + const: rtc 41 + 42 + system-power-controller: 43 + description: | 44 + Indicates that the RTC is responsible for powering OFF 45 + the system. 46 + type: boolean 47 + 48 + ingenic,reset-pin-assert-time-ms: 49 + minimum: 0 50 + maximum: 125 51 + default: 60 52 + description: | 53 + Reset pin low-level assertion time after wakeup 54 + (assuming RTC clock at 32 kHz) 55 + 56 + ingenic,min-wakeup-pin-assert-time-ms: 57 + minimum: 0 58 + maximum: 2000 59 + default: 100 60 + description: | 61 + Minimum wakeup pin assertion time 62 + (assuming RTC clock at 32 kHz) 63 + 64 + required: 65 + - compatible 66 + - reg 67 + - interrupts 68 + - clocks 69 + - clock-names 70 + 71 + examples: 72 + - | 73 + #include <dt-bindings/clock/jz4740-cgu.h> 74 + rtc_dev: rtc@10003000 { 75 + compatible = "ingenic,jz4740-rtc"; 76 + reg = <0x10003000 0x40>; 77 + 78 + interrupt-parent = <&intc>; 79 + interrupts = <15>; 80 + 81 + clocks = <&cgu JZ4740_CLK_RTC>; 82 + clock-names = "rtc"; 83 + };