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

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) More...
 
__STATIC_INLINE void EvrUSBH_HID_ConfigureFailed (usbStatus error)
 Event on internal operation HID device configuration failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_Unconfigure (uint8_t instance)
 Event on internal operation HID device unconfigure start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_UnconfigureFailed (uint8_t instance, usbStatus error)
 Event on internal operation HID device uninitialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_Initialize (uint8_t instance)
 Event on internal operation HID device initialization start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_InitializeFailed (uint8_t instance, usbStatus error)
 Event on internal operation HID device initialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_OnInitialize (uint8_t instance)
 Event on USBH_HID_Initialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_Uninitialize (uint8_t instance)
 Event on internal operation HID device uninitialization start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_UninitializeFailed (uint8_t instance, usbStatus error)
 Event on internal operation HID device uninitialization failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_OnUninitialize (uint8_t instance)
 Event on USBH_HID_Uninitialize user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetDevice (uint8_t instance, uint8_t device)
 Event on USBH_HID_GetDevice finished (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetStatus (uint8_t instance, uint8_t status)
 Event on USBH_HID_GetStatus finished (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_Read (uint8_t instance, int32_t len)
 Event on USBH_HID_Read start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_ReadFailed (uint8_t instance, int32_t len, usbStatus error)
 Event on USBH_HID_Read failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_ReadDone (uint8_t instance, int32_t len, int32_t result)
 Event on USBH_HID_Read finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_HID_Write (uint8_t instance, int32_t len)
 Event on USBH_HID_Write start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_WriteFailed (uint8_t instance, int32_t len, usbStatus error)
 Event on USBH_HID_Write failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_WriteDone (uint8_t instance, int32_t len, int32_t result)
 Event on USBH_HID_Write finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKey (uint8_t instance)
 Event on USBH_HID_GetKeyboardKey start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKeyDone (uint8_t instance, int32_t ch)
 Event on USBH_HID_GetKeyboardKey finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetMouseState (uint8_t instance)
 Event on USBH_HID_GetMouseState start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetMouseStateFailed (uint8_t instance, usbStatus error)
 Event on USBH_HID_GetMouseState failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetMouseStateDone (uint8_t instance, usbHID_MouseState state)
 Event on USBH_HID_GetMouseState finished successfully (Detail) More...
 
__STATIC_INLINE void EvrUSBH_HID_OnParseReportDescriptor (uint8_t instance, uint32_t len)
 Event on USBH_HID_ParseReportDescriptor user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_OnDataReceived (uint8_t instance, uint32_t len)
 Event on USBH_HID_DataReceived user callback function start (API) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetReport (uint8_t instance)
 Event on internal operation Get Report start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetReportFailed (uint8_t instance, usbStatus error)
 Event on internal operation Get Report failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetReport (uint8_t instance)
 Event on internal operation Set Report start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetReportFailed (uint8_t instance, usbStatus error)
 Event on internal operation Set Report failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetIdle (uint8_t instance)
 Event on internal operation Get Idle start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetIdleFailed (uint8_t instance, usbStatus error)
 Event on internal operation Get Idle failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetIdle (uint8_t instance)
 Event on internal operation Set Idle start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetIdleFailed (uint8_t instance, usbStatus error)
 Event on internal operation Set Idle failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetProtocol (uint8_t instance)
 Event on internal operation Get Protocol start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_GetProtocolFailed (uint8_t instance, usbStatus error)
 Event on internal operation Get Protocol failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetProtocol (uint8_t instance)
 Event on internal operation Set Protocol start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_SetProtocolFailed (uint8_t instance, usbStatus error)
 Event on internal operation Set Protocol failed (Error) More...
 
__STATIC_INLINE void EvrUSBH_HID_ReportOut (uint8_t instance)
 Event on internal operation Report Out start (Operation) More...
 
__STATIC_INLINE void EvrUSBH_HID_ReportOutFailed (uint8_t instance, usbStatus error)
 Event on internal operation Report Out failed (Error) More...
 

Description

Events generated by USB Host - Human Interface Device functions.

Function Documentation

__STATIC_INLINE void EvrUSBH_HID_Configure ( uint8_t  instance)

Event on internal operation HID device configuration start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_ConfigureFailed ( usbStatus  error)

Event on internal operation HID device configuration failed (Error)

Parameters
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_GetDevice ( uint8_t  instance,
uint8_t  device 
)

Event on USBH_HID_GetDevice finished (API)

Parameters
instanceinstance of HID device
devicedevice index
  • value <= 127: index of Device
  • value == 255: non-existing Device index
__STATIC_INLINE void EvrUSBH_HID_GetIdle ( uint8_t  instance)

Event on internal operation Get Idle start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_GetIdleFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Get Idle failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKey ( uint8_t  instance)

Event on USBH_HID_GetKeyboardKey start (API)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_GetKeyboardKeyDone ( uint8_t  instance,
int32_t  ch 
)

Event on USBH_HID_GetKeyboardKey finished successfully (Detail)

Parameters
instanceinstance of HID device
chvalue of first received unread character
__STATIC_INLINE void EvrUSBH_HID_GetMouseState ( uint8_t  instance)

Event on USBH_HID_GetMouseState start (API)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_GetMouseStateDone ( uint8_t  instance,
usbHID_MouseState  state 
)

Event on USBH_HID_GetMouseState finished successfully (Detail)

Parameters
instanceinstance of HID device
statemouse state usbHID_MouseState structure
__STATIC_INLINE void EvrUSBH_HID_GetMouseStateFailed ( uint8_t  instance,
usbStatus  error 
)

Event on USBH_HID_GetMouseState failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_GetProtocol ( uint8_t  instance)

Event on internal operation Get Protocol start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_GetProtocolFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Get Protocol failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_GetReport ( uint8_t  instance)

Event on internal operation Get Report start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_GetReportFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Get Report failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_GetStatus ( uint8_t  instance,
uint8_t  status 
)

Event on USBH_HID_GetStatus finished (API)

Parameters
instanceinstance of HID device
statusdevice status usbStatus
__STATIC_INLINE void EvrUSBH_HID_Initialize ( uint8_t  instance)

Event on internal operation HID device initialization start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_InitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation HID device initialization failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_OnDataReceived ( uint8_t  instance,
uint32_t  len 
)

Event on USBH_HID_DataReceived user callback function start (API)

Parameters
instanceinstance of HID device
lenlength of received data
__STATIC_INLINE void EvrUSBH_HID_OnInitialize ( uint8_t  instance)

Event on USBH_HID_Initialize user callback function start (API)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_OnParseReportDescriptor ( uint8_t  instance,
uint32_t  len 
)

Event on USBH_HID_ParseReportDescriptor user callback function start (API)

Parameters
instanceinstance of HID device
lenlength of HID report descriptor
__STATIC_INLINE void EvrUSBH_HID_OnUninitialize ( uint8_t  instance)

Event on USBH_HID_Uninitialize user callback function start (API)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_Read ( uint8_t  instance,
int32_t  len 
)

Event on USBH_HID_Read start (API)

Parameters
instanceinstance of HID device
lennumber of bytes to read
__STATIC_INLINE void EvrUSBH_HID_ReadDone ( uint8_t  instance,
int32_t  len,
int32_t  result 
)

Event on USBH_HID_Read finished successfully (Detail)

Parameters
instanceinstance of HID device
lennumber of bytes to read
resultnumber of bytes read
__STATIC_INLINE void EvrUSBH_HID_ReadFailed ( uint8_t  instance,
int32_t  len,
usbStatus  error 
)

Event on USBH_HID_Read failed (Error)

Parameters
instanceinstance of HID device
lennumber of bytes to read
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_ReportOut ( uint8_t  instance)

Event on internal operation Report Out start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_ReportOutFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Report Out failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_SetIdle ( uint8_t  instance)

Event on internal operation Set Idle start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_SetIdleFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Set Idle failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_SetProtocol ( uint8_t  instance)

Event on internal operation Set Protocol start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_SetProtocolFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Set Protocol failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_SetReport ( uint8_t  instance)

Event on internal operation Set Report start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_SetReportFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation Set Report failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_Unconfigure ( uint8_t  instance)

Event on internal operation HID device unconfigure start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_UnconfigureFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation HID device uninitialization failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_Uninitialize ( uint8_t  instance)

Event on internal operation HID device uninitialization start (Operation)

Parameters
instanceinstance of HID device
__STATIC_INLINE void EvrUSBH_HID_UninitializeFailed ( uint8_t  instance,
usbStatus  error 
)

Event on internal operation HID device uninitialization failed (Error)

Parameters
instanceinstance of HID device
errorerror code usbStatus
__STATIC_INLINE void EvrUSBH_HID_Write ( uint8_t  instance,
int32_t  len 
)

Event on USBH_HID_Write start (API)

Parameters
instanceinstance of HID device
lennumber of bytes to write
__STATIC_INLINE void EvrUSBH_HID_WriteDone ( uint8_t  instance,
int32_t  len,
int32_t  result 
)

Event on USBH_HID_Write finished successfully (Detail)

Parameters
instanceinstance of HID device
lennumber of bytes to write
resultnumber of bytes accepted for writing
__STATIC_INLINE void EvrUSBH_HID_WriteFailed ( uint8_t  instance,
int32_t  len,
usbStatus  error 
)

Event on USBH_HID_Write failed (Error)

Parameters
instanceinstance of HID device
lennumber of bytes to write
errorerror code usbStatus