User API reference of the USB Device Core. More...

Functions
usbStatus	USBD_Initialize (uint8_t device)
	Initialize USB Device stack and controller.

usbStatus	USBD_Uninitialize (uint8_t device)
	De-initialize USB Device stack and controller.

usbStatus	USBD_Connect (uint8_t device)
	Activate pull-up on D+ or D- line to signal USB Device connection on USB Bus.

usbStatus	USBD_Disconnect (uint8_t device)
	Disconnect USB Device from USB Bus.

bool	USBD_Configured (uint8_t device)
	Return USB Device configuration status.

usbdRequestStatus	USBD_Devicen_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET setup_packet, uint8_t buf, int32_t len)
	Callback function called when Device received SETUP PACKET on Control Endpoint 0.

void	USBD_Devicen_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet)
	Callback function called when SETUP PACKET was processed by USB library.

usbdRequestStatus	USBD_Devicen_Endpoint0_OutDataReceived (uint32_t len)
	Callback function called when Device received OUT DATA on Control Endpoint 0.

usbdRequestStatus	USBD_Devicen_Endpoint0_InDataSent (uint32_t len)
	Callback function called when Device sent IN DATA on Control Endpoint 0.

void	USBD_Devicen_Initialize (void)
	Called during USBD_Initialize to initialize the USB Device.

void	USBD_Devicen_Uninitialize (void)
	Called during USBD_Uninitialize to de-initialize the USB Device.

void	USBD_Devicen_EventReset (void)
	Device Reset Event handling.

Description

User API reference of the USB Device Core.

For a general function overview refer to the section Core.

Function Documentation

bool USBD_Configured ( uint8_t device )

Return USB Device configuration status.

Parameters

[in] device index of USB Device.

Returns: true device is in configured state and ready to communicate.; false device is not configured and not ready to communicate.

The function USBD_Configured retrieves the configuration status of the USB Device. It determines whether the USB Device has been configured and is ready to communicate.

The argument device specifies the instance of the USB Device.

usbStatus USBD_Connect ( uint8_t device )

Activate pull-up on D+ or D- line to signal USB Device connection on USB Bus.

Parameters

[in] device index of USB Device.

Returns: status code that indicates the execution status of the function as defined with usbStatus.

The function USBD_Connect connects the USB Device to the USB Bus. This typically initiates the enumeration on the USB Host side for the USB Device.

The argument device specifies the instance of the USB Device.

Code Example

#include "cmsis_os.h"
#include "rl_usb.h"
  
int main (void) {
  ...
  USBD_Initialize (0);       // USB Device 0 Initialization
  USBD_Connect    (0);       // USB Device 0 Connect       
  while (1) {                // Loop forever               
  ...
  }
}

usbdRequestStatus USBD_Devicen_Endpoint0_InDataSent ( uint32_t len )

Callback function called when Device sent IN DATA on Control Endpoint 0.

Parameters

[in] len number of sent data bytes.

Returns: usbdRequestStatus enumerator value indicating the function execution status; usbdRequestNotProcessed:request was not processed; processing will be done by USB library; usbdRequestOK: request was processed successfully (return ACK); usbdRequestStall: request was processed but is not supported (stall Endpoint 0); usbdRequestNAK: request was processed but the device is busy (return NAK)

The callback function USBD_Devicen_Endpoint0_InDataSent is called when the USB Device sent IN DATA on Control Endpoint 0.

The argument len specifies the number of sent data bytes.

This function can be modified in the user code template file USBD_User_Device_n.c.

usbdRequestStatus USBD_Devicen_Endpoint0_OutDataReceived ( uint32_t len )

Callback function called when Device received OUT DATA on Control Endpoint 0.

Parameters

[in] len number of received data bytes.

Returns: usbdRequestStatus enumerator value indicating the function execution status; usbdRequestNotProcessed:request was not processed; processing will be done by USB library; usbdRequestOK: request was processed successfully (send Zero-Length Packet); usbdRequestStall: request was processed but is not supported (stall Endpoint 0); usbdRequestNAK: request was processed but the device is busy (return NAK)

The callback function USBD_Devicen_Endpoint0_OutDataReceived is called when the USB Device received an OUT DATA on Control Endpoint 0.

The argument len specifies the number of received data bytes.

This function can be modified in the user code template file USBD_User_Device_n.c.

void USBD_Devicen_Endpoint0_SetupPacketProcessed ( const USB_SETUP_PACKET * setup_packet )

Callback function called when SETUP PACKET was processed by USB library.

Parameters

[in] setup_packet pointer to processed setup packet.

Returns: none.

The callback function USBD_Devicen_Endpoint0_SetupPacketProcessed is called when a SETUP PACKET was processed by the USB library.

The argument setup_packet is a pointer to the processed setup packet.

This function can be modified in the user code template file USBD_User_Device_n.c.

Code Example

void USBD_Device0_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet) {
 
  switch (setup_packet->bmRequestType.Type) {
    case USB_REQUEST_STANDARD:
      break;
    case USB_REQUEST_CLASS:
      break;
    case USB_REQUEST_VENDOR:
      break;
    case USB_REQUEST_RESERVED:
      break;
  }
}

usbdRequestStatus USBD_Devicen_Endpoint0_SetupPacketReceived	(	const USB_SETUP_PACKET *	setup_packet,
		uint8_t **	buf,
		int32_t *	len
	)

Callback function called when Device received SETUP PACKET on Control Endpoint 0.

Parameters

[in]	setup_packet	pointer to received setup packet.
[out]	buf	pointer to data buffer used for data stage requested by setup packet.
[out]	len	pointer to number of data bytes in data stage requested by setup packet.

Returns: usbdRequestStatus enumerator value indicating the function execution status; usbdRequestNotProcessed:request was not processed; processing will be done by USB library; usbdRequestOK: request was processed successfully (send Zero-Length Packet if no data stage); usbdRequestStall: request was processed but is not supported (stall Endpoint 0)

The callback function USBD_Devicen_Endpoint0_SetupPacketReceived is called when the USB Device Instance n received a SETUP PACKET on Control Endpoint 0.

The argument setup_packet is a pointer to the received setup packet.

The argument buf is a pointer to the data buffer that is used for data stage requested by setup packet.

The argument len is a pointer to the number of data bytes in the data stage requested by setup packet.

This function can be modified in the user code template file USBD_User_Device_n.c.

Code Example

usbdRequestStatus USBD_Device0_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, int32_t *len) {
 
  switch (setup_packet->bmRequestType.Type) {
    case USB_REQUEST_STANDARD:
      if ((setup_packet->bmRequestType.Dir       == USB_REQUEST_DEVICE_TO_HOST) && 
          (setup_packet->bmRequestType.Recipient == USB_REQUEST_TO_DEVICE     ) && 
          (setup_packet->bRequest                == USB_REQUEST_GET_DESCRIPTOR) && 
          (setup_packet->wValueH                 == USB_DEVICE_DESCRIPTOR_TYPE) && 
          (setup_packet->wIndex                  == 0                         )) {
        *buf = (uint8_t *)device%Instance%_dev_desc;
        *len = sizeof    (device%Instance%_dev_desc);
        return usbdRequestOK;
      }
      break;
    case USB_REQUEST_CLASS:
      break;
    case USB_REQUEST_VENDOR:
      break;
    case USB_REQUEST_RESERVED:
      break;
  }
 
  return usbdRequestNotProcessed;
}

void USBD_Devicen_EventReset ( void )

Device Reset Event handling.

Returns: none.

Use the function USBD_Devicen_EventReset to specify custom USB Device reset event handling. This function can be found in the user code template file USBD_User_Device_n.c.

void USBD_Devicen_Initialize ( void )

Called during USBD_Initialize to initialize the USB Device.

Returns: none.

If available, the function USBD_Devicen_Initialize is called automatically upon initialization of the USB Device and needs no invocation in the user code. Modify this function for custom USB Device handling. This function can be modified in the user code template file USBD_User_Device_n.c.

Code Example

#include "rl_usb.h"
 
int main (void)  {
  ..
  USBD_Initialize (0);   // USB Device 0 Initialization calls USBD_Devicen_Initialize() automatically
  USBD_Connect (0);      // USB Device 0 Connect
  ..
}

void USBD_Devicen_Uninitialize ( void )

Called during USBD_Uninitialize to de-initialize the USB Device.

Returns: none.

If available, the function USBD_Devicen_Uninitialize is called automatically upon un-initialization of the USB Device and needs no invocation in the user code. Modify this function for custom USB Device handling. This function can be found in the user code template file USBD_User_Device_n.c.

Code Example

#include "rl_usb.h"
 
int main (void)  {
  ..
  USBD_Initialize (0);   // USB Device 0 Initialization 
  ..
  USBD_Uninitialize (0); // USB Device 0 Un-Initialization calls USBD_Devicen_Uninitialize() automatically
  ..
}

usbStatus USBD_Disconnect ( uint8_t device )

Disconnect USB Device from USB Bus.

Parameters

[in] device index of USB Device.

Returns: status code that indicates the execution status of the function as defined with usbStatus.

The function USBD_Disconnect disconnects the USB Device from the USB Bus. After executing this function the USB Device can no longer be accessed from the USB Host.

The argument device specifies the instance of the USB Device.

usbStatus USBD_Initialize ( uint8_t device )

Initialize USB Device stack and controller.

Parameters

[in] device index of USB Device.

Returns: status code that indicates the execution status of the function as defined with usbStatus.

The function USBD_Initialize initializes the USB Device Controller Core and Hardware Driver (such as the USB clock and pins). It starts all the tasks and sets up the main USB interrupt service routine. In any application, the USBD_Initialize function must be called before invoking any other USB Device function. The function does not initialize any non-USB hardware features.

The argument device specifies the instance of the USB Device.

Code Example

#include "cmsis_os.h"
#include "rl_usb.h"
  
int main (void) {
  ...
  USBD_Initialize (0);       // USB Device 0 Initialization
  USBD_Connect    (0);       // USB Device 0 Connect       
  while (1) {                // Loop forever               
  ...
  }
}

usbStatus USBD_Uninitialize ( uint8_t device )

De-initialize USB Device stack and controller.

Parameters

[in] device index of USB Device.

Returns: status code that indicates the execution status of the function as defined with usbStatus.

De-initialize the USB Device Controller Core and Hardware Driver. Invoke this function when USB is not to be used any more.

The argument device specifies the instance of the USB Device.

Functions

Description

Function Documentation