drivers: uhc: add opaque pointer to store upper layer private data

Add an opaque pointer to store upper layer private data and initialize
it with the USB host context during controller initialization. Use the
pointer in event processing to get the correct context.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>

Author: jfischer-no

drivers/usb/uhc/uhc_common.c

@@ -288,7 +288,8 @@ int uhc_disable(const struct device *dev)
 	return ret;
 }
 
-int uhc_init(const struct device *dev, uhc_event_cb_t event_cb)
+int uhc_init(const struct device *dev,
+	     uhc_event_cb_t event_cb, const void *const event_ctx)
 {
 	const struct uhc_api *api = dev->api;
 	struct uhc_data *data = dev->data;
@@ -306,6 +307,7 @@ int uhc_init(const struct device *dev, uhc_event_cb_t event_cb)
 	}
 
 	data->event_cb = event_cb;
+	data->event_ctx = event_ctx;
 	sys_dlist_init(&data->ctrl_xfers);
 	sys_dlist_init(&data->bulk_xfers);
 

include/zephyr/drivers/usb/uhc.h

@@ -199,6 +199,8 @@ struct uhc_data {
 	sys_dlist_t bulk_xfers;
 	/** Callback to submit an UHC event to upper layer */
 	uhc_event_cb_t event_cb;
+	/** Opaque pointer to store higher layer context */
+	const void *event_ctx;
 	/** USB host controller status */
 	atomic_t status;
 	/** Driver private data */
@@ -477,12 +479,14 @@ int uhc_ep_dequeue(const struct device *dev, struct uhc_transfer *const xfer);
  *
  * @param[in] dev      Pointer to device struct of the driver instance
  * @param[in] event_cb Event callback from the higher layer (USB host stack)
+ * @param[in] event_ctx Opaque pointer to higher layer context
  *
  * @return 0 on success, all other values should be treated as error.
  * @retval -EINVAL on parameter error (no callback is passed)
  * @retval -EALREADY already initialized
  */
-int uhc_init(const struct device *dev, uhc_event_cb_t event_cb);
+int uhc_init(const struct device *dev,
+	     uhc_event_cb_t event_cb, const void *const event_ctx);
 
 /**
  * @brief Enable USB host controller
@@ -540,6 +544,23 @@ static inline struct uhc_device_caps uhc_caps(const struct device *dev)
 	return data->caps;
 }
 
+/**
+ * @brief Get pointer to higher layer context
+ *
+ * The address of the context is passed as an argument to the uhc_init()
+ * function and is stored in the uhc data.
+ *
+ * @param[in] dev Pointer to device struct of the driver instance
+ *
+ * @return Opaque pointer to higher layer context
+ */
+static inline const void *uhc_get_event_ctx(const struct device *dev)
+{
+	struct uhc_data *data = dev->data;
+
+	return data->event_ctx;
+}
+
 /**
  * @}
  */

subsys/usb/host/usbh_core.c

@@ -96,24 +96,22 @@ static void usbh_thread(void *p1, void *p2, void *p3)
 	ARG_UNUSED(p2);
 	ARG_UNUSED(p3);
 
+	struct usbh_contex *uhs_ctx;
 	struct uhc_event event;
 
 	while (true) {
 		k_msgq_get(&usbh_msgq, &event, K_FOREVER);
 
-		STRUCT_SECTION_FOREACH(usbh_contex, uhs_ctx) {
-			if (uhs_ctx->dev == event.dev) {
-				usbh_event_handler(uhs_ctx, &event);
-			}
-		}
+		uhs_ctx = (void *)uhc_get_event_ctx(event.dev);
+		usbh_event_handler(uhs_ctx, &event);
 	}
 }
 
 int usbh_init_device_intl(struct usbh_contex *const uhs_ctx)
 {
 	int ret;
 
-	ret = uhc_init(uhs_ctx->dev, usbh_event_carrier);
+	ret = uhc_init(uhs_ctx->dev, usbh_event_carrier, uhs_ctx);
 	if (ret != 0) {
 		LOG_ERR("Failed to init device driver");
 		return ret;