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

EvrUSBH_Driver_Initialize()

__STATIC_INLINE void EvrUSBH_Driver_Initialize

(

uint8_t

ctrl

)

Event on ARM_USBH_Initialize finished successfully (API)

Parameters

ctrl	controller index

EvrUSBH_Driver_InitializeFailed()

__STATIC_INLINE void EvrUSBH_Driver_InitializeFailed	(	uint8_t	ctrl,
		int32_t	error
	)

Event on ARM_USBH_Initialize failed (Error)

Parameters

ctrl	controller index
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_Uninitialize()

__STATIC_INLINE void EvrUSBH_Driver_Uninitialize

(

uint8_t

ctrl

)

Event on ARM_USBH_Uninitialize finished successfully (API)

Parameters

ctrl	controller index

EvrUSBH_Driver_UninitializeFailed()

__STATIC_INLINE void EvrUSBH_Driver_UninitializeFailed	(	uint8_t	ctrl,
		int32_t	error
	)

Event on ARM_USBH_Uninitialize failed (Error)

Parameters

ctrl	controller index
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PowerControl()

__STATIC_INLINE void EvrUSBH_Driver_PowerControl	(	uint8_t	ctrl,
		ARM_POWER_STATE	state
	)

Event on ARM_USBH_PowerControl finished successfully (API)

Parameters

ctrl	controller index
state	power state ARM_POWER_STATE

EvrUSBH_Driver_PowerControlFailed()

__STATIC_INLINE void EvrUSBH_Driver_PowerControlFailed	(	uint8_t	ctrl,
		ARM_POWER_STATE	state,
		int32_t	error
	)

Event on ARM_USBH_PowerControl failed (Error)

Parameters

ctrl	controller index
state	power state
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PortVbusOnOff()

__STATIC_INLINE void EvrUSBH_Driver_PortVbusOnOff	(	uint8_t	ctrl,
		uint8_t	port,
		bool	vbus
	)

Event on ARM_USBH_PortVbusOnOff finished successfully (API)

Parameters

ctrl	controller index
port	root HUB port number
vbus	VBUS state false VBUS off true VBUS on

EvrUSBH_Driver_PortVbusOnOffFailed()

__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

ctrl	controller index
port	root HUB port number
vbus	VBUS state false VBUS off true VBUS on
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PortReset()

__STATIC_INLINE void EvrUSBH_Driver_PortReset	(	uint8_t	ctrl,
		uint8_t	port
	)

Event on ARM_USBH_PortReset finished successfully (API)

Parameters

ctrl	controller index
port	root HUB port number

EvrUSBH_Driver_PortResetFailed()

__STATIC_INLINE void EvrUSBH_Driver_PortResetFailed	(	uint8_t	ctrl,
		uint8_t	port,
		int32_t	error
	)

Event on ARM_USBH_PortReset failed (Error)

Parameters

ctrl	controller index
port	root HUB port number
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PortSuspend()

__STATIC_INLINE void EvrUSBH_Driver_PortSuspend	(	uint8_t	ctrl,
		uint8_t	port
	)

Event on ARM_USBH_PortSuspend finished successfully (API)

Parameters

ctrl	controller index
port	root HUB port number

EvrUSBH_Driver_PortSuspendFailed()

__STATIC_INLINE void EvrUSBH_Driver_PortSuspendFailed	(	uint8_t	ctrl,
		uint8_t	port,
		int32_t	error
	)

Event on ARM_USBH_PortSuspend failed (Error)

Parameters

ctrl	controller index
port	root HUB port number
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PortResume()

__STATIC_INLINE void EvrUSBH_Driver_PortResume	(	uint8_t	ctrl,
		uint8_t	port
	)

Event on ARM_USBH_PortResume finished successfully (API)

Parameters

ctrl	controller index
port	root HUB port number

EvrUSBH_Driver_PortResumeFailed()

__STATIC_INLINE void EvrUSBH_Driver_PortResumeFailed	(	uint8_t	ctrl,
		uint8_t	port,
		int32_t	error
	)

Event on ARM_USBH_PortResume failed (Error)

Parameters

ctrl	controller index
port	root HUB port number
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PortGetState()

__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

ctrl	controller index
port	root HUB port number
state	port state ARM_USBH_STATE

EvrUSBH_Driver_PipeCreate()

__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

ctrl	controller index
dev_addr	device address
dev_speed	device speed
hub_addr	hub address
hub_port	hub port
ep_addr	endpoint address ep_addr.0..3: address ep_addr.7: direction
ep_type	endpoint type (ARM_USB_ENDPOINT_xxx)
ep_max_packet_size	endpoint maximum packet size
ep_interval	endpoint polling interval
pipe_hndl	pipe handle ARM_USBH_PIPE_HANDLE

EvrUSBH_Driver_PipeCreateFailed()

__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

ctrl	controller index
dev_addr	device address
dev_speed	device speed
hub_addr	hub address
hub_port	hub port
ep_addr	endpoint address ep_addr.0..3: address ep_addr.7: direction
ep_type	endpoint type (ARM_USB_ENDPOINT_xxx)
ep_max_packet_size	endpoint maximum packet size
ep_interval	endpoint polling interval

EvrUSBH_Driver_PipeModify()

__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

ctrl	controller index
pipe_hndl	pipe handle
dev_addr	device address
dev_speed	device speed
hub_addr	hub address
hub_port	hub port
ep_max_packet_size	endpoint maximum packet size

EvrUSBH_Driver_PipeModifyFailed()

__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

ctrl	controller index
pipe_hndl	pipe handle
dev_addr	device address
dev_speed	device speed
hub_addr	hub address
hub_port	hub port
ep_max_packet_size	endpoint maximum packet size
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PipeDelete()

__STATIC_INLINE void EvrUSBH_Driver_PipeDelete	(	uint8_t	ctrl,
		ARM_USBH_PIPE_HANDLE	pipe_hndl
	)

Event on ARM_USBH_PipeDelete finished successfully (API)

Parameters

ctrl	controller index
pipe_hndl	pipe handle

EvrUSBH_Driver_PipeDeleteFailed()

__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

ctrl	controller index
pipe_hndl	pipe handle
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PipeReset()

__STATIC_INLINE void EvrUSBH_Driver_PipeReset	(	uint8_t	ctrl,
		ARM_USBH_PIPE_HANDLE	pipe_hndl
	)

Event on ARM_USBH_PipeReset finished successfully (API)

Parameters

ctrl	controller index
pipe_hndl	pipe handle

EvrUSBH_Driver_PipeResetFailed()

__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

ctrl	controller index
pipe_hndl	pipe handle
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PipeTransfer()

__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

ctrl	controller index
pipe_hndl	pipe handle
packet	packet information
num	number of data bytes to transfer

EvrUSBH_Driver_PipeTransferFailed()

__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

ctrl	controller index
pipe_hndl	pipe handle
packet	packet information
num	number of data bytes to transfer
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_PipeTransferGetResult()

__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

ctrl	controller index
pipe_hndl	pipe handle
num	number of successfully transferred data bytes

EvrUSBH_Driver_PipeTransferAbort()

__STATIC_INLINE void EvrUSBH_Driver_PipeTransferAbort	(	uint8_t	ctrl,
		ARM_USBH_PIPE_HANDLE	pipe_hndl
	)

Event on ARM_USBH_PipeTransferAbort finished successfully (API)

Parameters

ctrl	controller index
pipe_hndl	pipe handle

EvrUSBH_Driver_PipeTransferAbortFailed()

__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

ctrl	controller index
pipe_hndl	pipe handle
error	error code (ARM_DRIVER_xxx)

EvrUSBH_Driver_GetFrameNumber()

__STATIC_INLINE void EvrUSBH_Driver_GetFrameNumber	(	uint8_t	ctrl,
		uint16_t	frame_number
	)

Event on ARM_USBH_GetFrameNumber finished (API)

Parameters

ctrl	controller index
frame_number	frame number

EvrUSBH_Driver_OnSignalPortEvent()

__STATIC_INLINE void EvrUSBH_Driver_OnSignalPortEvent	(	uint8_t	ctrl,
		uint8_t	port,
		uint32_t	event
	)

Event on ARM_USBH_SignalPortEvent callback start (API)

Parameters

ctrl	controller index
port	root HUB port number
event	port event USBH_port_events

EvrUSBH_Driver_OnSignalPipeEvent()

__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

ctrl	controller index
pipe_hndl	pipe handle
event	pipe event USBH_pipe_events