USB Component  Version 6.10.0
MDK Middleware for USB Device and Host Communication
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
USBD_CDC: Communication Device Class Functions

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

Functions

__STATIC_INLINE void EvrUSBD_CDC_Initialize (uint8_t instance)
 Event on internal library operation CDC initialize start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_CDC_InitializeFailed (uint8_t instance, usbStatus error)
 Event on internal library operation CDC initialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_Uninitialize (uint8_t instance)
 Event on internal library operation CDC uninitialize start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_CDC_UninitializeFailed (uint8_t instance, usbStatus error)
 Event on internal library operation CDC uninitialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_Reset (uint8_t instance)
 Event on internal library operation CDC reset start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ResetFailed (uint8_t instance, usbStatus error)
 Event on internal library operation CDC reset failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnInitialize (uint8_t n)
 Event on USBD_CDCn_ACM_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnUninitialize (uint8_t n)
 Event on USBD_CDCn_ACM_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnReset (uint8_t n)
 Event on USBD_CDCn_ACM_Reset user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnSetLineCoding (uint8_t n, uint32_t rate, bool result)
 Event on USBD_CDCn_ACM_SetLineCoding user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnGetLineCoding (uint8_t n, uint32_t rate, bool result)
 Event on USBD_CDCn_ACM_GetLineCoding user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnSetControlLineState (uint8_t n, uint8_t dtr, uint8_t rts, bool result)
 Event on USBD_CDCn_ACM_SetControlLineState user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_ReadData (uint8_t instance, int32_t len, uint32_t result)
 Event on USBD_CDC_ACM_ReadData finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_ReadDataFailed (uint8_t instance, int32_t len, int32_t error)
 Event on USBD_CDC_ACM_ReadData failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_WriteData (uint8_t instance, int32_t len, uint32_t result)
 Event on USBD_CDC_ACM_WriteData finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_WriteDataFailed (uint8_t instance, int32_t len, int32_t error)
 Event on USBD_CDC_ACM_WriteData failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_GetChar (uint8_t instance, int32_t result)
 Event on USBD_CDC_ACM_GetChar finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_PutChar (uint8_t instance, int32_t result)
 Event on USBD_CDC_ACM_PutChar finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_DataAvailable (uint8_t instance, uint32_t result)
 Event on USBD_CDC_ACM_DataAvailable finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_DataAvailableFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_ACM_DataAvailable failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_Notify (uint8_t instance, uint16_t state)
 Event on USBD_CDC_ACM_Notify finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_ACM_NotifyFailed (uint8_t instance, uint16_t state, usbStatus error)
 Event on USBD_CDC_ACM_Notify failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnInitialize (uint8_t n)
 Event on USBD_CDCn_NCM_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnUninitialize (uint8_t n)
 Event on USBD_CDCn_NCM_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnReset (uint8_t n)
 Event on USBD_CDCn_NCM_Reset user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnStart (uint8_t n)
 Event on USBD_CDCn_NCM_Start user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnStop (uint8_t n)
 Event on USBD_CDCn_NCM_Stop user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthMulticastFilters (uint8_t n, bool result)
 Event on USBD_CDCn_NCM_SetEthernetMulticastFilters user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthPowerMgmtPatFilter (uint8_t n, uint16_t filter_number, bool result)
 Event on USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetEthPowerMgmtPatFilter (uint8_t n, uint16_t filter_number, bool result)
 Event on USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthernetPacketFilter (uint8_t n, uint16_t packet_filter_bitmap, bool result)
 Event on USBD_CDCn_NCM_SetEthernetPacketFilter user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetEthernetStatistic (uint8_t n, uint16_t feature_selector, bool result)
 Event on USBD_CDCn_NCM_GetEthernetStatistic user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbParameters (uint8_t n, bool result)
 Event on USBD_CDCn_NCM_GetNtbParameters user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNetAddress (uint8_t n, bool result)
 Event on USBD_CDCn_NCM_GetNetAddress user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNetAddress (uint8_t n, bool result)
 Event on USBD_CDCn_NCM_SetNetAddress user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbFormat (uint8_t n, uint16_t ntb_format, bool result)
 Event on USBD_CDCn_NCM_GetNtbFormat user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNtbFormat (uint8_t n, uint16_t ntb_format, bool result)
 Event on USBD_CDCn_NCM_SetNtbFormat user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbInputSize (uint8_t n, uint32_t ntb_input_size, bool result)
 Event on USBD_CDCn_NCM_GetNtbInputSize user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNtbInputSize (uint8_t n, uint32_t ntb_input_size, bool result)
 Event on USBD_CDCn_NCM_SetNtbInputSize user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetMaxDatagramSize (uint8_t n, uint16_t max_datagram_size, bool result)
 Event on USBD_CDCn_NCM_GetMaxDatagramSize user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetMaxDatagramSize (uint8_t n, uint16_t max_datagram_size, bool result)
 Event on USBD_CDCn_NCM_SetMaxDatagramSize user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetCrcMode (uint8_t n, uint16_t crc_mode, bool result)
 Event on USBD_CDCn_NCM_GetCrcMode user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetCrcMode (uint8_t n, uint16_t crc_mode, bool result)
 Event on USBD_CDCn_NCM_SetCrcMode user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnNTB_IN_Sent (uint8_t n)
 Event on USBD_CDCn_NCM_NTB_IN_Sent user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnNTB_OUT_Received (uint8_t n)
 Event on USBD_CDCn_NCM_NTB_OUT_Received user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_Initialize (uint8_t instance)
 Event on USBD_CDC_NCM_NTB_IN_Initialize finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_InitializeFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_Initialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_CreateNDP (uint8_t instance, uint8_t num_datagrams)
 Event on USBD_CDC_NCM_NTB_IN_CreateNDP finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_CreateNDPFailed (uint8_t instance, uint8_t num_datagrams, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_CreateNDP failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_WriteDatagram (uint8_t instance, uint32_t len)
 Event on USBD_CDC_NCM_NTB_IN_WriteDatagram finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_WriteDatagramFailed (uint8_t instance, uint32_t len, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_WriteDatagram failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_Send (uint8_t instance)
 Event on USBD_CDC_NCM_NTB_IN_Send finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_SendFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_Send failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_IsSent (uint8_t instance, uint32_t result)
 Event on USBD_CDC_NCM_NTB_IN_IsSent finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_IsSentFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_IsSent failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_IsReceived (uint8_t instance, uint32_t result)
 Event on USBD_CDC_NCM_NTB_OUT_IsReceived finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_IsReceivedFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_OUT_IsReceived failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_Release (uint8_t instance)
 Event on USBD_CDC_NCM_NTB_OUT_Release finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReleaseFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_OUT_Release failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ProcessNDP (uint8_t instance)
 Event on USBD_CDC_NCM_NTB_OUT_ProcessNDP finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ProcessNDPFailed (uint8_t instance, int32_t error)
 Event on USBD_CDC_NCM_NTB_OUT_ProcessNDP failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_GetDatagramSize (uint8_t instance, uint32_t result)
 Event on USBD_CDC_NCM_NTB_OUT_GetDatagramSize finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReadDatagram (uint8_t instance, uint32_t max_len, uint32_t result)
 Event on USBD_CDC_NCM_NTB_OUT_ReadDatagram finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReadDatagramFailed (uint8_t instance, uint32_t max_len, int32_t error)
 Event on USBD_CDC_NCM_NTB_OUT_ReadDatagram failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_RawSend (uint8_t instance, uint32_t len)
 Event on USBD_CDC_NCM_NTB_IN_RawSend finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_RawSendFailed (uint8_t instance, uint32_t len, int32_t error)
 Event on USBD_CDC_NCM_NTB_IN_RawSend failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawGetSize (uint8_t instance, uint32_t result)
 Event on USBD_CDC_NCM_NTB_OUT_RawGetSize finished (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawReceive (uint8_t instance, uint32_t max_len)
 Event on USBD_CDC_NCM_NTB_OUT_RawReceive finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawReceiveFailed (uint8_t instance, uint32_t max_len, int32_t error)
 Event on USBD_CDC_NCM_NTB_OUT_RawReceive failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_NetworkConnection (uint8_t instance, uint16_t status)
 Event on USBD_CDC_NCM_Notify_NetworkConnection finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_NetworkConnectionFailed (uint8_t instance, uint16_t status, int32_t error)
 Event on USBD_CDC_NCM_Notify_NetworkConnection failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_ConnectionSpeedChange (uint8_t instance, uint32_t us_bitrate, uint32_t ds_bitrate)
 Event on USBD_CDC_NCM_Notify_ConnectionSpeedChange finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_ConnectionSpeedChangeFailed (uint8_t instance, uint32_t us_bitrate, uint32_t ds_bitrate, int32_t error)
 Event on USBD_CDC_NCM_Notify_ConnectionSpeedChange failed (Error) More...
 

Description

Events generated by USB Device - Communication Device Class functions.

Function Documentation

__STATIC_INLINE void EvrUSBD_CDC_ACM_DataAvailable ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_CDC_ACM_DataAvailable finished successfully (API)

Parameters
instanceinstance of CDC class
resultnumber of bytes available to read
__STATIC_INLINE void EvrUSBD_CDC_ACM_DataAvailableFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_ACM_DataAvailable failed (Error)

Parameters
instanceinstance of CDC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_ACM_GetChar ( uint8_t  instance,
int32_t  result 
)

Event on USBD_CDC_ACM_GetChar finished (API)

Parameters
instanceinstance of CDC class
resultvalue of read character or no character received
  • value >= 0: value of first received unread character
  • value -1: indicates no character was received
__STATIC_INLINE void EvrUSBD_CDC_ACM_Notify ( uint8_t  instance,
uint16_t  state 
)

Event on USBD_CDC_ACM_Notify finished successfully (API)

Parameters
instanceinstance of CDC class
stateerror status and line states:
  • bit 6: bOverRun
  • bit 5: bParity
  • bit 4: bFraming
  • bit 3: bRingSignal
  • bit 2: bBreak
  • bit 1: bTxCarrier (DSR line state)
  • bit 0: bRxCarrier (DCD line state)
__STATIC_INLINE void EvrUSBD_CDC_ACM_NotifyFailed ( uint8_t  instance,
uint16_t  state,
usbStatus  error 
)

Event on USBD_CDC_ACM_Notify failed (Error)

Parameters
instanceinstance of CDC class
stateerror status and line states:
  • bit 6: bOverRun
  • bit 5: bParity
  • bit 4: bFraming
  • bit 3: bRingSignal
  • bit 2: bBreak
  • bit 1: bTxCarrier (DSR line state)
  • bit 0: bRxCarrier (DCD line state)
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnGetLineCoding ( uint8_t  n,
uint32_t  rate,
bool  result 
)

Event on USBD_CDCn_ACM_GetLineCoding user callback function finished (API)

Parameters
ninstance of CDC class
ratecurrent data terminal bit rate
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnInitialize ( uint8_t  n)

Event on USBD_CDCn_ACM_Initialize user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnReset ( uint8_t  n)

Event on USBD_CDCn_ACM_Reset user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnSetControlLineState ( uint8_t  n,
uint8_t  dtr,
uint8_t  rts,
bool  result 
)

Event on USBD_CDCn_ACM_SetControlLineState user callback function finished (API)

Parameters
ninstance of CDC class
dtrDTR control line state
rtsRTS control line state
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnSetLineCoding ( uint8_t  n,
uint32_t  rate,
bool  result 
)

Event on USBD_CDCn_ACM_SetLineCoding user callback function finished (API)

Parameters
ninstance of CDC class
raterequested data terminal bit rate
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_ACM_OnUninitialize ( uint8_t  n)

Event on USBD_CDCn_ACM_Uninitialize user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_ACM_PutChar ( uint8_t  instance,
int32_t  result 
)

Event on USBD_CDC_ACM_PutChar finished (API)

Parameters
instanceinstance of CDC class
resultvalue of accepted character or no character accepted
  • value >= 0: if character accepted for writing
  • value -1: indicates character not accepted
__STATIC_INLINE void EvrUSBD_CDC_ACM_ReadData ( uint8_t  instance,
int32_t  len,
uint32_t  result 
)

Event on USBD_CDC_ACM_ReadData finished successfully (API)

Parameters
instanceinstance of CDC class
lenmaximum number of bytes to read
resultnumber of bytes read
__STATIC_INLINE void EvrUSBD_CDC_ACM_ReadDataFailed ( uint8_t  instance,
int32_t  len,
int32_t  error 
)

Event on USBD_CDC_ACM_ReadData failed (Error)

Parameters
instanceinstance of CDC class
lenmaximum number of bytes to read
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_ACM_WriteData ( uint8_t  instance,
int32_t  len,
uint32_t  result 
)

Event on USBD_CDC_ACM_WriteData finished successfully (API)

Parameters
instanceinstance of CDC class
lenmaximum number of bytes to write
resultnumber of bytes accepted for writing
__STATIC_INLINE void EvrUSBD_CDC_ACM_WriteDataFailed ( uint8_t  instance,
int32_t  len,
int32_t  error 
)

Event on USBD_CDC_ACM_WriteData failed (Error)

Parameters
instanceinstance of CDC class
lenmaximum number of bytes to write
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_Initialize ( uint8_t  instance)

Event on internal library operation CDC initialize start (Operation)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_InitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation CDC initialize failed (Error)

Parameters
instanceinstance of CDC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_ConnectionSpeedChange ( uint8_t  instance,
uint32_t  us_bitrate,
uint32_t  ds_bitrate 
)

Event on USBD_CDC_NCM_Notify_ConnectionSpeedChange finished successfully (API)

Parameters
instanceinstance of CDC class
us_bitrateupstream bitrate
ds_bitratedownstream bitrate
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_ConnectionSpeedChangeFailed ( uint8_t  instance,
uint32_t  us_bitrate,
uint32_t  ds_bitrate,
int32_t  error 
)

Event on USBD_CDC_NCM_Notify_ConnectionSpeedChange failed (Error)

Parameters
instanceinstance of CDC class
us_bitrateupstream bitrate
ds_bitratedownstream bitrate
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_NetworkConnection ( uint8_t  instance,
uint16_t  status 
)

Event on USBD_CDC_NCM_Notify_NetworkConnection finished successfully (API)

Parameters
instanceinstance of CDC class
statusconnection status
  • value 1: connected
  • value 0: disconnected
__STATIC_INLINE void EvrUSBD_CDC_NCM_Notify_NetworkConnectionFailed ( uint8_t  instance,
uint16_t  status,
int32_t  error 
)

Event on USBD_CDC_NCM_Notify_NetworkConnection failed (Error)

Parameters
instanceinstance of CDC class
statusconnection status
  • value 1: connected
  • value 0: disconnected
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_CreateNDP ( uint8_t  instance,
uint8_t  num_datagrams 
)

Event on USBD_CDC_NCM_NTB_IN_CreateNDP finished successfully (API)

Parameters
instanceinstance of CDC class
num_datagramsmaximum number of datagrams that NDP will contain
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_CreateNDPFailed ( uint8_t  instance,
uint8_t  num_datagrams,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_CreateNDP failed (Error)

Parameters
instanceinstance of CDC class
num_datagramsmaximum number of datagrams that NDP will contain
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_Initialize ( uint8_t  instance)

Event on USBD_CDC_NCM_NTB_IN_Initialize finished successfully (API)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_InitializeFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_Initialize failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_IsSent ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_CDC_NCM_NTB_IN_IsSent finished successfully (API)

Parameters
instanceinstance of CDC class
resultNTB sending status
  • value 1: NTB was sent
  • value 0: NTB sending is in progress
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_IsSentFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_IsSent failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_RawSend ( uint8_t  instance,
uint32_t  len 
)

Event on USBD_CDC_NCM_NTB_IN_RawSend finished successfully (API)

Parameters
instanceinstance of CDC class
lensize of NTB
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_RawSendFailed ( uint8_t  instance,
uint32_t  len,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_RawSend failed (Error)

Parameters
instanceinstance of CDC class
lensize of NTB
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_Send ( uint8_t  instance)

Event on USBD_CDC_NCM_NTB_IN_Send finished successfully (API)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_SendFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_Send failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_WriteDatagram ( uint8_t  instance,
uint32_t  len 
)

Event on USBD_CDC_NCM_NTB_IN_WriteDatagram finished successfully (API)

Parameters
instanceinstance of CDC class
lennumber of bytes to write
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_IN_WriteDatagramFailed ( uint8_t  instance,
uint32_t  len,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_IN_WriteDatagram failed (Error)

Parameters
instanceinstance of CDC class
lennumber of bytes to write
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_GetDatagramSize ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_CDC_NCM_NTB_OUT_GetDatagramSize finished (API)

Parameters
instanceinstance of CDC class
resultnumber of bytes available in the datagram
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_IsReceived ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_CDC_NCM_NTB_OUT_IsReceived finished successfully (API)

Parameters
instanceinstance of CDC class
resultNTB receiving status
  • value 1: NTB was received
  • value 0: NTB reception is in progress
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_IsReceivedFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_OUT_IsReceived failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ProcessNDP ( uint8_t  instance)

Event on USBD_CDC_NCM_NTB_OUT_ProcessNDP finished successfully (API)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ProcessNDPFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_OUT_ProcessNDP failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawGetSize ( uint8_t  instance,
uint32_t  result 
)

Event on USBD_CDC_NCM_NTB_OUT_RawGetSize finished (API)

Parameters
instanceinstance of CDC class
resultnumber of bytes available in the NTB
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawReceive ( uint8_t  instance,
uint32_t  max_len 
)

Event on USBD_CDC_NCM_NTB_OUT_RawReceive finished successfully (API)

Parameters
instanceinstance of CDC class
max_lenmaximum number of bytes that buffer can accept
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_RawReceiveFailed ( uint8_t  instance,
uint32_t  max_len,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_OUT_RawReceive failed (Error)

Parameters
instanceinstance of CDC class
max_lenmaximum number of bytes that buffer can accept
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReadDatagram ( uint8_t  instance,
uint32_t  max_len,
uint32_t  result 
)

Event on USBD_CDC_NCM_NTB_OUT_ReadDatagram finished successfully (API)

Parameters
instanceinstance of CDC class
max_lenmaximum number of bytes to read
resultnumber of bytes read from the datagram
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReadDatagramFailed ( uint8_t  instance,
uint32_t  max_len,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_OUT_ReadDatagram failed (Error)

Parameters
instanceinstance of CDC class
max_lenmaximum number of bytes to read
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_Release ( uint8_t  instance)

Event on USBD_CDC_NCM_NTB_OUT_Release finished successfully (API)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_NTB_OUT_ReleaseFailed ( uint8_t  instance,
int32_t  error 
)

Event on USBD_CDC_NCM_NTB_OUT_Release failed (Error)

Parameters
instanceinstance of CDC class
errorerror code
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetCrcMode ( uint8_t  n,
uint16_t  crc_mode,
bool  result 
)

Event on USBD_CDCn_NCM_GetCrcMode user callback function finished (API)

Parameters
ninstance of CDC class
crc_modecurrent CRC mode
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetEthernetStatistic ( uint8_t  n,
uint16_t  feature_selector,
bool  result 
)

Event on USBD_CDCn_NCM_GetEthernetStatistic user callback function finished (API)

Parameters
ninstance of CDC class
feature_selectorfeature selector
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetEthPowerMgmtPatFilter ( uint8_t  n,
uint16_t  filter_number,
bool  result 
)

Event on USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter user callback function finished (API)

Parameters
ninstance of CDC class
filter_numberfilter number
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetMaxDatagramSize ( uint8_t  n,
uint16_t  max_datagram_size,
bool  result 
)

Event on USBD_CDCn_NCM_GetMaxDatagramSize user callback function finished (API)

Parameters
ninstance of CDC class
max_datagram_sizemaximum datagram size
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNetAddress ( uint8_t  n,
bool  result 
)

Event on USBD_CDCn_NCM_GetNetAddress user callback function finished (API)

Parameters
ninstance of CDC class
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbFormat ( uint8_t  n,
uint16_t  ntb_format,
bool  result 
)

Event on USBD_CDCn_NCM_GetNtbFormat user callback function finished (API)

Parameters
ninstance of CDC class
ntb_formatNTB format
  • value 0 : NTB-16
  • value 1 : NTB-32
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbInputSize ( uint8_t  n,
uint32_t  ntb_input_size,
bool  result 
)

Event on USBD_CDCn_NCM_GetNtbInputSize user callback function finished (API)

Parameters
ninstance of CDC class
ntb_input_sizemaximum NTB size
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnGetNtbParameters ( uint8_t  n,
bool  result 
)

Event on USBD_CDCn_NCM_GetNtbParameters user callback function finished (API)

Parameters
ninstance of CDC class
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnInitialize ( uint8_t  n)

Event on USBD_CDCn_NCM_Initialize user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnNTB_IN_Sent ( uint8_t  n)

Event on USBD_CDCn_NCM_NTB_IN_Sent user callback function finished (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnNTB_OUT_Received ( uint8_t  n)

Event on USBD_CDCn_NCM_NTB_OUT_Received user callback function finished (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnReset ( uint8_t  n)

Event on USBD_CDCn_NCM_Reset user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetCrcMode ( uint8_t  n,
uint16_t  crc_mode,
bool  result 
)

Event on USBD_CDCn_NCM_SetCrcMode user callback function finished (API)

Parameters
ninstance of CDC class
crc_modeCRC mode to set
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthernetPacketFilter ( uint8_t  n,
uint16_t  packet_filter_bitmap,
bool  result 
)

Event on USBD_CDCn_NCM_SetEthernetPacketFilter user callback function finished (API)

Parameters
ninstance of CDC class
packet_filter_bitmappacket filter bitmap
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthMulticastFilters ( uint8_t  n,
bool  result 
)

Event on USBD_CDCn_NCM_SetEthernetMulticastFilters user callback function finished (API)

Parameters
ninstance of CDC class
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetEthPowerMgmtPatFilter ( uint8_t  n,
uint16_t  filter_number,
bool  result 
)

Event on USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter user callback function finished (API)

Parameters
ninstance of CDC class
filter_numberfilter number
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetMaxDatagramSize ( uint8_t  n,
uint16_t  max_datagram_size,
bool  result 
)

Event on USBD_CDCn_NCM_SetMaxDatagramSize user callback function finished (API)

Parameters
ninstance of CDC class
max_datagram_sizemaximum datagram size
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNetAddress ( uint8_t  n,
bool  result 
)

Event on USBD_CDCn_NCM_SetNetAddress user callback function finished (API)

Parameters
ninstance of CDC class
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNtbFormat ( uint8_t  n,
uint16_t  ntb_format,
bool  result 
)

Event on USBD_CDCn_NCM_SetNtbFormat user callback function finished (API)

Parameters
ninstance of CDC class
ntb_formatNTB format
  • value 0 : NTB-16
  • value 1 : NTB-32
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnSetNtbInputSize ( uint8_t  n,
uint32_t  ntb_input_size,
bool  result 
)

Event on USBD_CDCn_NCM_SetNtbInputSize user callback function finished (API)

Parameters
ninstance of CDC class
ntb_input_sizemaximum NTB size
resultoperation result
  • true: request processed
  • false: request not supported or not processed
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnStart ( uint8_t  n)

Event on USBD_CDCn_NCM_Start user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnStop ( uint8_t  n)

Event on USBD_CDCn_NCM_Stop user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_NCM_OnUninitialize ( uint8_t  n)

Event on USBD_CDCn_NCM_Uninitialize user callback function start (API)

Parameters
ninstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_Reset ( uint8_t  instance)

Event on internal library operation CDC reset start (Operation)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_ResetFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation CDC reset failed (Error)

Parameters
instanceinstance of CDC class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_CDC_Uninitialize ( uint8_t  instance)

Event on internal library operation CDC uninitialize start (Operation)

Parameters
instanceinstance of CDC class
__STATIC_INLINE void EvrUSBD_CDC_UninitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation CDC uninitialize failed (Error)

Parameters
instanceinstance of CDC class
errorerror code usbStatus