Merge pull request #4 from amirhammad/core-refactor

Major rework

1 files changed, 117 insertions, 17 deletions

diff --git a/include/driver/usbh_device_driver.h b/include/driver/usbh_device_driver.h
index bace1ef..e846fd2 100644
--- a/include/driver/usbh_device_driver.h
+++ b/include/driver/usbh_device_driver.h
@@ -26,6 +26,7 @@
 #include "usbh_config.h"
 #include "usbh_core.h"
 
+#include <libopencm3/usb/usbstd.h>
 #include <stdint.h>
 
 BEGIN_DECLS
@@ -61,6 +62,54 @@ enum USBH_CONTROL_TYPE {
 	USBH_CONTROL_TYPE_DATA
 };
 
+enum USBH_ENUM_STATE {
+	USBH_ENUM_STATE_SET_ADDRESS,
+	USBH_ENUM_STATE_FIRST = USBH_ENUM_STATE_SET_ADDRESS,
+	USBH_ENUM_STATE_DEVICE_DT_READ_SETUP,
+	USBH_ENUM_STATE_DEVICE_DT_READ_COMPLETE,
+	USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_SETUP,
+	USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ,
+	USBH_ENUM_STATE_CONFIGURATION_DT_HEADER_READ_COMPLETE,
+	USBH_ENUM_STATE_CONFIGURATION_DT_READ_SETUP,
+	USBH_ENUM_STATE_CONFIGURATION_DT_READ,
+	USBH_ENUM_STATE_CONFIGURATION_DT_READ_COMPLETE,
+	USBH_ENUM_STATE_SET_CONFIGURATION_SETUP,
+	USBH_ENUM_STATE_SET_CONFIGURATION_COMPLETE,
+	USBH_ENUM_STATE_FIND_DRIVER,
+};
+
+enum USBH_CONTROL_STATE {
+	USBH_CONTROL_STATE_NONE,
+	USBH_CONTROL_STATE_SETUP,
+	USBH_CONTROL_STATE_DATA,
+	USBH_CONTROL_STATE_STATUS,
+};
+
+typedef struct _usbh_device usbh_device_t;
+
+struct _usbh_packet_callback_data {
+	/// status - it is used for reporting of the errors
+	enum USBH_PACKET_CALLBACK_STATUS status;
+
+	/// count of bytes that has been actually transferred
+	uint32_t transferred_length;
+};
+typedef struct _usbh_packet_callback_data usbh_packet_callback_data_t;
+
+typedef void (*usbh_packet_callback_t)(usbh_device_t *dev, usbh_packet_callback_data_t status);
+
+struct _usbh_control {
+	enum USBH_CONTROL_STATE state;
+	usbh_packet_callback_t callback;
+	union {
+		const void *out;
+		void *in;
+	} data;
+	uint16_t data_length;
+	struct usb_setup_data setup_data;
+};
+typedef struct _usbh_control usbh_control_t;
+
 /**
  * @brief The _usbh_device struct
  *
@@ -77,7 +126,8 @@ struct _usbh_device {
 	enum USBH_SPEED speed;
 
 	/// state used for enumeration purposes
-	uint8_t state;
+	enum USBH_ENUM_STATE state;
+	usbh_control_t control;
 
 	/// toggle bit
 	uint8_t toggle0;
@@ -99,20 +149,12 @@ struct _usbh_device {
 };
 typedef struct _usbh_device usbh_device_t;
 
-struct _usbh_packet_callback_data {
-	/// status - it is used for reporting of the errors
-	enum USBH_PACKET_CALLBACK_STATUS status;
-
-	/// count of bytes that has been actually transferred
-	uint32_t transferred_length;
-};
-typedef struct _usbh_packet_callback_data usbh_packet_callback_data_t;
-
-typedef void (*usbh_packet_callback_t)(usbh_device_t *dev, usbh_packet_callback_data_t status);
-
 struct _usbh_packet {
 	/// pointer to data
-	void *data;
+	union {
+		const void *out;
+		void *in;
+	} data;
 
 	/// length of the data (up to 1023)
 	uint16_t datalen;
@@ -201,6 +243,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__)
 
@@ -216,10 +318,8 @@ void usbh_read(usbh_device_t *dev, usbh_packet_t *packet);
 void usbh_write(usbh_device_t *dev, const usbh_packet_t *packet);
 
 /* Helper functions used by device drivers */
-void device_xfer_control_read(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev);
-void device_xfer_control_write_setup(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev);
-void device_xfer_control_write_data(void *data, uint16_t datalen, usbh_packet_callback_t callback, usbh_device_t *dev);
-
+void device_control(usbh_device_t *dev, usbh_packet_callback_t callback, const struct usb_setup_data *setup_data, void *data);
+void device_remove(usbh_device_t *dev);
 
 END_DECLS