From d835c52a4b0497c987449833306a24a1f74425d5 Mon Sep 17 00:00:00 2001 From: Leandro Lanzieri Date: Wed, 4 Dec 2019 15:04:11 +0100 Subject: [PATCH 1/4] usb: Fix VID/PID macros documentation --- sys/include/usb.h | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/sys/include/usb.h b/sys/include/usb.h index cbe8c9c241..4f12698d2f 100644 --- a/sys/include/usb.h +++ b/sys/include/usb.h @@ -26,20 +26,31 @@ extern "C" { /** * @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 +#ifdef DOXYGEN +#define USB_CONFIG_VID +#else #error Please supply your vendor ID by setting USB_CONFIG_VID #endif +#endif /** * @brief USB peripheral device product ID * - * You must provide your own VID/PID combination when manufacturing a device - * with USB + * @note You must provide your own VID/PID combination when manufacturing a + * device with USB. */ #ifndef USB_CONFIG_PID +#ifdef DOXYGEN +#define USB_CONFIG_PID +#else #error Please supply your vendor ID by setting USB_CONFIG_PID #endif +#endif /** * @brief USB peripheral manufacturer string From 731f27378bd0226b0355b8b4ab51d896eea3bf85 Mon Sep 17 00:00:00 2001 From: Leandro Lanzieri Date: Wed, 4 Dec 2019 15:09:56 +0100 Subject: [PATCH 2/4] usb: Add configs to compile time configuration Doxygen group --- sys/include/usb.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sys/include/usb.h b/sys/include/usb.h index 4f12698d2f..018c323030 100644 --- a/sys/include/usb.h +++ b/sys/include/usb.h @@ -24,6 +24,11 @@ extern "C" { #endif +/** + * @defgroup usb_conf USB peripheral compile time configurations + * @ingroup config + * @{ + */ /** * @brief USB peripheral device vendor ID * @@ -110,6 +115,7 @@ extern "C" { #ifndef USB_CONFIG_DEFAULT_LANGID #define USB_CONFIG_DEFAULT_LANGID 0x0409 /* EN-US */ #endif +/** @} */ /** * @brief USB version definitions From f48bd7f9f3aef8fdc23f2e9b5b8fcc49d322864f Mon Sep 17 00:00:00 2001 From: Leandro Lanzieri Date: Wed, 4 Dec 2019 13:34:34 +0100 Subject: [PATCH 3/4] usbus: Add configs to compile time configuration Doxygen group --- sys/include/usb/usbus.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/sys/include/usb/usbus.h b/sys/include/usb/usbus.h index 24d439a48e..fbbef5c7f1 100644 --- a/sys/include/usb/usbus.h +++ b/sys/include/usb/usbus.h @@ -40,6 +40,11 @@ extern "C" { #endif +/** + * @defgroup usb_usbus_conf USBUS compile time configurations + * @ingroup usb_conf + * @{ + */ /** * @brief USBUS thread stack size */ @@ -54,11 +59,6 @@ extern "C" { #define USBUS_PRIO (THREAD_PRIORITY_MAIN - 6) #endif -/** - * @brief USBUS thread name - */ -#define USBUS_TNAME "usbus" - /** * @brief USBUS auto attach setting * @@ -80,6 +80,12 @@ extern "C" { #ifndef USBUS_EP0_SIZE #define USBUS_EP0_SIZE 64 #endif +/** @} */ + +/** + * @brief USBUS thread name + */ +#define USBUS_TNAME "usbus" /** * @name USBUS thread flags From 0673fce3c422f9300eee2d2b963e959d3199bcc4 Mon Sep 17 00:00:00 2001 From: Leandro Lanzieri Date: Wed, 4 Dec 2019 13:38:31 +0100 Subject: [PATCH 4/4] usbus/cdc/acm: Add configs to compile time configuration Doxygen group --- sys/include/usb/usbus/cdc/acm.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sys/include/usb/usbus/cdc/acm.h b/sys/include/usb/usbus/cdc/acm.h index 62fb5154e2..8bd2f09c48 100644 --- a/sys/include/usb/usbus/cdc/acm.h +++ b/sys/include/usb/usbus/cdc/acm.h @@ -37,6 +37,11 @@ extern "C" { #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 * the USBUS_CDC_ACM_STDIO module @@ -51,6 +56,7 @@ extern "C" { #ifndef USBUS_CDC_ACM_BULK_EP_SIZE #define USBUS_CDC_ACM_BULK_EP_SIZE (64) #endif +/** @} */ /** * @brief USBUS CDC ACM interrupt endpoint size.