Skip to content

USB Device: document internal functions #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobertRostohar merged 2 commits into from
Oct 19, 2026
Merged

USB Device: document internal functions #192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2093d79
USB Device: document internal functions
MiloradCvjetkovic Oct 16, 2026
4f06d41
Update briefs
MiloradCvjetkovic Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Components/USB/Source/usbd_config.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5955,6 +5955,10 @@ usbdRequestStatus (* const fpUSBD_Device_Endpoint0_InDataSent[USBD_DEV_NUM]) (ui
#endif
};

/// \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.
usbStatus USBD_ClassInitialize (uint8_t device) {
uint8_t instance;
usbStatus status_ret, status;
Expand Down Expand Up @@ -6035,6 +6039,10 @@ usbStatus USBD_ClassInitialize (uint8_t device) {
return status_ret;
}

/// \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.
usbStatus USBD_ClassUninitialize (uint8_t device) {
uint8_t instance;
usbStatus status_ret, status;
Expand Down Expand Up @@ -6115,6 +6123,8 @@ usbStatus USBD_ClassUninitialize (uint8_t device) {
return status_ret;
}

/// \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;

Expand Down Expand Up @@ -6186,6 +6196,9 @@ void USBD_Reset (uint8_t device) {
#endif
}

/// \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) {

#if (USBD_HID_NUM > 0)
Expand All @@ -6210,6 +6223,9 @@ void USBD_SetConfiguration (uint8_t device, uint8_t configuration) {
#endif
}

/// \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) {
uint8_t instance;

Expand Down Expand Up @@ -6320,6 +6336,9 @@ void USBD_EndpointStart (uint8_t device, uint8_t ep_addr) {
#endif
}

/// \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) {
#if ((USBD_CUSTOM_CLASS_NUM > 0) || (USBD_ADC_NUM > 0) || (USBD_CDC_NUM > 0))
uint8_t instance;
Expand Down
Loading