add comments.

This commit is contained in:
Gatsby Van
2023-12-27 19:47:06 +08:00
parent 13f07021de
commit 8b46723c20
+20
View File
@@ -61,15 +61,35 @@ int32_t TimeCtrl_Init(TIMECTRL_INST **instPtr, TIMECTRL_CONFIG *config)
return SUCCESS; return SUCCESS;
} }
/*****************************************************************************/
/**
* @brief Completely destroy time control instance.
*
* @param instPtr a pointer to time controller instance
*
* @return NONE
*
******************************************************************************/
void TimeCtrl_Destroy(TIMECTRL_INST *instPtr) void TimeCtrl_Destroy(TIMECTRL_INST *instPtr)
{ {
free(instPtr); free(instPtr);
} }
/*****************************************************************************/
/**
* @brief Read time controller version register.
*
* @param instPtr a pointer to time controller instance
*
* @return timer controller version.
*
******************************************************************************/
uint32_t TimeCtrl_GetVersion(TIMECTRL_INST *instPtr) uint32_t TimeCtrl_GetVersion(TIMECTRL_INST *instPtr)
{ {
ASSERT(instPtr != NULL);
return TMC_Read(instPtr, VERSION_REG); return TMC_Read(instPtr, VERSION_REG);
} }
/*****************************************************************************/ /*****************************************************************************/
/** /**
* @brief Apply a reset process to time controller * @brief Apply a reset process to time controller