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

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

__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
instanceinstance of HID class
ridreport ID
idlecurrent idle setting
__STATIC_INLINE void EvrUSBD_HID_GetIdleFailed ( uint8_t  instance)

Event on internal library operation Get Idle failed (Error)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_GetProtocol ( uint8_t  instance,
int8_t  protocol 
)

Event on internal library operation Get Protocol start (Operation)

Parameters
instanceinstance of HID class
protocolcurrent protocol
__STATIC_INLINE void EvrUSBD_HID_GetProtocolFailed ( uint8_t  instance)

Event on internal library operation Get Protocol failed (Error)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_GetReport ( uint8_t  instance)

Event on internal library operation Get Report start (Operation)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_GetReportFailed ( uint8_t  instance)

Event on internal library operation Get Report failed (Error)

Parameters
instanceinstance of HID class
__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
instanceinstance of HID class
ridreport ID
bufpointer to data buffer with data to be sent
lennumber of bytes to be sent
__STATIC_INLINE void EvrUSBD_HID_GetReportTriggerFailed ( uint8_t  instance,
usbStatus  error 
)

Event on USBD_HID_GetReportTrigger failed (Error)

Parameters
instanceinstance of HID class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_HID_Initialize ( uint8_t  instance)

Event on internal library operation HID initialize start (Operation)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_InitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation HID initialize failed (Error)

Parameters
instanceinstance of HID class
errorerror code usbStatus
__STATIC_INLINE void EvrUSBD_HID_OnGetProtocol ( uint8_t  n,
int8_t  protocol 
)

Event on USBD_HIDn_GetProtocol user callback function finished successfully (API)

Parameters
ninstance of HID class
protocolcurrent protocol
__STATIC_INLINE void EvrUSBD_HID_OnGetProtocolFailed ( uint8_t  n)

Event on USBD_HIDn_GetProtocol user callback function failed (Error)

Parameters
ninstance of HID class
__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
ninstance of HID class
rtypereport type:
  • HID_REPORT_INPUT = input report requested
  • HID_REPORT_FEATURE = feature report requested
reqrequest 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
ridreport ID (0 if only one report exists)
lennumber of report data bytes prepared to send
__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
ninstance of HID class
rtypereport type:
  • HID_REPORT_INPUT = input report requested
  • HID_REPORT_FEATURE = feature report requested
reqrequest 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
ridreport ID (0 if only one report exists)
__STATIC_INLINE void EvrUSBD_HID_OnInitialize ( uint8_t  n)

Event on USBD_HIDn_Initialize user callback function start (API)

Parameters
ninstance of HID class
__STATIC_INLINE void EvrUSBD_HID_OnSetProtocol ( uint8_t  n,
uint8_t  protocol 
)

Event on USBD_HIDn_SetProtocol user callback function finished successfully (API)

Parameters
ninstance of HID class
protocolprotocol to set
__STATIC_INLINE void EvrUSBD_HID_OnSetProtocolFailed ( uint8_t  n,
uint8_t  protocol 
)

Event on USBD_HIDn_SetProtocol user callback function failed (Error)

Parameters
ninstance of HID class
protocolprotocol to set
__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
ninstance of HID class
rtypereport type:
  • HID_REPORT_OUTPUT = output report requested
  • HID_REPORT_FEATURE = feature report requested
reqrequest type:
  • USBD_HID_REQ_EP_CTRL = report received on control endpoint
  • USBD_HID_REQ_EP_INT = report received on interrupt endpoint
ridreport ID (0 if only one report exists)
lenlength of received report data
__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
ninstance of HID class
rtypereport type:
  • HID_REPORT_OUTPUT = output report requested
  • HID_REPORT_FEATURE = feature report requested
reqrequest type:
  • USBD_HID_REQ_EP_CTRL = report received on control endpoint
  • USBD_HID_REQ_EP_INT = report received on interrupt endpoint
ridreport ID (0 if only one report exists)
lenlength of received report data
__STATIC_INLINE void EvrUSBD_HID_OnUninitialize ( uint8_t  n)

Event on USBD_HIDn_Uninitialize user callback function start (API)

Parameters
ninstance of HID class
__STATIC_INLINE void EvrUSBD_HID_Reset ( uint8_t  instance)

Event on internal library operation HID reset start (Operation)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_ResetFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation HID reset failed (Error)

Parameters
instanceinstance of HID class
errorerror code usbStatus
__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
instanceinstance of HID class
ridreport ID
idleidle to set
__STATIC_INLINE void EvrUSBD_HID_SetIdleFailed ( uint8_t  instance)

Event on internal library operation Set Idle failed (Error)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_SetProtocol ( uint8_t  instance,
uint8_t  protocol 
)

Event on internal library operation Set Protocol start (Operation)

Parameters
instanceinstance of HID class
protocolprotocol to set
__STATIC_INLINE void EvrUSBD_HID_SetProtocolFailed ( uint8_t  instance)

Event on internal library operation Set Protocol failed (Error)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_SetReport ( uint8_t  instance)

Event on internal library operation Set Report start (Operation)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_SetReportFailed ( uint8_t  instance)

Event on internal library operation Set Report failed (Error)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_Uninitialize ( uint8_t  instance)

Event on internal library operation HID uninitialize start (Operation)

Parameters
instanceinstance of HID class
__STATIC_INLINE void EvrUSBD_HID_UninitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal library operation HID uninitialize failed (Error)

Parameters
instanceinstance of HID class
errorerror code usbStatus