Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -rf688e0f8bded1f0a687437e3136cfba8b14f87b6 -r3518e8a088c32e75c0c8960d5e629a7401095feb --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision f688e0f8bded1f0a687437e3136cfba8b14f87b6) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 3518e8a088c32e75c0c8960d5e629a7401095feb) @@ -37,9 +37,9 @@ /*********************************************************************//** * @brief - * The initMsgQueues function initializes the MsgQueues module. - * @details Inputs: none - * @details Outputs: msgQueueCounts[], msgQueueStarts[], msgQueueNexts[], msgQueues[][] + * The initMsgQueues function initializes the MsgQueues unit. + * @details \b Inputs: none + * @details \b Outputs: The MsgQueues unit is initialized. * @return none *************************************************************************/ void initMsgQueues( void ) @@ -62,12 +62,15 @@ /*********************************************************************//** * @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 - * @details 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 - * @return TRUE if message added to queue, FALSE if could not + * @warning This function is not thread safe and should only be called from + * the General Task. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given queue is invalid + * or full. + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: msgQueues[], msgQueueNexts[], msgQueueCounts[] + * @param queue the message queue to add a message to + * @param msg a pointer to a message to add to the queue + * @return TRUE if message added to queue successfully, FALSE if not *************************************************************************/ BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) { @@ -102,12 +105,14 @@ /*********************************************************************//** * @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 - * @details 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 - * message. + * message queue. + * @warning This function is not thread safe and should only be called from + * the General Task. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given queue is invalid. + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: msgQueues[], msgQueueStarts[], msgQueueCounts[] + * @param queue the message queue to retrieve a message from + * @param msg a pointer to a message to populate with the retrieved message. * @return TRUE if a message was found to retrieve, FALSE if not *************************************************************************/ BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg ) @@ -142,9 +147,10 @@ /*********************************************************************//** * @brief - * The isMsgQueueEmpty function determines whether a given message queue is empty. - * @details Inputs: msgQueueCounts[] - * @details Outputs: none + * The isMsgQueueEmpty function determines whether a given message queue is empty. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if the given queue is invalid. + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: none * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ @@ -170,9 +176,10 @@ /*********************************************************************//** * @brief - * The isMsgQueueFull function determines whether a given message queue is full. - * @details Inputs: msgQueueCounts[] - * @details Outputs: none + * The isMsgQueueFull function determines whether a given message queue is full. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if the given queue is invalid. + * @details \b Inputs: msgQueueCounts[] + * @details \b Outputs: none * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ @@ -199,8 +206,8 @@ /*********************************************************************//** * @brief * The blankMessage function blanks a given message. - * @details Inputs: none - * @details Outputs: given message is blanked + * @details \b Inputs: none + * @details \b Outputs: given message is blanked * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -220,8 +227,8 @@ /*********************************************************************//** * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. - * @details Inputs: none - * @details Outputs: given wrapped message is blanked + * @details \b Inputs: none + * @details \b Outputs: given wrapped message is blanked * @param message Pointer to the message in a wrapper to blank * @return none *************************************************************************/