soc: nxp: mcxw2xx: Enable the power management

Enabled modes:
  idle: SLEEP
  suspend: DEEP-SLEEP
  standby: POWER-DOWN with CPU retention

OS Time Base: OSTIMER with 32K clock source

Signed-off-by: Jason Yu <zejiang.yu@nxp.com>

Author: zejiang0jason

boards/nxp/frdm_mcxw23/doc/index.rst

@@ -198,6 +198,21 @@ should see the following message in the terminal:
    *** Booting Zephyr OS build v4.2.0-2105-g48f2ffda26de ***
    Hello World! frdm_mcxw23/mcxw236
 
+Power Management
+================
+
+When Power Management is enabled, OSTIMER is used as OS tick timer.
+Add device tree overlay file to the main directory of your application
+to enable OSTIMER.
+
+.. code-block:: devicetree
+
+   &os_timer {
+       status = "okay";
+   };
+
+Limitation: Wakeup pin can't be used as wakeup source in Standby mode.
+
 .. include:: ../../common/board-footer.rst.inc
 
 .. _MCXW23 SoC Website:

boards/nxp/mcxw23_evk/doc/index.rst

@@ -177,6 +177,21 @@ should see the following message in the terminal:
    *** Booting Zephyr OS build v4.2.0-2105-g9da1d56da9e7 ***
    Hello World! mcxw23_evk/mcxw236
 
+Power Management
+================
+
+When Power Management is enabled, OSTIMER is used as OS tick timer.
+Add device tree overlay file to the main directory of your application
+to enable OSTIMER.
+
+.. code-block:: devicetree
+
+   &os_timer {
+       status = "okay";
+   };
+
+Limitation: Wakeup pin can't be used as wakeup source in Standby mode.
+
 .. include:: ../../common/board-footer.rst.inc
 
 .. _MCXW23 SoC Website:

dts/arm/nxp/nxp_mcxw23x_common.dtsi

@@ -32,12 +32,47 @@
 			reg = <0>;
 			#address-cells = <1>;
 			#size-cells = <1>;
+			cpu-power-states = <&idle &suspend &standby>;
 
 			mpu: mpu@e000ed90 {
 				compatible = "arm,armv8m-mpu";
 				reg = <0xe000ed90 0x40>;
 			};
 		};
+
+		power-states {
+			/* Idle mode maps to Sleep mode. */
+			idle: idle {
+				compatible = "zephyr,power-state";
+				power-state-name = "runtime-idle";
+				min-residency-us = <60>;
+				exit-latency-us = <16>;
+				zephyr,pm-device-disabled;
+			};
+
+			/* Suspend mode maps to Deep Sleep mode. */
+			suspend: suspend {
+				compatible = "zephyr,power-state";
+				power-state-name = "suspend-to-idle";
+				min-residency-us = <1300>;
+				exit-latency-us = <749>;
+			};
+
+			/* Standby mode maps to Power Down mode with CPU retention . */
+			standby: standby {
+				compatible = "zephyr,power-state";
+				power-state-name = "standby";
+				min-residency-us = <2000>;
+				exit-latency-us = <1345>;
+			};
+		};
+	};
+
+	/* For the resource which will be off and lose content. */
+	standby_off_domain: standby-off-domain {
+		compatible = "power-domain-soc-state-change";
+		#power-domain-cells = <0>;
+		onoff-power-states = <&standby>;
 	};
 
 	sysclk: system-clock {
@@ -175,6 +210,7 @@
 		mode = <0>;
 		input = <0>;
 		prescale = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 	};
 
 	ctimer1: ctimer@9000 {
@@ -187,6 +223,7 @@
 		mode = <0>;
 		input = <0>;
 		prescale = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 	};
 
 	ctimer2: ctimer@28000 {
@@ -199,6 +236,7 @@
 		mode = <0>;
 		input = <0>;
 		prescale = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 	};
 
 	ctimer3: ctimer@29000 {
@@ -211,6 +249,7 @@
 		mode = <0>;
 		input = <0>;
 		prescale = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 	};
 
 	ctimer4: ctimer@2a000 {
@@ -223,6 +262,7 @@
 		mode = <0>;
 		input = <0>;
 		prescale = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 	};
 
 	sc_timer: pwm@85000 {
@@ -232,13 +272,15 @@
 		status = "disabled";
 		clocks = <&syscon MCUX_SCTIMER_CLK>;
 		prescaler = <2>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 		#pwm-cells = <3>;
 	};
 
 	os_timer: timers@2d000 {
 		compatible = "nxp,os-timer";
 		reg = <0x2d000 0x1000>;
 		interrupts = <38 1>;
+		resets = <&reset NXP_SYSCON_RESET(1, 1)>;
 		status = "disabled";
 	};
 
@@ -250,6 +292,7 @@
 		resets = <&reset NXP_SYSCON_RESET(1, 11)>;
 		dmas = <&dma0 4 &dma0 5>;
 		dma-names = "rx", "tx";
+		zephyr,disabling-power-states = <&suspend &standby>;
 		status = "disabled";
 	};
 
@@ -261,6 +304,8 @@
 		resets = <&reset NXP_SYSCON_RESET(1, 12)>;
 		dmas = <&dma0 6 &dma0 7>;
 		dma-names = "rx", "tx";
+		zephyr,disabling-power-states = <&suspend &standby>;
+		power-domains = <&standby_off_domain>;
 		status = "disabled";
 	};
 
@@ -272,6 +317,8 @@
 		resets = <&reset NXP_SYSCON_RESET(1, 13)>;
 		dmas = <&dma0 8 &dma0 9>;
 		dma-names = "rx", "tx";
+		zephyr,disabling-power-states = <&suspend &standby>;
+		power-domains = <&standby_off_domain>;
 		status = "disabled";
 	};
 
@@ -287,6 +334,8 @@
 		reg = <0x82000 0x1000>;
 		interrupts = <1 1>;
 		dma-channels = <23>;
+		zephyr,disabling-power-states = <&suspend &standby>;
+		power-domains = <&standby_off_domain>;
 		status = "disabled";
 		#dma-cells = <1>;
 	};
@@ -296,6 +345,8 @@
 		reg = <0xa7000 0x1000>;
 		interrupts = <58 1>;
 		dma-channels = <10>;
+		zephyr,disabling-power-states = <&suspend &standby>;
+		power-domains = <&standby_off_domain>;
 		status = "disabled";
 		#dma-cells = <1>;
 	};
@@ -328,6 +379,7 @@
 		resets = <&reset NXP_SYSCON_RESET(1, 0)>;
 		#address-cells = <1>;
 		#size-cells = <0>;
+		zephyr,disabling-power-states = <&suspend &standby>;
 
 		mrt0_channel0: mrt0_channel@0 {
 			compatible = "nxp,mrt-channel";

soc/nxp/mcx/mcxw/mcxw2xx/Kconfig.defconfig

@@ -4,6 +4,9 @@
 
 if SOC_SERIES_MCXW2XX
 
+config MCUX_OS_TIMER
+	default y if PM
+
 config CORTEX_M_SYSTICK
 	default n if MCUX_OS_TIMER
 
@@ -13,9 +16,14 @@ config NUM_IRQS
 DT_SYSCLK_PATH := $(dt_nodelabel_path,sysclk)
 
 config SYS_CLOCK_HW_CYCLES_PER_SEC
-	default 1000000 if MCUX_OS_TIMER
+	default 32768   if MCUX_OS_TIMER && PM
+	default 1000000 if MCUX_OS_TIMER && !PM
 	default $(dt_node_int_prop_int,$(DT_SYSCLK_PATH),clock-frequency) if CORTEX_M_SYSTICK
 
+config SYS_CLOCK_TICKS_PER_SEC
+	default 512  if MCUX_OS_TIMER && PM
+	default 1000 if MCUX_OS_TIMER && !PM
+
 # Set to the minimal size of data which can be written.
 config FLASH_FILL_BUFFER_SIZE
 	default 512
@@ -36,4 +44,35 @@ config MAIN_STACK_SIZE
 
 endif # BT
 
+if PM
+
+# Enable PM_DEVICE for Suspend mode and Standby mode,
+# because some devices can't work in these modes.
+config PM_DEVICE
+	default y if "$(dt_nodelabel_enabled,standby)" || "$(dt_nodelabel_enabled,suspend)"
+
+config PM_POLICY_DEVICE_CONSTRAINTS
+	default y if PM_DEVICE
+
+config IDLE_STACK_SIZE
+	default 640
+
+config TICKLESS_KERNEL
+	default y if PM
+
+if BT
+choice PM_POLICY
+	default PM_POLICY_CUSTOM
+endchoice
+endif # BT
+
+endif # PM
+
+if PM_DEVICE
+
+config POWER_DOMAIN
+	default y
+
+endif # PM_DEVICE
+
 endif # SOC_SERIES_MCXW2XX