tests: pm: policy_api: Add test for locking all PM states

Add test case that validates behavior of pm_policy_state_all_lock_get and pm_policy_state_all_lock_put. Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>

Author: nordic-krch

include/zephyr/pm/policy.h

@@ -112,7 +112,6 @@ const struct pm_state_info *pm_policy_next_state(uint8_t cpu, int32_t ticks);
  *
  * @see pm_policy_state_lock_put()
  */
-
 void pm_policy_state_lock_get(enum pm_state state, uint8_t substate_id);
 
 /**
@@ -365,7 +364,6 @@ static inline void pm_policy_device_power_lock_put(const struct device *dev)
 {
 ARG_UNUSED(dev);
 }
-
 #endif /* CONFIG_PM_POLICY_DEVICE_CONSTRAINTS */
 
 #if defined(CONFIG_PM) || defined(CONFIG_PM_POLICY_LATENCY_STANDALONE) || defined(__DOXYGEN__)

subsys/pm/policy/policy_state_lock.c

@@ -50,13 +50,17 @@ static struct k_spinlock lock;
 
 void pm_policy_state_all_lock_get(void)
 {
+#if DT_HAS_COMPAT_STATUS_OKAY(zephyr_power_state)
 (void)atomic_inc(&global_lock_cnt);
+#endif
 }
 
 void pm_policy_state_all_lock_put(void)
 {
+#if DT_HAS_COMPAT_STATUS_OKAY(zephyr_power_state)
 __ASSERT(global_lock_cnt > 0, "Unbalanced state lock get/put");
 (void)atomic_dec(&global_lock_cnt);
+#endif
 }
 
 

tests/subsys/pm/policy_api/src/main.c

@@ -71,6 +71,37 @@ ZTEST(policy_api, test_pm_policy_next_state_default)
 zassert_equal(next->state, PM_STATE_SUSPEND_TO_RAM);
 }
 
+ZTEST(policy_api, test_pm_policy_state_all_lock)
+{
+/* initial state: PM_STATE_RUNTIME_IDLE allowed */
+zassert_false(pm_policy_state_lock_is_active(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_true(pm_policy_state_is_available(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_true(pm_policy_state_any_active());
+
+/* Locking all states. */
+pm_policy_state_all_lock_get();
+pm_policy_state_all_lock_get();
+
+/* States are locked. */
+zassert_true(pm_policy_state_lock_is_active(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_false(pm_policy_state_is_available(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_false(pm_policy_state_any_active());
+
+pm_policy_state_all_lock_put();
+
+/* States are still locked due to reference counter. */
+zassert_true(pm_policy_state_lock_is_active(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_false(pm_policy_state_is_available(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_false(pm_policy_state_any_active());
+
+pm_policy_state_all_lock_put();
+
+/* States are available again. */
+zassert_false(pm_policy_state_lock_is_active(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_true(pm_policy_state_is_available(PM_STATE_RUNTIME_IDLE, PM_ALL_SUBSTATES));
+zassert_true(pm_policy_state_any_active());
+}
+
 /**
  * @brief Test the behavior of pm_policy_next_state() when
  * states are allowed/disallowed and CONFIG_PM_POLICY_DEFAULT=y.