diff options
| author | hathach <[email protected]> | 2013-10-24 15:32:54 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2013-10-24 15:32:54 +0700 |
| commit | b71ffe3d5a7b97010b7ac2096271e03dcb35c2dd (patch) | |
| tree | 512a6798926f074a93701a10a31a6e6721b78e02 /tinyusb/doxygen | |
| parent | 2076e57d7072bb77c116c3cea51f640081da4aab (diff) | |
change TUSB_CFG_CONTROLLER0/1_MODE to TUSB_CFG_CONTROLLER_0/1_MODE for clearance
adding configuration docs for tinyusb_config.h
document HID mouse & keyboard API
Diffstat (limited to 'tinyusb/doxygen')
| -rw-r--r-- | tinyusb/doxygen/configuration.h | 39 | ||||
| -rw-r--r-- | tinyusb/doxygen/overview.md | 3 |
2 files changed, 39 insertions, 3 deletions
diff --git a/tinyusb/doxygen/configuration.h b/tinyusb/doxygen/configuration.h new file mode 100644 index 000000000..8f2d8bd34 --- /dev/null +++ b/tinyusb/doxygen/configuration.h @@ -0,0 +1,39 @@ +/** \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
+ 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
+ uint8_t tinyusb_data[10] TUSB_CFG_ATTR_USBRAM;
+ @endcode
+ */
+#define TUSB_CFG_ATTR_USBRAM
+
+
+/** \defgroup TUSB_CFG_HOST Host
+ * @{ */
+
+/// 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
+#define TUSB_CFG_HOST_DEVICE_MAX
+
+/// Buffer size used for getting device configuration descriptor. You may want to increase this from default
+/// to support lengthy composite device especially with Audio or Video class
+#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE
+
+#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
+#define TUSB_CFG_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
+#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
+
+
+
+/** @} */
diff --git a/tinyusb/doxygen/overview.md b/tinyusb/doxygen/overview.md deleted file mode 100644 index 695690143..000000000 --- a/tinyusb/doxygen/overview.md +++ /dev/null @@ -1,3 +0,0 @@ -# What is tinyUSB - - |