use forward declaration for usbh_dev_driver_t

Signed-off-by: Amir Hammad <amir.hammad@hotmail.com>

1 files changed, 64 insertions, 0 deletions

diff --git a/include/driver/usbh_device_driver.h b/include/driver/usbh_device_driver.h
index 03bbd3a..20ece5d 100644
--- a/include/driver/usbh_device_driver.h
+++ b/include/driver/usbh_device_driver.h
@@ -110,6 +110,10 @@ struct _usbh_control {
 };
 typedef struct _usbh_control usbh_control_t;
 
+
+//forward declare usbh_dev_driver_t
+typedef struct _usbh_dev_driver usbh_dev_driver_t;
+
 /**
  * @brief The _usbh_device struct
  *
@@ -243,6 +247,66 @@ struct _usbh_generic_data {
 typedef struct _usbh_generic_data usbh_generic_data_t;
 
 
+/// set to -1 for unused items ("don't care" functionality) @see find_driver()
+struct _usbh_dev_driver_info {
+	int32_t deviceClass;
+	int32_t deviceSubClass;
+	int32_t deviceProtocol;
+	int32_t idVendor;
+	int32_t idProduct;
+	int32_t ifaceClass;
+	int32_t ifaceSubClass;
+	int32_t ifaceProtocol;
+};
+typedef struct _usbh_dev_driver_info usbh_dev_driver_info_t;
+
+struct _usbh_dev_driver {
+	/**
+	 * @brief init is initialization routine of the device driver
+	 *
+	 * This function is called during the initialization of the device driver
+	 */
+	void *(*init)(usbh_device_t *usbh_dev);
+
+	/**
+	 * @brief analyze descriptor
+	 * @param[in/out] drvdata is the device driver's private data
+	 * @param[in] descriptor is the pointer to the descriptor that should
+	 *		be parsed in order to prepare driver to be loaded
+	 *
+	 * @retval true when the enumeration is complete and the driver is ready to be used
+	 * @retval false when the device driver is not ready to be used
+	 *
+	 * This should be used for getting correct endpoint numbers, getting maximum sizes of endpoints.
+	 * Should return true, when no more data is needed.
+	 *
+	 */
+	bool (*analyze_descriptor)(void *drvdata, void *descriptor);
+
+	/**
+	 * @brief poll method is called periodically by the library core
+	 * @param[in/out] drvdata is the device driver's private data
+	 * @param[in] time_curr_us current timestamp in microseconds
+	 * @see usbh_poll()
+	 */
+	void (*poll)(void *drvdata, uint32_t time_curr_us);
+
+	/**
+	 * @brief unloads the device driver
+	 * @param[in/out] drvdata is the device driver's private data
+	 *
+	 * This should free any data associated with this device
+	 */
+	void (*remove)(void *drvdata);
+
+	/**
+	 * @brief info - compatibility information about the driver. It is used by the core during device enumeration
+	 * @see find_driver()
+	 */
+	const usbh_dev_driver_info_t * const info;
+};
+typedef struct _usbh_dev_driver usbh_dev_driver_t;
+
 #define ERROR(arg) LOG_PRINTF("UNHANDLED_ERROR %d: file: %s, line: %d",\
 							arg, __FILE__, __LINE__)