Index: firmware/App/Controllers/AirTrap.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/AirTrap.c (.../AirTrap.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Controllers/AirTrap.c (.../AirTrap.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -78,9 +78,8 @@ /*********************************************************************//** * @brief * The initAirTrap function initializes the Air Trap module. - * @details - * Inputs : none - * Outputs : Air Trap module initialized. + * @details Inputs: none + * @details Outputs: Air Trap module initialized. * @return none *************************************************************************/ void initAirTrap( void ) @@ -93,9 +92,8 @@ * @brief * The resetAirTrap function resets certain parts of the air trap module * between treatments. - * @details - * Inputs : none - * Outputs : Air Trap module reset. + * @details Inputs: none + * @details Outputs: Air Trap module reset. * @return none *************************************************************************/ void resetAirTrap( void ) @@ -108,9 +106,8 @@ /*********************************************************************//** * @brief * The startAirTrapControl function requests a start to air trap control. - * @details - * Inputs : airTrapControllerState - * Outputs : pendingStartAirTrapController + * @details Inputs: airTrapControllerState + * @details Outputs: pendingStartAirTrapController * @return none *************************************************************************/ void startAirTrapControl( void ) @@ -124,9 +121,8 @@ /*********************************************************************//** * @brief * The endAirTrapControl function requests a stop to air trap control. - * @details - * Inputs : airTrapControllerState - * Outputs : pendingStopAirTrapController + * @details Inputs: airTrapControllerState + * @details Outputs: pendingStopAirTrapController * @return none *************************************************************************/ void endAirTrapControl( void ) @@ -142,9 +138,8 @@ * @brief * The isAirTrapControlling function determines whether the air trap is * currently controlling. - * @details - * Inputs : airTrapControllerState - * Outputs : none + * @details Inputs: airTrapControllerState + * @details Outputs: none * @return TRUE if air trap is currently controlling, FALSE if not. *************************************************************************/ BOOL isAirTrapControlling( void ) @@ -162,9 +157,8 @@ /*********************************************************************//** * @brief * The execAirTrapMonitor function executes the air trap monitor. - * @details - * Inputs : TBD - * Outputs : airTrapLevels[] + * @details Inputs: TBD + * @details Outputs: airTrapLevels[] * @return none *************************************************************************/ void execAirTrapMonitor( void ) @@ -187,9 +181,8 @@ /*********************************************************************//** * @brief * The execAirTrapController function executes the air trap control state machine. - * @details - * Inputs : airTrapControllerState - * Outputs : airTrapControllerState + * @details Inputs: airTrapControllerState + * @details Outputs: airTrapControllerState * @return none *************************************************************************/ void execAirTrapController( void ) @@ -227,9 +220,8 @@ * @brief * The handleAirTrapManualControlState function handles the manual control * state of the air trap. - * @details - * Inputs : pendingStartAirTrapController - * Outputs : none + * @details Inputs: pendingStartAirTrapController + * @details Outputs: none * @return next state *************************************************************************/ static AIR_TRAP_STATE_T handleAirTrapManualControlState( void ) @@ -251,9 +243,8 @@ * @brief * The handleAirTrapValveClosedState function handles the valve closed state * of the air trap. - * @details - * Inputs : pendingStopAirTrapController, airTrapLevels[] - * Outputs : none + * @details Inputs: pendingStopAirTrapController, airTrapLevels[] + * @details Outputs: none * @return next state *************************************************************************/ static AIR_TRAP_STATE_T handleAirTrapValveClosedState( void ) @@ -280,9 +271,8 @@ * @brief * The handleAirTrapValveOpenState function handles the valve open state of * the air trap. - * @details - * Inputs : pendingStopAirTrapController, airTrapLevels[] - * Outputs : none + * @details Inputs: pendingStopAirTrapController, airTrapLevels[] + * @details Outputs: none * @return next state *************************************************************************/ static AIR_TRAP_STATE_T handleAirTrapValveOpenState( void ) @@ -309,9 +299,8 @@ * @brief * The getAirTrapLevel function gets the current reading for the given * level sensor. - * @details - * Inputs : airTrapLevels[] - * Outputs : none + * @details Inputs: airTrapLevels[] + * @details Outputs: none * @param sensor ID of level sensor to get reading for * @return the current level sensor reading for the given sensor (air or fluid). *************************************************************************/ @@ -340,9 +329,8 @@ * @brief * The getPublishAirTrapDataInterval function gets the air trap data * publication interval. - * @details - * Inputs : airTrapDataPublishInterval - * Outputs : none + * @details Inputs: airTrapDataPublishInterval + * @details Outputs: none * @return the current air trap data publication interval (in task intervals). *************************************************************************/ static U32 getPublishAirTrapDataInterval( void ) @@ -360,9 +348,8 @@ /*********************************************************************//** * @brief * The publishAirTrapData function publishes air trap data at the set interval. - * @details - * Inputs : airTrapLevels[] - * Outputs : if broadcast is due, send air trap data + * @details Inputs: airTrapLevels[] + * @details Outputs: if broadcast is due, send air trap data * @return none *************************************************************************/ static void publishAirTrapData( void ) @@ -382,9 +369,8 @@ * @brief * The execAirTrapTest function executes the state machine for the air trap * self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the PresOccl self-test. *************************************************************************/ SELF_TEST_STATUS_T execAirTrapTest( void ) @@ -406,9 +392,8 @@ * @brief * The testSetAirTrapDataPublishIntervalOverride function overrides the * air trap data publish interval. - * @details - * Inputs : none - * Outputs : airTrapDataPublishInterval + * @details Inputs: none + * @details Outputs: airTrapDataPublishInterval * @param value override air trap data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -432,9 +417,8 @@ * @brief * The testResetAirTrapDataPublishIntervalOverride function resets the override * of the air trap data publish interval. - * @details - * Inputs : none - * Outputs : airTrapDataPublishInterval + * @details Inputs: none + * @details Outputs: airTrapDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetAirTrapDataPublishIntervalOverride( void ) @@ -455,9 +439,8 @@ * @brief * The testSetAirTrapLevelOverride function overrides the measured level * for a given level sensor. - * @details - * Inputs : none - * Outputs : airTrapLevels[] + * @details Inputs: none + * @details Outputs: airTrapLevels[] * @param sensor ID of level sensor to override * @param level override level sensor with this * @return TRUE if override successful, FALSE if not @@ -483,9 +466,8 @@ * @brief * The testResetAirTrapLevelOverride function resets the override of the * level sensor. - * @details - * Inputs : none - * Outputs : airTrapLevels[] + * @details Inputs: none + * @details Outputs: airTrapLevels[] * @param sensor ID of level sensor to reset override * @return TRUE if reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Controllers/AlarmLamp.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/AlarmLamp.c (.../AlarmLamp.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Controllers/AlarmLamp.c (.../AlarmLamp.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -90,9 +90,8 @@ /*********************************************************************//** * @brief * The initAlarmLamp function initializes the AlarmLamp module. - * @details - * Inputs : none - * Outputs : AlarmLamp module initialized. + * @details Inputs: none + * @details Outputs: AlarmLamp module initialized. * @return none *************************************************************************/ void initAlarmLamp( void ) @@ -110,10 +109,9 @@ * @brief * The execAlarmLamp function executes the alarm lamp service for the * current lamp pattern. - * @details - * Inputs : pendingLampPattern, currentLampPattern, lampPatternStepTimer, + * @details Inputs: pendingLampPattern, currentLampPattern, lampPatternStepTimer, * lampPatterns. - * Outputs : currentLampPattern + * @details Outputs: currentLampPattern * @return none *************************************************************************/ void execAlarmLamp( void ) @@ -153,9 +151,8 @@ /*********************************************************************//** * @brief * The requestAlarmLampPattern function sets a request for a new lamp pattern. - * @details - * Inputs : none - * Outputs : pendingLampPattern + * @details Inputs: none + * @details Outputs: pendingLampPattern * @param lampPattern new lamp pattern * @return none *************************************************************************/ @@ -175,9 +172,8 @@ * @brief * The getCurrentAlarmLampPattern function gets the current alarm lamp * pattern in effect. - * @details - * Inputs : currentLampPattern - * Outputs : none + * @details Inputs: currentLampPattern + * @details Outputs: none * @return currentLampPattern *************************************************************************/ LAMP_PATTERN_T getCurrentAlarmLampPattern( void ) @@ -195,9 +191,8 @@ /*********************************************************************//** * @brief * The getAlarmLampOn function gets the current alarm lamp on flag. - * @details - * Inputs : alarmLampOn - * Outputs : none + * @details Inputs: alarmLampOn + * @details Outputs: none * @return alarmLampOn *************************************************************************/ BOOL getAlarmLampOn( void ) @@ -210,9 +205,8 @@ * The execAlarmLampTest function executes the alarm lamp test. * This function should be called periodically until a pass or fail * result is returned. - * @details - * Inputs : alarmLampSelfTestState, alarmLampSelfTestStepTimerCount - * Outputs : alarmLampSelfTestState, alarmLampSelfTestStepTimerCount + * @details Inputs: alarmLampSelfTestState, alarmLampSelfTestStepTimerCount + * @details Outputs: alarmLampSelfTestState, alarmLampSelfTestStepTimerCount * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execAlarmLampTest( void ) @@ -273,9 +267,8 @@ * @brief * The setAlarmLampToPatternStep function sets the lamps according to the * current lamp pattern and lamp pattern step. - * @details - * Inputs : lampPatterns[], currentLampPatternStep - * Outputs : lampPatternStepTimer reset. Lamps set per current pattern. + * @details Inputs: lampPatterns[], currentLampPatternStep + * @details Outputs: lampPatternStepTimer reset. Lamps set per current pattern. * @return none *************************************************************************/ static void setAlarmLampToPatternStep( void ) @@ -319,9 +312,8 @@ * @brief * The testSetCurrentLampPatternOverride function overrides the state of the * current alarm lamp pattern with a given pattern. - * @details - * Inputs : none - * Outputs : currentLampPattern + * @details Inputs: none + * @details Outputs: currentLampPattern * @param value override state for the alarm lamp pattern * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -343,9 +335,8 @@ * @brief * The testResetCurrentLampPatternOverride function resets the override of the * state of the alarm lamp pattern. - * @details - * Inputs : none - * Outputs : currentLampPattern + * @details Inputs: none + * @details Outputs: currentLampPattern * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetCurrentLampPatternOverride( void ) Index: firmware/App/Controllers/BloodFlow.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/BloodFlow.c (.../BloodFlow.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Controllers/BloodFlow.c (.../BloodFlow.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -193,9 +193,8 @@ /*********************************************************************//** * @brief * The initBloodFlow function initializes the BloodFlow module. - * @details - * Inputs : none - * Outputs : BloodFlow module initialized. + * @details Inputs: none + * @details Outputs: BloodFlow module initialized. * @return none *************************************************************************/ void initBloodFlow( void ) @@ -218,9 +217,8 @@ * @brief * The setBloodPumpTargetFlowRate function sets a new target flow rate and * pump direction. - * @details - * Inputs : isBloodPumpOn, bloodPumpDirectionSet - * Outputs : targetBloodFlowRate, bloodPumpdirection, bloodPumpPWMDutyCyclePct + * @details Inputs: isBloodPumpOn, bloodPumpDirectionSet + * @details Outputs: targetBloodFlowRate, bloodPumpdirection, bloodPumpPWMDutyCyclePct * @param flowRate new target blood flow rate * @param dir new blood flow direction * @param mode new control mode @@ -285,9 +283,8 @@ /*********************************************************************//** * @brief * The signalBloodPumpHardStop function stops the blood pump immediately. - * @details - * Inputs : none - * Outputs : Blood pump stopped, set point reset, state changed to off + * @details Inputs: none + * @details Outputs: Blood pump stopped, set point reset, state changed to off * @return none *************************************************************************/ void signalBloodPumpHardStop( void ) @@ -305,9 +302,8 @@ * The signalBloodPumpRotorHallSensor function handles the blood pump rotor * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if * there is a pending request to home the pump. - * @details - * Inputs : bpRotorRevStartTime, bpStopAtHomePosition - * Outputs : bpRotorRevStartTime, bloodPumpRotorSpeedRPM + * @details Inputs: bpRotorRevStartTime, bpStopAtHomePosition + * @details Outputs: bpRotorRevStartTime, bloodPumpRotorSpeedRPM * @return none *************************************************************************/ void signalBloodPumpRotorHallSensor( void ) @@ -330,9 +326,8 @@ /*********************************************************************//** * @brief * The homeBloodPump function initiates a blood pump home operation. - * @details - * Inputs : bloodPumpState - * Outputs : bpStopAtHomePosition, bpHomeStartTime, blood pump started (slow) + * @details Inputs: bloodPumpState + * @details Outputs: bpStopAtHomePosition, bpHomeStartTime, blood pump started (slow) * @return none *************************************************************************/ BOOL homeBloodPump( void ) @@ -352,9 +347,8 @@ /*********************************************************************//** * @brief * The execBloodFlowMonitor function executes the blood flow monitor. - * @details - * Inputs : none - * Outputs : measuredBloodFlowRate, adcBloodPumpMCSpeedRPM, adcBloodPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: measuredBloodFlowRate, adcBloodPumpMCSpeedRPM, adcBloodPumpMCCurrentmA * @return none *************************************************************************/ void execBloodFlowMonitor( void ) @@ -392,9 +386,8 @@ /*********************************************************************//** * @brief * The execBloodFlowController function executes the blood flow controller. - * @details - * Inputs : bloodPumpState - * Outputs : bloodPumpState + * @details Inputs: bloodPumpState + * @details Outputs: bloodPumpState * @return none *************************************************************************/ void execBloodFlowController( void ) @@ -427,9 +420,8 @@ * @brief * The handleBloodPumpOffState function handles the blood pump off state * of the blood pump controller state machine. - * @details - * Inputs : targetBloodFlowRate, bloodPumpDirection - * Outputs : bloodPumpPWMDutyCyclePctSet, bloodPumpDirectionSet, isBloodPumpOn + * @details Inputs: targetBloodFlowRate, bloodPumpDirection + * @details Outputs: bloodPumpPWMDutyCyclePctSet, bloodPumpDirectionSet, isBloodPumpOn * @return next state *************************************************************************/ static BLOOD_PUMP_STATE_T handleBloodPumpOffState( void ) @@ -456,9 +448,8 @@ * @brief * The handleBloodPumpRampingUpState function handles the ramp up state * of the blood pump controller state machine. - * @details - * Inputs : bloodPumpPWMDutyCyclePctSet - * Outputs : bloodPumpPWMDutyCyclePctSet + * @details Inputs: bloodPumpPWMDutyCyclePctSet + * @details Outputs: bloodPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static BLOOD_PUMP_STATE_T handleBloodPumpRampingUpState( void ) @@ -501,9 +492,8 @@ * @brief * The handleBloodPumpRampingDownState function handles the ramp down state * of the blood pump controller state machine. - * @details - * Inputs : bloodPumpPWMDutyCyclePctSet - * Outputs : bloodPumpPWMDutyCyclePctSet + * @details Inputs: bloodPumpPWMDutyCyclePctSet + * @details Outputs: bloodPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static BLOOD_PUMP_STATE_T handleBloodPumpRampingDownState( void ) @@ -544,9 +534,8 @@ * @brief * The handleBloodPumpControlToTargetState function handles the "control to * target" state of the blood pump controller state machine. - * @details - * Inputs : none - * Outputs : bloodPumpState + * @details Inputs: none + * @details Outputs: bloodPumpState * @return next state *************************************************************************/ static BLOOD_PUMP_STATE_T handleBloodPumpControlToTargetState( void ) @@ -576,9 +565,8 @@ * @brief * The setBloodPumpControlSignalPWM function sets the PWM duty cycle for * the blood pump to a given %. - * @details - * Inputs : none - * Outputs : blood pump stop signal activated, PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: blood pump stop signal activated, PWM duty cycle zeroed * @param newPWM new duty cycle % to apply to PWM * @return none *************************************************************************/ @@ -590,9 +578,8 @@ /*********************************************************************//** * @brief * The stopBloodPump function sets the blood pump stop signal. - * @details - * Inputs : none - * Outputs : blood pump stop signal activated, PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: blood pump stop signal activated, PWM duty cycle zeroed * @return none *************************************************************************/ static void stopBloodPump( void ) @@ -606,9 +593,8 @@ /*********************************************************************//** * @brief * The releaseBloodPumpStop function clears the blood pump stop signal. - * @details - * Inputs : none - * Outputs : blood pump stop signal + * @details Inputs: none + * @details Outputs: blood pump stop signal * @return none *************************************************************************/ static void releaseBloodPumpStop( void ) @@ -620,9 +606,8 @@ * @brief * The setBloodPumpDirection function sets the set blood pump direction to * the given direction. - * @details - * Inputs : bloodPumpState - * Outputs : bloodPumpState + * @details Inputs: bloodPumpState + * @details Outputs: bloodPumpState * @param dir blood pump direction to set * @return none *************************************************************************/ @@ -650,9 +635,8 @@ * @brief * The getPublishBloodFlowDataInterval function gets the blood flow data * publication interval. - * @details - * Inputs : bloodFlowDataPublishInterval - * Outputs : none + * @details Inputs: bloodFlowDataPublishInterval + * @details Outputs: none * @return the current blood flow data publication interval (in task intervals). *************************************************************************/ U32 getPublishBloodFlowDataInterval( void ) @@ -671,9 +655,8 @@ * @brief * The getTargetBloodFlowRate function gets the current target blood flow * rate. - * @details - * Inputs : targetBloodFlowRate - * Outputs : none + * @details Inputs: targetBloodFlowRate + * @details Outputs: none * @return the current target blood flow rate (in mL/min). *************************************************************************/ S32 getTargetBloodFlowRate( void ) @@ -692,9 +675,8 @@ * @brief * The getMeasuredBloodFlowRate function gets the measured blood flow * rate. - * @details - * Inputs : measuredBloodFlowRate - * Outputs : none + * @details Inputs: measuredBloodFlowRate + * @details Outputs: none * @return the current blood flow rate (in mL/min). *************************************************************************/ F32 getMeasuredBloodFlowRate( void ) @@ -713,9 +695,8 @@ * @brief * The getMeasuredBloodPumpRotorSpeed function gets the measured blood flow * rate. - * @details - * Inputs : bloodPumpRotorSpeedRPM - * Outputs : none + * @details Inputs: bloodPumpRotorSpeedRPM + * @details Outputs: none * @return the current blood flow rate (in mL/min). *************************************************************************/ F32 getMeasuredBloodPumpRotorSpeed( void ) @@ -734,9 +715,8 @@ * @brief * The getMeasuredBloodPumpSpeed function gets the measured blood flow * rate. - * @details - * Inputs : bloodPumpSpeedRPM - * Outputs : none + * @details Inputs: bloodPumpSpeedRPM + * @details Outputs: none * @return the current blood flow rate (in mL/min). *************************************************************************/ F32 getMeasuredBloodPumpSpeed( void ) @@ -755,9 +735,8 @@ * @brief * The getMeasuredBloodPumpMCSpeed function gets the measured blood pump * speed. - * @details - * Inputs : adcBloodPumpMCSpeedRPM - * Outputs : none + * @details Inputs: adcBloodPumpMCSpeedRPM + * @details Outputs: none * @return the current blood pump speed (in RPM). *************************************************************************/ F32 getMeasuredBloodPumpMCSpeed( void ) @@ -776,9 +755,8 @@ * @brief * The getMeasuredBloodPumpMCCurrent function gets the measured blood pump * current. - * @details - * Inputs : adcBloodPumpMCCurrentmA - * Outputs : none + * @details Inputs: adcBloodPumpMCCurrentmA + * @details Outputs: none * @return the current blood pump current (in mA). *************************************************************************/ F32 getMeasuredBloodPumpMCCurrent( void ) @@ -797,10 +775,9 @@ * @brief * The publishBloodFlowData function publishes blood flow data at the set * interval. - * @details - * Inputs : target flow rate, measured flow rate, measured MC speed, + * @details Inputs: target flow rate, measured flow rate, measured MC speed, * measured MC current - * Outputs : Blood flow data is published to CAN bus. + * @details Outputs: Blood flow data is published to CAN bus. * @return none *************************************************************************/ static void publishBloodFlowData( void ) @@ -841,9 +818,8 @@ * @brief * The resetBloodFlowMovingAverage function re-initializes the blood flow * moving average sample buffer. - * @details - * Inputs : none - * Outputs : flowReadingsTotal, flowReadingsIdx, flowReadingsCount all set to zero. + * @details Inputs: none + * @details Outputs: flowReadingsTotal, flowReadingsIdx, flowReadingsCount all set to zero. * @return none *************************************************************************/ static void resetBloodFlowMovingAverage( void ) @@ -857,9 +833,8 @@ /*********************************************************************//** * @brief * The filterBloodFlowReadings function adds a new flow sample to the filter. - * @details - * Inputs : none - * Outputs : flowReadings[], flowReadingsIdx, flowReadingsCount, flowReadingsTotal + * @details Inputs: none + * @details Outputs: flowReadings[], flowReadingsIdx, flowReadingsCount, flowReadingsTotal * @param flow newest blood flow sample * @return none *************************************************************************/ @@ -885,9 +860,8 @@ * The updateBloodPumpSpeedAndDirectionFromHallSensors function calculates * the blood pump motor speed and direction from hall sensor counter on * a 1 second interval. - * @details - * Inputs : bpLastMotorHallSensorCount, bpMotorSpeedCalcTimerCtr, current count from FPGA - * Outputs : bpMotorDirectionFromHallSensors, bloodPumpSpeedRPM + * @details Inputs: bpLastMotorHallSensorCount, bpMotorSpeedCalcTimerCtr, current count from FPGA + * @details Outputs: bpMotorDirectionFromHallSensors, bloodPumpSpeedRPM * @return none *************************************************************************/ static void updateBloodPumpSpeedAndDirectionFromHallSensors( void ) @@ -924,9 +898,8 @@ * The checkBloodPumpRotor function checks the rotor for the blood * 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 : bpStopAtHomePosition, bpHomeStartTime, bpRotorRevStartTime - * Outputs : pump may be stopped if homing, bloodPumpRotorSpeedRPM may be set to zero. + * @details Inputs: bpStopAtHomePosition, bpHomeStartTime, bpRotorRevStartTime + * @details Outputs: pump may be stopped if homing, bloodPumpRotorSpeedRPM may be set to zero. * @return none *************************************************************************/ static void checkBloodPumpRotor( void ) @@ -958,9 +931,8 @@ * @brief * The checkBloodPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return none *************************************************************************/ static void checkBloodPumpDirection( void ) @@ -988,9 +960,8 @@ * 2. while pump is controlling, measured motor speed should be within allowed range of commanded 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 : targetBloodFlowRate, bloodPumpSpeedRPM, bloodPumpRotorSpeedRPM - * Outputs : alarm(s) may be triggered + * @details Inputs: targetBloodFlowRate, bloodPumpSpeedRPM, bloodPumpRotorSpeedRPM + * @details Outputs: alarm(s) may be triggered * @return none *************************************************************************/ static void checkBloodPumpSpeeds( void ) @@ -1072,9 +1043,8 @@ * against the implied flow of the measured pump speed when in treatment mode * and controlling to target flow. If a sufficient difference persists, a * flow vs. motor speed check error is triggered. - * @details - * Inputs : measuredBloodFlowRate, bloodPumpSpeedRPM, errorBloodFlowVsMotorSpeedPersistTimerCtr - * Outputs : alarm may be triggered + * @details Inputs: measuredBloodFlowRate, bloodPumpSpeedRPM, errorBloodFlowVsMotorSpeedPersistTimerCtr + * @details Outputs: alarm may be triggered * @return none *************************************************************************/ static void checkBloodPumpFlowAgainstSpeed( void ) @@ -1111,9 +1081,8 @@ * @brief * The checkBloodPumpMCCurrent function checks the measured MC current vs. * the set state of the blood pump (stopped or running). - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return none *************************************************************************/ static void checkBloodPumpMCCurrent( void ) @@ -1164,9 +1133,8 @@ * @brief * The execBloodFlowTest function executes the state machine for the * BloodFlow self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the BloodFlow self-test. *************************************************************************/ SELF_TEST_STATUS_T execBloodFlowTest( void ) @@ -1211,9 +1179,8 @@ * @brief * The setBloodFlowCalibration function sets the blood flow calibration * factors and has them stored in non-volatile memory. - * @details - * Inputs : none - * Outputs : bloodFlowCalGain, bloodFlowCalOffset + * @details Inputs: none + * @details Outputs: bloodFlowCalGain, bloodFlowCalOffset * @param gain gain calibration factor for blood flow sensor * @param offset offset calibration factor for blood flow sensor * @return TRUE if calibration factors successfully set/stored, FALSE if not @@ -1246,9 +1213,8 @@ * @brief * The getBloodFlowCalibration function retrieves the current blood flow * calibration factors. - * @details - * Inputs : bloodFlowCalGain, bloodFlowCalOffset - * Outputs : none + * @details Inputs: bloodFlowCalGain, bloodFlowCalOffset + * @details Outputs: none * @param gain value to populate with gain calibration factor for blood flow sensor * @param offset value to populate with offset calibration factor for blood flow sensor * @return none @@ -1263,9 +1229,8 @@ * @brief * The testSetBloodFlowDataPublishIntervalOverride function overrides the * blood flow data publish interval. - * @details - * Inputs : none - * Outputs : bloodFlowDataPublishInterval + * @details Inputs: none + * @details Outputs: bloodFlowDataPublishInterval * @param value override blood flow data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1289,9 +1254,8 @@ * @brief * The testResetBloodFlowDataPublishIntervalOverride function resets the override * of the blood flow data publish interval. - * @details - * Inputs : none - * Outputs : bloodFlowDataPublishInterval + * @details Inputs: none + * @details Outputs: bloodFlowDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetBloodFlowDataPublishIntervalOverride( void ) @@ -1312,9 +1276,8 @@ * @brief * The testSetTargetBloodFlowRateOverride function overrides the target * blood flow rate. - * @details - * Inputs : none - * Outputs : targetBloodFlowRate + * @details Inputs: none + * @details Outputs: targetBloodFlowRate * @param value override target blood flow rate (in mL/min) * @param ctrlMode override pump control mode to this mode (0 = closed loop, 1 = open loop) * @return TRUE if override successful, FALSE if not @@ -1351,9 +1314,8 @@ * @brief * The testResetTargetBloodFlowRateOverride function resets the override of the * target blood flow rate. - * @details - * Inputs : none - * Outputs : targetBloodFlowRate + * @details Inputs: none + * @details Outputs: targetBloodFlowRate * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetTargetBloodFlowRateOverride( void ) @@ -1376,9 +1338,8 @@ * @brief * The testResetMeasuredBloodFlowRateOverride function overrides the measured * blood flow rate. - * @details - * Inputs : none - * Outputs : measuredBloodFlowRate + * @details Inputs: none + * @details Outputs: measuredBloodFlowRate * @param value override measured blood flow rate (in mL/min) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1400,9 +1361,8 @@ * @brief * The testResetOffButtonStateOverride function resets the override of the * measured blood flow rate. - * @details - * Inputs : none - * Outputs : measuredBloodFlowRate + * @details Inputs: none + * @details Outputs: measuredBloodFlowRate * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredBloodFlowRateOverride( void ) @@ -1423,9 +1383,8 @@ * @brief * The testSetMeasuredBloodPumpRotorSpeedOverride function overrides the measured * blood pump rotor speed. - * @details - * Inputs : none - * Outputs : bloodPumpRotorSpeedRPM + * @details Inputs: none + * @details Outputs: bloodPumpRotorSpeedRPM * @param value override measured blood pump rotor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1447,9 +1406,8 @@ * @brief * The testResetMeasuredBloodPumpRotorSpeedOverride function resets the override of the * measured blood pump rotor speed. - * @details - * Inputs : none - * Outputs : bloodPumpRotorSpeedRPM + * @details Inputs: none + * @details Outputs: bloodPumpRotorSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredBloodPumpRotorSpeedOverride( void ) @@ -1470,9 +1428,8 @@ * @brief * The testSetMeasuredBloodPumpSpeedOverride function overrides the measured * blood pump motor speed. - * @details - * Inputs : none - * Outputs : bloodPumpSpeedRPM + * @details Inputs: none + * @details Outputs: bloodPumpSpeedRPM * @param value override measured blood pump motor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1494,9 +1451,8 @@ * @brief * The testResetMeasuredBloodPumpSpeedOverride function resets the override of the * measured blood pump motor speed. - * @details - * Inputs : none - * Outputs : bloodPumpSpeedRPM + * @details Inputs: none + * @details Outputs: bloodPumpSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredBloodPumpSpeedOverride( void ) @@ -1517,9 +1473,8 @@ * @brief * The testSetMeasuredBloodPumpMCSpeedOverride function overrides the measured * blood pump motor speed. - * @details - * Inputs : none - * Outputs : adcBloodPumpMCSpeedRPM + * @details Inputs: none + * @details Outputs: adcBloodPumpMCSpeedRPM * @param value override measured blood pump speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1541,9 +1496,8 @@ * @brief * The testResetMeasuredBloodPumpMCSpeedOverride function resets the override of the * measured blood pump motor speed. - * @details - * Inputs : none - * Outputs : adcBloodPumpMCSpeedRPM + * @details Inputs: none + * @details Outputs: adcBloodPumpMCSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredBloodPumpMCSpeedOverride( void ) @@ -1564,9 +1518,8 @@ * @brief * The testSetMeasuredBloodPumpMCCurrentOverride function overrides the measured * blood pump motor current. - * @details - * Inputs : none - * Outputs : adcBloodPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: adcBloodPumpMCCurrentmA * @param value override measured blood pump current (in mA) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1588,9 +1541,8 @@ * @brief * The testResetMeasuredBloodPumpMCCurrentOverride function resets the override of the * measured blood pump motor current. - * @details - * Inputs : none - * Outputs : adcBloodPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: adcBloodPumpMCCurrentmA * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredBloodPumpMCCurrentOverride( void ) Index: firmware/App/Controllers/Buttons.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -105,9 +105,8 @@ /*********************************************************************//** * @brief * The initButtons function initializes the Buttons module. - * @details - * Inputs : none - * Outputs : Buttons module initialized. + * @details Inputs: none + * @details Outputs: Buttons module initialized. * @return none *************************************************************************/ void initButtons( void ) @@ -130,9 +129,8 @@ /*********************************************************************//** * @brief * The execButtons function executes the Buttons monitor. - * @details - * Inputs : none - * Outputs : offButtonState, stopButtonState, prevOffButtonState, prevStopButtonState + * @details Inputs: none + * @details Outputs: offButtonState, stopButtonState, prevOffButtonState, prevStopButtonState * @return none *************************************************************************/ void execButtons( void ) @@ -156,9 +154,8 @@ * The isStopButtonPressed function determines whether the stop button has been * pressed. Once the stop button has transitioned from released to pressed, a * press for the stop button will be pending until this function is called. - * @details - * Inputs : stopButtonPressPending - * Outputs : stopButtonPressPending + * @details Inputs: stopButtonPressPending + * @details Outputs: stopButtonPressPending * @return true if the stop button is pressed, false if not *************************************************************************/ BOOL isStopButtonPressed( void ) @@ -174,9 +171,8 @@ * @brief * The getOffButtonState function determines whether the off button is * currently pressed. - * @details - * Inputs : dataOffButtonState, prevOffButtonState - * Outputs : none + * @details Inputs: dataOffButtonState, prevOffButtonState + * @details Outputs: none * @return BUTTON_STATE_PRESSED if off button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ BUTTON_STATE_T getOffButtonState( void ) @@ -195,9 +191,8 @@ * @brief * The getStopButtonState function determines whether the stop button is * currently pressed. - * @details - * Inputs : dataStopButtonState, prevStopButtonState - * Outputs : none + * @details Inputs: dataStopButtonState, prevStopButtonState + * @details Outputs: none * @return BUTTON_STATE_PRESSED if stop button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ BUTTON_STATE_T getStopButtonState( void ) @@ -217,9 +212,8 @@ * The execStuckButtonTest function executes the stuck button test. * This function should be called periodically until a pass or fail * result is returned. - * @details - * Inputs : dataOffButtonState - * Outputs : buttonSelfTestState, buttonSelfTestTimerCount + * @details Inputs: dataOffButtonState + * @details Outputs: buttonSelfTestState, buttonSelfTestTimerCount * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execStuckButtonTest( void ) @@ -269,9 +263,8 @@ * The userConfirmOffButton function handles user confirmation of the off * button. The off request will be initiated here if confirmed or cancelled * if rejected by user. - * @details - * Inputs : current operation mode - * Outputs : stopButtonPressPending + * @details Inputs: current operation mode + * @details Outputs: stopButtonPressPending * @param response 1 = confirmed, 0 = rejected * @return none *************************************************************************/ @@ -340,9 +333,8 @@ * @brief * The isCurrentOpModeOkToTurnOff function determines whether the system can * be turned off in current operation mode. - * @details - * Inputs : Current operation mode. - * Outputs : none + * @details Inputs: Current operation mode. + * @details Outputs: none * @return TRUE if can turn system off in current mode, FALSE if not *************************************************************************/ static BOOL isCurrentOpModeOkToTurnOff( void ) @@ -362,9 +354,8 @@ * @brief * The handleOffButtonProcessing function checks for and processes off button * activity. - * @details - * Inputs : offButtonState, prevOffButtonState - * Outputs : offButtonPressPending, offRequestPulseCount, offRequestPulseTimer + * @details Inputs: offButtonState, prevOffButtonState + * @details Outputs: offButtonPressPending, offRequestPulseCount, offRequestPulseTimer * @return none *************************************************************************/ static void handleOffButtonProcessing( void ) @@ -421,9 +412,8 @@ * @brief * The handleStopButtonProcessing function checks for and processes stop button * activity. - * @details - * Inputs : stopButtonState, prevStopButtonState - * Outputs : stopButtonPressPending + * @details Inputs: stopButtonState, prevStopButtonState + * @details Outputs: stopButtonPressPending * @return none *************************************************************************/ static void handleStopButtonProcessing( void ) @@ -461,9 +451,8 @@ * @brief * The testSetOffButtonStateOverride function overrides the state of then * off button with a given state.n - * @details - * Inputs : none - * Outputs : dataOffButtonState + * @details Inputs: none + * @details Outputs: dataOffButtonState * @param value override state for the off button * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -485,9 +474,8 @@ * @brief * The testResetOffButtonStateOverride function resets the override of then * state of the off button. - * @details - * Inputs : none - * Outputs : dataOffButtonState + * @details Inputs: none + * @details Outputs: dataOffButtonState * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetOffButtonStateOverride( void ) @@ -508,9 +496,8 @@ * @brief * The testSetStopButtonStateOverride function overrides the state of then * stop button with a given state. - * @details - * Inputs : none - * Outputs : dataStopButtonState + * @details Inputs: none + * @details Outputs: dataStopButtonState * @param value override state for the stop button * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -532,9 +519,8 @@ * @brief * The testResetStopButtonStateOverride function resets the override of then * state of the stop button. - * @details - * Inputs : none - * Outputs : dataStopButtonState + * @details Inputs: none + * @details Outputs: dataStopButtonState * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetStopButtonStateOverride( void ) Index: firmware/App/Controllers/DGInterface.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -91,9 +91,8 @@ /*********************************************************************//** * @brief * The initDGInterface function initializes the DGInterface module. - * @details - * Inputs : none - * Outputs : DGInterface module initialized. + * @details Inputs: none + * @details Outputs: DGInterface module initialized. * @return none *************************************************************************/ void initDGInterface( void ) @@ -112,9 +111,8 @@ * @brief * The initTreatmentReservoirMgmt function initializes the treatment reservoir * management state machine. - * @details - * Inputs : none - * Outputs : treatment reservoir management state machine initialized. + * @details Inputs: none + * @details Outputs: treatment reservoir management state machine initialized. * @return none *************************************************************************/ void initTreatmentReservoirMgmt( void ) @@ -129,9 +127,8 @@ * @brief * The execTreatmentReservoirMgmt function executes the state machine for the * reservoir management during treatment mode. - * @details - * Inputs : none - * Outputs : DG reservoirs (drains & fills) managed. + * @details Inputs: none + * @details Outputs: DG reservoirs (drains & fills) managed. * @return none *************************************************************************/ void execTreatmentReservoirMgmt( void ) @@ -256,9 +253,8 @@ /*********************************************************************//** * @brief * The getDGOpMode function gets the current DG operating mode. - * @details - * Inputs : dgCurrentOpMode - * Outputs : none + * @details Inputs: dgCurrentOpMode + * @details Outputs: none * @return Current DG operating mode. *************************************************************************/ DG_OP_MODE_T getDGOpMode( void ) @@ -269,9 +265,8 @@ /*********************************************************************//** * @brief * The getDGSubMode function gets the current DG operating sub-mode. - * @details - * Inputs : dgSubMode - * Outputs : none + * @details Inputs: dgSubMode + * @details Outputs: none * @return Current DG operating sub-mode. *************************************************************************/ U32 getDGSubMode( void ) @@ -282,9 +277,8 @@ /*********************************************************************//** * @brief * The getDGActiveReservoir function gets the current active reservoir. - * @details - * Inputs : dgActiveReservoirSet - * Outputs : none + * @details Inputs: dgActiveReservoirSet + * @details Outputs: none * @return Currently commanded active reservoir. *************************************************************************/ DG_RESERVOIR_ID_T getDGActiveReservoir( void ) @@ -296,9 +290,8 @@ * @brief * The getDGPressure function gets the latest pressure reported by the DG * for a given pressure sensor. - * @details - * Inputs : dgPressures[] - * Outputs : none + * @details Inputs: dgPressures[] + * @details Outputs: none * @param sensorID pressure sensor we are getting reading for * @return Latest pressure reading reported by DG for the given sensor. *************************************************************************/ @@ -322,9 +315,8 @@ * @brief * The getDGROPumpPressureSetPt function gets the latest RO pump * pressure set point reported by the DG. - * @details - * Inputs : dgROPumpPressureSetPtPSI - * Outputs : none + * @details Inputs: dgROPumpPressureSetPtPSI + * @details Outputs: none * @return Latest RO pump pressure set point reported by DG. *************************************************************************/ U32 getDGROPumpPressureSetPt( void ) @@ -338,9 +330,8 @@ * @brief * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow * rate reported by the DG. - * @details - * Inputs : dgROPumpFlowRateMlMin - * Outputs : none + * @details Inputs: dgROPumpFlowRateMlMin + * @details Outputs: none * @return Latest RO pump flow rate reported by DG. *************************************************************************/ F32 getDGROPumpFlowRateMlMin( void ) @@ -354,9 +345,8 @@ * @brief * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM * set point reported by the DG. - * @details - * Inputs : dgDrainPumpSpeedSetPtRPM - * Outputs : none + * @details Inputs: dgDrainPumpSpeedSetPtRPM + * @details Outputs: none * @return Latest drain pump RPM set point reported by DG. *************************************************************************/ U32 getDGDrainPumpRPMSetPt( void ) @@ -370,9 +360,8 @@ * @brief * The setDGOpMode function sets the latest DG operating mode reported by * the DG. - * @details - * Inputs : none - * Outputs : dgCurrentOpMode + * @details Inputs: none + * @details Outputs: dgCurrentOpMode * @param opMode operating mode reported by DG * @param subMode sub-mode (current state) of operating mode reported by DG * @return none @@ -394,9 +383,8 @@ * @brief * The setDialysateTemperatureReadings function sets the latest dialysate * temperatures reported by the DG. - * @details - * Inputs : none - * Outputs : dgDialysateTemp, dgRedundantDialysateTemp + * @details Inputs: none + * @details Outputs: dgDialysateTemp, dgRedundantDialysateTemp * @param temp1 dialysate temperature reported by DG * @param temp2 redundant dialysate temperature reported by DG * @return none @@ -411,9 +399,8 @@ * @brief * The setDGDialysateTemperatures function sets the latest temperature data * reported by the DG. - * @details - * Inputs : none - * Outputs : dgPrimaryTemp, dgTrimmerTemp + * @details Inputs: none + * @details Outputs: dgPrimaryTemp, dgTrimmerTemp * @param primaryHtrTemp Primary heater temperature reported by DG * @param trimmerHtrTemp Trimmer heater temperature reported by DG * @return none @@ -428,9 +415,8 @@ * @brief * The setDGReservoirsData function sets the latest reservoir data * reported by the DG. - * @details - * Inputs : none - * Outputs : dgActiveReservoir, dgReservoirFillVolumeTarget, dgReservoirDrainVolumeTarget + * @details Inputs: none + * @details 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 @@ -453,9 +439,8 @@ /*********************************************************************//** * @brief * The setDGPressures function sets the latest pressures reported by the DG. - * @details - * Inputs : none - * Outputs : dgPressures[] + * @details Inputs: none + * @details 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 @@ -473,9 +458,8 @@ /*********************************************************************//** * @brief * The setDGROPumpData function sets the latest RO pump data reported by the DG. - * @details - * Inputs : none - * Outputs : dgROPumpPressureSetPtPSI, dgROPumpFlowRateMlMin + * @details Inputs: none + * @details 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 * @return none @@ -489,9 +473,8 @@ /*********************************************************************//** * @brief * The setDGDrainPumpData function sets the latest drain pump data reported by the DG. - * @details - * Inputs : none - * Outputs : dgDrainPumpSpeedSetPtRPM + * @details Inputs: none + * @details Outputs: dgDrainPumpSpeedSetPtRPM * @param rpmSetPt latest drain pump RPM set point reported by DG * @return none *************************************************************************/ @@ -504,9 +487,8 @@ * @brief * The cmdSetDGDialysateTargetTemps function sends a target dialysate * temperature command message to the DG. - * @details - * Inputs : none - * Outputs : dgPrimaryTempSet, dgTrimmerTempSet + * @details Inputs: none + * @details Outputs: dgPrimaryTempSet, dgTrimmerTempSet * @param primaryHtrTemp commanded target dialysate temperature for the primary heater * @param trimmerHtrTemp commanded target dialysate temperature for the trimmer heater * @return none @@ -522,9 +504,8 @@ * @brief * 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 + * @details Inputs: none + * @details Outputs: start DG command sent * @return none *************************************************************************/ void cmdStartDG( void ) @@ -537,9 +518,8 @@ * @brief * 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 + * @details Inputs: none + * @details Outputs: stop DG command sent * @return none *************************************************************************/ void cmdStopDG( void ) @@ -552,9 +532,8 @@ * @brief * The cmdStartDGTrimmerHeater function sends a start trimmer heater command * to the DG. - * @details - * Inputs : none - * Outputs : start DG trimmer heater command sent + * @details Inputs: none + * @details Outputs: start DG trimmer heater command sent * @return none *************************************************************************/ void cmdStartDGTrimmerHeater( void ) @@ -567,9 +546,8 @@ * @brief * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command * to the DG. - * @details - * Inputs : none - * Outputs : stop DG trimmer heater command sent + * @details Inputs: none + * @details Outputs: stop DG trimmer heater command sent * @return none *************************************************************************/ void cmdStopDGTrimmerHeater( void ) @@ -582,9 +560,8 @@ * @brief * The cmdSetDGActiveReservoir function sends a set active reservoir command * message to the DG. - * @details - * Inputs : none - * Outputs : set active reservoir command sent to DG. + * @details Inputs: none + * @details Outputs: set active reservoir command sent to DG. * @param resID ID of reservoir to set as active (reservoir for HD to draw from) * @return none *************************************************************************/ @@ -604,9 +581,8 @@ /*********************************************************************//** * @brief * The cmdStartDGFill function sends a fill command message to the DG. - * @details - * Inputs : none - * Outputs : fill command sent to DG. + * @details Inputs: none + * @details Outputs: fill command sent to DG. * @param fillToVolMl volume (in mL) to fill inactive reservoir to * @return none *************************************************************************/ @@ -619,9 +595,8 @@ /*********************************************************************//** * @brief * The cmdStartDGDrain function sends a drain command message to the DG. - * @details - * Inputs : none - * Outputs : drain command sent to DG. + * @details Inputs: none + * @details Outputs: drain command sent to DG. * @param drainToVolMl volume (in mL) to drain inactive reservoir to * @return none *************************************************************************/ @@ -634,9 +609,8 @@ /*********************************************************************//** * @brief * The cmdDGSampleWater function sends a sample water command message to the DG. - * @details - * Inputs : none - * Outputs : sample water command sent to DG. + * @details Inputs: none + * @details Outputs: sample water command sent to DG. * @return none *************************************************************************/ void cmdDGSampleWater( void ) Index: firmware/App/Controllers/DialInFlow.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -190,9 +190,8 @@ /*********************************************************************//** * @brief * The initDialInFlow function initializes the DialInFlow module. - * @details - * Inputs : none - * Outputs : DialInFlow module initialized. + * @details Inputs: none + * @details Outputs: DialInFlow module initialized. * @return none *************************************************************************/ void initDialInFlow( void ) @@ -215,9 +214,8 @@ * @brief * The setDialInPumpTargetFlowRate function sets a new target flow rate and * pump direction. - * @details - * Inputs : isDialInPumpOn, dialInPumpDirectionSet - * Outputs : targetDialInFlowRate, dialInPumpdirection, dialInPumpPWMDutyCyclePct + * @details Inputs: isDialInPumpOn, dialInPumpDirectionSet + * @details Outputs: targetDialInFlowRate, dialInPumpdirection, dialInPumpPWMDutyCyclePct * @param flowRate new target dialIn flow rate * @param dir new dialIn flow direction * @param mode new control mode @@ -282,9 +280,8 @@ /*********************************************************************//** * @brief * The signalDialInPumpHardStop function stops the dialIn pump immediately. - * @details - * Inputs : none - * Outputs : DialIn pump stopped, set point reset, state changed to off + * @details Inputs: none + * @details Outputs: DialIn pump stopped, set point reset, state changed to off * @return none *************************************************************************/ void signalDialInPumpHardStop( void ) @@ -302,9 +299,8 @@ * The signalDialInPumpRotorHallSensor function handles the dialysate inlet pump rotor * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if * there is a pending request to home the pump. - * @details - * Inputs : dipRotorRevStartTime, dipStopAtHomePosition - * Outputs : dipRotorRevStartTime, dialInPumpRotorSpeedRPM + * @details Inputs: dipRotorRevStartTime, dipStopAtHomePosition + * @details Outputs: dipRotorRevStartTime, dialInPumpRotorSpeedRPM * @return none *************************************************************************/ void signalDialInPumpRotorHallSensor( void ) @@ -327,9 +323,8 @@ /*********************************************************************//** * @brief * The homeDialInPump function initiates a dialysate inlet pump home operation. - * @details - * Inputs : dialInPumpState - * Outputs : dipStopAtHomePosition, dipHomeStartTime, dialysate inlet pump started (slow) + * @details Inputs: dialInPumpState + * @details Outputs: dipStopAtHomePosition, dipHomeStartTime, dialysate inlet pump started (slow) * @return none *************************************************************************/ BOOL homeDialInPump( void ) @@ -349,9 +344,8 @@ /*********************************************************************//** * @brief * The execDialInFlowMonitor function executes the dialIn flow monitor. - * @details - * Inputs : none - * Outputs : measuredDialInFlowRate, adcDialInPumpMCSpeedRPM, adcDialInPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: measuredDialInFlowRate, adcDialInPumpMCSpeedRPM, adcDialInPumpMCCurrentmA * @return none *************************************************************************/ void execDialInFlowMonitor( void ) @@ -389,9 +383,8 @@ /*********************************************************************//** * @brief * The execDialInFlowController function executes the dialIn flow controller. - * @details - * Inputs : dialInPumpState - * Outputs : dialInPumpState + * @details Inputs: dialInPumpState + * @details Outputs: dialInPumpState * @return none *************************************************************************/ void execDialInFlowController( void ) @@ -424,9 +417,8 @@ * @brief * The handleDialInPumpOffState function handles the dialIn pump off state * of the dialIn pump controller state machine. - * @details - * Inputs : targetDialInFlowRate, dialInPumpDirection - * Outputs : dialInPumpPWMDutyCyclePctSet, dialInPumpDirectionSet, isDialInPumpOn + * @details Inputs: targetDialInFlowRate, dialInPumpDirection + * @details Outputs: dialInPumpPWMDutyCyclePctSet, dialInPumpDirectionSet, isDialInPumpOn * @return next state *************************************************************************/ static DIAL_IN_PUMP_STATE_T handleDialInPumpOffState( void ) @@ -453,9 +445,8 @@ * @brief * The handleDialInPumpRampingUpState function handles the ramp up state * of the dialIn pump controller state machine. - * @details - * Inputs : dialInPumpPWMDutyCyclePctSet - * Outputs : dialInPumpPWMDutyCyclePctSet + * @details Inputs: dialInPumpPWMDutyCyclePctSet + * @details Outputs: dialInPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static DIAL_IN_PUMP_STATE_T handleDialInPumpRampingUpState( void ) @@ -498,9 +489,8 @@ * @brief * The handleDialInPumpRampingDownState function handles the ramp down state * of the dialIn pump controller state machine. - * @details - * Inputs : dialInPumpPWMDutyCyclePctSet - * Outputs : dialInPumpPWMDutyCyclePctSet + * @details Inputs: dialInPumpPWMDutyCyclePctSet + * @details Outputs: dialInPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static DIAL_IN_PUMP_STATE_T handleDialInPumpRampingDownState( void ) @@ -541,9 +531,8 @@ * @brief * The handleDialInPumpControlToTargetState function handles the "control to * target" state of the dialIn pump controller state machine. - * @details - * Inputs : none - * Outputs : dialInPumpState + * @details Inputs: none + * @details Outputs: dialInPumpState * @return next state *************************************************************************/ static DIAL_IN_PUMP_STATE_T handleDialInPumpControlToTargetState( void ) @@ -573,9 +562,8 @@ * @brief * The setDialInPumpControlSignalPWM function sets the PWM duty cycle for * the dialysate inlet pump to a given %. - * @details - * Inputs : none - * Outputs : dialIn pump stop signal activated, PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: dialIn pump stop signal activated, PWM duty cycle zeroed * @param newPWM new duty cycle % to apply to PWM * @return none *************************************************************************/ @@ -587,9 +575,8 @@ /*********************************************************************//** * @brief * The stopDialInPump function sets the dialIn pump stop signal. - * @details - * Inputs : none - * Outputs : dialIn pump stop signal activated, PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: dialIn pump stop signal activated, PWM duty cycle zeroed * @return none *************************************************************************/ static void stopDialInPump( void ) @@ -603,9 +590,8 @@ /*********************************************************************//** * @brief * The releaseDialInPumpStop function clears the dialIn pump stop signal. - * @details - * Inputs : none - * Outputs : dialIn pump stop signal + * @details Inputs: none + * @details Outputs: dialIn pump stop signal * @return none *************************************************************************/ static void releaseDialInPumpStop( void ) @@ -617,9 +603,8 @@ * @brief * The setDialInPumpDirection function sets the set dialIn pump direction to * the given direction. - * @details - * Inputs : dialInPumpState - * Outputs : dialInPumpState + * @details Inputs: dialInPumpState + * @details Outputs: dialInPumpState * @param dir dialIn pump direction to set * @return none *************************************************************************/ @@ -647,9 +632,8 @@ * @brief * The getPublishDialInFlowDataInterval function gets the dialIn flow data * publication interval. - * @details - * Inputs : dialInFlowDataPublishInterval - * Outputs : none + * @details Inputs: dialInFlowDataPublishInterval + * @details Outputs: none * @return the current dialIn flow data publication interval (in task intervals). *************************************************************************/ U32 getPublishDialInFlowDataInterval( void ) @@ -668,9 +652,8 @@ * @brief * The getTargetDialInFlowRate function gets the current target dialIn flow * rate. - * @details - * Inputs : targetDialInFlowRate - * Outputs : none + * @details Inputs: targetDialInFlowRate + * @details Outputs: none * @return the current target dialIn flow rate (in mL/min). *************************************************************************/ S32 getTargetDialInFlowRate( void ) @@ -689,9 +672,8 @@ * @brief * The getMeasuredDialInFlowRate function gets the measured dialIn flow * rate. - * @details - * Inputs : measuredDialInFlowRate - * Outputs : none + * @details Inputs: measuredDialInFlowRate + * @details Outputs: none * @return the current dialIn flow rate (in mL/min). *************************************************************************/ F32 getMeasuredDialInFlowRate( void ) @@ -710,9 +692,8 @@ * @brief * The getMeasuredDialInPumpRotorSpeed function gets the measured dialIn flow * rate. - * @details - * Inputs : dialInPumpRotorSpeedRPM - * Outputs : none + * @details Inputs: dialInPumpRotorSpeedRPM + * @details Outputs: none * @return the current dialIn flow rate (in mL/min). *************************************************************************/ F32 getMeasuredDialInPumpRotorSpeed( void ) @@ -731,9 +712,8 @@ * @brief * The getMeasuredDialInPumpSpeed function gets the measured dialIn flow * rate. - * @details - * Inputs : dialInPumpSpeedRPM - * Outputs : none + * @details Inputs: dialInPumpSpeedRPM + * @details Outputs: none * @return the current dialIn flow rate (in mL/min). *************************************************************************/ F32 getMeasuredDialInPumpSpeed( void ) @@ -752,9 +732,8 @@ * @brief * The getMeasuredDialInPumpMCSpeed function gets the measured dialIn pump * speed. - * @details - * Inputs : adcDialInPumpMCSpeedRPM - * Outputs : none + * @details Inputs: adcDialInPumpMCSpeedRPM + * @details Outputs: none * @return the current dialIn pump speed (in RPM). *************************************************************************/ F32 getMeasuredDialInPumpMCSpeed( void ) @@ -773,9 +752,8 @@ * @brief * The getMeasuredDialInPumpMCCurrent function gets the measured dialIn pump * current. - * @details - * Inputs : adcDialInPumpMCCurrentmA - * Outputs : none + * @details Inputs: adcDialInPumpMCCurrentmA + * @details Outputs: none * @return the current dialIn pump current (in mA). *************************************************************************/ F32 getMeasuredDialInPumpMCCurrent( void ) @@ -794,10 +772,9 @@ * @brief * The publishDialInFlowData function publishes dialIn flow data at the set * interval. - * @details - * Inputs : target flow rate, measured flow rate, measured MC speed, + * @details Inputs: target flow rate, measured flow rate, measured MC speed, * measured MC current - * Outputs : DialIn flow data is published to CAN bus. + * @details Outputs: DialIn flow data is published to CAN bus. * @return none *************************************************************************/ static void publishDialInFlowData( void ) @@ -821,9 +798,8 @@ * @brief * The resetDialInFlowMovingAverage function resets the properties of the * dialIn flow moving average sample buffer. - * @details - * Inputs : none - * Outputs : flowReadingsTotal, flowReadingsIdx, flowReadingsCount all set to zero. + * @details Inputs: none + * @details Outputs: flowReadingsTotal, flowReadingsIdx, flowReadingsCount all set to zero. * @return none *************************************************************************/ static void resetDialInFlowMovingAverage( void ) @@ -837,9 +813,8 @@ /*********************************************************************//** * @brief * The filterDialInFlowReadings function adds a new flow sample to the filter. - * @details - * Inputs : none - * Outputs : flowReadings[], flowReadingsIdx, flowReadingsCount, flowReadingsTotal + * @details Inputs: none + * @details Outputs: flowReadings[], flowReadingsIdx, flowReadingsCount, flowReadingsTotal * @return none *************************************************************************/ static void filterDialInFlowReadings( F32 flow ) @@ -864,9 +839,8 @@ * The updateDialInPumpSpeedAndDirectionFromHallSensors function calculates * the dialysate inlet pump motor speed and direction from hall sensor counter on * a 1 second interval. - * @details - * Inputs : dipLastMotorHallSensorCount, dipMotorSpeedCalcTimerCtr, current count from FPGA - * Outputs : dipMotorDirectionFromHallSensors, dialInPumpSpeedRPM + * @details Inputs: dipLastMotorHallSensorCount, dipMotorSpeedCalcTimerCtr, current count from FPGA + * @details Outputs: dipMotorDirectionFromHallSensors, dialInPumpSpeedRPM * @return none *************************************************************************/ static void updateDialInPumpSpeedAndDirectionFromHallSensors( void ) @@ -903,9 +877,8 @@ * The checkDialInPumpRotor function checks the rotor for the dialysate inlet * 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 : dipStopAtHomePosition, dipHomeStartTime, dipRotorRevStartTime - * Outputs : pump may be stopped if homing, dialInPumpRotorSpeedRPM may be set to zero. + * @details Inputs: dipStopAtHomePosition, dipHomeStartTime, dipRotorRevStartTime + * @details Outputs: pump may be stopped if homing, dialInPumpRotorSpeedRPM may be set to zero. * @return none *************************************************************************/ static void checkDialInPumpRotor( void ) @@ -929,9 +902,8 @@ * @brief * The checkDialInPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. - * @details - * Inputs : adcDialInPumpMCSpeedRPM, dialInPumpDirectionSet, dialInPumpState - * Outputs : none + * @details Inputs: adcDialInPumpMCSpeedRPM, dialInPumpDirectionSet, dialInPumpState + * @details Outputs: none * @return none *************************************************************************/ static void checkDialInPumpDirection( void ) @@ -959,9 +931,8 @@ * 2. while pump is controlling, measured motor speed should be within allowed range of commanded 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 : targetDialInFlowRate, dialInPumpSpeedRPM, dialInPumpRotorSpeedRPM - * Outputs : alarm(s) may be triggered + * @details Inputs: targetDialInFlowRate, dialInPumpSpeedRPM, dialInPumpRotorSpeedRPM + * @details Outputs: alarm(s) may be triggered * @return none *************************************************************************/ static void checkDialInPumpSpeeds( void ) @@ -1043,9 +1014,8 @@ * against the implied flow of the measured pump speed when in treatment mode * and controlling to target flow. If a sufficient difference persists, a * flow vs. motor speed check error is triggered. - * @details - * Inputs : measuredDialInFlowRate, dialInPumpSpeedRPM, errorDialInFlowVsMotorSpeedPersistTimerCtr - * Outputs : alarm may be triggered + * @details Inputs: measuredDialInFlowRate, dialInPumpSpeedRPM, errorDialInFlowVsMotorSpeedPersistTimerCtr + * @details Outputs: alarm may be triggered * @return none *************************************************************************/ static void checkDialInPumpFlowAgainstSpeed( void ) @@ -1082,9 +1052,8 @@ * @brief * The checkDialInPumpMCCurrent function checks the measured MC current vs. * the set state of the dialIn pump (stopped or running). - * @details - * Inputs : dialInPumpState, dipCurrErrorDurationCtr, adcDialInPumpMCCurrentmA - * Outputs : none + * @details Inputs: dialInPumpState, dipCurrErrorDurationCtr, adcDialInPumpMCCurrentmA + * @details Outputs: none * @return none *************************************************************************/ static void checkDialInPumpMCCurrent( void ) @@ -1135,9 +1104,8 @@ * @brief * The execDialInFlowTest function executes the state machine for the * DialInFlow self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the DialInFlow self-test. *************************************************************************/ SELF_TEST_STATUS_T execDialInFlowTest( void ) @@ -1182,9 +1150,8 @@ * @brief * The setDialInFlowCalibration function sets the dialysate flow calibration * factors and has them stored in non-volatile memory. - * @details - * Inputs : none - * Outputs : dialInFlowCalGain, dialInFlowCalOffset + * @details Inputs: none + * @details Outputs: dialInFlowCalGain, dialInFlowCalOffset * @param gain gain calibration factor for dialysate flow sensor * @param offset offset calibration factor for dialysate flow sensor * @return TRUE if calibration factors successfully set/stored, FALSE if not @@ -1217,9 +1184,8 @@ * @brief * The getDialInFlowCalibration function retrieves the current dialysate flow * calibration factors. - * @details - * Inputs : dialInFlowCalGain, dialInFlowCalOffset - * Outputs : none + * @details Inputs: dialInFlowCalGain, dialInFlowCalOffset + * @details Outputs: none * @param gain value to populate with gain calibration factor for dialysate flow sensor * @param offset value to populate with offset calibration factor for dialysate flow sensor * @return none @@ -1234,9 +1200,8 @@ * @brief * The testSetDialInFlowDataPublishIntervalOverride function overrides the * dialIn flow data publish interval. - * @details - * Inputs : none - * Outputs : dialInFlowDataPublishInterval + * @details Inputs: none + * @details Outputs: dialInFlowDataPublishInterval * @param value override dialIn flow data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1260,9 +1225,8 @@ * @brief * The testResetDialInFlowDataPublishIntervalOverride function resets the override * of the dialIn flow data publish interval. - * @details - * Inputs : none - * Outputs : dialInFlowDataPublishInterval + * @details Inputs: none + * @details Outputs: dialInFlowDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetDialInFlowDataPublishIntervalOverride( void ) @@ -1283,9 +1247,8 @@ * @brief * The testSetTargetDialInFlowRateOverride function overrides the target * dialysate inlet flow rate.n - * @details - * Inputs : none - * Outputs : targetDialInFlowRate + * @details Inputs: none + * @details Outputs: targetDialInFlowRate * @param value override target dialysate inlet flow rate (in mL/min) * @param ctrlMode override pump control mode to this mode (0 = closed loop, 1 = open loop) * @return TRUE if override successful, FALSE if not @@ -1322,9 +1285,8 @@ * @brief * The testResetTargetDialInFlowRateOverride function resets the override of the * target dialysate inlet flow rate. - * @details - * Inputs : none - * Outputs : targetDialInFlowRate + * @details Inputs: none + * @details Outputs: targetDialInFlowRate * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetTargetDialInFlowRateOverride( void ) @@ -1347,9 +1309,8 @@ * @brief * The testResetMeasuredDialInFlowRateOverride function overrides the measured * dialIn flow rate. - * @details - * Inputs : none - * Outputs : measuredDialInFlowRate + * @details Inputs: none + * @details Outputs: measuredDialInFlowRate * @param value override measured dialIn flow rate (in mL/min) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1371,9 +1332,8 @@ * @brief * The testResetMeasuredDialInFlowRateOverride function resets the override of the * measured dialIn flow rate. - * @details - * Inputs : none - * Outputs : measuredDialInFlowRate + * @details Inputs: none + * @details Outputs: measuredDialInFlowRate * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialInFlowRateOverride( void ) @@ -1394,9 +1354,8 @@ * @brief * The testSetMeasuredDialInPumpRotorSpeedOverride function overrides the measured * dialIn pump rotor speed. - * @details - * Inputs : none - * Outputs : dialInPumpRotorSpeedRPM + * @details Inputs: none + * @details Outputs: dialInPumpRotorSpeedRPM * @param value override measured dialIn pump rotor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1418,9 +1377,8 @@ * @brief * The testResetMeasuredDialInPumpRotorSpeedOverride function resets the override of the * measured dialIn pump rotor speed. - * @details - * Inputs : none - * Outputs : dialInPumpRotorSpeedRPM + * @details Inputs: none + * @details Outputs: dialInPumpRotorSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialInPumpRotorSpeedOverride( void ) @@ -1441,9 +1399,8 @@ * @brief * The testSetMeasuredDialInPumpSpeedOverride function overrides the measured * dialIn pump motor speed. - * @details - * Inputs : none - * Outputs : dialInPumpSpeedRPM + * @details Inputs: none + * @details Outputs: dialInPumpSpeedRPM * @param value override measured dialIn pump motor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1465,9 +1422,8 @@ * @brief * The testResetMeasuredDialInPumpSpeedOverride function resets the override of the * measured dialIn pump motor speed. - * @details - * Inputs : none - * Outputs : dialInPumpSpeedRPM + * @details Inputs: none + * @details Outputs: dialInPumpSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialInPumpSpeedOverride( void ) @@ -1488,9 +1444,8 @@ * @brief * The testSetMeasuredDialInPumpMCSpeedOverride function overrides the measured * dialIn pump motor speed. - * @details - * Inputs : none - * Outputs : adcDialInPumpMCSpeedRPM + * @details Inputs: none + * @details Outputs: adcDialInPumpMCSpeedRPM * @param value override measured dialIn pump speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1512,9 +1467,8 @@ * @brief * The testResetMeasuredDialInPumpMCSpeedOverride function resets the override of the * measured dialIn pump motor speed. - * @details - * Inputs : none - * Outputs : adcDialInPumpMCSpeedRPM + * @details Inputs: none + * @details Outputs: adcDialInPumpMCSpeedRPM * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialInPumpMCSpeedOverride( void ) @@ -1535,9 +1489,8 @@ * @brief * The testSetMeasuredDialInPumpMCCurrentOverride function overrides the measured * dialIn pump motor current. - * @details - * Inputs : none - * Outputs : adcDialInPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: adcDialInPumpMCCurrentmA * @param value override measured dialIn pump current (in mA) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1559,9 +1512,8 @@ * @brief * The testResetMeasuredDialInPumpMCCurrentOverride function resets the override of the * measured dialIn pump motor current. - * @details - * Inputs : none - * Outputs : adcDialInPumpMCCurrentmA + * @details Inputs: none + * @details Outputs: adcDialInPumpMCCurrentmA * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialInPumpMCCurrentOverride( void ) Index: firmware/App/Controllers/DialOutFlow.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -185,9 +185,8 @@ /*********************************************************************//** * @brief * The initDialOutFlow function initializes the DialOutFlow module. - * @details - * Inputs : none - * Outputs : DialOutFlow module initialized. + * @details Inputs: none + * @details Outputs: DialOutFlow module initialized. * @return none *************************************************************************/ void initDialOutFlow( void ) @@ -224,9 +223,8 @@ * @brief * The setDialOutPumpTargetRate function sets a new target flow rate, pump * direction, and control mode. - * @details - * Inputs : isDialOutPumpOn, dialOutPumpDirectionSet - * Outputs : targetDialOutFlowRate, dialOutPumpdirection, dialOutPumpPWMDutyCyclePct + * @details Inputs: isDialOutPumpOn, dialOutPumpDirectionSet + * @details Outputs: targetDialOutFlowRate, dialOutPumpdirection, dialOutPumpPWMDutyCyclePct * @param flowRate new target dialysate outlet flow rate * @param dir new dialysate outlet flow direction * @param mode new control mode @@ -297,9 +295,8 @@ * @brief * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). - * @details - * Inputs : none - * Outputs : referenceUFVolumeInMl and totalMeasuredUFVolumeInMl + * @details Inputs: none + * @details Outputs: referenceUFVolumeInMl and totalMeasuredUFVolumeInMl * @param refVol New ultrafiltration reference volume (in mL) * @param totVol New ultrafiltration total volume (in mL) * @return none @@ -314,9 +311,8 @@ * @brief * The signalDialOutPumpHardStop function stops the dialysate outlet pump * immediately. - * @details - * Inputs : none - * Outputs : Dialysate outlet pump stopped, set point reset, state changed to off + * @details Inputs: none + * @details Outputs: Dialysate outlet pump stopped, set point reset, state changed to off * @return none *************************************************************************/ void signalDialOutPumpHardStop( void ) @@ -334,9 +330,8 @@ * 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 - * Outputs : dopRotorRevStartTime, dialOutPumpRotorSpeedRPM + * @details Inputs: dopRotorRevStartTime, dopStopAtHomePosition + * @details Outputs: dopRotorRevStartTime, dialOutPumpRotorSpeedRPM * @return none *************************************************************************/ void signalDialOutPumpRotorHallSensor( void ) @@ -359,9 +354,8 @@ /*********************************************************************//** * @brief * The homeDialOutPump function initiates a dialysate outlet pump home operation. - * @details - * Inputs : dialOutPumpState - * Outputs : dopStopAtHomePosition, dopHomeStartTime, dialysate outlet pump started (slow) + * @details Inputs: dialOutPumpState + * @details Outputs: dopStopAtHomePosition, dopHomeStartTime, dialysate outlet pump started (slow) * @return none *************************************************************************/ BOOL homeDialOutPump( void ) @@ -382,9 +376,8 @@ * @brief * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). - * @details - * Inputs : none - * Outputs : loadCellWeightInGrams[] + * @details Inputs: none + * @details Outputs: loadCellWeightInGrams[] * @param res1Primary New weight from primary load cell of reservoir 1 * @param res1Backup New weight from backup load cell of reservoir 1 * @param res2Primary New weight from primary load cell of reservoir 2 @@ -408,9 +401,8 @@ * 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 - * Outputs : dialOutPumpMCSpeedRPM, dialOutPumpMCCurrentmA + * @details Inputs: latest sensor data + * @details Outputs: dialOutPumpMCSpeedRPM, dialOutPumpMCCurrentmA * @return none *************************************************************************/ void execDialOutFlowMonitor( void ) @@ -444,9 +436,8 @@ * @brief * The execDialOutFlowController function executes the dialysate outlet pump * ultrafiltration controller state machine. - * @details - * Inputs : dialOutPumpState - * Outputs : dialOutPumpState + * @details Inputs: dialOutPumpState + * @details Outputs: dialOutPumpState * @return none *************************************************************************/ void execDialOutFlowController( void ) @@ -479,9 +470,8 @@ * @brief * The handleDialOutPumpOffState function handles the dialOut pump off state * of the dialOut pump controller state machine. - * @details - * Inputs : targetDialOutFlowRate, dialOutPumpDirection - * Outputs : dialOutPumpPWMDutyCyclePctSet, dialOutPumpDirectionSet, isDialOutPumpOn + * @details Inputs: targetDialOutFlowRate, dialOutPumpDirection + * @details Outputs: dialOutPumpPWMDutyCyclePctSet, dialOutPumpDirectionSet, isDialOutPumpOn * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpOffState( void ) @@ -512,9 +502,8 @@ * @brief * The handleDialOutPumpRampingUpState function handles the ramp up state * of the dialOut pump controller state machine. - * @details - * Inputs : dialOutPumpPWMDutyCyclePctSet - * Outputs : dialOutPumpPWMDutyCyclePctSet + * @details Inputs: dialOutPumpPWMDutyCyclePctSet + * @details Outputs: dialOutPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpRampingUpState( void ) @@ -556,9 +545,8 @@ * @brief * The handleDialOutPumpRampingDownState function handles the ramp down state * of the dialOut pump controller state machine. - * @details - * Inputs : dialOutPumpPWMDutyCyclePctSet - * Outputs : dialOutPumpPWMDutyCyclePctSet + * @details Inputs: dialOutPumpPWMDutyCyclePctSet + * @details Outputs: dialOutPumpPWMDutyCyclePctSet * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpRampingDownState( void ) @@ -598,9 +586,8 @@ * @brief * The handleDialOutPumpControlToTargetState function handles the "control to * target" state of the dialOut pump controller state machine. - * @details - * Inputs : dopControlTimerCounter, dialOutPumpControlModeSet, volumes. - * Outputs : dopControlTimerCounter, pump controlled. + * @details Inputs: dopControlTimerCounter, dialOutPumpControlModeSet, volumes. + * @details Outputs: dopControlTimerCounter, pump controlled. * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpControlToTargetState( void ) @@ -639,9 +626,8 @@ * @brief * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of * the dialysate outlet pump to a given %. - * @details - * Inputs : none - * Outputs : dialysis outlet pump PWM duty cycle is set. + * @details Inputs: none + * @details Outputs: dialysis outlet pump PWM duty cycle is set. * @param newPWM A percentage duty cycle between 0.0 and 1.0 * @return none *************************************************************************/ @@ -654,9 +640,8 @@ * @brief * The stopDialOutPump function sets the dialout flow stop signal and PWM * duty cycle to 0.0. - * @details - * Inputs : none - * Outputs : dialOut pump stop signal activated, PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: dialOut pump stop signal activated, PWM duty cycle zeroed * @return none *************************************************************************/ static void stopDialOutPump( void ) @@ -670,9 +655,8 @@ /*********************************************************************//** * @brief * The releaseDialOutPumpStop function clears the dialysate outlet pump stop signal. - * @details - * Inputs : none - * Outputs : dialysate outlet pump stop signal is cleared. + * @details Inputs: none + * @details Outputs: dialysate outlet pump stop signal is cleared. * @return none *************************************************************************/ static void releaseDialOutPumpStop( void ) @@ -684,9 +668,8 @@ * @brief * The setDialOutPumpDirection function sets the set dialOut pump direction to * the given direction. - * @details - * Inputs : none - * Outputs : dialOutPumpDirectionSet, pump direction signal set to match given direction. + * @details Inputs: none + * @details Outputs: dialOutPumpDirectionSet, pump direction signal set to match given direction. * @param dir dialysate outlet pump direction to set * @return none *************************************************************************/ @@ -714,9 +697,8 @@ * @brief * The publishDialOutFlowData function publishes dialysate outlet data at * the set interval. - * @details - * Inputs : Dialysate outlet pump data - * Outputs : Dialysate outlet pump data is published to CAN bus. + * @details Inputs: Dialysate outlet pump data + * @details Outputs: Dialysate outlet pump data is published to CAN bus. * @return none *************************************************************************/ static void publishDialOutFlowData( void ) @@ -742,9 +724,8 @@ * 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 - * Outputs : dopMotorDirectionFromHallSensors, dialOutPumpSpeedRPM + * @details Inputs: dopLastMotorHallSensorCount, dopMotorSpeedCalcTimerCtr, current count from FPGA + * @details Outputs: dopMotorDirectionFromHallSensors, dialOutPumpSpeedRPM * @return none *************************************************************************/ static void updateDialOutPumpSpeedAndDirectionFromHallSensors( void ) @@ -781,9 +762,8 @@ * 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 - * Outputs : pump may be stopped if homing, dialOutPumpRotorSpeedRPM may be set to zero. + * @details Inputs: dopStopAtHomePosition, dopHomeStartTime, dopRotorRevStartTime + * @details Outputs: pump may be stopped if homing, dialOutPumpRotorSpeedRPM may be set to zero. * @return none *************************************************************************/ static void checkDialOutPumpRotor( void ) @@ -807,9 +787,8 @@ * @brief * The checkDialOutPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. - * @details - * Inputs : adcDialOutPumpMCSpeedRPM, dialOutPumpDirectionSet, dialOutPumpState - * Outputs : none + * @details Inputs: adcDialOutPumpMCSpeedRPM, dialOutPumpDirectionSet, dialOutPumpState + * @details Outputs: none * @return none *************************************************************************/ static void checkDialOutPumpDirection( void ) @@ -837,9 +816,8 @@ * 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 - * Outputs : alarm(s) may be triggered + * @details Inputs: targetDialOutFlowRate, dialOutPumpSpeedRPM, dialOutPumpRotorSpeedRPM + * @details Outputs: alarm(s) may be triggered * @return none *************************************************************************/ static void checkDialOutPumpSpeeds( void ) @@ -918,9 +896,8 @@ * @brief * The checkDialOutPumpMCCurrent function checks the measured MC current vs. * the set state of the dialOut pump (stopped or running). - * @details - * Inputs : dialOutPumpState, dopCurrErrorDurationCtr, adcDialOutPumpMCCurrentmA - * Outputs : none + * @details Inputs: dialOutPumpState, dopCurrErrorDurationCtr, adcDialOutPumpMCCurrentmA + * @details Outputs: none * @return none *************************************************************************/ static void checkDialOutPumpMCCurrent( void ) @@ -976,9 +953,8 @@ * @brief * The getPublishDialOutFlowDataInterval function gets the dialysate out flow * data publication interval. - * @details - * Inputs : dialOutDataPublishInterval - * Outputs : none + * @details Inputs: dialOutDataPublishInterval + * @details Outputs: none * @return the current dialysate out flow data publication interval (in ms). *************************************************************************/ static U32 getPublishDialOutDataInterval( void ) @@ -996,9 +972,8 @@ /*********************************************************************//** * @brief * The getLoadCellWeightInGrams function gets the load cell weight. - * @details - * Inputs : loadCellWeightInGrams - * Outputs : none + * @details Inputs: loadCellWeightInGrams + * @details Outputs: none * @param loadCellID ID of load cell to get * @return the current load cell weight in grams *************************************************************************/ @@ -1028,9 +1003,8 @@ /*********************************************************************//** * @brief * The getTotalTargetDialOutUFVolumeInMl function gets the target UF volume. - * @details - * Inputs : referenceUFVolumeInMl - * Outputs : none + * @details Inputs: referenceUFVolumeInMl + * @details Outputs: none * @return the current target UF volume in mL. *************************************************************************/ F32 getTotalTargetDialOutUFVolumeInMl( void ) @@ -1048,9 +1022,8 @@ /*********************************************************************//** * @brief * The getTotalMeasuredUFVolumeInMl function gets the measured UF volume. - * @details - * Inputs : totalMeasuredUFVolumeInMl - * Outputs : none + * @details Inputs: totalMeasuredUFVolumeInMl + * @details Outputs: none * @return the current UF volume (in mL). *************************************************************************/ F32 getTotalMeasuredUFVolumeInMl( void ) @@ -1069,9 +1042,8 @@ * @brief * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate * outlet pump rotor speed. - * @details - * Inputs : dialOutPumpRotorSpeedRPM - * Outputs : none + * @details Inputs: dialOutPumpRotorSpeedRPM + * @details Outputs: none * @return the current dialysate outlet pump rotor speed (in RPM). *************************************************************************/ F32 getMeasuredDialOutPumpRotorSpeed( void ) @@ -1090,9 +1062,8 @@ * @brief * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet * pump motor speed. - * @details - * Inputs : dialOutPumpSpeedRPM - * Outputs : none + * @details Inputs: dialOutPumpSpeedRPM + * @details Outputs: none * @return the current dialysate outlet pump motor speed (in RPM). *************************************************************************/ F32 getMeasuredDialOutPumpSpeed( void ) @@ -1111,9 +1082,8 @@ * @brief * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump * speed. - * @details - * Inputs : dialOutPumpMCSpeedRPM - * Outputs : none + * @details Inputs: dialOutPumpMCSpeedRPM + * @details Outputs: none * @return the current dialOut pump speed (in RPM). *************************************************************************/ F32 getMeasuredDialOutPumpMCSpeed( void ) @@ -1132,9 +1102,8 @@ * @brief * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump * current. - * @details - * Inputs : dialOutPumpMCCurrentmA - * Outputs : none + * @details Inputs: dialOutPumpMCCurrentmA + * @details Outputs: none * @return the current dialOut pump current (in mA). *************************************************************************/ F32 getMeasuredDialOutPumpMCCurrent( void ) @@ -1159,9 +1128,8 @@ * @brief * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the * dialout data publish interval. - * @details - * Inputs : none - * Outputs : dialOutDataPublishInterval + * @details Inputs: none + * @details Outputs: dialOutDataPublishInterval * @param value override dialout data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1185,9 +1153,8 @@ * @brief * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override * of the dialout data publish interval. - * @details - * Inputs : none - * Outputs : dialOutDataPublishInterval + * @details Inputs: none + * @details Outputs: dialOutDataPublishInterval * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetDialOutPumpAndLoadCellDataPublishIntervalOverride( void ) @@ -1208,9 +1175,8 @@ * @brief * The testSetTargetDialOutFlowRateOverride function overrides the target * dialysate outlet flow rate. - * @details - * Inputs : none - * Outputs : pump started w/ set target rate and control mode + * @details Inputs: none + * @details Outputs: pump started w/ set target rate and control mode * @param value override target dialysate outlet flow rate (in mL/min) * @param ctrlMode override pump control mode to this mode (0 = closed loop, 1 = open loop) * @return TRUE if override successful, FALSE if not @@ -1244,9 +1210,8 @@ * @brief * The testResetTargetDialOutFlowRateOverride function resets the override of the * target dialysate outlet flow rate. - * @details - * Inputs : none - * Outputs : pump stopped + * @details Inputs: none + * @details Outputs: pump stopped * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetTargetDialOutFlowRateOverride( void ) @@ -1265,9 +1230,8 @@ * @brief * The testSetDialOutUFRefVolumeOverride function overrides the target * dialout vol rate. - * @details - * Inputs : referenceUFVolumeInMl - * Outputs : referenceUFVolumeInMl + * @details Inputs: referenceUFVolumeInMl + * @details Outputs: referenceUFVolumeInMl * @param value override target dialout vol rate (in mL/min) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1289,9 +1253,8 @@ * @brief * The testResetDialOutUFRefVolumeOverride function resets the override of the * target dialout vol rate. - * @details - * Inputs : referenceUFVolumeInMl - * Outputs : referenceUFVolumeInMl + * @details Inputs: referenceUFVolumeInMl + * @details Outputs: referenceUFVolumeInMl * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetDialOutUFRefVolumeOverride( void ) @@ -1312,9 +1275,8 @@ * @brief * The testSetDialOutUFTotVolumeOverride function overrides the measured * dialout vol rate. - * @details - * Inputs : totalMeasuredUFVolumeInMl - * Outputs : totalMeasuredUFVolumeInMl + * @details Inputs: totalMeasuredUFVolumeInMl + * @details Outputs: totalMeasuredUFVolumeInMl * @param value override measured dialout vol rate (in mL/min) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1336,9 +1298,8 @@ * @brief * The testResetDialOutUFTotVolumeOverride function resets the override of the * measured dialout vol rate. - * @details - * Inputs : totalMeasuredUFVolumeInMl - * Outputs : totalMeasuredUFVolumeInMl + * @details Inputs: totalMeasuredUFVolumeInMl + * @details Outputs: totalMeasuredUFVolumeInMl * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetDialOutUFTotVolumeOverride( void ) @@ -1359,9 +1320,8 @@ * @brief * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured * dialOut pump rotor speed. - * @details - * Inputs : DialOutPumpRotorSpeedRPM - * Outputs : DialOutPumpRotorSpeedRPM + * @details Inputs: DialOutPumpRotorSpeedRPM + * @details Outputs: DialOutPumpRotorSpeedRPM * @param value override measured dialOut pump rotor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1383,9 +1343,8 @@ * @brief * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the * measured dialOut pump rotor speed. - * @details - * Inputs : DialOutPumpRotorSpeedRPM - * Outputs : DialOutPumpRotorSpeedRPM + * @details Inputs: DialOutPumpRotorSpeedRPM + * @details Outputs: DialOutPumpRotorSpeedRPM * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialOutPumpRotorSpeedOverride( void ) @@ -1406,9 +1365,8 @@ * @brief * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured * dialOut pump motor speed. - * @details - * Inputs : dialOutPumpSpeedRPM - * Outputs : dialOutPumpSpeedRPM + * @details Inputs: dialOutPumpSpeedRPM + * @details Outputs: dialOutPumpSpeedRPM * @param value override measured dialOut pump motor speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1430,9 +1388,8 @@ * @brief * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the * measured dialOut pump motor speed. - * @details - * Inputs : dialOutPumpSpeedRPM - * Outputs : dialOutPumpSpeedRPM + * @details Inputs: dialOutPumpSpeedRPM + * @details Outputs: dialOutPumpSpeedRPM * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialOutPumpSpeedOverride( void ) @@ -1453,9 +1410,8 @@ * @brief * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured * dialOut pump motor speed. - * @details - * Inputs : dialOutPumpMCSpeedRPM - * Outputs : dialOutPumpMCSpeedRPM + * @details Inputs: dialOutPumpMCSpeedRPM + * @details Outputs: dialOutPumpMCSpeedRPM * @param value override measured dialOut pump speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1477,9 +1433,8 @@ * @brief * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the * measured dialOut pump motor speed. - * @details - * Inputs : dialOutPumpMCSpeedRPM - * Outputs : dialOutPumpMCSpeedRPM + * @details Inputs: dialOutPumpMCSpeedRPM + * @details Outputs: dialOutPumpMCSpeedRPM * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialOutPumpMCSpeedOverride( void ) @@ -1500,9 +1455,8 @@ * @brief * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured * dialOut pump motor current. - * @details - * Inputs : dialOutPumpMCCurrentmA - * Outputs : dialOutPumpMCCurrentmA + * @details Inputs: dialOutPumpMCCurrentmA + * @details Outputs: dialOutPumpMCCurrentmA * @param value override measured dialOut pump current (in mA) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1524,9 +1478,8 @@ * @brief * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the * measured dialOut pump motor current. - * @details - * Inputs : dialOutPumpMCCurrentmA - * Outputs : dialOutPumpMCCurrentmA + * @details Inputs: dialOutPumpMCCurrentmA + * @details Outputs: dialOutPumpMCCurrentmA * @return TRUE if reset override successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredDialOutPumpMCCurrentOverride( void ) @@ -1547,9 +1500,8 @@ * @brief * The testSetDialOutLoadCellWeightOverride function overrides the value of the * load cell sensor with a given weight (in grams). - * @details - * Inputs : loadCellWeightInGrams[] - * Outputs : loadCellWeightInGrams[] + * @details Inputs: loadCellWeightInGrams[] + * @details Outputs: loadCellWeightInGrams[] * @param sensor ID of load cell sensor to override weight for * @param value override weight (in grams) for the given sensor * @return TRUE if override successful, FALSE if not @@ -1575,9 +1527,8 @@ * @brief * The testResetDialOutLoadCellWeightOverride function resets the override of the * load cell sensor. - * @details - * Inputs : loadCellWeightInGrams[] - * Outputs : loadCellWeightInGrams[] + * @details Inputs: loadCellWeightInGrams[] + * @details Outputs: loadCellWeightInGrams[] * @param sensor ID of load cell sensor to override weight for * @return TRUE if reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Controllers/PresOccl.c =================================================================== diff -u -rfa4f2bfd1ec6a4f007b23789b002429125d7f1a8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision fa4f2bfd1ec6a4f007b23789b002429125d7f1a8) +++ firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -94,9 +94,8 @@ /*********************************************************************//** * @brief * The initPresOccl function initializes the initPresOccl module. - * @details - * Inputs : none - * Outputs : Pressures and Occlusions module initialized. + * @details Inputs: none + * @details Outputs: Pressures and Occlusions module initialized. * @return none *************************************************************************/ void initPresOccl( void ) @@ -108,9 +107,8 @@ * @brief * The setPressureLimits function sets the lower and upper alarm limits * for a given pressure sensor. - * @details - * Inputs : none - * Outputs : pressure limits + * @details Inputs: none + * @details Outputs: pressure limits * @param sensor pressure sensor we are setting limits for * @param low lower alarm limit (mmHg) * @param high upper alarm limit (mmHg) @@ -140,9 +138,8 @@ * @brief * The setOcclusionThreshold function sets the occlusion pressure threshold * for a given occlusion sensor. - * @details - * Inputs : none - * Outputs : pressure threshold + * @details Inputs: none + * @details Outputs: pressure threshold * @param sensor occlusion sensor we are setting threshold for * @param threshold pressure threshold above which indicates an occlusion (mmHg) * @return none @@ -172,9 +169,8 @@ /*********************************************************************//** * @brief * The execPresOccl function executes the pressure and occlusion monitor. - * @details - * Inputs : presOcclState - * Outputs : presOcclState + * @details Inputs: presOcclState + * @details Outputs: presOcclState * @return none *************************************************************************/ void execPresOccl( void ) @@ -203,9 +199,8 @@ * @brief * The handlePresOcclInitState function handles the pres/occl initialize state * of the pressure/occlusion monitor state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePresOcclInitState( void ) @@ -219,9 +214,8 @@ * @brief * The handlePresOcclContReadState function handles the continuous read state * of the pressure/occlusion monitor state machine. - * @details - * Inputs : FPGA pressure/occlusion readings - * Outputs : pressure sensor values updated + * @details Inputs: FPGA pressure/occlusion readings + * @details Outputs: pressure sensor values updated * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePresOcclContReadState( void ) @@ -255,9 +249,8 @@ * @brief * The checkPressureLimits function gets the pressure/occlusion data * publication interval. - * @details - * Inputs : occlusion pressures for the pumps - * Outputs : alarm(s) may be triggered + * @details Inputs: occlusion pressures for the pumps + * @details Outputs: alarm(s) may be triggered * @return none *************************************************************************/ static void checkOcclusions( void ) @@ -289,29 +282,26 @@ * @brief * The getPublishPresOcclDataInterval function gets the pressure/occlusion data * publication interval. - * @details - * Inputs : presOcclDataPublishInterval - * Outputs : none + * @details Inputs: presOcclDataPublishInterval + * @details Outputs: none * @return the current pressure/occlusion data publication interval (in task intervals). *************************************************************************/ DATA_GET( U32, getPublishPresOcclDataInterval, presOcclDataPublishInterval ) /*********************************************************************//** * @brief * The getMeasuredArterialPressure function gets the current arterial pressure. - * @details - * Inputs : arterialPressure - * Outputs : none + * @details Inputs: arterialPressure + * @details Outputs: none * @return the current arterial pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredArterialPressure, arterialPressure ) /*********************************************************************//** * @brief * The getMeasuredVenousPressure function gets the measured venous pressure. - * @details - * Inputs : venousPressure - * Outputs : none + * @details Inputs: venousPressure + * @details Outputs: none * @return the current venous pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredVenousPressure, venousPressure ) @@ -320,9 +310,8 @@ * @brief * The getMeasuredBloodPumpOcclusion function gets the measured blood pump * occlusion pressure. - * @details - * Inputs : bloodPumpOcclusion - * Outputs : none + * @details Inputs: bloodPumpOcclusion + * @details Outputs: none * @return the current blood pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredBloodPumpOcclusion, bloodPumpOcclusion ) @@ -331,9 +320,8 @@ * @brief * The getMeasuredDialInPumpOcclusion function gets the measured dialysate * inlet pump occlusion pressure. - * @details - * Inputs : dialInPumpOcclusion - * Outputs : none + * @details Inputs: dialInPumpOcclusion + * @details Outputs: none * @return the current dialysis inlet pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredDialInPumpOcclusion, dialInPumpOcclusion ) @@ -342,9 +330,8 @@ * @brief * The getMeasuredDialOutPumpOcclusion function gets the measured dialysate * outlet pump occlusion pressure. - * @details - * Inputs : dialOutPumpOcclusion - * Outputs : none + * @details Inputs: dialOutPumpOcclusion + * @details Outputs: none * @return the current dialysis outlet pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpOcclusion, dialOutPumpOcclusion ) @@ -353,9 +340,8 @@ * @brief * The publishPresOcclData function publishes pressure/occlusion data at the * set interval. - * @details - * Inputs : latest pressure and occlusion readings - * Outputs : Pressure/occlusion data are published to CAN bus. + * @details Inputs: latest pressure and occlusion readings + * @details Outputs: Pressure/occlusion data are published to CAN bus. * @return none *************************************************************************/ static void publishPresOcclData( void ) @@ -378,9 +364,8 @@ * @brief * The execPresOcclTest function executes the state machine for the * PresOccl self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the PresOccl self-test. *************************************************************************/ SELF_TEST_STATUS_T execPresOcclTest( void ) @@ -402,9 +387,8 @@ * @brief * The testSetPresOcclDataPublishIntervalOverride function overrides the * pressure and occlusion data publish interval. - * @details - * Inputs : none - * Outputs : presOcclDataPublishInterval + * @details Inputs: none + * @details Outputs: presOcclDataPublishInterval * @param value override pressure and occlusion data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -428,9 +412,8 @@ * @brief * The testResetPresOcclDataPublishIntervalOverride function resets the override * of the pressure and occlusion data publish interval. - * @details - * Inputs : none - * Outputs : presOcclDataPublishInterval + * @details Inputs: none + * @details Outputs: presOcclDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetPresOcclDataPublishIntervalOverride( void ) @@ -451,9 +434,8 @@ * @brief * The testSetArterialPressureOverride function overrides the measured arterial * pressure. - * @details - * Inputs : none - * Outputs : arterialPressure + * @details Inputs: none + * @details Outputs: arterialPressure * @param value override arterial pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -475,9 +457,8 @@ * @brief * The testResetArterialPressureOverride function resets the override of the * arterial pressure. - * @details - * Inputs : none - * Outputs : arterialPressure + * @details Inputs: none + * @details Outputs: arterialPressure * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetArterialPressureOverride( void ) @@ -498,9 +479,8 @@ * @brief * The testSetVenousPressureOverride function overrides the measured venous * pressure. - * @details - * Inputs : none - * Outputs : venousPressure + * @details Inputs: none + * @details Outputs: venousPressure * @param value override measured venous pressure with (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -522,9 +502,8 @@ * @brief * The testResetVenousPressureOverride function resets the override of the * venous pressure. - * @details - * Inputs : none - * Outputs : venousPressure + * @details Inputs: none + * @details Outputs: venousPressure * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetVenousPressureOverride( void ) @@ -545,9 +524,8 @@ * @brief * The testSetBloodPumpOcclusionOverride function overrides the measured * blood pump occlusion pressure.n - * @details - * Inputs : none - * Outputs : bloodPumpOcclusion + * @details Inputs: none + * @details Outputs: bloodPumpOcclusion * @param value override measured blood pump occlusion pressure with (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -569,9 +547,8 @@ * @brief * The testResetBloodPumpOcclusionOverride function resets the override of the * measured blood pump occlusion pressure. - * @details - * Inputs : none - * Outputs : bloodPumpOcclusion + * @details Inputs: none + * @details Outputs: bloodPumpOcclusion * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetBloodPumpOcclusionOverride( void ) @@ -592,9 +569,8 @@ * @brief * The testSetDialInPumpOcclusionOverride function overrides the measured * dialysate inlet pump occlusion pressure.n - * @details - * Inputs : none - * Outputs : dialInPumpOcclusion + * @details Inputs: none + * @details Outputs: dialInPumpOcclusion * @param value override measured dialysate inlet pump occlusion pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -616,9 +592,8 @@ * @brief * The testResetDialInPumpOcclusionOverride function resets the override of the * measured dialysate inlet pump occlusion pressure. - * @details - * Inputs : none - * Outputs : dialInPumpOcclusion + * @details Inputs: none + * @details Outputs: dialInPumpOcclusion * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetDialInPumpOcclusionOverride( void ) @@ -639,9 +614,8 @@ * @brief * The testSetDialOutPumpOcclusionOverride function overrides the measured * dialysate outlet pump occlusion pressure. - * @details - * Inputs : none - * Outputs : dialOutPumpOcclusion + * @details Inputs: none + * @details Outputs: dialOutPumpOcclusion * @param value override measured dialysate outlet pump occlusion pressure (in mmHg) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -663,9 +637,8 @@ * @brief * The testResetDialOutPumpOcclusionOverride function resets the override of the * measured dialysate outlet pump occlusion pressure. - * @details - * Inputs : none - * Outputs : dialOutPumpOcclusion + * @details Inputs: none + * @details Outputs: dialOutPumpOcclusion * @return TRUE if reset successful, FALSE if not *************************************************************************/ BOOL testResetDialOutPumpOcclusionOverride( void ) Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -235,10 +235,9 @@ /*********************************************************************//** * @brief * The initValves function initializes the valves driver. - * @details - * Inputs: valveSelfTestState, valvesSelfTestResult, valvesStatus, + * @details Inputs: valveSelfTestState, valvesSelfTestResult, valvesStatus, * valvesControlSetBits - * Outputs: valveSelfTestState, valvesSelfTestResult, valvesStatus + * @details Outputs: valveSelfTestState, valvesSelfTestResult, valvesStatus * @return none *************************************************************************/ void initValves( void ) @@ -264,9 +263,8 @@ /*********************************************************************//** * @brief * The homeValve function sets the homing request flag of a valve to TRUE. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus (The flag that sets the homing request) + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus (The flag that sets the homing request) * @param valve that is set to be homed * @return none *************************************************************************/ @@ -278,9 +276,8 @@ /*********************************************************************//** * @brief * The setValvePosition function sets the requested position of a valve. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its position is set * @param position that the valve is set * @return returns TRUE if the requested position was legal @@ -305,9 +302,8 @@ /*********************************************************************//** * @brief * The getValvePosition function returns the current position of a valve. - * @details - * Inputs: none - * Outputs: valvesStatus + * @details Inputs: none + * @details Outputs: valvesStatus * @param valve that the position is requested * @return returns the current position of the valve in enum *************************************************************************/ @@ -320,9 +316,8 @@ * @brief * The setValveBloodTrap function set the blood trap valve to open or close * position. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param: state enumeration of open or close for valve * @return: none *************************************************************************/ @@ -341,9 +336,8 @@ /*********************************************************************//** * @brief * The execValvesSelfTest function executes the valves self test. - * @details - * Inputs: valveSelfTestState - * Outputs: valveSelfTestState + * @details Inputs: valveSelfTestState + * @details Outputs: valveSelfTestState * @return valvesSelfTestResult The status of the self test *************************************************************************/ SELF_TEST_STATUS_T execValvesSelfTest( void ) @@ -374,9 +368,8 @@ /*********************************************************************//** * @brief * The execValves function executes the valves exec state machine. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @return none *************************************************************************/ void execValves( void ) @@ -436,9 +429,8 @@ /*********************************************************************//** * @brief * The handleValveSelfTestEnableValves function starts the valves self test. - * @details - * Inputs: valvesSelfTestResult, valvesSelfTestResult - * Outputs: valvesSelfTestResult, valvesSelfTestResult + * @details Inputs: valvesSelfTestResult, valvesSelfTestResult + * @details Outputs: valvesSelfTestResult, valvesSelfTestResult * @return next state of the self test state machine *************************************************************************/ static VALVE_SELF_TEST_STATE_T handleValveSelfTestEnableValves( void ) @@ -464,9 +456,8 @@ * @brief * The handleValveSelfTestConfirmEnable function checks to make sure the * valves are enabled properly. - * @details - * Inputs: valvesSelfTestResult - * Outputs: valvesSelfTestResult + * @details Inputs: valvesSelfTestResult + * @details Outputs: valvesSelfTestResult * @return next state of the self test state machine *************************************************************************/ static VALVE_SELF_TEST_STATE_T handleValveSelfTestConfirmEnable( void ) @@ -491,9 +482,8 @@ /*********************************************************************//** * @brief * The handleValveStateWaitForPost function handles the wait for POST state. - * @details - * Inputs: valveSelfTestState - * Outputs: none + * @details Inputs: valveSelfTestState + * @details Outputs: none * @param valve that is waiting for POST to complete * @return next state of exec state *************************************************************************/ @@ -513,9 +503,8 @@ * @brief * The handleValveStateHomingNotStarted function handles homing not started * state of the state machine. - * @details - * Inputs: valvesStatus, valveSelfTestState, isDoorClosed - * Outputs: valvesStatus + * @details Inputs: valvesStatus, valveSelfTestState, isDoorClosed + * @details Outputs: valvesStatus * @param valve that is set to be homed * @return next state of the exec state machine *************************************************************************/ @@ -553,9 +542,8 @@ * @brief * The handleValveStateHomingFindEnergizedEdge function handles find * energized state of the state machine. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its energized edge is found * @return next state of the exec state machine *************************************************************************/ @@ -598,9 +586,8 @@ * @brief * The handleValveStateHomingFindDeenergizedEdge function handles find * de-energized state of the state machine. - * @details. - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its de-energized edge is found * @return next state of the exec state machine *************************************************************************/ @@ -673,9 +660,8 @@ * @brief * The handleValveStateIdle function handles the idle state of the valves * state machine. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that is in idle state * @return next state of the exec state machine *************************************************************************/ @@ -726,9 +712,8 @@ * @brief * The handleValveStateInTransition function handles the in transition * state of the state machine. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that is in position transition * @return next state of the exec state machine *************************************************************************/ @@ -780,9 +765,8 @@ * @brief * The handleValveStateInBypassMode function handles the bypass mode * state of the state machine. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that is in position transition * @return next state of the exec state machine *************************************************************************/ @@ -816,10 +800,9 @@ /*********************************************************************//** * @brief * The setValveControlMode function sets the valves control mode. - * @details - * Inputs: valvesControlSetBits, valvesControlModesSetBits, + * @details Inputs: valvesControlSetBits, valvesControlModesSetBits, * valvesControlModesResetBits - * Outputs: valvesControlSetBits + * @details Outputs: valvesControlSetBits * @param valve that its control mode is set * @param mode the control mode that the valve will be set to * @return none @@ -843,9 +826,8 @@ * @brief * The execMonitorValves function handles monitoring of the valves. The * function calls other functions to monitor the values. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ static void execMonitorValves( void ) @@ -876,9 +858,8 @@ * The areValvesEnabled function checks the current valves status from FPGA * to the enable bit mask of each valve. If any of the valves is not enabled * the function raises an alarm. - * @details - * Inputs: valvesStatus, valvesControlStatusBits - * Outputs: none + * @details Inputs: valvesStatus, valvesControlStatusBits + * @details Outputs: none * @return Returns TRUE if all the valves are enabled properly *************************************************************************/ static BOOL areValvesFunctional( void ) @@ -932,9 +913,8 @@ /*********************************************************************//** * @brief * The setFPGAValue function sets the position of a valve to FPGA. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param valve that its FPGA set point is updated * @param position that is set in counts * @param enableCurrentRelaxation flag. Indicates whether current relaxation @@ -981,9 +961,8 @@ * The convertAndMonitorValvesCurrent function gets the current values * in counts from FPGA and converts them to current. If any of the values * is above the threshold, the function raises an alarm. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @return none *************************************************************************/ static void convertAndMonitorValvesCurrent( void ) @@ -1034,9 +1013,8 @@ * checks whether any of the valves have deviated from their current position \n * if they are in idle state. If any of the valves have deviated, the function \n * raises an alarm. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @return none *************************************************************************/ static void getAndMonitorValvesCurrentPosition( void ) @@ -1089,9 +1067,8 @@ * @brief * The getPublishValvesDataInterval function gets the valves data publish * interval. - * @details - * Inputs: valvesDataPublishInterval - * Outputs: none + * @details Inputs: valvesDataPublishInterval + * @details Outputs: none * @return data publish time interval *************************************************************************/ U32 getPublishValvesDataInterval( void ) @@ -1110,9 +1087,8 @@ * @brief * The publishValvesData function publishes the data of the valves at the * specified time interval. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its data is published * @return none *************************************************************************/ @@ -1143,9 +1119,8 @@ * @brief * The setValveNextStep function calculates the next step of a valve and * calls another function to set the next step. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its next step is calculated and set * @return none *************************************************************************/ @@ -1203,9 +1178,8 @@ * The setFPGAValvePWM function checks whether the valve should be moving * CW or CCW and converts the PWM in percent to PWM in counts accordingly. * The converted PWM in counts is set via the FPGA functions. - * @details - * Inputs: valvesStatus - * Outputs: none + * @details Inputs: valvesStatus + * @details Outputs: none * @param valve which its PWM is being set * @return none *************************************************************************/ @@ -1252,9 +1226,8 @@ * @brief * The getValvesCurrentPWM function gets the PWM counts from the FPGA module * and converts them in to duty cycle in percent. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @return none *************************************************************************/ static void getValvesCurrentPWM( void ) @@ -1293,9 +1266,8 @@ * @brief * The testSetValvesDataPublishInterval function overrides the valves data * publish interval. - * @details - * Inputs: valvesDataPublishInterval - * Outputs: valvesDataPublishInterval + * @details Inputs: valvesDataPublishInterval + * @details Outputs: valvesDataPublishInterval * @param value which is override value for the valve data publish interval * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -1319,9 +1291,8 @@ * @brief * The testResetValvesDataPublishInterval function resets the override * of the valves publish interval. - * @details - * Inputs: valvesDataPublishInterval - * Outputs: valvesDataPublishInterval + * @details Inputs: valvesDataPublishInterval + * @details Outputs: valvesDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetValvesDataPublishInterval( void ) @@ -1341,9 +1312,8 @@ /*********************************************************************//** * @brief * The testSetValvesPositionOverride function overrides the valves position. - * @details - * Inputs: valvesPositionOverride, valvesStatus - * Outputs: valvesPositionOverride + * @details Inputs: valvesPositionOverride, valvesStatus + * @details Outputs: valvesPositionOverride * @param valve to override its position * @param position of the valve that will be overridden * @return TRUE if override successful, FALSE if not @@ -1372,9 +1342,8 @@ * @brief * The testResetValvesDataPublishInterval function resets the override * of the valves publish interval. - * @details - * Inputs: valvesDataPublishInterval - * Outputs: valvesDataPublishInterval + * @details Inputs: valvesDataPublishInterval + * @details Outputs: valvesDataPublishInterval * @param valve that its data publish will be overridden * @return TRUE if override reset successful, FALSE if not *************************************************************************/ @@ -1398,9 +1367,8 @@ * @brief * The testSetValvePWMOverride function overrides the valves PWM in bypass * control mode. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve to override its PWM * @param pwm in percent * @param direction of the movement of the valve in clockwise or counter @@ -1442,9 +1410,8 @@ * @brief * The testResetValvePWMOverride function resets the override PWM in bypass * control mode. - * @details - * Inputs: valvesStatus - * Outputs: valvesStatus + * @details Inputs: valvesStatus + * @details Outputs: valvesStatus * @param valve that its data publish will be overridden * @return TRUE if override reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Drivers/CPLD.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -91,9 +91,8 @@ * @brief * The initCPLD function initializes the CPLD module. All outputs to CPLD * (watchdog pet, off request, and alarm lamp LEDs) are set to low. - * @details - * Inputs : none - * Outputs : CPLD module signal outputs set to initial states. + * @details Inputs: none + * @details Outputs: CPLD module signal outputs set to initial states. * @return none *************************************************************************/ void initCPLD( void ) @@ -113,9 +112,8 @@ /*********************************************************************//** * @brief * The toggleCPLDWatchdog function toggles the watchdog pet signal to CPLD. - * @details - * Inputs : none - * Outputs : watchdog pet signal toggled. + * @details Inputs: none + * @details Outputs: watchdog pet signal toggled. * @return none *************************************************************************/ void toggleCPLDWatchdog( void ) @@ -127,9 +125,8 @@ * @brief * The getCPLDWatchdogExpired function determines the current signal level * on the watchdog expired pin from the CPLD. - * @details - * Inputs : Signal from CPLD on watchdog expired pin. - * Outputs : none + * @details Inputs: Signal from CPLD on watchdog expired pin. + * @details Outputs: none * @return level (LOW or HIGH) *************************************************************************/ PIN_SIGNAL_STATE_T getCPLDWatchdogExpired( void ) @@ -143,9 +140,8 @@ * @brief * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD * to given level. - * @details - * Inputs : none - * Outputs : alarm lamp green signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp green signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ @@ -165,9 +161,8 @@ * @brief * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD * to given level. - * @details - * Inputs : none - * Outputs : alarm lamp blue signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp blue signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ @@ -187,9 +182,8 @@ * @brief * The setCPLDLampRed function sets the alarm lamp red signal to CPLD * to given level. - * @details - * Inputs : none - * Outputs : alarm lamp red signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp red signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ @@ -211,9 +205,8 @@ * The off request signal must be toggled 4 times, once every 50 ms, in order * for the CPLD to accept the off request sequence and initiate system power * down. - * @details - * Inputs : none - * Outputs : off request signal toggled. + * @details Inputs: none + * @details Outputs: off request signal toggled. * @return none *************************************************************************/ void toggleCPLDOffRequest( void ) @@ -225,9 +218,8 @@ * @brief * The getCPLDOffButton function determines the current signal level * on the off button pin from the CPLD. - * @details - * Inputs : Signal from CPLD on off button pin. - * Outputs : none + * @details Inputs: Signal from CPLD on off button pin. + * @details Outputs: none * @return level (LOW or HIGH) *************************************************************************/ PIN_SIGNAL_STATE_T getCPLDOffButton( void ) @@ -246,9 +238,8 @@ * @brief * The getCPLDStopButton function determines the current signal level * on the stop button pin from the CPLD. - * @details - * Inputs : Signal from CPLD on off button pin. - * Outputs : none + * @details Inputs: Signal from CPLD on off button pin. + * @details Outputs: none * @return level (LOW or HIGH) *************************************************************************/ PIN_SIGNAL_STATE_T getCPLDStopButton( void ) Index: firmware/App/Drivers/Comm.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Drivers/Comm.c (.../Comm.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Drivers/Comm.c (.../Comm.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -41,9 +41,8 @@ * @brief * The signalCANXmitsInitiated function sets the CAN transmits in * progress flag. - * @details - * Inputs : none - * Outputs : canXmitsInProgress + * @details Inputs: none + * @details Outputs: canXmitsInProgress * @return none *************************************************************************/ void signalCANXmitsInitiated( void ) @@ -55,9 +54,8 @@ * @brief * The signalCANXmitsCompleted function resets the CAN transmits in * progress flag. - * @details - * Inputs : none - * Outputs : canXmitsInProgress + * @details Inputs: none + * @details Outputs: canXmitsInProgress * @return none *************************************************************************/ void signalCANXmitsCompleted( void ) @@ -69,9 +67,8 @@ * @brief * The signalSCI1XmitsInitiated function sets the SCI1 transmits in * progress flag. - * @details - * Inputs : none - * Outputs : uartXmitsInProgress + * @details Inputs: none + * @details Outputs: uartXmitsInProgress * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -85,9 +82,8 @@ * @brief * The signalSCI1XmitsCompleted function resets the SCI1 transmits in * progress flag. - * @details - * Inputs : none - * Outputs : uartXmitsInProgress + * @details Inputs: none + * @details Outputs: uartXmitsInProgress * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -101,9 +97,8 @@ * @brief * The setSCI1DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is enabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -117,9 +112,8 @@ * @brief * The setSCI1DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is enabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -133,9 +127,8 @@ * @brief * The clearSCI1DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is disabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -149,9 +142,8 @@ * @brief * The clearSCI1DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is disabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -165,9 +157,8 @@ * @brief * The setSCI2DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is enabled. * @return none *************************************************************************/ void setSCI2DMAReceiveInterrupt( void ) @@ -179,9 +170,8 @@ * @brief * The setSCI2DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is enabled. * @return none *************************************************************************/ void setSCI2DMATransmitInterrupt( void ) @@ -193,9 +183,8 @@ * @brief * The clearSCI2DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is disabled. * @return none *************************************************************************/ void clearSCI2DMAReceiveInterrupt( void ) @@ -207,9 +196,8 @@ * @brief * The clearSCI2DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is disabled. * @return none *************************************************************************/ void clearSCI2DMATransmitInterrupt( void ) @@ -221,9 +209,8 @@ * @brief * The clearSCI1CommErrors function clears framing and/or overrun error flags \ * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : SCI1 error flags cleared. + * @details Inputs: none + * @details Outputs: SCI1 error flags cleared. * @return none *************************************************************************/ void clearSCI1CommErrors( void ) @@ -236,9 +223,8 @@ * @brief * The clearSCI2CommErrors function clears framing and/or overrun error flags * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : SCI2 error flags cleared. + * @details Inputs: none + * @details Outputs: SCI2 error flags cleared. * @return none *************************************************************************/ void clearSCI2CommErrors( void ) @@ -251,9 +237,8 @@ * @brief * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI1 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ #ifdef DEBUG_ENABLED @@ -271,9 +256,8 @@ * @brief * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI2 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ BOOL isSCI2DMATransmitInProgress( void ) @@ -288,9 +272,8 @@ * @brief * The isCAN1TransmitInProgress function determines whether a transmit * is in progress on the CAN1 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ BOOL isCAN1TransmitInProgress( void ) Index: firmware/App/Drivers/InternalADC.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -75,9 +75,8 @@ /*********************************************************************//** * @brief * The initInternalADC function initializes the InternalADC module. - * @details - * Inputs : none - * Outputs : InternalADC module is initialized. + * @details Inputs: none + * @details Outputs: InternalADC module is initialized. * @return none *************************************************************************/ void initInternalADC( void ) @@ -107,9 +106,8 @@ * @brief * The adcNotification function handles an ADC conversion complete interrupt. * All channel readings in the FIFO are retrieved. - * @details - * Inputs : ADC FIFO - * Outputs : adcRawReadingsCount, adcRawReadings[] + * @details Inputs: ADC FIFO + * @details Outputs: adcRawReadingsCount, adcRawReadings[] * @param adc pointer to the ADC1 controller * @param group ADC channel group ID * @return none @@ -126,9 +124,8 @@ * @brief * The execInternalADC function processes the last set of raw ADC channel * readings and kicks off the next conversion of ADC channels. - * @details - * Inputs : adcRawReadingsCount, adcRawReadings[] - * Outputs : adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] + * @details Inputs: adcRawReadingsCount, adcRawReadings[] + * @details Outputs: adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] * @return none *************************************************************************/ void execInternalADC( void ) @@ -162,9 +159,8 @@ * @brief * The getIntADCReading function gets the latest average reading for a given * channel. - * @details - * Inputs : adcReadingsAvgs[] - * Outputs : none + * @details Inputs: adcReadingsAvgs[] + * @details Outputs: none * @param channel adc channel to retrieve a reading for * @return average reading for the given channel *************************************************************************/ Index: firmware/App/Drivers/SafetyShutdown.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -43,9 +43,8 @@ /*********************************************************************//** * @brief * The initSafetyShutdown function initializes the Buttons module. - * @details - * Inputs : none - * Outputs : Safety Shutdown module signal output set to initial state. + * @details Inputs: none + * @details Outputs: Safety Shutdown module signal output set to initial state. * @return none *************************************************************************/ void initSafetyShutdown( void ) @@ -56,9 +55,8 @@ /*********************************************************************//** * @brief * The activateSafetyShutdown function activates the safety shutdown signal. - * @details - * Inputs : none - * Outputs : Safety Shutdown signal output set to active state. + * @details Inputs: none + * @details Outputs: Safety Shutdown signal output set to active state. * @return none *************************************************************************/ void activateSafetyShutdown( void ) @@ -71,9 +69,8 @@ * @brief * The isSafetyShutdownActivated function returns whether the safety shutdown * signal has been activated. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return safetyShutdownActivated *************************************************************************/ BOOL isSafetyShutdownActivated( void ) @@ -85,9 +82,8 @@ * @brief * The testSetSafetyShutdownOverride function overrides the HD safety * shutdown. - * @details - * Inputs : none - * Outputs : HD safety shutdown overridden + * @details Inputs: none + * @details Outputs: HD safety shutdown overridden * @param value TRUE to activate safety shutdown, FALSE to de-activate it. * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -119,9 +115,8 @@ * @brief * The testResetSafetyShutdownOverride function resets the override of the * HD safety shutdown. - * @details - * Inputs : none - * Outputs : shutdown override reset + * @details Inputs: none + * @details Outputs: shutdown override reset * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetSafetyShutdownOverride( void ) Index: firmware/App/Modes/Dialysis.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -85,9 +85,8 @@ * 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 - * Outputs : Dialysis sub-mode module initialized. + * @details Inputs: none + * @details Outputs: Dialysis sub-mode module initialized. * @return none *************************************************************************/ void initDialysis( void ) @@ -124,9 +123,8 @@ * 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 - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToDialysis( void ) @@ -139,9 +137,8 @@ * 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 - * Outputs : dialysis treatment parameters are set. + * @details Inputs: none + * @details Outputs: dialysis treatment parameters are set. * @param bPFlow target blood pump flow rate (in mL/min) * @param dPFlow target dialysate inlet pump flow rate (in mL/min) * @param maxUFVol maximum ultrafiltration volume (in mL) @@ -175,9 +172,8 @@ * The startDialysis function starts/resumes dialysis. This function * will be called by Treatment Mode when beginning or resuming dialysis * treatment. - * @details - * Inputs : none - * Outputs : Dialysis module prepared for immediate resumption. + * @details Inputs: none + * @details Outputs: Dialysis module prepared for immediate resumption. * @return none *************************************************************************/ void startDialysis( void ) @@ -205,9 +201,8 @@ * 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 - * Outputs : Blood and dialysate pumps stopped. Heparin pump stopped. + * @details Inputs: none + * @details Outputs: Blood and dialysate pumps stopped. Heparin pump stopped. * @return none *************************************************************************/ void stopDialysis( void ) @@ -224,9 +219,8 @@ /*********************************************************************//** * @brief * The getDialysisState function gets the current dialysis state (sub-mode). - * @details - * Inputs : currentDialysisState - * Outputs : none + * @details Inputs: currentDialysisState + * @details Outputs: none * @return currentDialysisState *************************************************************************/ DIALYSIS_STATE_T getDialysisState( void ) @@ -237,9 +231,8 @@ /*********************************************************************//** * @brief * The getUltrafiltrationState function gets the current ultrafiltration state. - * @details - * Inputs : currentUFState - * Outputs : none + * @details Inputs: currentUFState + * @details Outputs: none * @return currentUFState *************************************************************************/ UF_STATE_T getUltrafiltrationState( void ) @@ -250,9 +243,8 @@ /*********************************************************************//** * @brief * The getSalineBolusState function gets the current saline bolus state. - * @details - * Inputs : currentSalineBolusState - * Outputs : none + * @details Inputs: currentSalineBolusState + * @details Outputs: none * @return currentSalineBolusState *************************************************************************/ SALINE_BOLUS_STATE_T getSalineBolusState( void ) @@ -264,9 +256,8 @@ * @brief * The getUltrafiltrationVolumeCollected function gets the current ultrafiltration * volume collected so far for current treatment. - * @details - * Inputs : measUFVolume, measUFVolumeFromPriorReservoirs - * Outputs : none + * @details Inputs: measUFVolume, measUFVolumeFromPriorReservoirs + * @details Outputs: none * @return currentUFState *************************************************************************/ F32 getUltrafiltrationVolumeCollected( void ) @@ -279,9 +270,8 @@ /*********************************************************************//** * @brief * The pauseUF function pauses ultrafiltration. - * @details - * Inputs : currentDialysisState, currentUFState - * Outputs : currentUFState, outlet pump set point + * @details Inputs: currentDialysisState, currentUFState + * @details Outputs: currentUFState, outlet pump set point * @return TRUE if pause successful, FALSE if not *************************************************************************/ BOOL pauseUF( void ) @@ -328,9 +318,8 @@ /*********************************************************************//** * @brief * The resumeUF function resumes ultrafiltration. - * @details - * Inputs : currentDialysisState, currentUFState - * Outputs : currentUFState, outlet pump set point + * @details Inputs: currentDialysisState, currentUFState + * @details Outputs: currentUFState, outlet pump set point * @return TRUE if resume successful, FALSE if not *************************************************************************/ BOOL resumeUF( void ) @@ -379,9 +368,8 @@ /*********************************************************************//** * @brief * The execDialysis function executes the Dialysis sub-mode state machine. - * @details - * Inputs : currentDialysisState - * Outputs : currentDialysisState + * @details Inputs: currentDialysisState + * @details Outputs: currentDialysisState * @return none *************************************************************************/ void execDialysis( void ) @@ -414,9 +402,8 @@ * @brief * The handleDialysisUltrafiltrationState function handles the ultrafiltration * state of the Dialysis state machine. - * @details - * Inputs : currentUFState - * Outputs : currentUFState + * @details Inputs: currentUFState + * @details Outputs: currentUFState * @return next Dialysis state. *************************************************************************/ static DIALYSIS_STATE_T handleDialysisUltrafiltrationState( void ) @@ -457,9 +444,8 @@ * @brief * The handleDialysisSolutionInfusionState function handles the solution * infustion state of the Dialysis state machine. - * @details - * Inputs : currentSalineBolusState - * Outputs : currentSalineBolusState + * @details Inputs: currentSalineBolusState + * @details Outputs: currentSalineBolusState * @return next Dialysis state. *************************************************************************/ static DIALYSIS_STATE_T handleDialysisSalineBolusState( void ) @@ -475,9 +461,8 @@ * @brief * The handleUFStartState function handles the Start state of the * ultrafiltration state machine. - * @details - * Inputs : maxUFVolumeML - * Outputs : if ultrafiltration prescribed, ultrafiltration time is + * @details Inputs: maxUFVolumeML + * @details Outputs: if ultrafiltration prescribed, ultrafiltration time is * initialized. * @return next ultrafiltration state. *************************************************************************/ @@ -503,9 +488,8 @@ * @brief * The handleUFPausedState function handles the Paused state of the * ultrafiltration state machine. - * @details - * Inputs : none - * Outputs : if ultrafiltration resumption requested, UF time is set to resume. + * @details Inputs: none + * @details Outputs: if ultrafiltration resumption requested, UF time is set to resume. * @return next ultrafiltration state. *************************************************************************/ static UF_STATE_T handleUFPausedState( void ) @@ -529,9 +513,8 @@ * @brief * 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 + * @details Inputs: ms timer, lastUFTimeStamp + * @details Outputs: UF timer incremented, UF volumes updated and provided to DPo * pump controller. * @return next ultrafiltration state. *************************************************************************/ @@ -571,9 +554,8 @@ * @brief * The handleUFCompletedOrOffState function handles the UF Off state * of the ultrafiltration state machine. - * @details - * Inputs : none - * Outputs : UF volumes updated and provided to DPo pump controller. + * @details Inputs: none + * @details Outputs: UF volumes updated and provided to DPo pump controller. * @return next ultrafiltration state *************************************************************************/ static UF_STATE_T handleUFOffState( void ) @@ -590,9 +572,8 @@ * @brief * The handleUFCompletedState function handles the UF Completed * state of the ultrafiltration state machine. This is a terminal state. - * @details - * Inputs : none - * Outputs : UF volumes updated and provided to DPo pump controller. + * @details Inputs: none + * @details Outputs: UF volumes updated and provided to DPo pump controller. * @return next ultrafiltration state *************************************************************************/ static UF_STATE_T handleUFCompletedState( void ) @@ -609,9 +590,8 @@ * @brief * The checkUF function checks ultrafiltration accuracy for the last * hour and checks total UF volume. Triggers an alarm if out of spec. - * @details - * Inputs : uFAccuracyCheckTimerCtr, lastUFVolumeChecked, measUFVolume - * Outputs : uFAccuracyCheckTimerCtr, lastUFVolumeChecked + * @details Inputs: uFAccuracyCheckTimerCtr, lastUFVolumeChecked, measUFVolume + * @details Outputs: uFAccuracyCheckTimerCtr, lastUFVolumeChecked * @return none *************************************************************************/ static void checkUFAccuracyAndVolume( void ) @@ -657,9 +637,8 @@ * 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 - * Outputs : refUFVolume, measUFVolume + * @details Inputs: setUFRate, uFTimeMS, load cell weight + * @details Outputs: refUFVolume, measUFVolume * @return none *************************************************************************/ static void updateUFVolumes( void ) @@ -688,9 +667,8 @@ * 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 - * Outputs : resStartVolume[] + * @details Inputs: active reservoir, load cell reading from inactive reservoir + * @details Outputs: resStartVolume[] * @return none *************************************************************************/ void setStartReservoirVolume( void ) @@ -720,9 +698,8 @@ * 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[] - * Outputs : measUFVolumeFromPriorReservoirs + * @details Inputs: resFinalVolume[], resStartVolume[] + * @details Outputs: measUFVolumeFromPriorReservoirs * @return none *************************************************************************/ void signalReservoirsSwitched( void ) @@ -739,9 +716,8 @@ * 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 - * Outputs : measUFVolumeFromPriorReservoirs, resFinalVolume[], resStartVolume[] + * @details Inputs: active reservoir, load cell reading from inactive reservoir + * @details Outputs: measUFVolumeFromPriorReservoirs, resFinalVolume[], resStartVolume[] * @return none *************************************************************************/ void setFinalReservoirVolume( void ) Index: firmware/App/Modes/ModeFault.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -38,9 +38,8 @@ /*********************************************************************//** * @brief * The initFaultMode function initializes the Fault Mode module. - * @details - * Inputs : none - * Outputs : Fault Mode module initialized. + * @details Inputs: none + * @details Outputs: Fault Mode module initialized. * @return none *************************************************************************/ void initFaultMode( void ) @@ -50,9 +49,8 @@ /*********************************************************************//** * @brief * The transitionToFaultMode function prepares for transition to fault mode. - * @details - * Inputs : none - * Outputs : + * @details Inputs: none + * @details Outputs: * @return none *************************************************************************/ void transitionToFaultMode( void ) @@ -62,9 +60,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the Fault Mode state machine. - * @details - * Inputs : none - * Outputs : + * @details Inputs: none + * @details Outputs: * @return current state (sub-mode) *************************************************************************/ U32 execFaultMode( void ) Index: firmware/App/Modes/ModeInitPOST.c =================================================================== diff -u -r0bfe6ac8e627f0390fbeb25a978d85e15f2cc09a -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 0bfe6ac8e627f0390fbeb25a978d85e15f2cc09a) +++ firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -50,9 +50,8 @@ /*********************************************************************//** * @brief * The initInitAndPOSTMode function initializes the Initialize & POST Mode module. - * @details - * Inputs : none - * Outputs : Initialize & POST Mode module initialized. + * @details Inputs: none + * @details Outputs: Initialize & POST Mode module initialized. * @return none *************************************************************************/ void initInitAndPOSTMode( void ) @@ -67,9 +66,8 @@ * @brief * The transitionToInitAndPOSTMode function prepares for transition to * initialize & POST mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToInitAndPOSTMode( void ) @@ -79,9 +77,8 @@ /*********************************************************************//** * @brief * The execInitAndPOSTMode function executes the Initialize & POST Mode state machine. - * @details - * Inputs : postState - * Outputs : postState, postPassed, postCompleted + * @details Inputs: postState + * @details Outputs: postState, postPassed, postCompleted * @return current state (sub-mode) *************************************************************************/ U32 execInitAndPOSTMode( void ) @@ -193,9 +190,8 @@ * The isPOSTCompleted function determines whether all HD POST have * been run and completed. If true, call the isPOSTPassed() to see final * result (pass/fail). - * @details - * Inputs : postCompleted - * Outputs : none + * @details Inputs: postCompleted + * @details Outputs: none * @return true if all HD POST tests have completed, false if not *************************************************************************/ BOOL isPOSTCompleted( void ) @@ -207,9 +203,8 @@ * @brief * The isPOSTPassed function determines whether all HD POST have passed. * Call this function after POST is complete (call isPOSTCompleted function). - * @details - * Inputs : postPassed - * Outputs : none + * @details Inputs: postPassed + * @details Outputs: none * @return true if all HD POST tests have passed, false if not *************************************************************************/ BOOL isPOSTPassed( void ) @@ -221,9 +216,8 @@ * @brief * The handlePOSTStatus function handles a status result returned by a * POST function. - * @details - * Inputs : postPassed - * Outputs : none + * @details Inputs: postPassed + * @details Outputs: none * @param testStatus status reported by last test * @return recommended next POST state *************************************************************************/ Index: firmware/App/Modes/ModePostTreat.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModePostTreat.c (.../ModePostTreat.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Modes/ModePostTreat.c (.../ModePostTreat.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -39,9 +39,8 @@ /*********************************************************************//** * @brief * The initPostTreatmentMode function initializes the Post-Treatment Mode module. - * @details - * Inputs : none - * Outputs : Post-Treatment Mode module initialized. + * @details Inputs: none + * @details Outputs: Post-Treatment Mode module initialized. * @return none *************************************************************************/ void initPostTreatmentMode( void ) @@ -52,9 +51,8 @@ * @brief * The transitionToPostTreatmentMode function prepares for transition to * post-treatment mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToPostTreatmentMode( void ) @@ -79,9 +77,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the Post-Treatment Mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return current state (sub-mode) *************************************************************************/ U32 execPostTreatmentMode( void ) Index: firmware/App/Modes/ModePreTreat.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -43,9 +43,8 @@ /*********************************************************************//** * @brief * The initPreTreatmentMode function initializes the Pre-Treatment Mode module. - * @details - * Inputs : none - * Outputs : Pre-Treatment Mode module initialized. + * @details Inputs: none + * @details Outputs: Pre-Treatment Mode module initialized. * @return none *************************************************************************/ void initPreTreatmentMode( void ) @@ -56,9 +55,8 @@ * @brief * The transitionToPreTreatmentMode function prepares for transition to * pre-treatment mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToPreTreatmentMode( void ) @@ -85,9 +83,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the Pre-Treatment Mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return current state (sub-mode) *************************************************************************/ U32 execPreTreatmentMode( void ) @@ -119,9 +116,8 @@ * @brief * The signalUserBeginningTreatment function handles user start of a * treatment. - * @details - * Inputs : none - * Outputs : requested mode transition to treatment mode + * @details Inputs: none + * @details Outputs: requested mode transition to treatment mode * @return TRUE if signal accepted, FALSE if not *************************************************************************/ BOOL signalUserBeginningTreatment( void ) Index: firmware/App/Modes/ModeService.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeService.c (.../ModeService.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Modes/ModeService.c (.../ModeService.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -30,9 +30,8 @@ /*********************************************************************//** * @brief * The initServiceMode function initializes the Service Mode module. - * @details - * Inputs : none - * Outputs : Service Mode module initialized. + * @details Inputs: none + * @details Outputs: Service Mode module initialized. * @return none *************************************************************************/ void initServiceMode( void ) @@ -42,9 +41,8 @@ /*********************************************************************//** * @brief * The transitionToServiceMode function prepares for transition to service mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToServiceMode( void ) @@ -54,9 +52,8 @@ /*********************************************************************//** * @brief * The execServiceMode function executes the Service Mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return current state (sub-mode) *************************************************************************/ U32 execServiceMode( void ) Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -53,9 +53,8 @@ /*********************************************************************//** * @brief * The initStandbyMode function initializes the Standby Mode module. - * @details - * Inputs : none - * Outputs : Standby Mode module initialized. + * @details Inputs: none + * @details Outputs: Standby Mode module initialized. * @return none *************************************************************************/ void initStandbyMode( void ) @@ -67,9 +66,8 @@ /*********************************************************************//** * @brief * The transitionToStandbyMode function prepares for transition to standby mode. - * @details - * Inputs : none - * Outputs : Standby Mode module re-initialized, DG interface initialized, + * @details Inputs: none + * @details Outputs: Standby Mode module re-initialized, DG interface initialized, * blood & dialysate pumps shut off. * @return none *************************************************************************/ @@ -92,9 +90,8 @@ /*********************************************************************//** * @brief * The execStandbyMode function executes the Standby Mode state machine. - * @details - * Inputs : currentStandbyState - * Outputs : currentStandbyState + * @details Inputs: currentStandbyState + * @details Outputs: currentStandbyState * @return current state (sub-mode) *************************************************************************/ U32 execStandbyMode( void ) @@ -307,9 +304,8 @@ * @brief * The signalUserStartingTreatment function handles user initiation of a * treatment. - * @details - * Inputs : none - * Outputs : requested mode transition to treatment parameters mode + * @details Inputs: none + * @details Outputs: requested mode transition to treatment parameters mode * @return TRUE if signal accepted, FALSE if not *************************************************************************/ BOOL signalUserStartingTreatment( void ) Index: firmware/App/Modes/ModeTreatment.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -92,9 +92,8 @@ /*********************************************************************//** * @brief * The initTreatmentMode function initializes the Treatment Mode module. - * @details - * Inputs : none - * Outputs : Treatment Mode module initialized. + * @details Inputs: none + * @details Outputs: Treatment Mode module initialized. * @return none *************************************************************************/ void initTreatmentMode( void ) @@ -123,9 +122,8 @@ /*********************************************************************//** * @brief * The transitionToTreatmentMode function prepares for transition to treatment mode. - * @details - * Inputs : none - * Outputs : + * @details Inputs: none + * @details Outputs: * @return none *************************************************************************/ void transitionToTreatmentMode( void ) @@ -156,9 +154,8 @@ /*********************************************************************//** * @brief * The getTreatmentState function gets the current treatment mode state. - * @details - * Inputs : currentTreatmentState - * Outputs : none + * @details Inputs: currentTreatmentState + * @details Outputs: none * @return currentTreatmentState *************************************************************************/ TREATMENT_STATE_T getTreatmentState( void ) @@ -170,9 +167,8 @@ * @brief * The userRequestEndTreatment function conveys a user request to end the * treatment. - * @details - * Inputs : currentTreatmentState - * Outputs : response to user request sent + * @details Inputs: currentTreatmentState + * @details Outputs: response to user request sent * @return TRUE if request accepted, FALSE if not *************************************************************************/ BOOL userRequestEndTreatment( void ) @@ -192,9 +188,8 @@ /*********************************************************************//** * @brief * The execTreatmentMode function executes the Treatment Mode state machine. - * @details - * Inputs : currentTreatmentState - * Outputs : currentTreatmentState + * @details Inputs: currentTreatmentState + * @details Outputs: currentTreatmentState * @return current state (sub-mode) *************************************************************************/ U32 execTreatmentMode( void ) @@ -284,9 +279,8 @@ * @brief * The handleTreatmentStartState function handles the Start state of * the Treatment Mode state machine. - * @details - * Inputs : none - * Outputs : treatmentTimeMS, lastTreatmentTimeStamp + * @details Inputs: none + * @details Outputs: treatmentTimeMS, lastTreatmentTimeStamp * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStartState( void ) @@ -315,9 +309,8 @@ * @brief * The handleTreatmentDialysisState function handles the Dialysis state of * the Treatment Mode state machine. - * @details - * Inputs : none - * Outputs : treatmentTimeMS, lastTreatmentTimeStamp, dialysis sub-mode + * @details Inputs: none + * @details Outputs: treatmentTimeMS, lastTreatmentTimeStamp, dialysis sub-mode * executed. * @return next treatment mode state *************************************************************************/ @@ -368,9 +361,8 @@ * @brief * The handleTreatmentStopState function executes the Stop state of the * Treatment Mode state machine. - * @details - * Inputs : none - * Outputs : treatment stop sub-mode executed. + * @details Inputs: none + * @details Outputs: treatment stop sub-mode executed. * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStopState( void ) @@ -412,9 +404,8 @@ * @brief * The verifyTreatmentDurationSettingChange function verifies and responds to * the user treatment duration setting change request. - * @details - * Inputs : current operating mode, treatment states and parameters - * Outputs : response message sent + * @details Inputs: current operating mode, treatment states and parameters + * @details Outputs: response message sent * @param treatmentTime Proposed new treatment duration (in min) * @return TRUE if new treatment duration setting valid, FALSE if not. *************************************************************************/ @@ -491,9 +482,8 @@ * @brief * The verifyUFSettingsChange function verifies and responds to a new * ultrafiltration volume setting from the user. - * @details - * Inputs : current operating mode, treatment states and parameters - * Outputs : response message sent + * @details Inputs: current operating mode, treatment states and parameters + * @details Outputs: response message sent * @param uFVolume New ultrafiltration volume requested by the user * @return TRUE if new UF voluem is valid, FALSE if not. *************************************************************************/ @@ -594,9 +584,8 @@ * @brief * 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 - * Outputs : response message sent + * @details Inputs: current operating mode, treatment states and parameters + * @details Outputs: response message sent * @param uFVolume New ultrafiltration volume confirmed by the user * @param adjustment The adjustment selected by the user * @return TRUE if new UF settings accepted, FALSE if not. @@ -658,9 +647,8 @@ * @brief * The verifyBloodAndDialysateRateSettingsChange function verifies the * user blood & dialysate flow rate settings change. - * @details - * Inputs : current operating mode, treatment states and parameters - * Outputs : response message sent + * @details Inputs: current operating mode, treatment states and parameters + * @details Outputs: response message sent * @param bloodRate Proposed new blood flow rate (in mL/min) * @param dialRate Proposed new dialysate flow rate (in mL/min) * @return TRUE if new blood & dialysate rate settings are valid, FALSE if not. @@ -718,9 +706,8 @@ * @brief * The broadcastTreatmentTimeAndState function broadcasts treatment time and * state data during treatment. - * @details - * Inputs : treatment time and state data - * Outputs : treatment time and state messages sent on interval + * @details Inputs: treatment time and state data + * @details Outputs: treatment time and state messages sent on interval * @return none *************************************************************************/ static void broadcastTreatmentTimeAndState( void ) @@ -755,9 +742,8 @@ * 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 - * Outputs : valid ranges message sent on interval + * @details Inputs: current operating mode, treatment states and parameters + * @details Outputs: valid ranges message sent on interval * @return none *************************************************************************/ static void broadcastTreatmentSettingsRanges( void ) Index: firmware/App/Modes/ModeTreatmentParams.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -101,9 +101,8 @@ /*********************************************************************//** * @brief * The initOpParamsMode function initializes the Operating Parameters Mode module. - * @details - * Inputs : none - * Outputs : Operating Parameters Mode module initialized. + * @details Inputs: none + * @details Outputs: Operating Parameters Mode module initialized. * @return none *************************************************************************/ void initTreatParamsMode( void ) @@ -115,9 +114,8 @@ * @brief * The transitionToOpParamsMode function prepares for transition to operating * parameters mode. - * @details - * Inputs : none - * Outputs : Treatment Parameters mode reset prior to starting + * @details Inputs: none + * @details Outputs: Treatment Parameters mode reset prior to starting * @return none *************************************************************************/ void transitionToTreatParamsMode( void ) @@ -142,9 +140,8 @@ * @brief * The resetAllTreatmentParameters function resets treatment parameters * to default values. - * @details - * Inputs : none - * Outputs : All treatment parameters reset to default values. + * @details Inputs: none + * @details Outputs: All treatment parameters reset to default values. * @return none *************************************************************************/ static void resetAllTreatmentParameters( void ) @@ -178,9 +175,8 @@ * @brief * The signalUserConfirmationOfTreatmentParameters function sets the user * confirmation flag signaling user has confirmed treatment parameters. - * @details - * Inputs : none - * Outputs : treatParamsConfirmed + * @details Inputs: none + * @details Outputs: treatParamsConfirmed * @return TRUE if confirmation accepted, FALSE if not *************************************************************************/ BOOL signalUserConfirmationOfTreatmentParameters( void ) @@ -200,9 +196,8 @@ * @brief * The signalUserCancelTreatment function sets the cancelled treatment * flag signaling the user has cancelled the treatment. - * @details - * Inputs : none - * Outputs : treatmentCancelled + * @details Inputs: none + * @details Outputs: treatmentCancelled * @return TRUE if cancel accepted, FALSE if not *************************************************************************/ BOOL signalUserCancelTreatment( void ) @@ -222,9 +217,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the Operating Parameters Mode state machine. - * @details - * Inputs : treatParamsState - * Outputs : treatParamsState + * @details Inputs: treatParamsState + * @details Outputs: treatParamsState * @return current state (sub-mode) *************************************************************************/ U32 execTreatParamsMode( void ) @@ -268,9 +262,8 @@ * @brief * The handleWaitForUI2SendState function handles the wait for UI to send * treatment parameters state of treatment parameters mode. - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return current state (sub-mode) *************************************************************************/ static HD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2SendState( void ) @@ -299,9 +292,8 @@ * @brief * The handleWaitForUI2ConfirmState function handles the wait for UI to send * user confirmation state of treatment parameters mode. - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return current state (sub-mode) *************************************************************************/ static HD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2ConfirmState( void ) @@ -350,9 +342,8 @@ * @brief * The validateAndSetTreatmentParameters function validates received * treatment parameters. - * @details - * Inputs : none - * Outputs : stagedParams[], response sent + * @details Inputs: none + * @details Outputs: stagedParams[], response sent * @param params payload record from treatment parameters message received from UI * @return TRUE if received treatment parameters are valid, FALSE if not *************************************************************************/ @@ -388,9 +379,8 @@ * @brief * The checkTreatmentParamsInRange function checks whether received * treatment parameters are in range. - * @details - * Inputs : stagedParams[] - * Outputs : reasons[] + * @details Inputs: stagedParams[] + * @details Outputs: reasons[] * @param reasons Pointer to array of reject reason codes for each parameter * @return TRUE if treatment parameters are in range, FALSE if not *************************************************************************/ @@ -418,9 +408,8 @@ * @brief * The checkTreatmentParamsDependencies function checks dependencies between * received treatment parameters. - * @details - * Inputs : stagedParams[] - * Outputs : reasons[] + * @details Inputs: stagedParams[] + * @details Outputs: reasons[] * @param reasons Pointer to array of reject reason codes for each parameter * @return TRUE if treatment parameter dependencies are ok, FALSE if not *************************************************************************/ @@ -472,9 +461,8 @@ * @brief * The isTreatmentParamInRange function determines whether a given treatment * parameter is in range. - * @details - * Inputs : treatParamsRanges[] - * Outputs : none + * @details Inputs: treatParamsRanges[] + * @details Outputs: none * @param param ID of parameter to check range for * @param value value of parameter to check range for * @return TRUE if given treatment parameter is in range, FALSE if not @@ -520,9 +508,8 @@ * 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 - * Outputs : stagedParams[] + * @details Inputs: none + * @details Outputs: stagedParams[] * @param payload message payload record containing received treatment parameters * @return none *************************************************************************/ @@ -537,9 +524,8 @@ * 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 - * Outputs : Response to treatment parameters message constructed and sent. + * @details Inputs: none + * @details Outputs: Response to treatment parameters message constructed and sent. * @param valid 1 if valid, 0 if not * @param reasons array of reject reason codes for each parameter (0=not rejected) * @return none @@ -557,9 +543,8 @@ * @brief * The setTreatmentParameterU32 function sets a given unsigned integer * treatment parameter to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set unsigned integer value for * @param value unsigned integer value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -588,9 +573,8 @@ * @brief * The setTreatmentParameterS32 function sets a given signed integer treatment * parameter to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set signed integer value for * @param value signed integer value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -619,9 +603,8 @@ * @brief * The setTreatmentParameterF32 sets a given floating point treatment parameter * to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set floating point value for * @param value floating point value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -650,9 +633,8 @@ * @brief * The getTreatmentParameterU32 function gets the value of a given unsigned * integer treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get unsigned integer value for * @return value of given unsigned integer treatment parameter *************************************************************************/ @@ -679,9 +661,8 @@ * @brief * The getTreatmentParameterS32 function gets the value of a given signed * integer treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get signed integer value for * @return value of given signed integer treatment parameter *************************************************************************/ @@ -708,9 +689,8 @@ * @brief * The getTreatmentParameterF32 function gets the value of a given floating point * treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get floating point value for * @return value of given floating point treatment parameter *************************************************************************/ @@ -743,9 +723,8 @@ * @brief * The testSetTreatmentParameterOverride function overrides the value of a * given treatment parameter. - * @details - * Inputs : none - * Outputs : treatment parameter set to given value + * @details Inputs: none + * @details Outputs: treatment parameter set to given value * @param param ID of treatment parameter to set value of * @param value value to set for given treatment parameter * @return TRUE if override successful, FALSE if not Index: firmware/App/Modes/OperationModes.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -68,9 +68,8 @@ /*********************************************************************//** * @brief * The initOperationModes function initializes the Operation Modes module. - * @details - * Inputs : none - * Outputs : Operation Modes module initialized. + * @details Inputs: none + * @details Outputs: Operation Modes module initialized. * @return none *************************************************************************/ void initOperationModes( void ) @@ -102,9 +101,8 @@ /*********************************************************************//** * @brief * The execOperationModes function executes the Operation Modes state machine. - * @details - * Inputs : none - * Outputs : currentMode is set by state machine. + * @details Inputs: none + * @details Outputs: currentMode is set by state machine. * @return none *************************************************************************/ void execOperationModes( void ) @@ -181,9 +179,8 @@ * The requestNewOperationMode function requests transition to a new * operation mode. The request will be arbitrated when the state machine * is next executed. - * @details - * Inputs : none - * Outputs : modeRequest[] + * @details Inputs: none + * @details Outputs: modeRequest[] * @return none *************************************************************************/ void requestNewOperationMode( HD_OP_MODE_T newMode ) @@ -203,9 +200,8 @@ /*********************************************************************//** * @brief * The getCurrentOperationMode function gets the current operation mode. - * @details - * Inputs : currentMode - * Outputs : none + * @details Inputs: currentMode + * @details Outputs: none * @return the current operation mode *************************************************************************/ HD_OP_MODE_T getCurrentOperationMode( void ) @@ -217,9 +213,8 @@ * @brief * The arbitrateModeRequest function arbitrates any pending mode transition * requests. - * @details - * Inputs : modeRequest[] - * Outputs : modeRequest[] is reset + * @details Inputs: modeRequest[] + * @details Outputs: modeRequest[] is reset * @return the next operation mode (current mode if no requests pending) *************************************************************************/ static HD_OP_MODE_T arbitrateModeRequest( void ) @@ -256,9 +251,8 @@ * @brief * The transitionToNewOperationMode function calls the transition to function * for a new operation mode that we are transitioning to. - * @details - * Inputs : none - * Outputs : transition function called for new mode + * @details Inputs: none + * @details Outputs: transition function called for new mode * @return none *************************************************************************/ static void transitionToNewOperationMode( HD_OP_MODE_T newMode ) @@ -300,9 +294,8 @@ * @brief * The broadcastOperationMode function sends the current operation mode at * the prescribed interval. - * @details - * Inputs : broadcastModeIntervalCtr - * Outputs : HD operation mode broadcast message sent. + * @details Inputs: broadcastModeIntervalCtr + * @details Outputs: HD operation mode broadcast message sent. * @return none *************************************************************************/ static void broadcastOperationMode( void ) Index: firmware/App/Modes/TreatmentStop.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -34,9 +34,8 @@ * @brief * The initTreatmentStop function initializes the Treatment Stop sub-mode * module. - * @details - * Inputs : none - * Outputs : Treatment Stop sub-mode module initialized. + * @details Inputs: none + * @details Outputs: Treatment Stop sub-mode module initialized. * @return none *************************************************************************/ void initTreatmentStop( void ) @@ -47,9 +46,8 @@ * @brief * The transitionToTreatmentStop function prepares for transition to treatment * stop sub-mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToTreatmentStop( void ) @@ -61,9 +59,8 @@ * @brief * The execTreatmentStop function executes the Treatment Stop sub-mode * state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void execTreatmentStop( void ) Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -191,9 +191,8 @@ /*********************************************************************//** * @brief * The initAlarmMgmt function initializes the AlarmMgmt module. - * @details - * Inputs : none - * Outputs : AlarmMgmt module initialized. + * @details Inputs: none + * @details Outputs: AlarmMgmt module initialized. * @return none *************************************************************************/ void initAlarmMgmt( void ) @@ -240,9 +239,8 @@ * The execAlarmMgmt function executes the alarm management functions to be * done periodically. The composite alarm state is updated, alarm lamp and * audio patterns are updated, and status is sent out to the rest of the system. - * @details - * Inputs : alarmStatusTable[], alarmTable[] - * Outputs : alarmStatus + * @details Inputs: alarmStatusTable[], alarmTable[] + * @details Outputs: alarmStatus * @return none *************************************************************************/ void execAlarmMgmt( void ) @@ -263,9 +261,8 @@ /*********************************************************************//** * @brief * The activateAlarm function activates a given alarm. - * @details - * Inputs : none - * Outputs : alarmIsActive[], alarmStartedAt[] + * @details Inputs: none + * @details Outputs: alarmIsActive[], alarmStartedAt[] * @param alarm ID of alarm to activate * @return none *************************************************************************/ @@ -302,9 +299,8 @@ * The activateAlarmNoData function activates a given alarm. Also, an alarm * message is broadcast to the rest of the system. This function will * include given data in the broadcast message for logging. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @return none *************************************************************************/ @@ -335,9 +331,8 @@ * The activateAlarm1Data function activates a given alarm. Also, an alarm * message is broadcast to the rest of the system. This function will * include given data in the broadcast message for logging. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @param alarmData supporting data to include in alarm msg * @return none @@ -369,9 +364,8 @@ * The activateAlarm2Data function activates a given alarm. Also, an alarm * message is broadcast to the rest of the system. This function will * include two given data in the broadcast message for logging. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @param alarmData1 supporting data to include in alarm msg * @param alarmData2 supporting data to include in alarm msg @@ -403,9 +397,8 @@ * @brief * The clearAlarm function clears a given alarm if it is recoverable. Also * an alarm message is broadcast to the rest of the system. - * @details - * Inputs : none - * Outputs : AlarmStatusTable[] + * @details Inputs: none + * @details Outputs: AlarmStatusTable[] * @param alarm ID of alarm to clear * @return none *************************************************************************/ @@ -452,9 +445,8 @@ * @brief * The isAlarmActive function determines whether a given alarm is currently * active. - * @details - * Inputs : alarmIsActive[] - * Outputs : none + * @details Inputs: alarmIsActive[] + * @details Outputs: none * @param alarm ID of alarm to check * @return TRUE if given alarm is active, FALSE if not *************************************************************************/ @@ -468,9 +460,8 @@ /*********************************************************************//** * @brief * The getAlarmStartTime function gets the active state of a given alarm. - * @details - * Inputs : alarmStartedAt[] - * Outputs : none + * @details Inputs: alarmStartedAt[] + * @details Outputs: none * @param alarmID ID of alarm to check * @return The start time stamp of given alarm ID *************************************************************************/ @@ -501,9 +492,8 @@ * @brief * The updateAlarmsState function updates the alarms state and alarm to * display. - * @details - * Inputs : alarmStatusTable[] - * Outputs : alarmPriorityFIFO[], alarmStatus + * @details Inputs: alarmStatusTable[] + * @details Outputs: alarmPriorityFIFO[], alarmStatus * @return none *************************************************************************/ static void updateAlarmsState( void ) @@ -540,9 +530,8 @@ * @brief * The setAlarmLampAndAudio function sets the alarm lamp and audio patterns * according to the current state of alarms. - * @details - * Inputs : none - * Outputs : Alarm lamp patter set according to current alarms status. + * @details Inputs: none + * @details Outputs: Alarm lamp patter set according to current alarms status. * @return none *************************************************************************/ static void setAlarmLampAndAudio( void ) @@ -621,9 +610,8 @@ /*********************************************************************//** * @brief * The updateAlarmsSilenceStatus function updates the alarms silence state. - * @details - * Inputs : alarmStatus - * Outputs : alarmStatus + * @details Inputs: alarmStatus + * @details Outputs: alarmStatus * @return none *************************************************************************/ static void updateAlarmsSilenceStatus( void ) @@ -657,9 +645,8 @@ /*********************************************************************//** * @brief * The handleAlarmEscalations function handles alarm escalation. - * @details - * Inputs : alarmIsActive[], alarmTable[] - * Outputs : alarm(s) escalated when appropriate + * @details Inputs: alarmIsActive[], alarmTable[] + * @details Outputs: alarm(s) escalated when appropriate * @return none *************************************************************************/ static void handleAlarmEscalations( void ) @@ -720,9 +707,8 @@ * @brief * The updateAlarmsFlags function updates the alarms flags of the alarms * status record. - * @details - * Inputs : none - * Outputs : alarmStatus + * @details Inputs: none + * @details Outputs: alarmStatus * @return none *************************************************************************/ static void updateAlarmsFlags( void ) @@ -775,9 +761,8 @@ * @brief * The resetAlarmPriorityFIFO function resets a FIFO for a given alarm * priority. - * @details - * Inputs : none - * Outputs : alarmPriorityFIFO[] + * @details Inputs: none + * @details Outputs: alarmPriorityFIFO[] * @param priority priority of FIFO to reset * @return none *************************************************************************/ @@ -798,9 +783,8 @@ * @brief * The getPublishAlarmStatusInterval function gets the alarm status * publication interval. - * @details - * Inputs : alarmStatusPublishInterval - * Outputs : none + * @details Inputs: alarmStatusPublishInterval + * @details Outputs: none * @return the current alarm status publication interval (in ms). *************************************************************************/ U32 getPublishAlarmStatusInterval( void ) @@ -825,9 +809,8 @@ * @brief * The testSetAlarmStatusPublishIntervalOverride function overrides the * alarm status publish interval. - * @details - * Inputs : none - * Outputs : alarmStatusPublishInterval + * @details Inputs: none + * @details Outputs: alarmStatusPublishInterval * @param value override blood flow data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -851,9 +834,8 @@ * @brief * The testResetAlarmStatusPublishIntervalOverride function resets the override * of the alarm status publish interval. - * @details - * Inputs : none - * Outputs : alarmStatusPublishInterval + * @details Inputs: none + * @details Outputs: alarmStatusPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetAlarmStatusPublishIntervalOverride( void ) @@ -875,9 +857,8 @@ * The testSetAlarmStateOverride function overrides the state of the * alarm active state for a given alarm with the alarm management with * a given active state. - * @details - * Inputs : none - * Outputs : alarm activated or cleared + * @details Inputs: none + * @details Outputs: alarm activated or cleared * @param alarmID ID of alarm to activate or clear * @param value override state for the given alarm ID (1=activate, 0=clear) * @return TRUE if override successful, FALSE if not @@ -909,9 +890,8 @@ * @brief * The testResetAlarmStateOverride function resets the override of the * state of the active state for a given alarm with the alarm management. - * @details - * Inputs : none - * Outputs : alarm cleared + * @details Inputs: none + * @details Outputs: alarm cleared * @param alarmID ID of alarm to clear * @return TRUE if alarm clear successful, FALSE if not *************************************************************************/ @@ -935,9 +915,8 @@ * @brief * The testSetAlarmStartOverride function overrides the start time * for a given alarm with the alarm management with a given start time. - * @details - * Inputs : none - * Outputs : alarmStartedAt[] + * @details Inputs: none + * @details Outputs: alarmStartedAt[] * @param alarmID ID of alarm to override start time for * @param value override time since start (in ms) for the given alarm ID * @return TRUE if override successful, FALSE if not @@ -968,9 +947,8 @@ * @brief * The testResetAlarmStartOverride function resets the override of the * start time for a given alarm with the alarm management. - * @details - * Inputs : none - * Outputs : alarmStartedAt[] + * @details Inputs: none + * @details Outputs: alarmStartedAt[] * @param alarmID ID of alarm to reset override of start time for * @return TRUE if override reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Services/CommBuffers.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -49,9 +49,8 @@ /*********************************************************************//** * @brief * The initCommBuffers function initializes the CommBuffers module. - * @details - * Inputs : none - * Outputs : CommBuffers module initialized. + * @details Inputs: none + * @details Outputs: CommBuffers module initialized. * @return none *************************************************************************/ void initCommBuffers( void ) @@ -70,9 +69,8 @@ * The clearBuffer function clears (empties) a given buffer. * Caller should ensure buffer won't be used while this function is clearing * the buffer. - * @details - * Inputs : none - * Outputs : given buffer is cleared. + * @details Inputs: none + * @details Outputs: given buffer is cleared. * @param buffer the buffer to clear * @return none *************************************************************************/ @@ -104,9 +102,8 @@ * This function will always add to the active double buffer. * This function should only be called from the background, general, or * priority tasks (BG or IRQ) for thread safety. - * @details - * Inputs : commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[] + * @details Inputs: commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: commBuffers[], commBufferByteCount[] * @param buffer which comm buffer to add data to * @param data pointer to byte array containing data to add * @param len length of data (in bytes) @@ -202,9 +199,8 @@ * rest of the requested data. * Only one function in one thread should be calling this function for a given * buffer. - * @details - * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[], * and the given data array is populated with data from the buffer. * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into @@ -262,9 +258,8 @@ * should be made before calling this function to determine how many bytes * are currently in the buffer. Do not call this function with a "len" * longer than what is currently in the buffer. - * @details - * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : given array populated with requested number of bytes from the buffer. + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: given array populated with requested number of bytes from the buffer. * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into * @param len number of bytes to retrieve into given data array. @@ -317,9 +312,8 @@ * The numberOfBytesInCommBuffer function determines how many bytes * are currently contained in a given comm buffer. Both double buffers * are considered for this. - * @details - * Inputs : activeDoubleBuffer[], commBufferByteCount[] - * Outputs : none + * @details Inputs: activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: none * @param buffer which comm buffer to get byte count for * @return the number of bytes in the given comm buffer. *************************************************************************/ @@ -349,9 +343,8 @@ * for the given buffer. * This function should only be called when the current inactive buffer has * been emptied. Any unconsumed data in inactive buffer will be lost. - * @details - * Inputs : activeDoubleBuffer[] - * Outputs : activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: activeDoubleBuffer[] + * @details Outputs: activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer to switch double buffers on * @return the new active buffer for the given buffer. *************************************************************************/ @@ -374,9 +367,8 @@ * The getDataFromInactiveBuffer function retrieves a given number of bytes * from the inactive buffer of a given buffer. This function should only be * called by getFromCommBuffer(). Params will be pre-validated there. - * @details - * Inputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[] - * Outputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer get data from * @param data pointer to byte array to populate with data * @param len number of bytes to get from comm buffer Index: firmware/App/Services/FPGA.c =================================================================== diff -u -ra35d5e68aad457339f625848809207a9650ad019 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/FPGA.c (.../FPGA.c) (revision a35d5e68aad457339f625848809207a9650ad019) +++ firmware/App/Services/FPGA.c (.../FPGA.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -288,9 +288,8 @@ /*********************************************************************//** * @brief * The initFPGA function initializes the FPGA module. - * @details - * Inputs : none - * Outputs : FPGA module initialized. + * @details Inputs: none + * @details Outputs: FPGA module initialized. * @return none *************************************************************************/ void initFPGA( void ) @@ -399,9 +398,8 @@ * @brief * The resetFPGACommFlags function resets the various fpga comm flags and * counters. - * @details - * Inputs : none - * Outputs : fpga comm flags & counters reset + * @details Inputs: none + * @details Outputs: fpga comm flags & counters reset * @return none *************************************************************************/ static void resetFPGACommFlags( void ) @@ -419,9 +417,8 @@ * @brief * The signalFPGAReceiptCompleted function increments a counter to indicate * that another DMA receipt from the FPGA has completed. - * @details - * Inputs : none - * Outputs : fpgaReceiptCounter + * @details Inputs: none + * @details Outputs: fpgaReceiptCounter * @return none *************************************************************************/ void signalFPGAReceiptCompleted( void ) @@ -454,9 +451,8 @@ * @brief * The signalFPGATransmitCompleted function increments a counter to indicate * that another DMA transmit to the FPGA has completed. - * @details - * Inputs : none - * Outputs : fpgaReceiptCounter + * @details Inputs: none + * @details Outputs: fpgaReceiptCounter * @return none *************************************************************************/ void signalFPGATransmitCompleted( void ) @@ -467,9 +463,8 @@ /*********************************************************************//** * @brief * The execFPGA function manages incoming data exchanges with the FPGA. - * @details - * Inputs : fpgaState - * Outputs : fpgaState + * @details Inputs: fpgaState + * @details Outputs: fpgaState * @return none *************************************************************************/ void execFPGAIn( void ) @@ -526,9 +521,8 @@ /*********************************************************************//** * @brief * The execFPGAOut function manages outgoing data exchanges with the FPGA. - * @details - * Inputs : fpgaState - * Outputs : fpgaState + * @details Inputs: fpgaState + * @details Outputs: fpgaState * @return none *************************************************************************/ void execFPGAOut( void ) @@ -573,9 +567,8 @@ * @brief * The handleFPGAReadHeaderState function handles the FPGA state where * the read header registers command is sent to the FPGA. - * @details - * Inputs : none - * Outputs : read command sent to FPGA + * @details Inputs: none + * @details Outputs: read command sent to FPGA * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReadHeaderState( void ) @@ -605,9 +598,8 @@ * @brief * The handleFPGAReceiveHeaderState function handles the FPGA state * where the header registers read response should be ready to take in. - * @details - * Inputs : none - * Outputs : header register values updated + * @details Inputs: none + * @details Outputs: header register values updated * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveHeaderState( void ) @@ -657,9 +649,8 @@ * @brief * The handleFPGAWriteAllActuatorsState function handles the FPGA state * where the bulk write command is sent to the FPGA. - * @details - * Inputs : actuator set points - * Outputs : actuator set points sent to FPGA + * @details Inputs: actuator set points + * @details Outputs: actuator set points sent to FPGA * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAWriteAllActuatorsState( void ) @@ -706,9 +697,8 @@ * @brief * The handleFPGAReceiveAllSensorsState function handles the FPGA state * where the bulk read response should be ready to parse. - * @details - * Inputs : none - * Outputs : sensor values updated + * @details Inputs: none + * @details Outputs: sensor values updated * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveAllSensorsState( void ) @@ -769,9 +759,8 @@ * @brief * The handleFPGAReadAllSensorsAsyncState function handles the FPGA state where * the read async sensors command is sent to the FPGA. - * @details - * Inputs : none - * Outputs : read async sensors command sent to FPGA + * @details Inputs: none + * @details Outputs: read async sensors command sent to FPGA * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReadAllSensorsAsyncState( void ) @@ -801,9 +790,8 @@ * @brief * The handleFPGAReceiveAllSensorsAsyncState function handles the FPGA state * where the bulk async read response should be ready to parse. - * @details - * Inputs : none - * Outputs : async sensor values updated + * @details Inputs: none + * @details Outputs: async sensor values updated * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveAllSensorsAsyncState( void ) @@ -853,9 +841,8 @@ /*********************************************************************//** * @brief * The execFPGATest function executes the FPGA self-test. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execFPGATest( void ) @@ -884,9 +871,8 @@ * @brief * The consumeUnexpectedData function checks to see if a byte is sitting in * the SCI2 received data register. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return fpgaDiag *************************************************************************/ static void consumeUnexpectedData( void ) @@ -904,9 +890,8 @@ * @brief * The setupDMAForWriteCmd function sets the byte count for the next DMA * write command to the FPGA. - * @details - * Inputs : none - * Outputs : number of bytes for next FPGA write command is set + * @details Inputs: none + * @details Outputs: number of bytes for next FPGA write command is set * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA * @return none *************************************************************************/ @@ -927,9 +912,8 @@ * @brief * The startDMAWriteCmd function initiates the DMA transmit for the next * DMA write command to the FPGA. - * @details - * Inputs : none - * Outputs : DMA write command to FPGA is initiated + * @details Inputs: none + * @details Outputs: DMA write command to FPGA is initiated * @return none *************************************************************************/ static void startDMAWriteCmd( void ) @@ -943,9 +927,8 @@ * @brief * The setupDMAForWriteResp function sets the expected byte count for the * next DMA write command response from the FPGA. - * @details - * Inputs : none - * Outputs : number of expected bytes for next FPGA write command response is set + * @details Inputs: none + * @details Outputs: number of expected bytes for next FPGA write command response is set * @param bytes2Receive number of bytes expected to be transmitted via DMA from the FPGA * @return none *************************************************************************/ @@ -966,9 +949,8 @@ * @brief * The startDMAReceiptOfWriteResp function initiates readiness of the DMA * receiver for the next DMA write command response from the FPGA. - * @details - * Inputs : none - * Outputs : DMA write command response is ready to be received from the FPGA + * @details Inputs: none + * @details Outputs: DMA write command response is ready to be received from the FPGA * @return none *************************************************************************/ static void startDMAReceiptOfWriteResp( void ) @@ -982,9 +964,8 @@ * @brief * The setupDMAForReadCmd function sets the byte count for the next DMA * read command to the FPGA. - * @details - * Inputs : none - * Outputs : number of bytes for next FPGA read command is set + * @details Inputs: none + * @details Outputs: number of bytes for next FPGA read command is set * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA * @return none *************************************************************************/ @@ -1005,9 +986,8 @@ * @brief * The startDMAReadCmd function initiates the DMA transmit for the next * DMA read command to the FPGA. - * @details - * Inputs : none - * Outputs : DMA read command to FPGA is initiated + * @details Inputs: none + * @details Outputs: DMA read command to FPGA is initiated * @return none *************************************************************************/ static void startDMAReadCmd( void ) @@ -1021,9 +1001,8 @@ * @brief * The setupDMAForReadResp function sets the expected byte count for the * next DMA read command response from the FPGA. - * @details - * Inputs : none - * Outputs : number of expected bytes for next FPGA read command response is set + * @details Inputs: none + * @details Outputs: number of expected bytes for next FPGA read command response is set * @param bytes2Receive number of expected bytes to be transmitted via DMA from the FPGA * @return none *************************************************************************/ @@ -1044,9 +1023,8 @@ * @brief * The startDMAReceiptOfReadResp function initiates readiness of the DMA * receiver for the next DMA read command response from the FPGA. - * @details - * Inputs : none - * Outputs : DMA read command response is ready to be received from the FPGA + * @details Inputs: none + * @details Outputs: DMA read command response is ready to be received from the FPGA * @return none *************************************************************************/ static void startDMAReceiptOfReadResp( void ) @@ -1059,9 +1037,8 @@ /*********************************************************************//** * @brief * The getFPGAVersions function gets the fpga version numbers. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return none *************************************************************************/ void getFPGAVersions( U08 *Id, U08 *Maj, U08 *Min, U08 *Lab ) @@ -1076,9 +1053,8 @@ * @brief * The getFPGABloodFlowSignalStrength function gets the latest blood flow * signal strength reading. - * @details - * Inputs : fpgaSensorReadings2 - * Outputs : none + * @details Inputs: fpgaSensorReadings2 + * @details Outputs: none * @return last blood flow signal strength reading *************************************************************************/ F32 getFPGABloodFlowSignalStrength( void ) @@ -1090,9 +1066,8 @@ * @brief * The getFPGADialysateFlowSignalStrength function gets the latest dialysate * flow signal strength reading. - * @details - * Inputs : fpgaSensorReadings2 - * Outputs : none + * @details Inputs: fpgaSensorReadings2 + * @details Outputs: none * @return last dialysate flow signal strength reading *************************************************************************/ F32 getFPGADialysateFlowSignalStrength( void ) @@ -1103,9 +1078,8 @@ /*********************************************************************//** * @brief * The getFPGABloodFlow function gets the latest blood flow reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last blood flow reading *************************************************************************/ F32 getFPGABloodFlow( void ) @@ -1116,9 +1090,8 @@ /*********************************************************************//** * @brief * The getFPGADialysateFlow function gets the latest dialysate flow reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate flow reading *************************************************************************/ F32 getFPGADialysateFlow( void ) @@ -1133,9 +1106,8 @@ * counting up, indicates motor is running in forward direction. If counter is * counting down, indicates motor is running in reverse direction. Counter will * wrap at 0/65535. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last blood pump hall sensor count reading. *************************************************************************/ U16 getFPGABloodPumpHallSensorCount( void ) @@ -1150,9 +1122,8 @@ * Bit 0 - Derived direction of the blood pump motor (0=Fwd, 1=Rev) * Bit 1 - A direction error was detected in the current hall sensor phase * Bit 2 - A direction error was detected since the last read of this register - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last blood pump hall sensor status reading. *************************************************************************/ U08 getFPGABloodPumpHallSensorStatus( void ) @@ -1167,9 +1138,8 @@ * counting up, indicates motor is running in forward direction. If counter is * counting down, indicates motor is running in reverse direction. Counter will * wrap at 0/65535. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate inlet pump hall sensor count reading. *************************************************************************/ U16 getFPGADialInPumpHallSensorCount( void ) @@ -1184,9 +1154,8 @@ * Bit 0 - Derived direction of the dialyste inlet pump motor (0=Fwd, 1=Rev) * Bit 1 - A direction error was detected in the current hall sensor phase * Bit 2 - A direction error was detected since the last read of this register - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate inlet pump hall sensor status reading. *************************************************************************/ U08 getFPGADialInPumpHallSensorStatus( void ) @@ -1201,9 +1170,8 @@ * counting up, indicates motor is running in forward direction. If counter is * counting down, indicates motor is running in reverse direction. Counter will * wrap at 0/65535. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate outlet pump hall sensor count reading. *************************************************************************/ U16 getFPGADialOutPumpHallSensorCount( void ) @@ -1218,9 +1186,8 @@ * Bit 0 - Derived direction of the dialysate outlet pump motor (0=Fwd, 1=Rev) * Bit 1 - A direction error was detected in the current hall sensor phase * Bit 2 - A direction error was detected since the last read of this register - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate outlet pump hall sensor status reading. *************************************************************************/ U08 getFPGADialOutPumpHallSensorStatus( void ) @@ -1231,9 +1198,8 @@ /*********************************************************************//** * @brief * The getFPGABloodPumpOcclusion function gets the latest blood occlusion reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last blood occlusion reading *************************************************************************/ U16 getFPGABloodPumpOcclusion( void ) @@ -1245,9 +1211,8 @@ * @brief * The getFPGADialInPumpOcclusion function gets the latest dialysate * inlet occlusion reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate inlet occlusion reading *************************************************************************/ U16 getFPGADialInPumpOcclusion( void ) @@ -1259,9 +1224,8 @@ * @brief * The getFPGADialOutPumpOcclusion function gets the latest dialysate * outlet occlusion reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last dialysate outlet occlusion reading *************************************************************************/ U16 getFPGADialOutPumpOcclusion( void ) @@ -1272,9 +1236,8 @@ /*********************************************************************//** * @brief * The getFPGAArterialPressure function gets the latest arterial pressure reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last arterial pressure reading *************************************************************************/ S32 getFPGAArterialPressure( void ) @@ -1285,9 +1248,8 @@ /*********************************************************************//** * @brief * The getFPGAVenousPressure function gets the venous arterial pressure reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last venous pressure reading *************************************************************************/ U16 getFPGAVenousPressure( void ) @@ -1300,9 +1262,8 @@ * @brief * The getFPGAAccelAxes function gets the accelerometer axis readings. * Axis readings are in ADC counts. 0.004 g per LSB. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param x Populate this param with X axis reading * @param y Populate this param with Y axis reading * @param z Populate this param with Z axis reading @@ -1320,9 +1281,8 @@ * The getFPGAAccelMaxes function gets the maximum accelerometer axis readings. * from last FPGA read (every 10ms). * Axis readings are in ADC counts. 0.004 g per LSB. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param x Populate this param with maximum X axis reading * @param y Populate this param with maximum Y axis reading * @param z Populate this param with maximum Z axis reading @@ -1339,9 +1299,8 @@ * @brief * The getFPGAAccelStatus function gets the accelerometer reading count * and error register values. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param cnt Populate this param with latest sample counter value * @param err Populate this param with latest error * @return none @@ -1356,9 +1315,8 @@ * @brief * The consumeUnexpectedData function checks to see if a byte is sitting in * the SCI2 received data register. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return fpgaDiag *************************************************************************/ void getFPGAAirTrapLevels( BOOL *airAtLower, BOOL *airAtUpper ) @@ -1374,9 +1332,8 @@ /*********************************************************************//** * @brief * The setFPGAValvesControlMode function sets the valves control mode. - * @details - * Inputs : fpgaActuatorSetPoints - * Outputs : fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param bits : The bits to enable the PID controller of a valve * @return none *************************************************************************/ @@ -1388,9 +1345,8 @@ /*********************************************************************//** * @brief * The getValvesStatus function reads the status of the valves - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return The status of the valves *************************************************************************/ U16 getFPGAValvesStatus( void ) @@ -1402,9 +1358,8 @@ * @brief * The setValveDialyzerInletPosition function sets the position of VDi \n * in counts - * @details - * Inputs : fpgaActuatorSetPoints - * Outputs : fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param setPoint : Next position of the valve in counts * @return none *************************************************************************/ @@ -1417,9 +1372,8 @@ * @brief * The getValveDialyzerInletPosition function reads the current position \n * of VDi in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current position of VDi *************************************************************************/ S16 getFPGAValveDialyzerInletPosition( void ) @@ -1431,9 +1385,8 @@ * @brief * The getFPGAValveDialyzerInletCurrentCounts function reads the current \n * of VDi in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current of VDi *************************************************************************/ U16 getFPGAValveDialyzerInletCurrentCounts( void ) @@ -1445,9 +1398,8 @@ /*********************************************************************//** * @brief * The setFPGAValveDialyzerInletPWM function sets the PWM of VDI in counts. - * @details - * Inputs: fpgaActuatorSetPoints - * Outputs: fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param count which is the PWM of VDI in counts * @return none *************************************************************************/ @@ -1460,9 +1412,8 @@ * @brief * The getFPGAValveDialyzerInletPWM function reads the current PWM target * of VDI. - * @details - * Inputs: fpgaSensorReadings - * Outputs: none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return current PWM of VDI *************************************************************************/ U16 getFPGAValveDialyzerInletPWM( void ) @@ -1475,9 +1426,8 @@ * @brief * The setValveDialyzerOutletPosition function sets the position of VDo \n * in counts - * @details - * Inputs : fpgaActuatorSetPoints - * Outputs : fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param setPoint : Next position of the valve in counts * @return none *************************************************************************/ @@ -1490,9 +1440,8 @@ * @brief * The getDialyzerOutletValvePosition function reads the current position \n * of VDo in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current position of VDo *************************************************************************/ S16 getFPGAValveDialyzerOutletPosition( void ) @@ -1504,9 +1453,8 @@ * @brief * The getFPGAValveDialyzerOutletCurrentCounts function reads the current \n * of VDo in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current of VDo *************************************************************************/ U16 getFPGAValveDialyzerOutletCurrentCounts( void ) @@ -1518,9 +1466,8 @@ /*********************************************************************//** * @brief * The setFPGAValveDialyzerOutletPWM function sets the PWM of VDO in counts. - * @details - * Inputs: fpgaActuatorSetPoints - * Outputs: fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param count which is the PWM of VDO in counts * @return none *************************************************************************/ @@ -1533,9 +1480,8 @@ * @brief * The getFPGAValveDialyzerOutletPWM function reads the current PWM target * of VDO. - * @details - * Inputs: fpgaSensorReadings - * Outputs: none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return current PWM of VDO *************************************************************************/ U16 getFPGAValveDialyzerOutletPWM( void ) @@ -1548,9 +1494,8 @@ * @brief * The setValveBloodVenousPosition function sets the position of VBV \n * in counts - * @details - * Inputs : fpgaActuatorSetPoints - * Outputs : fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param setPoint : Next position of the valve in counts * @return none *************************************************************************/ @@ -1563,9 +1508,8 @@ * @brief * The getValveBloodVenousPosition function reads the current position \n * of VBV in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current position of VBV *************************************************************************/ S16 getFPGAValveBloodVenousPosition( void ) @@ -1577,9 +1521,8 @@ * @brief * The getFPGAValveBloodVenousCurrentCounts function reads the current \n * of VBV in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current of VBV *************************************************************************/ U16 getFPGAValveBloodVenousCurrentCounts( void ) @@ -1591,9 +1534,8 @@ /*********************************************************************//** * @brief * The setFPGAValveBloodVenousPWM function sets the PWM of VBV in counts. - * @details - * Inputs: fpgaActuatorSetPoints - * Outputs: fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param count which is the PWM of VBV in counts * @return none *************************************************************************/ @@ -1605,9 +1547,8 @@ /*********************************************************************//** * @brief * The getFPGAValveBloodVenousPWM function returns the PWM of VBV in counts. - * @details - * Inputs: fpgaActuatorSetPoints - * Outputs: none + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: none * @return returns the PWM of VBV in counts *************************************************************************/ U16 getFPGAValveBloodVenousPWM( void ) @@ -1620,9 +1561,8 @@ * @brief * The setValveBloodArterialPosition function sets the position of VBA \n * in counts - * @details - * Inputs : fpgaActuatorSetPoints - * Outputs : fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param setPoint : Next position of the valve in counts * @return none *************************************************************************/ @@ -1635,9 +1575,8 @@ * @brief * The getValveBloodArterialPosition function reads the current position \n * of VBA in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current position of VBA *************************************************************************/ S16 getFPGAValveBloodArterialPosition( void ) @@ -1649,9 +1588,8 @@ * @brief * The getFPGAValveBloodArterialCurrentCounts function reads the current \n * of VBA in counts - * @details - * Inputs : none - * Outputs : fpgaSensorReadings + * @details Inputs: none + * @details Outputs: fpgaSensorReadings * @return The current of VBA *************************************************************************/ U16 getFPGAValveBloodArterialCurrentCounts( void ) @@ -1663,9 +1601,8 @@ /*********************************************************************//** * @brief * The setFPGAValveBloodArterialPWM function sets a PWM for VBA in counts. - * @details - * Inputs: fpgaActuatorSetPoints - * Outputs: fpgaActuatorSetPoints + * @details Inputs: fpgaActuatorSetPoints + * @details Outputs: fpgaActuatorSetPoints * @param count which is the PWM of VBA in counts * @return none *************************************************************************/ @@ -1678,9 +1615,8 @@ * @brief * The getFPGAValveBloodArterialPWM function returns the current PWM of * VBA in counts. - * @details - * Inputs: fpgaSensorReadings - * Outputs: none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return current PWM of VBA in counts *************************************************************************/ U16 getFPGAValveBloodArterialPWM( void ) Index: firmware/App/Services/Interrupts.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -71,9 +71,8 @@ /*********************************************************************//** * @brief * The initInterrupts function initializes the Interrupts module. - * @details - * Inputs : none - * Outputs : Interrupts module initialized. + * @details Inputs: none + * @details Outputs: Interrupts module initialized. * @return none *************************************************************************/ void initInterrupts( void ) @@ -89,9 +88,8 @@ /*********************************************************************//** * @brief * The phantomInterrupt function handles phantom interrupts. - * @details - * Inputs : none - * Outputs : phantom interrupt handled. + * @details Inputs: none + * @details Outputs: phantom interrupt handled. * @return none *************************************************************************/ void phantomInterrupt(void) @@ -111,9 +109,8 @@ /*********************************************************************//** * @brief * The rtiNotification function handles real-time interrupt notifications. - * @details - * Inputs : none - * Outputs : RTI notification handled. + * @details Inputs: none + * @details Outputs: RTI notification handled. * @param notification Which RTI timer caused this interrupt * @return none *************************************************************************/ @@ -146,9 +143,8 @@ /*********************************************************************//** * @brief * The canMessageNotification function handles CAN message notifications. - * @details - * Inputs : none - * Outputs : CAN message notification handled. + * @details Inputs: none + * @details Outputs: CAN message notification handled. * @param node which CAN controller * @param messageBox which message box triggered the message notification * @return none @@ -164,9 +160,8 @@ /*********************************************************************//** * @brief * The canErrorNotification function handles CAN error notifications. - * @details - * Inputs : none - * Outputs : CAN error notification handled. + * @details Inputs: none + * @details Outputs: CAN error notification handled. * @param node which CAN controller * @param notification canLEVEL_PASSIVE (0x20) : When RX- or TX error counter are between 32 and 63 * canLEVEL_WARNING (0x40) : When RX- or TX error counter are between 64 and 127 @@ -241,9 +236,8 @@ * @brief * The sciNotification function handles UART communication error interrupts. * Frame and Over-run errors are handled. - * @details - * Inputs : none - * Outputs : UART error interrupts handled. + * @details Inputs: none + * @details Outputs: UART error interrupts handled. * @param sci Pointer to the SCI peripheral that detected the error * @param flags error flag(s) * @return none @@ -312,9 +306,8 @@ /*********************************************************************//** * @brief * The dmaGroupANotification function handles communication DMA interrupts. - * @details - * Inputs : none - * Outputs : DMA interrupt is handled. + * @details Inputs: none + * @details Outputs: DMA interrupt is handled. * @param inttype type of DMA interrupt * @param channel DMA channel that caused the interrupt * @return none @@ -359,9 +352,8 @@ /*********************************************************************//** * @brief * The edgeNotification function handles rotor hall sensor interrupts. - * @details - * Inputs : none - * Outputs : Rotor hall sensor interrupt is handled according to pin associated with given edge. + * @details Inputs: none + * @details Outputs: Rotor hall sensor interrupt is handled according to pin associated with given edge. * @param hetREG HET controller associated with the edge * @param edge Which edge was detected * @return none Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -38,9 +38,8 @@ /*********************************************************************//** * @brief * The initMsgQueues function initializes the MsgQueues module. - * @details - * Inputs : none - * Outputs : msgQueueCounts[], msgQueueStarts[], msgQueueNexts[], msgQueues[][] + * @details Inputs: none + * @details Outputs: msgQueueCounts[], msgQueueStarts[], msgQueueNexts[], msgQueues[][] * @return none *************************************************************************/ void initMsgQueues( void ) @@ -64,9 +63,8 @@ * @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 + * @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 @@ -105,9 +103,8 @@ * @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 + * @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. @@ -146,9 +143,8 @@ /*********************************************************************//** * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. - * @details - * Inputs : msgQueueCounts[] - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ @@ -175,9 +171,8 @@ /*********************************************************************//** * @brief * The isMsgQueueFull function determines whether a given message queue is full. - * @details - * Inputs : msgQueueCounts[] - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ @@ -204,9 +199,8 @@ /*********************************************************************//** * @brief * The blankMessage function blanks a given message. - * @details - * Inputs : none - * Outputs : given message is blanked + * @details Inputs: none + * @details Outputs: given message is blanked * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -226,9 +220,8 @@ /*********************************************************************//** * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. - * @details - * Inputs : none - * Outputs : given wrapped message is blanked + * @details Inputs: none + * @details Outputs: given wrapped message is blanked * @param message Pointer to the message in a wrapper to blank * @return none *************************************************************************/ Index: firmware/App/Services/SystemComm.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -161,9 +161,8 @@ /*********************************************************************//** * @brief * The initSystemComm function initializes the SystemComm module. - * @details - * Inputs : none - * Outputs : SystemComm module initialized. + * @details Inputs: none + * @details Outputs: SystemComm module initialized. * @return none *************************************************************************/ void initSystemComm( void ) @@ -189,9 +188,8 @@ * @brief * The checkInFromDG function checks in the DG with the HD - indicating that * the DG is communicating. - * @details - * Inputs : none - * Outputs : dgIsCommunicating + * @details Inputs: none + * @details Outputs: dgIsCommunicating * @return none *************************************************************************/ void checkInFromDG( void ) @@ -204,9 +202,8 @@ * @brief * The checkInFromUI function checks in the UI with the HD - indicating that * the UI is communicating. - * @details - * Inputs : none - * Outputs : uiIsCommunicating + * @details Inputs: none + * @details Outputs: uiIsCommunicating * @return none *************************************************************************/ void checkInFromUI( void ) @@ -220,9 +217,8 @@ * @brief * The isDGCommunicating function determines whether the DG is communicating * with the HD. - * @details - * Inputs : dgIsCommunicating - * Outputs : none + * @details Inputs: dgIsCommunicating + * @details Outputs: none * @return TRUE if DG has checked in since last call, FALSE if not *************************************************************************/ BOOL isDGCommunicating( void ) @@ -234,9 +230,8 @@ * @brief * The isUICommunicating function determines whether the UI is communicating * with the HD. - * @details - * Inputs : uiIsCommunicating - * Outputs : none + * @details Inputs: uiIsCommunicating + * @details Outputs: none * @return TRUE if UI has checked in since last call, FALSE if not *************************************************************************/ BOOL isUICommunicating( void ) @@ -251,9 +246,8 @@ /*********************************************************************//** * @brief * The uiCommunicated function determines whether the UI has communicated. - * @details - * Inputs : uiDidCommunicate - * Outputs : none + * @details Inputs: uiDidCommunicate + * @details Outputs: none * @return TRUE if UI has communicated since power up, FALSE if not *************************************************************************/ BOOL uiCommunicated( void ) @@ -265,9 +259,8 @@ * @brief * The isHDOnlyCANNode function determines whether the HD is the only node * currently on the CAN bus. - * @details - * Inputs : hdIsOnlyCANNode - * Outputs : none + * @details Inputs: hdIsOnlyCANNode + * @details Outputs: none * @return TRUE if HD is only node on CAN bus, FALSE if not *************************************************************************/ BOOL isHDOnlyCANNode( void ) @@ -278,9 +271,8 @@ /*********************************************************************//** * @brief * The execSystemCommRx function manages received data from other sub-systems. - * @details - * Inputs : none - * Outputs : Incoming messages parsed and processed. + * @details Inputs: none + * @details Outputs: Incoming messages parsed and processed. * @return none *************************************************************************/ void execSystemCommRx( void ) @@ -302,9 +294,8 @@ * @brief * The execSystemCommTx function manages data to be transmitted to other * sub-systems. - * @details - * Inputs : none - * Outputs : Outgoing messages transmitted. + * @details Inputs: none + * @details Outputs: Outgoing messages transmitted. * @return none *************************************************************************/ void execSystemCommTx( void ) @@ -373,9 +364,8 @@ * This may have occurred because a CAN packet transmission has completed * or because a CAN packet has been received. The appropriate handler is * called. - * @details - * Inputs : none - * Outputs : message interrupt handled + * @details Inputs: none + * @details Outputs: message interrupt handled * @param srcCANBox which CAN message box triggered this interrupt * @return none *************************************************************************/ @@ -422,9 +412,8 @@ * @brief * The handleUARTMsgRecvPacketInterrupt function handles a DMA UART receive * packet completed interrupt. - * @details - * Inputs : none - * Outputs : UART received packet interrupt handled. + * @details Inputs: none + * @details Outputs: UART received packet interrupt handled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -443,9 +432,8 @@ * @brief * The handleUARTMsgXmitPacketInterrupt function handles a DMA UART transmit * packet completed interrupt. - * @details - * Inputs : none - * Outputs : UART transmit packet interrupt handled. + * @details Inputs: none + * @details Outputs: UART transmit packet interrupt handled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -464,9 +452,8 @@ * @brief * The initUARTAndDMA function initializes the SCI1 peripheral and the DMA * to go with it for PC communication. - * @details - * Inputs : none - * Outputs : SCI1 and DMA initialized + * @details Inputs: none + * @details Outputs: SCI1 and DMA initialized * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -530,9 +517,8 @@ * @brief * The isCANBoxForXmit function determines whether a given CAN message box * is configured for transmit. - * @details - * Inputs : CAN_OUT_BUFFERS[] - * Outputs : none + * @details Inputs: CAN_OUT_BUFFERS[] + * @details Outputs: none * @param srcCANBox which CAN message box to check * @return TRUE if the given CAN message box is configured for transmit, FALSE if not. *************************************************************************/ @@ -557,9 +543,8 @@ * @brief * The isCANBoxForRecv function determines whether a given CAN message box * is configured for receiving. - * @details - * Inputs : MSG_IN_BUFFERS[] - * Outputs : none + * @details Inputs: MSG_IN_BUFFERS[] + * @details Outputs: none * @param srcCANBox which CAN message box to check * @return TRUE if the given CAN message box is configured for receiving, FALSE if not. *************************************************************************/ @@ -583,9 +568,8 @@ /*********************************************************************//** * @brief * The clearCANXmitBuffers function clears all CAN transmit buffers. - * @details - * Inputs : CAN_OUT_BUFFERS[] - * Outputs : CAN transmit buffers cleared. + * @details Inputs: CAN_OUT_BUFFERS[] + * @details Outputs: CAN transmit buffers cleared. * @return none *************************************************************************/ static void clearCANXmitBuffers( void ) @@ -608,9 +592,8 @@ * @brief * The findNextHighestPriorityCANPacketToTransmit function gets the next * 8 byte packet and initiates a CAN transmit on the appropriate CAN channel. - * @details - * Inputs : Output CAN Comm Buffer(s) - * Outputs : none + * @details Inputs: Output CAN Comm Buffer(s) + * @details Outputs: none * @return buffer with highest priority CAN packet to transmit, * COMM_BUFFER_NOT_USED if not CAN packets pending transmit found *************************************************************************/ @@ -636,9 +619,8 @@ * @brief * The transmitNextCANPacket function gets the next 8 byte packet and initiates * a CAN transmit on the appropriate CAN channel. - * @details - * Inputs : Output CAN Comm Buffers - * Outputs : CAN packet transmit initiated. + * @details Inputs: Output CAN Comm Buffers + * @details Outputs: CAN packet transmit initiated. * @return number of bytes transmitted *************************************************************************/ static U32 transmitNextCANPacket( void ) @@ -686,9 +668,8 @@ * @brief * The transmitNextUARTPacket function sets up and initiates a DMA transmit * of the next packet pending transmit (if any) via UART. - * @details - * Inputs : Output UART Comm Buffer(s) - * Outputs : UART DMA transmit initiated. + * @details Inputs: Output UART Comm Buffer(s) + * @details Outputs: UART DMA transmit initiated. * @return number of bytes transmitted *************************************************************************/ #ifdef DEBUG_ENABLED @@ -725,9 +706,8 @@ * @brief * The processIncomingData function parses out messages from the Input * Comm Buffers and adds them to the Received Message Queue. - * @details - * Inputs : Input Comm Buffers - * Outputs : Parsed message(s) added to Received Message Queue + * @details Inputs: Input Comm Buffers + * @details Outputs: Parsed message(s) added to Received Message Queue * @return none *************************************************************************/ static void processIncomingData( void ) @@ -813,9 +793,8 @@ * @brief * The consumeBufferPaddingBeforeSync function removes any bytes in a given * buffer that lie before a sync byte. - * @details - * Inputs : none - * Outputs : Any padding at front of buffer is consumed. + * @details Inputs: none + * @details Outputs: Any padding at front of buffer is consumed. * @param buffer the comm buffer to process * @return none *************************************************************************/ @@ -844,9 +823,8 @@ * @brief * The parseMessageFromBuffer function looks for a complete message in a * given buffer. If a message is found, its size is returned. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param data pointer to byte array to search for a message * @param len number of bytes in the data to search * @return size of message if found, zero if no complete message found, @@ -896,9 +874,8 @@ * @brief * The processReceivedMessages function processes any messages in the * received message queues. - * @details - * Inputs : Received Message Queues - * Outputs : Message(s) processed. + * @details Inputs: Received Message Queues + * @details Outputs: Message(s) processed. * @return none *************************************************************************/ static void processReceivedMessages( void ) @@ -946,9 +923,8 @@ * @brief * The checkForCommTimeouts function checks for sub-system communication * timeout errors. - * @details - * Inputs : timeOfLastDGCheckIn, timeOfLastUICheckIn - * Outputs : possibly a comm t/o alarm + * @details Inputs: timeOfLastDGCheckIn, timeOfLastUICheckIn + * @details Outputs: possibly a comm t/o alarm * @return none *************************************************************************/ static void checkForCommTimeouts( void ) @@ -971,9 +947,8 @@ * The checkTooManyBadMsgCRCs function checks for too many bad message CRCs * within a set period of time. Assumed function is being called when a new * bad CRC is detected so a new bad CRC will be added to the list. - * @details - * Inputs : badCRCTimeStamps[], badCRCListIdx, badCRCListCount - * Outputs : possibly a "too many bad CRCs" alarm + * @details Inputs: badCRCTimeStamps[], badCRCListIdx, badCRCListCount + * @details Outputs: possibly a "too many bad CRCs" alarm * @return none *************************************************************************/ static void checkTooManyBadMsgCRCs( void ) @@ -998,9 +973,8 @@ * The addMsgToPendingACKList function adds a given message to the pending * ACK list. Messages in this list will require receipt of an ACK message * for this particular message within a limited time. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @param msg pointer to msg within the message data * @param msgData pointer to message data to add to pending ACK list * @param len number of bytes of message data @@ -1046,9 +1020,8 @@ * The matchACKtoPendingACKList function searches the pending ACK list to * see if the sequence # from a received ACK msg matches any. If found, * the list entry is removed. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @param seqNo sequence # to match to an entry in the list * @return TRUE if a match was found, FALSE if not *************************************************************************/ @@ -1076,9 +1049,8 @@ * The checkPendingACKList function searches the pending ACK list to * see if any have expired. Any such messages will be queued for retransmission * and if max retries reached a fault is triggered. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @return none *************************************************************************/ static void checkPendingACKList( void ) @@ -1112,9 +1084,8 @@ /*********************************************************************//** * @brief * The processReceivedMessage function processes a given message. - * @details - * Inputs : none - * Outputs : message processed + * @details Inputs: none + * @details Outputs: message processed * @param message pointer to message to process * @return none *************************************************************************/ Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r61153247029a9a246ca1beadc66d772e3e583e4e -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 61153247029a9a246ca1beadc66d772e3e583e4e) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -73,9 +73,8 @@ * bit of the sequence # is set if ACK is required per parameter. A sync byte * is inserted at the beginning of the message and an 8-bit CRC is appended to * the end of the message. The message is queued for transmission in the given buffer. - * @details - * Inputs : none - * Outputs : given data array populated with serialized message data and queued for transmit. + * @details Inputs: none + * @details Outputs: given data array populated with serialized message data and queued for transmit. * @param msg message to serialize * @param buffer outgoing buffer that message should be queued in * @param ackReq is an acknowledgement from receiver required? @@ -155,9 +154,8 @@ * @brief * The sendACKMsg function constructs and queues for transmit an ACK message * for a given received message. - * @details - * Inputs : none - * Outputs : ACK message queued for transmit on broadcast CAN channel. + * @details Inputs: none + * @details Outputs: ACK message queued for transmit on broadcast CAN channel. * @param message message to send an ACK for * @return TRUE if ACK message queued successfully, FALSE if not *************************************************************************/ @@ -186,9 +184,8 @@ * The sendTestAckResponseMsg function constructs a simple response * message for a handled test message and queues it for transmit on the * appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param buffer outgoing buffer that message should be queued in * @param ack TRUE if test message was handled successfully, FALSE if not @@ -219,9 +216,8 @@ * @brief * The sendOffButtonMsgToUI function constructs an off button msg to the UI * and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Off button msg constructed and queued. + * @details Inputs: none + * @details Outputs: Off button msg constructed and queued. * @param cmd 0=prompt user to confirm, 1=cancel prompt, 2=reject user off request * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -247,9 +243,8 @@ * The sendChangeUFSettingsResponse function constructs a UF change settings * response to the UI and queues the msg for transmit on the appropriate CAN * channel. - * @details - * Inputs : none - * Outputs : UF change settings response msg constructed and queued. + * @details Inputs: none + * @details Outputs: UF change settings response msg constructed and queued. * @param accepted T/F - are settings ok? * @param reason reason rejected (if not accepted) * @param volume_mL UF volume (in mL) @@ -298,9 +293,8 @@ * The sendChangeUFSettingsResponse function constructs a UF change settings * option response to the UI and queues the msg for transmit on the appropriate CAN * channel. - * @details - * Inputs : none - * Outputs : UF change settings option response msg constructed and queued. + * @details Inputs: none + * @details Outputs: UF change settings option response msg constructed and queued. * @param accepted T/F - are settings ok? * @param reason reason rejected (if not accepted) * @param volume_mL UF volume (in mL) @@ -340,9 +334,8 @@ * The sendChangeTreatmentDurationResponse function constructs a treatment * duration change response to the UI and queues the msg for transmit on the * appropriate CAN channel. - * @details - * Inputs : none - * Outputs : treatment duration change settings response msg constructed and queued. + * @details Inputs: none + * @details Outputs: treatment duration change settings response msg constructed and queued. * @param accepted T/F - are settings ok? * @param reason reason rejected (if not accepted) * @param time_min treatment duration (in minutes) @@ -379,9 +372,8 @@ * The sendChangeBloodDialysateRateChangeResponse function constructs a change * blood and dialysate rate settings response to the UI and queues the msg for * transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Blood & dialysate rate change response msg constructed and queued. + * @details Inputs: none + * @details Outputs: Blood & dialysate rate change response msg constructed and queued. * @param accepted T/F - are settings ok? * @param reason reason code for rejection or unused if accepted * @param bloodRate new blood flow rate @@ -417,9 +409,8 @@ * @brief * The sendTreatmentParamsRangesToUI function constructs a treatment parameter * ranges message to the UI and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Treatment parameter ranges msg constructed and queued. + * @details Inputs: none + * @details Outputs: Treatment parameter ranges msg constructed and queued. * @param minTime Minimum treatment duration (in minutes) * @param maxTime Maximum treatment duration (in minutes) * @param minUFVol Minimum ultrafiltration volume (in mL) @@ -461,9 +452,8 @@ * @brief * The sendDialysateTempTargetsToDG function constructs a dialysate temperature * set points message for DG and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Dialysate temperature set points msg constructed and queued. + * @details Inputs: none + * @details Outputs: Dialysate temperature set points msg constructed and queued. * @param primary temperature set point for primary heater * @param trimmer temperature set point for trimmer heater * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -493,9 +483,8 @@ * @brief * The sendDGSwitchReservoirCommand function constructs a DG set active * reservoir message for DG and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG set active reservoir msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG set active reservoir msg constructed and queued. * @param activeReservoir reservoir ID to set as active * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -522,9 +511,8 @@ * @brief * The sendDGFillCommand function constructs a DG fill command message * and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG fill command msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG fill command msg constructed and queued. * @param fillToVolumeMl volume (in mL) to fill inactive reservoir to * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -551,9 +539,8 @@ * @brief * The sendDGDrainCommand function constructs a DG drain command message * and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG drain command msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG drain command msg constructed and queued. * @param drainToVolumeMl volume (in mL) to drain the inactive reservoir to * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -580,9 +567,8 @@ * @brief * The sendDGStartStopCommand function constructs a DG start/stop command * message and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG start/stop command msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG start/stop command msg constructed and queued. * @param start TRUE indicates start DG, FALSE indicates stop DG * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -610,9 +596,8 @@ * The sendDGStartStopTrimmerHeaterCommand function constructs a DG start/stop * trimmer heater command message and queues the msg for transmit on the * appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG start/stop trimmer heater command msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG start/stop trimmer heater command msg constructed and queued. * @param start TRUE indicates start heater, FALSE indicates stop heater * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -639,9 +624,8 @@ * @brief * The sendDGSampleWaterCommand function constructs a DG sample water command * message and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG sample water command msg constructed and queued. + * @details Inputs: none + * @details Outputs: DG sample water command msg constructed and queued. * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ BOOL sendDGSampleWaterCommand( void ) @@ -664,9 +648,8 @@ * @brief * The broadcastAccelData function constructs an accelerometer data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : accelerometer data broadcast msg constructed and queued. + * @details Inputs: none + * @details Outputs: accelerometer data broadcast msg constructed and queued. * @param x X axis vector magnitude (in g) * @param y Y axis vector magnitude (in g) * @param z Z axis vector magnitude (in g) @@ -711,9 +694,8 @@ * @brief * The broadcastAlarmStatus function constructs an alarm status msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm status msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm status msg constructed and queued. * @param almStatus alarm status record * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -756,9 +738,8 @@ * @brief * The broadcastAlarmTriggered function constructs an alarm triggered msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm triggered msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm triggered msg constructed and queued. * @param alarm ID of alarm triggered * @param almData1 1st data associated with alarm * @param almData2 2nd data associated with alarm @@ -795,9 +776,8 @@ * @brief * The broadcastAlarmCleared function constructs an alarm cleared msg to be * broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm cleared msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm cleared msg constructed and queued. * @param alarm ID of alarm cleared * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -824,9 +804,8 @@ * @brief * The broadcastBloodFlowData function constructs a blood flow data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : blood flow data msg constructed and queued. + * @details Inputs: none + * @details Outputs: blood flow data msg constructed and queued. * @param flowStPt Current set point for blood flow * @param measFlow Latest measured blood flow * @param measRotorSpd Latest measured blood pump rotoro speed @@ -868,9 +847,8 @@ * @brief * The broadcastDialInFlowData function constructs a dialysate flow data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : dialysate flow data msg constructed and queued. + * @details Inputs: none + * @details Outputs: dialysate flow data msg constructed and queued. * @param flowStPt Current set point for dialysate flow * @param measFlow Latest measured dialysate flow * @param measRotorSpd Latest measured dialysate pump rotor speed @@ -912,9 +890,8 @@ * @brief * The broadcastDialInFlowData function constructs a dialysate outlet flow data * msg to be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : dialysate out flow data msg constructed and queued. + * @details Inputs: none + * @details Outputs: dialysate out flow data msg constructed and queued. * @param dialOutFlowData Pointer to the dialysate out flow data record * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -941,9 +918,8 @@ * @brief * The broadcastPresOcclData function constructs a pres/occl data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : pressure/occlusion data msg constructed and queued. + * @details Inputs: none + * @details Outputs: pressure/occlusion data msg constructed and queued. * @param artPres Latest measured arterial pressure * @param venPres Latest measured venous pressure * @param bpOccl Latest measured blood pump occlusion pressure @@ -981,9 +957,8 @@ * @brief * The broadcastRTCEpoch function constructs an epoch msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : RTC time and date in epoch + * @details Inputs: none + * @details Outputs: RTC time and date in epoch * @param epoch Current time and date in epoch * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -1010,9 +985,8 @@ * @brief * The broadcastTreatmentTime function constructs a treatment time msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : treatment time data msg constructed and queued + * @details Inputs: none + * @details Outputs: treatment time data msg constructed and queued * @param secsTotTreatment Total treatment time prescribed (in seconds) * @param secsElapsed Treatment time elapsed (in seconds) * @param secsRemaining Treatment time remaining (in seconds) @@ -1046,9 +1020,8 @@ * @brief * The broadcastTreatmentState function constructs a treatment state msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : treatment state msg constructed and queued + * @details Inputs: none + * @details Outputs: treatment state msg constructed and queued * @param subMode Current state (sub-mode) of treatment * @param uFState Current state of ultrafiltration * @param salineBolusState 1=saline bolus in progress, 0=not, 2=max bolus volume reached @@ -1082,9 +1055,8 @@ * @brief * The broadcastPowerOffWarning function constructs a power off warning msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : power off warning msg constructed and queued + * @details Inputs: none + * @details Outputs: power off warning msg constructed and queued * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ BOOL broadcastPowerOffWarning( void ) @@ -1107,9 +1079,8 @@ * @brief * The broadcastHDOperationMode function constructs an HD operation mode * broadcast message and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : HD operation mode msg constructed and queued + * @details Inputs: none + * @details Outputs: HD operation mode msg constructed and queued * @param mode current HD operation mode * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -1138,9 +1109,8 @@ * @brief * The broadcastHDValves function constructs an HD valves msg to \n * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : HD valves msg constructed and queued + * @details Inputs: none + * @details Outputs: HD valves msg constructed and queued * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ BOOL broadcastHDValves( HD_VALVE_DATA_T *valveData ) @@ -1166,9 +1136,8 @@ * @brief * The broadcastAirTrapData function constructs an HD air trap data msg to \n * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : air trap data msg constructed and queued + * @details Inputs: none + * @details Outputs: air trap data msg constructed and queued * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ BOOL broadcastAirTrapData( AIR_TRAP_LEVELS_T lowerLevel, AIR_TRAP_LEVELS_T upperLevel ) @@ -1222,9 +1191,8 @@ /*********************************************************************//** * @brief * The handleDGCheckIn function handles a check-in from the DG. - * @details - * Inputs : none - * Outputs : check in the DG with the SystemComm module. + * @details Inputs: none + * @details Outputs: check in the DG with the SystemComm module. * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1236,9 +1204,8 @@ /*********************************************************************//** * @brief * The handleUICheckIn function handles a check-in from the UI. - * @details - * Inputs : none - * Outputs : check in the UI with the SystemComm module. + * @details Inputs: none + * @details Outputs: check in the UI with the SystemComm module. * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1250,9 +1217,8 @@ /*********************************************************************//** * @brief * The handleAlarmTriggered function handles a triggered alarm event message. - * @details - * Inputs : none - * Outputs : alarm triggered. + * @details Inputs: none + * @details Outputs: alarm triggered. * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1284,9 +1250,8 @@ /*********************************************************************//** * @brief * The handleAlarmCleared function handles a cleared alarm event message. - * @details - * Inputs : none - * Outputs : alarm cleared. + * @details Inputs: none + * @details Outputs: alarm cleared. * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1310,9 +1275,8 @@ * @brief * The handleOffButtonConfirmMsgFromUI function handles a response to an * off button message to the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1331,9 +1295,8 @@ * @brief * The handleLoadCellReadingsFromDG function handles a load cell readings * broadcast message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1356,9 +1319,8 @@ * @brief * The handleDGTemperatureData function handles a temperature readings * broadcast message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1379,9 +1341,8 @@ * @brief * The handleROPumpData function handles an RO pump data broadcast * message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1401,9 +1362,8 @@ * @brief * The handleDrainPumpData function handles a drain pump broadcast * message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1423,9 +1383,8 @@ * @brief * The handleDGPressuresData function handles a DG pressure sensor readings * broadcast message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1445,9 +1404,8 @@ * @brief * The handleDGReservoirData function handles a reservoir data broadcast * message from the DG. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1467,9 +1425,8 @@ * @brief * The handleUFPauseResumeRequest function handles a ultrafiltration pause * or resume request message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1499,9 +1456,8 @@ * @brief * The handleUIStartTreatmentMsg function handles a treatment start/cancel * message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1537,9 +1493,8 @@ * The sendTreatmentStartResponseMsg function constructs a treatment start * request response message to the UI and queues the msg for transmit on * the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Treatment start response msg constructed and queued. + * @details Inputs: none + * @details Outputs: Treatment start response msg constructed and queued. * @param accepted T/F - request accepted? * @param reason reason code if rejected * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -1569,9 +1524,8 @@ * @brief * The handleUIUserEndTreatmentRequest function handles a treatment end * request message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1592,9 +1546,8 @@ * The sendTreatmentEndResponseMsg function constructs a treatment end * request response message to the UI and queues the msg for transmit on * the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Treatment end response msg constructed and queued. + * @details Inputs: none + * @details Outputs: Treatment end response msg constructed and queued. * @param accepted T/F - request accepted? * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -1621,9 +1574,8 @@ * @brief * The handleTreatmentParametersFromUI function handles a treatment parameters * set and validate request message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1647,9 +1599,8 @@ * @brief * The handleUIUserConfirmTreatmentParameters function handles a user confirmation * of treatment parameters message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1669,9 +1620,8 @@ * @brief * The sendTreatmentParametersResponseMsg function constructs a treatment parameters * response to the UI and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : Treatment parameters response msg constructed and queued. + * @details Inputs: none + * @details Outputs: Treatment parameters response msg constructed and queued. * @param accepted T/F - are settings ok? * @param rejectReasons reasons each parameter was rejected (if not accepted) * @param byteLength number of bytes that array of reject reasons takes @@ -1702,9 +1652,8 @@ * @brief * The handleChangeUFSettingsRequest function handles a ultrafiltration * change settings request message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1728,9 +1677,8 @@ * @brief * The handleChangeUFSettingsConfirmation function handles a ultrafiltration * change setting confirmation message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1754,9 +1702,8 @@ * @brief * The handleChangeTreatmentDurationRequest function handles a treatment * duration setting change message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1780,9 +1727,8 @@ * @brief * The handleChangeBloodDialysateRateChangeRequest function handles a blood * and dialysate rate settings change message from the UI. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1809,9 +1755,8 @@ /*********************************************************************//** * @brief * The handleDGOpMode function handles a DG broadcast of it's current mode. - * @details - * Inputs : none - * Outputs : message handled, response constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: message handled, response constructed and queued for transmit. * @param message a pointer to the message to handle. * @return none *************************************************************************/ @@ -1838,9 +1783,8 @@ /*********************************************************************//** * @brief * The handleFWVersionRequest function handles a request for HD f/w version. - * @details - * Inputs : none - * Outputs : message handled, response constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: message handled, response constructed and queued for transmit. * @param message a pointer to the message to handle. * @return none *************************************************************************/ @@ -1880,8 +1824,8 @@ * @brief * The sendDebugData function sends debug data out to the PC port. * @details - * Inputs : none - * Outputs : PC serial port + * @details Inputs: none + * @details Outputs: PC serial port * @param dbgData Pointer to debug data * @param len number of bytes of debug data * @return TRUE if debug data was successfully queued for transmit, FALSE if not @@ -1900,8 +1844,8 @@ * @brief * The sendDebugDataToUI function sends debug string to the UI for logging. * @details - * Inputs : none - * Outputs : Message constructed and queued for transmit + * @details Inputs: none + * @details Outputs: Message constructed and queued for transmit * @param str Pointer to debug string * @return none *************************************************************************/ @@ -1929,9 +1873,8 @@ * @brief * The isTestingActivated function determines whether a tester has successfully * logged in to activate testing functionality. - * @details - * Inputs : testerLoggedIn - * Outputs : none + * @details Inputs: testerLoggedIn + * @details Outputs: none * @return TRUE if a tester has logged in to activate testing, FALSE if not *************************************************************************/ BOOL isTestingActivated( void ) @@ -1944,9 +1887,8 @@ * The sendTestAckResponseMsg function constructs a simple response * message for a handled test message and queues it for transmit on the * appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param ack TRUE if test message was handled successfully, FALSE if not * @return TRUE if response message successfully queued for transmit, FALSE if not @@ -1972,9 +1914,8 @@ * @brief * The handleTesterLogInRequest function handles a request to login as a * tester. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1999,9 +1940,8 @@ * @brief * The handleTestOffButtonStateOverrideRequest function handles a request to * override the state of the off button. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2033,9 +1973,8 @@ * @brief * The handleTestStopButtonStateOverrideRequest function handles a request to * override the stop button state. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2066,9 +2005,8 @@ * @brief * The handleTestAlarmLampPatternOverrideRequest function handles a request to * override the alarm lamp pattern. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2099,9 +2037,8 @@ * @brief * The handleTestWatchdogCheckInStateOverrideRequest function handles a * request to override the check-in status of a given task. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2132,9 +2069,8 @@ * @brief * The handleTestAlarmStateOverrideRequest function handles a request to * override the active status of a given alarm. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2165,9 +2101,8 @@ * @brief * The handleTestAlarmTimeOverrideRequest function handles a request to * override the time since activation of a given alarm. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2198,9 +2133,8 @@ * @brief * The handleTestAlarmStatusBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for alarm status. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2231,9 +2165,8 @@ * @brief * The handleTestBloodFlowSetPointOverrideRequest function handles a request to * override the set point for the blood flow rate (mL/min). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2264,9 +2197,8 @@ * @brief * The handleTestBloodFlowMeasuredOverrideRequest function handles a request to * override the measured blood flow rate (mL/min). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2297,9 +2229,8 @@ * @brief * The handleTestBloodPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump rotor speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2330,9 +2261,8 @@ * @brief * The handleTestBloodPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2363,9 +2293,8 @@ * @brief * The handleTestBloodPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump motor controller speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2396,9 +2325,8 @@ * @brief * The handleTestBloodPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured blood pump motor controller current (mA). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2429,9 +2357,8 @@ * @brief * The handleTestBloodFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for blood flow data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2462,9 +2389,8 @@ * @brief * The handleTestDialInFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate inlet flow rate (mL/min). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2495,9 +2421,8 @@ * @brief * The handleTestDialOutFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate outlet flow rate (mL/min). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2528,9 +2453,8 @@ * @brief * The handleTestDialInFlowMeasuredOverrideRequest function handles a request to * override the measured dialysate inlet flow rate (mL/min). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2561,9 +2485,8 @@ * @brief * The handleTestDialInPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump rotor speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2594,9 +2517,8 @@ * @brief * The handleTestDialInPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2627,9 +2549,8 @@ * @brief * The handleTestDialInPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller speed (RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2660,9 +2581,8 @@ * @brief * The handleTestDialInPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller current (mA). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2693,9 +2613,8 @@ * @brief * The handleTestDialInFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for dialysate inlet flow data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2726,9 +2645,8 @@ * @brief * The handleTestArterialPressureOverrideRequest function handles a request to * override the arterial pressure. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2759,9 +2677,8 @@ * @brief * The handleTestVenousPressureOverrideRequest function handles a request to * override the venous pressure. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2792,9 +2709,8 @@ * @brief * The handleTestBloodPumpOcclusionOverrideRequest function handles a request to * override the blood pump occlusion sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2825,9 +2741,8 @@ * @brief * The handleTestDialysateInletPumpOcclusionOverrideRequest function handles a request to * override the dialysate inlet pump occlusion sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2858,9 +2773,8 @@ * @brief * The handleTestDialysateOutletPumpOcclusionOverrideRequest function handles a request to * override the dialysate outlet pump occlusion sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2891,9 +2805,8 @@ * @brief * The handleTestPresOcclBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for pressure/occlusion data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2924,9 +2837,8 @@ * @brief * The handleSetRTCTimestamp function handles a request to write time and * date to RTC - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2955,9 +2867,8 @@ * @brief * The handleTestDialOutFlowBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for dialysate outlet pump data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -2989,9 +2900,8 @@ * The handleTestDialOutUFReferenceVolumeOverrideRequest function handles a * request to override the ultrafiltration reference volume for the dialysate * outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3023,9 +2933,8 @@ * The handleTestDialOutUFMeasuredVolumeOverrideRequest function handles a * request to override the ultrafiltration measured volume for the dialysate * outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3057,9 +2966,8 @@ * The handleTestDialOutPumpMCMeasuredSpeedOverrideRequest function handles a * request to override the measured motor controller speed for the dialysate * outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3091,9 +2999,8 @@ * The handleTestDialOutPumpMCMeasuredCurrentOverrideRequest function handles a * request to override the measured motor controller current for the dialysate * outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3124,9 +3031,8 @@ * @brief * The handleTestDialOutPumpMeasuredSpeedOverrideRequest function handles a * request to override the measured speed for the dialysate outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3157,9 +3063,8 @@ * @brief * The handleTestDialOutPumpMeasuredRotorSpeedOverrideRequest function handles a * request to override the measured rotor speed for the dialysate outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3190,9 +3095,8 @@ * @brief * The handleTestDialOutLoadCellWeightOverrideRequest function handles a * request to override the measured load cell weight for the dialysate outlet pump. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3223,9 +3127,8 @@ * @brief * The handleTestHDSafetyShutdownOverrideRequest function handles a * request to override the safety shutdown signal. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3256,9 +3159,8 @@ * @brief * The handleTestHDAccelOverrideRequest function handles a request to * override the measured accelerometer sensor readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3289,9 +3191,8 @@ * @brief * The handleTestHDAccelMaxOverrideRequest function handles a request to * override the measured accelerometer sensor maximum readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3322,9 +3223,8 @@ * @brief * The handleTestHDAccelBroadcastIntervalOverrideRequest function handles a * request to override the broadcast interval for accelerometer data messages. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3355,9 +3255,8 @@ * @brief * The handleSetAccelCalibration function handles a request to set * accelerometer calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3382,9 +3281,8 @@ * @brief * The handleSetBloodFlowCalibration function handles a request to set * blood flow calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3409,9 +3307,8 @@ * @brief * The handleSetDialysateFlowCalibration function handles a request to set * dialysate flow calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3436,9 +3333,8 @@ * @brief * The handleSetDialysateFlowCalibration function handles a request to set * dialysate flow calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3462,9 +3358,8 @@ /************************************************************************* * @brief * The handleHomeHDValve function handles a request to home an HD valve - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ @@ -3491,9 +3386,8 @@ * @brief * The handleTestHDValvesBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for HD valves data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3524,9 +3418,8 @@ * @brief * The handleSetBloodValve function handles a request to set the HD air * (blood) trap valve to open or close - * @details - * Inputs: none - * Outputs: message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -3552,9 +3445,8 @@ * @brief * The handleSetHDValvePositionOverrideRequest function handles a request to * override the position of a valve - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ @@ -3585,9 +3477,8 @@ * @brief * The handleSetHDValvePWMOverrideRequest function handles a request to * override the PWM of a valve - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ @@ -3618,9 +3509,8 @@ * @brief * The handleSetAirTrapBroadcastIntervalOverrideRequest function handles a * request to override the air trap data broadcast interval. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ @@ -3651,9 +3541,8 @@ * @brief * The handleSetAirTrapLevelSensorOverrideRequest function handles a request to * override an air trap level sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ @@ -3684,9 +3573,8 @@ * @brief * The handleSetAirTrapLevelSensorOverrideRequest function handles a request to * override an air trap level sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message : a pointer to the message to handle * @return none *************************************************************************/ Index: firmware/App/Services/WatchdogMgmt.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -62,9 +62,8 @@ /*********************************************************************//** * @brief * The initWatchdogMgmt function initializes the watchdog mgmt. module. - * @details - * Inputs : none - * Outputs : Watchdog mgmt. module initialized. + * @details Inputs: none + * @details Outputs: Watchdog mgmt. module initialized. * @return none *************************************************************************/ void initWatchdogMgmt( void ) @@ -88,9 +87,8 @@ /*********************************************************************//** * @brief * The execWatchdogMgmt function executes thewatchdog mgmt. service. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : watchdogTaskCheckedIn[] + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: watchdogTaskCheckedIn[] * @return none *************************************************************************/ void execWatchdogMgmt( void ) @@ -133,9 +131,8 @@ * @brief * The checkInWithWatchdogMgmt function checks a given task in with the * watchdog mgmt. service. - * @details - * Inputs : none - * Outputs : task is checked in with the watchdog mgmt.. + * @details Inputs: none + * @details Outputs: task is checked in with the watchdog mgmt.. * @param task the task that is checking in with the watchdog mgmt * @return none *************************************************************************/ @@ -152,9 +149,8 @@ * The execWatchdogTest function executes the watchdog test. * This function should be called periodically until a pass or fail * result is returned. - * @details - * Inputs : watchdogSelfTestState - * Outputs : watchdogSelfTestState + * @details Inputs: watchdogSelfTestState + * @details Outputs: watchdogSelfTestState * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execWatchdogTest( void ) @@ -212,9 +208,8 @@ /*********************************************************************//** * @brief * The resetWDTaskCheckIns function resets the task check-ins with the watchdog. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] array reset to all false. + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] array reset to all false. * @return none *************************************************************************/ static void resetWDTaskCheckIns( void ) @@ -232,9 +227,8 @@ * @brief * The haveAllTasksCheckedIn function determines whether all tasks have * checked in with watchdog mgmt. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : none + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: none * @return TRUE if all tasks have checked in since last watchdog pet, FALSE if not. *************************************************************************/ static BOOL haveAllTasksCheckedIn( void ) @@ -259,9 +253,8 @@ * @brief * The hasTaskGeneralCheckedIn function gets the check-in state of a given * task. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : none + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: none * @param task ID of task to check * @return TRUE if given task has checked in, FALSE if not *************************************************************************/ @@ -292,9 +285,8 @@ * @brief * The petWatchdog function pets the watchdog by pulsing the CPLD WD pet * signal. - * @details - * Inputs : none - * Outputs : CPLD WD pet signal is pulsed + * @details Inputs: none + * @details Outputs: CPLD WD pet signal is pulsed * @return none *************************************************************************/ static void petWatchdog( void ) @@ -318,9 +310,8 @@ * @brief * The testSetWatchdogTaskCheckInOverride function overrides the state of the * task check-in with the watchdog management with a given check-in state. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] * @param task ID of task to override check-in state for * @param value override state for the given task ID * @return TRUE if override successful, FALSE if not @@ -346,9 +337,8 @@ * @brief * The testResetWatchdogTaskCheckInOverride function resets the override of the * state of the check-in with the watchdog management. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] * @param task ID of task to override check-in state for * @return TRUE if override reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Tasks/TaskBG.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -42,9 +42,8 @@ * @brief * The taskBackground function handles the idle Background Task loop. * Calls the Watchdog Mgmt. and NonVolatile Data services. - * @details - * Inputs : none - * Outputs : Executive for watchdog mgmt. and non-volatile data services called. + * @details Inputs: none + * @details Outputs: Executive for watchdog mgmt. and non-volatile data services called. * @return none *************************************************************************/ void taskBackground( void ) Index: firmware/App/Tasks/TaskGeneral.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -47,9 +47,8 @@ * The taskGeneral function handles the scheduled General Task interrupt. * Calls the executive functions for most monitors and controllers, the * operation modes, the system communications, and alarms. - * @details - * Inputs : none - * Outputs : Executive for the TBD called. + * @details Inputs: none + * @details Outputs: Executive for the TBD called. * @return none *************************************************************************/ void taskGeneral( void ) Index: firmware/App/Tasks/TaskPriority.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -38,9 +38,8 @@ * @brief * The taskPriority function handles the scheduled Priority Task interrupt. * Calls the executive functions for FPGA, pumps, valves, and buttons. - * @details - * Inputs : none - * Outputs : Executive for the FPGA, pumps, valves, and buttons called. + * @details Inputs: none + * @details Outputs: Executive for the FPGA, pumps, valves, and buttons called. * @return none *************************************************************************/ void taskPriority( void ) Index: firmware/App/Tasks/TaskTimer.c =================================================================== diff -u -rd91a24c730aeb5cd7e3eba9ef4eca78e442911f8 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision d91a24c730aeb5cd7e3eba9ef4eca78e442911f8) +++ firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -30,9 +30,8 @@ * The taskTimer function handles the scheduled Timer Task interrupt. * Calls the Timers executive to maintain a 1ms timer counter to * support timer and timeout functions. - * @details - * Inputs : none - * Outputs : Executive for Timers called. + * @details Inputs: none + * @details Outputs: Executive for Timers called. * @return none *************************************************************************/ void taskTimer( void ) Index: firmware/source/sys_main.c =================================================================== diff -u -ra35d5e68aad457339f625848809207a9650ad019 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/source/sys_main.c (.../sys_main.c) (revision a35d5e68aad457339f625848809207a9650ad019) +++ firmware/source/sys_main.c (.../sys_main.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -129,9 +129,8 @@ * @brief initProcessor * The initProcessor function initializes and configures the processor \n * peripherals. - * @details - * Inputs : none - * Outputs : Processor peripherals initialized and configured. + * @details Inputs: none + * @details Outputs: Processor peripherals initialized and configured. * @return none *************************************************************************/ static void initProcessor( void ) @@ -157,9 +156,8 @@ /************************************************************************* * @brief initSoftware * The initSoftware function calls all software module initialize functions. - * @details - * Inputs : none - * Outputs : All modules initialized. + * @details Inputs: none + * @details Outputs: All modules initialized. * @return none *************************************************************************/ static void initSoftware( void ) @@ -200,9 +198,8 @@ /************************************************************************* * @brief initHardware * The initHardware function initializes and configures external hardware. - * @details - * Inputs : none - * Outputs : External hardware initialized and configured. + * @details Inputs: none + * @details Outputs: External hardware initialized and configured. * @return none *************************************************************************/ static void initHardware( void ) @@ -212,9 +209,8 @@ /************************************************************************* * @brief initTasks * The initTasks function sets up and starts the scheduled tasks. - * @details - * Inputs : none - * Outputs : Scheduled tasks set up and started. + * @details Inputs: none + * @details Outputs: Scheduled tasks set up and started. * @return none *************************************************************************/ static void initTasks( void )