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

Events generated by USB Device - Core functions. More...

Functions

__STATIC_INLINE void EvrUSBD_Core_Initialize (uint8_t device)
 Event on USBD_Initialize start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_InitializeFailed (uint8_t device, usbStatus error)
 Event on USBD_Initialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_Uninitialize (uint8_t device)
 Event on USBD_Uninitialize start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_UninitializeFailed (uint8_t device, usbStatus error)
 Event on USBD_Uninitialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_Connect (uint8_t device)
 Event on USBD_Connect start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_ConnectFailed (uint8_t device, usbStatus error)
 Event on USBD_Connect failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_Disconnect (uint8_t device)
 Event on USBD_Disconnect start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_DisconnectFailed (uint8_t device, usbStatus error)
 Event on USBD_Disconnect failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_Configured (uint8_t device, bool configured)
 Event on USBD_Configured finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_GetState (uint8_t device, USBD_STATE state)
 Event on USBD_GetState finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_SetSerialNumber (uint8_t device)
 Event on USBD_SetSerialNumber finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_SetSerialNumberFailed (uint8_t device, usbStatus error)
 Event on USBD_SetSerialNumber failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointRead (uint8_t device, uint8_t ep_addr, uint32_t len)
 Event on USBD_EndpointRead start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointReadFailed (uint8_t device, uint8_t ep_addr, usbStatus error)
 Event on USBD_EndpointRead failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointReadGetResult (uint8_t device, uint8_t ep_addr, uint32_t result)
 Event on USBD_EndpointReadGetResult finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointWrite (uint8_t device, uint8_t ep_addr, uint32_t len)
 Event on USBD_EndpointWrite start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointWriteFailed (uint8_t device, uint8_t ep_addr, usbStatus error)
 Event on USBD_EndpointWrite failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointWriteGetResult (uint8_t device, uint8_t ep_addr, uint32_t result)
 Event on USBD_EndpointWriteGetResult finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointStall (uint8_t device, uint8_t ep_addr, bool stall)
 Event on USBD_EndpointStall start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointStallFailed (uint8_t device, uint8_t ep_addr, bool stall, usbStatus error)
 Event on USBD_EndpointStall failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointAbort (uint8_t device, uint8_t ep_addr)
 Event on USBD_EndpointAbort start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_EndpointAbortFailed (uint8_t device, uint8_t ep_addr, usbStatus error)
 Event on USBD_EndpointAbort failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ConfigureEp0 (uint8_t device)
 Event on internal operation configuration of Endpoint 0 start (Operation) More...
 
__STATIC_INLINE void EvrUSBD_Core_ConfigureEp0Failed (uint8_t device, uint8_t ep_addr, usbStatus error)
 Event on internal operation configuration of Endpoint 0 failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReadSetupPacket (uint8_t device, const void *setup_packet)
 Event on internal operation read of setup packet finished (Detail) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReadSetupPacketFailed (uint8_t device, usbStatus error)
 Event on internal operation read of setup packet failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqGetStatusFailed (uint8_t device)
 Event on internal operation Control Endpoint request Get Status failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqSetClrFeatureFailed (uint8_t device)
 Event on internal operation Control Endpoint request Set/Clear Feature failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqSetAddressFailed (uint8_t device)
 Event on internal operation Control Endpoint request Set Address failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqGetDescriptorFailed (uint8_t device)
 Event on internal operation Control Endpoint request Get Descriptor failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqGetMSDescriptorFailed (uint8_t device)
 Event on internal operation Control Endpoint request Get Microsoft Descriptor failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqGetConfigurationFailed (uint8_t device)
 Event on internal operation Control Endpoint request Get Configuration failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqSetConfigurationFailed (uint8_t device)
 Event on internal operation Control Endpoint request Set Configuration failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqGetInterfaceFailed (uint8_t device)
 Event on internal operation Control Endpoint request Get Interface failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_ReqSetInterfaceFailed (uint8_t device)
 Event on internal operation Control Endpoint request Set Interface failed (Error) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnInitialize (uint8_t n)
 Event on USBD_Devicen_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnUninitialize (uint8_t n)
 Event on USBD_Devicen_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnVbusChanged (uint8_t n, bool level)
 Event on USBD_Devicen_VbusChanged user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnReset (uint8_t n)
 Event on USBD_Devicen_Reset user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnHighSpeedActivated (uint8_t n)
 Event on USBD_Devicen_HighSpeedActivated user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnSuspended (uint8_t n)
 Event on USBD_Devicen_Suspended user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnResumed (uint8_t n)
 Event on USBD_Devicen_Resumed user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnConfigurationChanged (uint8_t n, uint8_t configuration)
 Event on USBD_Devicen_ConfigurationChanged user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnEnableRemoteWakeup (uint8_t n)
 Event on USBD_Devicen_EnableRemoteWakeup user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnDisableRemoteWakeup (uint8_t n)
 Event on USBD_Devicen_DisableRemoteWakeup user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketReceived (uint8_t n, usbdRequestStatus result)
 Event on USBD_Devicen_Endpoint0_SetupPacketReceived user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketReceivedDetail (uint8_t n, const void *setup_packet, uint32_t len)
 Event on USBD_Devicen_Endpoint0_SetupPacketReceived user callback function finished (Detail) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketProcessed (uint8_t n)
 Event on USBD_Devicen_Endpoint0_SetupPacketProcessed user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketProcessedDetail (uint8_t n, const void *setup_packet)
 Event on USBD_Devicen_Endpoint0_SetupPacketProcessed user callback function finished (Detail) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnOutDataReceived (uint8_t n, uint32_t len, usbdRequestStatus result)
 Event on USBD_Devicen_Endpoint0_OutDataReceived user callback function finished (API) More...
 
__STATIC_INLINE void EvrUSBD_Core_OnInDataSent (uint8_t n, uint32_t len, usbdRequestStatus result)
 Event on USBD_Devicen_Endpoint0_InDataSent user callback function finished (API) More...
 

Description

Events generated by USB Device - Core functions.

Function Documentation

__STATIC_INLINE void EvrUSBD_Core_Configured ( uint8_t  device,
bool  configured 
)

Event on USBD_Configured finished (API)

Parameters
devicedevice index
configuredconfiguration state
  • false: not configured
  • true: configured
__STATIC_INLINE void EvrUSBD_Core_ConfigureEp0 ( uint8_t  device)

Event on internal operation configuration of Endpoint 0 start (Operation)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ConfigureEp0Failed ( uint8_t  device,
uint8_t  ep_addr,
usbStatus  error 
)

Event on internal operation configuration of Endpoint 0 failed (Error)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_Connect ( uint8_t  device)

Event on USBD_Connect start (API)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ConnectFailed ( uint8_t  device,
usbStatus  error 
)

Event on USBD_Connect failed (Error)

Parameters
devicedevice index
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_Disconnect ( uint8_t  device)

Event on USBD_Disconnect start (API)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_DisconnectFailed ( uint8_t  device,
usbStatus  error 
)

Event on USBD_Disconnect failed (Error)

Parameters
devicedevice index
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_EndpointAbort ( uint8_t  device,
uint8_t  ep_addr 
)

Event on USBD_EndpointAbort start (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
__STATIC_INLINE void EvrUSBD_Core_EndpointAbortFailed ( uint8_t  device,
uint8_t  ep_addr,
usbStatus  error 
)

Event on USBD_EndpointAbort failed (Error)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_EndpointRead ( uint8_t  device,
uint8_t  ep_addr,
uint32_t  len 
)

Event on USBD_EndpointRead start (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
lenmaximum number of bytes to receive
__STATIC_INLINE void EvrUSBD_Core_EndpointReadFailed ( uint8_t  device,
uint8_t  ep_addr,
usbStatus  error 
)

Event on USBD_EndpointRead failed (Error)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_EndpointReadGetResult ( uint8_t  device,
uint8_t  ep_addr,
uint32_t  result 
)

Event on USBD_EndpointReadGetResult finished (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
resultnumber of bytes received
__STATIC_INLINE void EvrUSBD_Core_EndpointStall ( uint8_t  device,
uint8_t  ep_addr,
bool  stall 
)

Event on USBD_EndpointStall start (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
stalloperation
  • false: clear
  • true: set
__STATIC_INLINE void EvrUSBD_Core_EndpointStallFailed ( uint8_t  device,
uint8_t  ep_addr,
bool  stall,
usbStatus  error 
)

Event on USBD_EndpointStall failed (Error)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
stalloperation
  • false: clear
  • true: set
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_EndpointWrite ( uint8_t  device,
uint8_t  ep_addr,
uint32_t  len 
)

Event on USBD_EndpointWrite start (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
lenmaximum number of bytes to write
__STATIC_INLINE void EvrUSBD_Core_EndpointWriteFailed ( uint8_t  device,
uint8_t  ep_addr,
usbStatus  error 
)

Event on USBD_EndpointWrite failed (Error)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_EndpointWriteGetResult ( uint8_t  device,
uint8_t  ep_addr,
uint32_t  result 
)

Event on USBD_EndpointWriteGetResult finished (API)

Parameters
devicedevice index
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
resultnumber of bytes written
__STATIC_INLINE void EvrUSBD_Core_GetState ( uint8_t  device,
USBD_STATE  state 
)

Event on USBD_GetState finished (API)

Parameters
devicedevice index
statedevice state USBD_STATE
__STATIC_INLINE void EvrUSBD_Core_Initialize ( uint8_t  device)

Event on USBD_Initialize start (API)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_InitializeFailed ( uint8_t  device,
usbStatus  error 
)

Event on USBD_Initialize failed (Error)

Parameters
devicedevice index
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_OnConfigurationChanged ( uint8_t  n,
uint8_t  configuration 
)

Event on USBD_Devicen_ConfigurationChanged user callback function start (API)

Parameters
ndevice index
configurationcurrent configuration value
  • value = 0: not configured
  • value > 0: active configuration
__STATIC_INLINE void EvrUSBD_Core_OnDisableRemoteWakeup ( uint8_t  n)

Event on USBD_Devicen_DisableRemoteWakeup user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnEnableRemoteWakeup ( uint8_t  n)

Event on USBD_Devicen_EnableRemoteWakeup user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnHighSpeedActivated ( uint8_t  n)

Event on USBD_Devicen_HighSpeedActivated user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnInDataSent ( uint8_t  n,
uint32_t  len,
usbdRequestStatus  result 
)

Event on USBD_Devicen_Endpoint0_InDataSent user callback function finished (API)

Parameters
ndevice index
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)
__STATIC_INLINE void EvrUSBD_Core_OnInitialize ( uint8_t  n)

Event on USBD_Devicen_Initialize user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnOutDataReceived ( uint8_t  n,
uint32_t  len,
usbdRequestStatus  result 
)

Event on USBD_Devicen_Endpoint0_OutDataReceived user callback function finished (API)

Parameters
ndevice index
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)
__STATIC_INLINE void EvrUSBD_Core_OnReset ( uint8_t  n)

Event on USBD_Devicen_Reset user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnResumed ( uint8_t  n)

Event on USBD_Devicen_Resumed user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketProcessed ( uint8_t  n)

Event on USBD_Devicen_Endpoint0_SetupPacketProcessed user callback function finished (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketProcessedDetail ( uint8_t  n,
const void *  setup_packet 
)

Event on USBD_Devicen_Endpoint0_SetupPacketProcessed user callback function finished (Detail)

Parameters
ndevice index
setup_packetsetup packet content
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketReceived ( uint8_t  n,
usbdRequestStatus  result 
)

Event on USBD_Devicen_Endpoint0_SetupPacketReceived user callback function finished (API)

Parameters
ndevice index
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)
__STATIC_INLINE void EvrUSBD_Core_OnSetupPacketReceivedDetail ( uint8_t  n,
const void *  setup_packet,
uint32_t  len 
)

Event on USBD_Devicen_Endpoint0_SetupPacketReceived user callback function finished (Detail)

Parameters
ndevice index
setup_packetsetup packet content
lennumber of data bytes in data stage requested by setup packet
__STATIC_INLINE void EvrUSBD_Core_OnSuspended ( uint8_t  n)

Event on USBD_Devicen_Suspended user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnUninitialize ( uint8_t  n)

Event on USBD_Devicen_Uninitialize user callback function start (API)

Parameters
ndevice index
__STATIC_INLINE void EvrUSBD_Core_OnVbusChanged ( uint8_t  n,
bool  level 
)

Event on USBD_Devicen_VbusChanged user callback function start (API)

Parameters
ndevice index
levelcurrent VBUS level
  • true: VBUS level is high
  • false: VBUS level is low
__STATIC_INLINE void EvrUSBD_Core_ReadSetupPacket ( uint8_t  device,
const void *  setup_packet 
)

Event on internal operation read of setup packet finished (Detail)

Parameters
devicedevice index
setup_packetsetup packet content
__STATIC_INLINE void EvrUSBD_Core_ReadSetupPacketFailed ( uint8_t  device,
usbStatus  error 
)

Event on internal operation read of setup packet failed (Error)

Parameters
devicedevice index
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_ReqGetConfigurationFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Get Configuration failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqGetDescriptorFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Get Descriptor failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqGetInterfaceFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Get Interface failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqGetMSDescriptorFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Get Microsoft Descriptor failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqGetStatusFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Get Status failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqSetAddressFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Set Address failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqSetClrFeatureFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Set/Clear Feature failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqSetConfigurationFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Set Configuration failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_ReqSetInterfaceFailed ( uint8_t  device)

Event on internal operation Control Endpoint request Set Interface failed (Error)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_SetSerialNumber ( uint8_t  device)

Event on USBD_SetSerialNumber finished (API)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_SetSerialNumberFailed ( uint8_t  device,
usbStatus  error 
)

Event on USBD_SetSerialNumber failed (Error)

Parameters
devicedevice index
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_Core_Uninitialize ( uint8_t  device)

Event on USBD_Uninitialize start (API)

Parameters
devicedevice index
__STATIC_INLINE void EvrUSBD_Core_UninitializeFailed ( uint8_t  device,
usbStatus  error 
)

Event on USBD_Uninitialize failed (Error)

Parameters
devicedevice index
errorerror code usbStatus