Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Hw Lock Ctrl Driver Interface
/**
* @brief HwLockCtrlSelfTestResult enumerates possible self test results.
*/
typedef enum HwLockCtrlSelfTestResult
{
HW_LOCK_CTRL_SELF_TEST_PASSED,
HW_LOCK_CTRL_SELF_TEST_FAILED_POWER,
HW_LOCK_CTRL_SELF_TEST_FAILED_MOTOR,
} HwLockCtrlSelfTestResultT;
/**
* @brief HwLockCtrlInit initializes the driver. Lock state is undefined.
* @return true - initialization completed successfully. false - some error.
*/
bool HwLockCtrlInit();
/**
* @brief HwLockCtrlLock locks the lock.
* @return true - lock operation completed successfully. false - some error.
*/
bool HwLockCtrlLock();
/**
* @brief HwLockCtrlUnlock unlocks the lock.
* @return true - unlock operation completed successfully. false - some error.
*/
bool HwLockCtrlUnlock();
/**
* @brief HwLockCtrlSelfTest executes a self test. When completed, the Lock is always LOCKED.
* @arg outResult: [out] output the self test results
* @return true - self test completed and results are available in 'outResult'
* false - self test failed to execute.
*/
bool HwLockCtrlSelfTest(HwLockCtrlSelfTestResultT* outResult);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.