andy/tinyUSB
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doxygening

Browse Source
This commit is contained in:
hathach
2014-03-17 16:46:11 +07:00
parent d1d4ddd856
commit eaf2e888ab
9 changed files with 98 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tinyusb/class/cdc.h
View File

@@ -36,9 +36,7 @@
*/
/**************************************************************************/
/**
* \addtogroup ClassDriver Class Driver
* @{
/** \ingroup ClassDriver Class Driver
* \defgroup ClassDriver_CDC Communication Device Class (CDC)
* Currently only Abstract Control Model subclass is supported
* @{
@@ -396,4 +394,3 @@ STATIC_ASSERT(sizeof(cdc_line_control_state_t) == 2, "size is not correct");
#endif
/** @} */
/** @} */

26
tinyusb/class/cdc_host.h
View File

@@ -48,16 +48,14 @@
extern "C" {
#endif
/** \addtogroup ClassDriver_CDC Communication Device Class (CDC)
* @{ */
//--------------------------------------------------------------------+
// APPLICATION PUBLIC API
// CDC APPLICATION PUBLIC API
//--------------------------------------------------------------------+
/** \addtogroup CDC_Serial Serial
* @{
* \defgroup CDC_Serial_Host Host
* @{ */
/** \ingroup ClassDriver_CDC Communication Device Class (CDC)
* \addtogroup CDC_Serial Serial
* @{
* \defgroup CDC_Serial_Host Host
* @{ */
/** \brief Check if device support CDC Serial interface or not
* \param[in] dev_addr device address
@@ -131,15 +129,14 @@ void tusbh_cdc_unmounted_cb(uint8_t dev_addr);
*/
void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
/// @}
/// @} // group CDC_Serial_Host
/// @}
//--------------------------------------------------------------------+
// RNDIS APPLICATION API
//--------------------------------------------------------------------+
/** \addtogroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)
* @{
* \addtogroup CDC_RNSID_Host Host
/** \ingroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)
* \defgroup CDC_RNSID_Host Host
* @{ */
bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
@@ -162,8 +159,7 @@ void tusbh_cdc_rndis_unmounted_cb(uint8_t dev_addr);
void tusbh_cdc_rndis_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
/// @}
/// @}
/// @} // group CDC_RNSID_Host
//--------------------------------------------------------------------+
// USBH-CLASS API
@@ -194,5 +190,3 @@ void cdch_close(uint8_t dev_addr);
#endif
#endif /* _TUSB_CDC_HOST_H_ */
/** @} */

6
tinyusb/class/cdc_rndis.h
View File

@@ -36,11 +36,11 @@
*/
/**************************************************************************/
/** \addtogroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)
/** \ingroup ClassDriver_CDC Communication Device Class (CDC)
* \defgroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)
* @{
* \defgroup CDC_RNDIS_Common Common Definitions
* @{
*/
* @{ */
#ifndef _TUSB_CDC_RNDIS_H_
#define _TUSB_CDC_RNDIS_H_

50
tinyusb/doxygen/configuration.h
View File

@@ -1,29 +1,45 @@
/** \addtogroup group_configuration
* @{ */
/**
USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables
//--------------------------------------------------------------------+
// COMMON CONFIGURATION
//--------------------------------------------------------------------+
/// \brief tell the stack which mode (host/device/otg) the usb controller0 will be operated on. Possible value is
/// from \ref TUSB_MODE. Note the hardware usb controller must support the selected mode.
#define TUSB_CFG_CONTROLLER_0_MODE
/** USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables
into the USB RAM section as follows. if your mcu's usb controller has no such limit, define TUSB_CFG_ATTR_USBRAM as empty macro.
@code
TUSB_CFG_ATTR_USBRAM uint8_t tinyusb_data[10];
TUSB_CFG_ATTR_USBRAM uint8_t usb_xfer_buffer[10];
@endcode
*/
#define TUSB_CFG_ATTR_USBRAM
#define TUSB_CFG_MCU ///< Select one of the supported MCU, the value must be from \ref config_mcu_selection
#define TUSB_CFG_OS ///< Select one of the supported RTOS, the value must be from \ref TUSB_OS RTOS.
#define TUSB_CFG_OS_TASK_PRIO ///< If \ref TUSB_CFG_OS is configured to use a real RTOS (other than TUSB_OS_NONE). This determines the priority of the usb stack task.
/** \defgroup TUSB_CFG_HOST Host
//--------------------------------------------------------------------+
// HOST CONFIGURATION
//--------------------------------------------------------------------+
/** \defgroup TUSB_CFG_HOST Host Options
* @{ */
/// Maximum number of device host stack can manage
/// - If hub class is not enabled, set this equal to number of controllers in host mode
/// - if hub class is enabled, make sure hub is also counted
/** \brief Maximum number of device host stack can manage
* \n If hub class is not enabled, set this equal to number of controllers in host mode
* \n If hub class is enabled, make sure hub is also counted */
#define TUSB_CFG_HOST_DEVICE_MAX
/// Buffer size used for getting device configuration descriptor. You may want to increase this from default
/// \brief Buffer size used for getting device configuration descriptor. You may want to increase this from default (256)
/// to support lengthy composite device especially with Audio or Video class
#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE
/** \defgroup config_host_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
#define TUSB_CFG_HOST_HUB ///< Enable Hub Class
#define TUSB_CFG_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard
#define TUSB_CFG_HOST_HID_MOUSE ///< Enable HID Class for Mouse
@@ -31,9 +47,27 @@
#define TUSB_CFG_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only)
#define TUSB_CFG_HOST_CDC ///< Enable Virtual Serial (Communication Device Class)
#define TUSB_CFG_HOST_CDC_RNDIS ///< Enable Remote Network Device (require TUSB_CFG_HOST_CDC to be enabled)
/** @} */
/** @} */ // group Host
//--------------------------------------------------------------------+
// DEVICE CONFIGURATION
//--------------------------------------------------------------------+
/** \defgroup TUSB_CFG_DEVICE Device Options
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
/** \defgroup config_device_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
#define TUSB_CFG_DEVICE_HID_KEYBOARD ///< Enable HID Class for Keyboard
#define TUSB_CFG_DEVICE_HID_MOUSE ///< Enable HID Class for Mouse
#define TUSB_CFG_DEVICE_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
#define TUSB_CFG_DEVICE_MSC ///< Enable Mass Storage Class (SCSI subclass only)
#define TUSB_CFG_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class)
/** @} */
/** @} */ // group Device
/** @} */

13
tinyusb/tusb_option.h
View File

@@ -48,7 +48,7 @@
#define TUSB_VERSION_NAME "alpha"
#define TUSB_VERSION XSTRING_(TUSB_VERSION_YEAR) "." XSTRING_(TUSB_VERSION_MONTH)
/** \defgroup MCU_ MCU Selection
/** \defgroup config_mcu_selection MCU Selection
* \brief TUSB_CFG_MCU must be defined to one of these
* @{ */
#define MCU_LPC13UXX 1 ///< NXP LPC13xx 12 bit ADC family with USB on-chip Rom Driver (not supported yet)
@@ -79,6 +79,14 @@
#define TUSB_MODE_NONE 0x00 ///< Disabled
/** @} */
#ifndef TUSB_CFG_CONTROLLER_0_MODE
#define TUSB_CFG_CONTROLLER_0_MODE TUSB_MODE_NONE
#endif
#ifndef TUSB_CFG_CONTROLLER_1_MODE
#define TUSB_CFG_CONTROLLER_1_MODE TUSB_MODE_NONE
#endif
#define CONTROLLER_HOST_NUMBER (\
((TUSB_CFG_CONTROLLER_0_MODE & TUSB_MODE_HOST) ? 1 : 0) + \
((TUSB_CFG_CONTROLLER_1_MODE & TUSB_MODE_HOST) ? 1 : 0))
@@ -123,9 +131,6 @@
#endif
#endif
/**
* Maximum number of supported USB's configuration (currently only support only 1)
*/
//#ifndef TUSB_CFG_CONFIGURATION_MAX
// #define TUSB_CFG_CONFIGURATION_MAX 1
// #warning TUSB_CFG_CONFIGURATION_MAX is not defined, default value is 1