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

Functions
__STATIC_INLINE void	EvrUSBD_HID_Initialize (uint8_t instance)
	Event on internal library operation HID initialize start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_InitializeFailed (uint8_t instance, usbStatus error)
	Event on internal library operation HID initialize failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_Uninitialize (uint8_t instance)
	Event on internal library operation HID uninitialize start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_UninitializeFailed (uint8_t instance, usbStatus error)
	Event on internal library operation HID uninitialize failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_Reset (uint8_t instance)
	Event on internal library operation HID reset start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_ResetFailed (uint8_t instance, usbStatus error)
	Event on internal library operation HID reset failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_GetReport (uint8_t instance)
	Event on internal library operation Get Report start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_GetReportFailed (uint8_t instance)
	Event on internal library operation Get Report failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_SetReport (uint8_t instance)
	Event on internal library operation Set Report start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_SetReportFailed (uint8_t instance)
	Event on internal library operation Set Report failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_GetIdle (uint8_t instance, uint8_t rid, uint8_t idle)
	Event on internal library operation Get Idle start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_GetIdleFailed (uint8_t instance)
	Event on internal library operation Get Idle failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_SetIdle (uint8_t instance, uint8_t rid, uint8_t idle)
	Event on internal library operation Set Idle start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_SetIdleFailed (uint8_t instance)
	Event on internal library operation Set Idle failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_GetProtocol (uint8_t instance, int8_t protocol)
	Event on internal library operation Get Protocol start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_GetProtocolFailed (uint8_t instance)
	Event on internal library operation Get Protocol failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_SetProtocol (uint8_t instance, uint8_t protocol)
	Event on internal library operation Set Protocol start (Operation) More...

__STATIC_INLINE void	EvrUSBD_HID_SetProtocolFailed (uint8_t instance)
	Event on internal library operation Set Protocol failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_OnInitialize (uint8_t n)
	Event on USBD_HIDn_Initialize user callback function start (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnUninitialize (uint8_t n)
	Event on USBD_HIDn_Uninitialize user callback function start (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnGetReport (uint8_t n, uint8_t rtype, uint8_t req, uint8_t rid, int32_t len)
	Event on USBD_HIDn_GetReport user callback function finished successfully (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnGetReportFailed (uint8_t n, uint8_t rtype, uint8_t req, uint8_t rid)
	Event on USBD_HIDn_GetReport user callback function failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_OnSetReport (uint8_t n, uint8_t rtype, uint8_t req, uint8_t rid, int32_t len)
	Event on USBD_HIDn_SetReport user callback function finished successfully (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnSetReportFailed (uint8_t n, uint8_t rtype, uint8_t req, uint8_t rid, int32_t len)
	Event on USBD_HIDn_SetReport user callback function failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_OnGetProtocol (uint8_t n, int8_t protocol)
	Event on USBD_HIDn_GetProtocol user callback function finished successfully (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnGetProtocolFailed (uint8_t n)
	Event on USBD_HIDn_GetProtocol user callback function failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_OnSetProtocol (uint8_t n, uint8_t protocol)
	Event on USBD_HIDn_SetProtocol user callback function finished successfully (API) More...

__STATIC_INLINE void	EvrUSBD_HID_OnSetProtocolFailed (uint8_t n, uint8_t protocol)
	Event on USBD_HIDn_SetProtocol user callback function failed (Error) More...

__STATIC_INLINE void	EvrUSBD_HID_GetReportTrigger (uint8_t instance, uint32_t rid, const uint8_t *buf, uint32_t len)
	Event on USBD_HID_GetReportTrigger start (API) More...

__STATIC_INLINE void	EvrUSBD_HID_GetReportTriggerFailed (uint8_t instance, usbStatus error)
	Event on USBD_HID_GetReportTrigger failed (Error) More...

Description

Events generated by USB Device - Human Interface Device functions.

Function Documentation

◆ EvrUSBD_HID_Initialize()

__STATIC_INLINE void EvrUSBD_HID_Initialize ( uint8_t instance )

Event on internal library operation HID initialize start (Operation)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_InitializeFailed()

__STATIC_INLINE void EvrUSBD_HID_InitializeFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal library operation HID initialize failed (Error)

Parameters

instance	instance of HID class
error	error code usbStatus

◆ EvrUSBD_HID_Uninitialize()

__STATIC_INLINE void EvrUSBD_HID_Uninitialize ( uint8_t instance )

Event on internal library operation HID uninitialize start (Operation)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_UninitializeFailed()

__STATIC_INLINE void EvrUSBD_HID_UninitializeFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal library operation HID uninitialize failed (Error)

Parameters

instance	instance of HID class
error	error code usbStatus

◆ EvrUSBD_HID_Reset()

__STATIC_INLINE void EvrUSBD_HID_Reset ( uint8_t instance )

Event on internal library operation HID reset start (Operation)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_ResetFailed()

__STATIC_INLINE void EvrUSBD_HID_ResetFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on internal library operation HID reset failed (Error)

Parameters

instance	instance of HID class
error	error code usbStatus

◆ EvrUSBD_HID_GetReport()

__STATIC_INLINE void EvrUSBD_HID_GetReport ( uint8_t instance )

Event on internal library operation Get Report start (Operation)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_GetReportFailed()

__STATIC_INLINE void EvrUSBD_HID_GetReportFailed ( uint8_t instance )

Event on internal library operation Get Report failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_SetReport()

__STATIC_INLINE void EvrUSBD_HID_SetReport ( uint8_t instance )

Event on internal library operation Set Report start (Operation)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_SetReportFailed()

__STATIC_INLINE void EvrUSBD_HID_SetReportFailed ( uint8_t instance )

Event on internal library operation Set Report failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_GetIdle()

__STATIC_INLINE void EvrUSBD_HID_GetIdle	(	uint8_t	instance,
		uint8_t	rid,
		uint8_t	idle
	)

Event on internal library operation Get Idle start (Operation)

Parameters

instance	instance of HID class
rid	report ID
idle	current idle setting

◆ EvrUSBD_HID_GetIdleFailed()

__STATIC_INLINE void EvrUSBD_HID_GetIdleFailed ( uint8_t instance )

Event on internal library operation Get Idle failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_SetIdle()

__STATIC_INLINE void EvrUSBD_HID_SetIdle	(	uint8_t	instance,
		uint8_t	rid,
		uint8_t	idle
	)

Event on internal library operation Set Idle start (Operation)

Parameters

instance	instance of HID class
rid	report ID
idle	idle to set

◆ EvrUSBD_HID_SetIdleFailed()

__STATIC_INLINE void EvrUSBD_HID_SetIdleFailed ( uint8_t instance )

Event on internal library operation Set Idle failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_GetProtocol()

__STATIC_INLINE void EvrUSBD_HID_GetProtocol	(	uint8_t	instance,
		int8_t	protocol
	)

Event on internal library operation Get Protocol start (Operation)

Parameters

instance	instance of HID class
protocol	current protocol

◆ EvrUSBD_HID_GetProtocolFailed()

__STATIC_INLINE void EvrUSBD_HID_GetProtocolFailed ( uint8_t instance )

Event on internal library operation Get Protocol failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_SetProtocol()

__STATIC_INLINE void EvrUSBD_HID_SetProtocol	(	uint8_t	instance,
		uint8_t	protocol
	)

Event on internal library operation Set Protocol start (Operation)

Parameters

instance	instance of HID class
protocol	protocol to set

◆ EvrUSBD_HID_SetProtocolFailed()

__STATIC_INLINE void EvrUSBD_HID_SetProtocolFailed ( uint8_t instance )

Event on internal library operation Set Protocol failed (Error)

Parameters

instance instance of HID class

◆ EvrUSBD_HID_OnInitialize()

__STATIC_INLINE void EvrUSBD_HID_OnInitialize ( uint8_t n )

Event on USBD_HIDn_Initialize user callback function start (API)

Parameters

n	instance of HID class

◆ EvrUSBD_HID_OnUninitialize()

__STATIC_INLINE void EvrUSBD_HID_OnUninitialize ( uint8_t n )

Event on USBD_HIDn_Uninitialize user callback function start (API)

Parameters

n	instance of HID class

◆ EvrUSBD_HID_OnGetReport()

__STATIC_INLINE void EvrUSBD_HID_OnGetReport	(	uint8_t	n,
		uint8_t	rtype,
		uint8_t	req,
		uint8_t	rid,
		int32_t	len
	)

Event on USBD_HIDn_GetReport user callback function finished successfully (API)

Parameters

n	instance of HID class
rtype	report type: HID_REPORT_INPUT = input report requested HID_REPORT_FEATURE = feature report requested
req	request type: USBD_HID_REQ_EP_CTRL = control endpoint request USBD_HID_REQ_PERIOD_UPDATE = idle period expiration request USBD_HID_REQ_EP_INT = previously sent report on interrupt endpoint request
rid	report ID (0 if only one report exists)
len	number of report data bytes prepared to send

◆ EvrUSBD_HID_OnGetReportFailed()

__STATIC_INLINE void EvrUSBD_HID_OnGetReportFailed	(	uint8_t	n,
		uint8_t	rtype,
		uint8_t	req,
		uint8_t	rid
	)

Event on USBD_HIDn_GetReport user callback function failed (Error)

Parameters

n	instance of HID class
rtype	report type: HID_REPORT_INPUT = input report requested HID_REPORT_FEATURE = feature report requested
req	request type: USBD_HID_REQ_EP_CTRL = control endpoint request USBD_HID_REQ_PERIOD_UPDATE = idle period expiration request USBD_HID_REQ_EP_INT = previously sent report on interrupt endpoint request
rid	report ID (0 if only one report exists)

◆ EvrUSBD_HID_OnSetReport()

__STATIC_INLINE void EvrUSBD_HID_OnSetReport	(	uint8_t	n,
		uint8_t	rtype,
		uint8_t	req,
		uint8_t	rid,
		int32_t	len
	)

Event on USBD_HIDn_SetReport user callback function finished successfully (API)

Parameters

n	instance of HID class
rtype	report type: HID_REPORT_OUTPUT = output report requested HID_REPORT_FEATURE = feature report requested
req	request type: USBD_HID_REQ_EP_CTRL = report received on control endpoint USBD_HID_REQ_EP_INT = report received on interrupt endpoint
rid	report ID (0 if only one report exists)
len	length of received report data

◆ EvrUSBD_HID_OnSetReportFailed()

__STATIC_INLINE void EvrUSBD_HID_OnSetReportFailed	(	uint8_t	n,
		uint8_t	rtype,
		uint8_t	req,
		uint8_t	rid,
		int32_t	len
	)

Event on USBD_HIDn_SetReport user callback function failed (Error)

Parameters

n	instance of HID class
rtype	report type: HID_REPORT_OUTPUT = output report requested HID_REPORT_FEATURE = feature report requested
req	request type: USBD_HID_REQ_EP_CTRL = report received on control endpoint USBD_HID_REQ_EP_INT = report received on interrupt endpoint
rid	report ID (0 if only one report exists)
len	length of received report data

◆ EvrUSBD_HID_OnGetProtocol()

__STATIC_INLINE void EvrUSBD_HID_OnGetProtocol	(	uint8_t	n,
		int8_t	protocol
	)

Event on USBD_HIDn_GetProtocol user callback function finished successfully (API)

Parameters

n	instance of HID class
protocol	current protocol

◆ EvrUSBD_HID_OnGetProtocolFailed()

__STATIC_INLINE void EvrUSBD_HID_OnGetProtocolFailed ( uint8_t n )

Event on USBD_HIDn_GetProtocol user callback function failed (Error)

Parameters

n	instance of HID class

◆ EvrUSBD_HID_OnSetProtocol()

__STATIC_INLINE void EvrUSBD_HID_OnSetProtocol	(	uint8_t	n,
		uint8_t	protocol
	)

Event on USBD_HIDn_SetProtocol user callback function finished successfully (API)

Parameters

n	instance of HID class
protocol	protocol to set

◆ EvrUSBD_HID_OnSetProtocolFailed()

__STATIC_INLINE void EvrUSBD_HID_OnSetProtocolFailed	(	uint8_t	n,
		uint8_t	protocol
	)

Event on USBD_HIDn_SetProtocol user callback function failed (Error)

Parameters

n	instance of HID class
protocol	protocol to set

◆ EvrUSBD_HID_GetReportTrigger()

__STATIC_INLINE void EvrUSBD_HID_GetReportTrigger	(	uint8_t	instance,
		uint32_t	rid,
		const uint8_t *	buf,
		uint32_t	len
	)

Event on USBD_HID_GetReportTrigger start (API)

Parameters

instance	instance of HID class
rid	report ID
buf	pointer to data buffer with data to be sent
len	number of bytes to be sent

◆ EvrUSBD_HID_GetReportTriggerFailed()

__STATIC_INLINE void EvrUSBD_HID_GetReportTriggerFailed	(	uint8_t	instance,
		usbStatus	error
	)

Event on USBD_HID_GetReportTrigger failed (Error)

Parameters

instance	instance of HID class
error	error code usbStatus

Functions

Description

Function Documentation

◆ EvrUSBD_HID_Initialize()

◆ EvrUSBD_HID_InitializeFailed()

◆ EvrUSBD_HID_Uninitialize()

◆ EvrUSBD_HID_UninitializeFailed()

◆ EvrUSBD_HID_Reset()

◆ EvrUSBD_HID_ResetFailed()

◆ EvrUSBD_HID_GetReport()

◆ EvrUSBD_HID_GetReportFailed()

◆ EvrUSBD_HID_SetReport()

◆ EvrUSBD_HID_SetReportFailed()

◆ EvrUSBD_HID_GetIdle()

◆ EvrUSBD_HID_GetIdleFailed()

◆ EvrUSBD_HID_SetIdle()

◆ EvrUSBD_HID_SetIdleFailed()

◆ EvrUSBD_HID_GetProtocol()

◆ EvrUSBD_HID_GetProtocolFailed()

◆ EvrUSBD_HID_SetProtocol()

◆ EvrUSBD_HID_SetProtocolFailed()

◆ EvrUSBD_HID_OnInitialize()

◆ EvrUSBD_HID_OnUninitialize()

◆ EvrUSBD_HID_OnGetReport()

◆ EvrUSBD_HID_OnGetReportFailed()

◆ EvrUSBD_HID_OnSetReport()

◆ EvrUSBD_HID_OnSetReportFailed()

◆ EvrUSBD_HID_OnGetProtocol()

◆ EvrUSBD_HID_OnGetProtocolFailed()

◆ EvrUSBD_HID_OnSetProtocol()

◆ EvrUSBD_HID_OnSetProtocolFailed()

◆ EvrUSBD_HID_GetReportTrigger()

◆ EvrUSBD_HID_GetReportTriggerFailed()