From 0bec764c96be46a04d3ea90676f283be8812a9bb Mon Sep 17 00:00:00 2001
From: Gatsby Van <mail.gatsby.icu>
Date: Fri, 22 Dec 2023 01:19:11 +0800
Subject: [PATCH] update comments.

---
 datalink814_ge/src/linklayer/linklayer814.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/datalink814_ge/src/linklayer/linklayer814.c b/datalink814_ge/src/linklayer/linklayer814.c
index d6a34e9..8ced0ea 100644
--- a/datalink814_ge/src/linklayer/linklayer814.c
+++ b/datalink814_ge/src/linklayer/linklayer814.c
@@ -41,20 +41,28 @@ static void L2_SetSlotNum(L2_INST* instPtr, uint32_t newSlotNum);
 static void L2_SetFrameNum(L2_INST* instPtr, uint32_t newFrameNum);
 static void L2_UpdateSlotNum(L2_INST* instPtr);
 static void L2_DataAvailUpdate(L2_INST* instPtr, bool status);
-static void L2_EventPoolHandler(L2_INST* instPtr);
 
+/**
+ * @brief	helper function to update linkelayer state
+ */
 static inline void UpdateMainSate(L2_INST* instPtr, L2_NODE_STATE newSate) {
 	ASSERT(instPtr != NULL);
 	DBG_INFO("MainStateUpdate: %d -> %d\n", instPtr->mainState, newSate);
 	instPtr->nextState = newSate;
 }
 
+/**
+ * @brief	helper function to set slot number.
+ */
 static void L2_SetSlotNum(L2_INST* instPtr, uint32_t newSlotNum){
 	ASSERT(instPtr != NULL);
 	DBG_INFO("Set new slot number to %u\n", newSlotNum);
 	instPtr->slotNum.next = newSlotNum;
 }
 
+/**
+ * @brief	helper function to set frame number
+ */
 static void L2_SetFrameNum(L2_INST* instPtr, uint32_t newFrameNum){
 	ASSERT(instPtr != NULL);
 	DBG_INFO("Set new frame number to %u\n", newFrameNum);