Merge pull request #12873 from leandrolanzieri/pr/usb_fix_config
sys/usb: Add configurations to Doxygen configuration group
This commit is contained in:
commit
1d223b5059
@ -24,22 +24,38 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup usb_conf USB peripheral compile time configurations
|
||||||
|
* @ingroup config
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
/**
|
/**
|
||||||
* @brief USB peripheral device vendor ID
|
* @brief USB peripheral device vendor ID
|
||||||
|
*
|
||||||
|
* @note You must provide your own VID/PID combination when manufacturing a
|
||||||
|
* device with USB.
|
||||||
*/
|
*/
|
||||||
#ifndef USB_CONFIG_VID
|
#ifndef USB_CONFIG_VID
|
||||||
|
#ifdef DOXYGEN
|
||||||
|
#define USB_CONFIG_VID
|
||||||
|
#else
|
||||||
#error Please supply your vendor ID by setting USB_CONFIG_VID
|
#error Please supply your vendor ID by setting USB_CONFIG_VID
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief USB peripheral device product ID
|
* @brief USB peripheral device product ID
|
||||||
*
|
*
|
||||||
* You must provide your own VID/PID combination when manufacturing a device
|
* @note You must provide your own VID/PID combination when manufacturing a
|
||||||
* with USB
|
* device with USB.
|
||||||
*/
|
*/
|
||||||
#ifndef USB_CONFIG_PID
|
#ifndef USB_CONFIG_PID
|
||||||
|
#ifdef DOXYGEN
|
||||||
|
#define USB_CONFIG_PID
|
||||||
|
#else
|
||||||
#error Please supply your vendor ID by setting USB_CONFIG_PID
|
#error Please supply your vendor ID by setting USB_CONFIG_PID
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief USB peripheral manufacturer string
|
* @brief USB peripheral manufacturer string
|
||||||
@ -99,6 +115,7 @@ extern "C" {
|
|||||||
#ifndef USB_CONFIG_DEFAULT_LANGID
|
#ifndef USB_CONFIG_DEFAULT_LANGID
|
||||||
#define USB_CONFIG_DEFAULT_LANGID 0x0409 /* EN-US */
|
#define USB_CONFIG_DEFAULT_LANGID 0x0409 /* EN-US */
|
||||||
#endif
|
#endif
|
||||||
|
/** @} */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief USB version definitions
|
* @brief USB version definitions
|
||||||
|
|||||||
@ -40,6 +40,11 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup usb_usbus_conf USBUS compile time configurations
|
||||||
|
* @ingroup usb_conf
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
/**
|
/**
|
||||||
* @brief USBUS thread stack size
|
* @brief USBUS thread stack size
|
||||||
*/
|
*/
|
||||||
@ -54,11 +59,6 @@ extern "C" {
|
|||||||
#define USBUS_PRIO (THREAD_PRIORITY_MAIN - 6)
|
#define USBUS_PRIO (THREAD_PRIORITY_MAIN - 6)
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief USBUS thread name
|
|
||||||
*/
|
|
||||||
#define USBUS_TNAME "usbus"
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief USBUS auto attach setting
|
* @brief USBUS auto attach setting
|
||||||
*
|
*
|
||||||
@ -80,6 +80,12 @@ extern "C" {
|
|||||||
#ifndef USBUS_EP0_SIZE
|
#ifndef USBUS_EP0_SIZE
|
||||||
#define USBUS_EP0_SIZE 64
|
#define USBUS_EP0_SIZE 64
|
||||||
#endif
|
#endif
|
||||||
|
/** @} */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief USBUS thread name
|
||||||
|
*/
|
||||||
|
#define USBUS_TNAME "usbus"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name USBUS thread flags
|
* @name USBUS thread flags
|
||||||
|
|||||||
@ -37,6 +37,11 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup usbus_cdc_acm_conf USBUS CDC ACM compile time configurations
|
||||||
|
* @ingroup usb_conf
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
/**
|
/**
|
||||||
* @brief Buffer size for STDIN and STDOUT data to and from USB when using
|
* @brief Buffer size for STDIN and STDOUT data to and from USB when using
|
||||||
* the USBUS_CDC_ACM_STDIO module
|
* the USBUS_CDC_ACM_STDIO module
|
||||||
@ -51,6 +56,7 @@ extern "C" {
|
|||||||
#ifndef USBUS_CDC_ACM_BULK_EP_SIZE
|
#ifndef USBUS_CDC_ACM_BULK_EP_SIZE
|
||||||
#define USBUS_CDC_ACM_BULK_EP_SIZE (64)
|
#define USBUS_CDC_ACM_BULK_EP_SIZE (64)
|
||||||
#endif
|
#endif
|
||||||
|
/** @} */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief USBUS CDC ACM interrupt endpoint size.
|
* @brief USBUS CDC ACM interrupt endpoint size.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user