USBD_HID_OS_InputLock
Description
Lock class input report.
Files
usbd_hid_os.h
/usbd_hid_os.c
Prototype
void USBD_HID_OS_InputLock (CPU_INT08U class_nbr, USBD_ERR *p_err);
Arguments
class_nbr
Class instance number.
p_err
Pointer to variable that will receive the return error code from this function.
USBD_ERR_NONE
OS error code(s) relevant to failure(s).
Callers
HID Class.
Implementation Guidelines
The lock operation typically consists in pending on a semaphore. If the semaphore is free, the task continues normally its execution, otherwise it waits until another task releases the semaphore. p_err
argument should be assigned as described in following table:
Table - Error code assignment according to pend operation result
Operation result | Error code to assign |
---|---|
No error | USBD_ERR_NONE |
Pend aborted | USBD_ERR_OS_ABORT |
Pend failed for any other reason | USBD_ERR_OS_FAIL |