USB Component  Version 6.17.0
MDK Middleware for USB Device and Host Communication
USBD_CustomClass: Custom Class Functions

Events generated by USB Device - Custom Class functions. More...

Functions

__STATIC_INLINE void EvrUSBD_CC_OnInitialize (uint8_t n)
 Event on USBD_CustomClassn_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnUninitialize (uint8_t n)
 Event on USBD_CustomClassn_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnReset (uint8_t n)
 Event on USBD_CustomClassn_Reset user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpointStart (uint8_t n, uint8_t ep_addr)
 Event on USBD_CustomClassn_EndpointStart user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpointStop (uint8_t n, uint8_t ep_addr)
 Event on USBD_CustomClassn_EndpointStop user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketReceived (uint8_t n, usbdRequestStatus result)
 Event on USBD_CustomClassn_Endpoint0_SetupPacketReceived user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketReceivedDetail (uint8_t n, const void *setup_packet, uint32_t len)
 Event on USBD_CustomClassn_Endpoint0_SetupPacketReceived user callback function start (Detail) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketProcessed (uint8_t n)
 Event on USBD_CustomClassn_Endpoint0_SetupPacketProcessed user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketProcessedDetail (uint8_t n, const void *setup_packet)
 Event on USBD_CustomClassn_Endpoint0_SetupPacketProcessed user callback function start (Detail) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0OutDataReceived (uint8_t n, uint32_t len, usbdRequestStatus result)
 Event on USBD_CustomClassn_Endpoint0_OutDataReceived user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0InDataSent (uint8_t n, uint32_t len, usbdRequestStatus result)
 Event on USBD_CustomClassn_Endpoint0_InDataSent user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CC_OnEndpointmEvent (uint8_t n, uint8_t ep_num, uint32_t event)
 Event on USBD_CustomClassn_Endpoint1_Event user callback function start (API) More...
 

Description

Events generated by USB Device - Custom Class functions.

Function Documentation

◆ EvrUSBD_CC_OnInitialize()

__STATIC_INLINE void EvrUSBD_CC_OnInitialize ( uint8_t  n)

Event on USBD_CustomClassn_Initialize user callback function start (API)

Parameters
ninstance of custom class

◆ EvrUSBD_CC_OnUninitialize()

__STATIC_INLINE void EvrUSBD_CC_OnUninitialize ( uint8_t  n)

Event on USBD_CustomClassn_Uninitialize user callback function start (API)

Parameters
ninstance of custom class

◆ EvrUSBD_CC_OnReset()

__STATIC_INLINE void EvrUSBD_CC_OnReset ( uint8_t  n)

Event on USBD_CustomClassn_Reset user callback function start (API)

Parameters
ninstance of custom class

◆ EvrUSBD_CC_OnEndpointStart()

__STATIC_INLINE void EvrUSBD_CC_OnEndpointStart ( uint8_t  n,
uint8_t  ep_addr 
)

Event on USBD_CustomClassn_EndpointStart user callback function start (API)

Parameters
ninstance of custom class
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction

◆ EvrUSBD_CC_OnEndpointStop()

__STATIC_INLINE void EvrUSBD_CC_OnEndpointStop ( uint8_t  n,
uint8_t  ep_addr 
)

Event on USBD_CustomClassn_EndpointStop user callback function start (API)

Parameters
ninstance of custom class
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction

◆ EvrUSBD_CC_OnEndpoint0SetupPacketReceived()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketReceived ( uint8_t  n,
usbdRequestStatus  result 
)

Event on USBD_CustomClassn_Endpoint0_SetupPacketReceived user callback function finished (API)

Parameters
ninstance of custom class
resultenumerator value usbdRequestStatus 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)

◆ EvrUSBD_CC_OnEndpoint0SetupPacketReceivedDetail()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketReceivedDetail ( uint8_t  n,
const void *  setup_packet,
uint32_t  len 
)

Event on USBD_CustomClassn_Endpoint0_SetupPacketReceived user callback function start (Detail)

Parameters
ninstance of custom class
setup_packetreceived setup packet content
lennumber of data bytes in data stage that were provided by the user in a callback

◆ EvrUSBD_CC_OnEndpoint0SetupPacketProcessed()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketProcessed ( uint8_t  n)

Event on USBD_CustomClassn_Endpoint0_SetupPacketProcessed user callback function finished (API)

Parameters
ninstance of custom class

◆ EvrUSBD_CC_OnEndpoint0SetupPacketProcessedDetail()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0SetupPacketProcessedDetail ( uint8_t  n,
const void *  setup_packet 
)

Event on USBD_CustomClassn_Endpoint0_SetupPacketProcessed user callback function start (Detail)

Parameters
ninstance of custom class
setup_packetprocessed setup packet content

◆ EvrUSBD_CC_OnEndpoint0OutDataReceived()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0OutDataReceived ( uint8_t  n,
uint32_t  len,
usbdRequestStatus  result 
)

Event on USBD_CustomClassn_Endpoint0_OutDataReceived user callback function finished (API)

Parameters
ninstance of custom class
lennumber of received data bytes
resultenumerator value usbdRequestStatus 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)

◆ EvrUSBD_CC_OnEndpoint0InDataSent()

__STATIC_INLINE void EvrUSBD_CC_OnEndpoint0InDataSent ( uint8_t  n,
uint32_t  len,
usbdRequestStatus  result 
)

Event on USBD_CustomClassn_Endpoint0_InDataSent user callback function finished (API)

Parameters
ninstance of custom class
lennumber of sent data bytes
resultenumerator value usbdRequestStatus 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)

◆ EvrUSBD_CC_OnEndpointmEvent()

__STATIC_INLINE void EvrUSBD_CC_OnEndpointmEvent ( uint8_t  n,
uint8_t  ep_num,
uint32_t  event 
)

Event on USBD_CustomClassn_Endpoint1_Event user callback function start (API)

Parameters
ninstance of custom class
ep_numendpoint number
eventevent on endpoint:
  • ARM_USBD_EVENT_OUT = data OUT received
  • ARM_USBD_EVENT_IN = data IN sent