power: Rename constraint API

Replace pm_ctrl_* with pm_constraint.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>

Author: Flavio Ceolin

boards/arm/cc1352r1_launchxl/doc/index.rst

@@ -216,9 +216,9 @@ disable sleep state 2 while polling:
 
 .. code-block:: c
 
-    pm_ctrl_disable_state(PM_STATE_STANDBY);
+    pm_constraint_set(PM_STATE_STANDBY);
     <code that calls uart_poll_in() and expects input at any point in time>
-    pm_ctrl_enable_state(PM_STATE_STANDBY);
+    pm_constraint_release(PM_STATE_STANDBY);
 
 
 References

boards/arm/cc1352r_sensortag/doc/index.rst

@@ -242,9 +242,9 @@ disable sleep state 2 while polling:
 
 .. code-block:: c
 
-    pm_ctrl_disable_state(PM_STATE_STANDBY);
+    pm_constraint_set(PM_STATE_STANDBY);
     <code that calls uart_poll_in() and expects input at any point in time>
-    pm_ctrl_enable_state(PM_STATE_STANDBY);
+    pm_constraint_release(PM_STATE_STANDBY);
 
 
 References

boards/arm/cc26x2r1_launchxl/doc/index.rst

@@ -222,9 +222,9 @@ disable sleep state 2 while polling:
 
 .. code-block:: c
 
-    pm_ctrl_disable_state(PM_STATE_STANDBY);
+    pm_constraint_set(PM_STATE_STANDBY);
     <code that calls uart_poll_in() and expects input at any point in time>
-    pm_ctrl_enable_state(PM_STATE_STANDBY);
+    pm_constraint_release(PM_STATE_STANDBY);
 
 
 References

drivers/entropy/entropy_cc13xx_cc26xx.c

@@ -109,7 +109,7 @@ static int entropy_cc13xx_cc26xx_get_entropy(const struct device *dev,
 	unsigned int key = irq_lock();
 
 	if (!data->constrained) {
-		pm_ctrl_disable_state(PM_STATE_STANDBY);
+		pm_constraint_set(PM_STATE_STANDBY);
 		data->constrained = true;
 	}
 	irq_unlock(key);
@@ -154,7 +154,7 @@ static void entropy_cc13xx_cc26xx_isr(const void *arg)
 		if (cnt != sizeof(num)) {
 #ifdef CONFIG_PM
 			if (data->constrained) {
-				pm_ctrl_enable_state(
+				pm_constraint_release(
 					PM_STATE_STANDBY);
 				data->constrained = false;
 			}
@@ -333,7 +333,7 @@ static int entropy_cc13xx_cc26xx_init(const struct device *dev)
 #if defined(CONFIG_PM)
 	Power_setDependency(PowerCC26XX_PERIPH_TRNG);
 	/* Stay out of standby until buffer is filled with entropy */
-	pm_ctrl_disable_state(PM_STATE_STANDBY);
+	pm_constraint_set(PM_STATE_STANDBY);
 	data->constrained = true;
 	/* Register notification function */
 	Power_registerNotify(&data->post_notify,

drivers/i2c/i2c_cc13xx_cc26xx.c

@@ -208,7 +208,7 @@ static int i2c_cc13xx_cc26xx_transfer(const struct device *dev,
 	k_sem_take(&get_dev_data(dev)->lock, K_FOREVER);
 
 #ifdef CONFIG_PM
-	pm_ctrl_disable_state(PM_STATE_STANDBY);
+	pm_constraint_set(PM_STATE_STANDBY);
 #endif
 
 	for (int i = 0; i < num_msgs; i++) {
@@ -232,7 +232,7 @@ static int i2c_cc13xx_cc26xx_transfer(const struct device *dev,
 	}
 
 #ifdef CONFIG_PM
-	pm_ctrl_enable_state(PM_STATE_STANDBY);
+	pm_constraint_release(PM_STATE_STANDBY);
 #endif
 
 	k_sem_give(&get_dev_data(dev)->lock);

drivers/serial/uart_cc13xx_cc26xx.c

@@ -243,7 +243,7 @@ static void uart_cc13xx_cc26xx_irq_tx_enable(const struct device *dev)
 		 * standby mode instead, since it is the power state that
 		 * would interfere with a transfer.
 		 */
-		pm_ctrl_disable_state(PM_STATE_STANDBY);
+		pm_constraint_set(PM_STATE_STANDBY);
 		get_dev_data(dev)->tx_constrained = true;
 	}
 #endif
@@ -257,7 +257,7 @@ static void uart_cc13xx_cc26xx_irq_tx_disable(const struct device *dev)
 
 #ifdef CONFIG_PM
 	if (get_dev_data(dev)->tx_constrained) {
-		pm_ctrl_enable_state(PM_STATE_STANDBY);
+		pm_constraint_release(PM_STATE_STANDBY);
 		get_dev_data(dev)->tx_constrained = false;
 	}
 #endif
@@ -277,7 +277,7 @@ static void uart_cc13xx_cc26xx_irq_rx_enable(const struct device *dev)
 	 * standby.
 	 */
 	if (!get_dev_data(dev)->rx_constrained) {
-		pm_ctrl_disable_state(PM_STATE_STANDBY);
+		pm_constraint_set(PM_STATE_STANDBY);
 		get_dev_data(dev)->rx_constrained = true;
 	}
 #endif
@@ -289,7 +289,7 @@ static void uart_cc13xx_cc26xx_irq_rx_disable(const struct device *dev)
 {
 #ifdef CONFIG_PM
 	if (get_dev_data(dev)->rx_constrained) {
-		pm_ctrl_enable_state(PM_STATE_STANDBY);
+		pm_constraint_release(PM_STATE_STANDBY);
 		get_dev_data(dev)->rx_constrained = false;
 	}
 #endif

drivers/spi/spi_cc13xx_cc26xx.c

@@ -149,7 +149,7 @@ static int spi_cc13xx_cc26xx_transceive(const struct device *dev,
 	spi_context_lock(ctx, false, NULL, config);
 
 #ifdef CONFIG_PM
-	pm_ctrl_disable_state(PM_STATE_STANDBY);
+	pm_constraint_set(PM_STATE_STANDBY);
 #endif
 
 	err = spi_cc13xx_cc26xx_configure(dev, config);
@@ -185,7 +185,7 @@ static int spi_cc13xx_cc26xx_transceive(const struct device *dev,
 
 done:
 #ifdef CONFIG_PM
-	pm_ctrl_enable_state(PM_STATE_STANDBY);
+	pm_constraint_release(PM_STATE_STANDBY);
 #endif
 	spi_context_release(ctx, err);
 	return err;

include/power/power.h

@@ -166,25 +166,25 @@ void pm_dump_debug_info(void);
  *
  * @details Disabled state cannot be selected by the Zephyr power
  *	    management policies. Application defined policy should
- *	    use the @ref pm_ctrl_is_state_enabled function to
+ *	    use the @ref pm_constraint_get function to
  *	    check if given state is enabled and could be used.
  *
  * @param [in] state Power state to be disabled.
  */
-void pm_ctrl_disable_state(enum pm_state state);
+void pm_constraint_set(enum pm_state state);
 
 /**
  * @brief Enable particular power state
  *
  * @details Enabled state can be selected by the Zephyr power
  *	    management policies. Application defined policy should
- *	    use the @ref pm_ctrl_is_state_enabled function to
+ *	    use the @ref pm_constraint_get function to
  *	    check if given state is enabled and could be used.
  *	    By default all power states are enabled.
  *
  * @param [in] state Power state to be enabled.
  */
-void pm_ctrl_enable_state(enum pm_state state);
+void pm_constraint_release(enum pm_state state);
 
 /**
  * @brief Check if particular power state is enabled
@@ -193,7 +193,7 @@ void pm_ctrl_enable_state(enum pm_state state);
  *
  * @param [in] state Power state.
  */
-bool pm_ctrl_is_state_enabled(enum pm_state state);
+bool pm_constraint_get(enum pm_state state);
 
 #endif /* CONFIG_PM_STATE_LOCK */
 

samples/boards/nrf/system_off/src/main.c

@@ -27,7 +27,7 @@ static int disable_ds_1(const struct device *dev)
 {
 	ARG_UNUSED(dev);
 
-	pm_ctrl_disable_state(PM_STATE_SOFT_OFF);
+	pm_constraint_set(PM_STATE_SOFT_OFF);
 	return 0;
 }
 

subsys/power/pm_ctrl.c

@@ -19,7 +19,7 @@ LOG_MODULE_DECLARE(power);
 
 static atomic_t power_state_disable_count[PM_STATES_LEN];
 
-void pm_ctrl_disable_state(enum pm_state state)
+void pm_constraint_set(enum pm_state state)
 {
 	atomic_val_t v;
 
@@ -31,7 +31,7 @@ void pm_ctrl_disable_state(enum pm_state state)
 	(void)(v);
 }
 
-void pm_ctrl_enable_state(enum pm_state state)
+void pm_constraint_release(enum pm_state state)
 {
 	atomic_val_t v;
 
@@ -43,7 +43,7 @@ void pm_ctrl_enable_state(enum pm_state state)
 	(void)(v);
 }
 
-bool pm_ctrl_is_state_enabled(enum pm_state state)
+bool pm_constraint_get(enum pm_state state)
 {
 	__ASSERT(state < PM_STATES_LEN, "Invalid power state!");