From 8b46723c20eff5f831b01f76a0ac15bf2f1c2777 Mon Sep 17 00:00:00 2001
From: Gatsby Van <mail.gatsby.icu>
Date: Wed, 27 Dec 2023 19:47:06 +0800
Subject: [PATCH] add comments.

---
 datalink814_ge/src/time_ctrl/time_ctrl.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/datalink814_ge/src/time_ctrl/time_ctrl.c b/datalink814_ge/src/time_ctrl/time_ctrl.c
index c4768c7..b4981ad 100644
--- a/datalink814_ge/src/time_ctrl/time_ctrl.c
+++ b/datalink814_ge/src/time_ctrl/time_ctrl.c
@@ -61,15 +61,35 @@ int32_t TimeCtrl_Init(TIMECTRL_INST **instPtr, TIMECTRL_CONFIG *config)
 	return SUCCESS;
 }
 
+/*****************************************************************************/
+/**
+ * @brief   Completely destroy time control instance.
+ *
+ * @param   instPtr a pointer to time controller instance
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
 void TimeCtrl_Destroy(TIMECTRL_INST *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)
 {
+	ASSERT(instPtr != NULL);
 	return TMC_Read(instPtr, VERSION_REG);
 }
+
 /*****************************************************************************/
 /**
  * @brief   Apply a reset process to time controller