diff --git a/datalink814_ge/src/linklayer/linklayer814.c b/datalink814_ge/src/linklayer/linklayer814.c index e34996f..ef037eb 100644 --- a/datalink814_ge/src/linklayer/linklayer814.c +++ b/datalink814_ge/src/linklayer/linklayer814.c @@ -288,7 +288,8 @@ L2_SCHD_EVENT* L2_CreatNewSchdEvent(L2_INST* instPtr, L2_EVENT_TYPE event){ * @brief Delete a schedule event, remove the event from event pool, * release memory, release event ID. * - * @param schdEvent pointer to the schedule event which is aboute to be deleted. + * @param instPtr a pointer to linklayer instance + * @param eventId ID of the event * * @return SUCCESS * error code @@ -317,7 +318,15 @@ int32_t L2_DeletSchdEvent(L2_INST* instPtr, int32_t eventId){ return SUCCESS; } - +/*****************************************************************************/ +/** + * @brief Clear all event in the event pool. + * + * @param instPtr a pointer to linklayer instance + * + * @return NONE + * + ******************************************************************************/ void L2_ClearSchdEvent(L2_INST* instPtr){ ASSERT(instPtr != NULL); for(int32_t i = 0; i < instPtr->schdEventCnt; i++){ @@ -383,6 +392,7 @@ inline bool L2_isEventScheduled(L2_SCHD_EVENT* schdEvent){ /** * @brief Schedule a event at a specific time(indexed by frame and slot number) * + * @param instPtr a pointer to linklayer instance * @param schdEvent pointer to the schedule event. * @param frameNum schedule frame number * @param slotNum schedule slot number @@ -412,6 +422,7 @@ int32_t L2_ScheduleEventAt(L2_INST* instPtr, L2_SCHD_EVENT* schdEvent, uint32_t /** * @brief Schedule a event after a specific time period. * + * @param instPtr a pointer to linklayer instance * @param schdEvent pointer to the schedule event. * @param numSlots how many slot later the event should be scheduled * @@ -434,6 +445,7 @@ int32_t L2_ScheduleEventAfter(L2_INST* instPtr, L2_SCHD_EVENT* schdEvent, uint32 /** * @brief Reschedule a event at a specific time(indexed by frame and slot number) * + * @param instPtr a pointer to linklayer instance * @param schdEvent pointer to the schedule event. * @param frameNum schedule frame number * @param slotNum schedule slot number @@ -455,14 +467,13 @@ int32_t L2_RecheduleEventAt(L2_INST* instPtr, L2_SCHD_EVENT* schdEvent, uint32_t /** * @brief Rechedule a event after a specific time period. * + * @param instPtr a pointer to linklayer instance * @param schdEvent pointer to the schedule event. * @param numSlots how many slot later the event should be scheduled * * @return FAILURE, event has already been scheduled/schedule time not allowed. * SUCCESS * - * @return NONE. - * ******************************************************************************/ int32_t L2_RecheduleEventAfter(L2_INST* instPtr, L2_SCHD_EVENT* schdEvent, uint32_t numSlots){ ASSERT(schdEvent != NULL); @@ -478,7 +489,7 @@ int32_t L2_RecheduleEventAfter(L2_INST* instPtr, L2_SCHD_EVENT* schdEvent, uint3 /** * @brief Check and excute schedule event in event pool illiterate. * - * @param NONE. + * @param instPtr a pointer to linklayer instance * * @return NONE. * @@ -534,7 +545,7 @@ L2_FRAME_TYPE L2_GetLastRcvFrameType(L2_INST* instPtr) { * @brief Update L2 frame state, check if there is any valid L2 frame data in * data buffer, update receive frame status. * - * @param NONE. + * @param instPtr a pointer to linklayer instance * * @return NONE. * @@ -635,7 +646,7 @@ void L2_FrameStateUpdate(L2_INST* instPtr) { /** * @brief Layer 2 setup next slot operation, update current operating frame. * - * @param instPtr a pointer to physical layer controller instance + * @param instPtr a pointer to linklayer instance * @param txrxMode tx/rx state for next slot * @param frameType frame type of next slot. *