Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rf308cc4c35eab630ebbbde405cfe47d049afeafb --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision f308cc4c35eab630ebbbde405cfe47d049afeafb) @@ -7,8 +7,8 @@ * * @file MsgQueues.c * -* @author (last) Sean -* @date (last) 27-Feb-2020 +* @author (last) Quang Nguyen +* @date (last) 22-Jul-2020 * * @author (original) Dara Navaei * @date (original) 05-Nov-2019 @@ -19,14 +19,14 @@ // ********** private definitions ********** -#define MAX_MSG_QUEUE_SIZE 100 // messages +#define MAX_MSG_QUEUE_SIZE 100 ///< Maximum message queue size // ********** private data ********** -static U32 msgQueueCounts[ NUM_OF_MSG_QUEUES ]; -static U32 msgQueueStarts[ NUM_OF_MSG_QUEUES ]; -static U32 msgQueueNexts[ NUM_OF_MSG_QUEUES ]; -static MESSAGE_WRAPPER_T msgQueues[ NUM_OF_MSG_QUEUES ][ MAX_MSG_QUEUE_SIZE ]; +static U32 msgQueueCounts[ NUM_OF_MSG_QUEUES ]; ///< Message queue count +static U32 msgQueueStarts[ NUM_OF_MSG_QUEUES ]; ///< Start index of a queue +static U32 msgQueueNexts[ NUM_OF_MSG_QUEUES ]; ///< Index to add new message to a queue +static MESSAGE_WRAPPER_T msgQueues[ NUM_OF_MSG_QUEUES ][ MAX_MSG_QUEUE_SIZE ]; ///< Message queues // ********** private function prototypes ********** @@ -36,7 +36,6 @@ * @details * Inputs : none * Outputs : none - * @param none * @return none *************************************************************************/ void initMsgQueues( void ) @@ -63,8 +62,8 @@ * @details * Inputs : none * Outputs : message added to queue - * @param queue : the message queue to add to - * @param msg : a pointer to a message structure to add to the queue + * @param queue the message queue to add to + * @param msg a pointer to a message structure to add to the queue * @return TRUE if message added to queue, FALSE if could not *************************************************************************/ BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) @@ -86,12 +85,12 @@ } else // msg queue is full { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_QUEUE_FULL ) + SET_ALARM_WITH_1_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_QUEUE_FULL ) } } else // invalid message queue { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_INVALID_QUEUE, queue ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_INVALID_QUEUE, queue ) } return result; @@ -104,8 +103,8 @@ * @details * Inputs : queue * Outputs : message retrieved from the queue - * @param queue : the message queue to retrieve from - * @param msg : a pointer to a message structure to populate with the retrieved \n + * @param queue the message queue to retrieve from + * @param msg a pointer to a message structure to populate with the retrieved \n * message. * @return TRUE if a message was found to retrieve, FALSE if not *************************************************************************/ @@ -133,7 +132,7 @@ } else // invalid message queue { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_GET_INVALID_QUEUE, queue ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_GET_INVALID_QUEUE, queue ) } return result; @@ -145,7 +144,7 @@ * @details * Inputs : none * Outputs : none - * @param queue : the message queue to check + * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ BOOL isMsgQueueEmpty( MSG_QUEUE_T queue ) @@ -162,7 +161,7 @@ } else // invalid message queue { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_EMPTY_INVALID_QUEUE, queue ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_EMPTY_INVALID_QUEUE, queue ) } return result; @@ -174,7 +173,7 @@ * @details * Inputs : none * Outputs : none - * @param queue : the message queue to check + * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ BOOL isMsgQueueFull( MSG_QUEUE_T queue ) @@ -191,7 +190,7 @@ } else // invalid message queue { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_FULL_INVALID_QUEUE, queue ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_FULL_INVALID_QUEUE, queue ) } return result; @@ -203,7 +202,7 @@ * @details * Inputs : none * Outputs : none - * @param message : Pointer to the message to blank. + * @param message Pointer to the message to blank * @return none *************************************************************************/ void blankMessage( MESSAGE_T *message ) @@ -225,7 +224,7 @@ * @details * Inputs : none * Outputs : none - * @param message : Pointer to the message in a wrapper to blank. + * @param message Pointer to the message in a wrapper to blank * @return none *************************************************************************/ void blankMessageInWrapper( MESSAGE_WRAPPER_T *message ) @@ -243,6 +242,3 @@ // set msg ID out of bounds in case blank message goes somewhere message->msg.hdr.msgID = 0xFFFF; } - - -