diff options
| author | hathach <[email protected]> | 2014-03-21 16:59:34 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2014-03-21 16:59:34 +0700 |
| commit | b349121c09c99dd65b35b785fa34d8884f6867f4 (patch) | |
| tree | 198e4e4d938e997e96c222c9631c5371e18a3f4a /tinyusb | |
| parent | 08dd42fa5c3c773cb8e712dd573152f40dbbe801 (diff) | |
some doxygen
Diffstat (limited to 'tinyusb')
| -rw-r--r-- | tinyusb/common/std_descriptors.h | 3 | ||||
| -rw-r--r-- | tinyusb/device/usbd.h | 12 |
2 files changed, 8 insertions, 7 deletions
diff --git a/tinyusb/common/std_descriptors.h b/tinyusb/common/std_descriptors.h index 1dbba88c3..9c9d06c4d 100644 --- a/tinyusb/common/std_descriptors.h +++ b/tinyusb/common/std_descriptors.h @@ -42,8 +42,7 @@ /** \addtogroup group_usb_definitions USB Definitions
* @{
* \defgroup Group_StdDescriptor Standard Descriptors
- * @{
- */
+ * @{ */
#ifndef _TUSB_STD_DESCRIPTORS_H_
#define _TUSB_STD_DESCRIPTORS_H_
diff --git a/tinyusb/device/usbd.h b/tinyusb/device/usbd.h index 48574fddc..c8665d033 100644 --- a/tinyusb/device/usbd.h +++ b/tinyusb/device/usbd.h @@ -63,13 +63,15 @@ #define ATTR_USB_MIN_ALIGNMENT
#endif
+/// \brief Descriptor pointer collector to all the needed. All the addresses pointed
+/// must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
typedef struct {
- uint8_t * p_device;
- uint8_t * p_configuration;
- uint8_t * p_string_arr[TUSB_CFG_DEVICE_STRING_DESCRIPTOR_COUNT];
+ uint8_t * p_device; ///< pointer to device descritpor \ref tusb_descriptor_device_t
+ uint8_t * p_configuration; ///< pointer to the whole configuration descriptor, starting by \ref tusb_descriptor_configuration_t
+ uint8_t * p_string_arr[TUSB_CFG_DEVICE_STRING_DESCRIPTOR_COUNT]; ///< a array of pointers to string descriptors
- uint8_t * p_hid_keyboard_report;
- uint8_t * p_hid_mouse_report;
+ uint8_t * p_hid_keyboard_report; ///< pointer to HID report descriptor of Keybaord interface. Only needed if TUSB_CFG_DEVICE_HID_KEYBOARD is enabled
+ uint8_t * p_hid_mouse_report; ///< pointer to HID report descriptor of Mouse interface. Only needed if TUSB_CFG_DEVICE_HID_MOUSE is enabled
}tusbd_descriptor_pointer_t;
// define by application
|