mgmt: hawkbit: add hawkbit_autohandler_wait

Add hawkbit_autohandler_wait() to be able
to wait for the autohandler to finish.

Signed-off-by: Fin Maaß <[email protected]>

Author: maass-hamburg

include/zephyr/mgmt/hawkbit.h

@@ -26,6 +26,7 @@
  *
  */
 enum hawkbit_response {
+	HAWKBIT_NO_RESPONSE,
 	HAWKBIT_NETWORKING_ERROR,
 	HAWKBIT_UNCONFIRMED_IMAGE,
 	HAWKBIT_PERMISSION_ERROR,
@@ -97,6 +98,30 @@ int hawkbit_init(void);
  */
 void hawkbit_autohandler(bool auto_reschedule);
 
+/**
+ * @brief Wait for the autohandler to finish.
+ *
+ * @param events Set of desired events on which to wait. Set to ::UINT32_MAX to wait for the
+ *               autohandler to finish one run, or BIT() together with a value from
+ *               ::hawkbit_response to wait for a specific event.
+ * @param timeout Waiting period for the desired set of events or one of the
+ *                special values ::K_NO_WAIT and ::K_FOREVER.
+ *
+ * @retval HAWKBIT_OK if success.
+ * @retval HAWKBIT_NO_RESPONSE if matching events were not received within the specified time
+ * @retval HAWKBIT_NETWORKING_ERROR fail to connect to the hawkBit server.
+ * @retval HAWKBIT_UNCONFIRMED_IMAGE image is unconfirmed.
+ * @retval HAWKBIT_PERMISSION_ERROR fail to get the permission to access the hawkBit server.
+ * @retval HAWKBIT_METADATA_ERROR fail to parse or to encode the metadata.
+ * @retval HAWKBIT_DOWNLOAD_ERROR fail while downloading the update package.
+ * @retval HAWKBIT_UPDATE_INSTALLED if an update was installed. Reboot is required to apply it.
+ * @retval HAWKBIT_NO_UPDATE if no update was available.
+ * @retval HAWKBIT_CANCEL_UPDATE update was cancelled.
+ * @retval HAWKBIT_NOT_INITIALIZED if hawkBit is not initialized.
+ * @retval HAWKBIT_PROBE_IN_PROGRESS if probe is currently running.
+ */
+enum hawkbit_response hawkbit_autohandler_wait(uint32_t events, k_timeout_t timeout);
+
 /**
  * @brief The hawkBit probe verify if there is some update to be performed.
  *

subsys/mgmt/hawkbit/Kconfig

@@ -15,6 +15,7 @@ menuconfig HAWKBIT
 	depends on DNS_RESOLVER
 	depends on JSON_LIBRARY
 	depends on BOOTLOADER_MCUBOOT
+	select EVENTS
 	select MPU_ALLOW_FLASH_WRITE
 	select IMG_ENABLE_IMAGE_CHECK
 	select IMG_ERASE_PROGRESSIVELY

subsys/mgmt/hawkbit/hawkbit.c

@@ -150,6 +150,8 @@ static void autohandler(struct k_work *work);
 static K_WORK_DELAYABLE_DEFINE(hawkbit_work_handle, autohandler);
 static K_WORK_DELAYABLE_DEFINE(hawkbit_work_handle_once, autohandler);
 
+static K_EVENT_DEFINE(hawkbit_autohandler_event);
+
 K_SEM_DEFINE(probe_sem, 1, 1);
 
 static const struct json_obj_descr json_href_descr[] = {
@@ -1476,7 +1478,13 @@ enum hawkbit_response hawkbit_probe(void)
 
 static void autohandler(struct k_work *work)
 {
-	switch (hawkbit_probe()) {
+	k_event_clear(&hawkbit_autohandler_event, UINT32_MAX);
+
+	enum hawkbit_response response = hawkbit_probe();
+
+	k_event_set(&hawkbit_autohandler_event, BIT(response));
+
+	switch (response) {
 	case HAWKBIT_UNCONFIRMED_IMAGE:
 		LOG_ERR("Current image is not confirmed");
 		LOG_ERR("Rebooting to previous confirmed image");
@@ -1525,12 +1533,27 @@ static void autohandler(struct k_work *work)
 	case HAWKBIT_PROBE_IN_PROGRESS:
 		LOG_INF("hawkBit is already running");
 		break;
+
+	default:
+		LOG_ERR("Invalid response: %d", response);
+		break;
 	}
 
 	if (k_work_delayable_from_work(work) == &hawkbit_work_handle) {
 		k_work_reschedule(&hawkbit_work_handle, K_SECONDS(poll_sleep));
 	}
 }
+
+enum hawkbit_response hawkbit_autohandler_wait(uint32_t events, k_timeout_t timeout)
+{
+	uint32_t ret = k_event_wait(&hawkbit_autohandler_event, events, false, timeout);
+
+	for (int i = 1; i < HAWKBIT_PROBE_IN_PROGRESS; i++) {
+		if (ret & BIT(i)) {
+			return i;
+		}
+	}
+	return HAWKBIT_NO_RESPONSE;
 }
 
 void hawkbit_autohandler(bool auto_reschedule)