forked from gatsby/datalink_repo
update comments.
This commit is contained in:
@@ -53,8 +53,9 @@ static int32_t MgmtPkt_Packing(L2_INST* instPtr, MGMTPKT_TYPE pktType);
|
||||
/**
|
||||
* @brief Packing management message to a bit array.
|
||||
*
|
||||
* @param instPtr a pointer to l2 instance.
|
||||
* @param bitarr pointer to bit array buffer.
|
||||
* msgType message type.
|
||||
* @param msgType message type.
|
||||
*
|
||||
* @return EPARAM
|
||||
* SUCCESS
|
||||
@@ -423,7 +424,7 @@ static int32_t MgmtMsg_Packing(L2_INST* instPtr, BIT_ARRAY* bitarr, L2_MSG_TYPE
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*****************************************************************************/
|
||||
static int32_t MgmtPkt_Packing(L2_INST* instPtr, MGMTPKT_TYPE pktType) {
|
||||
ASSERT(instPtr != NULL);
|
||||
uint8_t* buff = instPtr->sendPktData;
|
||||
@@ -517,6 +518,15 @@ int32_t MgmtNet_Init(L2_MGMT_FSM** mgmtFSM) {
|
||||
return SUCCESS;
|
||||
}
|
||||
|
||||
/*****************************************************************************/
|
||||
/**
|
||||
* @brief Reset management net FSM.
|
||||
*
|
||||
* @param mgmtFSM a pointer to l2 management net FSM instance.
|
||||
*
|
||||
* @return NONE
|
||||
*
|
||||
******************************************************************************/
|
||||
void MgmtNet_Reset(L2_MGMT_FSM* mgmtFSM) {
|
||||
mgmtFSM->isBisarProc = false;
|
||||
mgmtFSM->isPendSlotAlloc = false;
|
||||
@@ -542,18 +552,28 @@ void MgmtNet_Reset(L2_MGMT_FSM* mgmtFSM) {
|
||||
// clear buffer.
|
||||
memset(&(mgmtFSM->rttMsgRspLog), 0x00, sizeof(RTT_MSG_RECORD));
|
||||
memset(&(mgmtFSM->rttMsgReqLog), 0x00, sizeof(RTT_MSG_RECORD));
|
||||
memset(&(mgmtFSM->rttData), 0x00, sizeof(RTT_DATA));
|
||||
}
|
||||
|
||||
|
||||
/*****************************************************************************/
|
||||
/**
|
||||
* @brief Destroy management net FSM, free all allocated memory.
|
||||
*
|
||||
* @param mgmtFSM a pointer to l2 management net FSM instance.
|
||||
*
|
||||
* @return NONE
|
||||
*
|
||||
******************************************************************************/
|
||||
void MgmtNet_Destroy(L2_MGMT_FSM* mgmtFSM){
|
||||
free(mgmtFSM);
|
||||
}
|
||||
|
||||
/*****************************************************************************/
|
||||
/**
|
||||
* @brief Handles management net packet, apply time sync and other management
|
||||
* net functions.
|
||||
*
|
||||
* @param msg A pointer to packet data buffer.
|
||||
* @param instPtr a pointer to l2 instance.
|
||||
*
|
||||
* @return SUCCESS Packet was successfully handled.
|
||||
* Other Packed was dumped(not addressed to me, unrecognized frame type)
|
||||
@@ -594,6 +614,7 @@ int32_t MgmtNet_PktHandler(L2_INST* instPtr) {
|
||||
FrameGetChunk(mgmtMsg, TK_MSG_INI_STAG_OFFSET, TK_MSG_INI_STAG_LEN, &dataChunk);
|
||||
mgmtMsgLog->msgSubTag = (uint8_t) (dataChunk);
|
||||
|
||||
// Preventing the error response caused by unexpected bit error.
|
||||
if ( mgmtMsgLog->wordTag == 3
|
||||
&& mgmtMsgLog->msgTag == 28
|
||||
&& mgmtMsgLog->msgSubTag == 1 ) {
|
||||
@@ -828,14 +849,21 @@ failed:
|
||||
return Status;
|
||||
}
|
||||
|
||||
// helper function
|
||||
|
||||
/**
|
||||
* @brief Helper function for check node TTL.
|
||||
* @param entry
|
||||
* @return trur/false
|
||||
*/
|
||||
static bool IsTTLValid(NODE_ENTRY* entry) {
|
||||
ASSERT(entry != NULL);
|
||||
return (entry->ttlCnt <= CONN_LOST_TH);
|
||||
return (entry->ttlCnt <= CONX_LOST_TH);
|
||||
}
|
||||
|
||||
|
||||
/*****************************************************************************/
|
||||
/**
|
||||
* @brief Management net FSM procedure.
|
||||
* @brief Management net FSM routine.
|
||||
*
|
||||
* @param mgmtFSM
|
||||
* mainState
|
||||
|
||||
Reference in New Issue
Block a user