usb: host: introduce wrappers to access the class function pointers

Add API wrappers around the function pointers in struct usbh_class_api,
while also documenting the USB host class internal API.

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

Author: Josuah Demangeon

include/zephyr/usb/usbh.h

@@ -90,23 +90,18 @@ struct usbh_class_data;
  * @brief USB host class instance API
  */
 struct usbh_class_api {
-	/** Initialization of the class implementation */
-	int (*init)(struct usbh_class_data *const c_data);
+	/** Host init handler, before any device is connected */
+	int (*init)(struct usbh_class_data *const c_data,
+		    struct usbh_context *const uhs_ctx);
 	/** Request completion event handler */
-	int (*request)(struct usbh_class_data *const c_data,
-		       struct uhc_transfer *const xfer, int err);
-	/** Device connected handler */
-	int (*connected)(struct usbh_class_data *const c_data,
-			 void *const desc_start_addr,
-			 void *const desc_end_addr);
-	/** Device removed handler */
+	int (*completion_cb)(struct usbh_class_data *const c_data,
+			     struct uhc_transfer *const xfer);
+	/** Device connection handler */
+	int (*probe)(struct usbh_class_data *const c_data,
+		     struct usb_device *const udev,
+		     const uint8_t iface);
+	/** Device removal handler */
 	int (*removed)(struct usbh_class_data *const c_data);
-	/** Bus remote wakeup handler */
-	int (*rwup)(struct usbh_class_data *const c_data);
-	/** Bus suspended handler */
-	int (*suspended)(struct usbh_class_data *const c_data);
-	/** Bus resumed handler */
-	int (*resumed)(struct usbh_class_data *const c_data);
 };
 
 /**
@@ -117,8 +112,10 @@ struct usbh_class_data {
 	const char *name;
 	/** Pointer to USB host stack context structure */
 	struct usbh_context *uhs_ctx;
-	/** Class code supported by this instance */
-	struct usbh_code_triple code;
+	/** Pointer to USB device this class is used for */
+	struct usb_device *udev;
+	/** Interface number for which this class matched */
+	uint8_t iface;
 	/** Pointer to host support class API */
 	struct usbh_class_api *api;
 	/** Pointer to private data */

subsys/usb/host/usbh_class_api.h

@@ -0,0 +1,107 @@
+/*
+ * Copyright Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file
+ * @brief USB host stack class instances API
+ *
+ * This file contains the USB host stack class instances API.
+ */
+
+#ifndef ZEPHYR_INCLUDE_USBH_CLASS_API_H
+#define ZEPHYR_INCLUDE_USBH_CLASS_API_H
+
+#include <zephyr/usb/usbh.h>
+
+/**
+ * @brief Initialization of the class implementation
+ *
+ * This is called for each instance during the initialization phase,
+ * for every registered class.
+ * It can be used to initialize underlying systems.
+ *
+ * @param[in] c_data Pointer to USB host class data
+ * @param[in] uhs_ctx USB host context to assign to this class
+ * @return 0 on success, negative error code on failure.
+ */
+static inline int usbh_class_init(struct usbh_class_data *const c_data,
+				  struct usbh_context *const uhs_ctx)
+{
+	const struct usbh_class_api *api = c_data->api;
+
+	if (api->init != NULL) {
+		return api->init(c_data, uhs_ctx);
+	}
+
+	return -ENOTSUP;
+}
+
+/**
+ * @brief Request completion event handler
+ *
+ * Called upon completion of a request made by the host to this class.
+ *
+ * @param[in] c_data Pointer to USB host class data
+ * @param[in] xfer Completed transfer
+ * @return 0 on success, negative error code on failure.
+ */
+static inline int usbh_class_completion_cb(struct usbh_class_data *const c_data,
+					   struct uhc_transfer *const xfer)
+{
+	const struct usbh_class_api *api = c_data->api;
+
+	if (api->completion_cb != NULL) {
+		return api->completion_cb(c_data, xfer);
+	}
+
+	return -ENOTSUP;
+}
+
+/**
+ * @brief Device initialization handler
+ *
+ * Called when a device is connected to the bus for every device.
+ *
+ * @param[in] c_data Pointer to USB host class data
+ * @param[in] udev USB device connected
+ * @param[in] iface The @c bInterfaceNumber or @c bFirstInterface of this class
+ * @return 0 on success, negative error code on failure.
+ * @return -ENOTSUP if the class is not matching
+ */
+static inline int usbh_class_probe(struct usbh_class_data *const c_data,
+				   struct usb_device *const udev,
+				   const uint8_t iface)
+{
+	const struct usbh_class_api *api = c_data->api;
+
+	if (api->probe != NULL) {
+		return api->probe(c_data, udev, iface);
+	}
+
+	return -ENOTSUP;
+}
+
+/**
+ * @brief Device removed handler
+ *
+ * Called when the device is removed from the bus
+ * and it matches the class filters of this instance.
+ *
+ * @param[in] c_data Pointer to USB host class data
+ * @return 0 on success, negative error code on failure.
+ */
+static inline int usbh_class_removed(struct usbh_class_data *const c_data)
+{
+	const struct usbh_class_api *api = c_data->api;
+
+	if (api->removed != NULL) {
+		return api->removed(c_data);
+	}
+
+	return -ENOTSUP;
+}
+
+#endif /* ZEPHYR_INCLUDE_USBD_CLASS_API_H */