espressif_tinyusb/doxygen/configuration.txt

78 lines
3.6 KiB
Plaintext
Raw Normal View History

2014-03-31 11:34:23 +02:00
/** \addtogroup group_configuration
* @{ */
//--------------------------------------------------------------------+
// COMMON CONFIGURATION
//--------------------------------------------------------------------+
/// \brief tell the stack which mode (host/device/otg) the usb controller0 will be operated on. Possible value is
/// from \ref group_mode. Note the hardware usb controller must support the selected mode.
#define CFG_TUSB_RHPORT0_MODE
2014-03-31 11:34:23 +02:00
/** USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables
2018-04-10 09:31:11 +02:00
into the USB RAM section as follows. if your mcu's usb controller has no such limit, define CFG_TUSB_ATTR_USBRAM as empty macro.
2014-03-31 11:34:23 +02:00
@code
2018-04-10 09:31:11 +02:00
CFG_TUSB_ATTR_USBRAM uint8_t usb_xfer_buffer[10];
2014-03-31 11:34:23 +02:00
@endcode
*/
2018-04-10 09:31:11 +02:00
#define CFG_TUSB_ATTR_USBRAM
2014-03-31 11:34:23 +02:00
2018-04-10 09:31:11 +02:00
#define CFG_TUSB_MCU ///< Select one of the supported MCU, the value must be from \ref group_mcu
#define CFG_TUSB_OS ///< Select one of the supported RTOS, the value must be from \ref group_supported_os.
#define CFG_TUD_TASK_PRIO ///< If \ref CFG_TUSB_OS is configured to use a real RTOS (other than OPT_OS_NONE). This determines the priority of the usb stack task.
2014-03-31 11:34:23 +02:00
//--------------------------------------------------------------------+
// HOST CONFIGURATION
//--------------------------------------------------------------------+
2018-04-10 09:31:11 +02:00
/** \defgroup CFG_TUSB_HOST Host Options
2014-03-31 11:34:23 +02:00
* @{ */
/** \brief Maximum number of device host stack can manage
* \n If hub class is not enabled, set this equal to number of controllers in host mode
* \n If hub class is enabled, make sure hub is also counted */
2018-04-10 09:31:11 +02:00
#define CFG_TUSB_HOST_DEVICE_MAX
2014-03-31 11:34:23 +02:00
/// \brief Buffer size used for getting device configuration descriptor. You may want to increase this from default (256)
/// to support lengthy composite device especially with Audio or Video class
2018-04-10 09:31:11 +02:00
#define CFG_TUSB_HOST_ENUM_BUFFER_SIZE
2014-03-31 11:34:23 +02:00
/** \defgroup config_host_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
2018-04-10 09:31:11 +02:00
#define CFG_TUSB_HOST_HUB ///< Enable Hub Class
#define CFG_TUSB_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard
#define CFG_TUSB_HOST_HID_MOUSE ///< Enable HID Class for Mouse
#define CFG_TUSB_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
#define CFG_TUSB_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only)
#define CFG_TUSB_HOST_CDC ///< Enable Virtual Serial (Communication Device Class)
2014-03-31 11:34:23 +02:00
/** @} */
/** @} */ // group Host
//--------------------------------------------------------------------+
// DEVICE CONFIGURATION
//--------------------------------------------------------------------+
2018-04-10 09:31:11 +02:00
/** \defgroup CFG_TUSB_DEVICE Device Options
2014-03-31 11:34:23 +02:00
* @{ */
2018-04-12 08:23:52 +02:00
#define CFG_TUD_ENDOINT0_SIZE ///< Max packet size of Cotnrol Endpoint, default is 64
2014-03-31 11:34:23 +02:00
/// Application MUST define this variable and initialize its pointers's member to all required USB descriptors including
/// Device Descriptor, Configuration Descriptor, String Descriptors, HID Report Descriptors etc ...
2018-04-16 08:46:28 +02:00
tud_desc_init_t tusbd_descriptor_pointers;
2014-03-31 11:34:23 +02:00
/** \defgroup config_device_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
2018-04-12 08:23:52 +02:00
#define CFG_TUD_HID_KEYBOARD ///< Enable HID Class for Keyboard
#define CFG_TUD_HID_MOUSE ///< Enable HID Class for Mouse
#define CFG_TUD_HID_GENERIC ///< Enable HID Class for Generic (not supported yet)
#define CFG_TUD_MSC ///< Enable Mass Storage Class (SCSI subclass only)
#define CFG_TUD_CDC ///< Enable Virtual Serial (Communication Device Class)
2014-03-31 11:34:23 +02:00
/** @} */
/** @} */ // group Device
/** @} */