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

Functions
__STATIC_INLINE void	EvrUSBH_Core_Initialize (uint8_t ctrl)
	Event on USBH_Initialize start (API)

__STATIC_INLINE void	EvrUSBH_Core_InitializeFailed (uint8_t ctrl, usbStatus error)
	Event on USBH_Initialize failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_Uninitialize (uint8_t ctrl)
	Event on USBH_Uninitialize start (API)

__STATIC_INLINE void	EvrUSBH_Core_UninitializeFailed (uint8_t ctrl, usbStatus error)
	Event on USBH_Uninitialize failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PortSuspend (uint8_t ctrl, uint8_t port)
	Event on USBH_Port_Suspend start (API)

__STATIC_INLINE void	EvrUSBH_Core_PortSuspendFailed (uint8_t ctrl, uint8_t port, usbStatus error)
	Event on USBH_Port_Suspend failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PortResume (uint8_t ctrl, uint8_t port)
	Event on USBH_Port_Resume start (API)

__STATIC_INLINE void	EvrUSBH_Core_PortResumeFailed (uint8_t ctrl, uint8_t port, usbStatus error)
	Event on USBH_Port_Resume failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetController (uint8_t device, uint8_t ctrl)
	Event on USBH_Device_GetController finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetPort (uint8_t device, uint8_t port)
	Event on USBH_Device_GetPort finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetStatus (uint8_t device, usbStatus status)
	Event on USBH_Device_GetStatus finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetSpeed (uint8_t device, uint8_t speed)
	Event on USBH_Device_GetSpeed finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetAddress (uint8_t device, uint8_t address)
	Event on USBH_Device_GetAddress finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetVID (uint8_t device, uint16_t vid)
	Event on USBH_Device_GetVID finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetPID (uint8_t device, uint16_t pid)
	Event on USBH_Device_GetPID finished (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetStringDescriptor (uint8_t device, uint8_t index, uint16_t lang_id, uint16_t desc_length)
	Event on USBH_Device_GetStringDescriptor start (API)

__STATIC_INLINE void	EvrUSBH_Core_DeviceGetStringDescriptorFailed (uint8_t device, uint8_t index, uint16_t lang_id, uint16_t desc_length, usbStatus error)
	Event on USBH_Device_GetStringDescriptor failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_OnNotify (uint8_t ctrl, uint8_t port, uint8_t device, USBH_NOTIFY notify)
	Event on USBH_Notify user callback function start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeCreate (uint8_t device, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval, USBH_PIPE_HANDLE pipe_hndl)
	Event on USBH_PipeCreate start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeUpdate (USBH_PIPE_HANDLE pipe_hndl)
	Event on USBH_PipeUpdate start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeUpdateFailed (USBH_PIPE_HANDLE pipe_hndl, usbStatus error)
	Event on USBH_PipeUpdate failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PipeDelete (USBH_PIPE_HANDLE pipe_hndl)
	Event on USBH_PipeDelete start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeDeleteFailed (USBH_PIPE_HANDLE pipe_hndl, usbStatus error)
	Event on USBH_PipeDelete failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PipeReset (USBH_PIPE_HANDLE pipe_hndl)
	Event on USBH_PipeReset start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeResetFailed (USBH_PIPE_HANDLE pipe_hndl, usbStatus error)
	Event on USBH_PipeReset failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PipeReceive (USBH_PIPE_HANDLE pipe_hndl, uint32_t len)
	Event on USBH_PipeReceive start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeReceiveFailed (USBH_PIPE_HANDLE pipe_hndl, uint32_t len, usbStatus error)
	Event on USBH_PipeReceive failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PipeReceiveGetResult (USBH_PIPE_HANDLE pipe_hndl, uint32_t num)
	Event on USBH_PipeReceiveGetResult finished (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeSend (USBH_PIPE_HANDLE pipe_hndl, uint32_t len)
	Event on USBH_PipeSend start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeSendFailed (USBH_PIPE_HANDLE pipe_hndl, uint32_t len, usbStatus error)
	Event on USBH_PipeSend failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_PipeSendGetResult (USBH_PIPE_HANDLE pipe_hndl, uint32_t num)
	Event on USBH_PipeSendGetResult finished (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeAbort (USBH_PIPE_HANDLE pipe_hndl)
	Event on USBH_PipeAbort start (API)

__STATIC_INLINE void	EvrUSBH_Core_PipeAbortFailed (USBH_PIPE_HANDLE pipe_hndl, usbStatus error)
	Event on USBH_PipeAbort failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_ControlTransfer (uint8_t device, const void *setup_packet, uint32_t len)
	Event on USBH_ControlTransfer start (API)

__STATIC_INLINE void	EvrUSBH_Core_ControlTransferFailed (uint8_t device, const void *setup_packet, usbStatus error)
	Event on USBH_ControlTransfer failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetStatus (uint8_t device, uint8_t recipient, uint8_t index, uint16_t status)
	Event on USBH_DeviceRequest_GetStatus start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetStatusFailed (uint8_t device, uint8_t recipient, uint8_t index, usbStatus error)
	Event on USBH_DeviceRequest_GetStatus failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestClearFeature (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature)
	Event on USBH_DeviceRequest_ClearFeature start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestClearFeatureFailed (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature, usbStatus error)
	Event on USBH_DeviceRequest_ClearFeature failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetFeature (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature)
	Event on USBH_DeviceRequest_SetFeature start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetFeatureFailed (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature, usbStatus error)
	Event on USBH_DeviceRequest_SetFeature failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetAddress (uint8_t device, uint8_t address)
	Event on USBH_DeviceRequest_SetAddress start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetAddressFailed (uint8_t device, uint8_t address, usbStatus error)
	Event on USBH_DeviceRequest_SetAddress failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetDescriptor (uint8_t device, uint8_t recipient, uint8_t desc_type, uint8_t desc_index, uint16_t lang_id, uint16_t desc_length)
	Event on USBH_DeviceRequest_GetDescriptor start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetDescriptor (uint8_t device, uint8_t recipient, uint8_t desc_type, uint8_t desc_index, uint16_t lang_id, uint16_t desc_length)
	Event on USBH_DeviceRequest_SetDescriptor start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetConfiguration (uint8_t device, uint8_t config)
	Event on USBH_DeviceRequest_GetConfiguration start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetConfigurationFailed (uint8_t device, usbStatus error)
	Event on USBH_DeviceRequest_GetConfiguration failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetConfiguration (uint8_t device, uint8_t config)
	Event on USBH_DeviceRequest_SetConfiguration start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetConfigurationFailed (uint8_t device, uint8_t config, usbStatus error)
	Event on USBH_DeviceRequest_SetConfiguration failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetInterface (uint8_t device, uint8_t index, uint8_t alt)
	Event on USBH_DeviceRequest_GetInterface start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestGetInterfaceFailed (uint8_t device, uint8_t index, usbStatus error)
	Event on USBH_DeviceRequest_GetInterface failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetInterface (uint8_t device, uint8_t index, uint8_t alt)
	Event on USBH_DeviceRequest_SetInterface start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSetInterfaceFailed (uint8_t device, uint8_t index, uint8_t alt, usbStatus error)
	Event on USBH_DeviceRequest_SetInterface failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_RequestSynchFrame (uint8_t device, uint8_t index, uint16_t frame_num)
	Event on USBH_DeviceRequest_SynchFrame start (API)

__STATIC_INLINE void	EvrUSBH_Core_RequestSynchFrameFailed (uint8_t device, uint8_t index, usbStatus error)
	Event on USBH_DeviceRequest_SynchFrame failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_MemInitFailed (uint8_t ctrl, usbStatus error)
	Event on internal operation memory initialization failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_MemInit (uint8_t ctrl)
	Event on internal operation memory initialization finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_Core_MemUninitFailed (uint8_t ctrl, usbStatus error)
	Event on internal operation memory uninitialization failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_MemUninit (uint8_t ctrl)
	Event on internal operation memory uninitialization finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_Core_MemAllocFailed (uint8_t ctrl, uint32_t size, usbStatus error)
	Event on internal operation memory allocation failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_MemAlloc (uint8_t ctrl, const uint8_t *ptr, uint32_t size)
	Event on internal operation memory allocation finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_Core_MemFreeFailed (uint8_t ctrl, const uint8_t *ptr, usbStatus error)
	Event on internal operation memory free failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_MemFree (uint8_t ctrl, const uint8_t *ptr)
	Event on internal operation memory free finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_Core_Engine (uint8_t ctrl, uint8_t port, uint32_t event, uint8_t port_state)
	Event on internal operation engine start (Detail)

__STATIC_INLINE void	EvrUSBH_Core_EngineFailed (uint8_t ctrl, uint8_t port, uint32_t event)
	Event on internal operation engine failed (Error)

__STATIC_INLINE void	EvrUSBH_Core_EngineDone (uint8_t ctrl, uint8_t port, uint32_t event, uint8_t port_state)
	Event on internal operation engine finished successfully (Detail)

Description

Events generated by USB Host - Core functions.

Function Documentation

◆ EvrUSBH_Core_ControlTransfer()

__STATIC_INLINE void EvrUSBH_Core_ControlTransfer	(	uint8_t	device,
		const void *	setup_packet,
		uint32_t	len
	)

Event on USBH_ControlTransfer start (API)

Parameters

device	device index
setup_packet	setup packet content
len	number of data bytes in data stage

◆ EvrUSBH_Core_ControlTransferFailed()

__STATIC_INLINE void EvrUSBH_Core_ControlTransferFailed	(	uint8_t	device,
		const void *	setup_packet,
		usbStatus	error
	)

Event on USBH_ControlTransfer failed (Error)

Parameters

device	device index
setup_packet	setup packet content
error	error code usbStatus

◆ EvrUSBH_Core_DeviceGetAddress()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetAddress	(	uint8_t	device,
		uint8_t	address
	)

Event on USBH_Device_GetAddress finished (API)

Parameters

device	device index
address	enumerated address value <= 127: enumerated address value == 255: invalid address

◆ EvrUSBH_Core_DeviceGetController()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetController	(	uint8_t	device,
		uint8_t	ctrl
	)

Event on USBH_Device_GetController finished (API)

Parameters

device	device index
ctrl	controller index value <= 3: index of USB Host controller value == 255: non-existing USB Host controller

◆ EvrUSBH_Core_DeviceGetPID()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetPID	(	uint8_t	device,
		uint16_t	pid
	)

Event on USBH_Device_GetPID finished (API)

Parameters

device	device index
pid	product ID

◆ EvrUSBH_Core_DeviceGetPort()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetPort	(	uint8_t	device,
		uint8_t	port
	)

Event on USBH_Device_GetPort finished (API)

Parameters

device	device index
port	root HUB port index value != 255: index of USB Host root HUB port value == 255: non-existing USB Host root HUB port

◆ EvrUSBH_Core_DeviceGetSpeed()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetSpeed	(	uint8_t	device,
		uint8_t	speed
	)

Event on USBH_Device_GetSpeed finished (API)

Parameters

device	device index
speed	communication speed

◆ EvrUSBH_Core_DeviceGetStatus()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetStatus	(	uint8_t	device,
		usbStatus	status
	)

Event on USBH_Device_GetStatus finished (API)

Parameters

device	device index
status	device status usbStatus

◆ EvrUSBH_Core_DeviceGetStringDescriptor()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetStringDescriptor	(	uint8_t	device,
		uint8_t	index,
		uint16_t	lang_id,
		uint16_t	desc_length
	)

Event on USBH_Device_GetStringDescriptor start (API)

Parameters

device	device index
index	string descriptor index
lang_id	language ID
desc_length	descriptor length

◆ EvrUSBH_Core_DeviceGetStringDescriptorFailed()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetStringDescriptorFailed	(	uint8_t	device,
		uint8_t	index,
		uint16_t	lang_id,
		uint16_t	desc_length,
		usbStatus	error
	)

Event on USBH_Device_GetStringDescriptor failed (Error)

Parameters

device	device index
index	string descriptor index
lang_id	language ID
desc_length	descriptor length
error	error code usbStatus

◆ EvrUSBH_Core_DeviceGetVID()

__STATIC_INLINE void EvrUSBH_Core_DeviceGetVID	(	uint8_t	device,
		uint16_t	vid
	)

Event on USBH_Device_GetVID finished (API)

Parameters

device	device index
vid	vendor ID

◆ EvrUSBH_Core_Engine()

__STATIC_INLINE void EvrUSBH_Core_Engine	(	uint8_t	ctrl,
		uint8_t	port,
		uint32_t	event,
		uint8_t	port_state
	)

Event on internal operation engine start (Detail)

Parameters

ctrl	controller index
port	root HUB port
event	event
port_state	current port state

◆ EvrUSBH_Core_EngineDone()

__STATIC_INLINE void EvrUSBH_Core_EngineDone	(	uint8_t	ctrl,
		uint8_t	port,
		uint32_t	event,
		uint8_t	port_state
	)

Event on internal operation engine finished successfully (Detail)

Parameters

ctrl	controller index
port	root HUB port
event	event
port_state	current port state

◆ EvrUSBH_Core_EngineFailed()

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

Event on internal operation engine failed (Error)

Parameters

ctrl	controller index
port	root HUB port
event	event

◆ EvrUSBH_Core_Initialize()

__STATIC_INLINE void EvrUSBH_Core_Initialize ( uint8_t ctrl )

Event on USBH_Initialize start (API)

Parameters

ctrl	controller index

◆ EvrUSBH_Core_InitializeFailed()

__STATIC_INLINE void EvrUSBH_Core_InitializeFailed	(	uint8_t	ctrl,
		usbStatus	error
	)

Event on USBH_Initialize failed (Error)

Parameters

ctrl	controller index
error	error code usbStatus

◆ EvrUSBH_Core_MemAlloc()

__STATIC_INLINE void EvrUSBH_Core_MemAlloc	(	uint8_t	ctrl,
		const uint8_t *	ptr,
		uint32_t	size
	)

Event on internal operation memory allocation finished successfully (Detail)

Parameters

ctrl	controller index
ptr	pointer to allocated memory
size	size of memory chunk to be allocated

◆ EvrUSBH_Core_MemAllocFailed()

__STATIC_INLINE void EvrUSBH_Core_MemAllocFailed	(	uint8_t	ctrl,
		uint32_t	size,
		usbStatus	error
	)

Event on internal operation memory allocation failed (Error)

Parameters

ctrl	controller index
size	size of memory chunk to be allocated
error	error code usbStatus

◆ EvrUSBH_Core_MemFree()

__STATIC_INLINE void EvrUSBH_Core_MemFree	(	uint8_t	ctrl,
		const uint8_t *	ptr
	)

Event on internal operation memory free finished successfully (Detail)

Parameters

ctrl	controller index
ptr	pointer to allocated memory chunk to be released

◆ EvrUSBH_Core_MemFreeFailed()

__STATIC_INLINE void EvrUSBH_Core_MemFreeFailed	(	uint8_t	ctrl,
		const uint8_t *	ptr,
		usbStatus	error
	)

Event on internal operation memory free failed (Error)

Parameters

ctrl	controller index
ptr	pointer to allocated memory chunk to be released
error	error code usbStatus

◆ EvrUSBH_Core_MemInit()

__STATIC_INLINE void EvrUSBH_Core_MemInit ( uint8_t ctrl )

Event on internal operation memory initialization finished successfully (Detail)

Parameters

ctrl	controller index

◆ EvrUSBH_Core_MemInitFailed()

__STATIC_INLINE void EvrUSBH_Core_MemInitFailed	(	uint8_t	ctrl,
		usbStatus	error
	)

Event on internal operation memory initialization failed (Error)

Parameters

ctrl	controller index
error	error code usbStatus

◆ EvrUSBH_Core_MemUninit()

__STATIC_INLINE void EvrUSBH_Core_MemUninit ( uint8_t ctrl )

Event on internal operation memory uninitialization finished successfully (Detail)

Parameters

ctrl	controller index

◆ EvrUSBH_Core_MemUninitFailed()

__STATIC_INLINE void EvrUSBH_Core_MemUninitFailed	(	uint8_t	ctrl,
		usbStatus	error
	)

Event on internal operation memory uninitialization failed (Error)

Parameters

ctrl	controller index
error	error code usbStatus

◆ EvrUSBH_Core_OnNotify()

__STATIC_INLINE void EvrUSBH_Core_OnNotify	(	uint8_t	ctrl,
		uint8_t	port,
		uint8_t	device,
		USBH_NOTIFY	notify
	)

Event on USBH_Notify user callback function start (API)

Parameters

ctrl	index of USB Host controller.
port	index of Root HUB port.
device	index of USB Device value <= 127: index of of USB Device for device notifications value 255: no device information for port notifications
notify	notification: USBH_NOTIFY_CONNECT = Port connection happened USBH_NOTIFY_DISCONNECT = Port disconnection happened USBH_NOTIFY_OVERCURRENT = Port overcurrent happened USBH_NOTIFY_REMOTE_WAKEUP = Port remote wakeup signaling happened USBH_NOTIFY_READY = Device was successfully enumerated, initialized and is ready for communication USBH_NOTIFY_UNKNOWN_DEVICE = Device was successfully enumerated but there is no driver for it USBH_NOTIFY_INSUFFICIENT_POWER = Device requires more power consumption than available USBH_NOTIFY_CONFIGURATION_FAILED = Device was not successfully configured (not enough resources) USBH_NOTIFY_INITIALIZATION_FAILED = Device was not successfully initialized

◆ EvrUSBH_Core_PipeAbort()

__STATIC_INLINE void EvrUSBH_Core_PipeAbort ( USBH_PIPE_HANDLE pipe_hndl )

Event on USBH_PipeAbort start (API)

Parameters

pipe_hndl pipe handle.

◆ EvrUSBH_Core_PipeAbortFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeAbortFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		usbStatus	error
	)

Event on USBH_PipeAbort failed (Error)

Parameters

pipe_hndl	pipe handle.
error	error code usbStatus

◆ EvrUSBH_Core_PipeCreate()

__STATIC_INLINE void EvrUSBH_Core_PipeCreate	(	uint8_t	device,
		uint8_t	ep_addr,
		uint8_t	ep_type,
		uint16_t	ep_max_packet_size,
		uint8_t	ep_interval,
		USBH_PIPE_HANDLE	pipe_hndl
	)

Event on USBH_PipeCreate start (API)

Parameters

device	index of USB Device.
ep_addr	endpoint address ep_addr.0..3: address ep_addr.7: direction
ep_type	endpoint type.
ep_max_packet_size	endpoint maximum packet size.
ep_interval	endpoint polling interval.
pipe_hndl	pipe handle or pipe creation failed value > 0: pipe_handle value 0: pipe creation failed

◆ EvrUSBH_Core_PipeDelete()

__STATIC_INLINE void EvrUSBH_Core_PipeDelete ( USBH_PIPE_HANDLE pipe_hndl )

Event on USBH_PipeDelete start (API)

Parameters

pipe_hndl pipe handle.

◆ EvrUSBH_Core_PipeDeleteFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeDeleteFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		usbStatus	error
	)

Event on USBH_PipeDelete failed (Error)

Parameters

pipe_hndl	pipe handle.
error	error code usbStatus

◆ EvrUSBH_Core_PipeReceive()

__STATIC_INLINE void EvrUSBH_Core_PipeReceive	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	len
	)

Event on USBH_PipeReceive start (API)

Parameters

pipe_hndl	pipe handle.
len	maximum number of bytes to receive

◆ EvrUSBH_Core_PipeReceiveFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeReceiveFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	len,
		usbStatus	error
	)

Event on USBH_PipeReceive failed (Error)

Parameters

pipe_hndl	pipe handle.
len	maximum number of bytes to receive
error	error code usbStatus

◆ EvrUSBH_Core_PipeReceiveGetResult()

__STATIC_INLINE void EvrUSBH_Core_PipeReceiveGetResult	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	num
	)

Event on USBH_PipeReceiveGetResult finished (API)

Parameters

pipe_hndl	pipe handle.
num	number of successfully received data bytes

◆ EvrUSBH_Core_PipeReset()

__STATIC_INLINE void EvrUSBH_Core_PipeReset ( USBH_PIPE_HANDLE pipe_hndl )

Event on USBH_PipeReset start (API)

Parameters

pipe_hndl pipe handle.

◆ EvrUSBH_Core_PipeResetFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeResetFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		usbStatus	error
	)

Event on USBH_PipeReset failed (Error)

Parameters

pipe_hndl	pipe handle.
error	error code usbStatus

◆ EvrUSBH_Core_PipeSend()

__STATIC_INLINE void EvrUSBH_Core_PipeSend	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	len
	)

Event on USBH_PipeSend start (API)

Parameters

pipe_hndl	pipe handle.
len	maximum number of bytes to send

◆ EvrUSBH_Core_PipeSendFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeSendFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	len,
		usbStatus	error
	)

Event on USBH_PipeSend failed (Error)

Parameters

pipe_hndl	pipe handle.
len	number of bytes to send
error	error code usbStatus

◆ EvrUSBH_Core_PipeSendGetResult()

__STATIC_INLINE void EvrUSBH_Core_PipeSendGetResult	(	USBH_PIPE_HANDLE	pipe_hndl,
		uint32_t	num
	)

Event on USBH_PipeSendGetResult finished (API)

Parameters

pipe_hndl	pipe handle.
num	number of successfully sent data bytes

◆ EvrUSBH_Core_PipeUpdate()

__STATIC_INLINE void EvrUSBH_Core_PipeUpdate ( USBH_PIPE_HANDLE pipe_hndl )

Event on USBH_PipeUpdate start (API)

Parameters

pipe_hndl pipe handle.

◆ EvrUSBH_Core_PipeUpdateFailed()

__STATIC_INLINE void EvrUSBH_Core_PipeUpdateFailed	(	USBH_PIPE_HANDLE	pipe_hndl,
		usbStatus	error
	)

Event on USBH_PipeUpdate failed (Error)

Parameters

pipe_hndl	pipe handle.
error	error code usbStatus

◆ EvrUSBH_Core_PortResume()

__STATIC_INLINE void EvrUSBH_Core_PortResume	(	uint8_t	ctrl,
		uint8_t	port
	)

Event on USBH_Port_Resume start (API)

Parameters

ctrl	controller index
port	root HUB port

◆ EvrUSBH_Core_PortResumeFailed()

__STATIC_INLINE void EvrUSBH_Core_PortResumeFailed	(	uint8_t	ctrl,
		uint8_t	port,
		usbStatus	error
	)

Event on USBH_Port_Resume failed (Error)

Parameters

ctrl	controller index
port	root HUB port
error	error code usbStatus

◆ EvrUSBH_Core_PortSuspend()

__STATIC_INLINE void EvrUSBH_Core_PortSuspend	(	uint8_t	ctrl,
		uint8_t	port
	)

Event on USBH_Port_Suspend start (API)

Parameters

ctrl	controller index
port	root HUB port

◆ EvrUSBH_Core_PortSuspendFailed()

__STATIC_INLINE void EvrUSBH_Core_PortSuspendFailed	(	uint8_t	ctrl,
		uint8_t	port,
		usbStatus	error
	)

Event on USBH_Port_Suspend failed (Error)

Parameters

ctrl	controller index
port	root HUB port
error	error code usbStatus

◆ EvrUSBH_Core_RequestClearFeature()

__STATIC_INLINE void EvrUSBH_Core_RequestClearFeature	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		uint8_t	feature
	)

Event on USBH_DeviceRequest_ClearFeature start (API)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
feature	feature selector

◆ EvrUSBH_Core_RequestClearFeatureFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestClearFeatureFailed	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		uint8_t	feature,
		usbStatus	error
	)

Event on USBH_DeviceRequest_ClearFeature failed (Error)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
feature	feature selector
error	error code usbStatus

◆ EvrUSBH_Core_RequestGetConfiguration()

__STATIC_INLINE void EvrUSBH_Core_RequestGetConfiguration	(	uint8_t	device,
		uint8_t	config
	)

Event on USBH_DeviceRequest_GetConfiguration start (API)

Parameters

device	device index
config	configuration

◆ EvrUSBH_Core_RequestGetConfigurationFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestGetConfigurationFailed	(	uint8_t	device,
		usbStatus	error
	)

Event on USBH_DeviceRequest_GetConfiguration failed (Error)

Parameters

device	device index
error	error code usbStatus

◆ EvrUSBH_Core_RequestGetDescriptor()

__STATIC_INLINE void EvrUSBH_Core_RequestGetDescriptor	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	desc_type,
		uint8_t	desc_index,
		uint16_t	lang_id,
		uint16_t	desc_length
	)

Event on USBH_DeviceRequest_GetDescriptor start (API)

Parameters

device	device index
recipient	recipient
desc_type	descriptor type
desc_index	descriptor index
lang_id	language ID
desc_length	descriptor length

◆ EvrUSBH_Core_RequestGetInterface()

__STATIC_INLINE void EvrUSBH_Core_RequestGetInterface	(	uint8_t	device,
		uint8_t	index,
		uint8_t	alt
	)

Event on USBH_DeviceRequest_GetInterface start (API)

Parameters

device	device index
index	interface index
alt	alternate setting

◆ EvrUSBH_Core_RequestGetInterfaceFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestGetInterfaceFailed	(	uint8_t	device,
		uint8_t	index,
		usbStatus	error
	)

Event on USBH_DeviceRequest_GetInterface failed (Error)

Parameters

device	device index
index	interface index
error	error code usbStatus

◆ EvrUSBH_Core_RequestGetStatus()

__STATIC_INLINE void EvrUSBH_Core_RequestGetStatus	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		uint16_t	status
	)

Event on USBH_DeviceRequest_GetStatus start (API)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
status	received status

◆ EvrUSBH_Core_RequestGetStatusFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestGetStatusFailed	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		usbStatus	error
	)

Event on USBH_DeviceRequest_GetStatus failed (Error)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
error	error code usbStatus

◆ EvrUSBH_Core_RequestSetAddress()

__STATIC_INLINE void EvrUSBH_Core_RequestSetAddress	(	uint8_t	device,
		uint8_t	address
	)

Event on USBH_DeviceRequest_SetAddress start (API)

Parameters

device	device index
address	device address

◆ EvrUSBH_Core_RequestSetAddressFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestSetAddressFailed	(	uint8_t	device,
		uint8_t	address,
		usbStatus	error
	)

Event on USBH_DeviceRequest_SetAddress failed (Error)

Parameters

device	device index
address	device address
error	error code usbStatus

◆ EvrUSBH_Core_RequestSetConfiguration()

__STATIC_INLINE void EvrUSBH_Core_RequestSetConfiguration	(	uint8_t	device,
		uint8_t	config
	)

Event on USBH_DeviceRequest_SetConfiguration start (API)

Parameters

device	device index
config	configuration

◆ EvrUSBH_Core_RequestSetConfigurationFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestSetConfigurationFailed	(	uint8_t	device,
		uint8_t	config,
		usbStatus	error
	)

Event on USBH_DeviceRequest_SetConfiguration failed (Error)

Parameters

device	device index
config	configuration
error	error code usbStatus

◆ EvrUSBH_Core_RequestSetDescriptor()

__STATIC_INLINE void EvrUSBH_Core_RequestSetDescriptor	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	desc_type,
		uint8_t	desc_index,
		uint16_t	lang_id,
		uint16_t	desc_length
	)

Event on USBH_DeviceRequest_SetDescriptor start (API)

Parameters

device	device index
recipient	recipient
desc_type	descriptor type
desc_index	descriptor index
lang_id	language ID
desc_length	descriptor length

◆ EvrUSBH_Core_RequestSetFeature()

__STATIC_INLINE void EvrUSBH_Core_RequestSetFeature	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		uint8_t	feature
	)

Event on USBH_DeviceRequest_SetFeature start (API)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
feature	feature selector

◆ EvrUSBH_Core_RequestSetFeatureFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestSetFeatureFailed	(	uint8_t	device,
		uint8_t	recipient,
		uint8_t	index,
		uint8_t	feature,
		usbStatus	error
	)

Event on USBH_DeviceRequest_SetFeature failed (Error)

Parameters

device	device index
recipient	recipient
index	interface or endpoint index
feature	feature selector
error	error code usbStatus

◆ EvrUSBH_Core_RequestSetInterface()

__STATIC_INLINE void EvrUSBH_Core_RequestSetInterface	(	uint8_t	device,
		uint8_t	index,
		uint8_t	alt
	)

Event on USBH_DeviceRequest_SetInterface start (API)

Parameters

device	device index
index	interface index
alt	alternate setting

◆ EvrUSBH_Core_RequestSetInterfaceFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestSetInterfaceFailed	(	uint8_t	device,
		uint8_t	index,
		uint8_t	alt,
		usbStatus	error
	)

Event on USBH_DeviceRequest_SetInterface failed (Error)

Parameters

device	device index
index	interface index
alt	alternate setting
error	error code usbStatus

◆ EvrUSBH_Core_RequestSynchFrame()

__STATIC_INLINE void EvrUSBH_Core_RequestSynchFrame	(	uint8_t	device,
		uint8_t	index,
		uint16_t	frame_num
	)

Event on USBH_DeviceRequest_SynchFrame start (API)

Parameters

device	device index
index	interface index
frame_num	frame number

◆ EvrUSBH_Core_RequestSynchFrameFailed()

__STATIC_INLINE void EvrUSBH_Core_RequestSynchFrameFailed	(	uint8_t	device,
		uint8_t	index,
		usbStatus	error
	)

Event on USBH_DeviceRequest_SynchFrame failed (Error)

Parameters

device	device index
index	interface index
error	error code usbStatus

◆ EvrUSBH_Core_Uninitialize()

__STATIC_INLINE void EvrUSBH_Core_Uninitialize ( uint8_t ctrl )

Event on USBH_Uninitialize start (API)

Parameters

ctrl	controller index

◆ EvrUSBH_Core_UninitializeFailed()

__STATIC_INLINE void EvrUSBH_Core_UninitializeFailed	(	uint8_t	ctrl,
		usbStatus	error
	)

Event on USBH_Uninitialize failed (Error)

Parameters

ctrl	controller index
error	error code usbStatus

Functions

Description

Function Documentation

◆ EvrUSBH_Core_ControlTransfer()

◆ EvrUSBH_Core_ControlTransferFailed()

◆ EvrUSBH_Core_DeviceGetAddress()

◆ EvrUSBH_Core_DeviceGetController()

◆ EvrUSBH_Core_DeviceGetPID()

◆ EvrUSBH_Core_DeviceGetPort()

◆ EvrUSBH_Core_DeviceGetSpeed()

◆ EvrUSBH_Core_DeviceGetStatus()

◆ EvrUSBH_Core_DeviceGetStringDescriptor()

◆ EvrUSBH_Core_DeviceGetStringDescriptorFailed()

◆ EvrUSBH_Core_DeviceGetVID()

◆ EvrUSBH_Core_Engine()

◆ EvrUSBH_Core_EngineDone()

◆ EvrUSBH_Core_EngineFailed()

◆ EvrUSBH_Core_Initialize()

◆ EvrUSBH_Core_InitializeFailed()

◆ EvrUSBH_Core_MemAlloc()

◆ EvrUSBH_Core_MemAllocFailed()

◆ EvrUSBH_Core_MemFree()

◆ EvrUSBH_Core_MemFreeFailed()

◆ EvrUSBH_Core_MemInit()

◆ EvrUSBH_Core_MemInitFailed()

◆ EvrUSBH_Core_MemUninit()

◆ EvrUSBH_Core_MemUninitFailed()

◆ EvrUSBH_Core_OnNotify()

◆ EvrUSBH_Core_PipeAbort()

◆ EvrUSBH_Core_PipeAbortFailed()

◆ EvrUSBH_Core_PipeCreate()

◆ EvrUSBH_Core_PipeDelete()

◆ EvrUSBH_Core_PipeDeleteFailed()

◆ EvrUSBH_Core_PipeReceive()

◆ EvrUSBH_Core_PipeReceiveFailed()

◆ EvrUSBH_Core_PipeReceiveGetResult()

◆ EvrUSBH_Core_PipeReset()

◆ EvrUSBH_Core_PipeResetFailed()

◆ EvrUSBH_Core_PipeSend()

◆ EvrUSBH_Core_PipeSendFailed()

◆ EvrUSBH_Core_PipeSendGetResult()

◆ EvrUSBH_Core_PipeUpdate()

◆ EvrUSBH_Core_PipeUpdateFailed()

◆ EvrUSBH_Core_PortResume()

◆ EvrUSBH_Core_PortResumeFailed()

◆ EvrUSBH_Core_PortSuspend()

◆ EvrUSBH_Core_PortSuspendFailed()

◆ EvrUSBH_Core_RequestClearFeature()

◆ EvrUSBH_Core_RequestClearFeatureFailed()

◆ EvrUSBH_Core_RequestGetConfiguration()

◆ EvrUSBH_Core_RequestGetConfigurationFailed()

◆ EvrUSBH_Core_RequestGetDescriptor()

◆ EvrUSBH_Core_RequestGetInterface()

◆ EvrUSBH_Core_RequestGetInterfaceFailed()

◆ EvrUSBH_Core_RequestGetStatus()

◆ EvrUSBH_Core_RequestGetStatusFailed()

◆ EvrUSBH_Core_RequestSetAddress()

◆ EvrUSBH_Core_RequestSetAddressFailed()

◆ EvrUSBH_Core_RequestSetConfiguration()

◆ EvrUSBH_Core_RequestSetConfigurationFailed()

◆ EvrUSBH_Core_RequestSetDescriptor()

◆ EvrUSBH_Core_RequestSetFeature()

◆ EvrUSBH_Core_RequestSetFeatureFailed()

◆ EvrUSBH_Core_RequestSetInterface()

◆ EvrUSBH_Core_RequestSetInterfaceFailed()

◆ EvrUSBH_Core_RequestSynchFrame()

◆ EvrUSBH_Core_RequestSynchFrameFailed()

◆ EvrUSBH_Core_Uninitialize()

◆ EvrUSBH_Core_UninitializeFailed()