Index: firmware/App/Controllers/DialOutFlow.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -222,7 +222,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpTargetRate function sets a new target flow rate, pump \n + * The setDialOutPumpTargetRate function sets a new target flow rate, pump * direction, and control mode. * @details * Inputs : isDialOutPumpOn, dialOutPumpDirectionSet @@ -295,7 +295,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -312,7 +312,7 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpHardStop function stops the dialysate outlet pump \n + * The signalDialOutPumpHardStop function stops the dialysate outlet pump * immediately. * @details * Inputs : none @@ -331,8 +331,8 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet \n - * pump rotor hall sensor detection. Calculates rotor speed (in RPM). \n + * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet + * pump rotor hall sensor detection. Calculates rotor speed (in RPM). * Stops pump if there is a pending request to home the pump. * @details * Inputs : dopRotorRevStartTime, dopStopAtHomePosition @@ -380,7 +380,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -405,8 +405,8 @@ /*********************************************************************//** * @brief execDialOutFlowMonitor - * The execDialOutFlowMonitor function executes the dialysate outlet pump \n - * and load cell sensor monitor. Checks are performed. Data is published \n + * The execDialOutFlowMonitor function executes the dialysate outlet pump + * and load cell sensor monitor. Checks are performed. Data is published * at appropriate interval. * @details * Inputs : latest sensor data @@ -442,7 +442,7 @@ /*********************************************************************//** * @brief execDialOutFlowController - * The execDialOutFlowController function executes the dialysate outlet pump \n + * The execDialOutFlowController function executes the dialysate outlet pump * ultrafiltration controller state machine. * @details * Inputs : dialOutPumpState @@ -477,7 +477,7 @@ /*********************************************************************//** * @brief handleDialOutPumpOffState - * The handleDialOutPumpOffState function handles the dialOut pump off state \n + * The handleDialOutPumpOffState function handles the dialOut pump off state * of the dialOut pump controller state machine. * @details * Inputs : targetDialOutFlowRate, dialOutPumpDirection @@ -510,7 +510,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingUpState - * The handleDialOutPumpRampingUpState function handles the ramp up state \n + * The handleDialOutPumpRampingUpState function handles the ramp up state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -554,7 +554,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingDownState - * The handleDialOutPumpRampingDownState function handles the ramp down state \n + * The handleDialOutPumpRampingDownState function handles the ramp down state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -596,7 +596,7 @@ /*********************************************************************//** * @brief handleDialOutPumpControlToTargetState - * The handleDialOutPumpControlToTargetState function handles the "control to \n + * The handleDialOutPumpControlToTargetState function handles the "control to * target" state of the dialOut pump controller state machine. * @details * Inputs : dopControlTimerCounter, dialOutPumpControlModeSet, volumes. @@ -637,7 +637,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of \n + * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of * the dialysate outlet pump to a given %. * @details * Inputs : none @@ -652,7 +652,7 @@ /*********************************************************************//** * @brief stopDialOutPump - * The stopDialOutPump function sets the dialout flow stop signal and PWM \n + * The stopDialOutPump function sets the dialout flow stop signal and PWM * duty cycle to 0.0. * @details * Inputs : none @@ -682,7 +682,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpDirection function sets the set dialOut pump direction to \n + * The setDialOutPumpDirection function sets the set dialOut pump direction to * the given direction. * @details * Inputs : none @@ -712,7 +712,7 @@ /*********************************************************************//** * @brief - * The publishDialOutFlowData function publishes dialysate outlet data at \n + * The publishDialOutFlowData function publishes dialysate outlet data at * the set interval. * @details * Inputs : Dialysate outlet pump data @@ -739,8 +739,8 @@ /*********************************************************************//** * @brief - * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates \n - * the dialysate outlet pump motor speed and direction from hall sensor counter on \n + * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates + * the dialysate outlet pump motor speed and direction from hall sensor counter on * a 1 second interval. * @details * Inputs : dopLastMotorHallSensorCount, dopMotorSpeedCalcTimerCtr, current count from FPGA @@ -778,8 +778,8 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet + * pump. If homing, this function will stop when hall sensor detected. If pump * is off or running very slowly, rotor speed will be set to zero. * @details * Inputs : dopStopAtHomePosition, dopHomeStartTime, dopRotorRevStartTime @@ -805,7 +805,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpDirection function checks the set direction vs. \n + * The checkDialOutPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : adcDialOutPumpMCSpeedRPM, dialOutPumpDirectionSet, dialOutPumpState @@ -831,11 +831,11 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpSpeeds function checks several aspects of the dialysate \n - * outlet pump speed. \n - * 1. while pump is commanded off, measured motor speed should be < limit. \n - * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkDialOutPumpSpeeds function checks several aspects of the dialysate + * outlet pump speed. + * 1. while pump is commanded off, measured motor speed should be < limit. + * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. + * 3. measured motor speed should be within allowed range of measured rotor speed. * All 3 checks have a persistence time that must be met before an alarm is triggered. * @details * Inputs : targetDialOutFlowRate, dialOutPumpSpeedRPM, dialOutPumpRotorSpeedRPM @@ -916,7 +916,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpMCCurrent function checks the measured MC current vs. \n + * The checkDialOutPumpMCCurrent function checks the measured MC current vs. * the set state of the dialOut pump (stopped or running). * @details * Inputs : dialOutPumpState, dopCurrErrorDurationCtr, adcDialOutPumpMCCurrentmA @@ -974,7 +974,7 @@ /*********************************************************************//** * @brief - * The getPublishDialOutFlowDataInterval function gets the dialysate out flow \n + * The getPublishDialOutFlowDataInterval function gets the dialysate out flow * data publication interval. * @details * Inputs : dialOutDataPublishInterval @@ -1067,7 +1067,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate \n + * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate * outlet pump rotor speed. * @details * Inputs : dialOutPumpRotorSpeedRPM @@ -1088,7 +1088,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet \n + * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet * pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1109,7 +1109,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump * speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1130,7 +1130,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump * current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1157,7 +1157,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the \n + * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the * dialout data publish interval. * @details * Inputs : none @@ -1183,7 +1183,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override \n + * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override * of the dialout data publish interval. * @details * Inputs : none @@ -1206,7 +1206,7 @@ /*********************************************************************//** * @brief - * The testSetTargetDialOutFlowRateOverride function overrides the target \n + * The testSetTargetDialOutFlowRateOverride function overrides the target * dialysate outlet flow rate. * @details * Inputs : none @@ -1242,7 +1242,7 @@ /*********************************************************************//** * @brief - * The testResetTargetDialOutFlowRateOverride function resets the override of the \n + * The testResetTargetDialOutFlowRateOverride function resets the override of the * target dialysate outlet flow rate. * @details * Inputs : none @@ -1263,7 +1263,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFRefVolumeOverride function overrides the target \n + * The testSetDialOutUFRefVolumeOverride function overrides the target * dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1287,7 +1287,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFRefVolumeOverride function resets the override of the \n + * The testResetDialOutUFRefVolumeOverride function resets the override of the * target dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1310,7 +1310,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFTotVolumeOverride function overrides the measured \n + * The testSetDialOutUFTotVolumeOverride function overrides the measured * dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1334,7 +1334,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFTotVolumeOverride function resets the override of the \n + * The testResetDialOutUFTotVolumeOverride function resets the override of the * measured dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1357,7 +1357,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured * dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1381,7 +1381,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the * measured dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1404,7 +1404,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1428,7 +1428,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1451,7 +1451,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1475,7 +1475,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1498,7 +1498,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured * dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1522,7 +1522,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the * measured dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1545,7 +1545,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutLoadCellWeightOverride function overrides the value of the \n + * The testSetDialOutLoadCellWeightOverride function overrides the value of the * load cell sensor with a given weight (in grams). * @details * Inputs : loadCellWeightInGrams[] @@ -1573,7 +1573,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutLoadCellWeightOverride function resets the override of the \n + * The testResetDialOutLoadCellWeightOverride function resets the override of the * load cell sensor. * @details * Inputs : loadCellWeightInGrams[] Index: firmware/App/HDCommon.h =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/HDCommon.h (.../HDCommon.h) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/HDCommon.h (.../HDCommon.h) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -71,13 +71,10 @@ // **** Common Definitions **** - // **** Common Macros **** - /**@}*/ - // **** VectorCAST Definitions **** #ifdef _VECTORCAST_ Index: firmware/App/Modes/Dialysis.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -77,8 +77,8 @@ /*********************************************************************//** * @brief - * The initDialysis function initializes the Dialysis sub-mode module. \n - * Calling this function will reset dialysis and therefore should only \n + * The initDialysis function initializes the Dialysis sub-mode module. + * Calling this function will reset dialysis and therefore should only * be called when a new treatment is due to begin. * @details * Inputs : none @@ -112,10 +112,10 @@ /*********************************************************************//** * @brief - * The transitionToDialysis function prepares for transition to dialysis sub-mode. \n - * This function will reset anything required for resuming dialysis in a \n - * treatment that has already begun. It does not reset everything as dialysis \n - * may be stopped and resumed multiple times due to alarms or user intervention \n + * The transitionToDialysis function prepares for transition to dialysis sub-mode. + * This function will reset anything required for resuming dialysis in a + * treatment that has already begun. It does not reset everything as dialysis + * may be stopped and resumed multiple times due to alarms or user intervention * and we don't want to start the treatment all over again. * @details * Inputs : none @@ -129,8 +129,8 @@ /*********************************************************************//** * @brief - * The setDialysisParams function sets the dialysis treatment parameters. \n - * This function should be called prior to beginning dialysis treatment \n + * The setDialysisParams function sets the dialysis treatment parameters. + * This function should be called prior to beginning dialysis treatment * and when the user changes one or more parameters during treatment. * @details * Inputs : none @@ -158,8 +158,8 @@ /*********************************************************************//** * @brief - * The startDialysis function starts/resumes dialysis. This function \n - * will be called by Treatment Mode when beginning or resuming dialysis \n + * The startDialysis function starts/resumes dialysis. This function + * will be called by Treatment Mode when beginning or resuming dialysis * treatment. * @details * Inputs : none @@ -178,8 +178,8 @@ /*********************************************************************//** * @brief - * The stopDialysis function stops dialysis. This function will be called \n - * by Treatment Mode when an alarm occurs or the user pressed the stop button. \n + * The stopDialysis function stops dialysis. This function will be called + * by Treatment Mode when an alarm occurs or the user pressed the stop button. * Dialysis may be resumed later. * @details * Inputs : none @@ -221,7 +221,7 @@ /*********************************************************************//** * @brief - * The getUltrafiltrationVolumeCollected function gets the current ultrafiltration \n + * The getUltrafiltrationVolumeCollected function gets the current ultrafiltration * volume collected so far for current treatment. * @details * Inputs : measUFVolume, measUFVolumeFromPriorReservoirs @@ -371,7 +371,7 @@ /*********************************************************************//** * @brief - * The handleDialysisUltrafiltrationState function handles the ultrafiltration \n + * The handleDialysisUltrafiltrationState function handles the ultrafiltration * state of the Dialysis state machine. * @details * Inputs : currentUFState @@ -414,7 +414,7 @@ /*********************************************************************//** * @brief - * The handleDialysisSolutionInfusionState function handles the solution \n + * The handleDialysisSolutionInfusionState function handles the solution * infustion state of the Dialysis state machine. * @details * Inputs : TBD @@ -432,7 +432,7 @@ /*********************************************************************//** * @brief - * The handleUFStartState function handles the Start state of the \n + * The handleUFStartState function handles the Start state of the * ultrafiltration state machine. * @details * Inputs : maxUFVolumeML @@ -460,7 +460,7 @@ /*********************************************************************//** * @brief - * The handleUFPausedState function handles the Paused state of the \n + * The handleUFPausedState function handles the Paused state of the * ultrafiltration state machine. * @details * Inputs : none @@ -486,11 +486,11 @@ /*********************************************************************//** * @brief - * The handleUFRunningState function handles the Running state of the \n + * The handleUFRunningState function handles the Running state of the * ultrafiltration state machine. * @details * Inputs : ms timer, lastUFTimeStamp - * Outputs : UF timer incremented, UF volumes updated and provided to DPo \n + * Outputs : UF timer incremented, UF volumes updated and provided to DPo * pump controller. * @return next ultrafiltration state. *************************************************************************/ @@ -528,7 +528,7 @@ /*********************************************************************//** * @brief - * The handleUFCompletedOrOffState function handles the UF Off state \n + * The handleUFCompletedOrOffState function handles the UF Off state * of the ultrafiltration state machine. * @details * Inputs : none @@ -547,7 +547,7 @@ /*********************************************************************//** * @brief - * The handleUFCompletedState function handles the UF Completed \n + * The handleUFCompletedState function handles the UF Completed * state of the ultrafiltration state machine. This is a terminal state. * @details * Inputs : none @@ -566,7 +566,7 @@ /*********************************************************************//** * @brief - * The checkUF function checks ultrafiltration accuracy for the last \n + * The checkUF function checks ultrafiltration accuracy for the last * minute and checks total UF volume. Triggers an alarm if out of spec. * @details * Inputs : uFAccuracyCheckTimerCtr, lastUFVolumeChecked, measUFVolume @@ -603,9 +603,9 @@ /*********************************************************************//** * @brief - * The updateUFVolumes function updates the ultrafiltration volumes based on \n - * set UF rate, latest UF elapsed time, and the latest load cell weight for the \n - * currently used reservoir. Updated UF volumes are then sent to the dialysate \n + * The updateUFVolumes function updates the ultrafiltration volumes based on + * set UF rate, latest UF elapsed time, and the latest load cell weight for the + * currently used reservoir. Updated UF volumes are then sent to the dialysate * outlet pump controller. * @details * Inputs : setUFRate, uFTimeMS, load cell weight @@ -635,8 +635,8 @@ /*********************************************************************//** * @brief - * The setStartReservoirVolume function updates the baseline volume of the \n - * next reservoir to be drawn from before it is switched to (i.e. while it \n + * The setStartReservoirVolume function updates the baseline volume of the + * next reservoir to be drawn from before it is switched to (i.e. while it * is the inactive reservoir) in order to get a more stable volume. * @details * Inputs : active reservoir, load cell reading from inactive reservoir @@ -667,8 +667,8 @@ /*********************************************************************//** * @brief - * The signalReservoirsSwitched function informs this module that the \n - * reservoirs have been switched. The UF volume from prior reservoirs is \n + * The signalReservoirsSwitched function informs this module that the + * reservoirs have been switched. The UF volume from prior reservoirs is * tentatively added to with a load cell reading of the inactive reservoir. * @details * Inputs : resFinalVolume[], resStartVolume[] @@ -686,8 +686,8 @@ /*********************************************************************//** * @brief - * The setFinalReservoirVolume function updates the UF volume from prior reservoirs \n - * with a more stable final reservoir volume of the prior reservoir after it's \n + * The setFinalReservoirVolume function updates the UF volume from prior reservoirs + * with a more stable final reservoir volume of the prior reservoir after it's * had a moment to settle. * @details * Inputs : active reservoir, load cell reading from inactive reservoir Index: firmware/App/Modes/ModePreTreat.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -27,17 +27,17 @@ static U32 start; #endif - /** - * @addtogroup HDPreTreatmentMode - * @{ - */ +/** + * @addtogroup HDPreTreatmentMode + * @{ + */ // ********** private data ********** // ********** private function prototypes ********** -/************************************************************************* - * @brief initPreTreatmentMode +/*********************************************************************//** + * @brief * The initPreTreatmentMode function initializes the Pre-Treatment Mode module. * @details * Inputs : none @@ -48,13 +48,13 @@ { } -/************************************************************************* - * @brief transitionToPreTreatmentMode - * The transitionToPreTreatmentMode function prepares for transition to \n +/*********************************************************************//** + * @brief + * The transitionToPreTreatmentMode function prepares for transition to * pre-treatment mode. * @details * Inputs : none - * Outputs : + * Outputs : none * @return none *************************************************************************/ void transitionToPreTreatmentMode( void ) @@ -71,12 +71,12 @@ #endif } -/************************************************************************* - * @brief execPreTreatmentMode +/*********************************************************************//** + * @brief * The execFaultMode function executes the Pre-Treatment Mode state machine. * @details * Inputs : none - * Outputs : + * Outputs : none * @return current state (sub-mode) *************************************************************************/ U32 execPreTreatmentMode( void ) Index: firmware/App/Modes/ModeTreatment.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -33,10 +33,10 @@ static U32 start; #endif - /** - * @addtogroup HDTreatmentMode - * @{ - */ +/** + * @addtogroup HDTreatmentMode + * @{ + */ // ********** private definitions ********** @@ -160,8 +160,8 @@ * @brief * The execTreatmentMode function executes the Treatment Mode state machine. * @details - * Inputs : none - * Outputs : + * Inputs : currentTreatmentState + * Outputs : currentTreatmentState * @return current state (sub-mode) *************************************************************************/ U32 execTreatmentMode( void ) @@ -246,11 +246,11 @@ /*********************************************************************//** * @brief - * The handleTreatmentStartState function handles the Start state of \n + * The handleTreatmentStartState function handles the Start state of * the Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatmentTimeMS, lastTreatmentTimeStamp * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStartState( void ) @@ -277,11 +277,12 @@ /*********************************************************************//** * @brief - * The handleTreatmentDialysisState function handles the Dialysis state of \n + * The handleTreatmentDialysisState function handles the Dialysis state of * the Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatmentTimeMS, lastTreatmentTimeStamp, dialysis sub-mode + * executed. * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentDialysisState( void ) @@ -328,11 +329,11 @@ /*********************************************************************//** * @brief - * The handleTreatmentStopState function executes the Stop state of the \n + * The handleTreatmentStopState function executes the Stop state of the * Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatment stop sub-mode executed. * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStopState( void ) @@ -364,7 +365,7 @@ /*********************************************************************//** * @brief - * The verifyTreatmentDurationSettingChange function verifies and responds to \n + * The verifyTreatmentDurationSettingChange function verifies and responds to * the user treatment duration setting change request. * @details * Inputs : current operating mode, treatment states and parameters @@ -443,7 +444,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsChange function verifies and responds to a new \n + * The verifyUFSettingsChange function verifies and responds to a new * ultrafiltration volume setting from the user. * @details * Inputs : current operating mode, treatment states and parameters @@ -546,7 +547,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsConfirmation function verifies the user confirmed \n + * The verifyUFSettingsConfirmation function verifies the user confirmed * ultrafiltration settings change(s) and, if valid, accepts the new settings. * @details * Inputs : current operating mode, treatment states and parameters @@ -610,7 +611,7 @@ /*********************************************************************//** * @brief - * The verifyBloodAndDialysateRateSettingsChange function verifies the \n + * The verifyBloodAndDialysateRateSettingsChange function verifies the * user blood & dialysate flow rate settings change. * @details * Inputs : current operating mode, treatment states and parameters @@ -670,7 +671,7 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentTimeAndState function broadcasts treatment time and \n + * The broadcastTreatmentTimeAndState function broadcasts treatment time and * state data during treatment. * @details * Inputs : treatment time and state data @@ -705,9 +706,9 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentSettingsRanges function computes and broadcasts \n - * updated treatment parameter ranges that the user may change during treatment. \n - * It is assumed that prescription settings have already been set prior to calling \n + * The broadcastTreatmentSettingsRanges function computes and broadcasts + * updated treatment parameter ranges that the user may change during treatment. + * It is assumed that prescription settings have already been set prior to calling * this function. * @details * Inputs : current operating mode, treatment states and parameters Index: firmware/App/Modes/ModeTreatmentParams.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -111,7 +111,7 @@ /*********************************************************************//** * @brief - * The transitionToOpParamsMode function prepares for transition to operating \n + * The transitionToOpParamsMode function prepares for transition to operating * parameters mode. * @details * Inputs : none @@ -135,7 +135,7 @@ /*********************************************************************//** * @brief - * The resetAllTreatmentParameters function resets treatment parameters \n + * The resetAllTreatmentParameters function resets treatment parameters * to default values. * @details * Inputs : none @@ -168,7 +168,7 @@ /*********************************************************************//** * @brief - * The signalUserConfirmationOfTreatmentParameters function sets the user \n + * The signalUserConfirmationOfTreatmentParameters function sets the user * confirmation flag signaling user has confirmed treatment parameters. * @details * Inputs : none @@ -190,7 +190,7 @@ /*********************************************************************//** * @brief - * The signalUserCancelTreatment function sets the cancelled treatment \n + * The signalUserCancelTreatment function sets the cancelled treatment * flag signaling the user has cancelled the treatment. * @details * Inputs : none @@ -258,7 +258,7 @@ /*********************************************************************//** * @brief - * The handleWaitForUI2SendState function handles the wait for UI to send \n + * The handleWaitForUI2SendState function handles the wait for UI to send * treatment parameters state of treatment parameters mode. * @details * Inputs : @@ -289,7 +289,7 @@ /*********************************************************************//** * @brief - * The handleWaitForUI2ConfirmState function handles the wait for UI to send \n + * The handleWaitForUI2ConfirmState function handles the wait for UI to send * user confirmation state of treatment parameters mode. * @details * Inputs : @@ -337,7 +337,7 @@ /*********************************************************************//** * @brief - * The validateAndSetTreatmentParameters function validates received \n + * The validateAndSetTreatmentParameters function validates received * treatment parameters. * @details * Inputs : none @@ -375,7 +375,7 @@ /*********************************************************************//** * @brief - * The checkTreatmentParamsInRange function checks whether received \n + * The checkTreatmentParamsInRange function checks whether received * treatment parameters are in range. * @details * Inputs : stagedParams[] @@ -405,7 +405,7 @@ /*********************************************************************//** * @brief - * The checkTreatmentParamsDependencies function checks dependencies between \n + * The checkTreatmentParamsDependencies function checks dependencies between * received treatment parameters. * @details * Inputs : stagedParams[] @@ -458,7 +458,7 @@ /*********************************************************************//** * @brief - * The isTreatmentParamInRange function determines whether a given treatment \n + * The isTreatmentParamInRange function determines whether a given treatment * parameter is in range. * @details * Inputs : treatParamsRanges[] @@ -504,8 +504,8 @@ /*********************************************************************//** * @brief - * The extractTreatmentParamsFromPayload function extracts the individual \n - * treatment parameters received from the UI into a staging array where \n + * The extractTreatmentParamsFromPayload function extracts the individual + * treatment parameters received from the UI into a staging array where * they will be validated and stay until user confirms them. * @details * Inputs : none @@ -537,8 +537,8 @@ /*********************************************************************//** * @brief - * The sendTreatmentParamsResponse function responds to the treatment parameters \n - * received from the UI. An over-all ok/rejected flag as well as individual reject \n + * The sendTreatmentParamsResponse function responds to the treatment parameters + * received from the UI. An over-all ok/rejected flag as well as individual reject * reason codes for each parameter are provided back to the UI. * @details * Inputs : none @@ -574,7 +574,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterU32 function sets a given unsigned integer \n + * The setTreatmentParameterU32 function sets a given unsigned integer * treatment parameter to a given value. * @details * Inputs : treatmentParameters[] @@ -601,7 +601,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterS32 function sets a given signed integer treatment \n + * The setTreatmentParameterS32 function sets a given signed integer treatment * parameter to a given value. * @details * Inputs : treatmentParameters[] @@ -628,7 +628,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterF32 sets a given floating point treatment parameter \n + * The setTreatmentParameterF32 sets a given floating point treatment parameter * to a given value. * @details * Inputs : treatmentParameters[] @@ -655,7 +655,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterU32 function gets the value of a given unsigned \n + * The getTreatmentParameterU32 function gets the value of a given unsigned * integer treatment parameter. * @details * Inputs : treatmentParameters[] @@ -684,7 +684,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterS32 function gets the value of a given signed \n + * The getTreatmentParameterS32 function gets the value of a given signed * integer treatment parameter. * @details * Inputs : treatmentParameters[] @@ -713,7 +713,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterF32 function gets the value of a given floating point \n + * The getTreatmentParameterF32 function gets the value of a given floating point * treatment parameter. * @details * Inputs : treatmentParameters[] @@ -748,7 +748,7 @@ /************************************************************************* * @brief - * The testSetTreatmentParameterOverride function overrides the value of a \n + * The testSetTreatmentParameterOverride function overrides the value of a * given treatment parameter. * @details * Inputs : none