USB Component  Version 6.13.6
MDK Middleware for USB Device and Host Communication
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
USBH_CDC_ACM: Communication Device Clas ACM Functions

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

Functions

__STATIC_INLINE void EvrUSBH_CDC_ACM_Configure (uint8_t instance)
 Event on internal operation CDC ACM device configuration start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_ConfigureFailed (usbStatus error)
 Event on internal operation CDC ACM device configuration failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_Unconfigure (uint8_t instance)
 Event on internal operation CDC ACM device unconfigure start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_UnconfigureFailed (uint8_t instance, usbStatus error)
 Event on internal operation CDC ACM device uninitialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_Initialize (uint8_t instance)
 Event on internal operation CDC ACM device initialization start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_InitializeFailed (uint8_t instance, usbStatus error)
 Event on internal operation CDC ACM device initialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_OnInitialize (uint8_t instance)
 Event on USBH_CDC_ACM_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_Uninitialize (uint8_t instance)
 Event on internal operation CDC ACM device uninitialization start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_UninitializeFailed (uint8_t instance, usbStatus error)
 Event on internal operation CDC ACM device uninitialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_OnUninitialize (uint8_t instance)
 Event on USBH_CDC_ACM_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetDevice (uint8_t instance, uint8_t device)
 Event on USBH_CDC_ACM_GetDevice finished (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetStatus (uint8_t instance, uint8_t status)
 Event on USBH_CDC_ACM_GetStatus finished (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_Send (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_Send start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendFailed (uint8_t instance, uint32_t num, usbStatus error)
 Event on USBH_CDC_ACM_Send failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendDone (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_Send finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetTxCount (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_GetTxCount finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_Receive (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_Receive start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_ReceiveFailed (uint8_t instance, uint32_t num, usbStatus error)
 Event on USBH_CDC_ACM_Receive failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_ReceiveDone (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_Receive finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetRxCount (uint8_t instance, uint32_t num)
 Event on USBH_CDC_ACM_GetRxCount finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetLineCoding (uint8_t instance, uint32_t rate)
 Event on USBH_CDC_ACM_SetLineCoding start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetLineCodingFailed (uint8_t instance, uint32_t rate, usbStatus error)
 Event on USBH_CDC_ACM_SetLineCoding failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetLineCodingFailed (uint8_t instance, uint32_t rate, usbStatus error)
 Event on USBH_CDC_ACM_GetLineCoding failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetLineCoding (uint8_t instance, uint32_t rate)
 Event on USBH_CDC_ACM_GetLineCoding finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetControlLineState (uint8_t instance, uint8_t dtr, uint8_t rts)
 Event on USBH_CDC_ACM_SetControlLineState start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetControlLineStateFailed (uint8_t instance, uint8_t dtr, uint8_t rts, usbStatus error)
 Event on USBH_CDC_ACM_SetControlLineState failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_OnNotify (uint8_t instance, uint16_t state)
 Event on USBH_CDC_ACM_Notify user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendBreak (uint8_t instance, uint16_t duration)
 Event on USBH_CDC_ACM_SendBreak start (API) More...
 
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendBreakFailed (uint8_t instance, uint16_t duration, usbStatus error)
 Event on USBH_CDC_ACM_SendBreak failed (Error) More...
 

Description

Events generated by USB Host - Communication Device Class ACM functions.

Function Documentation

__STATIC_INLINE void EvrUSBH_CDC_ACM_Configure ( uint8_t  instance)

Event on internal operation CDC ACM device configuration start (Operation)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_ConfigureFailed ( usbStatus  error)

Event on internal operation CDC ACM device configuration failed (Error)

Parameters
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetDevice ( uint8_t  instance,
uint8_t  device 
)

Event on USBH_CDC_ACM_GetDevice finished (API)

Parameters
instanceinstance of CDC ACM device
devicedevice index
  • value <= 127: index of Device
  • value == 255: non-existing Device index
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetLineCoding ( uint8_t  instance,
uint32_t  rate 
)

Event on USBH_CDC_ACM_GetLineCoding finished successfully (API)

Parameters
instanceinstance of CDC ACM device
ratedata terminal rate in bits per second
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetLineCodingFailed ( uint8_t  instance,
uint32_t  rate,
usbStatus  error 
)

Event on USBH_CDC_ACM_GetLineCoding failed (Error)

Parameters
instanceinstance of CDC ACM device
ratedata terminal rate in bits per second
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetRxCount ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_GetRxCount finished successfully (API)

Parameters
instanceinstance of CDC ACM device
numnumber of successfully received data bytes
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetStatus ( uint8_t  instance,
uint8_t  status 
)

Event on USBH_CDC_ACM_GetStatus finished (API)

Parameters
instanceinstance of CDC ACM device
statusdevice status usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_GetTxCount ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_GetTxCount finished successfully (API)

Parameters
instanceinstance of CDC ACM device
numnumber of successfully sent data bytes
__STATIC_INLINE void EvrUSBH_CDC_ACM_Initialize ( uint8_t  instance)

Event on internal operation CDC ACM device initialization start (Operation)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_InitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation CDC ACM device initialization failed (Error)

Parameters
instanceinstance of CDC ACM device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_OnInitialize ( uint8_t  instance)

Event on USBH_CDC_ACM_Initialize user callback function start (API)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_OnNotify ( uint8_t  instance,
uint16_t  state 
)

Event on USBH_CDC_ACM_Notify user callback function start (API)

Parameters
instanceinstance of CDC ACM device
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 EvrUSBH_CDC_ACM_OnUninitialize ( uint8_t  instance)

Event on USBH_CDC_ACM_Uninitialize user callback function start (API)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_Receive ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_Receive start (API)

Parameters
instanceinstance of CDC ACM device
nummaximum number of bytes to receive
__STATIC_INLINE void EvrUSBH_CDC_ACM_ReceiveDone ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_Receive finished successfully (Detail)

Parameters
instanceinstance of CDC ACM device
nummaximum number of bytes to receive
__STATIC_INLINE void EvrUSBH_CDC_ACM_ReceiveFailed ( uint8_t  instance,
uint32_t  num,
usbStatus  error 
)

Event on USBH_CDC_ACM_Receive failed (Error)

Parameters
instanceinstance of CDC ACM device
nummaximum number of bytes to receive
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_Send ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_Send start (API)

Parameters
instanceinstance of CDC ACM device
numnumber of bytes to send
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendBreak ( uint8_t  instance,
uint16_t  duration 
)

Event on USBH_CDC_ACM_SendBreak start (API)

Parameters
instanceinstance of CDC ACM device
durationduration of break (in milliseconds):
  • value = 0xFFFF: indefinite
  • value = 0: immediate
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendBreakFailed ( uint8_t  instance,
uint16_t  duration,
usbStatus  error 
)

Event on USBH_CDC_ACM_SendBreak failed (Error)

Parameters
instanceinstance of CDC ACM device
durationduration of break (in milliseconds):
  • value = 0xFFFF: indefinite
  • value = 0: immediate
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendDone ( uint8_t  instance,
uint32_t  num 
)

Event on USBH_CDC_ACM_Send finished successfully (Detail)

Parameters
instanceinstance of CDC ACM device
numnumber of bytes to send
__STATIC_INLINE void EvrUSBH_CDC_ACM_SendFailed ( uint8_t  instance,
uint32_t  num,
usbStatus  error 
)

Event on USBH_CDC_ACM_Send failed (Error)

Parameters
instanceinstance of CDC ACM device
numnumber of bytes to send
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetControlLineState ( uint8_t  instance,
uint8_t  dtr,
uint8_t  rts 
)

Event on USBH_CDC_ACM_SetControlLineState start (API)

Parameters
instanceinstance of CDC ACM device
dtrDTR control line state
rtsRTS control line state
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetControlLineStateFailed ( uint8_t  instance,
uint8_t  dtr,
uint8_t  rts,
usbStatus  error 
)

Event on USBH_CDC_ACM_SetControlLineState failed (Error)

Parameters
instanceinstance of CDC ACM device
dtrDTR control line state
rtsRTS control line state
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetLineCoding ( uint8_t  instance,
uint32_t  rate 
)

Event on USBH_CDC_ACM_SetLineCoding start (API)

Parameters
instanceinstance of CDC ACM device
ratedata terminal rate in bits per second
__STATIC_INLINE void EvrUSBH_CDC_ACM_SetLineCodingFailed ( uint8_t  instance,
uint32_t  rate,
usbStatus  error 
)

Event on USBH_CDC_ACM_SetLineCoding failed (Error)

Parameters
instanceinstance of CDC ACM device
ratedata terminal rate in bits per second
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_Unconfigure ( uint8_t  instance)

Event on internal operation CDC ACM device unconfigure start (Operation)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_UnconfigureFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation CDC ACM device uninitialization failed (Error)

Parameters
instanceinstance of CDC ACM device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_CDC_ACM_Uninitialize ( uint8_t  instance)

Event on internal operation CDC ACM device uninitialization start (Operation)

Parameters
instanceinstance of CDC ACM device
__STATIC_INLINE void EvrUSBH_CDC_ACM_UninitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation CDC ACM device uninitialization failed (Error)

Parameters
instanceinstance of CDC ACM device
errorerror code usbStatus