Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r8dad6fab1c33602ad94908fd31b8b15153a9eb6e --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 8dad6fab1c33602ad94908fd31b8b15153a9eb6e) @@ -17,26 +17,30 @@ #include "MsgQueues.h" +/** + * @addtogroup MsgQueues + * @{ + */ + // ********** private definitions ********** -#define MAX_MSG_QUEUE_SIZE 100 // messages +#define MAX_MSG_QUEUE_SIZE 100 ///< Number of messages a queue can hold. // ********** 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 ]; ///< Number of messages in each queue. +static U32 msgQueueStarts[ NUM_OF_MSG_QUEUES ]; ///< Starting index for each queue. +static U32 msgQueueNexts[ NUM_OF_MSG_QUEUES ]; ///< Next index for each queue. +static MESSAGE_WRAPPER_T msgQueues[ NUM_OF_MSG_QUEUES ][ MAX_MSG_QUEUE_SIZE ]; ///< The messages in each queue. // ********** private function prototypes ********** -/************************************************************************* - * @brief initMsgQueues +/*********************************************************************//** + * @brief * The initMsgQueues function initializes the MsgQueues module. * @details * Inputs : none - * Outputs : none - * @param none + * Outputs : msgQueueCounts[], msgQueueStarts[], msgQueueNexts[], msgQueues[][] * @return none *************************************************************************/ void initMsgQueues( void ) @@ -56,15 +60,15 @@ } } -/************************************************************************* - * @brief addToMsgQueue - * The addToMsgQueue function adds a message to a given message queue. \n +/*********************************************************************//** + * @brief + * The addToMsgQueue function adds a message to a given message queue. * This function should only be called from the General Task. * @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,26 +90,26 @@ } 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_HD_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_HD_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_INVALID_QUEUE, queue ) } return result; } -/************************************************************************* - * @brief getFromMsgQueue - * The getFromMsgQueue function retrieves the next message from a given \n +/*********************************************************************//** + * @brief + * The getFromMsgQueue function retrieves the next message from a given * message queue. This function should only be called from the General Task. * @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 * message. * @return TRUE if a message was found to retrieve, FALSE if not *************************************************************************/ @@ -133,19 +137,19 @@ } 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_HD_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_GET_INVALID_QUEUE, queue ) } return result; } -/************************************************************************* - * @brief isMsgQueueEmpty +/*********************************************************************//** + * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. * @details - * Inputs : none + * Inputs : msgQueueCounts[] * 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,19 +166,19 @@ } 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_HD_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_EMPTY_INVALID_QUEUE, queue ) } return result; } -/************************************************************************* - * @brief isMsgQueueFull +/*********************************************************************//** + * @brief * The isMsgQueueFull function determines whether a given message queue is full. * @details - * Inputs : none + * Inputs : msgQueueCounts[] * 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,19 +195,19 @@ } 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_HD_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_FULL_INVALID_QUEUE, queue ) } return result; } -/************************************************************************* - * @brief blankMessage +/*********************************************************************//** + * @brief * The blankMessage function blanks a given message. * @details * Inputs : none - * Outputs : none - * @param message : Pointer to the message to blank. + * Outputs : given message is blanked + * @param message Pointer to the message to blank * @return none *************************************************************************/ void blankMessage( MESSAGE_T *message ) @@ -219,13 +223,13 @@ } } -/************************************************************************* - * @brief blankMessageInWrapper +/*********************************************************************//** + * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. * @details * Inputs : none - * Outputs : none - * @param message : Pointer to the message in a wrapper to blank. + * Outputs : given wrapped message is blanked + * @param message Pointer to the message in a wrapper to blank * @return none *************************************************************************/ void blankMessageInWrapper( MESSAGE_WRAPPER_T *message ) @@ -243,3 +247,5 @@ // set msg ID out of bounds in case blank message goes somewhere message->msg.hdr.msgID = 0xFFFF; } + +/**@}*/