drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation #63961

bjarki-andreasen · 2023-10-15T18:12:38Z

This PR adds two features required for power off of the atmel sam series chips

Driver and DTS entry for SUPC. This component sets up wakeup sources and powers down the core voltage regulator, which is required to go to sleep and wake up again.
sys_poweroff implementation required to synchronously enable the wakeup sources using SUPC, and entering deep sleep (backup mode)

soc/arm/atmel_sam/common/soc_poweroff.c

bjarki-andreasen · 2023-10-18T23:35:38Z

@nandojve I have created a PR to add missing defines for registers required by this PR and the RTC PR (to avoid some ugly hackery), please review it :)

gmarull · 2023-10-20T11:53:44Z

@nandojve @gmarull Using the RTC device as an example, we could then have
rtc: rtc@01010101 {
        ...
        wakeup-source-channel = <&supc SUPC_CHANNEL_RTC_ALARM>;
};
in the .dtsi and
&rtc: {
        ...
        wakeup-source;
        status = "okay";
};
in the overlay :)

lgtm

nandojve · 2023-10-20T18:28:35Z

Hi @bjarki-trackunit ,

@nandojve @gmarull Using the RTC device as an example, we could then have
rtc: rtc@01010101 {
        ...
        wakeup-source-channel = <&supc SUPC_CHANNEL_RTC_ALARM>;
};

Let's use supc for now since it have multiple functions and it will be used in more places.

rtc: rtc@01010101 {
        ...
        supc = <&supc SUPC_CHANNEL_RTC_ALARM>;
or
        atmel,supc = <&supc SUPC_CHANNEL_RTC_ALARM>;
};

The below seems to be the correct way to enable the wake-up source.

in the .dtsi and

&rtc: {
        ...
        wakeup-source;
        status = "okay";
};

bjarki-andreasen · 2023-10-20T18:45:59Z

Let's use supc for now since it have multiple functions and it will be used in more places.
rtc: rtc@01010101 {
        ...
        supc = <&supc SUPC_CHANNEL_RTC_ALARM>;
or
        atmel,supc = <&supc SUPC_CHANNEL_RTC_ALARM>;
};

I might be misunderstanding something. This is a concrete example of using the wakeup-souce-id cell:

.dtsi

supc: supc@400e1810 {
	compatible = "atmel,sam-supc";
	reg = <0x400e1810 0x20>;
	#wakeup-source-id-cells = <1>;
	status = "okay";
};

...

rtc: rtc@400e1860 {
	compatible = "atmel,sam-rtc";
	reg = <0x400e1860 0x100>;
	interrupts = <2 0>;
	clocks = <&pmc PMC_TYPE_PERIPHERAL 2>;
	wakeup-source-ids = <&supc SUPC_WAKEUP_SOURCE_RTC>;
	alarms-count = <1>;
	status = "disabled";
};

.dts

&rtc {
	status = "okay";
	wakeup-source;
};

I don't understand why we would call the #wakeup-source-id-cells supc?

nandojve · 2023-10-20T21:06:38Z

Hi @bjarki-trackunit ,

You are right in your approach defining the #wakeup-source-id-cells at supc. Let's use it.

nandojve · 2023-10-21T13:52:18Z

soc/arm/atmel_sam/common/CMakeLists.txt


 zephyr_library_sources_ifdef(CONFIG_SOC_SERIES_SAM4L soc_sam4l_pm.c)
 zephyr_library_sources_ifdef(CONFIG_SOC_SERIES_SAM4L soc_sam4l_gpio.c)
+zephyr_library_sources_ifndef(CONFIG_SOC_SERIES_SAM4L soc_poweroff.c)


you mean

-zephyr_library_sources_ifndef(CONFIG_SOC_SERIES_SAM4L soc_poweroff.c) +zephyr_library_sources_ifdef(CONFIG_SOC_SERIES_SAM4L soc_sam4l_poweroff.c)

nandojve · 2023-10-21T14:11:38Z

soc/arm/atmel_sam/common/soc_supc.h

+#define _ATMEL_SAM_SOC_SUPC_H_
+
+#include <zephyr/types.h>
+#include <soc.h>


This include is not necessary.

-#include <soc.h>

bjarki-andreasen · 2023-10-21T22:44:44Z

The failing test will succeed once the hal is updated :)

nandojve · 2023-10-22T10:44:53Z

dts/bindings/power/atmel,sam-supc.yaml

+  The supply controller manages wakeup sources and core voltages and
+  regulators.


The supply controller manages the voltage reference, power supply and supply
monitoring of the device. It have a special feature that it can wake-up the
device from a low-power state using special peripherals as wake-up sources.

Replaced with your suggestion

nandojve · 2023-10-22T10:48:45Z

dts/bindings/power/atmel,sam-supc.yaml

+  To specify the wakeup source channel used by a peripheral, the custom
+  property wakeup-source-channel needs to be used, e.g. for the RTC
+  device:


The dedicated peripherals that can wake-up the core supply domain are: RTC,
RTT, Supply Monitor and GPIOs. In the first three peripherals it is necessary
inform the wakeup-source-id property on their respective nodes.

Replaced with your suggestion

nandojve · 2023-10-22T10:51:19Z

dts/bindings/power/atmel,sam-supc.yaml

+  The device drivers will then use the provided channel to enable its wakeup
+  if they have been designated as wakeup sources using the standard
+  wakeup-source property, e.g.


The special peripheral will wake-up the device only when the standard property
wakeup-source is defined, e.g.:

Replaced with your suggestion

nandojve · 2023-10-22T10:54:35Z

dts/bindings/power/atmel,sam-supc.yaml

+
+    rtc: rtc@xxx {
+      ...
+      wakeup-source-id = <&supc SUPC_WAKEUP_SOURCE_RTT>;


- wakeup-source-id = <&supc SUPC_WAKEUP_SOURCE_RTT>; + wakeup-source-id = <&supc SUPC_WAKEUP_SOURCE_RTC>;

Replaced with your suggestion

nandojve · 2023-10-23T15:51:49Z

Hi @bjarki-trackunit ,

I was wondering if you can update this PR to us check if is already passing CI.

This commit adds a driver and dts model for the ATMEL SAM SUPC component. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

This commit adds the new SUPC devicetree instance to the soc dtsi files. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

This commit adds an implementation of poweroff, which first uses SUPC to enable all defined wakeup sources (except for sam4l), followed by entering backup mode. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

bjarki-andreasen · 2023-10-23T18:20:35Z

@nandojve In progress :)

nandojve

LGTM!

gmarull

ok to poweroff changes

bjarki-andreasen force-pushed the sam4_add_poweroff branch 2 times, most recently from 1c65aca to 2ea4b77 Compare October 15, 2023 18:15

bjarki-andreasen marked this pull request as ready for review October 15, 2023 22:31

bjarki-andreasen requested review from nandojve, ioannisg, MaureenHelm and galak as code owners October 15, 2023 22:31

zephyrbot added the platform: Microchip SAM Microchip SAM Platform (formerly Atmel SAM) label Oct 15, 2023

zephyrbot requested review from attie-argentum, mnkp, pdgendt and stephanosio October 15, 2023 22:32

zephyrbot assigned nandojve Oct 15, 2023

gmarull reviewed Oct 16, 2023

View reviewed changes

soc/arm/atmel_sam/common/soc_poweroff.c Outdated Show resolved Hide resolved

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 2ea4b77 to 8b6af25 Compare October 16, 2023 10:48

gmarull previously approved these changes Oct 16, 2023

View reviewed changes

bjarki-andreasen dismissed gmarull’s stale review via 0a46e98 October 16, 2023 10:49

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 8b6af25 to 0a46e98 Compare October 16, 2023 10:49

bjarki-andreasen requested a review from gmarull October 16, 2023 10:52

gmarull previously approved these changes Oct 16, 2023

View reviewed changes

nandojve requested changes Oct 18, 2023

View reviewed changes

soc/arm/atmel_sam/common/soc_poweroff.c Outdated Show resolved Hide resolved

bjarki-andreasen dismissed gmarull’s stale review via b15d771 October 18, 2023 23:00

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 0a46e98 to b15d771 Compare October 18, 2023 23:00

zephyrbot added the area: Devicetree Binding PR modifies or adds a Device Tree binding label Oct 18, 2023

bjarki-andreasen force-pushed the sam4_add_poweroff branch from b15d771 to 43dea8b Compare October 18, 2023 23:35

bjarki-andreasen force-pushed the sam4_add_poweroff branch 2 times, most recently from 3f1b294 to 5944121 Compare October 19, 2023 22:27

bjarki-andreasen changed the title ~~Add sys_poweroff implementation for atmel_sam series~~ Add SUPC and sys_poweroff implementation for atmel_sam series Oct 19, 2023

bjarki-andreasen changed the title ~~Add SUPC and sys_poweroff implementation for atmel_sam series~~ Add SUPC, wakeup sources and poweroff implementation for atmel_sam series Oct 19, 2023

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 5944121 to d10fce2 Compare October 20, 2023 19:23

bjarki-andreasen requested review from nashif and carlescufi as code owners October 20, 2023 19:23

bjarki-andreasen force-pushed the sam4_add_poweroff branch 2 times, most recently from 18231b6 to 228cfe8 Compare October 20, 2023 20:13

nandojve requested changes Oct 21, 2023

View reviewed changes

nandojve mentioned this pull request Oct 21, 2023

drivers: pinctrl: sam: Add wake-up source support #64213

Closed

nandojve changed the title ~~Add SUPC, wakeup sources and poweroff implementation for atmel_sam series~~ drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation Oct 21, 2023

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 228cfe8 to 848b549 Compare October 21, 2023 22:44

bjarki-andreasen requested a review from nandojve October 21, 2023 22:44

nandojve requested changes Oct 22, 2023

View reviewed changes

nandojve added this to the v3.6.0 milestone Oct 23, 2023

Bjarki Arge Andreasen added 3 commits October 23, 2023 20:16

soc: sam: Add SUPC driver and dts model

a6cd718

This commit adds a driver and dts model for the ATMEL SAM SUPC component. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

dts: soc: atmel: sam: Add SUPC component to soc dtsi

f758b26

This commit adds the new SUPC devicetree instance to the soc dtsi files. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

soc: sam: Add poweroff implementation

d83f367

This commit adds an implementation of poweroff, which first uses SUPC to enable all defined wakeup sources (except for sam4l), followed by entering backup mode. Signed-off-by: Bjarki Arge Andreasen <[email protected]>

bjarki-andreasen force-pushed the sam4_add_poweroff branch from 848b549 to d83f367 Compare October 23, 2023 18:19

nandojve approved these changes Oct 23, 2023

View reviewed changes

bjarki-andreasen requested a review from gmarull October 23, 2023 20:34

gmarull approved these changes Oct 24, 2023

View reviewed changes

carlescufi merged commit 9b21d4d into zephyrproject-rtos:main Oct 24, 2023
18 checks passed

bjarki-andreasen deleted the sam4_add_poweroff branch October 24, 2023 10:41

nandojve mentioned this pull request Nov 3, 2023

Introduce gpio-keys wake-up sources using pinctrl #64538

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation #63961

drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation #63961

bjarki-andreasen commented Oct 15, 2023 •

edited

Loading

bjarki-andreasen commented Oct 18, 2023

gmarull commented Oct 20, 2023

nandojve commented Oct 20, 2023

bjarki-andreasen commented Oct 20, 2023 •

edited

Loading

nandojve commented Oct 20, 2023

nandojve Oct 21, 2023

bjarki-andreasen Oct 21, 2023

nandojve Oct 21, 2023 •

edited

Loading

bjarki-andreasen Oct 21, 2023

bjarki-andreasen commented Oct 21, 2023

nandojve Oct 22, 2023

bjarki-andreasen Oct 23, 2023

nandojve Oct 22, 2023

bjarki-andreasen Oct 23, 2023

nandojve Oct 22, 2023

bjarki-andreasen Oct 23, 2023

nandojve Oct 22, 2023

bjarki-andreasen Oct 23, 2023

nandojve commented Oct 23, 2023

bjarki-andreasen commented Oct 23, 2023

nandojve left a comment

gmarull left a comment

		The supply controller manages wakeup sources and core voltages and
		regulators.

drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation #63961

drivers: power: sam: Introduce Atmel SAM SUPC, wakeup sources and poweroff implementation #63961

Conversation

bjarki-andreasen commented Oct 15, 2023 • edited Loading

bjarki-andreasen commented Oct 18, 2023

gmarull commented Oct 20, 2023

nandojve commented Oct 20, 2023

bjarki-andreasen commented Oct 20, 2023 • edited Loading

nandojve commented Oct 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nandojve Oct 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bjarki-andreasen commented Oct 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nandojve commented Oct 23, 2023

bjarki-andreasen commented Oct 23, 2023

nandojve left a comment

Choose a reason for hiding this comment

gmarull left a comment

Choose a reason for hiding this comment

bjarki-andreasen commented Oct 15, 2023 •

edited

Loading

bjarki-andreasen commented Oct 20, 2023 •

edited

Loading

nandojve Oct 21, 2023 •

edited

Loading