Function Overview

The following list provides a brief overview of all USB Component functions.

USB Device

Core

• USBD_GetVersion — Get version of USB Device stack.
• USBD_Configured — Retrieve USB Device configuration status.
• USBD_Connect — Activate pull-up on D+ or D- line to signal USB Device connection on USB Bus.
• USBD_Devicen_DisableRemoteWakeup — Callback function called when Clear Feature for Remote Wakeup was requested over Control Endpoint 0.
• USBD_Devicen_EnableRemoteWakeup — Callback function called when Set Feature for Remote Wakeup was requested over Control Endpoint 0.
• USBD_Devicen_Endpoint0_InDataSent — Callback function called when Device sent IN DATA on Control Endpoint 0.
• USBD_Devicen_Endpoint0_OutDataReceived — Callback function called when Device received OUT DATA on Control Endpoint 0.
• USBD_Devicen_Endpoint0_SetupPacketProcessed — Callback function called when SETUP PACKET was processed by USB library.
• USBD_Devicen_Endpoint0_SetupPacketReceived — Callback function called when Device received SETUP PACKET on Control Endpoint 0.
• USBD_Devicen_ConfigurationChanged — Callback function called when Device configuration has changed.
• USBD_Devicen_HighSpeedActivated — Callback function called when USB Bus speed has changed to high-speed.
• USBD_Devicen_Initialize — Callback function called during USBD_Initialize to initialize the USB Device.
• USBD_Devicen_Reset — Callback function called upon USB Bus Reset signaling.
• USBD_Devicen_Resumed — Callback function called when USB Bus activity has resumed.
• USBD_Devicen_Suspended — Callback function called when USB Bus goes into suspend mode (no bus activity for 3 ms)
• USBD_Devicen_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB Device.
• USBD_Devicen_VbusChanged — Callback function called when VBUS level changes.
• USBD_Disconnect — Disconnect USB Device from USB Bus.
• USBD_GetState — Retrieve USB Device state.
• USBD_SetSerialNumber — Set USB Device serial number string.
• USBD_Initialize — Initialize USB Device stack and controller.
• USBD_Uninitialize — De-initialize USB Device stack and controller.

ADC: Audio Device Class

• USBD_ADC_ReadSamples — Read audio samples received from USB Host.
• USBD_ADC_ReceivedSamplesAvailable — Number of audio samples received from USB Host and available to be read.
• USBD_ADC_SetMicrophoneVolumeRange — Set range for microphone volume (level) control.
• USBD_ADC_SetSpeakerVolumeRange — Set range for speaker volume control.
• USBD_ADC_WriteSamples — Write audio samples to be transferred to USB Host.
• USBD_ADC_WrittenSamplesPending — Number of audio samples written and pending to be sent to USB Host.
• USBD_ADCn_Initialize — Callback function called during USBD_Initialize to initialize the USB ADC class instance.
• USBD_ADCn_PlayStart — Callback function called when play started.
• USBD_ADCn_PlayStop — Callback function called when play stopped.
• USBD_ADCn_ReceivedSamples — Callback function called when data in USB buffer for speaker samples reaches half-full from empty.
• USBD_ADCn_RecordStart — Callback function called when recording started.
• USBD_ADCn_RecordStop — Callback function called when recording stopped.
• USBD_ADCn_SetSpeakerMute — Callback function called when speaker mute setting changed.
• USBD_ADCn_SetSpeakerVolume — Callback function called when speaker volume setting changed.
• USBD_ADCn_SetMicrophoneMute — Callback function called when microphone mute setting changed.
• USBD_ADCn_SetMicrophoneVolume — Callback function called when microphone volume setting changed.
• USBD_ADCn_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB ADC class instance.

CDC: Communication Device Class (ACM)

• USBD_CDC_ACM_DataAvailable — Retrieve number of data bytes received by Communication Device from USB Host that are available to read.
• USBD_CDC_ACM_GetChar — Read one character received by Communication Device from USB Host.
• USBD_CDC_ACM_Notify_SerialState — Send notification of Communication Device status and line states to USB Host.
• USBD_CDC_ACM_Notify_ResponseAvailable — Send notification to USB Host signaling that response is available.
• USBD_CDC_ACM_PutChar — Write a single character from Communication Device to USB Host.
• USBD_CDC_ACM_ReadData — Read multiple data bytes received by Communication Device from USB Host.
• USBD_CDC_ACM_WriteData — Write data from Communication Device to USB Host.
• USBD_CDCn_ACM_DataReceived — Callback function called when new data was received.
• USBD_CDCn_ACM_DataSent — Callback function called when all data was sent.
• USBD_CDCn_ACM_GetEncapsulatedResponse — Callback function called upon reception of request to get encapsulated response sent by the USB Host.
• USBD_CDCn_ACM_GetLineCoding — Callback function called upon USB Host request to retrieve communication settings.
• USBD_CDCn_ACM_Initialize — Callback function called during USBD_Initialize to initialize the USB CDC class instance (ACM)
• USBD_CDCn_ACM_Reset — Callback function called upon USB Bus Reset signaling.
• USBD_CDCn_ACM_SendEncapsulatedCommand — Callback function called upon reception of request send encapsulated command sent by the USB Host.
• USBD_CDCn_ACM_SetControlLineState — Callback function called upon USB Host request to set control line states.
• USBD_CDCn_ACM_SetLineCoding — Callback function called upon USB Host request to change communication settings.
• USBD_CDCn_ACM_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB CDC class instance (ACM)

CDC: Communication Device Class (NCM)

• USBD_CDC_NCM_Notify_ConnectionSpeedChange — Report a change in upstream or downstream speed of the networking connection to the USB Host.
• USBD_CDC_NCM_Notify_NetworkConnection — Report whether or not the physical layer (modem, Ethernet PHY, etc.) link is up to the USB Host.
• USBD_CDC_NCM_NTB_IN_CreateNDP — Create a new NDP in the NTB (datagrams can be added to it)
• USBD_CDC_NCM_NTB_IN_Initialize — Clear the active NTB (prepared for sending)
• USBD_CDC_NCM_NTB_IN_IsSent — Check if NTB was sent and new NTB can be prepared.
• USBD_CDC_NCM_NTB_IN_RawSend — Send already prepared NTB (for this option value of define in configuration USBD_CDCn_NCM_RAW_ENABLE has to be 1)
• USBD_CDC_NCM_NTB_IN_Send — Send the active NTB.
• USBD_CDC_NCM_NTB_IN_WriteDatagram — Add a datagram into the active NDP of the NTB to be sent.
• USBD_CDC_NCM_NTB_OUT_GetDatagramSize — Get size of a datagram from the active NDP of the received NTB.
• USBD_CDC_NCM_NTB_OUT_IsReceived — Check if NTB was received and is available for processing.
• USBD_CDC_NCM_NTB_OUT_ProcessNDP — Process the next NDP in the received NTB.
• USBD_CDC_NCM_NTB_OUT_RawGetSize — Get size of the received NTB.
• USBD_CDC_NCM_NTB_OUT_RawReceive — Receive an NDP (for this option value of define in configuration USBD_CDCn_NCM_RAW_ENABLE has to be 1)
• USBD_CDC_NCM_NTB_OUT_ReadDatagram — Read a datagram from the active NDP of the received NTB.
• USBD_CDC_NCM_NTB_OUT_Release — Flush the received NTB and release memory for reception of a new NTB.
• USBD_CDCn_NCM_GetCrcMode — Callback function called upon USB Host request to return the currently selected CRC mode.
• USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter — Callback function called upon USB Host request to retrieve the status of the specified Ethernet power management pattern filter.
• USBD_CDCn_NCM_GetEthernetStatistic — Callback function called upon USB Host request to retrieve a statistic based on the feature selector.
• USBD_CDCn_NCM_GetMaxDatagramSize — Callback function called upon USB Host request to return the currently effective maximum datagram size.
• USBD_CDCn_NCM_GetNetAddress — Callback function called upon USB Host request to return the USB Device's current EUI-48 station address.
• USBD_CDCn_NCM_GetNtbFormat — Callback function called upon USB Host request to return the NTB data format currently being used.
• USBD_CDCn_NCM_GetNtbInputSize — Callback function called upon USB Host request to return NTB input size currently being used.
• USBD_CDCn_NCM_GetNtbParameters — Callback function called upon USB Host request to retrieve the parameters that describe NTBs for each direction.
• USBD_CDCn_NCM_Initialize — Callback function called during USBD_Initialize to initialize the USB CDC class instance (NCM)
• USBD_CDCn_NCM_NTB_IN_Sent — Callback function called when NTB was successfully sent.
• USBD_CDCn_NCM_NTB_OUT_Received — Callback function called when NTB was successfully received.
• USBD_CDCn_NCM_Reset — Callback function called upon USB Bus Reset signaling.
• USBD_CDCn_NCM_SetCrcMode — Callback function called upon USB Host request to control CRC mode.
• USBD_CDCn_NCM_SetEthernetMulticastFilters — Callback function called upon USB Host request to set the Ethernet device multicast filters.
• USBD_CDCn_NCM_SetEthernetPacketFilter — Callback function called upon USB Host request to configure device Ethernet packet filter settings.
• USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter — Callback function called upon USB Host request to set up the specified Ethernet power management pattern filter.
• USBD_CDCn_NCM_SetMaxDatagramSize — Callback function called upon USB Host request to select the maximum datagram size that can be sent in an NTB.
• USBD_CDCn_NCM_SetNetAddress — Callback function called upon USB Host request to set the USB Device's current EUI-48 station address.
• USBD_CDCn_NCM_SetNtbFormat — Callback function called upon USB Host request to select the format of NTB to be used for NTBs transmitted to the USB Host.
• USBD_CDCn_NCM_SetNtbInputSize — Callback function called upon USB Host request to select the maximum size of NTB that is permitted to be sent to the USB Host.
• USBD_CDCn_NCM_Start — Callback function called when USB Host changes data interface from alternate 0 to alternate 1 (activates data interface)
• USBD_CDCn_NCM_Stop — Callback function called when USB Host changes data interface from alternate 1 to alternate 0 (de-activates data interface)
• USBD_CDCn_NCM_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB CDC class instance (NCM)

Custom Class

• USBD_CustomClassn_Initialize — Callback function called during USBD_Initialize to initialize the USB Custom class instance.
• USBD_CustomClassn_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB Custom class instance.
• USBD_CustomClassn_Reset — Callback function called upon USB Bus Reset signaling.
• USBD_CustomClassn_EndpointStart — Callback function called when Endpoint Start was requested (by activating interface or configuration)
• USBD_CustomClassn_EndpointStop — Callback function called when Endpoint Stop was requested (by de-activating interface or activating configuration 0)
• USBD_CustomClassn_Endpoint0_SetupPacketReceived — Callback function called when a SETUP PACKET was received on Control Endpoint 0.
• USBD_CustomClassn_Endpoint0_SetupPacketProcessed — Callback function called when a SETUP PACKET was processed by USB library.
• USBD_CustomClassn_Endpoint0_OutDataReceived — Callback function called when OUT DATA was received on Control Endpoint 0.
• USBD_CustomClassn_Endpoint0_InDataSent — Callback function called when IN DATA was sent on Control Endpoint 0.
• USBD_CustomClassn_Endpoint1_Event — Is called by the USB Device Core when an event happens on endpoint 1.
  :
  USBD_CustomClassn_Endpoint15_Event — Is called by the USB Device Core when an event happens on endpoint 15.
• USBD_EndpointRead — Start reception on Endpoint.
• USBD_EndpointReadGetResult — Get result of read operation on Endpoint.
• USBD_EndpointWrite — Start write on Endpoint.
• USBD_EndpointWriteGetResult — Get result of write operation on Endpoint.
• USBD_EndpointStall — Set/Clear stall on Endpoint.
• USBD_EndpointAbort — Abort read/write operation on Endpoint.

HID: Human Interface Class

• USBD_HIDn_Initialize — Callback function called during USBD_Initialize to initialize the USB HID class instance.
• USBD_HIDn_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize the USB HID class instance.
• USBD_HIDn_GetReport — Callback function called to prepare HID Report data to send.
• USBD_HIDn_SetReport — Callback function called to process received HID Report data.
• USBD_HID_GetReportTrigger — Asynchronously prepare HID Report data to send.

MSC: Mass Storage Class

• USBD_MSCn_Initialize — Callback function called during USBD_Initialize to initialize all Logical Units of the USB MSC class instance.
• USBD_MSCn_Uninitialize — Callback function called during USBD_Uninitialize to de-initialize all Logical Units of the USB MSC class instance.
• USBD_MSCn_GetCacheInfo — Callback function called to get cache information.
• USBD_MSCn_GetMediaCapacity — Callback function called to get media capacity.
• USBD_MSCn_Read — Callback function called to read data from media.
• USBD_MSCn_Write — Callback function called to write data to media.
• USBD_MSCn_CheckMedia — Callback function called to check media presence and write protect status.
• USBD_MSCn_GetMaxLUN — Callback function called to get maximum number of logical units.
• USBD_MSCn_LUN_GetMediaCapacity — Callback function called to get media capacity of a logical unit.
• USBD_MSCn_LUN_Read — Callback function called to read data from media of a logical unit.
• USBD_MSCn_LUN_Write — Callback function called to write data to media of a logical unit.
• USBD_MSCn_LUN_CheckMedia — Callback function called to check media presence and write protect status of a logical unit.
• USBD_MSCn_SetMediaOwnerUSB — Set USB as media owner.
• USBD_MSCn_SetMediaOwnerFS — Set File System as media owner.

USB Host

Core

• USBH_GetVersion — Get version of USB Host stack.
• USBH_Initialize — Initialize USB Host stack and controller.
• USBH_Uninitialize — De-initialize USB Host stack and controller.
• USBH_Port_Suspend — Suspend a root HUB port on specified controller.
• USBH_Port_Resume — Resume a root HUB port on specified controller.
• USBH_Device_GetController — Get index of USB Host controller to which USB Device is connected.
• USBH_Device_GetPort — Get index of USB Host Root HUB port to which USB Device is connected.
• USBH_Device_GetStatus — Get status of USB Device.
• USBH_Device_GetSpeed — Get communication speed of USB Device.
• USBH_Device_GetAddress — Get communication address of USB Device.
• USBH_Device_GetVID — Get Vendor ID (VID) of USB Device.
• USBH_Device_GetPID — Get Product ID (PID) of USB Device.
• USBH_Device_GetStringDescriptor — Get String Descriptor of USB Device.
• USBH_Notify — Callback function called when some event has happened on corresponding controller and port.

CDC (ACM): Communication Device Class (Abstract Control Model)

• USBH_CDC_ACM_GetDevice — Get Device instance of Communication Device Class device.
• USBH_CDC_ACM_GetLineCoding — Retrieve communication settings of Communication Device Class device.
• USBH_CDC_ACM_GetRxCount — Get result of receive data from Communication Device Class device.
• USBH_CDC_ACM_GetStatus — Get status of Communication Device Class device.
• USBH_CDC_ACM_GetTxCount — Get result of send data to Communication Device Class device.
• USBH_CDC_ACM_Initialize — Callback function called when Communication Device Class device was enumerated and is ready.
• USBH_CDC_ACM_Notify — Callback function called when Communication Device Class device modem line or error status changes.
• USBH_CDC_ACM_Receive — Receive data from Communication Device Class device.
• USBH_CDC_ACM_AbortReceive — Abort data reception from Communication Device Class device.
• USBH_CDC_ACM_Send — Send data to Communication Device Class device.
• USBH_CDC_ACM_AbortSend — Abort data sending to Communication Device Class device.
• USBH_CDC_ACM_SendBreak — Send break on Communication Device Class device.
• USBH_CDC_ACM_SetControlLineState — Set control line states of Communication Device Class device.
• USBH_CDC_ACM_SetLineCoding — Change communication settings of Communication Device Class device.
• USBH_CDC_ACM_Uninitialize — Callback function called when Communication Device Class device was disconnected.

HID: Human Interface Device Class

• USBH_HID_DataReceived — Callback function called when data is received from the Human Interface Device.
• USBH_HID_GetDevice — Get Device instance of Human Interface Device.
• USBH_HID_GetKeyboardKey — Retrieve first pending pressed keyboard key on HID Keyboard.
• USBH_HID_GetMouseState — Retrieve state change since last call of this function.
• USBH_HID_GetStatus — Get status of Human Interface Device.
• USBH_HID_Initialize — Callback function called when Human Interface Device was enumerated and is ready.
• USBH_HID_ParseReportDescriptor — Callback function called for parsing of the Human Interface Device report descriptor.
• USBH_HID_Read — Read data received from Human Interface Device.
• USBH_HID_Uninitialize — Callback function called when Human Interface Device was disconnected.
• USBH_HID_Write — Write data to Human Interface Device.

MSC: Mass Storage Class

• USBH_MSC_Initialize — Callback function called when Mass Storage Device was enumerated and is ready.
• USBH_MSC_Uninitialize — Callback function called when Mass Storage Device was disconnected.
• USBH_MSC_GetDevice — Get Device instance of Mass Storage Device.
• USBH_MSC_GetStatus — Get status of Mass Storage Device.
• USBH_MSC_Read — Read requested number of blocks from Mass Storage Device.
• USBH_MSC_Write — Write requested number of blocks to Mass Storage Device.
• USBH_MSC_ReadCapacity — Read capacity of Mass Storage Device.

Custom Class

• USBH_CustomClass_GetDevice — Get Device instance of Custom Class Device.
• USBH_CustomClass_GetStatus — Get status of Custom Class Device.
• USBH_CustomClass_Configure — Callback function called when custom class device is connected and needs to configure resources used by custom class device instance.
• USBH_CustomClass_Unconfigure — Callback function called when custom class device is disconnected and needs to de-configure resources used by custom class device instance.
• USBH_CustomClass_Initialize — Callback function called when custom class device is connected and needs to initialize custom class device instance.
• USBH_CustomClass_Uninitialize — Callback function called when custom class device is disconnected and needs to de-initialize custom class device instance.
• USBH_PipeCreate — Create Pipe.
• USBH_PipeRegisterCallback — Register a callback for Pipe events.
• USBH_PipeUpdate — Update Pipe.
• USBH_PipeDelete — Delete Pipe.
• USBH_PipeReset — Reset Pipe (reset data toggle)
• USBH_PipeReceive — Receive data on Pipe.
• USBH_PipeReceiveGetResult — Get result of receive data operation on Pipe.
• USBH_PipeSend — Send data on Pipe.
• USBH_PipeSendGetResult — Get result of send data operation on Pipe.
• USBH_PipeAbort — Abort send/receive operation on Pipe.
• USBH_ControlTransfer — Do a Control Transfer on Default Pipe.
• USBH_DeviceRequest_GetStatus — Standard Device Request on Default Pipe - GET_STATUS.
• USBH_DeviceRequest_ClearFeature — Standard Device Request on Default Pipe - CLEAR_FEATURE.
• USBH_DeviceRequest_SetFeature — Standard Device Request on Default Pipe - SET_FEATURE.
• USBH_DeviceRequest_SetAddress — Standard Device Request on Default Pipe - SET_ADDRESS.
• USBH_DeviceRequest_GetDescriptor — Standard Device Request on Default Pipe - GET_DESCRIPTOR.
• USBH_DeviceRequest_SetDescriptor — Standard Device Request on Default Pipe - SET_DESCRIPTOR.
• USBH_DeviceRequest_GetConfiguration — Standard Device Request on Default Pipe - GET_CONFIGURATION.
• USBH_DeviceRequest_SetConfiguration — Standard Device Request on Default Pipe - SET_CONFIGURATION.
• USBH_DeviceRequest_GetInterface — Standard Device Request on Default Pipe - GET_INTERFACE.
• USBH_DeviceRequest_SetInterface — Standard Device Request on Default Pipe - SET_INTERFACE.
• USBH_DeviceRequest_SynchFrame — Standard Device Request on Default Pipe - SYNCH_FRAME.