| Message ID | 20230616101646.879480-1-claudiu.beznea@microchip.com |
|---|---|
| Headers | show |
| Series | dt-bindings: power: reset: at91: convert to YAML | expand |
Hi, On Fri, Jun 16, 2023 at 01:16:45PM +0300, Claudiu Beznea wrote: > Convert Microchip AT91 SAMA5D2 shutdown controller to YAML. SAMA7G5 SHDWC > DT node (available in arch/arm/boot/dts/sama7g5.dtsi) has syscon along with > its compatible. There is no usage of this syscon in the current code but it > may be necessary in future as some registers of SHDWC are accessed in > different drivers (at91-sama5d2_shdwc.c and arch/arm/mach-at91/pm.c). > Thus update the YAML with it to make DT checkers happy. > > Signed-off-by: Claudiu Beznea <claudiu.beznea@microchip.com> > Reviewed-by: Conor Dooley <conor.dooley@microchip.com> > Acked-by: Nicolas Ferre <nicolas.ferre@microchip.com> > --- Thanks, queued. -- Sebastian > .../devicetree/bindings/arm/atmel-sysregs.txt | 63 ---------- > .../power/reset/atmel,sama5d2-shdwc.yaml | 114 ++++++++++++++++++ > 2 files changed, 114 insertions(+), 63 deletions(-) > create mode 100644 Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml > > diff --git a/Documentation/devicetree/bindings/arm/atmel-sysregs.txt b/Documentation/devicetree/bindings/arm/atmel-sysregs.txt > index e6b2fb291b45..67a66bf74895 100644 > --- a/Documentation/devicetree/bindings/arm/atmel-sysregs.txt > +++ b/Documentation/devicetree/bindings/arm/atmel-sysregs.txt > @@ -52,69 +52,6 @@ Example: > reg = <0xe3804000 0x1000>; > }; > > -SHDWC SAMA5D2-Compatible Shutdown Controller > - > -1) shdwc node > - > -required properties: > -- compatible: should be "atmel,sama5d2-shdwc", "microchip,sam9x60-shdwc" or > - "microchip,sama7g5-shdwc" > -- reg: should contain registers location and length > -- clocks: phandle to input clock. > -- #address-cells: should be one. The cell is the wake-up input index. > -- #size-cells: should be zero. > - > -optional properties: > - > -- debounce-delay-us: minimum wake-up inputs debouncer period in > - microseconds. It's usually a board-related property. > -- atmel,wakeup-rtc-timer: boolean to enable Real-Time Clock wake-up. > - > -optional microchip,sam9x60-shdwc or microchip,sama7g5-shdwc properties: > -- atmel,wakeup-rtt-timer: boolean to enable Real-time Timer Wake-up. > - > -The node contains child nodes for each wake-up input that the platform uses. > - > -2) input nodes > - > -Wake-up input nodes are usually described in the "board" part of the Device > -Tree. Note also that input 0 is linked to the wake-up pin and is frequently > -used. > - > -Required properties: > -- reg: should contain the wake-up input index [0 - 15]. > - > -Optional properties: > -- atmel,wakeup-active-high: boolean, the corresponding wake-up input described > - by the child, forces the wake-up of the core power supply on a high level. > - The default is to be active low. > - > -Example: > - > -On the SoC side: > - shdwc@f8048010 { > - compatible = "atmel,sama5d2-shdwc"; > - reg = <0xf8048010 0x10>; > - clocks = <&clk32k>; > - #address-cells = <1>; > - #size-cells = <0>; > - atmel,wakeup-rtc-timer; > - }; > - > -On the board side: > - shdwc@f8048010 { > - debounce-delay-us = <976>; > - > - input@0 { > - reg = <0>; > - }; > - > - input@1 { > - reg = <1>; > - atmel,wakeup-active-high; > - }; > - }; > - > Special Function Registers (SFR) > > Special Function Registers (SFR) manage specific aspects of the integrated > diff --git a/Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml b/Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml > new file mode 100644 > index 000000000000..8c58e12cdb60 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml > @@ -0,0 +1,114 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/power/reset/atmel,sama5d2-shdwc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Microchip AT91 SAMA5D2 SHDWC Shutdown Controller > + > +maintainers: > + - Claudiu Beznea <claudiu.beznea@microchip.com> > + > +description: | > + Microchip AT91 SHDWC shutdown controller controls the power supplies VDDIO > + and VDDCORE and the wake-up detection on debounced input lines. > + > +properties: > + compatible: > + oneOf: > + - items: > + - const: microchip,sama7g5-shdwc > + - const: syscon > + - enum: > + - atmel,sama5d2-shdwc > + - microchip,sam9x60-shdwc > + > + reg: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + "#address-cells": > + const: 1 > + > + "#size-cells": > + const: 0 > + > + debounce-delay-us: > + description: > + Minimum wake-up inputs debouncer period in microseconds. It is usually a > + board-related property. > + > + atmel,wakeup-rtc-timer: > + description: enable real-time clock wake-up > + type: boolean > + > + atmel,wakeup-rtt-timer: > + description: enable real-time timer wake-up > + type: boolean > + > +patternProperties: > + "^input@[0-15]$": > + description: > + Wake-up input nodes. These are usually described in the "board" part of > + the Device Tree. Note also that input 0 is linked to the wake-up pin and > + is frequently used. > + type: object > + properties: > + reg: > + description: contains the wake-up input index > + minimum: 0 > + maximum: 15 > + > + atmel,wakeup-active-high: > + description: > + The corresponding wake-up input described by the child forces the > + wake-up of the core power supply on a high level. The default is to > + be active low. > + type: boolean > + > + required: > + - reg > + > + additionalProperties: false > + > +required: > + - compatible > + - reg > + - clocks > + > +allOf: > + - if: > + properties: > + compatible: > + contains: > + const: atmel,sama5d2-shdwc > + then: > + properties: > + atmel,wakeup-rtt-timer: false > + > +additionalProperties: false > + > +examples: > + - | > + shdwc: poweroff@f8048010 { > + compatible = "atmel,sama5d2-shdwc"; > + reg = <0xf8048010 0x10>; > + clocks = <&clk32k>; > + #address-cells = <1>; > + #size-cells = <0>; > + atmel,wakeup-rtc-timer; > + debounce-delay-us = <976>; > + > + input@0 { > + reg = <0>; > + }; > + > + input@1 { > + reg = <1>; > + atmel,wakeup-active-high; > + }; > + }; > + > +... > -- > 2.34.1 >
Hi, Series convert AT91 shutdown controllers documentation to YAML. Along with it device trees were updated and also entries to MAINTAINERS with documentation files. Thank you, Claudiu Changes in v3: - do not define properties in allOf section - used additionalProperties instead of unevaluatedProperties - fixed compatible list of patch 3/4 - s/Atmel/Microchip AT91/g in title and description sections of YAML files and in commit description - collected tags Changes in v2: - use minimum, maximum on uint32 enums instead of all possible values - change commit description for patch 3/4 to explain why there is a syscon along with microchip,sama7g5-shdwc - remove | near description entries Claudiu Beznea (4): ARM: dts: at91: use generic name for shutdown controller dt-bindings: power: reset: atmel,at91sam9260-shdwc: convert to yaml dt-bindings: power: reset: atmel,sama5d2-shdwc: convert to yaml MAINTAINERS: add documentation file for Microchip SAMA5D2 shutdown controller .../devicetree/bindings/arm/atmel-sysregs.txt | 94 --------------- .../power/reset/atmel,at91sam9260-shdwc.yaml | 82 +++++++++++++ .../power/reset/atmel,sama5d2-shdwc.yaml | 114 ++++++++++++++++++ MAINTAINERS | 1 + arch/arm/boot/dts/at91-qil_a9260.dts | 2 +- arch/arm/boot/dts/at91-sama5d27_som1_ek.dts | 2 +- arch/arm/boot/dts/at91-sama5d2_ptc_ek.dts | 2 +- arch/arm/boot/dts/at91-sama5d2_xplained.dts | 2 +- arch/arm/boot/dts/at91sam9260.dtsi | 2 +- arch/arm/boot/dts/at91sam9260ek.dts | 2 +- arch/arm/boot/dts/at91sam9261.dtsi | 2 +- arch/arm/boot/dts/at91sam9263.dtsi | 2 +- arch/arm/boot/dts/at91sam9g20ek_common.dtsi | 2 +- arch/arm/boot/dts/at91sam9g45.dtsi | 2 +- arch/arm/boot/dts/at91sam9n12.dtsi | 2 +- arch/arm/boot/dts/at91sam9rl.dtsi | 2 +- arch/arm/boot/dts/at91sam9x5.dtsi | 2 +- arch/arm/boot/dts/sam9x60.dtsi | 2 +- arch/arm/boot/dts/sama5d2.dtsi | 2 +- arch/arm/boot/dts/sama5d3.dtsi | 2 +- arch/arm/boot/dts/sama5d4.dtsi | 2 +- arch/arm/boot/dts/sama7g5.dtsi | 2 +- arch/arm/boot/dts/usb_a9260.dts | 2 +- arch/arm/boot/dts/usb_a9263.dts | 2 +- 24 files changed, 217 insertions(+), 114 deletions(-) create mode 100644 Documentation/devicetree/bindings/power/reset/atmel,at91sam9260-shdwc.yaml create mode 100644 Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml