Index: firmware/App/Modes/StateTxRecirc.c =================================================================== diff -u -r909d4064e98d5684ee139534f0ac6cbc5f8774d5 -rb30f390acbd6c972d4ecea536b875a409a2c8e77 --- firmware/App/Modes/StateTxRecirc.c (.../StateTxRecirc.c) (revision 909d4064e98d5684ee139534f0ac6cbc5f8774d5) +++ firmware/App/Modes/StateTxRecirc.c (.../StateTxRecirc.c) (revision b30f390acbd6c972d4ecea536b875a409a2c8e77) @@ -214,6 +214,7 @@ * @brief * The execTreatmentRecirc function executes the Treatment Re-circulate * sub-mode state machine. + * @details \b Inputs: ALARM_ID_TD_SOFTWARE_FAULT if exec state is invalid * @details \b Inputs: currentRecircState * @details \b Outputs: currentRecircState, recircTimerCtr * @return none @@ -247,7 +248,9 @@ break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_TREATMENT_RECIRC_INVALID_STATE, (U32)currentRecircState ); + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, + SW_FAULT_ID_TREATMENT_INVALID_RECIRC_STATE, + (U32)currentRecircState ); break; } @@ -366,6 +369,8 @@ * @brief * The signalTreatmentRecircUserAction function signals a re-circ user action * has been requested. The request is handled and responded to. + * @details \b Message \b Sent: MSG_ID_TD_RECIRCULATE_RESPONSE to send response + * for recirc user action acceptance * @details \b Inputs: none * @details \b Outputs: none * @param message UI message which has requested user action @@ -403,7 +408,8 @@ break; case REQUESTED_USER_ACTION_TX_RECIRC_END_TREATMENT: - // Send message to UI to get user confirmation to end treatment - action initiated only upon receipt of user confirmation from UI + // Send message to UI to get user confirmation to end treatment + // - action initiated only upon receipt of user confirmation from UI addConfirmationRequest( GENERIC_CONFIRM_ID_TREATMENT_END, GENERIC_CONFIRM_CMD_REQUEST_OPEN, 0U ); result = TRUE; break; @@ -426,7 +432,10 @@ // Respond to user action request response.accepted = result; response.rejectionReason = rejReason; - sendMessage( MSG_ID_TD_RECIRCULATE_RESPONSE, COMM_BUFFER_OUT_CAN_TD_2_UI, (U08*)&response, sizeof( UI_RESPONSE_PAYLOAD_T ) ); + sendMessage( MSG_ID_TD_RECIRCULATE_RESPONSE, + COMM_BUFFER_OUT_CAN_TD_2_UI, + (U08*)&response, + sizeof( UI_RESPONSE_PAYLOAD_T ) ); return result; } @@ -561,7 +570,7 @@ * The publishTreatmentRecircData function broadcasts re-circulate countdown * data to the UI at 1 Hz. * @details \b Inputs: recircPublishTimerCtr, recircTimerCtr - * @details \b Outputs: none + * @details \b Outputs: recircPublishTimerCtr * @return none *************************************************************************/ static void publishTreatmentRecircData( void ) @@ -577,7 +586,10 @@ recircPublishTimerCtr = 0; - broadcastData( MSG_ID_TD_RECIRCULATE_DATA, COMM_BUFFER_OUT_CAN_TD_BROADCAST, (U08*)&data, sizeof( TREATMENT_RECIRC_PAYLOAD_T ) ); + broadcastData( MSG_ID_TD_RECIRCULATE_DATA, + COMM_BUFFER_OUT_CAN_TD_BROADCAST, + (U08*)&data, + sizeof( TREATMENT_RECIRC_PAYLOAD_T ) ); } }