more doxygen work
This commit is contained in:
hathach
parent
695fc5cc0a
commit
5f23653c69
|
|
@ -36,28 +36,21 @@
|
|||
*/
|
||||
/**************************************************************************/
|
||||
|
||||
/** \file
|
||||
* \brief Device Controller Driver
|
||||
*
|
||||
* \note TBD
|
||||
*/
|
||||
|
||||
/**
|
||||
* \defgroup Group_DCD Device Controller Driver
|
||||
* \brief Device Controller Driver
|
||||
*
|
||||
/** \addtogroup Port Port
|
||||
* @{
|
||||
* \defgroup Port_DCD Device Controller Driver (DCD)
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _TUSB_DCD_H_
|
||||
#define _TUSB_DCD_H_
|
||||
|
||||
#include "common/common.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include "common/common.h"
|
||||
|
||||
tusb_error_t dcd_init(void) ATTR_WARN_UNUSED_RESULT;
|
||||
tusb_error_t dcd_controller_reset(uint8_t coreid) ATTR_WARN_UNUSED_RESULT;
|
||||
void dcd_controller_connect(uint8_t coreid);
|
||||
|
|
@ -78,3 +71,4 @@ void dcd_device_set_configuration(uint8_t coreid, uint8_t config_num);
|
|||
#endif /* _TUSB_DCD_H_ */
|
||||
|
||||
/// @}
|
||||
/// @}
|
||||
|
|
|
|||
|
|
@ -36,22 +36,16 @@
|
|||
*/
|
||||
/**************************************************************************/
|
||||
|
||||
/** \file
|
||||
* \brief TBD
|
||||
*
|
||||
* \note TBD
|
||||
*/
|
||||
|
||||
/**
|
||||
* \defgroup Group_HAL Hardware Abtract Layer
|
||||
* \brief Hardware dependent layer
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _TUSB_HAL_H_
|
||||
#define _TUSB_HAL_H_
|
||||
|
||||
/** \addtogroup Port Port
|
||||
* @{
|
||||
* \defgroup Port_Hal Hardware Abtract Layer (HAL)
|
||||
* \brief Hardware Dependent Layer
|
||||
* @{
|
||||
*/
|
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// INCLUDES
|
||||
//--------------------------------------------------------------------+
|
||||
|
|
@ -124,3 +118,4 @@ static inline void hal_debugger_breakpoint(void)
|
|||
#endif /* _TUSB_HAL_H_ */
|
||||
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
|
|
|||
|
|
@ -36,13 +36,8 @@
|
|||
*/
|
||||
/**************************************************************************/
|
||||
|
||||
/** \file
|
||||
* \brief EHCI
|
||||
*
|
||||
* \note TBD
|
||||
*/
|
||||
|
||||
/** \ingroup Group_HCD
|
||||
/** \ingroup Port_HCD
|
||||
* @{
|
||||
* \defgroup EHCI
|
||||
* \brief EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise
|
||||
*
|
||||
|
|
@ -483,4 +478,5 @@ tusb_error_t hcd_controller_reset(uint8_t hostid) ATTR_WARN_UNUSED_RESULT;
|
|||
#endif /* _TUSB_EHCI_H_ */
|
||||
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
|
|
|
|||
|
|
@ -36,28 +36,21 @@
|
|||
*/
|
||||
/**************************************************************************/
|
||||
|
||||
/** \file
|
||||
* \brief Host Controller Driver
|
||||
*
|
||||
* \note TBD
|
||||
*/
|
||||
|
||||
/**
|
||||
* \defgroup Group_HCD Host Controller Driver
|
||||
* \brief Host Controller Driver
|
||||
*
|
||||
/** \addtogroup Port Port
|
||||
* @{
|
||||
* \defgroup Port_HCD Host Controller Driver (HCD)
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _TUSB_HCD_H_
|
||||
#define _TUSB_HCD_H_
|
||||
|
||||
#include "common/common.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include "common/common.h"
|
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// MACRO CONSTANT TYPEDEF
|
||||
//--------------------------------------------------------------------+
|
||||
|
|
@ -126,3 +119,4 @@ void hcd_port_unplug(uint8_t hostid); // called by usbh to instruct hcd that it
|
|||
#endif /* _TUSB_HCD_H_ */
|
||||
|
||||
/// @}
|
||||
/// @}
|
||||
|
|
|
|||
|
|
@ -36,28 +36,9 @@
|
|||
*/
|
||||
/**************************************************************************/
|
||||
|
||||
/** \file
|
||||
* \brief TBD
|
||||
*
|
||||
* \note TBD
|
||||
*/
|
||||
|
||||
/** \ingroup TBD
|
||||
* \defgroup TBD
|
||||
* \brief TBD
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef _TUSB_OSAL_H_
|
||||
#define _TUSB_OSAL_H_
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include "tusb_option.h"
|
||||
|
||||
/** \ingroup group_configuration
|
||||
* \defgroup TUSB_OS RTOS Integration Selection
|
||||
* \brief TUSB_CFG_OS must be defined to one of these
|
||||
|
|
@ -69,6 +50,20 @@
|
|||
#define TUSB_OS_UCOS3 5 ///< MicroC OS III is used (not supported yet)
|
||||
/** @} */
|
||||
|
||||
|
||||
/** \addtogroup Port Port
|
||||
* @{
|
||||
* \defgroup Port_OSAL OS Abstraction Layer (OSAL)
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include "tusb_option.h"
|
||||
|
||||
#ifndef _TEST_
|
||||
|
||||
#if TUSB_CFG_OS == TUSB_OS_NONE
|
||||
|
|
@ -204,6 +199,7 @@ uint32_t osal_tick_get(void);
|
|||
}
|
||||
#endif
|
||||
|
||||
#endif /* _TUSB_OSAL_H_ */
|
||||
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
#endif /* _TUSB_OSAL_H_ */
|
||||
|
|
|
|||
Loading…
Reference in New Issue