drivers: clock_control_nrf2_common: Add resetting of the on-off services

If an on-off service records an error while transitioning to the on
state, it stays in the error state and does not allow new requests
to be made until its state is reset. Add resetting of the services
associated with particular clock controllers so that requests can
be retried after failures.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>

Author: anangl

drivers/clock_control/clock_control_nrf2_common.c

@@ -81,6 +81,12 @@ static void onoff_stop_option(struct onoff_manager *mgr,
 	notify(mgr, 0);
 }
 
+static void onoff_reset_option(struct onoff_manager *mgr,
+			       onoff_notify_fn notify)
+{
+	notify(mgr, 0);
+}
+
 static inline uint8_t get_index_of_highest_bit(uint32_t value)
 {
 	return value ? (uint8_t)(31 - __builtin_clz(value)) : 0;
@@ -129,7 +135,8 @@ int clock_config_init(void *clk_cfg, uint8_t onoff_cnt, k_work_handler_t update_
 	for (int i = 0; i < onoff_cnt; ++i) {
 		static const struct onoff_transitions transitions = {
 			.start = onoff_start_option,
-			.stop  = onoff_stop_option
+			.stop  = onoff_stop_option,
+			.reset = onoff_reset_option,
 		};
 		int rc;
 
@@ -148,6 +155,22 @@ int clock_config_init(void *clk_cfg, uint8_t onoff_cnt, k_work_handler_t update_
 	return 0;
 }
 
+int clock_config_request(struct onoff_manager *mgr, struct onoff_client *cli)
+{
+	/* If the on-off service recorded earlier an error, its state must be
+	 * reset before a new request is made, otherwise the request would fail
+	 * immediately.
+	 */
+	if (onoff_has_error(mgr)) {
+		struct onoff_client reset_cli;
+
+		sys_notify_init_spinwait(&reset_cli.notify);
+		onoff_reset(mgr, &reset_cli);
+	}
+
+	return onoff_request(mgr, cli);
+}
+
 uint8_t clock_config_update_begin(struct k_work *work)
 {
 	struct clock_config_generic *cfg =

drivers/clock_control/clock_control_nrf2_common.h

@@ -59,6 +59,20 @@ int lfosc_get_accuracy(uint16_t *accuracy);
  */
 int clock_config_init(void *clk_cfg, uint8_t onoff_cnt, k_work_handler_t update_work_handler);
 
+/**
+ * @brief Helper function for requesting a clock configuration handled by
+ *        a given on-off manager.
+ *
+ * If needed, the function resets the on-off service prior to making the new
+ * request.
+ *
+ * @param mgr pointer to the manager for which the request is to be done.
+ * @param cli pointer to a client state structure to be used for the request.
+ *
+ * @return result returned by onoff_request().
+ */
+int clock_config_request(struct onoff_manager *mgr, struct onoff_client *cli);
+
 /**
  * @brief Starts a clock configuration update.
  *

drivers/clock_control/clock_control_nrf2_fll16m.c

@@ -178,7 +178,7 @@ static int api_request_fll16m(const struct device *dev,
 	struct onoff_manager *mgr = fll16m_find_mgr(dev, spec);
 
 	if (mgr) {
-		return onoff_request(mgr, cli);
+		return clock_config_request(mgr, cli);
 	}
 
 	return -EINVAL;

drivers/clock_control/clock_control_nrf2_global_hsfll.c

@@ -101,7 +101,7 @@ static int api_request_global_hsfll(const struct device *dev,
 	struct onoff_manager *mgr = global_hsfll_find_mgr(dev, spec);
 
 	if (mgr) {
-		return onoff_request(mgr, cli);
+		return clock_config_request(mgr, cli);
 	}
 
 	return -EINVAL;

drivers/clock_control/clock_control_nrf2_hsfll.c

@@ -140,7 +140,7 @@ static int api_request_hsfll(const struct device *dev,
 	struct onoff_manager *mgr = hsfll_find_mgr(dev, spec);
 
 	if (mgr) {
-		return onoff_request(mgr, cli);
+		return clock_config_request(mgr, cli);
 	}
 
 	return -EINVAL;

drivers/clock_control/clock_control_nrf2_lfclk.c

@@ -146,7 +146,7 @@ static int api_request_lfclk(const struct device *dev,
 	struct onoff_manager *mgr = lfclk_find_mgr(dev, spec);
 
 	if (mgr) {
-		return onoff_request(mgr, cli);
+		return clock_config_request(mgr, cli);
 	}
 
 	return -EINVAL;