Events generated by USB Host - Human Interface Device functions. More...

Functions
__STATIC_INLINE void	EvrUSBH_HID_Configure (uint8_t instance)
	Event on internal operation HID device configuration start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_ConfigureFailed (usbStatus error)
	Event on internal operation HID device configuration failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_Unconfigure (uint8_t instance)
	Event on internal operation HID device unconfigure start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_UnconfigureFailed (uint8_t instance, usbStatus error)
	Event on internal operation HID device uninitialization failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_Initialize (uint8_t instance)
	Event on internal operation HID device initialization start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_InitializeFailed (uint8_t instance, usbStatus error)
	Event on internal operation HID device initialization failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_OnInitialize (uint8_t instance)
	Event on USBH_HID_Initialize user callback function start (API)

__STATIC_INLINE void	EvrUSBH_HID_Uninitialize (uint8_t instance)
	Event on internal operation HID device uninitialization start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_UninitializeFailed (uint8_t instance, usbStatus error)
	Event on internal operation HID device uninitialization failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_OnUninitialize (uint8_t instance)
	Event on USBH_HID_Uninitialize user callback function start (API)

__STATIC_INLINE void	EvrUSBH_HID_GetDevice (uint8_t instance, uint8_t device)
	Event on USBH_HID_GetDevice finished (API)

__STATIC_INLINE void	EvrUSBH_HID_GetStatus (uint8_t instance, uint8_t status)
	Event on USBH_HID_GetStatus finished (API)

__STATIC_INLINE void	EvrUSBH_HID_Read (uint8_t instance, int32_t len)
	Event on USBH_HID_Read start (API)

__STATIC_INLINE void	EvrUSBH_HID_ReadFailed (uint8_t instance, int32_t len, usbStatus error)
	Event on USBH_HID_Read failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_ReadDone (uint8_t instance, int32_t len, int32_t result)
	Event on USBH_HID_Read finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_HID_Write (uint8_t instance, int32_t len)
	Event on USBH_HID_Write start (API)

__STATIC_INLINE void	EvrUSBH_HID_WriteFailed (uint8_t instance, int32_t len, usbStatus error)
	Event on USBH_HID_Write failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_WriteDone (uint8_t instance, int32_t len, int32_t result)
	Event on USBH_HID_Write finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_HID_GetKeyboardKey (uint8_t instance)
	Event on USBH_HID_GetKeyboardKey start (API)

__STATIC_INLINE void	EvrUSBH_HID_GetKeyboardKeyDone (uint8_t instance, int32_t ch)
	Event on USBH_HID_GetKeyboardKey finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_HID_GetMouseState (uint8_t instance)
	Event on USBH_HID_GetMouseState start (API)

__STATIC_INLINE void	EvrUSBH_HID_GetMouseStateFailed (uint8_t instance, usbStatus error)
	Event on USBH_HID_GetMouseState failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_GetMouseStateDone (uint8_t instance, usbHID_MouseState state)
	Event on USBH_HID_GetMouseState finished successfully (Detail)

__STATIC_INLINE void	EvrUSBH_HID_OnParseReportDescriptor (uint8_t instance, uint32_t len)
	Event on USBH_HID_ParseReportDescriptor user callback function start (API)

__STATIC_INLINE void	EvrUSBH_HID_OnDataReceived (uint8_t instance, uint32_t len)
	Event on USBH_HID_DataReceived user callback function start (API)

__STATIC_INLINE void	EvrUSBH_HID_GetReport (uint8_t instance)
	Event on internal operation Get Report start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_GetReportFailed (uint8_t instance, usbStatus error)
	Event on internal operation Get Report failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_SetReport (uint8_t instance)
	Event on internal operation Set Report start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_SetReportFailed (uint8_t instance, usbStatus error)
	Event on internal operation Set Report failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_GetIdle (uint8_t instance)
	Event on internal operation Get Idle start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_GetIdleFailed (uint8_t instance, usbStatus error)
	Event on internal operation Get Idle failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_SetIdle (uint8_t instance)
	Event on internal operation Set Idle start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_SetIdleFailed (uint8_t instance, usbStatus error)
	Event on internal operation Set Idle failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_GetProtocol (uint8_t instance)
	Event on internal operation Get Protocol start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_GetProtocolFailed (uint8_t instance, usbStatus error)
	Event on internal operation Get Protocol failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_SetProtocol (uint8_t instance)
	Event on internal operation Set Protocol start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_SetProtocolFailed (uint8_t instance, usbStatus error)
	Event on internal operation Set Protocol failed (Error)

__STATIC_INLINE void	EvrUSBH_HID_ReportOut (uint8_t instance)
	Event on internal operation Report Out start (Operation)

__STATIC_INLINE void	EvrUSBH_HID_ReportOutFailed (uint8_t instance, usbStatus error)
	Event on internal operation Report Out failed (Error)

Description

Events generated by USB Host - Human Interface Device functions.

Function Documentation

◆ EvrUSBH_HID_Configure()

__STATIC_INLINE void EvrUSBH_HID_Configure ( uint8_t instance )

Event on internal operation HID device configuration start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_ConfigureFailed()

__STATIC_INLINE void EvrUSBH_HID_ConfigureFailed ( usbStatus error )

Event on internal operation HID device configuration failed (Error)

Parameters

error error code usbStatus

◆ EvrUSBH_HID_GetDevice()

__STATIC_INLINE void EvrUSBH_HID_GetDevice	(	uint8_t	instance,
		uint8_t	device
	)

Event on USBH_HID_GetDevice finished (API)

Parameters

instance	instance of HID device
device	device index value <= 127: index of Device value == 255: non-existing Device index

◆ EvrUSBH_HID_GetIdle()

__STATIC_INLINE void EvrUSBH_HID_GetIdle ( uint8_t instance )

Event on internal operation Get Idle start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_GetIdleFailed()

__STATIC_INLINE void EvrUSBH_HID_GetIdleFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Get Idle failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_GetKeyboardKey()

__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKey ( uint8_t instance )

Event on USBH_HID_GetKeyboardKey start (API)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_GetKeyboardKeyDone()

__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKeyDone	(	uint8_t	instance,
		int32_t	ch
	)

Event on USBH_HID_GetKeyboardKey finished successfully (Detail)

Parameters

instance	instance of HID device
ch	value of first received unread character

◆ EvrUSBH_HID_GetMouseState()

__STATIC_INLINE void EvrUSBH_HID_GetMouseState ( uint8_t instance )

Event on USBH_HID_GetMouseState start (API)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_GetMouseStateDone()

__STATIC_INLINE void EvrUSBH_HID_GetMouseStateDone	(	uint8_t	instance,
		usbHID_MouseState	state
	)

Event on USBH_HID_GetMouseState finished successfully (Detail)

Parameters

instance	instance of HID device
state	mouse state usbHID_MouseState structure

◆ EvrUSBH_HID_GetMouseStateFailed()

__STATIC_INLINE void EvrUSBH_HID_GetMouseStateFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on USBH_HID_GetMouseState failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_GetProtocol()

__STATIC_INLINE void EvrUSBH_HID_GetProtocol ( uint8_t instance )

Event on internal operation Get Protocol start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_GetProtocolFailed()

__STATIC_INLINE void EvrUSBH_HID_GetProtocolFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Get Protocol failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_GetReport()

__STATIC_INLINE void EvrUSBH_HID_GetReport ( uint8_t instance )

Event on internal operation Get Report start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_GetReportFailed()

__STATIC_INLINE void EvrUSBH_HID_GetReportFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Get Report failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_GetStatus()

__STATIC_INLINE void EvrUSBH_HID_GetStatus	(	uint8_t	instance,
		uint8_t	status
	)

Event on USBH_HID_GetStatus finished (API)

Parameters

instance	instance of HID device
status	device status usbStatus

◆ EvrUSBH_HID_Initialize()

__STATIC_INLINE void EvrUSBH_HID_Initialize ( uint8_t instance )

Event on internal operation HID device initialization start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_InitializeFailed()

__STATIC_INLINE void EvrUSBH_HID_InitializeFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation HID device initialization failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_OnDataReceived()

__STATIC_INLINE void EvrUSBH_HID_OnDataReceived	(	uint8_t	instance,
		uint32_t	len
	)

Event on USBH_HID_DataReceived user callback function start (API)

Parameters

instance	instance of HID device
len	length of received data

◆ EvrUSBH_HID_OnInitialize()

__STATIC_INLINE void EvrUSBH_HID_OnInitialize ( uint8_t instance )

Event on USBH_HID_Initialize user callback function start (API)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_OnParseReportDescriptor()

__STATIC_INLINE void EvrUSBH_HID_OnParseReportDescriptor	(	uint8_t	instance,
		uint32_t	len
	)

Event on USBH_HID_ParseReportDescriptor user callback function start (API)

Parameters

instance	instance of HID device
len	length of HID report descriptor

◆ EvrUSBH_HID_OnUninitialize()

__STATIC_INLINE void EvrUSBH_HID_OnUninitialize ( uint8_t instance )

Event on USBH_HID_Uninitialize user callback function start (API)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_Read()

__STATIC_INLINE void EvrUSBH_HID_Read	(	uint8_t	instance,
		int32_t	len
	)

Event on USBH_HID_Read start (API)

Parameters

instance	instance of HID device
len	number of bytes to read

◆ EvrUSBH_HID_ReadDone()

__STATIC_INLINE void EvrUSBH_HID_ReadDone	(	uint8_t	instance,
		int32_t	len,
		int32_t	result
	)

Event on USBH_HID_Read finished successfully (Detail)

Parameters

instance	instance of HID device
len	number of bytes to read
result	number of bytes read

◆ EvrUSBH_HID_ReadFailed()

__STATIC_INLINE void EvrUSBH_HID_ReadFailed	(	uint8_t	instance,
		int32_t	len,
		usbStatus	error
	)

Event on USBH_HID_Read failed (Error)

Parameters

instance	instance of HID device
len	number of bytes to read
error	error code usbStatus

◆ EvrUSBH_HID_ReportOut()

__STATIC_INLINE void EvrUSBH_HID_ReportOut ( uint8_t instance )

Event on internal operation Report Out start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_ReportOutFailed()

__STATIC_INLINE void EvrUSBH_HID_ReportOutFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Report Out failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_SetIdle()

__STATIC_INLINE void EvrUSBH_HID_SetIdle ( uint8_t instance )

Event on internal operation Set Idle start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_SetIdleFailed()

__STATIC_INLINE void EvrUSBH_HID_SetIdleFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Set Idle failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_SetProtocol()

__STATIC_INLINE void EvrUSBH_HID_SetProtocol ( uint8_t instance )

Event on internal operation Set Protocol start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_SetProtocolFailed()

__STATIC_INLINE void EvrUSBH_HID_SetProtocolFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Set Protocol failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_SetReport()

__STATIC_INLINE void EvrUSBH_HID_SetReport ( uint8_t instance )

Event on internal operation Set Report start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_SetReportFailed()

__STATIC_INLINE void EvrUSBH_HID_SetReportFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation Set Report failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_Unconfigure()

__STATIC_INLINE void EvrUSBH_HID_Unconfigure ( uint8_t instance )

Event on internal operation HID device unconfigure start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_UnconfigureFailed()

__STATIC_INLINE void EvrUSBH_HID_UnconfigureFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation HID device uninitialization failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_Uninitialize()

__STATIC_INLINE void EvrUSBH_HID_Uninitialize ( uint8_t instance )

Event on internal operation HID device uninitialization start (Operation)

Parameters

instance instance of HID device

◆ EvrUSBH_HID_UninitializeFailed()

__STATIC_INLINE void EvrUSBH_HID_UninitializeFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal operation HID device uninitialization failed (Error)

Parameters

instance	instance of HID device
error	error code usbStatus

◆ EvrUSBH_HID_Write()

__STATIC_INLINE void EvrUSBH_HID_Write	(	uint8_t	instance,
		int32_t	len
	)

Event on USBH_HID_Write start (API)

Parameters

instance	instance of HID device
len	number of bytes to write

◆ EvrUSBH_HID_WriteDone()

__STATIC_INLINE void EvrUSBH_HID_WriteDone	(	uint8_t	instance,
		int32_t	len,
		int32_t	result
	)

Event on USBH_HID_Write finished successfully (Detail)

Parameters

instance	instance of HID device
len	number of bytes to write
result	number of bytes accepted for writing

◆ EvrUSBH_HID_WriteFailed()

__STATIC_INLINE void EvrUSBH_HID_WriteFailed	(	uint8_t	instance,
		int32_t	len,
		usbStatus	error
	)

Event on USBH_HID_Write failed (Error)

Parameters

instance	instance of HID device
len	number of bytes to write
error	error code usbStatus

Functions

Description

Function Documentation

◆ EvrUSBH_HID_Configure()

◆ EvrUSBH_HID_ConfigureFailed()

◆ EvrUSBH_HID_GetDevice()

◆ EvrUSBH_HID_GetIdle()

◆ EvrUSBH_HID_GetIdleFailed()

◆ EvrUSBH_HID_GetKeyboardKey()

◆ EvrUSBH_HID_GetKeyboardKeyDone()

◆ EvrUSBH_HID_GetMouseState()

◆ EvrUSBH_HID_GetMouseStateDone()

◆ EvrUSBH_HID_GetMouseStateFailed()

◆ EvrUSBH_HID_GetProtocol()

◆ EvrUSBH_HID_GetProtocolFailed()

◆ EvrUSBH_HID_GetReport()

◆ EvrUSBH_HID_GetReportFailed()

◆ EvrUSBH_HID_GetStatus()

◆ EvrUSBH_HID_Initialize()

◆ EvrUSBH_HID_InitializeFailed()

◆ EvrUSBH_HID_OnDataReceived()

◆ EvrUSBH_HID_OnInitialize()

◆ EvrUSBH_HID_OnParseReportDescriptor()

◆ EvrUSBH_HID_OnUninitialize()

◆ EvrUSBH_HID_Read()

◆ EvrUSBH_HID_ReadDone()

◆ EvrUSBH_HID_ReadFailed()

◆ EvrUSBH_HID_ReportOut()

◆ EvrUSBH_HID_ReportOutFailed()

◆ EvrUSBH_HID_SetIdle()

◆ EvrUSBH_HID_SetIdleFailed()

◆ EvrUSBH_HID_SetProtocol()

◆ EvrUSBH_HID_SetProtocolFailed()

◆ EvrUSBH_HID_SetReport()

◆ EvrUSBH_HID_SetReportFailed()

◆ EvrUSBH_HID_Unconfigure()

◆ EvrUSBH_HID_UnconfigureFailed()

◆ EvrUSBH_HID_Uninitialize()

◆ EvrUSBH_HID_UninitializeFailed()

◆ EvrUSBH_HID_Write()

◆ EvrUSBH_HID_WriteDone()

◆ EvrUSBH_HID_WriteFailed()