usb: host: wrap the mutex lock with a helper

Hide the mutex lock details inside a wrapper call, like done for the
device stack API. This is not used for the per-device lock of the host
stack which use a different mutex lock.

Signed-off-by: Josuah Demangeon <[email protected]>

Author: Josuah Demangeon

subsys/usb/host/usbh_api.c

@@ -6,6 +6,7 @@
 
 #include <errno.h>
 #include <zephyr/sys/util.h>
+#include "usbh_host.h"
 #include "usbh_internal.h"
 
 #include <zephyr/logging/log.h>
@@ -15,7 +16,7 @@ int usbh_init(struct usbh_context *uhs_ctx)
 {
 	int ret;
 
-	k_mutex_lock(&uhs_ctx->mutex, K_FOREVER);
+	usbh_host_lock(uhs_ctx);
 
 	if (!device_is_ready(uhs_ctx->dev)) {
 		LOG_ERR("USB host controller is not ready");
@@ -32,15 +33,15 @@ int usbh_init(struct usbh_context *uhs_ctx)
 	ret = usbh_init_device_intl(uhs_ctx);
 
 init_exit:
-	k_mutex_unlock(&uhs_ctx->mutex);
+	usbh_host_unlock(uhs_ctx);
 	return ret;
 }
 
 int usbh_enable(struct usbh_context *uhs_ctx)
 {
 	int ret;
 
-	k_mutex_lock(&uhs_ctx->mutex, K_FOREVER);
+	usbh_host_lock(uhs_ctx);
 
 	if (!uhc_is_initialized(uhs_ctx->dev)) {
 		LOG_WRN("USB host controller is not initialized");
@@ -61,7 +62,7 @@ int usbh_enable(struct usbh_context *uhs_ctx)
 	}
 
 enable_exit:
-	k_mutex_unlock(&uhs_ctx->mutex);
+	usbh_host_unlock(uhs_ctx);
 	return ret;
 }
 
@@ -74,14 +75,14 @@ int usbh_disable(struct usbh_context *uhs_ctx)
 		return 0;
 	}
 
-	k_mutex_lock(&uhs_ctx->mutex, K_FOREVER);
+	usbh_host_lock(uhs_ctx);
 
 	ret = uhc_disable(uhs_ctx->dev);
 	if (ret) {
 		LOG_ERR("Failed to disable USB controller");
 	}
 
-	k_mutex_unlock(&uhs_ctx->mutex);
+	usbh_host_unlock(uhs_ctx);
 
 	return 0;
 }
@@ -90,14 +91,14 @@ int usbh_shutdown(struct usbh_context *const uhs_ctx)
 {
 	int ret;
 
-	k_mutex_lock(&uhs_ctx->mutex, K_FOREVER);
+	usbh_host_lock(uhs_ctx);
 
 	ret = uhc_shutdown(uhs_ctx->dev);
 	if (ret) {
 		LOG_ERR("Failed to shutdown USB device");
 	}
 
-	k_mutex_unlock(&uhs_ctx->mutex);
+	usbh_host_unlock(uhs_ctx);
 
 	return ret;
 }

subsys/usb/host/usbh_host.h

@@ -34,4 +34,24 @@ static inline bool usbd_is_initialized(const struct usbh_context *const uhs_ctx)
 	return uhs_ctx->status.initialized;
 }
 
+/**
+ * @brief Lock the USB host stack context
+ *
+ * @param[in] uhs_ctx Pointer to a host context
+ */
+static inline void usbh_host_lock(struct usbh_context *const uhs_ctx)
+{
+	k_mutex_lock(&uhs_ctx->mutex, K_FOREVER);
+}
+
+/**
+ * @brief Unlock the USB host stack context
+ *
+ * @param[in] uhs_ctx Pointer to a host context
+ */
+static inline void usbh_host_unlock(struct usbh_context *const uhs_ctx)
+{
+	k_mutex_unlock(&uhs_ctx->mutex);
+}
+
 #endif /* ZEPHYR_INCLUDE_USBH_HOST_H */