From 83f1d660ce1a1520b7a7e781d05c47221067f3f7 Mon Sep 17 00:00:00 2001 From: hathach Date: Fri, 22 Nov 2013 15:16:24 +0700 Subject: clean up add some doxygen work finalize device disconnection & suspend - suspend & resume & remote wake up is not supported yet --- tinyusb/class/cdc_device.h | 13 ++++++------- tinyusb/class/cdc_host.h | 15 +++++++++------ tinyusb/class/hid_device.h | 11 ++++++++++- tinyusb/class/msc_device.h | 9 ++++++++- tinyusb/class/msc_host.h | 7 +++---- 5 files changed, 36 insertions(+), 19 deletions(-) (limited to 'tinyusb/class') diff --git a/tinyusb/class/cdc_device.h b/tinyusb/class/cdc_device.h index b5135a23c..6de9ab194 100644 --- a/tinyusb/class/cdc_device.h +++ b/tinyusb/class/cdc_device.h @@ -36,13 +36,6 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * - * @{ - */ - #ifndef _TUSB_CDC_DEVICE_H_ #define _TUSB_CDC_DEVICE_H_ @@ -54,6 +47,11 @@ extern "C" { #endif +/** \addtogroup CDC_Serial Serial + * @{ + * \defgroup CDC_Serial_Device Device + * @{ */ + //--------------------------------------------------------------------+ // APPLICATION API //--------------------------------------------------------------------+ @@ -91,3 +89,4 @@ void cdcd_close(uint8_t coreid); #endif /* _TUSB_CDC_DEVICE_H_ */ /** @} */ +/** @} */ diff --git a/tinyusb/class/cdc_host.h b/tinyusb/class/cdc_host.h index 6a33c9d85..91e653d03 100644 --- a/tinyusb/class/cdc_host.h +++ b/tinyusb/class/cdc_host.h @@ -36,8 +36,6 @@ */ /**************************************************************************/ -/** \addtogroup ClassDriver_CDC Communication Device Class (CDC) - * @{ */ #ifndef _TUSB_CDC_HOST_H_ #define _TUSB_CDC_HOST_H_ @@ -50,6 +48,8 @@ extern "C" { #endif +/** \addtogroup ClassDriver_CDC Communication Device Class (CDC) + * @{ */ //--------------------------------------------------------------------+ // APPLICATION PUBLIC API @@ -57,8 +57,7 @@ /** \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 @@ -104,7 +103,9 @@ tusb_error_t tusbh_cdc_send(uint8_t dev_addr, void const * p_data, uint32_t leng */ tusb_error_t tusbh_cdc_receive(uint8_t dev_addr, void * p_buffer, uint32_t length, bool is_notify); -//------------- CDC Application Callback -------------// +//--------------------------------------------------------------------+ +// CDC APPLICATION CALLBACKS +//--------------------------------------------------------------------+ /** \brief Callback function that will be invoked when a device with CDC Abstract Control Model interface is mounted * \param[in] dev_addr Address of newly mounted device * \note This callback should be used by Application to set-up interface-related data @@ -144,7 +145,9 @@ void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_ bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT; tusb_error_t tusbh_cdc_rndis_get_mac_addr(uint8_t dev_addr, uint8_t mac_address[6]); -//------------- RNDIS Application Callback (overshadow CDC callbacks) -------------// +//--------------------------------------------------------------------+ +// RNDIS Application Callback (overshadow CDC callbacks) +//--------------------------------------------------------------------+ /** \brief Callback function that will be invoked when a device with RNDIS interface is mounted * \param[in] dev_addr Address of newly mounted device * \note This callback should be used by Application to set-up interface-related data diff --git a/tinyusb/class/hid_device.h b/tinyusb/class/hid_device.h index 54cdd5e94..8eebd1824 100644 --- a/tinyusb/class/hid_device.h +++ b/tinyusb/class/hid_device.h @@ -83,13 +83,13 @@ tusb_error_t tusbd_hid_keyboard_send(uint8_t coreid, hid_keyboard_report_t const // APPLICATION CALLBACK API //--------------------------------------------------------------------+ /** \brief Callback function that is invoked when an transferring event occurred + * after invoking \ref tusbd_hid_keyboard_send * \param[in] coreid USB Controller ID * \param[in] event an value from \ref tusb_event_t * \note event can be one of following * - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully. * - TUSB_EVENT_XFER_ERROR : previously scheduled transfer encountered a transaction error. * - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device. - * \note Application should schedule the next report by calling \ref tusbh_hid_keyboard_get_report within this callback */ void tusbd_hid_keyboard_isr(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes); void tusbd_hid_keyboard_mounted_cb(uint8_t coreid); @@ -132,6 +132,15 @@ tusb_error_t tusbd_hid_mouse_send(uint8_t coreid, hid_mouse_report_t const *p_re //--------------------------------------------------------------------+ // APPLICATION CALLBACK API //--------------------------------------------------------------------+ +/** \brief Callback function that is invoked when an transferring event occurred + * after invoking \ref tusbd_hid_mouse_send + * \param[in] coreid USB Controller ID + * \param[in] event an value from \ref tusb_event_t + * \note event can be one of following + * - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully. + * - TUSB_EVENT_XFER_ERROR : previously scheduled transfer encountered a transaction error. + * - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device. + */ void tusbd_hid_mouse_isr(uint8_t coreid, tusb_event_t event, uint32_t xferred_bytes); void tusbd_hid_mouse_mounted_cb(uint8_t coreid); void tusbd_hid_mouse_unmounted_cb(uint8_t coreid); diff --git a/tinyusb/class/msc_device.h b/tinyusb/class/msc_device.h index acbf04ea0..d8dc6874c 100644 --- a/tinyusb/class/msc_device.h +++ b/tinyusb/class/msc_device.h @@ -47,6 +47,11 @@ extern "C" { #endif +/** \addtogroup ClassDriver_MSC + * @{ + * \defgroup MSC_Device Device + * @{ */ + //--------------------------------------------------------------------+ // APPLICATION API //--------------------------------------------------------------------+ @@ -64,6 +69,9 @@ msc_csw_status_t tusbd_msc_scsi_received_isr (uint8_t coreid, uint8_t lun, uint8 tusb_error_t tusbd_msc_read10 (uint8_t dev_addr, uint8_t lun, void * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT; tusb_error_t tusbh_msc_write10(uint8_t dev_addr, uint8_t lun, void const * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT; +/** @} */ +/** @} */ + //--------------------------------------------------------------------+ // USBD-CLASS DRIVER API //--------------------------------------------------------------------+ @@ -83,4 +91,3 @@ void mscd_close(uint8_t coreid); #endif /* _TUSB_MSC_DEVICE_H_ */ -/** @} */ diff --git a/tinyusb/class/msc_host.h b/tinyusb/class/msc_host.h index ddb8a7f54..66b8f9aa3 100644 --- a/tinyusb/class/msc_host.h +++ b/tinyusb/class/msc_host.h @@ -36,9 +36,6 @@ */ /**************************************************************************/ -/** \addtogroup ClassDriver_MSC - * @{ */ - #ifndef _TUSB_MSC_HOST_H_ #define _TUSB_MSC_HOST_H_ @@ -50,7 +47,9 @@ extern "C" { #endif -/** \defgroup MSC_Host Host +/** \addtogroup ClassDriver_MSC + * @{ + * \defgroup MSC_Host Host * The interface API includes status checking function, data transferring function and callback functions * @{ */ //--------------------------------------------------------------------+ -- cgit v1.3.1