Index: firmware/App/Controllers/DGInterface.c =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -ra3a01327c8fe80f65f6658ae6cbef4910a4a8033 --- firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision a3a01327c8fe80f65f6658ae6cbef4910a4a8033) @@ -110,7 +110,7 @@ /*********************************************************************//** * @brief - * The initTreatmentReservoirMgmt function initializes the treatment reservoir \n + * The initTreatmentReservoirMgmt function initializes the treatment reservoir * management state machine. * @details * Inputs : none @@ -127,7 +127,7 @@ /*********************************************************************//** * @brief - * The execTreatmentReservoirMgmt function executes the state machine for the \n + * The execTreatmentReservoirMgmt function executes the state machine for the * reservoir management during treatment mode. * @details * Inputs : none @@ -294,12 +294,12 @@ /*********************************************************************//** * @brief - * The getDGPressure function gets the latest pressure reported by the DG \n + * The getDGPressure function gets the latest pressure reported by the DG * for a given pressure sensor. * @details * Inputs : dgPressures[] * Outputs : none - * @param sensorID : pressure sensor we are getting reading for. + * @param sensorID pressure sensor we are getting reading for * @return Latest pressure reading reported by DG for the given sensor. *************************************************************************/ F32 getDGPressure( DG_PRESSURE_SENSORS_T sensorID ) @@ -312,15 +312,15 @@ } else { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_INVALID_DG_PRESSURE_ID, sensorID ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_INVALID_DG_PRESSURE_ID, sensorID ) } return result; } /*********************************************************************//** * @brief - * The getDGROPumpPressureSetPt function gets the latest RO pump \n + * The getDGROPumpPressureSetPt function gets the latest RO pump * pressure set point reported by the DG. * @details * Inputs : dgROPumpPressureSetPtPSI @@ -336,7 +336,7 @@ /*********************************************************************//** * @brief - * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow \n + * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow * rate reported by the DG. * @details * Inputs : dgROPumpFlowRateMlMin @@ -352,7 +352,7 @@ /*********************************************************************//** * @brief - * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM \n + * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM * set point reported by the DG. * @details * Inputs : dgDrainPumpSpeedSetPtRPM @@ -368,13 +368,13 @@ /*********************************************************************//** * @brief - * The setDGOpMode function sets the latest DG operating mode reported by \n + * The setDGOpMode function sets the latest DG operating mode reported by * the DG. * @details * Inputs : none * Outputs : dgCurrentOpMode - * @param opMode : operating mode reported by DG. - * @param subMode : sub-mode (current state) of operating mode reported by DG. + * @param opMode operating mode reported by DG + * @param subMode sub-mode (current state) of operating mode reported by DG * @return none *************************************************************************/ void setDGOpMode( U32 opMode, U32 subMode ) @@ -392,13 +392,13 @@ /*********************************************************************//** * @brief - * The setDialysateTemperatureReadings function sets the latest dialysate \n + * The setDialysateTemperatureReadings function sets the latest dialysate * temperatures reported by the DG. * @details * Inputs : none * Outputs : dgDialysateTemp, dgRedundantDialysateTemp - * @param temp1 : dialysate temperature reported by DG. - * @param temp2 : redundant dialysate temperature reported by DG. + * @param temp1 dialysate temperature reported by DG + * @param temp2 redundant dialysate temperature reported by DG * @return none *************************************************************************/ void setDialysateTemperatureReadings( F32 temp1, F32 temp2 ) @@ -409,13 +409,13 @@ /*********************************************************************//** * @brief - * The setDGDialysateTemperatures function sets the latest temperature data \n + * The setDGDialysateTemperatures function sets the latest temperature data * reported by the DG. * @details * Inputs : none * Outputs : dgPrimaryTemp, dgTrimmerTemp - * @param primaryHtrTemp : Primary heater temperature reported by DG. - * @param trimmerHtrTemp : Trimmer heater temperature reported by DG. + * @param primaryHtrTemp Primary heater temperature reported by DG + * @param trimmerHtrTemp Trimmer heater temperature reported by DG * @return none *************************************************************************/ void setDGDialysateTemperatures( F32 primaryHtrTemp, F32 trimmerHtrTemp ) @@ -426,14 +426,14 @@ /*********************************************************************//** * @brief - * The setDGReservoirsData function sets the latest reservoir data \n + * The setDGReservoirsData function sets the latest reservoir data * reported by the DG. * @details * Inputs : none * Outputs : dgActiveReservoir, dgReservoirFillVolumeTarget, dgReservoirDrainVolumeTarget - * @param resID : ID of active reservoir. - * @param fillVol : Reservoir fill to volume reported by DG. - * @param drainVol : Reservoir drain to volume reported by DG. + * @param resID ID of active reservoir + * @param fillVol Reservoir fill to volume reported by DG + * @param drainVol Reservoir drain to volume reported by DG * @return none *************************************************************************/ void setDGReservoirsData( DG_RESERVOIR_ID_T resID, U32 fillVol, U32 drainVol ) @@ -456,10 +456,10 @@ * @details * Inputs : none * Outputs : dgPressures[] - * @param roIn : latest RO pump inlet pressure reported by DG. - * @param roOut : latest RO pump outlet pressure reported by DG. - * @param drainIn : latest drain pump inlet pressure reported by DG. - * @param drainOut : latest drain pump outlet pressure reported by DG. + * @param roIn latest RO pump inlet pressure reported by DG + * @param roOut latest RO pump outlet pressure reported by DG + * @param drainIn latest drain pump inlet pressure reported by DG + * @param drainOut latest drain pump outlet pressure reported by DG * @return none *************************************************************************/ void setDGPressures( F32 roIn, F32 roOut, F32 drainIn, F32 drainOut ) @@ -476,8 +476,8 @@ * @details * Inputs : none * Outputs : dgROPumpPressureSetPtPSI, dgROPumpFlowRateMlMin - * @param presSetPt : latest RO pump pressure set point reported by DG. - * @param flowRate : latest RO pump flow rate (LPM) reported by DG. + * @param presSetPt latest RO pump pressure set point reported by DG + * @param flowRate latest RO pump flow rate (LPM) reported by DG * @return none *************************************************************************/ void setDGROPumpData( U32 presSetPt, F32 flowRate ) @@ -492,7 +492,7 @@ * @details * Inputs : none * Outputs : dgDrainPumpSpeedSetPtRPM - * @param rpmSetPt : latest drain pump RPM set point reported by DG. + * @param rpmSetPt latest drain pump RPM set point reported by DG * @return none *************************************************************************/ void setDGDrainPumpData( U32 rpmSetPt ) @@ -502,13 +502,13 @@ /*********************************************************************//** * @brief - * The cmdSetDGDialysateTargetTemps function sends a target dialysate \n + * The cmdSetDGDialysateTargetTemps function sends a target dialysate * temperature command message to the DG. * @details * Inputs : none * Outputs : dgPrimaryTempSet, dgTrimmerTempSet - * @param primaryHtrTemp : commanded target dialysate temperature for the primary heater. - * @param trimmerHtrTemp : commanded target dialysate temperature for the trimmer heater. + * @param primaryHtrTemp commanded target dialysate temperature for the primary heater + * @param trimmerHtrTemp commanded target dialysate temperature for the trimmer heater * @return none *************************************************************************/ void cmdSetDGDialysateTargetTemps( F32 primaryHtrTemp, F32 trimmerHtrTemp ) @@ -520,8 +520,8 @@ /*********************************************************************//** * @brief - * The cmdStartDG function sends a start command to the DG. DG will transition \n - * from standby to re-circulate mode and start producing warm, pure water. + * The cmdStartDG function sends a start command to the DG. DG will transition + * from standby to recirculate mode and start producing warm, pure water. * @details * Inputs : none * Outputs : start DG command sent @@ -535,8 +535,8 @@ /*********************************************************************//** * @brief - * The cmdStopDG function sends a stop command to the DG. DG will transition \n - * from re-circulate mode to standby mode. Pumps and heater go off. + * The cmdStopDG function sends a stop command to the DG. DG will transition + * from recirculate mode to standby mode. Pumps and heater go off. * @details * Inputs : none * Outputs : stop DG command sent @@ -550,7 +550,7 @@ /*********************************************************************//** * @brief - * The cmdStartDGTrimmerHeater function sends a start trimmer heater command \n + * The cmdStartDGTrimmerHeater function sends a start trimmer heater command * to the DG. * @details * Inputs : none @@ -565,7 +565,7 @@ /*********************************************************************//** * @brief - * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command \n + * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command * to the DG. * @details * Inputs : none @@ -580,12 +580,12 @@ /*********************************************************************//** * @brief - * The cmdSetDGActiveReservoir function sends a set active reservoir command \n + * The cmdSetDGActiveReservoir function sends a set active reservoir command * message to the DG. * @details * Inputs : none * Outputs : set active reservoir command sent to DG. - * @param resID : ID of reservoir to set as active (reservoir for HD to draw from). + * @param resID ID of reservoir to set as active (reservoir for HD to draw from) * @return none *************************************************************************/ void cmdSetDGActiveReservoir( DG_RESERVOIR_ID_T resID ) @@ -607,7 +607,7 @@ * @details * Inputs : none * Outputs : fill command sent to DG. - * @param fillToVolMl : volume (in mL) to fill inactive reservoir to. + * @param fillToVolMl volume (in mL) to fill inactive reservoir to * @return none *************************************************************************/ void cmdStartDGFill( U32 fillToVolMl ) @@ -622,7 +622,7 @@ * @details * Inputs : none * Outputs : drain command sent to DG. - * @param drainToVolMl : volume (in mL) to drain inactive reservoir to. + * @param drainToVolMl volume (in mL) to drain inactive reservoir to * @return none *************************************************************************/ void cmdStartDGDrain( U32 drainToVolMl )