From 4f3a3905c9c75c483fd72e173bd904f566dd4472 Mon Sep 17 00:00:00 2001 From: Amir Hammad Date: Fri, 8 Jul 2016 23:53:42 +0200 Subject: rename usbh_hubbed.* to usbh_core.* Signed-off-by: Amir Hammad --- include/driver/usbh_device_driver.h | 2 +- include/usbh_core.h | 120 ++++++++++++++++++++++++++++++++++++ include/usbh_driver_ac_midi.h | 2 +- include/usbh_driver_gp_xbox.h | 2 +- include/usbh_driver_hid_mouse.h | 2 +- include/usbh_driver_hub.h | 2 +- include/usbh_hubbed.h | 120 ------------------------------------ include/usbh_lld_stm32f4.h | 2 +- 8 files changed, 126 insertions(+), 126 deletions(-) create mode 100644 include/usbh_core.h delete mode 100644 include/usbh_hubbed.h (limited to 'include') diff --git a/include/driver/usbh_device_driver.h b/include/driver/usbh_device_driver.h index 4f0ecea..2c67129 100644 --- a/include/driver/usbh_device_driver.h +++ b/include/driver/usbh_device_driver.h @@ -24,7 +24,7 @@ #define USBH_DEVICE_DRIVER_ #include "usbh_config.h" -#include "usbh_hubbed.h" +#include "usbh_core.h" #include diff --git a/include/usbh_core.h b/include/usbh_core.h new file mode 100644 index 0000000..2315778 --- /dev/null +++ b/include/usbh_core.h @@ -0,0 +1,120 @@ +/* + * This file is part of the libusbhost library + * hosted at http://github.com/libusbhost/libusbhost + * + * Copyright (C) 2015 Amir Hammad + * + * + * libusbhost is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + * + */ + +#ifndef USBH_CORE_ +#define USBH_CORE_ + +#include "usbh_config.h" + +#include +#include + +/* This must be placed around external function declaration for C++ + * support. */ +#ifdef __cplusplus +# define BEGIN_DECLS extern "C" { +# define END_DECLS } +#else +# define BEGIN_DECLS +# define END_DECLS +#endif + +BEGIN_DECLS + +/// 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)(void *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 (@see usbh_poll()) + * @param[in/out] drvdata is the device driver's private data + * @param[in] time_curr_us current timestamp in microseconds + */ + 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; + +/** + * @brief usbh_init + * @param low_level_drivers list of the low level drivers to be used by this library + * @param device_drivers list of the device drivers that could be used with attached devices + */ +void usbh_init(const void *low_level_drivers[], const usbh_dev_driver_t * const device_drivers[]); + +/** + * @brief usbh_poll + * @param time_curr_us - use monotically rising time + * + * time_curr_us: + * * can overflow, in time of this writing, after 1s + * * unit is microseconds + */ +void usbh_poll(uint32_t time_curr_us); + +END_DECLS + +#endif // USBH_CORE_ diff --git a/include/usbh_driver_ac_midi.h b/include/usbh_driver_ac_midi.h index 0993589..c692a64 100644 --- a/include/usbh_driver_ac_midi.h +++ b/include/usbh_driver_ac_midi.h @@ -23,7 +23,7 @@ #ifndef USBH_DRIVER_AC_MIDI_ #define USBH_DRIVER_AC_MIDI_ -#include "usbh_hubbed.h" +#include "usbh_core.h" #include diff --git a/include/usbh_driver_gp_xbox.h b/include/usbh_driver_gp_xbox.h index 90d0ca1..32aed8a 100644 --- a/include/usbh_driver_gp_xbox.h +++ b/include/usbh_driver_gp_xbox.h @@ -23,7 +23,7 @@ #ifndef USBH_DRIVER_GP_XBOX_ #define USBH_DRIVER_GP_XBOX_ -#include "usbh_hubbed.h" +#include "usbh_core.h" #include diff --git a/include/usbh_driver_hid_mouse.h b/include/usbh_driver_hid_mouse.h index de7707c..b60046a 100644 --- a/include/usbh_driver_hid_mouse.h +++ b/include/usbh_driver_hid_mouse.h @@ -23,7 +23,7 @@ #ifndef USBH_DRIVER_HID_MOUSE_ #define USBH_DRIVER_HID_MOUSE_ -#include "usbh_hubbed.h" +#include "usbh_core.h" #include diff --git a/include/usbh_driver_hub.h b/include/usbh_driver_hub.h index 8555f79..1066074 100644 --- a/include/usbh_driver_hub.h +++ b/include/usbh_driver_hub.h @@ -23,7 +23,7 @@ #ifndef USBH_DRIVER_HUB_ #define USBH_DRIVER_HUB_ -#include "usbh_hubbed.h" +#include "usbh_core.h" BEGIN_DECLS diff --git a/include/usbh_hubbed.h b/include/usbh_hubbed.h deleted file mode 100644 index ca4a489..0000000 --- a/include/usbh_hubbed.h +++ /dev/null @@ -1,120 +0,0 @@ -/* - * This file is part of the libusbhost library - * hosted at http://github.com/libusbhost/libusbhost - * - * Copyright (C) 2015 Amir Hammad - * - * - * libusbhost is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library. If not, see . - * - */ - -#ifndef USBH_HUBBED_ -#define USBH_HUBBED_ - -#include "usbh_config.h" - -#include -#include - -/* This must be placed around external function declaration for C++ - * support. */ -#ifdef __cplusplus -# define BEGIN_DECLS extern "C" { -# define END_DECLS } -#else -# define BEGIN_DECLS -# define END_DECLS -#endif - -BEGIN_DECLS - -/// 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)(void *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 (@see usbh_poll()) - * @param[in/out] drvdata is the device driver's private data - * @param[in] time_curr_us current timestamp in microseconds - */ - 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; - -/** - * @brief usbh_init - * @param low_level_drivers list of the low level drivers to be used by this library - * @param device_drivers list of the device drivers that could be used with attached devices - */ -void usbh_init(const void *low_level_drivers[], const usbh_dev_driver_t * const device_drivers[]); - -/** - * @brief usbh_poll - * @param time_curr_us - use monotically rising time - * - * time_curr_us: - * * can overflow, in time of this writing, after 1s - * * unit is microseconds - */ -void usbh_poll(uint32_t time_curr_us); - -END_DECLS - -#endif diff --git a/include/usbh_lld_stm32f4.h b/include/usbh_lld_stm32f4.h index a8f7b0a..ead40cd 100644 --- a/include/usbh_lld_stm32f4.h +++ b/include/usbh_lld_stm32f4.h @@ -23,7 +23,7 @@ #ifndef USBH_LLD_STM32F4_H_ #define USBH_LLD_STM32F4_H_ -#include "usbh_hubbed.h" +#include "usbh_core.h" #include -- cgit