From 2093d79ecc9a0a112596d68138335fbd4dfd48af Mon Sep 17 00:00:00 2001 From: MiloradCvjetkovic Date: Fri, 16 Oct 2026 13:25:08 +0200 Subject: [PATCH 1/2] USB Device: document internal functions --- Components/USB/Source/usbd_config.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Components/USB/Source/usbd_config.c b/Components/USB/Source/usbd_config.c index 6602f54c..d548e143 100644 --- a/Components/USB/Source/usbd_config.c +++ b/Components/USB/Source/usbd_config.c @@ -5955,6 +5955,10 @@ usbdRequestStatus (* const fpUSBD_Device_Endpoint0_InDataSent[USBD_DEV_NUM]) (ui #endif }; +/// \brief Initialize each enabled USB class instance assigned to a device. +/// \param[in] device index of USB Device. +/// \return usbOK if every applicable class initializes successfully; otherwise +/// the status returned by the last class initialization that failed. usbStatus USBD_ClassInitialize (uint8_t device) { uint8_t instance; usbStatus status_ret, status; @@ -6035,6 +6039,10 @@ usbStatus USBD_ClassInitialize (uint8_t device) { return status_ret; } +/// \brief Uninitialize each enabled USB class instance assigned to a device. +/// \param[in] device index of USB Device. +/// \return usbOK if every applicable class uninitializes successfully; otherwise +/// the status returned by the last class uninitialization that failed. usbStatus USBD_ClassUninitialize (uint8_t device) { uint8_t instance; usbStatus status_ret, status; @@ -6115,6 +6123,8 @@ usbStatus USBD_ClassUninitialize (uint8_t device) { return status_ret; } +/// \brief Notify configured class instances that a USB device was reset. +/// \param[in] device index of USB Device. void USBD_Reset (uint8_t device) { uint8_t instance; @@ -6186,6 +6196,9 @@ void USBD_Reset (uint8_t device) { #endif } +/// \brief Notify HID instances when a device receives a nonzero configuration. +/// \param[in] device index of USB Device. +/// \param[in] configuration configuration value. void USBD_SetConfiguration (uint8_t device, uint8_t configuration) { #if (USBD_HID_NUM > 0) @@ -6210,6 +6223,9 @@ void USBD_SetConfiguration (uint8_t device, uint8_t configuration) { #endif } +/// \brief Notify USB classes that a configured endpoint should start. +/// \param[in] device index of USB Device. +/// \param[in] ep_addr USB endpoint address. void USBD_EndpointStart (uint8_t device, uint8_t ep_addr) { uint8_t instance; @@ -6320,6 +6336,9 @@ void USBD_EndpointStart (uint8_t device, uint8_t ep_addr) { #endif } +/// \brief Notify USB classes that a configured endpoint should stop. +/// \param[in] device index of USB Device. +/// \param[in] ep_addr USB endpoint address. void USBD_EndpointStop (uint8_t device, uint8_t ep_addr) { #if ((USBD_CUSTOM_CLASS_NUM > 0) || (USBD_ADC_NUM > 0) || (USBD_CDC_NUM > 0)) uint8_t instance; From 4f06d417f2404ce8668e809cf90c264102a66daa Mon Sep 17 00:00:00 2001 From: MiloradCvjetkovic Date: Mon, 19 Oct 2026 07:37:09 +0200 Subject: [PATCH 2/2] Update briefs --- Components/USB/Source/usbd_config.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Components/USB/Source/usbd_config.c b/Components/USB/Source/usbd_config.c index d548e143..d197692c 100644 --- a/Components/USB/Source/usbd_config.c +++ b/Components/USB/Source/usbd_config.c @@ -5955,7 +5955,7 @@ usbdRequestStatus (* const fpUSBD_Device_Endpoint0_InDataSent[USBD_DEV_NUM]) (ui #endif }; -/// \brief Initialize each enabled USB class instance assigned to a device. +/// \brief Initialize all enabled USB class instances associated with a device. /// \param[in] device index of USB Device. /// \return usbOK if every applicable class initializes successfully; otherwise /// the status returned by the last class initialization that failed. @@ -6039,7 +6039,7 @@ usbStatus USBD_ClassInitialize (uint8_t device) { return status_ret; } -/// \brief Uninitialize each enabled USB class instance assigned to a device. +/// \brief Uninitialize all enabled USB class instances associated with a device. /// \param[in] device index of USB Device. /// \return usbOK if every applicable class uninitializes successfully; otherwise /// the status returned by the last class uninitialization that failed. @@ -6123,7 +6123,7 @@ usbStatus USBD_ClassUninitialize (uint8_t device) { return status_ret; } -/// \brief Notify configured class instances that a USB device was reset. +/// \brief Notify all enabled USB class instances of a device reset. /// \param[in] device index of USB Device. void USBD_Reset (uint8_t device) { uint8_t instance; @@ -6196,7 +6196,7 @@ void USBD_Reset (uint8_t device) { #endif } -/// \brief Notify HID instances when a device receives a nonzero configuration. +/// \brief Notify all enabled USB class instances when the device configuration changes. /// \param[in] device index of USB Device. /// \param[in] configuration configuration value. void USBD_SetConfiguration (uint8_t device, uint8_t configuration) { @@ -6223,7 +6223,7 @@ void USBD_SetConfiguration (uint8_t device, uint8_t configuration) { #endif } -/// \brief Notify USB classes that a configured endpoint should start. +/// \brief Notify all enabled USB class instances to start a class-specific endpoint. /// \param[in] device index of USB Device. /// \param[in] ep_addr USB endpoint address. void USBD_EndpointStart (uint8_t device, uint8_t ep_addr) { @@ -6336,7 +6336,7 @@ void USBD_EndpointStart (uint8_t device, uint8_t ep_addr) { #endif } -/// \brief Notify USB classes that a configured endpoint should stop. +/// \brief Notify all enabled USB class instances to stop a class-specific endpoint. /// \param[in] device index of USB Device. /// \param[in] ep_addr USB endpoint address. void USBD_EndpointStop (uint8_t device, uint8_t ep_addr) {