Index: firmware/App/Controllers/AlarmLamp.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/AlarmLamp.c (.../AlarmLamp.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/AlarmLamp.c (.../AlarmLamp.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -21,43 +21,54 @@ #include "Timers.h" #include "AlarmLamp.h" -// ********** private definitions ********** - +/** + * @addtogroup AlarmLamp + * @{ + */ + +// ********** private definitions ********** + +#define NUM_OF_ALARM_LAMP_PATTERN_SEQUENCE_STEPS 2 ///< Number of steps in an alarm lamp pattern sequence. + +/// Enumeration of alarm lamp color states. typedef enum LampStates { - LAMP_STATE_OFF = 0, - LAMP_STATE_ON, - NUM_OF_LAMP_STATES + LAMP_STATE_OFF = 0, ///< Alarm lamp color (R, G, or B) is off. + LAMP_STATE_ON, ///< Alarm lamp color (R, G, or B) is on. + NUM_OF_LAMP_STATES ///< Number of alarm lamp color states. } LAMP_STATE_T; -// Lamp Pattern Record +/// Alarm lamp pattern record struct LampPatterns { - U32 duration[NUM_OF_LAMP_STATES ]; // in ms - LAMP_STATE_T green[ NUM_OF_LAMP_STATES ]; // green lamp state 1 and 2 - LAMP_STATE_T blue[ NUM_OF_LAMP_STATES ]; // blue lamp state 1 and 2 - LAMP_STATE_T red[ NUM_OF_LAMP_STATES ]; // red lamp state 1 and 2 + U32 duration[ NUM_OF_ALARM_LAMP_PATTERN_SEQUENCE_STEPS ]; ///< Duration (in ms) of the 2 step alarm lamp pattern sequence. + LAMP_STATE_T green[ NUM_OF_ALARM_LAMP_PATTERN_SEQUENCE_STEPS ]; ///< Lamp color state of the 2 step alarm lamp pattern sequence for green. + LAMP_STATE_T blue[ NUM_OF_ALARM_LAMP_PATTERN_SEQUENCE_STEPS ]; ///< Lamp color state of the 2 step alarm lamp pattern sequence for blue. + LAMP_STATE_T red[ NUM_OF_ALARM_LAMP_PATTERN_SEQUENCE_STEPS ]; ///< Lamp color state of the 2 step alarm lamp pattern sequence for red. }; - + +/// Enumeration of alarm lamp self test states. typedef enum Alarm_Lamp_Self_Test_States { - ALARM_LAMP_SELF_TEST_STATE_START = 0, - ALARM_LAMP_SELF_TEST_STATE_RED, - ALARM_LAMP_SELF_TEST_STATE_YELLOW, - ALARM_LAMP_SELF_TEST_STATE_GREEN, - ALARM_LAMP_SELF_TEST_STATE_COMPLETE, - NUM_OF_ALARM_LAMP_SELF_TEST_STATES + ALARM_LAMP_SELF_TEST_STATE_START = 0, ///< Start state of alarm lamp self test. + ALARM_LAMP_SELF_TEST_STATE_RED, ///< Red state of alarm lamp self test. + ALARM_LAMP_SELF_TEST_STATE_YELLOW, ///< Yellow state of alarm lamp self test. + ALARM_LAMP_SELF_TEST_STATE_GREEN, ///< Green state of alarm lamp self test. + ALARM_LAMP_SELF_TEST_STATE_COMPLETE, ///< Completed state of alarm lamp self test. + NUM_OF_ALARM_LAMP_SELF_TEST_STATES ///< Number of states in alarm lamp self test. } ALARM_LAMP_SELF_TEST_STATE_T; -#define POST_LAMP_STEP_TIME_MS 1000 // ms for each lamp color +#define POST_LAMP_STEP_TIME_MS 1000 ///< Duration (in ms) for each alarm lamp self test step. // ********** private data ********** - -DATA_DECL( LAMP_PATTERN_T, LampPattern, currentLampPattern, LAMP_PATTERN_MANUAL, LAMP_PATTERN_FAULT ); -static LAMP_PATTERN_T pendingLampPattern = LAMP_PATTERN_MANUAL; -static U32 currentLampPatternStep = 0; -static U32 lampPatternStepTimer = 0; - + +/// Current alarm lamp pattern (overrideable). +static OVERRIDE_U32_T currentLampPattern = { LAMP_PATTERN_MANUAL, LAMP_PATTERN_FAULT, LAMP_PATTERN_FAULT, 0 }; +static LAMP_PATTERN_T pendingLampPattern = LAMP_PATTERN_MANUAL; ///< Pending alarm lamp pattern. +static U32 currentLampPatternStep = 0; ///< Current alarm lamp pattern step. +static U32 lampPatternStepTimer = 0; ///< Timer counter for current alarm lamp pattern step. + +/// Two step alarm lamp patterns (repeating). const struct LampPatterns lampPatterns[ NUM_OF_LAMP_PATTERNS ] = { { { 500, 500 }, { LAMP_STATE_OFF, LAMP_STATE_OFF }, { LAMP_STATE_OFF, LAMP_STATE_OFF }, { LAMP_STATE_OFF, LAMP_STATE_OFF } }, // LAMP_PATTERN_OFF { { 500, 500 }, { LAMP_STATE_ON, LAMP_STATE_ON }, { LAMP_STATE_OFF, LAMP_STATE_OFF }, { LAMP_STATE_OFF, LAMP_STATE_OFF } }, // LAMP_PATTERN_OK @@ -68,15 +79,15 @@ { { 0, 0 }, { LAMP_STATE_OFF, LAMP_STATE_OFF }, { LAMP_STATE_OFF, LAMP_STATE_OFF }, { LAMP_STATE_OFF, LAMP_STATE_OFF } } // LAMP_PATTERN_MANUAL }; -static ALARM_LAMP_SELF_TEST_STATE_T alarmLampSelfTestState = ALARM_LAMP_SELF_TEST_STATE_START; -static U32 alarmLampSelfTestStepTimerCount = 0; +static ALARM_LAMP_SELF_TEST_STATE_T alarmLampSelfTestState = ALARM_LAMP_SELF_TEST_STATE_START; ///< Current alarm lamp self test state. +static U32 alarmLampSelfTestStepTimerCount = 0; ///< timer counter for current alarm lamp self test state. // ********** private function prototypes ********** static void setAlarmLampToPatternStep( void ); -/************************************************************************* - * @brief initAlarmLamp +/*********************************************************************//** + * @brief * The initAlarmLamp function initializes the AlarmLamp module. * @details * Inputs : none @@ -93,14 +104,14 @@ alarmLampSelfTestStepTimerCount = 0; } -/************************************************************************* - * @brief execAlarmLamp - * The execAlarmLamp function executes the alarm lamp service for the \n +/*********************************************************************//** + * @brief + * The execAlarmLamp function executes the alarm lamp service for the * current lamp pattern. * @details - * Inputs : pendingLampPattern, currentLampPattern, lampPatternStepTimer, \n + * Inputs : pendingLampPattern, currentLampPattern, lampPatternStepTimer, * lampPatterns. - * Outputs : + * Outputs : currentLampPattern * @return none *************************************************************************/ void execAlarmLamp( void ) @@ -137,8 +148,8 @@ } } -/************************************************************************* - * @brief requestAlarmLampPattern +/*********************************************************************//** + * @brief * The requestAlarmLampPattern function sets a request for a new lamp pattern. * @details * Inputs : none @@ -158,25 +169,35 @@ } } -/************************************************************************* - * @brief getCurrentAlarmLampPattern - * The getCurrentAlarmLampPattern function gets the current alarm lamp \n +/*********************************************************************//** + * @brief + * The getCurrentAlarmLampPattern function gets the current alarm lamp * pattern in effect. * @details * Inputs : currentLampPattern * Outputs : none * @return currentLampPattern *************************************************************************/ -DATA_GET( LAMP_PATTERN_T, getCurrentAlarmLampPattern, currentLampPattern ) +LAMP_PATTERN_T getCurrentAlarmLampPattern( void ) +{ + LAMP_PATTERN_T result = (LAMP_PATTERN_T)currentLampPattern.data; + + if ( OVERRIDE_KEY == currentLampPattern.override ) + { + result = (LAMP_PATTERN_T)currentLampPattern.ovData; + } + + return result; +} -/************************************************************************* - * @brief execAlarmLampTest - * The execAlarmLampTest function executes the alarm lamp test. \n - * This function should be called periodically until a pass or fail \n +/*********************************************************************//** + * @brief + * The execAlarmLampTest function executes the alarm lamp test. + * This function should be called periodically until a pass or fail * result is returned. * @details - * Inputs : - * Outputs : + * Inputs : alarmLampSelfTestState, alarmLampSelfTestStepTimerCount + * Outputs : alarmLampSelfTestState, alarmLampSelfTestStepTimerCount * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execAlarmLampTest( void ) @@ -233,14 +254,13 @@ return result; } -/************************************************************************* - * @brief setAlarmLampToPatternStep - * The setAlarmLampToPatternStep function sets the lamps according to the \n +/*********************************************************************//** + * @brief + * The setAlarmLampToPatternStep function sets the lamps according to the * current lamp pattern and lamp pattern step. * @details - * Inputs : none + * Inputs : lampPatterns[], currentLampPatternStep * Outputs : lampPatternStepTimer reset. Lamps set per current pattern. - * @param lampPattern new lamp pattern * @return none *************************************************************************/ static void setAlarmLampToPatternStep( void ) @@ -276,17 +296,51 @@ *************************************************************************/ -/************************************************************************* - * @brief testSetCurrentLampPatternOverride and testResetCurrentLampPatternOverride - * The testSetCurrentLampPatternOverride function overrides the state of the \n - * current alarm lamp pattern with a given pattern. \n - * The testResetCurrentLampPatternOverride function resets the override of the \n - * state of the alarm lamp pattern. +/*********************************************************************//** + * @brief + * The testSetCurrentLampPatternOverride function overrides the state of the + * current alarm lamp pattern with a given pattern. * @details * Inputs : none * Outputs : currentLampPattern * @param value override state for the alarm lamp pattern * @return TRUE if override successful, FALSE if not *************************************************************************/ -DATA_OVERRIDE_FUNC( LAMP_PATTERN_T, testSetCurrentLampPatternOverride, testResetCurrentLampPatternOverride, currentLampPattern ) - +BOOL testSetCurrentLampPatternOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + currentLampPattern.ovData = value; + currentLampPattern.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetCurrentLampPatternOverride function resets the override of the + * state of the alarm lamp pattern. + * @details + * Inputs : none + * Outputs : currentLampPattern + * @return TRUE if override reset successful, FALSE if not + *************************************************************************/ +BOOL testResetCurrentLampPatternOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + currentLampPattern.override = OVERRIDE_RESET; + currentLampPattern.ovData = currentLampPattern.ovInitData; + } + + return result; +} + +/**@}*/ Index: firmware/App/Controllers/AlarmLamp.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/AlarmLamp.h (.../AlarmLamp.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/AlarmLamp.h (.../AlarmLamp.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -20,18 +20,27 @@ #include "HDCommon.h" +/** + * @defgroup AlarmLamp AlarmLamp + * @brief The Alarm Lamp module manages the state of the alarm lamp. + * + * @addtogroup AlarmLamp + * @{ + */ + // ********** public definitions ********** - + +/// Enumeration of alarm lamp patterns. typedef enum LampPatternEnum { - LAMP_PATTERN_OFF = 0, - LAMP_PATTERN_OK, - LAMP_PATTERN_FAULT, - LAMP_PATTERN_HIGH_ALARM, - LAMP_PATTERN_MED_ALARM, - LAMP_PATTERN_LOW_ALARM, - LAMP_PATTERN_MANUAL, - NUM_OF_LAMP_PATTERNS + LAMP_PATTERN_OFF = 0, ///< Alarm lamp pattern where lamp is off + LAMP_PATTERN_OK, ///< Alarm lamp pattern for ok state + LAMP_PATTERN_FAULT, ///< Alarm lamp pattern for fault state + LAMP_PATTERN_HIGH_ALARM, ///< Alarm lamp pattern for high priority alarm state + LAMP_PATTERN_MED_ALARM, ///< Alarm lamp pattern for medium priority alarm state + LAMP_PATTERN_LOW_ALARM, ///< Alarm lamp pattern for low priority alarm state + LAMP_PATTERN_MANUAL, ///< Alarm lamp pattern is managed manually in the state + NUM_OF_LAMP_PATTERNS ///< Number of alarm lamp patterns } LAMP_PATTERN_T; // ********** public function prototypes ********** @@ -43,7 +52,9 @@ DATA_GET_PROTOTYPE( LAMP_PATTERN_T, getCurrentAlarmLampPattern ); -BOOL testSetCurrentLampPatternOverride( LAMP_PATTERN_T value ); +BOOL testSetCurrentLampPatternOverride( U32 value ); BOOL testResetCurrentLampPatternOverride( void ); +/**@}*/ + #endif Index: firmware/App/Controllers/BloodFlow.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/BloodFlow.c (.../BloodFlow.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/BloodFlow.c (.../BloodFlow.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -302,8 +302,8 @@ /*********************************************************************//** * @brief - * The signalBloodPumpRotorHallSensor function handles the blood pump rotor \n - * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if \n + * 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 @@ -425,7 +425,7 @@ /*********************************************************************//** * @brief - * The handleBloodPumpOffState function handles the blood pump off state \n + * The handleBloodPumpOffState function handles the blood pump off state * of the blood pump controller state machine. * @details * Inputs : targetBloodFlowRate, bloodPumpDirection @@ -454,7 +454,7 @@ /*********************************************************************//** * @brief - * The handleBloodPumpRampingUpState function handles the ramp up state \n + * The handleBloodPumpRampingUpState function handles the ramp up state * of the blood pump controller state machine. * @details * Inputs : bloodPumpPWMDutyCyclePctSet @@ -499,7 +499,7 @@ /*********************************************************************//** * @brief - * The handleBloodPumpRampingDownState function handles the ramp down state \n + * The handleBloodPumpRampingDownState function handles the ramp down state * of the blood pump controller state machine. * @details * Inputs : bloodPumpPWMDutyCyclePctSet @@ -542,7 +542,7 @@ /*********************************************************************//** * @brief - * The handleBloodPumpControlToTargetState function handles the "control to \n + * The handleBloodPumpControlToTargetState function handles the "control to * target" state of the blood pump controller state machine. * @details * Inputs : none @@ -574,7 +574,7 @@ /*********************************************************************//** * @brief - * The setBloodPumpControlSignalPWM function sets the PWM duty cycle for \n + * The setBloodPumpControlSignalPWM function sets the PWM duty cycle for * the blood pump to a given %. * @details * Inputs : none @@ -618,7 +618,7 @@ /*********************************************************************//** * @brief - * The setBloodPumpDirection function sets the set blood pump direction to \n + * The setBloodPumpDirection function sets the set blood pump direction to * the given direction. * @details * Inputs : bloodPumpState @@ -648,7 +648,7 @@ /*********************************************************************//** * @brief - * The getPublishBloodFlowDataInterval function gets the blood flow data \n + * The getPublishBloodFlowDataInterval function gets the blood flow data * publication interval. * @details * Inputs : bloodFlowDataPublishInterval @@ -669,7 +669,7 @@ /*********************************************************************//** * @brief - * The getTargetBloodFlowRate function gets the current target blood flow \n + * The getTargetBloodFlowRate function gets the current target blood flow * rate. * @details * Inputs : targetBloodFlowRate @@ -690,7 +690,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodFlowRate function gets the measured blood flow \n + * The getMeasuredBloodFlowRate function gets the measured blood flow * rate. * @details * Inputs : measuredBloodFlowRate @@ -711,7 +711,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpRotorSpeed function gets the measured blood flow \n + * The getMeasuredBloodPumpRotorSpeed function gets the measured blood flow * rate. * @details * Inputs : bloodPumpRotorSpeedRPM @@ -732,7 +732,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpSpeed function gets the measured blood flow \n + * The getMeasuredBloodPumpSpeed function gets the measured blood flow * rate. * @details * Inputs : bloodPumpSpeedRPM @@ -753,7 +753,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpMCSpeed function gets the measured blood pump \n + * The getMeasuredBloodPumpMCSpeed function gets the measured blood pump * speed. * @details * Inputs : adcBloodPumpMCSpeedRPM @@ -774,7 +774,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpMCCurrent function gets the measured blood pump \n + * The getMeasuredBloodPumpMCCurrent function gets the measured blood pump * current. * @details * Inputs : adcBloodPumpMCCurrentmA @@ -795,10 +795,10 @@ /*********************************************************************//** * @brief - * The publishBloodFlowData function publishes blood flow data at the set \n + * The publishBloodFlowData function publishes blood flow data at the set * interval. * @details - * Inputs : target flow rate, measured flow rate, measured MC speed, \n + * Inputs : target flow rate, measured flow rate, measured MC speed, * measured MC current * Outputs : Blood flow data is published to CAN bus. * @return none @@ -839,7 +839,7 @@ /*********************************************************************//** * @brief - * The resetBloodFlowMovingAverage function re-initializes the blood flow \n + * The resetBloodFlowMovingAverage function re-initializes the blood flow * moving average sample buffer. * @details * Inputs : none @@ -882,8 +882,8 @@ /*********************************************************************//** * @brief - * The updateBloodPumpSpeedAndDirectionFromHallSensors function calculates \n - * the blood pump motor speed and direction from hall sensor counter on \n + * 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 @@ -921,8 +921,8 @@ /*********************************************************************//** * @brief - * The checkBloodPumpRotor function checks the rotor for the blood \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * 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 @@ -956,7 +956,7 @@ /*********************************************************************//** * @brief - * The checkBloodPumpDirection function checks the set direction vs. \n + * The checkBloodPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : @@ -982,11 +982,11 @@ /*********************************************************************//** * @brief - * The checkBloodPumpSpeeds function checks several aspects of the blood pump \n - * speed. \n - * 1. while pump is commanded off, measured motor speed should be < limit. \n - * 2. while pump is controlling, measured motor speed should be within allowed range of commanded speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkBloodPumpSpeeds function checks several aspects of the blood pump + * speed. + * 1. while pump is commanded off, measured motor speed should be < limit. + * 2. while pump is controlling, measured motor speed should be within allowed range of 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 @@ -1068,9 +1068,9 @@ /*********************************************************************//** * @brief - * The checkBloodPumpFlowAgainstSpeed function checks the measured blood flow \n - * against the implied flow of the measured pump speed when in treatment mode \n - * and controlling to target flow. If a sufficient difference persists, a \n + * The checkBloodPumpFlowAgainstSpeed function checks the measured blood flow + * 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 @@ -1109,7 +1109,7 @@ /*********************************************************************//** * @brief - * The checkBloodPumpMCCurrent function checks the measured MC current vs. \n + * The checkBloodPumpMCCurrent function checks the measured MC current vs. * the set state of the blood pump (stopped or running). * @details * Inputs : @@ -1162,7 +1162,7 @@ /*********************************************************************//** * @brief - * The execBloodFlowTest function executes the state machine for the \n + * The execBloodFlowTest function executes the state machine for the * BloodFlow self test. * @details * Inputs : none @@ -1209,7 +1209,7 @@ /*********************************************************************//** * @brief - * The setBloodFlowCalibration function sets the blood flow calibration \n + * The setBloodFlowCalibration function sets the blood flow calibration * factors and has them stored in non-volatile memory. * @details * Inputs : none @@ -1244,7 +1244,7 @@ /*********************************************************************//** * @brief - * The getBloodFlowCalibration function retrieves the current blood flow \n + * The getBloodFlowCalibration function retrieves the current blood flow * calibration factors. * @details * Inputs : bloodFlowCalGain, bloodFlowCalOffset @@ -1261,7 +1261,7 @@ /*********************************************************************//** * @brief - * The testSetBloodFlowDataPublishIntervalOverride function overrides the \n + * The testSetBloodFlowDataPublishIntervalOverride function overrides the * blood flow data publish interval. * @details * Inputs : none @@ -1287,7 +1287,7 @@ /*********************************************************************//** * @brief - * The testResetBloodFlowDataPublishIntervalOverride function resets the override \n + * The testResetBloodFlowDataPublishIntervalOverride function resets the override * of the blood flow data publish interval. * @details * Inputs : none @@ -1310,7 +1310,7 @@ /*********************************************************************//** * @brief - * The testSetTargetBloodFlowRateOverride function overrides the target \n + * The testSetTargetBloodFlowRateOverride function overrides the target * blood flow rate. * @details * Inputs : none @@ -1349,7 +1349,7 @@ /*********************************************************************//** * @brief - * The testResetTargetBloodFlowRateOverride function resets the override of the \n + * The testResetTargetBloodFlowRateOverride function resets the override of the * target blood flow rate. * @details * Inputs : none @@ -1374,7 +1374,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredBloodFlowRateOverride function overrides the measured \n + * The testResetMeasuredBloodFlowRateOverride function overrides the measured * blood flow rate. * @details * Inputs : none @@ -1398,7 +1398,7 @@ /*********************************************************************//** * @brief - * The testResetOffButtonStateOverride function resets the override of the \n + * The testResetOffButtonStateOverride function resets the override of the * measured blood flow rate. * @details * Inputs : none @@ -1421,7 +1421,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredBloodPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredBloodPumpRotorSpeedOverride function overrides the measured * blood pump rotor speed. * @details * Inputs : none @@ -1445,7 +1445,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredBloodPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredBloodPumpRotorSpeedOverride function resets the override of the * measured blood pump rotor speed. * @details * Inputs : none @@ -1468,7 +1468,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredBloodPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredBloodPumpSpeedOverride function overrides the measured * blood pump motor speed. * @details * Inputs : none @@ -1492,7 +1492,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredBloodPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredBloodPumpSpeedOverride function resets the override of the * measured blood pump motor speed. * @details * Inputs : none @@ -1515,7 +1515,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredBloodPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredBloodPumpMCSpeedOverride function overrides the measured * blood pump motor speed. * @details * Inputs : none @@ -1539,7 +1539,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredBloodPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredBloodPumpMCSpeedOverride function resets the override of the * measured blood pump motor speed. * @details * Inputs : none @@ -1562,7 +1562,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredBloodPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredBloodPumpMCCurrentOverride function overrides the measured * blood pump motor current. * @details * Inputs : none @@ -1586,7 +1586,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredBloodPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredBloodPumpMCCurrentOverride function resets the override of the * measured blood pump motor current. * @details * Inputs : none Index: firmware/App/Controllers/Buttons.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -22,76 +22,87 @@ #include "TaskPriority.h" #include "Timers.h" +/** + * @addtogroup Buttons + * @{ + */ + // ********** private definitions ********** - + +/// Enumeration of button self test states. typedef enum Button_Self_Test_States { - BUTTON_SELF_TEST_STATE_START = 0, - BUTTON_SELF_TEST_STATE_IN_PROGRESS, - BUTTON_SELF_TEST_STATE_COMPLETE, - NUM_OF_BUTTON_SELF_TEST_STATES + BUTTON_SELF_TEST_STATE_START = 0, ///< Button self test start state + BUTTON_SELF_TEST_STATE_IN_PROGRESS, ///< Button self test in progress state + BUTTON_SELF_TEST_STATE_COMPLETE, ///< Button self test completed state + NUM_OF_BUTTON_SELF_TEST_STATES ///< Number of button self test states } BUTTON_SELF_TEST_STATE_T; - + +/// Enumeration of hardware buttons. typedef enum Buttons { - BUTTON_OFF = 0, - BUTTON_STOP, - NUM_OF_BUTTONS + BUTTON_OFF = 0, ///< Off button + BUTTON_STOP, ///< Stop button + NUM_OF_BUTTONS ///< Number of hardware buttons } BUTTON_T; - + +/// Enumeration of off button commands to UI. typedef enum OffButtonCmdsToUI { - OFF_BUTTON_CMD_PROMPT_USER_TO_CONFIRM = 0, - OFF_BUTTON_CMD_CANCEL_USER_CONFIRM_PROMPT, - OFF_BUTTON_CMD_REJECT_USER_OFF_REQUEST, - NUM_OF_OFF_BUTTON_CMDS + OFF_BUTTON_CMD_PROMPT_USER_TO_CONFIRM = 0, ///< Prompt user to confirm power off command + OFF_BUTTON_CMD_CANCEL_USER_CONFIRM_PROMPT, ///< Cancel user confirm prompt command + OFF_BUTTON_CMD_REJECT_USER_OFF_REQUEST, ///< Reject user off request command + NUM_OF_OFF_BUTTON_CMDS ///< Number of off button commands to UI } OFF_BUTTON_CMD_T; - + +/// Enumeration of off button responses from UI. typedef enum OffButtonRspsFromUI { - OFF_BUTTON_RSP_USER_REQUESTS_POWER_OFF = 0, - OFF_BUTTON_RSP_USER_CONFIRMS_POWER_OFF, - OFF_BUTTON_RSP_USER_REJECTS_POWER_OFF, - NUM_OF_OFF_BUTTON_RSPS + OFF_BUTTON_RSP_USER_REQUESTS_POWER_OFF = 0, ///< User requests power off response + OFF_BUTTON_RSP_USER_CONFIRMS_POWER_OFF, ///< User confirms power off response + OFF_BUTTON_RSP_USER_REJECTS_POWER_OFF, ///< User rejects power off response + NUM_OF_OFF_BUTTON_RSPS ///< Number of off button responses from UI } OFF_BUTTON_RSP_T; -#define OFF_REQUEST_PULSE_COUNT 4 -#define OFF_REQUEST_PULSE_INTVL_MS 50 // ms -#define OFF_REQUEST_DELAY_TIME_MS 2000 // ms -#define STOP_BUTTON_PENDING_TIMEOUT_MS 500 // ms -#define STUCK_BUTTON_TIMEOUT_MS 1000 // ms -#define OFF_REQUEST_EXPIRATION_TIME_MS (1000 * 60) // ms (1 minute) +#define OFF_REQUEST_PULSE_COUNT 4 ///< Number of edges for power off sequence on power off output signal. +#define OFF_REQUEST_PULSE_INTVL_MS 50 ///< Duration (in ms) of power off sequence steps. +#define OFF_REQUEST_DELAY_TIME_MS 2000 ///< Duration (in ms) of delay before power off sequence is initiated to provide sub-systems time to wrap things up. +#define STOP_BUTTON_PENDING_TIMEOUT_MS 500 ///< Timeout period (in ms) for stop button press to be consumed. +#define STUCK_BUTTON_TIMEOUT_MS 1000 ///< Duration (in ms) that a button must be in pressed state before considering it stuck at power up. +#define OFF_REQUEST_EXPIRATION_TIME_MS (1000 * 60) ///< Time (in ms) that the user is given to confirm a power off request before it expires. -#define USER_CONFIRMED 1 -#define USER_REJECTED 0 +#define USER_CONFIRMED 1 ///< User response code to power off confirmation prompt that indicates confirmation. +#define USER_REJECTED 0 ///< User response code to power off confirmation prompt that indicates rejection. // ********** private data ********** + +/// Current off button state (overrideable). +static OVERRIDE_U32_T dataOffButtonState = { BUTTON_STATE_RELEASED, BUTTON_STATE_PRESSED, BUTTON_STATE_PRESSED, 0 }; +static BUTTON_STATE_T prevOffButtonState = BUTTON_STATE_RELEASED; ///< Previous state of off button. +static BOOL offRequestAwaitingUserConfirmation = FALSE; ///< Flag indicates whether a power off request is pending user confirmation. +static U32 offRequestPendingTimer = 0; ///< Timer counter for pending power off request. +static BOOL offButtonPressPending = FALSE; ///< Flag indicates whether a confirmed power off request is pending execution. +static U32 offRequestPulseCount = 0; ///< Power off sequence step counter. +static U32 offRequestPulseTimer = 0; ///< Power off sequence step timer counter. +static U32 offRequestDelayTimer = 0; ///< Power off sequence delay timer counter. -DATA_DECL( BUTTON_STATE_T, OffButtonState, dataOffButtonState, BUTTON_STATE_RELEASED, BUTTON_STATE_PRESSED ); -static BUTTON_STATE_T prevOffButtonState = BUTTON_STATE_RELEASED; -static BOOL offRequestAwaitingUserConfirmation = FALSE; -static U32 offRequestPendingTimer = 0; -static BOOL offButtonPressPending = FALSE; -static U32 offRequestPulseCount = 0; -static U32 offRequestPulseTimer = 0; -static U32 offRequestDelayTimer = 0; +/// Current stop button state (overrideable). +static OVERRIDE_U32_T dataStopButtonState = { BUTTON_STATE_RELEASED, BUTTON_STATE_PRESSED, BUTTON_STATE_PRESSED, 0 }; +static BUTTON_STATE_T prevStopButtonState = BUTTON_STATE_RELEASED; ///< Previous state of stop button. +static BOOL stopButtonPressPending = FALSE; ///< Flag indicates a stop button press is pending consumption. +static U32 stopButtonPendingTimer = 0; ///< Timer counter for pending stop button press. -DATA_DECL( BUTTON_STATE_T, StopButtonState, dataStopButtonState, BUTTON_STATE_RELEASED, BUTTON_STATE_PRESSED ); -static BUTTON_STATE_T prevStopButtonState = BUTTON_STATE_RELEASED; -static BOOL stopButtonPressPending = FALSE; -static U32 stopButtonPendingTimer = 0; +static BUTTON_SELF_TEST_STATE_T buttonSelfTestState = BUTTON_SELF_TEST_STATE_START; ///< Current state of button self test. +static U32 buttonSelfTestTimerCount = 0; ///< Timer counter for button self test states. -static BUTTON_SELF_TEST_STATE_T buttonSelfTestState = BUTTON_SELF_TEST_STATE_START; -static U32 buttonSelfTestTimerCount = 0; - // ********** private function prototypes ********** static void handleOffButtonProcessing( void ); static void handleStopButtonProcessing( void ); static BOOL isCurrentOpModeOkToTurnOff( void ); -/************************************************************************* - * @brief initButtons +/*********************************************************************//** + * @brief * The initButtons function initializes the Buttons module. * @details * Inputs : none @@ -115,8 +126,8 @@ buttonSelfTestTimerCount = 0; } -/************************************************************************* - * @brief execButtons +/*********************************************************************//** + * @brief * The execButtons function executes the Buttons monitor. * @details * Inputs : none @@ -139,11 +150,11 @@ handleOffButtonProcessing(); } -/************************************************************************* - * @brief isStopButtonPressed - * The isStopButtonPressed function determines whether the stop button has been \n - * pressed. Once the stop button has transitioned from released to pressed, a \n - * press for the stop button will be pending until this function is called. \n +/*********************************************************************//** + * @brief + * 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 @@ -158,36 +169,56 @@ return result; } -/************************************************************************* - * @brief getOffButtonState - * The getOffButtonState function determines whether the off button is \n +/*********************************************************************//** + * @brief + * The getOffButtonState function determines whether the off button is * currently pressed. * @details * Inputs : dataOffButtonState, prevOffButtonState * Outputs : none * @return BUTTON_STATE_PRESSED if off button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ -DATA_GET( BUTTON_STATE_T, getOffButtonState, dataOffButtonState ) +BUTTON_STATE_T getOffButtonState( void ) +{ + BUTTON_STATE_T result = (BUTTON_STATE_T)dataOffButtonState.data; + + if ( OVERRIDE_KEY == dataOffButtonState.override ) + { + result = (BUTTON_STATE_T)dataOffButtonState.ovData; + } + + return result; +} -/************************************************************************* - * @brief getStopButtonState - * The getStopButtonState function determines whether the stop button is \n +/*********************************************************************//** + * @brief + * The getStopButtonState function determines whether the stop button is * currently pressed. * @details * Inputs : dataStopButtonState, prevStopButtonState * Outputs : none * @return BUTTON_STATE_PRESSED if stop button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ -DATA_GET( BUTTON_STATE_T, getStopButtonState, dataStopButtonState ) +BUTTON_STATE_T getStopButtonState( void ) +{ + BUTTON_STATE_T result = (BUTTON_STATE_T)dataStopButtonState.data; + + if ( OVERRIDE_KEY == dataStopButtonState.override ) + { + result = (BUTTON_STATE_T)dataStopButtonState.ovData; + } + + return result; +} -/************************************************************************* - * @brief execStuckButtonTest - * The execStuckButtonTest function executes the stuck button test. \n - * This function should be called periodically until a pass or fail \n +/*********************************************************************//** + * @brief + * The execStuckButtonTest function executes the stuck button test. + * This function should be called periodically until a pass or fail * result is returned. * @details - * Inputs : - * Outputs : + * Inputs : dataOffButtonState + * Outputs : buttonSelfTestState, buttonSelfTestTimerCount * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execStuckButtonTest( void ) @@ -232,10 +263,10 @@ return result; } -/************************************************************************* - * @brief userConfirmOffButton - * The userConfirmOffButton function handles user confirmation of the off \n - * button. The off request will be initiated here if confirmed or cancelled \n +/*********************************************************************//** + * @brief + * 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 @@ -273,7 +304,6 @@ if ( TRUE == isCurrentOpModeOkToTurnOff() ) { broadcastPowerOffWarning(); - // TODO - maybe delay a bit before starting power off sequence here to allow sub-systems time to get warning and wrap up critical activities offButtonPressPending = TRUE; offRequestPulseCount = OFF_REQUEST_PULSE_COUNT; offRequestPulseTimer = 0; @@ -304,9 +334,9 @@ } // end switch } -/************************************************************************* - * @brief isCurrentOpModeOkToTurnOff - * The isCurrentOpModeOkToTurnOff function determines whether the system can \n +/*********************************************************************//** + * @brief + * The isCurrentOpModeOkToTurnOff function determines whether the system can * be turned off in current operation mode. * @details * Inputs : Current operation mode. @@ -326,9 +356,9 @@ return result; } -/************************************************************************* - * @brief handleOffButtonProcessing - * The handleOffButtonProcessing function checks for and processes off button \n +/*********************************************************************//** + * @brief + * The handleOffButtonProcessing function checks for and processes off button * activity. * @details * Inputs : offButtonState, prevOffButtonState @@ -385,9 +415,9 @@ } } -/************************************************************************* - * @brief handleStopButtonProcessing - * The handleStopButtonProcessing function checks for and processes stop button \n +/*********************************************************************//** + * @brief + * The handleStopButtonProcessing function checks for and processes stop button * activity. * @details * Inputs : stopButtonState, prevStopButtonState @@ -425,31 +455,98 @@ *************************************************************************/ -/************************************************************************* - * @brief testSetOffButtonStateOverride and testResetOffButtonStateOverride - * The testSetOffButtonStateOverride function overrides the state of the \n - * off button with a given state. \n - * The testResetOffButtonStateOverride function resets the override of the \n - * state of the off button. +/*********************************************************************//** + * @brief + * The testSetOffButtonStateOverride function overrides the state of then + * off button with a given state.n * @details * Inputs : none * Outputs : dataOffButtonState * @param value override state for the off button * @return TRUE if override successful, FALSE if not *************************************************************************/ -DATA_OVERRIDE_FUNC( BUTTON_STATE_T, testSetOffButtonStateOverride, testResetOffButtonStateOverride, dataOffButtonState ) +BOOL testSetOffButtonStateOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + dataOffButtonState.ovData = value; + dataOffButtonState.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetOffButtonStateOverride function resets the override of then + * state of the off button. + * @details + * Inputs : none + * Outputs : dataOffButtonState + * @return TRUE if override reset successful, FALSE if not + *************************************************************************/ +BOOL testResetOffButtonStateOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + dataOffButtonState.override = OVERRIDE_RESET; + dataOffButtonState.ovData = dataOffButtonState.ovInitData; + } + + return result; +} -/************************************************************************* - * @brief testSetStopButtonStateOverride and testResetStopButtonStateOverride - * The testSetStopButtonStateOverride function overrides the state of the \n - * stop button with a given state. \n - * The testResetStopButtonStateOverride function resets the override of the \n - * state of the stop button. +/*********************************************************************//** + * @brief + * The testSetStopButtonStateOverride function overrides the state of then + * stop button with a given state. * @details * Inputs : none * Outputs : dataStopButtonState * @param value override state for the stop button * @return TRUE if override successful, FALSE if not *************************************************************************/ -DATA_OVERRIDE_FUNC( BUTTON_STATE_T, testSetStopButtonStateOverride, testResetStopButtonStateOverride, dataStopButtonState ) +BOOL testSetStopButtonStateOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + dataStopButtonState.ovData = value; + dataStopButtonState.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetStopButtonStateOverride function resets the override of then + * state of the stop button. + * @details + * Inputs : none + * Outputs : dataStopButtonState + * @return TRUE if override reset successful, FALSE if not + *************************************************************************/ +BOOL testResetStopButtonStateOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + dataStopButtonState.override = OVERRIDE_RESET; + dataStopButtonState.ovData = dataStopButtonState.ovInitData; + } + + return result; +} +/**@}*/ Index: firmware/App/Controllers/Buttons.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/Buttons.h (.../Buttons.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/Buttons.h (.../Buttons.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -20,13 +20,22 @@ #include "HDCommon.h" +/** + * @defgroup Buttons Buttons + * @brief The Buttons module monitors and manages the off and stop buttons. + * + * @addtogroup Buttons + * @{ + */ + // ********** public definitions ********** - + +// Enumeration of hardware button states. typedef enum Button_States { - BUTTON_STATE_RELEASED = 0, - BUTTON_STATE_PRESSED, - NUM_OF_BUTTON_STATES + BUTTON_STATE_RELEASED = 0, ///< Button is in the released state + BUTTON_STATE_PRESSED, ///< Button is in the pressed state + NUM_OF_BUTTON_STATES ///< Number of button states } BUTTON_STATE_T; // ********** public function prototypes ********** @@ -40,9 +49,11 @@ DATA_GET_PROTOTYPE( BUTTON_STATE_T, getOffButtonState ); DATA_GET_PROTOTYPE( BUTTON_STATE_T, getStopButtonState ); -BOOL testSetOffButtonStateOverride( BUTTON_STATE_T value ); +BOOL testSetOffButtonStateOverride( U32 value ); BOOL testResetOffButtonStateOverride( void ); -BOOL testSetStopButtonStateOverride( BUTTON_STATE_T value ); +BOOL testSetStopButtonStateOverride( U32 value ); BOOL testResetStopButtonStateOverride( void ); +/**@}*/ + #endif Index: firmware/App/Controllers/DGInterface.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -110,7 +110,7 @@ /*********************************************************************//** * @brief - * The initTreatmentReservoirMgmt function initializes the treatment reservoir \n + * The initTreatmentReservoirMgmt function initializes the treatment reservoir * management state machine. * @details * Inputs : none @@ -127,7 +127,7 @@ /*********************************************************************//** * @brief - * The execTreatmentReservoirMgmt function executes the state machine for the \n + * The execTreatmentReservoirMgmt function executes the state machine for the * reservoir management during treatment mode. * @details * Inputs : none @@ -294,7 +294,7 @@ /*********************************************************************//** * @brief - * The getDGPressure function gets the latest pressure reported by the DG \n + * The getDGPressure function gets the latest pressure reported by the DG * for a given pressure sensor. * @details * Inputs : dgPressures[] @@ -320,7 +320,7 @@ /*********************************************************************//** * @brief - * The getDGROPumpPressureSetPt function gets the latest RO pump \n + * The getDGROPumpPressureSetPt function gets the latest RO pump * pressure set point reported by the DG. * @details * Inputs : dgROPumpPressureSetPtPSI @@ -336,7 +336,7 @@ /*********************************************************************//** * @brief - * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow \n + * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow * rate reported by the DG. * @details * Inputs : dgROPumpFlowRateMlMin @@ -352,7 +352,7 @@ /*********************************************************************//** * @brief - * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM \n + * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM * set point reported by the DG. * @details * Inputs : dgDrainPumpSpeedSetPtRPM @@ -368,7 +368,7 @@ /*********************************************************************//** * @brief - * The setDGOpMode function sets the latest DG operating mode reported by \n + * The setDGOpMode function sets the latest DG operating mode reported by * the DG. * @details * Inputs : none @@ -392,7 +392,7 @@ /*********************************************************************//** * @brief - * The setDialysateTemperatureReadings function sets the latest dialysate \n + * The setDialysateTemperatureReadings function sets the latest dialysate * temperatures reported by the DG. * @details * Inputs : none @@ -409,7 +409,7 @@ /*********************************************************************//** * @brief - * The setDGDialysateTemperatures function sets the latest temperature data \n + * The setDGDialysateTemperatures function sets the latest temperature data * reported by the DG. * @details * Inputs : none @@ -426,7 +426,7 @@ /*********************************************************************//** * @brief - * The setDGReservoirsData function sets the latest reservoir data \n + * The setDGReservoirsData function sets the latest reservoir data * reported by the DG. * @details * Inputs : none @@ -502,7 +502,7 @@ /*********************************************************************//** * @brief - * The cmdSetDGDialysateTargetTemps function sends a target dialysate \n + * The cmdSetDGDialysateTargetTemps function sends a target dialysate * temperature command message to the DG. * @details * Inputs : none @@ -520,7 +520,7 @@ /*********************************************************************//** * @brief - * The cmdStartDG function sends a start command to the DG. DG will transition \n + * The cmdStartDG function sends a start command to the DG. DG will transition * from standby to re-circulate mode and start producing warm, pure water. * @details * Inputs : none @@ -535,7 +535,7 @@ /*********************************************************************//** * @brief - * The cmdStopDG function sends a stop command to the DG. DG will transition \n + * The cmdStopDG function sends a stop command to the DG. DG will transition * from re-circulate mode to standby mode. Pumps and heater go off. * @details * Inputs : none @@ -550,7 +550,7 @@ /*********************************************************************//** * @brief - * The cmdStartDGTrimmerHeater function sends a start trimmer heater command \n + * The cmdStartDGTrimmerHeater function sends a start trimmer heater command * to the DG. * @details * Inputs : none @@ -565,7 +565,7 @@ /*********************************************************************//** * @brief - * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command \n + * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command * to the DG. * @details * Inputs : none @@ -580,7 +580,7 @@ /*********************************************************************//** * @brief - * The cmdSetDGActiveReservoir function sends a set active reservoir command \n + * The cmdSetDGActiveReservoir function sends a set active reservoir command * message to the DG. * @details * Inputs : none Index: firmware/App/Controllers/DialInFlow.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -299,8 +299,8 @@ /*********************************************************************//** * @brief - * The signalDialInPumpRotorHallSensor function handles the dialysate inlet pump rotor \n - * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if \n + * 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 @@ -422,7 +422,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpOffState function handles the dialIn pump off state \n + * The handleDialInPumpOffState function handles the dialIn pump off state * of the dialIn pump controller state machine. * @details * Inputs : targetDialInFlowRate, dialInPumpDirection @@ -451,7 +451,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpRampingUpState function handles the ramp up state \n + * The handleDialInPumpRampingUpState function handles the ramp up state * of the dialIn pump controller state machine. * @details * Inputs : dialInPumpPWMDutyCyclePctSet @@ -496,7 +496,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpRampingDownState function handles the ramp down state \n + * The handleDialInPumpRampingDownState function handles the ramp down state * of the dialIn pump controller state machine. * @details * Inputs : dialInPumpPWMDutyCyclePctSet @@ -539,7 +539,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpControlToTargetState function handles the "control to \n + * The handleDialInPumpControlToTargetState function handles the "control to * target" state of the dialIn pump controller state machine. * @details * Inputs : none @@ -571,7 +571,7 @@ /*********************************************************************//** * @brief - * The setDialInPumpControlSignalPWM function sets the PWM duty cycle for \n + * The setDialInPumpControlSignalPWM function sets the PWM duty cycle for * the dialysate inlet pump to a given %. * @details * Inputs : none @@ -615,7 +615,7 @@ /*********************************************************************//** * @brief - * The setDialInPumpDirection function sets the set dialIn pump direction to \n + * The setDialInPumpDirection function sets the set dialIn pump direction to * the given direction. * @details * Inputs : dialInPumpState @@ -645,7 +645,7 @@ /*********************************************************************//** * @brief - * The getPublishDialInFlowDataInterval function gets the dialIn flow data \n + * The getPublishDialInFlowDataInterval function gets the dialIn flow data * publication interval. * @details * Inputs : dialInFlowDataPublishInterval @@ -666,7 +666,7 @@ /*********************************************************************//** * @brief - * The getTargetDialInFlowRate function gets the current target dialIn flow \n + * The getTargetDialInFlowRate function gets the current target dialIn flow * rate. * @details * Inputs : targetDialInFlowRate @@ -687,7 +687,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInFlowRate function gets the measured dialIn flow \n + * The getMeasuredDialInFlowRate function gets the measured dialIn flow * rate. * @details * Inputs : measuredDialInFlowRate @@ -708,7 +708,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpRotorSpeed function gets the measured dialIn flow \n + * The getMeasuredDialInPumpRotorSpeed function gets the measured dialIn flow * rate. * @details * Inputs : dialInPumpRotorSpeedRPM @@ -729,7 +729,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpSpeed function gets the measured dialIn flow \n + * The getMeasuredDialInPumpSpeed function gets the measured dialIn flow * rate. * @details * Inputs : dialInPumpSpeedRPM @@ -750,7 +750,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpMCSpeed function gets the measured dialIn pump \n + * The getMeasuredDialInPumpMCSpeed function gets the measured dialIn pump * speed. * @details * Inputs : adcDialInPumpMCSpeedRPM @@ -771,7 +771,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpMCCurrent function gets the measured dialIn pump \n + * The getMeasuredDialInPumpMCCurrent function gets the measured dialIn pump * current. * @details * Inputs : adcDialInPumpMCCurrentmA @@ -792,10 +792,10 @@ /*********************************************************************//** * @brief - * The publishDialInFlowData function publishes dialIn flow data at the set \n + * The publishDialInFlowData function publishes dialIn flow data at the set * interval. * @details - * Inputs : target flow rate, measured flow rate, measured MC speed, \n + * Inputs : target flow rate, measured flow rate, measured MC speed, * measured MC current * Outputs : DialIn flow data is published to CAN bus. * @return none @@ -819,7 +819,7 @@ /*********************************************************************//** * @brief - * The resetDialInFlowMovingAverage function resets the properties of the \n + * The resetDialInFlowMovingAverage function resets the properties of the * dialIn flow moving average sample buffer. * @details * Inputs : none @@ -861,8 +861,8 @@ /*********************************************************************//** * @brief - * The updateDialInPumpSpeedAndDirectionFromHallSensors function calculates \n - * the dialysate inlet pump motor speed and direction from hall sensor counter on \n + * 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 @@ -900,8 +900,8 @@ /*********************************************************************//** * @brief - * The checkDialInPumpRotor function checks the rotor for the dialysate inlet \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * 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 @@ -927,7 +927,7 @@ /*********************************************************************//** * @brief - * The checkDialInPumpDirection function checks the set direction vs. \n + * The checkDialInPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : adcDialInPumpMCSpeedRPM, dialInPumpDirectionSet, dialInPumpState @@ -953,11 +953,11 @@ /*********************************************************************//** * @brief - * The checkDialInPumpSpeeds function checks several aspects of the dialysate \n - * inlet pump speed. \n - * 1. while pump is commanded off, measured motor speed should be < limit. \n - * 2. while pump is controlling, measured motor speed should be within allowed range of commanded speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkDialInPumpSpeeds function checks several aspects of the dialysate + * inlet pump speed. + * 1. while pump is commanded off, measured motor speed should be < limit. + * 2. while pump is controlling, measured motor speed should be within allowed range of 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 @@ -1039,9 +1039,9 @@ /*********************************************************************//** * @brief - * The checkDialInPumpFlowAgainstSpeed function checks the measured dialysate flow \n - * against the implied flow of the measured pump speed when in treatment mode \n - * and controlling to target flow. If a sufficient difference persists, a \n + * The checkDialInPumpFlowAgainstSpeed function checks the measured dialysate flow + * 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 @@ -1080,7 +1080,7 @@ /*********************************************************************//** * @brief - * The checkDialInPumpMCCurrent function checks the measured MC current vs. \n + * The checkDialInPumpMCCurrent function checks the measured MC current vs. * the set state of the dialIn pump (stopped or running). * @details * Inputs : dialInPumpState, dipCurrErrorDurationCtr, adcDialInPumpMCCurrentmA @@ -1133,7 +1133,7 @@ /*********************************************************************//** * @brief - * The execDialInFlowTest function executes the state machine for the \n + * The execDialInFlowTest function executes the state machine for the * DialInFlow self test. * @details * Inputs : none @@ -1180,7 +1180,7 @@ /*********************************************************************//** * @brief - * The setDialInFlowCalibration function sets the dialysate flow calibration \n + * The setDialInFlowCalibration function sets the dialysate flow calibration * factors and has them stored in non-volatile memory. * @details * Inputs : none @@ -1215,7 +1215,7 @@ /*********************************************************************//** * @brief - * The getDialInFlowCalibration function retrieves the current dialysate flow \n + * The getDialInFlowCalibration function retrieves the current dialysate flow * calibration factors. * @details * Inputs : dialInFlowCalGain, dialInFlowCalOffset @@ -1232,7 +1232,7 @@ /*********************************************************************//** * @brief - * The testSetDialInFlowDataPublishIntervalOverride function overrides the \n + * The testSetDialInFlowDataPublishIntervalOverride function overrides the * dialIn flow data publish interval. * @details * Inputs : none @@ -1258,7 +1258,7 @@ /*********************************************************************//** * @brief - * The testResetDialInFlowDataPublishIntervalOverride function resets the override \n + * The testResetDialInFlowDataPublishIntervalOverride function resets the override * of the dialIn flow data publish interval. * @details * Inputs : none @@ -1281,7 +1281,7 @@ /*********************************************************************//** * @brief - * The testSetTargetDialInFlowRateOverride function overrides the target \n + * The testSetTargetDialInFlowRateOverride function overrides the target * dialysate inlet flow rate.n * @details * Inputs : none @@ -1320,7 +1320,7 @@ /*********************************************************************//** * @brief - * The testResetTargetDialInFlowRateOverride function resets the override of the \n + * The testResetTargetDialInFlowRateOverride function resets the override of the * target dialysate inlet flow rate. * @details * Inputs : none @@ -1345,7 +1345,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInFlowRateOverride function overrides the measured \n + * The testResetMeasuredDialInFlowRateOverride function overrides the measured * dialIn flow rate. * @details * Inputs : none @@ -1369,7 +1369,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInFlowRateOverride function resets the override of the \n + * The testResetMeasuredDialInFlowRateOverride function resets the override of the * measured dialIn flow rate. * @details * Inputs : none @@ -1392,7 +1392,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpRotorSpeedOverride function overrides the measured * dialIn pump rotor speed. * @details * Inputs : none @@ -1416,7 +1416,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpRotorSpeedOverride function resets the override of the * measured dialIn pump rotor speed. * @details * Inputs : none @@ -1439,7 +1439,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpSpeedOverride function overrides the measured * dialIn pump motor speed. * @details * Inputs : none @@ -1463,7 +1463,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpSpeedOverride function resets the override of the * measured dialIn pump motor speed. * @details * Inputs : none @@ -1486,7 +1486,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpMCSpeedOverride function overrides the measured * dialIn pump motor speed. * @details * Inputs : none @@ -1510,7 +1510,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpMCSpeedOverride function resets the override of the * measured dialIn pump motor speed. * @details * Inputs : none @@ -1533,7 +1533,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredDialInPumpMCCurrentOverride function overrides the measured * dialIn pump motor current. * @details * Inputs : none @@ -1557,7 +1557,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredDialInPumpMCCurrentOverride function resets the override of the * measured dialIn pump motor current. * @details * Inputs : none Index: firmware/App/Controllers/DialOutFlow.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -222,7 +222,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpTargetRate function sets a new target flow rate, pump \n + * The setDialOutPumpTargetRate function sets a new target flow rate, pump * direction, and control mode. * @details * Inputs : isDialOutPumpOn, dialOutPumpDirectionSet @@ -291,7 +291,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -308,7 +308,7 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpHardStop function stops the dialysate outlet pump \n + * The signalDialOutPumpHardStop function stops the dialysate outlet pump * immediately. * @details * Inputs : none @@ -327,8 +327,8 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet \n - * pump rotor hall sensor detection. Calculates rotor speed (in RPM). \n + * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet + * pump rotor hall sensor detection. Calculates rotor speed (in RPM). * Stops pump if there is a pending request to home the pump. * @details * Inputs : dopRotorRevStartTime, dopStopAtHomePosition @@ -376,7 +376,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -401,8 +401,8 @@ /*********************************************************************//** * @brief execDialOutFlowMonitor - * The execDialOutFlowMonitor function executes the dialysate outlet pump \n - * and load cell sensor monitor. Checks are performed. Data is published \n + * The execDialOutFlowMonitor function executes the dialysate outlet pump + * and load cell sensor monitor. Checks are performed. Data is published * at appropriate interval. * @details * Inputs : latest sensor data @@ -438,7 +438,7 @@ /*********************************************************************//** * @brief execDialOutFlowController - * The execDialOutFlowController function executes the dialysate outlet pump \n + * The execDialOutFlowController function executes the dialysate outlet pump * ultrafiltration controller state machine. * @details * Inputs : dialOutPumpState @@ -473,7 +473,7 @@ /*********************************************************************//** * @brief handleDialOutPumpOffState - * The handleDialOutPumpOffState function handles the dialOut pump off state \n + * The handleDialOutPumpOffState function handles the dialOut pump off state * of the dialOut pump controller state machine. * @details * Inputs : targetDialOutFlowRate, dialOutPumpDirection @@ -506,7 +506,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingUpState - * The handleDialOutPumpRampingUpState function handles the ramp up state \n + * The handleDialOutPumpRampingUpState function handles the ramp up state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -550,7 +550,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingDownState - * The handleDialOutPumpRampingDownState function handles the ramp down state \n + * The handleDialOutPumpRampingDownState function handles the ramp down state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -592,7 +592,7 @@ /*********************************************************************//** * @brief handleDialOutPumpControlToTargetState - * The handleDialOutPumpControlToTargetState function handles the "control to \n + * The handleDialOutPumpControlToTargetState function handles the "control to * target" state of the dialOut pump controller state machine. * @details * Inputs : dopControlTimerCounter, dialOutPumpControlModeSet, volumes. @@ -633,7 +633,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of \n + * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of * the dialysate outlet pump to a given %. * @details * Inputs : none @@ -648,7 +648,7 @@ /*********************************************************************//** * @brief stopDialOutPump - * The stopDialOutPump function sets the dialout flow stop signal and PWM \n + * The stopDialOutPump function sets the dialout flow stop signal and PWM * duty cycle to 0.0. * @details * Inputs : none @@ -678,7 +678,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpDirection function sets the set dialOut pump direction to \n + * The setDialOutPumpDirection function sets the set dialOut pump direction to * the given direction. * @details * Inputs : none @@ -708,7 +708,7 @@ /*********************************************************************//** * @brief - * The publishDialOutFlowData function publishes dialysate outlet data at \n + * The publishDialOutFlowData function publishes dialysate outlet data at * the set interval. * @details * Inputs : Dialysate outlet pump data @@ -735,8 +735,8 @@ /*********************************************************************//** * @brief - * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates \n - * the dialysate outlet pump motor speed and direction from hall sensor counter on \n + * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates + * the dialysate outlet pump motor speed and direction from hall sensor counter on * a 1 second interval. * @details * Inputs : dopLastMotorHallSensorCount, dopMotorSpeedCalcTimerCtr, current count from FPGA @@ -774,8 +774,8 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet + * pump. If homing, this function will stop when hall sensor detected. If pump * is off or running very slowly, rotor speed will be set to zero. * @details * Inputs : dopStopAtHomePosition, dopHomeStartTime, dopRotorRevStartTime @@ -801,7 +801,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpDirection function checks the set direction vs. \n + * The checkDialOutPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : adcDialOutPumpMCSpeedRPM, dialOutPumpDirectionSet, dialOutPumpState @@ -827,11 +827,11 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpSpeeds function checks several aspects of the dialysate \n - * outlet pump speed. \n - * 1. while pump is commanded off, measured motor speed should be < limit. \n - * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkDialOutPumpSpeeds function checks several aspects of the dialysate + * outlet pump speed. + * 1. while pump is commanded off, measured motor speed should be < limit. + * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. + * 3. measured motor speed should be within allowed range of measured rotor speed. * All 3 checks have a persistence time that must be met before an alarm is triggered. * @details * Inputs : targetDialOutFlowRate, dialOutPumpSpeedRPM, dialOutPumpRotorSpeedRPM @@ -912,7 +912,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpMCCurrent function checks the measured MC current vs. \n + * The checkDialOutPumpMCCurrent function checks the measured MC current vs. * the set state of the dialOut pump (stopped or running). * @details * Inputs : dialOutPumpState, dopCurrErrorDurationCtr, adcDialOutPumpMCCurrentmA @@ -970,7 +970,7 @@ /*********************************************************************//** * @brief - * The getPublishDialOutFlowDataInterval function gets the dialysate out flow \n + * The getPublishDialOutFlowDataInterval function gets the dialysate out flow * data publication interval. * @details * Inputs : dialOutDataPublishInterval @@ -1063,7 +1063,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate \n + * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate * outlet pump rotor speed. * @details * Inputs : dialOutPumpRotorSpeedRPM @@ -1084,7 +1084,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet \n + * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet * pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1105,7 +1105,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump * speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1126,7 +1126,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump * current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1153,7 +1153,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the \n + * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the * dialout data publish interval. * @details * Inputs : none @@ -1179,7 +1179,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override \n + * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override * of the dialout data publish interval. * @details * Inputs : none @@ -1202,7 +1202,7 @@ /*********************************************************************//** * @brief - * The testSetTargetDialOutFlowRateOverride function overrides the target \n + * The testSetTargetDialOutFlowRateOverride function overrides the target * dialysate outlet flow rate. * @details * Inputs : none @@ -1238,7 +1238,7 @@ /*********************************************************************//** * @brief - * The testResetTargetDialOutFlowRateOverride function resets the override of the \n + * The testResetTargetDialOutFlowRateOverride function resets the override of the * target dialysate outlet flow rate. * @details * Inputs : none @@ -1259,7 +1259,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFRefVolumeOverride function overrides the target \n + * The testSetDialOutUFRefVolumeOverride function overrides the target * dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1283,7 +1283,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFRefVolumeOverride function resets the override of the \n + * The testResetDialOutUFRefVolumeOverride function resets the override of the * target dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1306,7 +1306,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFTotVolumeOverride function overrides the measured \n + * The testSetDialOutUFTotVolumeOverride function overrides the measured * dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1330,7 +1330,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFTotVolumeOverride function resets the override of the \n + * The testResetDialOutUFTotVolumeOverride function resets the override of the * measured dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1353,7 +1353,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured * dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1377,7 +1377,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the * measured dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1400,7 +1400,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1424,7 +1424,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1447,7 +1447,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1471,7 +1471,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1494,7 +1494,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured * dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1518,7 +1518,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the * measured dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1541,7 +1541,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutLoadCellWeightOverride function overrides the value of the \n + * The testSetDialOutLoadCellWeightOverride function overrides the value of the * load cell sensor with a given weight (in grams). * @details * Inputs : loadCellWeightInGrams[] @@ -1569,7 +1569,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutLoadCellWeightOverride function resets the override of the \n + * The testResetDialOutLoadCellWeightOverride function resets the override of the * load cell sensor. * @details * Inputs : loadCellWeightInGrams[] Index: firmware/App/Controllers/PresOccl.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -108,7 +108,7 @@ /*********************************************************************//** * @brief - * The setPressureLimits function sets the lower and upper alarm limits \n + * The setPressureLimits function sets the lower and upper alarm limits * for a given pressure sensor. * @details * Inputs : none @@ -140,7 +140,7 @@ /*********************************************************************//** * @brief - * The setOcclusionThreshold function sets the occlusion pressure threshold \n + * The setOcclusionThreshold function sets the occlusion pressure threshold * for a given occlusion sensor. * @details * Inputs : none @@ -203,7 +203,7 @@ /*********************************************************************//** * @brief - * The handlePresOcclInitState function handles the pres/occl initialize state \n + * The handlePresOcclInitState function handles the pres/occl initialize state * of the pressure/occlusion monitor state machine. * @details * Inputs : TBD @@ -219,7 +219,7 @@ /*********************************************************************//** * @brief - * The handlePresOcclContReadState function handles the continuous read state \n + * The handlePresOcclContReadState function handles the continuous read state * of the pressure/occlusion monitor state machine. * @details * Inputs : TBD @@ -255,7 +255,7 @@ /*********************************************************************//** * @brief - * The checkPressureLimits function gets the pressure/occlusion data \n + * The checkPressureLimits function gets the pressure/occlusion data * publication interval. * @details * Inputs : occlusion pressures for the pumps @@ -289,7 +289,7 @@ /*********************************************************************//** * @brief - * The getPublishPresOcclDataInterval function gets the pressure/occlusion data \n + * The getPublishPresOcclDataInterval function gets the pressure/occlusion data * publication interval. * @details * Inputs : presOcclDataPublishInterval @@ -320,7 +320,7 @@ /*********************************************************************//** * @brief - * The getMeasuredBloodPumpOcclusion function gets the measured blood pump \n + * The getMeasuredBloodPumpOcclusion function gets the measured blood pump * occlusion pressure. * @details * Inputs : bloodPumpOcclusion @@ -331,7 +331,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpOcclusion function gets the measured dialysate \n + * The getMeasuredDialInPumpOcclusion function gets the measured dialysate * inlet pump occlusion pressure. * @details * Inputs : dialInPumpOcclusion @@ -342,7 +342,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpOcclusion function gets the measured dialysate \n + * The getMeasuredDialOutPumpOcclusion function gets the measured dialysate * outlet pump occlusion pressure. * @details * Inputs : dialOutPumpOcclusion @@ -353,7 +353,7 @@ /*********************************************************************//** * @brief - * The publishPresOcclData function publishes pressure/occlusion data at the \n + * The publishPresOcclData function publishes pressure/occlusion data at the * set interval. * @details * Inputs : TBD @@ -378,7 +378,7 @@ /*********************************************************************//** * @brief - * The execPresOcclTest function executes the state machine for the \n + * The execPresOcclTest function executes the state machine for the * PresOccl self test. * @details * Inputs : none @@ -402,7 +402,7 @@ /*********************************************************************//** * @brief - * The testSetPresOcclDataPublishIntervalOverride function overrides the \n + * The testSetPresOcclDataPublishIntervalOverride function overrides the * pressure and occlusion data publish interval. * @details * Inputs : none @@ -428,7 +428,7 @@ /*********************************************************************//** * @brief - * The testResetPresOcclDataPublishIntervalOverride function resets the override \n + * The testResetPresOcclDataPublishIntervalOverride function resets the override * of the pressure and occlusion data publish interval. * @details * Inputs : none @@ -451,7 +451,7 @@ /*********************************************************************//** * @brief - * The testSetArterialPressureOverride function overrides the measured arterial \n + * The testSetArterialPressureOverride function overrides the measured arterial * pressure. * @details * Inputs : none @@ -475,7 +475,7 @@ /*********************************************************************//** * @brief - * The testResetArterialPressureOverride function resets the override of the \n + * The testResetArterialPressureOverride function resets the override of the * arterial pressure. * @details * Inputs : none @@ -498,7 +498,7 @@ /*********************************************************************//** * @brief - * The testSetVenousPressureOverride function overrides the measured venous \n + * The testSetVenousPressureOverride function overrides the measured venous * pressure. * @details * Inputs : none @@ -522,7 +522,7 @@ /*********************************************************************//** * @brief - * The testResetVenousPressureOverride function resets the override of the \n + * The testResetVenousPressureOverride function resets the override of the * venous pressure. * @details * Inputs : none @@ -545,7 +545,7 @@ /*********************************************************************//** * @brief - * The testSetBloodPumpOcclusionOverride function overrides the measured \n + * The testSetBloodPumpOcclusionOverride function overrides the measured * blood pump occlusion pressure.n * @details * Inputs : none @@ -569,7 +569,7 @@ /*********************************************************************//** * @brief - * The testResetBloodPumpOcclusionOverride function resets the override of the \n + * The testResetBloodPumpOcclusionOverride function resets the override of the * measured blood pump occlusion pressure. * @details * Inputs : none @@ -592,7 +592,7 @@ /*********************************************************************//** * @brief - * The testSetDialInPumpOcclusionOverride function overrides the measured \n + * The testSetDialInPumpOcclusionOverride function overrides the measured * dialysate inlet pump occlusion pressure.n * @details * Inputs : none @@ -616,7 +616,7 @@ /*********************************************************************//** * @brief - * The testResetDialInPumpOcclusionOverride function resets the override of the \n + * The testResetDialInPumpOcclusionOverride function resets the override of the * measured dialysate inlet pump occlusion pressure. * @details * Inputs : none @@ -639,7 +639,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutPumpOcclusionOverride function overrides the measured \n + * The testSetDialOutPumpOcclusionOverride function overrides the measured * dialysate outlet pump occlusion pressure. * @details * Inputs : none @@ -663,7 +663,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutPumpOcclusionOverride function resets the override of the \n + * The testResetDialOutPumpOcclusionOverride function resets the override of the * measured dialysate outlet pump occlusion pressure. * @details * Inputs : none Index: firmware/App/Drivers/CPLD.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -119,7 +119,7 @@ /************************************************************************* * @brief getCPLDWatchdogExpired - * The getCPLDWatchdogExpired function determines the current signal level \n + * 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. @@ -135,7 +135,7 @@ /************************************************************************* * @brief setCPLDLampGreen - * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD \n + * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD * to given level. * @details * Inputs : none @@ -157,7 +157,7 @@ /************************************************************************* * @brief setCPLDLampBlue - * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD \n + * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD * to given level. * @details * Inputs : none @@ -179,7 +179,7 @@ /************************************************************************* * @brief setCPLDLampRed - * The setCPLDLampRed function sets the alarm lamp red signal to CPLD \n + * The setCPLDLampRed function sets the alarm lamp red signal to CPLD * to given level. * @details * Inputs : none @@ -214,7 +214,7 @@ /************************************************************************* * @brief getCPLDOffButton - * The getCPLDOffButton function determines the current signal level\n + * 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. @@ -235,7 +235,7 @@ /************************************************************************* * @brief getCPLDStopButton - * The getCPLDStopButton function determines the current signal level\n + * 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. Index: firmware/App/Drivers/Comm.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Drivers/Comm.c (.../Comm.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Drivers/Comm.c (.../Comm.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -34,7 +34,7 @@ /************************************************************************* * @brief signalCANXmitsInitiated - * The signalCANXmitsInitiated function sets the CAN transmits in \n + * The signalCANXmitsInitiated function sets the CAN transmits in * progress flag. * @details * Inputs : none @@ -48,7 +48,7 @@ /************************************************************************* * @brief signalCANXmitsCompleted - * The signalCANXmitsCompleted function resets the CAN transmits in \n + * The signalCANXmitsCompleted function resets the CAN transmits in * progress flag. * @details * Inputs : none @@ -62,7 +62,7 @@ /************************************************************************* * @brief signalSCI1XmitsInitiated - * The signalSCI1XmitsInitiated function sets the SCI1 transmits in \n + * The signalSCI1XmitsInitiated function sets the SCI1 transmits in * progress flag. * @details * Inputs : none @@ -78,7 +78,7 @@ /************************************************************************* * @brief signalSCI1XmitsCompleted - * The signalSCI1XmitsCompleted function resets the SCI1 transmits in \n + * The signalSCI1XmitsCompleted function resets the SCI1 transmits in * progress flag. * @details * Inputs : none @@ -94,7 +94,7 @@ /************************************************************************* * @brief setSCI1DMAReceiveInterrupt - * The setSCI1DMAReceiveInterrupt function enables DMA receive interrupts \n + * The setSCI1DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI1 peripheral. * @details * Inputs : none @@ -110,7 +110,7 @@ /************************************************************************* * @brief setSCI1DMATransmitInterrupt - * The setSCI1DMATransmitInterrupt function enables DMA transmit interrupts \n + * The setSCI1DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI1 peripheral. * @details * Inputs : none @@ -126,7 +126,7 @@ /************************************************************************* * @brief clearSCI1DMAReceiveInterrupt - * The clearSCI1DMAReceiveInterrupt function disables DMA receive interrupts \n + * The clearSCI1DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI1 peripheral. * @details * Inputs : none @@ -142,7 +142,7 @@ /************************************************************************* * @brief clearSCI1DMATransmitInterrupt - * The clearSCI1DMATransmitInterrupt function disables DMA transmit interrupts \n + * The clearSCI1DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI1 peripheral. * @details * Inputs : none @@ -158,7 +158,7 @@ /************************************************************************* * @brief setSCI2DMAReceiveInterrupt - * The setSCI2DMAReceiveInterrupt function enables DMA receive interrupts \n + * The setSCI2DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI2 peripheral. * @details * Inputs : none @@ -172,7 +172,7 @@ /************************************************************************* * @brief setSCI2DMATransmitInterrupt - * The setSCI2DMATransmitInterrupt function enables DMA transmit interrupts \n + * The setSCI2DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI2 peripheral. * @details * Inputs : none @@ -186,7 +186,7 @@ /************************************************************************* * @brief clearSCI2DMAReceiveInterrupt - * The clearSCI2DMAReceiveInterrupt function disables DMA receive interrupts \n + * The clearSCI2DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI2 peripheral. * @details * Inputs : none @@ -200,7 +200,7 @@ /************************************************************************* * @brief clearSCI2DMATransmitInterrupt - * The clearSCI2DMATransmitInterrupt function disables DMA transmit interrupts \n + * The clearSCI2DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI2 peripheral. * @details * Inputs : none @@ -229,7 +229,7 @@ /************************************************************************* * @brief clearSCI2CommErrors - * The clearSCI2CommErrors function clears framing and/or overrun error flags \n + * The clearSCI2CommErrors function clears framing and/or overrun error flags * for the SCI2 peripheral. * @details * Inputs : none @@ -244,7 +244,7 @@ /************************************************************************* * @brief isSCI1DMATransmitInProgress - * The isSCI2DMATransmitInProgress function determines whether a DMA transmit \n + * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI1 peripheral. * @details * Inputs : status registers @@ -264,7 +264,7 @@ /************************************************************************* * @brief isSCI2DMATransmitInProgress - * The isSCI2DMATransmitInProgress function determines whether a DMA transmit \n + * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI2 peripheral. * @details * Inputs : status registers @@ -281,7 +281,7 @@ /************************************************************************* * @brief isCAN1TransmitInProgress - * The isCAN1TransmitInProgress function determines whether a transmit \n + * The isCAN1TransmitInProgress function determines whether a transmit * is in progress on the CAN1 peripheral. * @details * Inputs : status registers Index: firmware/App/Drivers/InternalADC.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -101,7 +101,7 @@ /************************************************************************* * @brief adcNotification - * The adcNotification function handles an ADC conversion complete interrupt. \n + * The adcNotification function handles an ADC conversion complete interrupt. * All channel readings in the FIFO are retrieved. * @details * Inputs : ADC FIFO @@ -120,7 +120,7 @@ /************************************************************************* * @brief execInternalADC - * The execInternalADC function processes the last set of raw ADC channel \n + * 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[] @@ -158,7 +158,7 @@ /************************************************************************* * @brief getIntADCReading - * The getIntADCReading function gets the latest average reading for a given \n + * The getIntADCReading function gets the latest average reading for a given * channel. * @details * Inputs : adcReadingsAvgs[] Index: firmware/App/Drivers/SafetyShutdown.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -69,7 +69,7 @@ /*********************************************************************//** * @brief - * The isSafetyShutdownActivated function returns whether the safety shutdown \n + * The isSafetyShutdownActivated function returns whether the safety shutdown * signal has been activated. * @details * Inputs : none @@ -83,7 +83,7 @@ /*********************************************************************//** * @brief - * The testSetSafetyShutdownOverride function overrides the HD safety \n + * The testSetSafetyShutdownOverride function overrides the HD safety * shutdown. * @details * Inputs : none @@ -117,7 +117,7 @@ /*********************************************************************//** * @brief - * The testResetSafetyShutdownOverride function resets the override of the \n + * The testResetSafetyShutdownOverride function resets the override of the * HD safety shutdown. * @details * Inputs : none Index: firmware/App/Modes/Dialysis.c =================================================================== diff -u -rc6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision c6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2) +++ firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -77,8 +77,8 @@ /*********************************************************************//** * @brief - * The initDialysis function initializes the Dialysis sub-mode module. \n - * Calling this function will reset dialysis and therefore should only \n + * The initDialysis function initializes the Dialysis sub-mode module. + * Calling this function will reset dialysis and therefore should only * be called when a new treatment is due to begin. * @details * Inputs : none @@ -112,10 +112,10 @@ /*********************************************************************//** * @brief - * The transitionToDialysis function prepares for transition to dialysis sub-mode. \n - * This function will reset anything required for resuming dialysis in a \n - * treatment that has already begun. It does not reset everything as dialysis \n - * may be stopped and resumed multiple times due to alarms or user intervention \n + * The transitionToDialysis function prepares for transition to dialysis sub-mode. + * This function will reset anything required for resuming dialysis in a + * treatment that has already begun. It does not reset everything as dialysis + * may be stopped and resumed multiple times due to alarms or user intervention * and we don't want to start the treatment all over again. * @details * Inputs : none @@ -129,8 +129,8 @@ /*********************************************************************//** * @brief - * The setDialysisParams function sets the dialysis treatment parameters. \n - * This function should be called prior to beginning dialysis treatment \n + * The setDialysisParams function sets the dialysis treatment parameters. + * This function should be called prior to beginning dialysis treatment * and when the user changes one or more parameters during treatment. * @details * Inputs : none @@ -156,8 +156,8 @@ /*********************************************************************//** * @brief - * The startDialysis function starts/resumes dialysis. This function \n - * will be called by Treatment Mode when beginning or resuming dialysis \n + * The startDialysis function starts/resumes dialysis. This function + * will be called by Treatment Mode when beginning or resuming dialysis * treatment. * @details * Inputs : none @@ -176,8 +176,8 @@ /*********************************************************************//** * @brief - * The stopDialysis function stops dialysis. This function will be called \n - * by Treatment Mode when an alarm occurs or the user pressed the stop button. \n + * The stopDialysis function stops dialysis. This function will be called + * by Treatment Mode when an alarm occurs or the user pressed the stop button. * Dialysis may be resumed later. * @details * Inputs : none @@ -219,7 +219,7 @@ /*********************************************************************//** * @brief - * The getUltrafiltrationVolumeCollected function gets the current ultrafiltration \n + * The getUltrafiltrationVolumeCollected function gets the current ultrafiltration * volume collected so far for current treatment. * @details * Inputs : measUFVolume, measUFVolumeFromPriorReservoirs @@ -357,7 +357,7 @@ currentDialysisState = handleDialysisUltrafiltrationState(); break; - case DIALYSIS_SOLUTION_INFUSION_STATE: + case DIALYSIS_SALINE_BOLUS_STATE: currentDialysisState = handleDialysisSolutionInfusionState(); break; @@ -369,7 +369,7 @@ /*********************************************************************//** * @brief - * The handleDialysisUltrafiltrationState function handles the ultrafiltration \n + * The handleDialysisUltrafiltrationState function handles the ultrafiltration * state of the Dialysis state machine. * @details * Inputs : currentUFState @@ -412,7 +412,7 @@ /*********************************************************************//** * @brief - * The handleDialysisSolutionInfusionState function handles the solution \n + * The handleDialysisSolutionInfusionState function handles the solution * infustion state of the Dialysis state machine. * @details * Inputs : TBD @@ -421,7 +421,7 @@ *************************************************************************/ static DIALYSIS_STATE_T handleDialysisSolutionInfusionState( void ) { - DIALYSIS_STATE_T result = DIALYSIS_SOLUTION_INFUSION_STATE; + DIALYSIS_STATE_T result = DIALYSIS_SALINE_BOLUS_STATE; // TODO - @@ -430,7 +430,7 @@ /*********************************************************************//** * @brief - * The handleUFStartState function handles the Start state of the \n + * The handleUFStartState function handles the Start state of the * ultrafiltration state machine. * @details * Inputs : maxUFVolumeML @@ -458,7 +458,7 @@ /*********************************************************************//** * @brief - * The handleUFPausedState function handles the Paused state of the \n + * The handleUFPausedState function handles the Paused state of the * ultrafiltration state machine. * @details * Inputs : none @@ -484,11 +484,11 @@ /*********************************************************************//** * @brief - * The handleUFRunningState function handles the Running state of the \n + * The handleUFRunningState function handles the Running state of the * ultrafiltration state machine. * @details * Inputs : ms timer, lastUFTimeStamp - * Outputs : UF timer incremented, UF volumes updated and provided to DPo \n + * Outputs : UF timer incremented, UF volumes updated and provided to DPo * pump controller. * @return next ultrafiltration state. *************************************************************************/ @@ -526,7 +526,7 @@ /*********************************************************************//** * @brief - * The handleUFCompletedOrOffState function handles the UF Off state \n + * The handleUFCompletedOrOffState function handles the UF Off state * of the ultrafiltration state machine. * @details * Inputs : none @@ -545,7 +545,7 @@ /*********************************************************************//** * @brief - * The handleUFCompletedState function handles the UF Completed \n + * The handleUFCompletedState function handles the UF Completed * state of the ultrafiltration state machine. This is a terminal state. * @details * Inputs : none @@ -564,7 +564,7 @@ /*********************************************************************//** * @brief - * The checkUF function checks ultrafiltration accuracy for the last \n + * The checkUF function checks ultrafiltration accuracy for the last * minute and checks total UF volume. Triggers an alarm if out of spec. * @details * Inputs : uFAccuracyCheckTimerCtr, lastUFVolumeChecked, measUFVolume @@ -601,9 +601,9 @@ /*********************************************************************//** * @brief - * The updateUFVolumes function updates the ultrafiltration volumes based on \n - * set UF rate, latest UF elapsed time, and the latest load cell weight for the \n - * currently used reservoir. Updated UF volumes are then sent to the dialysate \n + * The updateUFVolumes function updates the ultrafiltration volumes based on + * set UF rate, latest UF elapsed time, and the latest load cell weight for the + * currently used reservoir. Updated UF volumes are then sent to the dialysate * outlet pump controller. * @details * Inputs : setUFRate, uFTimeMS, load cell weight @@ -633,8 +633,8 @@ /*********************************************************************//** * @brief - * The setStartReservoirVolume function updates the baseline volume of the \n - * next reservoir to be drawn from before it is switched to (i.e. while it \n + * The setStartReservoirVolume function updates the baseline volume of the + * next reservoir to be drawn from before it is switched to (i.e. while it * is the inactive reservoir) in order to get a more stable volume. * @details * Inputs : active reservoir, load cell reading from inactive reservoir @@ -665,8 +665,8 @@ /*********************************************************************//** * @brief - * The signalReservoirsSwitched function informs this module that the \n - * reservoirs have been switched. The UF volume from prior reservoirs is \n + * The signalReservoirsSwitched function informs this module that the + * reservoirs have been switched. The UF volume from prior reservoirs is * tentatively added to with a load cell reading of the inactive reservoir. * @details * Inputs : resFinalVolume[], resStartVolume[] @@ -684,8 +684,8 @@ /*********************************************************************//** * @brief - * The setFinalReservoirVolume function updates the UF volume from prior reservoirs \n - * with a more stable final reservoir volume of the prior reservoir after it's \n + * The setFinalReservoirVolume function updates the UF volume from prior reservoirs + * with a more stable final reservoir volume of the prior reservoir after it's * had a moment to settle. * @details * Inputs : active reservoir, load cell reading from inactive reservoir Index: firmware/App/Modes/ModeInitPOST.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -64,7 +64,7 @@ /************************************************************************* * @brief transitionToInitAndPOSTMode - * The transitionToInitAndPOSTMode function prepares for transition to\n + * The transitionToInitAndPOSTMode function prepares for transition to * initialize & POST mode. * @details * Inputs : none @@ -183,8 +183,8 @@ /************************************************************************* * @brief isPOSTCompleted - * The isPOSTCompleted function determines whether all HD POST have \n - * been run and completed. If true, call the isPOSTPassed() to see final \n + * 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 @@ -198,7 +198,7 @@ /************************************************************************* * @brief isPOSTPassed - * The isPOSTPassed function determines whether all HD POST have passed. \n + * The isPOSTPassed function determines whether all HD POST have passed. * Call this function after POST is complete (call isPOSTCompleted function). * @details * Inputs : postPassed Index: firmware/App/Modes/ModePostTreat.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModePostTreat.c (.../ModePostTreat.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Modes/ModePostTreat.c (.../ModePostTreat.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -50,7 +50,7 @@ /************************************************************************* * @brief transitionToPostTreatmentMode - * The transitionToPostTreatmentMode function prepares for transition to \n + * The transitionToPostTreatmentMode function prepares for transition to * post-treatment mode. * @details * Inputs : none Index: firmware/App/Modes/ModePreTreat.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -50,7 +50,7 @@ /************************************************************************* * @brief transitionToPreTreatmentMode - * The transitionToPreTreatmentMode function prepares for transition to \n + * The transitionToPreTreatmentMode function prepares for transition to * pre-treatment mode. * @details * Inputs : none Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -rc6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision c6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -288,7 +288,7 @@ /*********************************************************************//** * @brief - * The signalUserStartingTreatment function handles user initiation of a \n + * The signalUserStartingTreatment function handles user initiation of a * treatment. * @details * Inputs : none Index: firmware/App/Modes/ModeTreatment.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -246,7 +246,7 @@ /*********************************************************************//** * @brief - * The handleTreatmentStartState function handles the Start state of \n + * The handleTreatmentStartState function handles the Start state of * the Treatment Mode state machine. * @details * Inputs : none @@ -277,7 +277,7 @@ /*********************************************************************//** * @brief - * The handleTreatmentDialysisState function handles the Dialysis state of \n + * The handleTreatmentDialysisState function handles the Dialysis state of * the Treatment Mode state machine. * @details * Inputs : none @@ -318,7 +318,7 @@ /*********************************************************************//** * @brief - * The handleTreatmentStopState function executes the Stop state of the \n + * The handleTreatmentStopState function executes the Stop state of the * Treatment Mode state machine. * @details * Inputs : none @@ -354,7 +354,7 @@ /*********************************************************************//** * @brief - * The verifyTreatmentDurationSettingChange function verifies and responds to \n + * The verifyTreatmentDurationSettingChange function verifies and responds to * the user treatment duration setting change request. * @details * Inputs : current operating mode, treatment states and parameters @@ -433,7 +433,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsChange function verifies and responds to a new \n + * The verifyUFSettingsChange function verifies and responds to a new * ultrafiltration volume setting from the user. * @details * Inputs : current operating mode, treatment states and parameters @@ -536,7 +536,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsConfirmation function verifies the user confirmed \n + * The verifyUFSettingsConfirmation function verifies the user confirmed * ultrafiltration settings change(s) and, if valid, accepts the new settings. * @details * Inputs : current operating mode, treatment states and parameters @@ -600,7 +600,7 @@ /*********************************************************************//** * @brief - * The verifyBloodAndDialysateRateSettingsChange function verifies the \n + * The verifyBloodAndDialysateRateSettingsChange function verifies the * user blood & dialysate flow rate settings change. * @details * Inputs : current operating mode, treatment states and parameters @@ -660,7 +660,7 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentTimeAndState function broadcasts treatment time and \n + * The broadcastTreatmentTimeAndState function broadcasts treatment time and * state data during treatment. * @details * Inputs : treatment time and state data @@ -685,7 +685,7 @@ U32 timeRemaining = presTreatmentTimeSecs - elapsedTreatmentTimeInSecs; DIALYSIS_STATE_T dialysisState = getDialysisState(); UF_STATE_T uFState = getUltrafiltrationState(); - BOOL salineBolusInProgress = ( dialysisState == DIALYSIS_SOLUTION_INFUSION_STATE ? TRUE : FALSE ); + BOOL salineBolusInProgress = ( dialysisState == DIALYSIS_SALINE_BOLUS_STATE ? TRUE : FALSE ); broadcastTreatmentTime( presTreatmentTimeSecs, elapsedTreatmentTimeInSecs, timeRemaining ); broadcastTreatmentState( currentTreatmentState, uFState, salineBolusInProgress ); @@ -695,9 +695,9 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentSettingsRanges function computes and broadcasts \n - * updated treatment parameter ranges that the user may change during treatment. \n - * It is assumed that prescription settings have already been set prior to calling \n + * The broadcastTreatmentSettingsRanges function computes and broadcasts + * updated treatment parameter ranges that the user may change during treatment. + * It is assumed that prescription settings have already been set prior to calling * this function. * @details * Inputs : current operating mode, treatment states and parameters Index: firmware/App/Modes/ModeTreatmentParams.c =================================================================== diff -u -r07a352d02dc7e062dd5b6742891ac0b57679858c -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision 07a352d02dc7e062dd5b6742891ac0b57679858c) +++ firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -110,7 +110,7 @@ /*********************************************************************//** * @brief - * The transitionToOpParamsMode function prepares for transition to operating \n + * The transitionToOpParamsMode function prepares for transition to operating * parameters mode. * @details * Inputs : none @@ -134,7 +134,7 @@ /*********************************************************************//** * @brief - * The resetAllTreatmentParameters function resets treatment parameters \n + * The resetAllTreatmentParameters function resets treatment parameters * to default values. * @details * Inputs : none @@ -167,7 +167,7 @@ /*********************************************************************//** * @brief - * The signalUserConfirmationOfTreatmentParameters function sets the user \n + * The signalUserConfirmationOfTreatmentParameters function sets the user * confirmation flag signaling user has confirmed treatment parameters. * @details * Inputs : none @@ -189,7 +189,7 @@ /*********************************************************************//** * @brief - * The signalUserCancelTreatment function sets the cancelled treatment \n + * The signalUserCancelTreatment function sets the cancelled treatment * flag signaling the user has cancelled the treatment. * @details * Inputs : none @@ -257,7 +257,7 @@ /*********************************************************************//** * @brief - * The handleWaitForUI2SendState function handles the wait for UI to send \n + * The handleWaitForUI2SendState function handles the wait for UI to send * treatment parameters state of treatment parameters mode. * @details * Inputs : @@ -288,7 +288,7 @@ /*********************************************************************//** * @brief - * The handleWaitForUI2ConfirmState function handles the wait for UI to send \n + * The handleWaitForUI2ConfirmState function handles the wait for UI to send * user confirmation state of treatment parameters mode. * @details * Inputs : @@ -336,7 +336,7 @@ /*********************************************************************//** * @brief - * The validateAndSetTreatmentParameters function validates received \n + * The validateAndSetTreatmentParameters function validates received * treatment parameters. * @details * Inputs : none @@ -375,7 +375,7 @@ /*********************************************************************//** * @brief - * The checkTreatmentParamsInRange function checks whether received \n + * The checkTreatmentParamsInRange function checks whether received * treatment parameters are in range. * @details * Inputs : stagedParams[] @@ -405,7 +405,7 @@ /*********************************************************************//** * @brief - * The checkTreatmentParamsDependencies function checks dependencies between \n + * The checkTreatmentParamsDependencies function checks dependencies between * received treatment parameters. * @details * Inputs : stagedParams[] @@ -458,7 +458,7 @@ /*********************************************************************//** * @brief - * The isTreatmentParamInRange function determines whether a given treatment \n + * The isTreatmentParamInRange function determines whether a given treatment * parameter is in range. * @details * Inputs : treatParamsRanges[] @@ -504,8 +504,8 @@ /*********************************************************************//** * @brief - * The extractTreatmentParamsFromPayload function extracts the individual \n - * treatment parameters received from the UI into a staging array where \n + * The extractTreatmentParamsFromPayload function extracts the individual + * treatment parameters received from the UI into a staging array where * they will be validated and stay until user confirms them. * @details * Inputs : none @@ -537,7 +537,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterU32 function sets a given unsigned integer \n + * The setTreatmentParameterU32 function sets a given unsigned integer * treatment parameter to a given value. * @details * Inputs : treatmentParameters[] @@ -564,7 +564,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterS32 function sets a given signed integer treatment \n + * The setTreatmentParameterS32 function sets a given signed integer treatment * parameter to a given value. * @details * Inputs : treatmentParameters[] @@ -591,7 +591,7 @@ /*********************************************************************//** * @brief - * The setTreatmentParameterF32 sets a given floating point treatment parameter \n + * The setTreatmentParameterF32 sets a given floating point treatment parameter * to a given value. * @details * Inputs : treatmentParameters[] @@ -618,7 +618,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterU32 function gets the value of a given unsigned \n + * The getTreatmentParameterU32 function gets the value of a given unsigned * integer treatment parameter. * @details * Inputs : treatmentParameters[] @@ -647,7 +647,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterS32 function gets the value of a given signed \n + * The getTreatmentParameterS32 function gets the value of a given signed * integer treatment parameter. * @details * Inputs : treatmentParameters[] @@ -676,7 +676,7 @@ /*********************************************************************//** * @brief - * The getTreatmentParameterF32 function gets the value of a given floating point \n + * The getTreatmentParameterF32 function gets the value of a given floating point * treatment parameter. * @details * Inputs : treatmentParameters[] @@ -711,7 +711,7 @@ /************************************************************************* * @brief - * The testSetTreatmentParameterOverride function overrides the value of a \n + * The testSetTreatmentParameterOverride function overrides the value of a * given treatment parameter. * @details * Inputs : none Index: firmware/App/Modes/OperationModes.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -294,7 +294,7 @@ /************************************************************************* * @brief - * The broadcastOperationMode function sends the current operation mode at \n + * The broadcastOperationMode function sends the current operation mode at * the prescribed interval. * @details * Inputs : broadcastModeIntervalCtr Index: firmware/App/Modes/TreatmentStop.c =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -44,7 +44,7 @@ /*********************************************************************//** * @brief transitionToTreatmentStop - * The transitionToTreatmentStop function prepares for transition to treatment \n + * The transitionToTreatmentStop function prepares for transition to treatment * stop sub-mode. * @details * Inputs : none @@ -57,7 +57,7 @@ /*********************************************************************//** * @brief execTreatmentStop - * The execTreatmentStop function executes the Treatment Stop sub-mode \n + * The execTreatmentStop function executes the Treatment Stop sub-mode * state machine. * @details * Inputs : none Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -rc6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision c6f3b01d1b0a5e3fdf480a7ee205ca349e10d6d2) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -228,8 +228,8 @@ /************************************************************************* * @brief execAlarmMgmt - * The execAlarmMgmt function executes the alarm management functions to be \n - * done periodically. The composite alarm state is updated, alarm lamp and \n + * 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 : larmStatusTable[], alarmTable[] @@ -290,8 +290,8 @@ /************************************************************************* * @brief activateAlarmNoData - * The activateAlarmNoData function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n + * 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 @@ -324,8 +324,8 @@ /************************************************************************* * @brief activateAlarm1Data - * The activateAlarm1Data function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n + * 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 @@ -358,8 +358,8 @@ /************************************************************************* * @brief activateAlarm1Data - * The activateAlarm2Data function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n + * 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 @@ -393,7 +393,7 @@ /************************************************************************* * @brief clearAlarm - * The clearAlarm function clears a given alarm if it is recoverable. Also \n + * 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 @@ -442,7 +442,7 @@ /************************************************************************* * @brief isAlarmActive - * The isAlarmActive function determines whether a given alarm is currently \n + * The isAlarmActive function determines whether a given alarm is currently * active. * @details * Inputs : alarmIsActive[] @@ -470,7 +470,7 @@ /************************************************************************* * @brief updateAlarmsState - * The updateAlarmsState function updates the alarms state and alarm to \n + * The updateAlarmsState function updates the alarms state and alarm to * display. * @details * Inputs : alarmStatusTable[] @@ -509,7 +509,7 @@ /************************************************************************* * @brief setAlarmLampAndAudio - * The setAlarmLampAndAudio function sets the alarm lamp and audio patterns \n + * The setAlarmLampAndAudio function sets the alarm lamp and audio patterns * according to the current state of alarms. * @details * Inputs : none @@ -684,7 +684,7 @@ /************************************************************************* * @brief updateAlarmsFlags - * The updateAlarmsFlags function updates the alarms flags of the alarms \n + * The updateAlarmsFlags function updates the alarms flags of the alarms * status record. * @details * Inputs : none @@ -739,7 +739,7 @@ /************************************************************************* * @brief resetAlarmPriorityFIFO - * The resetAlarmPriorityFIFO function resets a FIFO for a given alarm \n + * The resetAlarmPriorityFIFO function resets a FIFO for a given alarm * priority. * @details * Inputs : none @@ -762,7 +762,7 @@ /************************************************************************* * @brief getPublishAlarmStatusInterval - * The getPublishAlarmStatusInterval function gets the alarm status \n + * The getPublishAlarmStatusInterval function gets the alarm status * publication interval. * @details * Inputs : alarmStatusPublishInterval @@ -781,7 +781,7 @@ /************************************************************************* * @brief testSetAlarmStatusPublishIntervalOverride - * The testSetAlarmStatusPublishIntervalOverride function overrides the \n + * The testSetAlarmStatusPublishIntervalOverride function overrides the * alarm status publish interval. * @details * Inputs : none @@ -807,7 +807,7 @@ /************************************************************************* * @brief testResetAlarmStatusPublishIntervalOverride - * The testResetAlarmStatusPublishIntervalOverride function resets the override \n + * The testResetAlarmStatusPublishIntervalOverride function resets the override * of the alarm status publish interval. * @details * Inputs : none @@ -830,8 +830,8 @@ /************************************************************************* * @brief - * The testSetAlarmStateOverride function overrides the state of the \n - * alarm active state for a given alarm with the alarm management with \n + * 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 @@ -865,7 +865,7 @@ /************************************************************************* * @brief - * The testResetAlarmStateOverride function resets the override of the \n + * The testResetAlarmStateOverride function resets the override of the * state of the active state for a given alarm with the alarm management. * @details * Inputs : none @@ -891,8 +891,8 @@ /************************************************************************* * @brief testSetAlarmStartOverride - * The testSetAlarmStartOverride function overrides the start time \n - * for a given alarm with the alarm management with a given start time. \n + * 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[] @@ -924,7 +924,7 @@ /************************************************************************* * @brief testResetAlarmStartOverride - * The testResetAlarmStartOverride function resets the override of the \n + * The testResetAlarmStartOverride function resets the override of the * start time for a given alarm with the alarm management. * @details * Inputs : none Index: firmware/App/Services/AlarmMgmt.h =================================================================== diff -u -re5e1cd8aacaae8e74f1baf80565f8d6253e6890d -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/AlarmMgmt.h (.../AlarmMgmt.h) (revision e5e1cd8aacaae8e74f1baf80565f8d6253e6890d) +++ firmware/App/Services/AlarmMgmt.h (.../AlarmMgmt.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -22,8 +22,8 @@ /** * @defgroup AlarmManagement AlarmManagement - * @brief Alarm Management service module. Provides general alarm management \n - * functionality including support functions for triggering and clearing \n + * @brief Alarm Management service module. Provides general alarm management + * functionality including support functions for triggering and clearing * specific alarms. * * @addtogroup AlarmManagement Index: firmware/App/Services/CommBuffers.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -62,8 +62,8 @@ /************************************************************************* * @brief - * The clearBuffer function clears (empties) a given buffer. \n - * Caller should ensure buffer won't be used while this function is clearing \n + * 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 @@ -94,10 +94,10 @@ /************************************************************************* * @brief - * The addToCommBuffer function adds data of specified length to a specified \n - * communication buffer. S/W fault if buffer too full to add data. \n - * This function will always add to the active double buffer. \n - * This function should only be called from the background, general, or \n + * The addToCommBuffer function adds data of specified length to a specified + * communication buffer. S/W fault if buffer too full to add data. + * 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[] @@ -191,16 +191,16 @@ /************************************************************************* * @brief - * The getFromCommBuffer function fills a given byte array with a given \n - * number of bytes from a given buffer and returns the number of bytes \n - * retrieved from the buffer. This function will draw from the inactive \n - * double buffer first and, if needed, switch double buffers to draw the \n + * The getFromCommBuffer function fills a given byte array with a given + * number of bytes from a given buffer and returns the number of bytes + * retrieved from the buffer. This function will draw from the inactive + * double buffer first and, if needed, switch double buffers to draw the * rest of the requested data. - * Only one function in one thread should be calling this function for a given \n + * Only one function in one thread should be calling this function for a given * buffer. * @details * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], \n + * 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 @@ -252,11 +252,11 @@ /************************************************************************* * @brief - * The peekFromCommBuffer function fills a given byte array with a given \n - * number of bytes from a given buffer. This function does NOT consume \n - * the bytes - it only peeks at them. A call to numberOfBytesInCommBuffer() \n - * should be made before calling this function to determine how many bytes \n - * are currently in the buffer. Do not call this function with a "len" \n + * The peekFromCommBuffer function fills a given byte array with a given + * number of bytes from a given buffer. This function does NOT consume + * the bytes - it only peeks at them. A call to numberOfBytesInCommBuffer() + * 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[] @@ -310,8 +310,8 @@ /************************************************************************* * @brief - * The numberOfBytesInCommBuffer function determines how many bytes \n - * are currently contained in a given comm buffer. Both double buffers \n + * 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[] @@ -341,9 +341,9 @@ /************************************************************************* * @brief - * The switchDoubleBuffer function switches the active and inactive buffers \n - * for the given buffer. \n - * This function should only be called when the current inactive buffer has \n + * The switchDoubleBuffer function switches the active and inactive buffers + * 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[] @@ -367,8 +367,8 @@ /************************************************************************* * @brief - * The getDataFromInactiveBuffer function retrieves a given number of bytes \n - * from the inactive buffer of a given buffer. This function should only be \n + * 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[] Index: firmware/App/Services/FPGA.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/FPGA.c (.../FPGA.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/FPGA.c (.../FPGA.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -377,7 +377,7 @@ /*********************************************************************//** * @brief - * The resetFPGACommFlags function resets the various fpga comm flags and \n + * The resetFPGACommFlags function resets the various fpga comm flags and * counters. * @details * Inputs : none @@ -397,7 +397,7 @@ /*********************************************************************//** * @brief - * The signalFPGAReceiptCompleted function increments a counter to indicate \n + * The signalFPGAReceiptCompleted function increments a counter to indicate * that another DMA receipt from the FPGA has completed. * @details * Inputs : none @@ -432,7 +432,7 @@ /*********************************************************************//** * @brief - * The signalFPGATransmitCompleted function increments a counter to indicate \n + * The signalFPGATransmitCompleted function increments a counter to indicate * that another DMA transmit to the FPGA has completed. * @details * Inputs : none @@ -551,7 +551,7 @@ /*********************************************************************//** * @brief - * The handleFPGAReadHeaderState function handles the FPGA state where \n + * The handleFPGAReadHeaderState function handles the FPGA state where * the read header registers command is sent to the FPGA. * @details * Inputs : none @@ -583,7 +583,7 @@ /*********************************************************************//** * @brief - * The handleFPGAReceiveHeaderState function handles the FPGA state \n + * The handleFPGAReceiveHeaderState function handles the FPGA state * where the header registers read response should be ready to take in. * @details * Inputs : none @@ -635,7 +635,7 @@ /*********************************************************************//** * @brief - * The handleFPGAWriteAllActuatorsState function handles the FPGA state \n + * The handleFPGAWriteAllActuatorsState function handles the FPGA state * where the bulk write command is sent to the FPGA. * @details * Inputs : actuator set points @@ -684,7 +684,7 @@ /*********************************************************************//** * @brief - * The handleFPGAReceiveAllSensorsState function handles the FPGA state \n + * The handleFPGAReceiveAllSensorsState function handles the FPGA state * where the bulk read response should be ready to parse. * @details * Inputs : none @@ -747,7 +747,7 @@ #ifdef READ_FPGA_ASYNC_DATA /*********************************************************************//** * @brief - * The handleFPGAReadAllSensorsAsyncState function handles the FPGA state where \n + * The handleFPGAReadAllSensorsAsyncState function handles the FPGA state where * the read async sensors command is sent to the FPGA. * @details * Inputs : none @@ -779,7 +779,7 @@ /*********************************************************************//** * @brief - * The handleFPGAReceiveAllSensorsAsyncState function handles the FPGA state \n + * The handleFPGAReceiveAllSensorsAsyncState function handles the FPGA state * where the bulk async read response should be ready to parse. * @details * Inputs : none @@ -832,7 +832,7 @@ /*********************************************************************//** * @brief - * The execFPGATest function executes the FPGA self-test. \n + * The execFPGATest function executes the FPGA self-test. * @details * Inputs : fpgaHeader * Outputs : none @@ -862,7 +862,7 @@ /*********************************************************************//** * @brief - * The setupDMAForWriteCmd function sets the byte count for the next DMA \n + * The setupDMAForWriteCmd function sets the byte count for the next DMA * write command to the FPGA. * @details * Inputs : none @@ -885,7 +885,7 @@ /*********************************************************************//** * @brief - * The startDMAWriteCmd function initiates the DMA transmit for the next \n + * The startDMAWriteCmd function initiates the DMA transmit for the next * DMA write command to the FPGA. * @details * Inputs : none @@ -901,7 +901,7 @@ /*********************************************************************//** * @brief - * The setupDMAForWriteResp function sets the expected byte count for the \n + * The setupDMAForWriteResp function sets the expected byte count for the * next DMA write command response from the FPGA. * @details * Inputs : none @@ -924,7 +924,7 @@ /*********************************************************************//** * @brief - * The startDMAReceiptOfWriteResp function initiates readiness of the DMA \n + * The startDMAReceiptOfWriteResp function initiates readiness of the DMA * receiver for the next DMA write command response from the FPGA. * @details * Inputs : none @@ -940,7 +940,7 @@ /*********************************************************************//** * @brief - * The setupDMAForReadCmd function sets the byte count for the next DMA \n + * The setupDMAForReadCmd function sets the byte count for the next DMA * read command to the FPGA. * @details * Inputs : none @@ -963,7 +963,7 @@ /*********************************************************************//** * @brief - * The startDMAReadCmd function initiates the DMA transmit for the next \n + * The startDMAReadCmd function initiates the DMA transmit for the next * DMA read command to the FPGA. * @details * Inputs : none @@ -979,7 +979,7 @@ /*********************************************************************//** * @brief - * The setupDMAForReadResp function sets the expected byte count for the \n + * The setupDMAForReadResp function sets the expected byte count for the * next DMA read command response from the FPGA. * @details * Inputs : none @@ -1002,7 +1002,7 @@ /*********************************************************************//** * @brief - * The startDMAReceiptOfReadResp function initiates readiness of the DMA \n + * The startDMAReceiptOfReadResp function initiates readiness of the DMA * receiver for the next DMA read command response from the FPGA. * @details * Inputs : none @@ -1034,7 +1034,7 @@ /*********************************************************************//** * @brief - * The getFPGABloodFlowSignalStrength function gets the latest blood flow \n + * The getFPGABloodFlowSignalStrength function gets the latest blood flow * signal strength reading. * @details * Inputs : fpgaSensorReadings2 @@ -1048,7 +1048,7 @@ /*********************************************************************//** * @brief - * The getFPGADialysateFlowSignalStrength function gets the latest dialysate \n + * The getFPGADialysateFlowSignalStrength function gets the latest dialysate * flow signal strength reading. * @details * Inputs : fpgaSensorReadings2 @@ -1088,10 +1088,10 @@ /*********************************************************************//** * @brief - * The getFPGABloodPumpHallSensorCount function gets the latest blood pump \n - * hall sensor count. Count is a 16 bit free running counter. If counter is \n - * counting up, indicates motor is running in forward direction. If counter is \n - * counting down, indicates motor is running in reverse direction. Counter will \n + * The getFPGABloodPumpHallSensorCount function gets the latest blood pump + * hall sensor count. Count is a 16 bit free running counter. If counter is + * 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 @@ -1105,10 +1105,10 @@ /*********************************************************************//** * @brief - * The getFPGABloodPumpHallSensorStatus function gets the latest blood pump \n - * hall sensor status. \n - * Bit 0 - Derived direction of the blood pump motor (0=Fwd, 1=Rev) \n - * Bit 1 - A direction error was detected in the current hall sensor phase \n + * The getFPGABloodPumpHallSensorStatus function gets the latest blood pump + * hall sensor status. + * 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 @@ -1122,10 +1122,10 @@ /*********************************************************************//** * @brief - * The getFPGADialInPumpHallSensorCount function gets the latest dialysate inlet pump \n - * hall sensor count. Count is a 16 bit free running counter. If counter is \n - * counting up, indicates motor is running in forward direction. If counter is \n - * counting down, indicates motor is running in reverse direction. Counter will \n + * The getFPGADialInPumpHallSensorCount function gets the latest dialysate inlet pump + * hall sensor count. Count is a 16 bit free running counter. If counter is + * 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 @@ -1139,10 +1139,10 @@ /*********************************************************************//** * @brief - * The getFPGADialInPumpHallSensorStatus function gets the latest dialysate inlet pump \n - * hall sensor status. \n - * Bit 0 - Derived direction of the dialyste inlet pump motor (0=Fwd, 1=Rev) \n - * Bit 1 - A direction error was detected in the current hall sensor phase \n + * The getFPGADialInPumpHallSensorStatus function gets the latest dialysate inlet pump + * hall sensor status. + * 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 @@ -1156,10 +1156,10 @@ /*********************************************************************//** * @brief - * The getFPGADialOutPumpHallSensorCount function gets the latest dialysate outlet pump \n - * hall sensor count. Count is a 16 bit free running counter. If counter is \n - * counting up, indicates motor is running in forward direction. If counter is \n - * counting down, indicates motor is running in reverse direction. Counter will \n + * The getFPGADialOutPumpHallSensorCount function gets the latest dialysate outlet pump + * hall sensor count. Count is a 16 bit free running counter. If counter is + * 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 @@ -1173,10 +1173,10 @@ /*********************************************************************//** * @brief - * The getFPGADialOutPumpHallSensorStatus function gets the latest dialysate outlet pump \n - * hall sensor status. \n - * Bit 0 - Derived direction of the dialysate outlet pump motor (0=Fwd, 1=Rev) \n - * Bit 1 - A direction error was detected in the current hall sensor phase \n + * The getFPGADialOutPumpHallSensorStatus function gets the latest dialysate outlet pump + * hall sensor status. + * 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 @@ -1203,7 +1203,7 @@ /*********************************************************************//** * @brief - * The getFPGADialInPumpOcclusion function gets the latest dialysate \n + * The getFPGADialInPumpOcclusion function gets the latest dialysate * inlet occlusion reading. * @details * Inputs : fpgaSensorReadings @@ -1217,7 +1217,7 @@ /*********************************************************************//** * @brief - * The getFPGADialOutPumpOcclusion function gets the latest dialysate \n + * The getFPGADialOutPumpOcclusion function gets the latest dialysate * outlet occlusion reading. * @details * Inputs : fpgaSensorReadings @@ -1258,7 +1258,7 @@ /*********************************************************************//** * @brief - * The getFPGAAccelAxes function gets the accelerometer axis readings. \n + * The getFPGAAccelAxes function gets the accelerometer axis readings. * Axis readings are in ADC counts. 0.004 g per LSB. * @details * Inputs : fpgaSensorReadings @@ -1277,8 +1277,8 @@ /*********************************************************************//** * @brief - * The getFPGAAccelMaxes function gets the maximum accelerometer axis readings. \n - * from last FPGA read (every 10ms). \n + * 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 @@ -1297,7 +1297,7 @@ /*********************************************************************//** * @brief - * The getFPGAAccelStatus function gets the accelerometer reading count \n + * The getFPGAAccelStatus function gets the accelerometer reading count * and error register values. * @details * Inputs : fpgaSensorReadings @@ -1355,7 +1355,7 @@ /*********************************************************************//** * @brief - * The consumeUnexpectedData function checks to see if a byte is sitting in \n + * The consumeUnexpectedData function checks to see if a byte is sitting in * the SCI2 received data register. * @details * Inputs : fpgaHeader Index: firmware/App/Services/Interrupts.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -168,9 +168,9 @@ * Inputs : none * 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 \n - * canLEVEL_WARNING (0x40) : When RX- or TX error counter are between 64 and 127 \n - * canLEVEL_BUS_OFF (0x80) : When RX- or TX error counter are between 128 and 255 \n + * @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 + * canLEVEL_BUS_OFF (0x80) : When RX- or TX error counter are between 128 and 255 * canLEVEL_PARITY_ERR (0x100): When parity error detected on CAN RAM read access * @return none *************************************************************************/ @@ -239,7 +239,7 @@ /*********************************************************************//** * @brief - * The sciNotification function handles UART communication error interrupts. \n + * The sciNotification function handles UART communication error interrupts. * Frame and Over-run errors are handled. * @details * Inputs : none Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -57,7 +57,7 @@ /************************************************************************* * @brief addToMsgQueue - * The addToMsgQueue function adds a message to a given message queue. \n + * The addToMsgQueue function adds a message to a given message queue. * This function should only be called from the General Task. * @details * Inputs : none @@ -98,13 +98,13 @@ /************************************************************************* * @brief getFromMsgQueue - * The getFromMsgQueue function retrieves the next message from a given \n + * 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 * @param queue the message queue to retrieve from - * @param msg a pointer to a message structure to populate with the retrieved \n + * @param msg a pointer to a message structure to populate with the retrieved * message. * @return TRUE if a message was found to retrieve, FALSE if not *************************************************************************/ Index: firmware/App/Services/SystemComm.c =================================================================== diff -u -r07a352d02dc7e062dd5b6742891ac0b57679858c -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 07a352d02dc7e062dd5b6742891ac0b57679858c) +++ firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -187,7 +187,7 @@ /*********************************************************************//** * @brief - * The checkInFromDG function checks in the DG with the HD - indicating that \n + * The checkInFromDG function checks in the DG with the HD - indicating that * the DG is communicating. * @details * Inputs : none @@ -202,7 +202,7 @@ /*********************************************************************//** * @brief - * The checkInFromUI function checks in the UI with the HD - indicating that \n + * The checkInFromUI function checks in the UI with the HD - indicating that * the UI is communicating. * @details * Inputs : none @@ -218,7 +218,7 @@ /*********************************************************************//** * @brief - * The isDGCommunicating function determines whether the DG is communicating \n + * The isDGCommunicating function determines whether the DG is communicating * with the HD. * @details * Inputs : dgIsCommunicating @@ -232,7 +232,7 @@ /*********************************************************************//** * @brief - * The isUICommunicating function determines whether the UI is communicating \n + * The isUICommunicating function determines whether the UI is communicating * with the HD. * @details * Inputs : uiIsCommunicating @@ -263,7 +263,7 @@ /*********************************************************************//** * @brief - * The isHDOnlyCANNode function determines whether the HD is the only node \n + * The isHDOnlyCANNode function determines whether the HD is the only node * currently on the CAN bus. * @details * Inputs : hdIsOnlyCANNode @@ -300,7 +300,7 @@ /*********************************************************************//** * @brief - * The execSystemCommTx function manages data to be transmitted to other \n + * The execSystemCommTx function manages data to be transmitted to other * sub-systems. * @details * Inputs : none @@ -369,9 +369,9 @@ /*********************************************************************//** * @brief - * The handleCANMsgInterrupt function handles a CAN message interrupt. \n - * This may have occurred because a CAN packet transmission has completed \n - * or because a CAN packet has been received. The appropriate handler is \n + * The handleCANMsgInterrupt function handles a CAN message interrupt. + * 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 @@ -420,7 +420,7 @@ /*********************************************************************//*** * @brief - * The handleUARTMsgRecvPacketInterrupt function handles a DMA UART receive \n + * The handleUARTMsgRecvPacketInterrupt function handles a DMA UART receive * packet completed interrupt. * @details * Inputs : none @@ -441,7 +441,7 @@ /*********************************************************************//** * @brief - * The handleUARTMsgXmitPacketInterrupt function handles a DMA UART transmit \n + * The handleUARTMsgXmitPacketInterrupt function handles a DMA UART transmit * packet completed interrupt. * @details * Inputs : none @@ -462,7 +462,7 @@ /*********************************************************************//** * @brief - * The initUARTAndDMA function initializes the SCI1 peripheral and the DMA \n + * The initUARTAndDMA function initializes the SCI1 peripheral and the DMA * to go with it for PC communication. * @details * Inputs : none @@ -528,7 +528,7 @@ /*********************************************************************//** * @brief - * The isCANBoxForXmit function determines whether a given CAN message box \n + * The isCANBoxForXmit function determines whether a given CAN message box * is configured for transmit. * @details * Inputs : CAN_OUT_BUFFERS[] @@ -555,7 +555,7 @@ /*********************************************************************//** * @brief - * The isCANBoxForRecv function determines whether a given CAN message box \n + * The isCANBoxForRecv function determines whether a given CAN message box * is configured for receiving. * @details * Inputs : MSG_IN_BUFFERS[] @@ -606,12 +606,12 @@ /*********************************************************************//** * @brief - * The findNextHighestPriorityCANPacketToTransmit function gets the next \n - * 8 byte packet and initiates a CAN transmit on the appropriate CAN channel. \n + * 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 - * @return buffer with highest priority CAN packet to transmit, \n + * @return buffer with highest priority CAN packet to transmit, * COMM_BUFFER_NOT_USED if not CAN packets pending transmit found *************************************************************************/ static COMM_BUFFER_T findNextHighestPriorityCANPacketToTransmit( void ) @@ -634,7 +634,7 @@ /*********************************************************************//** * @brief - * The transmitNextCANPacket function gets the next 8 byte packet and initiates \n + * 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 @@ -684,7 +684,7 @@ /*********************************************************************//** * @brief - * The transmitNextUARTPacket function sets up and initiates a DMA transmit \n + * 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) @@ -723,7 +723,7 @@ /*********************************************************************//** * @brief - * The processIncomingData function parses out messages from the Input \n + * The processIncomingData function parses out messages from the Input * Comm Buffers and adds them to the Received Message Queue. * @details * Inputs : Input Comm Buffers @@ -811,7 +811,7 @@ /*********************************************************************//** * @brief - * The consumeBufferPaddingBeforeSync function removes any bytes in a given \n + * The consumeBufferPaddingBeforeSync function removes any bytes in a given * buffer that lie before a sync byte. * @details * Inputs : none @@ -842,14 +842,14 @@ /*********************************************************************//** * @brief - * The parseMessageFromBuffer function looks for a complete message in a \n + * 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 * @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, \n + * @return size of message if found, zero if no complete message found, * -1 if message found but CRC fails. *************************************************************************/ static S32 parseMessageFromBuffer( U08 *data, U32 len ) @@ -894,7 +894,7 @@ /*********************************************************************//** * @brief - * The processReceivedMessages function processes any messages in the \n + * The processReceivedMessages function processes any messages in the * received message queues. * @details * Inputs : Received Message Queues @@ -944,7 +944,7 @@ /*********************************************************************//** * @brief - * The checkForCommTimeouts function checks for sub-system communication \n + * The checkForCommTimeouts function checks for sub-system communication * timeout errors. * @details * Inputs : timeOfLastDGCheckIn, timeOfLastUICheckIn @@ -968,8 +968,8 @@ /*********************************************************************//** * @brief - * The checkTooManyBadMsgCRCs function checks for too many bad message CRCs \n - * within a set period of time. Assumed function is being called when a new \n + * 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 @@ -995,8 +995,8 @@ /*********************************************************************//** * @brief - * The addMsgToPendingACKList function adds a given message to the pending \n - * ACK list. Messages in this list will require receipt of an ACK message \n + * 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[] @@ -1043,8 +1043,8 @@ /*********************************************************************//** * @brief - * The matchACKtoPendingACKList function searches the pending ACK list to \n - * see if the sequence # from a received ACK msg matches any. If found, \n + * 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[] @@ -1073,8 +1073,8 @@ /*********************************************************************//** * @brief - * The checkPendingACKList function searches the pending ACK list to \n - * see if any have expired. Any such messages will be queued for retransmission \n + * 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[] Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r07a352d02dc7e062dd5b6742891ac0b57679858c -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 07a352d02dc7e062dd5b6742891ac0b57679858c) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -59,10 +59,10 @@ /************************************************************************* * @brief serializeMessage - * The serializeMessage function serializes a given message into a given \n - * array of bytes. A sequence # is added to the message here and the ACK \n - * bit of the sequence # is set if ACK is required per parameter. A sync byte \n - * is inserted at the beginning of the message and an 8-bit CRC is appended to \n + * The serializeMessage function serializes a given message into a given + * array of bytes. A sequence # is added to the message here and the ACK + * 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 @@ -144,7 +144,7 @@ /************************************************************************* * @brief sendACKMsg - * The sendACKMsg function constructs and queues for transmit an ACK message \n + * The sendACKMsg function constructs and queues for transmit an ACK message * for a given received message. * @details * Inputs : none @@ -174,8 +174,8 @@ /************************************************************************* * @brief sendTestAckResponseMsg - * The sendTestAckResponseMsg function constructs a simple response \n - * message for a handled test message and queues it for transmit on the \n + * 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 @@ -208,7 +208,7 @@ /************************************************************************* * @brief sendOffButtonMsgToUI - * The sendOffButtonMsgToUI function constructs an off button msg to the UI \n + * 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 @@ -235,8 +235,8 @@ /************************************************************************* * @brief - * The sendChangeUFSettingsResponse function constructs a UF change settings \n - * response to the UI and queues the msg for transmit on the appropriate CAN \n + * 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 @@ -286,8 +286,8 @@ /************************************************************************* * @brief - * The sendChangeUFSettingsResponse function constructs a UF change settings \n - * option response to the UI and queues the msg for transmit on the appropriate CAN \n + * 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 @@ -328,8 +328,8 @@ /************************************************************************* * @brief - * The sendChangeTreatmentDurationResponse function constructs a treatment \n - * duration change response to the UI and queues the msg for transmit on the \n + * 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 @@ -367,8 +367,8 @@ /************************************************************************* * @brief - * The sendChangeBloodDialysateRateChangeResponse function constructs a change \n - * blood and dialysate rate settings response to the UI and queues the msg for \n + * 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 @@ -406,7 +406,7 @@ /************************************************************************* * @brief - * The sendTreatmentParamsRangesToUI function constructs a treatment parameter \n + * 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 @@ -450,7 +450,7 @@ /************************************************************************* * @brief - * The sendDialysateTempTargetsToDG function constructs a dialysate temperature \n + * 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 @@ -482,7 +482,7 @@ /************************************************************************* * @brief - * The sendDGSwitchReservoirCommand function constructs a DG set active \n + * 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 @@ -511,7 +511,7 @@ /************************************************************************* * @brief - * The sendDGFillCommand function constructs a DG fill command message \n + * The sendDGFillCommand function constructs a DG fill command message * and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -540,7 +540,7 @@ /************************************************************************* * @brief - * The sendDGDrainCommand function constructs a DG drain command message \n + * The sendDGDrainCommand function constructs a DG drain command message * and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -569,7 +569,7 @@ /************************************************************************* * @brief - * The sendDGStartStopCommand function constructs a DG start/stop command \n + * The sendDGStartStopCommand function constructs a DG start/stop command * message and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -598,8 +598,8 @@ /************************************************************************* * @brief - * The sendDGStartStopTrimmerHeaterCommand function constructs a DG start/stop \n - * trimmer heater command message and queues the msg for transmit on the \n + * 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 @@ -628,7 +628,7 @@ /************************************************************************* * @brief - * The sendDGSampleWaterCommand function constructs a DG sample water command \n + * The sendDGSampleWaterCommand function constructs a DG sample water command * message and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -653,7 +653,7 @@ /************************************************************************* * @brief - * The broadcastAccelData function constructs an accelerometer data msg to \n + * 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 @@ -700,7 +700,7 @@ /************************************************************************* * @brief broadcastAlarmStatus - * The broadcastAlarmStatus function constructs an alarm status msg to \n + * 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 @@ -744,7 +744,7 @@ /************************************************************************* * @brief broadcastAlarmTriggered - * The broadcastAlarmTriggered function constructs an alarm triggered msg to \n + * 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 @@ -779,7 +779,7 @@ /************************************************************************* * @brief broadcastAlarmCleared - * The broadcastAlarmCleared function constructs an alarm cleared msg to be \n + * 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 @@ -808,7 +808,7 @@ /************************************************************************* * @brief broadcastBloodFlowData - * The broadcastBloodFlowData function constructs a blood flow data msg to \n + * 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 @@ -852,7 +852,7 @@ /************************************************************************* * @brief broadcastDialInFlowData - * The broadcastDialInFlowData function constructs a dialysate flow data msg to \n + * 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 @@ -896,7 +896,7 @@ /************************************************************************* * @brief broadcastDialInFlowData - * The broadcastDialInFlowData function constructs a dialysate outlet flow data \n + * 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 @@ -925,7 +925,7 @@ /************************************************************************* * @brief broadcastPresOcclData - * The broadcastPresOcclData function constructs a pres/occl data msg to \n + * 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 @@ -965,7 +965,7 @@ /************************************************************************* * @brief broadcastRTCEpoch - * The broadcastRTCEpoch function constructs an epoch msg to \n + * The broadcastRTCEpoch function constructs an epoch msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -994,7 +994,7 @@ /************************************************************************* * @brief - * The broadcastTreatmentTime function constructs a treatment time msg to \n + * 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 @@ -1030,7 +1030,7 @@ /************************************************************************* * @brief - * The broadcastTreatmentState function constructs a treatment state msg to \n + * 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 @@ -1066,7 +1066,7 @@ /************************************************************************* * @brief - * The broadcastPowerOffWarning function constructs a power off warning msg to \n + * 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 @@ -1091,7 +1091,7 @@ /************************************************************************* * @brief - * The broadcastHDOperationMode function constructs an HD operation mode \n + * The broadcastHDOperationMode function constructs an HD operation mode * broadcast message and queues the msg for transmit on the appropriate CAN channel. * @details * Inputs : none @@ -1230,7 +1230,7 @@ /************************************************************************* * @brief handleOffButtonConfirmMsgFromUI - * The handleOffButtonConfirmMsgFromUI function handles a response to an \n + * The handleOffButtonConfirmMsgFromUI function handles a response to an * off button message to the UI. * @details * Inputs : none @@ -1251,7 +1251,7 @@ /************************************************************************* * @brief - * The handleLoadCellReadingsFromDG function handles a load cell readings \n + * The handleLoadCellReadingsFromDG function handles a load cell readings * broadcast message from the DG. * @details * Inputs : none @@ -1276,7 +1276,7 @@ /************************************************************************* * @brief - * The handleDGTemperatureData function handles a temperature readings \n + * The handleDGTemperatureData function handles a temperature readings * broadcast message from the DG. * @details * Inputs : none @@ -1299,7 +1299,7 @@ /************************************************************************* * @brief - * The handleROPumpData function handles an RO pump data broadcast \n + * The handleROPumpData function handles an RO pump data broadcast * message from the DG. * @details * Inputs : none @@ -1321,7 +1321,7 @@ /************************************************************************* * @brief - * The handleDrainPumpData function handles a drain pump broadcast \n + * The handleDrainPumpData function handles a drain pump broadcast * message from the DG. * @details * Inputs : none @@ -1343,7 +1343,7 @@ /************************************************************************* * @brief - * The handleDGPressuresData function handles a DG pressure sensor readings \n + * The handleDGPressuresData function handles a DG pressure sensor readings * broadcast message from the DG. * @details * Inputs : none @@ -1365,7 +1365,7 @@ /************************************************************************* * @brief - * The handleDGReservoirData function handles a reservoir data broadcast \n + * The handleDGReservoirData function handles a reservoir data broadcast * message from the DG. * @details * Inputs : none @@ -1387,7 +1387,7 @@ /************************************************************************* * @brief - * The handleUFPauseResumeRequest function handles a ultrafiltration pause \n + * The handleUFPauseResumeRequest function handles a ultrafiltration pause * or resume request message from the UI. * @details * Inputs : none @@ -1419,7 +1419,7 @@ /************************************************************************* * @brief - * The handleUIStartTreatmentMsg function handles a treatment start/cancel \n + * The handleUIStartTreatmentMsg function handles a treatment start/cancel * message from the UI. * @details * Inputs : none @@ -1456,7 +1456,7 @@ /************************************************************************* * @brief - * The handleTreatmentParametersFromUI function handles a treatment parameters \n + * The handleTreatmentParametersFromUI function handles a treatment parameters * set and validate request message from the UI. * @details * Inputs : none @@ -1485,7 +1485,7 @@ /************************************************************************* * @brief - * The handleUIUserConfirmTreatmentParameters function handles a user confirmation \n + * The handleUIUserConfirmTreatmentParameters function handles a user confirmation * of treatment parameters message from the UI. * @details * Inputs : none @@ -1507,7 +1507,7 @@ /************************************************************************* * @brief - * The sendTreatmentParametersResponseMsg function constructs a treatment parameters \n + * 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 @@ -1540,7 +1540,7 @@ /************************************************************************* * @brief - * The handleChangeUFSettingsRequest function handles a ultrafiltration \n + * The handleChangeUFSettingsRequest function handles a ultrafiltration * change settings request message from the UI. * @details * Inputs : none @@ -1566,7 +1566,7 @@ /************************************************************************* * @brief - * The handleChangeUFSettingsConfirmation function handles a ultrafiltration \n + * The handleChangeUFSettingsConfirmation function handles a ultrafiltration * change setting confirmation message from the UI. * @details * Inputs : none @@ -1592,7 +1592,7 @@ /************************************************************************* * @brief - * The handleChangeTreatmentDurationRequest function handles a treatment \n + * The handleChangeTreatmentDurationRequest function handles a treatment * duration setting change message from the UI. * @details * Inputs : none @@ -1618,7 +1618,7 @@ /************************************************************************* * @brief - * The handleChangeBloodDialysateRateChangeRequest function handles a blood \n + * The handleChangeBloodDialysateRateChangeRequest function handles a blood * and dialysate rate settings change message from the UI. * @details * Inputs : none @@ -1767,7 +1767,7 @@ /************************************************************************* * @brief isTestingActivated - * The isTestingActivated function determines whether a tester has successfully \n + * The isTestingActivated function determines whether a tester has successfully * logged in to activate testing functionality. * @details * Inputs : testerLoggedIn @@ -1781,8 +1781,8 @@ /************************************************************************* * @brief sendTestAckResponseMsg - * The sendTestAckResponseMsg function constructs a simple response \n - * message for a handled test message and queues it for transmit on the \n + * 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 @@ -1810,7 +1810,7 @@ /************************************************************************* * @brief handleTesterLogInRequest - * The handleTesterLogInRequest function handles a request to login as a \n + * The handleTesterLogInRequest function handles a request to login as a * tester. * @details * Inputs : none @@ -1836,44 +1836,108 @@ } /************************************************************************* - * @brief handleTestOffButtonStateOverrideRequest - * The handleTestOffButtonStateOverrideRequest function handles a request to \n + * @brief + * The handleTestOffButtonStateOverrideRequest function handles a request to * override the state of the off button. * @details * Inputs : none * Outputs : message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ -DATA_OVERRIDE_HANDLER_FUNC_U32( BUTTON_STATE_T, handleTestOffButtonStateOverrideRequest, testSetOffButtonStateOverride, testResetOffButtonStateOverride ) +void handleTestOffButtonStateOverrideRequest( MESSAGE_T *message ) +{ + TEST_OVERRIDE_PAYLOAD_T payload; + BOOL result = FALSE; + + // verify payload length + if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen ) + { + memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) ); + + if ( 0 == payload.reset ) + { + result = testSetOffButtonStateOverride( payload.state.u32 ); + } + else + { + result = testResetOffButtonStateOverride(); + } + } + + // respond to request + sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); +} /************************************************************************* - * @brief handleTestStopButtonStateOverrideRequest - * The handleTestStopButtonStateOverrideRequest function handles a request to \n + * @brief + * The handleTestStopButtonStateOverrideRequest function handles a request to * override the stop button state. * @details * Inputs : none * Outputs : message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ -DATA_OVERRIDE_HANDLER_FUNC_U32( BUTTON_STATE_T, handleTestStopButtonStateOverrideRequest, testSetStopButtonStateOverride, testResetStopButtonStateOverride ) +void handleTestStopButtonStateOverrideRequest( MESSAGE_T *message ) +{ + TEST_OVERRIDE_PAYLOAD_T payload; + BOOL result = 0; + + // verify payload length + if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen ) + { + memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) ); + if ( 0 == payload.reset ) + { + result = testSetStopButtonStateOverride( payload.state.u32 ); + } + else + { + result = testResetStopButtonStateOverride(); + } + } + + // respond to request + sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); +} -/************************************************************************* - * @brief handleTestAlarmLampPatternOverrideRequest - * The handleTestAlarmLampPatternOverrideRequest function handles a request to \n +/*********************************************************************//** + * @brief + * The handleTestAlarmLampPatternOverrideRequest function handles a request to * override the alarm lamp pattern. * @details * Inputs : none * Outputs : message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ -DATA_OVERRIDE_HANDLER_FUNC_U32( LAMP_PATTERN_T, handleTestAlarmLampPatternOverrideRequest, testSetCurrentLampPatternOverride, testResetCurrentLampPatternOverride ) +void handleTestAlarmLampPatternOverrideRequest( MESSAGE_T *message ) +{ + TEST_OVERRIDE_PAYLOAD_T payload; + BOOL result = 0; + + // verify payload length + if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen ) + { + memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) ); + if ( 0 == payload.reset ) + { + result = testSetCurrentLampPatternOverride( payload.state.u32 ); + } + else + { + result = testResetCurrentLampPatternOverride(); + } + } + + // respond to request + sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); +} /************************************************************************* * @brief handleTestWatchdogCheckInStateOverrideRequest - * The handleTestWatchdogCheckInStateOverrideRequest function handles a \n + * The handleTestWatchdogCheckInStateOverrideRequest function handles a * request to override the check-in status of a given task. * @details * Inputs : none @@ -1885,7 +1949,7 @@ /************************************************************************* * @brief handleTestAlarmStateOverrideRequest - * The handleTestAlarmStateOverrideRequest function handles a request to \n + * The handleTestAlarmStateOverrideRequest function handles a request to * override the active status of a given alarm. * @details * Inputs : none @@ -1897,7 +1961,7 @@ /************************************************************************* * @brief handleTestAlarmTimeOverrideRequest - * The handleTestAlarmTimeOverrideRequest function handles a request to \n + * The handleTestAlarmTimeOverrideRequest function handles a request to * override the time since activation of a given alarm. * @details * Inputs : none @@ -1909,7 +1973,7 @@ /************************************************************************* * @brief handleTestAlarmStatusBroadcastIntervalOverrideRequest - * The handleTestAlarmStatusBroadcastIntervalOverrideRequest function handles a request to \n + * The handleTestAlarmStatusBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for alarm status. * @details * Inputs : none @@ -1921,7 +1985,7 @@ /************************************************************************* * @brief handleTestBloodFlowSetPointOverrideRequest - * The handleTestBloodFlowSetPointOverrideRequest function handles a request to \n + * The handleTestBloodFlowSetPointOverrideRequest function handles a request to * override the set point for the blood flow rate (mL/min). * @details * Inputs : none @@ -1953,7 +2017,7 @@ /************************************************************************* * @brief handleTestBloodFlowMeasuredOverrideRequest - * The handleTestBloodFlowMeasuredOverrideRequest function handles a request to \n + * The handleTestBloodFlowMeasuredOverrideRequest function handles a request to * override the measured blood flow rate (mL/min). * @details * Inputs : none @@ -1965,7 +2029,7 @@ /************************************************************************* * @brief handleTestBloodPumpRotorMeasuredSpeedOverrideRequest - * The handleTestBloodPumpRotorMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestBloodPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump rotor speed (RPM). * @details * Inputs : none @@ -1977,7 +2041,7 @@ /************************************************************************* * @brief handleTestBloodPumpMeasuredSpeedOverrideRequest - * The handleTestBloodPumpMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestBloodPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump speed (RPM). * @details * Inputs : none @@ -1989,7 +2053,7 @@ /************************************************************************* * @brief handleTestBloodPumpMCMeasuredSpeedOverrideRequest - * The handleTestBloodPumpMCMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestBloodPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured blood pump motor controller speed (RPM). * @details * Inputs : none @@ -2001,7 +2065,7 @@ /************************************************************************* * @brief handleTestBloodPumpMCMeasuredCurrentOverrideRequest - * The handleTestBloodPumpMCMeasuredCurrentOverrideRequest function handles a request to \n + * The handleTestBloodPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured blood pump motor controller current (mA). * @details * Inputs : none @@ -2013,7 +2077,7 @@ /************************************************************************* * @brief handleTestBloodFlowBroadcastIntervalOverrideRequest - * The handleTestBloodFlowBroadcastIntervalOverrideRequest function handles a request to \n + * The handleTestBloodFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for blood flow data. * @details * Inputs : none @@ -2025,7 +2089,7 @@ /************************************************************************* * @brief handleTestDialInFlowSetPointOverrideRequest - * The handleTestDialInFlowSetPointOverrideRequest function handles a request to \n + * The handleTestDialInFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate inlet flow rate (mL/min). * @details * Inputs : none @@ -2057,7 +2121,7 @@ /************************************************************************* * @brief - * The handleTestDialOutFlowSetPointOverrideRequest function handles a request to \n + * The handleTestDialOutFlowSetPointOverrideRequest function handles a request to * override the set point for the dialysate outlet flow rate (mL/min). * @details * Inputs : none @@ -2089,7 +2153,7 @@ /************************************************************************* * @brief handleTestDialInFlowMeasuredOverrideRequest - * The handleTestDialInFlowMeasuredOverrideRequest function handles a request to \n + * The handleTestDialInFlowMeasuredOverrideRequest function handles a request to * override the measured dialysate inlet flow rate (mL/min). * @details * Inputs : none @@ -2101,7 +2165,7 @@ /************************************************************************* * @brief handleTestDialInPumpRotorMeasuredSpeedOverrideRequest - * The handleTestDialInPumpRotorMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestDialInPumpRotorMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump rotor speed (RPM). * @details * Inputs : none @@ -2113,7 +2177,7 @@ /************************************************************************* * @brief handleTestDialInPumpMeasuredSpeedOverrideRequest - * The handleTestDialInPumpMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestDialInPumpMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump speed (RPM). * @details * Inputs : none @@ -2125,7 +2189,7 @@ /************************************************************************* * @brief handleTestDialInPumpMCMeasuredSpeedOverrideRequest - * The handleTestDialInPumpMCMeasuredSpeedOverrideRequest function handles a request to \n + * The handleTestDialInPumpMCMeasuredSpeedOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller speed (RPM). * @details * Inputs : none @@ -2137,7 +2201,7 @@ /************************************************************************* * @brief handleTestDialInPumpMCMeasuredCurrentOverrideRequest - * The handleTestDialInPumpMCMeasuredCurrentOverrideRequest function handles a request to \n + * The handleTestDialInPumpMCMeasuredCurrentOverrideRequest function handles a request to * override the measured dialysate inlet pump motor controller current (mA). * @details * Inputs : none @@ -2149,7 +2213,7 @@ /************************************************************************* * @brief handleTestDialInFlowBroadcastIntervalOverrideRequest - * The handleTestDialInFlowBroadcastIntervalOverrideRequest function handles a request to \n + * The handleTestDialInFlowBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for dialysate inlet flow data. * @details * Inputs : none @@ -2161,7 +2225,7 @@ /************************************************************************* * @brief handleTestArterialPressureOverrideRequest - * The handleTestArterialPressureOverrideRequest function handles a request to \n + * The handleTestArterialPressureOverrideRequest function handles a request to * override the arterial pressure. * @details * Inputs : none @@ -2173,7 +2237,7 @@ /************************************************************************* * @brief handleTestVenousPressureOverrideRequest - * The handleTestVenousPressureOverrideRequest function handles a request to \n + * The handleTestVenousPressureOverrideRequest function handles a request to * override the venous pressure. * @details * Inputs : none @@ -2185,7 +2249,7 @@ /************************************************************************* * @brief handleTestBloodPumpOcclusionOverrideRequest - * The handleTestBloodPumpOcclusionOverrideRequest function handles a request to \n + * The handleTestBloodPumpOcclusionOverrideRequest function handles a request to * override the blood pump occlusion sensor. * @details * Inputs : none @@ -2197,7 +2261,7 @@ /************************************************************************* * @brief handleTestDialysateInletPumpOcclusionOverrideRequest - * The handleTestDialysateInletPumpOcclusionOverrideRequest function handles a request to \n + * The handleTestDialysateInletPumpOcclusionOverrideRequest function handles a request to * override the dialysate inlet pump occlusion sensor. * @details * Inputs : none @@ -2209,7 +2273,7 @@ /************************************************************************* * @brief handleTestDialysateOutletPumpOcclusionOverrideRequest - * The handleTestDialysateOutletPumpOcclusionOverrideRequest function handles a request to \n + * The handleTestDialysateOutletPumpOcclusionOverrideRequest function handles a request to * override the dialysate outlet pump occlusion sensor. * @details * Inputs : none @@ -2221,7 +2285,7 @@ /************************************************************************* * @brief handleTestPresOcclBroadcastIntervalOverrideRequest - * The handleTestPresOcclBroadcastIntervalOverrideRequest function handles a request to \n + * The handleTestPresOcclBroadcastIntervalOverrideRequest function handles a request to * override the broadcast interval for pressure/occlusion data. * @details * Inputs : none @@ -2264,7 +2328,7 @@ /************************************************************************* * @brief - * The handleTestDialOutFlowBroadcastIntervalOverrideRequest function handles \n + * The handleTestDialOutFlowBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for dialysate outlet pump data. * @details * Inputs : none @@ -2276,8 +2340,8 @@ /************************************************************************* * @brief - * The handleTestDialOutUFReferenceVolumeOverrideRequest function handles a \n - * request to override the ultrafiltration reference volume for the dialysate \n + * The handleTestDialOutUFReferenceVolumeOverrideRequest function handles a + * request to override the ultrafiltration reference volume for the dialysate * outlet pump. * @details * Inputs : none @@ -2289,8 +2353,8 @@ /************************************************************************* * @brief - * The handleTestDialOutUFMeasuredVolumeOverrideRequest function handles a \n - * request to override the ultrafiltration measured volume for the dialysate \n + * The handleTestDialOutUFMeasuredVolumeOverrideRequest function handles a + * request to override the ultrafiltration measured volume for the dialysate * outlet pump. * @details * Inputs : none @@ -2302,8 +2366,8 @@ /************************************************************************* * @brief - * The handleTestDialOutPumpMCMeasuredSpeedOverrideRequest function handles a \n - * request to override the measured motor controller speed for the dialysate \n + * The handleTestDialOutPumpMCMeasuredSpeedOverrideRequest function handles a + * request to override the measured motor controller speed for the dialysate * outlet pump. * @details * Inputs : none @@ -2315,8 +2379,8 @@ /************************************************************************* * @brief - * The handleTestDialOutPumpMCMeasuredCurrentOverrideRequest function handles a \n - * request to override the measured motor controller current for the dialysate \n + * The handleTestDialOutPumpMCMeasuredCurrentOverrideRequest function handles a + * request to override the measured motor controller current for the dialysate * outlet pump. * @details * Inputs : none @@ -2328,7 +2392,7 @@ /************************************************************************* * @brief - * The handleTestDialOutPumpMeasuredSpeedOverrideRequest function handles a \n + * The handleTestDialOutPumpMeasuredSpeedOverrideRequest function handles a * request to override the measured speed for the dialysate outlet pump. * @details * Inputs : none @@ -2340,7 +2404,7 @@ /************************************************************************* * @brief - * The handleTestDialOutPumpMeasuredRotorSpeedOverrideRequest function handles a \n + * The handleTestDialOutPumpMeasuredRotorSpeedOverrideRequest function handles a * request to override the measured rotor speed for the dialysate outlet pump. * @details * Inputs : none @@ -2352,7 +2416,7 @@ /************************************************************************* * @brief - * The handleTestDialOutLoadCellWeightOverrideRequest function handles a \n + * The handleTestDialOutLoadCellWeightOverrideRequest function handles a * request to override the measured load cell weight for the dialysate outlet pump. * @details * Inputs : none @@ -2364,7 +2428,7 @@ /************************************************************************* * @brief - * The handleTestHDSafetyShutdownOverrideRequest function handles a \n + * The handleTestHDSafetyShutdownOverrideRequest function handles a * request to override the safety shutdown signal. * @details * Inputs : none @@ -2376,7 +2440,7 @@ /************************************************************************* * @brief - * The handleTestHDAccelOverrideRequest function handles a request to \n + * The handleTestHDAccelOverrideRequest function handles a request to * override the measured accelerometer sensor readings. * @details * Inputs : none @@ -2388,7 +2452,7 @@ /************************************************************************* * @brief - * The handleTestHDAccelMaxOverrideRequest function handles a request to \n + * The handleTestHDAccelMaxOverrideRequest function handles a request to * override the measured accelerometer sensor maximum readings. * @details * Inputs : none @@ -2400,7 +2464,7 @@ /************************************************************************* * @brief - * The handleTestHDAccelBroadcastIntervalOverrideRequest function handles a \n + * The handleTestHDAccelBroadcastIntervalOverrideRequest function handles a * request to override the broadcast interval for accelerometer data messages. * @details * Inputs : none Index: firmware/App/Services/WatchdogMgmt.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -125,7 +125,7 @@ /************************************************************************* * @brief checkInWithWatchdogMgmt - * The checkInWithWatchdogMgmt function checks a given task in with the \n + * The checkInWithWatchdogMgmt function checks a given task in with the * watchdog mgmt. service. * @details * Inputs : none @@ -143,8 +143,8 @@ /************************************************************************* * @brief execWatchdogTest - * The execWatchdogTest function executes the watchdog test. \n - * This function should be called periodically until a pass or fail \n + * The execWatchdogTest function executes the watchdog test. + * This function should be called periodically until a pass or fail * result is returned. * @details * Inputs : @@ -289,9 +289,9 @@ /************************************************************************* * @brief testSetWatchdogTaskCheckInOverride and testResetWatchdogTaskCheckInOverride - * The testSetWatchdogTaskCheckInOverride function overrides the state of the \n - * task check-in with the watchdog management with a given check-in state. \n - * The testResetWatchdogTaskCheckInOverride function resets the override of the \n + * The testSetWatchdogTaskCheckInOverride function overrides the state of the + * task check-in with the watchdog management with a given check-in state. + * The testResetWatchdogTaskCheckInOverride function resets the override of the * state of the check-in with the watchdog management. * @details * Inputs : none Index: firmware/App/Tasks/TaskBG.c =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -23,46 +23,47 @@ #include "WatchdogMgmt.h" #include "TaskTimer.h" +/** + * @addtogroup TaskBackground + * @{ + */ + // ********** private definitions ********** -#define MAX_TIME_FOR_UI_TO_COMMUNICATE_MS 30000 // 30 seconds +#define MAX_TIME_FOR_UI_TO_COMMUNICATE_MS 30000 ///< Maximum time we wait for UI to communicate after power up (30 seconds). // ********** private data ********** -static U32 startUICommTimeout; -static BOOL uiIsCommunicating = FALSE; +static U32 startUICommTimeout; ///< Timer counter for UI to begin communicating. -/************************************************************************* - * @brief taskBackground +// ********** private function prototypes ********** + +/*********************************************************************//** + * @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. + * Outputs : Executive for watchdog mgmt. and non-volatile data services called. + * @return none *************************************************************************/ void taskBackground( void ) { - startUICommTimeout = getMSTimerCount(); + startUICommTimeout = getMSTimerCount(); + #ifndef _VECTORCAST_ // can't have infinite loop in unit test tool while ( 1 ) #endif { // wait for UI to come up after power up - if ( FALSE == uiIsCommunicating ) + if ( FALSE == uiCommunicated() ) { - if ( TRUE == uiCommunicated() ) +#ifndef SIMULATE_UI + if ( TRUE == didTimeout( startUICommTimeout, MAX_TIME_FOR_UI_TO_COMMUNICATE_MS ) ) { - uiIsCommunicating = TRUE; + activateAlarmNoData( ALARM_ID_UI_COMM_POST_FAILED ); } - else - { -#ifndef SIMULATE_UI - if ( TRUE == didTimeout( startUICommTimeout, MAX_TIME_FOR_UI_TO_COMMUNICATE_MS ) ) - { - activateAlarmNoData( ALARM_ID_UI_COMM_POST_FAILED ); - } #endif - } } // manage the watchdog @@ -72,4 +73,5 @@ execNVDataMgmt(); } } - + +/**@}*/ Index: firmware/App/Tasks/TaskBG.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskBG.h (.../TaskBG.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Tasks/TaskBG.h (.../TaskBG.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -18,8 +18,19 @@ #ifndef __TASK_BACKGROUND_H__ #define __TASK_BACKGROUND_H__ +/** + * @defgroup TaskBackground TaskBackground + * @brief The background task is an infinite loop running in the background + * called by main() after initialization. + * + * @addtogroup TaskBackground + * @{ + */ + // public function prototypes void taskBackground( void ); + +/**@}*/ #endif Index: firmware/App/Tasks/TaskGeneral.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -34,13 +34,18 @@ static BOOL lastUserPress = FALSE; #endif +/** + * @addtogroup TaskGeneral + * @{ + */ + // ********** private data ********** -/************************************************************************* - * @brief taskGeneral - * The taskGeneral function handles the scheduled General Task interrupt.\n - * Calls the executive functions for most monitors and controllers, the\n - * operation modes, the system communications, and alarms.\n +/*********************************************************************//** + * @brief + * 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. @@ -113,4 +118,5 @@ setCPLDLampGreen( PIN_SIGNAL_LOW ); #endif } - + +/**@}*/ Index: firmware/App/Tasks/TaskGeneral.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskGeneral.h (.../TaskGeneral.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Tasks/TaskGeneral.h (.../TaskGeneral.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -20,12 +20,23 @@ #include "HDCommon.h" +/** + * @defgroup TaskGeneral TaskGeneral + * @brief The general task is called by RTI interrupt every 50 ms and performs + * the bulk of sensor, actuator, mode, alarm & communication operations. + * + * @addtogroup TaskGeneral + * @{ + */ + // public definitions -#define TASK_GENERAL_INTERVAL (50) +#define TASK_GENERAL_INTERVAL (50) ///< General task timer interrupt interval (in ms). // public function prototypes void taskGeneral( void ); + +/**@}*/ #endif Index: firmware/App/Tasks/TaskPriority.c =================================================================== diff -u -r3ded5ffcbcade3f1da5d40c52936ab5f97fc6ec9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 3ded5ffcbcade3f1da5d40c52936ab5f97fc6ec9) +++ firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -27,13 +27,19 @@ #include "WatchdogMgmt.h" #include "TaskPriority.h" -/************************************************************************* - * @brief taskPriority +/** + * @addtogroup TaskPriority + * @{ + */ + +/*********************************************************************//** + * @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. + * Outputs : Executive for the FPGA, pumps, valves, and buttons called. + * @return none *************************************************************************/ void taskPriority( void ) { @@ -83,4 +89,5 @@ setCPLDLampRed( PIN_SIGNAL_LOW ); #endif } - + +/**@}*/ Index: firmware/App/Tasks/TaskPriority.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskPriority.h (.../TaskPriority.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Tasks/TaskPriority.h (.../TaskPriority.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -18,12 +18,24 @@ #ifndef __TASK_PRIORITY_H__ #define __TASK_PRIORITY_H__ +/** + * @defgroup TaskPriority TaskPriority + * @brief The priority task is called by RTI interrupt every 10 ms and performs + * high priority and/or more urgent sensor/actuator processing as well as the + * interface to the FPGA. + * + * @addtogroup TaskPriority + * @{ + */ + // public definitions -#define TASK_PRIORITY_INTERVAL (10) +#define TASK_PRIORITY_INTERVAL (10) ///< Priority task timer interrupt interval (in ms). // public function prototypes void taskPriority( void ); + +/**@}*/ #endif Index: firmware/App/Tasks/TaskTimer.c =================================================================== diff -u -r31c4bf94671f58375d2e1dbbbb37b37c6949e0c4 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision 31c4bf94671f58375d2e1dbbbb37b37c6949e0c4) +++ firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -20,14 +20,20 @@ #include "WatchdogMgmt.h" #include "Timers.h" -/************************************************************************* - * @brief taskTimer +/** + * @addtogroup TaskTimer + * @{ + */ + +/*********************************************************************//** + * @brief * 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. + * Outputs : Executive for Timers called. + * @return none *************************************************************************/ void taskTimer( void ) { @@ -47,5 +53,5 @@ setCPLDLampBlue( PIN_SIGNAL_LOW ); #endif } - - + +/**@}*/ Index: firmware/App/Tasks/TaskTimer.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Tasks/TaskTimer.h (.../TaskTimer.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Tasks/TaskTimer.h (.../TaskTimer.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -18,12 +18,23 @@ #ifndef __TASK_TIMER_H__ #define __TASK_TIMER_H__ +/** + * @defgroup TaskTimer TaskTimer + * @brief Timer task is called by RTI interrupt every 1 ms to update the + * ms timer counter. + * + * @addtogroup TaskTimer + * @{ + */ + // public definitions -#define TASK_TIMER_INTERVAL (1) +#define TASK_TIMER_INTERVAL (1) ///< Timer task timer interrupt interval (in ms). // public function prototypes void taskTimer( void ); - + +/**@}*/ + #endif