jesus/tinyusb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doxygen document

Browse Source
This commit is contained in:
hathach
2014-03-16 22:20:33 +07:00
parent 18d577abfb
commit d1d4ddd856
25 changed files with 243 additions and 12648 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tinyusb/class/custom_class.h
+4 -4
View File
@@ -36,10 +36,9 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
/** \addtogroup ClassDriver Class Driver
* @{
* \defgroup Group_Custom Custom Class (not supported yet)
* @{
*/
@@ -89,3 +88,4 @@ void cush_close(uint8_t dev_addr);
#endif /* _TUSB_CUSTOM_CLASS_H_ */
/** @} */
/** @} */
tinyusb/class/hid_host.h
+1 -1
View File
@@ -185,7 +185,7 @@ void tusbh_hid_mouse_unmounted_cb(uint8_t dev_addr);
//--------------------------------------------------------------------+
// GENERIC Application API
//--------------------------------------------------------------------+
/** \addtogroup ClassDriver_HID_Generic Generic
/** \addtogroup ClassDriver_HID_Generic Generic (not supported yet)
* @{ */
/** \defgroup Generic_Host Host
tinyusb/class/msc.h
+1 -2
View File
@@ -36,8 +36,7 @@
*/
/**************************************************************************/
/**
* \addtogroup ClassDriver Class Driver
/** \addtogroup ClassDriver Class Driver
* @{
* \defgroup ClassDriver_MSC MassStorage (MSC)
* @{ */
tinyusb/common/binary.h
+6 -6
View File
@@ -36,12 +36,11 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
/** \addtogroup Group_Common Common Files
* @{
* \defgroup Group_Binary binary.h
* @{ */
#ifndef _TUSB_BINARY_H_
#define _TUSB_BINARY_H_
@@ -132,3 +131,4 @@ static inline uint32_t bit_set_range(uint32_t value, uint8_t start, uint8_t end,
#endif /* _TUSB_BINARY_H_ */
/** @} */
/** @} */
tinyusb/common/common.h
+2 -5
View File
@@ -36,13 +36,10 @@
*/
/**************************************************************************/
/** \defgroup Group_Common Common Files
/** \addtogroup Group_Common Common Files
* @{
*
* \defgroup Group_CommonH common.h
*
* @{
*/
* @{ */
#ifndef _TUSB_COMMON_H_
#define _TUSB_COMMON_H_
tinyusb/common/timeout_timer.h
+6 -11
View File
@@ -36,18 +36,11 @@
*/
/**************************************************************************/
/** \file
* \brief TBD
*
* \note TBD
*/
/** \addtogroup Group_Common Common Files
* @{
* \defgroup Group_TimeoutTimer timeout timer
* @{ */
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
#ifndef _TUSB_TIMEOUT_TTIMER_H_
#define _TUSB_TIMEOUT_TTIMER_H_
@@ -83,3 +76,5 @@ static inline bool timeout_expired(timeout_timer_t* tt)
#endif /* _TUSB_TIMEOUT_TTIMER_H_ */
/** @} */
/** @} */
tinyusb/device/dcd.h
+3 -6
View File
@@ -36,11 +36,9 @@
*/
/**************************************************************************/
/** \addtogroup Port Port
* @{
* \defgroup Port_DCD Device Controller Driver (DCD)
* @{
*/
/** \ingroup Group_USBD
* \defgroup Group_DCD Device Controller Driver (DCD)
* @{ */
#ifndef _TUSB_DCD_H_
#define _TUSB_DCD_H_
@@ -100,4 +98,3 @@ tusb_error_t dcd_pipe_clear_stall(uint8_t coreid, uint8_t edpt_addr);
#endif /* _TUSB_DCD_H_ */
/// @}
/// @}
tinyusb/device/dcd_lpc175x_6x.h
+1 -1
View File
@@ -36,7 +36,7 @@
*/
/**************************************************************************/
/** \ingroup Port_DCD
/** \ingroup Group_DCD
* @{
* \defgroup LPC175x_6x
* @{
tinyusb/device/usbd.h
+2 -5
View File
@@ -36,12 +36,9 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
/** \defgroup Group_USBD USB Device Driver (USBD)
* \brief TBD
*
* @{
*/
* @{ */
#ifndef _TUSB_USBD_H_
#define _TUSB_USBD_H_
tinyusb/hal/hal.h
+3 -5
View File
@@ -39,15 +39,14 @@
#ifndef _TUSB_HAL_H_
#define _TUSB_HAL_H_
/** \addtogroup Port Port
* @{
/** \ingroup Group_USBD
* \ingroup Group_USBH
* \defgroup Port_Hal Hardware Abtract Layer (HAL)
* Hardware Abstraction Layer (HAL) is an abstraction layer, between the physical hardware and the tinyusb stack.
* Its function is to hide differences in hardware from most of MCUs, so that most of the stack code does not need to be changed to
* run on systems with a different MCU.
* HAL are sets of routines that emulate some platform-specific details, giving programs direct access to the hardware resources.
* @{
*/
* @{ */
//--------------------------------------------------------------------+
// INCLUDES
@@ -134,4 +133,3 @@ static inline void hal_debugger_breakpoint(void)
#endif /* _TUSB_HAL_H_ */
/** @} */
/** @} */
tinyusb/host/ehci/ehci.h
+1 -1
View File
@@ -36,7 +36,7 @@
*/
/**************************************************************************/
/** \ingroup Port_HCD
/** \ingroup Group_HCD
* @{
* \defgroup EHCI
* \brief EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise
tinyusb/host/hcd.h
+4 -7
View File
@@ -36,11 +36,9 @@
*/
/**************************************************************************/
/** \addtogroup Port Port
* @{
* \defgroup Port_HCD Host Controller Driver (HCD)
* @{
*/
/** \ingroup Group_USBH
* \defgroup Group_HCD Host Controller Driver (HCD)
* @{ */
#ifndef _TUSB_HCD_H_
#define _TUSB_HCD_H_
@@ -116,7 +114,6 @@ void hcd_port_unplug(uint8_t hostid); // called by usbh to instruct hcd that it
}
#endif
#endif /* _TUSB_HCD_H_ */
#endif /* _TUSB_HCD_H_ */
/// @}
/// @}
tinyusb/host/hub.h
+1 -1
View File
@@ -38,7 +38,7 @@
/** \addtogroup ClassDriver
* @{
* \defgroup ClassDriver_Hub Hub (Host)
* \defgroup ClassDriver_Hub Hub (Host only)
* \details Like most PC's OS, Hub support is completely hidden from Application. In fact, application cannot determine whether
* a device is mounted directly via roothub or via a hub's port. All Hub-related procedures are performed and managed
* by tinyusb stack. Unless you are trying to develop the stack itself, there are nothing else can be used by Application.
tinyusb/host/ohci/ohci.h
+2 -3
View File
@@ -36,12 +36,11 @@
*/
/**************************************************************************/
/** \ingroup Port_HCD
/** \ingroup Group_HCD
* @{
* \defgroup OHCI
* \brief OHCI driver. All documents sources mentioned here (eg section 3.5) is referring to OHCI Specs unless state otherwise
* @{
*/
* @{ */
#ifndef _TUSB_OHCI_H_
#define _TUSB_OHCI_H_
tinyusb/host/usbh.h
+2 -5
View File
@@ -36,12 +36,9 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
/** \defgroup Group_USBH USB Host Driver (USBH)
* \brief TBD
*
* @{
*/
* @{ */
#ifndef _TUSB_USBD_HOST_H_
#define _TUSB_USBD_HOST_H_
tinyusb/host/usbh_hcd.h
+3 -10
View File
@@ -36,18 +36,11 @@
*/
/**************************************************************************/
/** \file
* \brief TBD
*
* \note TBD
*/
/** \ingroup TBD
/** \ingroup Group_HCD
* @{
* \defgroup TBD
* \brief TBD
*
* @{
*/
* @{ */
#ifndef _TUSB_USBH_HCD_H_
#define _TUSB_USBH_HCD_H_
tinyusb/osal/osal.h
+5 -8
View File
@@ -51,12 +51,8 @@
/** @} */
/** \addtogroup Port Port
* @{
* \defgroup Port_OSAL OS Abstraction Layer (OSAL)
* @{
*/
/** \defgroup Group_OSAL OS Abstraction Layer (OSAL)
* @{ */
#ifdef __cplusplus
extern "C" {
@@ -68,6 +64,7 @@
#if TUSB_CFG_OS == TUSB_OS_NONE
#include "osal_none.h"
#else
#define OSAL_VAR
#define OSAL_TASK_FUNCTION(task_func) void task_func
@@ -111,7 +108,8 @@
#endif
#endif
#else // OSAL API for cmock
//------------- OSAL API for cmock -------------//
#else
#define OSAL_VAR
#include "osal_common.h"
@@ -231,7 +229,6 @@ uint32_t osal_tick_get(void);
}
#endif
/** @} */
/** @} */
#endif /* _TUSB_OSAL_H_ */
tinyusb/osal/osal_cmsis_rtx.h
+4 -5
View File
@@ -36,12 +36,10 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
/** \ingroup Group_OSAL
* @{
*/
* \defgroup Group_CMSISRTX CMSIS-RTOS RTX
* @{ */
#ifndef _TUSB_OSAL_CMSIS_RTX_H_
#define _TUSB_OSAL_CMSIS_RTX_H_
@@ -211,3 +209,4 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl)
#endif /* _TUSB_OSAL_CMSIS_RTX_H_ */
/** @} */
/** @} */
tinyusb/osal/osal_freeRTOS.h
+6 -6
View File
@@ -36,12 +36,10 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
/** \ingroup Group_OSAL
* @{
* \defgroup Group_FreeRTOS FreeRTOS
* @{ */
#ifndef _TUSB_OSAL_FREERTOS_H_
#define _TUSB_OSAL_FREERTOS_H_
@@ -201,3 +199,5 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl)
#endif /* _TUSB_OSAL_FREERTOS_H_ */
/** @} */
/** @} */
tinyusb/osal/osal_none.h
+5 -6
View File
@@ -36,12 +36,10 @@
*/
/**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
/** \addtogroup Group_OSAL
* @{
* \defgroup Group_OSNone None OS
* @{ */
#ifndef _TUSB_OSAL_NONE_H_
#define _TUSB_OSAL_NONE_H_
@@ -337,3 +335,4 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl)
#endif /* _TUSB_OSAL_NONE_H_ */
/** @} */
/** @} */