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

Events generated by USB Host - Driver functions. More...

Functions

__STATIC_INLINE void EvrUSBH_Driver_Initialize (uint8_t ctrl)
 Event on ARM_USBH_Initialize finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_InitializeFailed (uint8_t ctrl, int32_t error)
 Event on ARM_USBH_Initialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_Uninitialize (uint8_t ctrl)
 Event on ARM_USBH_Uninitialize finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_UninitializeFailed (uint8_t ctrl, int32_t error)
 Event on ARM_USBH_Uninitialize failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PowerControl (uint8_t ctrl, ARM_POWER_STATE state)
 Event on ARM_USBH_PowerControl finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PowerControlFailed (uint8_t ctrl, ARM_POWER_STATE state, int32_t error)
 Event on ARM_USBH_PowerControl failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortVbusOnOff (uint8_t ctrl, uint8_t port, bool vbus)
 Event on ARM_USBH_PortVbusOnOff finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortVbusOnOffFailed (uint8_t ctrl, uint8_t port, bool vbus, int32_t error)
 Event on ARM_USBH_PortVbusOnOff failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortReset (uint8_t ctrl, uint8_t port)
 Event on ARM_USBH_PortReset finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortResetFailed (uint8_t ctrl, uint8_t port, int32_t error)
 Event on ARM_USBH_PortReset failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortSuspend (uint8_t ctrl, uint8_t port)
 Event on ARM_USBH_PortSuspend finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortSuspendFailed (uint8_t ctrl, uint8_t port, int32_t error)
 Event on ARM_USBH_PortSuspend failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortResume (uint8_t ctrl, uint8_t port)
 Event on ARM_USBH_PortResume finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortResumeFailed (uint8_t ctrl, uint8_t port, int32_t error)
 Event on ARM_USBH_PortResume failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PortGetState (uint8_t ctrl, uint8_t port, ARM_USBH_PORT_STATE state)
 Event on ARM_USBH_PortGetState finished (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeCreate (uint8_t ctrl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval, ARM_USBH_EP_HANDLE pipe_hndl)
 Event on ARM_USBH_PipeCreate finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeCreateFailed (uint8_t ctrl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)
 Event on ARM_USBH_PipeCreate failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeModify (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)
 Event on ARM_USBH_PipeModify finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeModifyFailed (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size, int32_t error)
 Event on ARM_USBH_PipeModify failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeDelete (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl)
 Event on ARM_USBH_PipeDelete finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeDeleteFailed (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, int32_t error)
 Event on ARM_USBH_PipeDelete failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeReset (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl)
 Event on ARM_USBH_PipeReset finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeResetFailed (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, int32_t error)
 Event on ARM_USBH_PipeReset failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeTransfer (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t packet, uint32_t num)
 Event on ARM_USBH_PipeTransfer finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferFailed (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t packet, uint32_t num, int32_t error)
 Event on ARM_USBH_PipeTransfer failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferGetResult (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t num)
 Event on ARM_USBH_PipeTransferGetResult finished (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferAbort (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl)
 Event on ARM_USBH_PipeTransferAbort finished successfully (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferAbortFailed (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, int32_t error)
 Event on ARM_USBH_PipeTransferAbort failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_Driver_GetFrameNumber (uint8_t ctrl, uint16_t frame_number)
 Event on ARM_USBH_GetFrameNumber finished (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_OnSignalPortEvent (uint8_t ctrl, uint8_t port, uint32_t event)
 Event on ARM_USBH_SignalPortEvent callback start (API) More...
 
__STATIC_INLINE void EvrUSBH_Driver_OnSignalPipeEvent (uint8_t ctrl, ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)
 Event on ARM_USBH_SignalPipeEvent callback start (API) More...
 

Description

Events generated by USB Host - Driver functions.

Function Documentation

__STATIC_INLINE void EvrUSBH_Driver_GetFrameNumber ( uint8_t  ctrl,
uint16_t  frame_number 
)

Event on ARM_USBH_GetFrameNumber finished (API)

Parameters
ctrlcontroller index
frame_numberframe number
__STATIC_INLINE void EvrUSBH_Driver_Initialize ( uint8_t  ctrl)

Event on ARM_USBH_Initialize finished successfully (API)

Parameters
ctrlcontroller index
__STATIC_INLINE void EvrUSBH_Driver_InitializeFailed ( uint8_t  ctrl,
int32_t  error 
)

Event on ARM_USBH_Initialize failed (Error)

Parameters
ctrlcontroller index
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_OnSignalPipeEvent ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint32_t  event 
)

Event on ARM_USBH_SignalPipeEvent callback start (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
eventpipe event USBH_pipe_events
__STATIC_INLINE void EvrUSBH_Driver_OnSignalPortEvent ( uint8_t  ctrl,
uint8_t  port,
uint32_t  event 
)

Event on ARM_USBH_SignalPortEvent callback start (API)

Parameters
ctrlcontroller index
portroot HUB port number
eventport event USBH_port_events
__STATIC_INLINE void EvrUSBH_Driver_PipeCreate ( uint8_t  ctrl,
uint8_t  dev_addr,
uint8_t  dev_speed,
uint8_t  hub_addr,
uint8_t  hub_port,
uint8_t  ep_addr,
uint8_t  ep_type,
uint16_t  ep_max_packet_size,
uint8_t  ep_interval,
ARM_USBH_EP_HANDLE  pipe_hndl 
)

Event on ARM_USBH_PipeCreate finished successfully (API)

Parameters
ctrlcontroller index
dev_addrdevice address
dev_speeddevice speed
hub_addrhub address
hub_porthub port
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
ep_typeendpoint type (ARM_USB_ENDPOINT_xxx)
ep_max_packet_sizeendpoint maximum packet size
ep_intervalendpoint polling interval
pipe_hndlpipe handle ARM_USBH_PIPE_HANDLE
__STATIC_INLINE void EvrUSBH_Driver_PipeCreateFailed ( uint8_t  ctrl,
uint8_t  dev_addr,
uint8_t  dev_speed,
uint8_t  hub_addr,
uint8_t  hub_port,
uint8_t  ep_addr,
uint8_t  ep_type,
uint16_t  ep_max_packet_size,
uint8_t  ep_interval 
)

Event on ARM_USBH_PipeCreate failed (Error)

Parameters
ctrlcontroller index
dev_addrdevice address
dev_speeddevice speed
hub_addrhub address
hub_porthub port
ep_addrendpoint address
  • ep_addr.0..3: address
  • ep_addr.7: direction
ep_typeendpoint type (ARM_USB_ENDPOINT_xxx)
ep_max_packet_sizeendpoint maximum packet size
ep_intervalendpoint polling interval
__STATIC_INLINE void EvrUSBH_Driver_PipeDelete ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl 
)

Event on ARM_USBH_PipeDelete finished successfully (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
__STATIC_INLINE void EvrUSBH_Driver_PipeDeleteFailed ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
int32_t  error 
)

Event on ARM_USBH_PipeDelete failed (Error)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PipeModify ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint8_t  dev_addr,
uint8_t  dev_speed,
uint8_t  hub_addr,
uint8_t  hub_port,
uint16_t  ep_max_packet_size 
)

Event on ARM_USBH_PipeModify finished successfully (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
dev_addrdevice address
dev_speeddevice speed
hub_addrhub address
hub_porthub port
ep_max_packet_sizeendpoint maximum packet size
__STATIC_INLINE void EvrUSBH_Driver_PipeModifyFailed ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint8_t  dev_addr,
uint8_t  dev_speed,
uint8_t  hub_addr,
uint8_t  hub_port,
uint16_t  ep_max_packet_size,
int32_t  error 
)

Event on ARM_USBH_PipeModify failed (Error)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
dev_addrdevice address
dev_speeddevice speed
hub_addrhub address
hub_porthub port
ep_max_packet_sizeendpoint maximum packet size
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PipeReset ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl 
)

Event on ARM_USBH_PipeReset finished successfully (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
__STATIC_INLINE void EvrUSBH_Driver_PipeResetFailed ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
int32_t  error 
)

Event on ARM_USBH_PipeReset failed (Error)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PipeTransfer ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint32_t  packet,
uint32_t  num 
)

Event on ARM_USBH_PipeTransfer finished successfully (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
packetpacket information
numnumber of data bytes to transfer
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferAbort ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl 
)

Event on ARM_USBH_PipeTransferAbort finished successfully (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferAbortFailed ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
int32_t  error 
)

Event on ARM_USBH_PipeTransferAbort failed (Error)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferFailed ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint32_t  packet,
uint32_t  num,
int32_t  error 
)

Event on ARM_USBH_PipeTransfer failed (Error)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
packetpacket information
numnumber of data bytes to transfer
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PipeTransferGetResult ( uint8_t  ctrl,
ARM_USBH_PIPE_HANDLE  pipe_hndl,
uint32_t  num 
)

Event on ARM_USBH_PipeTransferGetResult finished (API)

Parameters
ctrlcontroller index
pipe_hndlpipe handle
numnumber of successfully transferred data bytes
__STATIC_INLINE void EvrUSBH_Driver_PortGetState ( uint8_t  ctrl,
uint8_t  port,
ARM_USBH_PORT_STATE  state 
)

Event on ARM_USBH_PortGetState finished (API)

Parameters
ctrlcontroller index
portroot HUB port number
stateport state ARM_USBH_STATE
__STATIC_INLINE void EvrUSBH_Driver_PortReset ( uint8_t  ctrl,
uint8_t  port 
)

Event on ARM_USBH_PortReset finished successfully (API)

Parameters
ctrlcontroller index
portroot HUB port number
__STATIC_INLINE void EvrUSBH_Driver_PortResetFailed ( uint8_t  ctrl,
uint8_t  port,
int32_t  error 
)

Event on ARM_USBH_PortReset failed (Error)

Parameters
ctrlcontroller index
portroot HUB port number
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PortResume ( uint8_t  ctrl,
uint8_t  port 
)

Event on ARM_USBH_PortResume finished successfully (API)

Parameters
ctrlcontroller index
portroot HUB port number
__STATIC_INLINE void EvrUSBH_Driver_PortResumeFailed ( uint8_t  ctrl,
uint8_t  port,
int32_t  error 
)

Event on ARM_USBH_PortResume failed (Error)

Parameters
ctrlcontroller index
portroot HUB port number
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PortSuspend ( uint8_t  ctrl,
uint8_t  port 
)

Event on ARM_USBH_PortSuspend finished successfully (API)

Parameters
ctrlcontroller index
portroot HUB port number
__STATIC_INLINE void EvrUSBH_Driver_PortSuspendFailed ( uint8_t  ctrl,
uint8_t  port,
int32_t  error 
)

Event on ARM_USBH_PortSuspend failed (Error)

Parameters
ctrlcontroller index
portroot HUB port number
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PortVbusOnOff ( uint8_t  ctrl,
uint8_t  port,
bool  vbus 
)

Event on ARM_USBH_PortVbusOnOff finished successfully (API)

Parameters
ctrlcontroller index
portroot HUB port number
vbusVBUS state
  • false VBUS off
  • true VBUS on
__STATIC_INLINE void EvrUSBH_Driver_PortVbusOnOffFailed ( uint8_t  ctrl,
uint8_t  port,
bool  vbus,
int32_t  error 
)

Event on ARM_USBH_PortVbusOnOff failed (Error)

Parameters
ctrlcontroller index
portroot HUB port number
vbusVBUS state
  • false VBUS off
  • true VBUS on
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_PowerControl ( uint8_t  ctrl,
ARM_POWER_STATE  state 
)

Event on ARM_USBH_PowerControl finished successfully (API)

Parameters
ctrlcontroller index
statepower state ARM_POWER_STATE
__STATIC_INLINE void EvrUSBH_Driver_PowerControlFailed ( uint8_t  ctrl,
ARM_POWER_STATE  state,
int32_t  error 
)

Event on ARM_USBH_PowerControl failed (Error)

Parameters
ctrlcontroller index
statepower state
errorerror code (ARM_DRIVER_xxx)
__STATIC_INLINE void EvrUSBH_Driver_Uninitialize ( uint8_t  ctrl)

Event on ARM_USBH_Uninitialize finished successfully (API)

Parameters
ctrlcontroller index
__STATIC_INLINE void EvrUSBH_Driver_UninitializeFailed ( uint8_t  ctrl,
int32_t  error 
)

Event on ARM_USBH_Uninitialize failed (Error)

Parameters
ctrlcontroller index
errorerror code (ARM_DRIVER_xxx)