Index: firmware/App/Controllers/DrainPump.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -55,13 +55,13 @@ NUM_OF_DRAIN_PUMP_STATES ///< Number of drain pump states } DRAIN_PUMP_STATE_T; -/// Enumeration of drain pump self test states. +/// Enumeration of drain pump self-test states. typedef enum DrainPump_Self_Test_States { - DRAIN_PUMP_SELF_TEST_STATE_START = 0, ///< Drain pump self test start state - DRAIN_PUMP_TEST_STATE_IN_PROGRESS, ///< Drain pump self tests in progress state - DRAIN_PUMP_TEST_STATE_COMPLETE, ///< Drain pump self tests completed state - NUM_OF_DRAIN_PUMP_SELF_TEST_STATES ///< Number of drain pump self test states + DRAIN_PUMP_SELF_TEST_STATE_START = 0, ///< Drain pump self-test start state + DRAIN_PUMP_TEST_STATE_IN_PROGRESS, ///< Drain pump self-test in progress state + DRAIN_PUMP_TEST_STATE_COMPLETE, ///< Drain pump self-test completed state + NUM_OF_DRAIN_PUMP_SELF_TEST_STATES ///< Number of drain pump self-test states } DRAIN_PUMP_SELF_TEST_STATE_T; #define DRAIN_PUMP_ENABLE_SPI3_PORT_MASK 0x00000020 ///< CS5 - Out put GPIO for pump enable. @@ -88,8 +88,8 @@ static OVERRIDE_U32_T targetDrainPumpSpeed = { 0, 0, 0, 0 }; ///< Target drain pump speed. static U32 drainControlTimerCounter = 0; ///< Timer counter for control drain pump. -static DRAIN_PUMP_SELF_TEST_STATE_T drainPumpSelfTestState; ///< Current drain pump self test state. -static U32 drainPumpSelfTestTimerCount = 0; ///< Timer counter for drain pump self test. +static DRAIN_PUMP_SELF_TEST_STATE_T drainPumpSelfTestState; ///< Current drain pump self-test state. +static U32 drainPumpSelfTestTimerCount = 0; ///< Timer counter for drain pump self-test. // ********** private function prototypes ********** @@ -384,17 +384,17 @@ /*********************************************************************//** * @brief * The execDrainPumpTest function executes the state machine for the drain - * pump self test. + * pump self-test. * @details * Inputs : none * Outputs : none - * @return the current state of the drain pump self test. + * @return the current state of the drain pump self-test. *************************************************************************/ SELF_TEST_STATUS_T execDrainPumpTest( void ) { SELF_TEST_STATUS_T result = SELF_TEST_STATUS_FAILED; - // TODO - implement self test(s) + // TODO - implement self-test(s) return result; } Index: firmware/App/Controllers/Heaters.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -64,14 +64,14 @@ #define MINIMUM_TARGET_TEMPERATURE 10U ///< Minimum allowed target temperature for the heaters. #define MAXIMUM_TARGET_TEMPERATURE 90U ///< Maximum allowed target temperature for the heaters. -/// Heaters self test enums +/// Heaters self-test enums typedef enum heaters_self_test_states { - HEATERS_SELF_TEST_START = 0, ///< Heaters self test start state - HEATERS_SELF_TEST_SMALL_PRIMARY_AND_TRIMMER_HEATERS, ///< Heaters self test small primary and trimmer heaters state - HEATERS_SELF_TEST_MAIN_PRIMARY_HEATER, ///< Heaters self test start main primary state - HEATERS_SELF_TEST_COMPLETE, ///< Heaters self test complete state - NUM_OF_HEATERS_SELF_TEST_STATES ///< Number of heaters self test states + HEATERS_SELF_TEST_START = 0, ///< Heaters self-test start state + HEATERS_SELF_TEST_SMALL_PRIMARY_AND_TRIMMER_HEATERS, ///< Heaters self-test small primary and trimmer heaters state + HEATERS_SELF_TEST_MAIN_PRIMARY_HEATER, ///< Heaters self-test start main primary state + HEATERS_SELF_TEST_COMPLETE, ///< Heaters self-test complete state + NUM_OF_HEATERS_SELF_TEST_STATES ///< Number of heaters self-test states } HEATERS_SELF_TEST_STATES_T ; /// Primary heaters exec states @@ -100,8 +100,8 @@ // ********** private data ********** -static SELF_TEST_STATUS_T heatersSelfTestResult; ///< Heaters self test results. -static HEATERS_SELF_TEST_STATES_T heatersSelfTestState; ///< Heaters self test state. +static SELF_TEST_STATUS_T heatersSelfTestResult; ///< Heaters self-test results. +static HEATERS_SELF_TEST_STATES_T heatersSelfTestState; ///< Heaters self-test state. static PRIMARY_HEATERS_EXEC_STATES_T primaryHeatersExecState; ///< Primary heaters exec state. static TRIMMER_HEATER_EXEC_STATES_T trimmerHeaterExecState; ///< Trimmer heater exec state. @@ -119,7 +119,7 @@ static OVERRIDE_U32_T heatersDataPublishInterval = { HEATERS_DATA_PUBLISH_INTERVAL, HEATERS_DATA_PUBLISH_INTERVAL, 0, 0 }; ///< Heaters data publish time interval. -static U32 selfTestElapsedTime; ///< Self test elapsed time variable. +static U32 selfTestElapsedTime; ///< Self-test elapsed time variable. static BOOL hasStartPrimaryHeaterRequested; ///< Start primary heater request flag. static BOOL hasStartTrimmerHeaterRequested; ///< Start trimmer heater request flag. @@ -313,7 +313,7 @@ /*********************************************************************//** * @brief - * The execHeatersSelfTest function executes the heaters' self test state machine. + * The execHeatersSelfTest function executes the heaters' self-test state machine. * @details * Inputs : heatersSelfTestState * Outputs : heatersSelfTestState @@ -405,7 +405,7 @@ /*********************************************************************//** * @brief * The handleHeatersSelfTestStart function starts the small primary and - * the trimmer heaters for self test. + * the trimmer heaters for self-test. * @details * Inputs : heatersSelfTestResult, selfTestElapsedTime * Outputs : heatersSelfTestResult, selfTestElapsedTime Index: firmware/App/Controllers/Pressures.c =================================================================== diff -u -r7a7e7c48dbad306ba09bd86d8b2fbf2fb0399340 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Controllers/Pressures.c (.../Pressures.c) (revision 7a7e7c48dbad306ba09bd86d8b2fbf2fb0399340) +++ firmware/App/Controllers/Pressures.c (.../Pressures.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -52,13 +52,13 @@ NUM_OF_PRESSURE_STATES ///< Number of pressure monitor states } PRESSURE_STATE_T; -/// Defined states for the pressures self test state machine. +/// Defined states for the pressures self-test state machine. typedef enum Pressures_Self_Test_States { - PRESSURE_SELF_TEST_STATE_START = 0, ///< Self test start state - PRESSURE_TEST_STATE_IN_PROGRESS, ///< Self test in progress state - PRESSURE_TEST_STATE_COMPLETE, ///< Self test completed state - NUM_OF_PRESSURE_SELF_TEST_STATES ///< Number of pressure self test states + PRESSURE_SELF_TEST_STATE_START = 0, ///< Self-test start state + PRESSURE_TEST_STATE_IN_PROGRESS, ///< Self-test in progress state + PRESSURE_TEST_STATE_COMPLETE, ///< Self-test completed state + NUM_OF_PRESSURE_SELF_TEST_STATES ///< Number of pressure self-test states } PRESSURE_SELF_TEST_STATE_T; // ********** private data ********** @@ -73,8 +73,8 @@ static S32 measuredPressureReadingsSum[ NUM_OF_PRESSURE_SENSORS ]; ///< Raw pressure sensor sums for averaging. static U32 pressureFilterCounter = 0; ///< Used to schedule pressure sensor filtering. -static PRESSURE_SELF_TEST_STATE_T pressuresSelfTestState; ///< Current pressure self test state. -static SELF_TEST_STATUS_T pressuresSelfTestResult; ///< Self test result of the Pressures module. +static PRESSURE_SELF_TEST_STATE_T pressuresSelfTestState; ///< Current pressure self-test state. +static SELF_TEST_STATUS_T pressuresSelfTestResult; ///< Self-test result of the Pressures module. // ********** private function prototypes ********** @@ -343,7 +343,7 @@ /*********************************************************************//** * @brief - * The execPressureSelfTest function executes the pressures self test's state machine. + * The execPressureSelfTest function executes the pressures self-test's state machine. * @details * Inputs : pressuresSelfTestState * Outputs : pressuresSelfTestState @@ -364,7 +364,7 @@ break; case PRESSURE_TEST_STATE_COMPLETE: - // Done with self test + // Done with self-test break; default: @@ -382,7 +382,7 @@ * or equals zero, it will throw an alarm. * @details * Inputs : ADC reading for RO pump inlet pressure sensor - * Outputs : Performed ADC check self test. + * Outputs : Performed ADC check self-test. * @return result (SELF_TEST_STATUS_T) *************************************************************************/ static SELF_TEST_STATUS_T handleSelfTestADCCheck( void ) Index: firmware/App/Controllers/ROPump.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -70,13 +70,13 @@ NUM_OF_RO_PUMP_STATES ///< Number of RO pump states } RO_PUMP_STATE_T; -/// Enumeration of RO pump self test states. +/// Enumeration of RO pump self-test states. typedef enum ROPump_Self_Test_States { - RO_PUMP_SELF_TEST_STATE_START = 0, ///< RO pump self test start state - RO_PUMP_TEST_STATE_IN_PROGRESS, ///< RO pump self tests in progress state - RO_PUMP_TEST_STATE_COMPLETE, ///< RO pump self tests completed state - NUM_OF_RO_PUMP_SELF_TEST_STATES ///< Number of RO pump self test states + RO_PUMP_SELF_TEST_STATE_START = 0, ///< RO pump self-test start state + RO_PUMP_TEST_STATE_IN_PROGRESS, ///< RO pump self-tests in progress state + RO_PUMP_TEST_STATE_COMPLETE, ///< RO pump self-tests completed state + NUM_OF_RO_PUMP_SELF_TEST_STATES ///< Number of RO pump self-test states } RO_PUMP_SELF_TEST_STATE_T; // TODO - test code - remove later @@ -106,8 +106,8 @@ static U32 roControlTimerCounter = 0; ///< Timer counter for perform control on RO pump. -static RO_PUMP_SELF_TEST_STATE_T roPumpSelfTestState = RO_PUMP_SELF_TEST_STATE_START; ///< Current RO pump self test state. -static U32 roPumpSelfTestTimerCount = 0; ///< Timer counter for RO pump self test. +static RO_PUMP_SELF_TEST_STATE_T roPumpSelfTestState = RO_PUMP_SELF_TEST_STATE_START; ///< Current RO pump self-test state. +static U32 roPumpSelfTestTimerCount = 0; ///< Timer counter for RO pump self-test. // ********** private function prototypes ********** @@ -488,17 +488,17 @@ /*********************************************************************//** * @brief - * The execROPumpTest function executes the state machine for the ROPump self test. + * The execROPumpTest function executes the state machine for the ROPump self-test. * @details * Inputs : none * Outputs : none - * @return the current state of the ROPump self test. + * @return the current state of the ROPump self-test. *************************************************************************/ SELF_TEST_STATUS_T execROPumpTest( void ) { SELF_TEST_STATUS_T result = SELF_TEST_STATUS_FAILED; - // TODO - implement self test(s) + // TODO - implement self-test(s) return result; } Index: firmware/App/Controllers/TemperatureSensors.c =================================================================== diff -u -r3e5c98eae83ce4efe2b36031d4e920bbf71fd098 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Controllers/TemperatureSensors.c (.../TemperatureSensors.c) (revision 3e5c98eae83ce4efe2b36031d4e920bbf71fd098) +++ firmware/App/Controllers/TemperatureSensors.c (.../TemperatureSensors.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -75,14 +75,14 @@ #define MAX_TEMPERATURE_SENSOR_FAILURES 10 ///< Maximum number of temperature sensor errors within window period before alarm. #define MAX_TEMPERATURE_SENSOR_FAILURE_WINDOW_MS (10 * MS_PER_SECOND) ///< Temperature sensor error window. -/// Temperature sensor self test states. +/// Temperature sensor self-test states. typedef enum tempSensors_Self_Test_States { - TEMPSENSORS_SELF_TEST_START = 0, ///< Temperature sensors self test start + TEMPSENSORS_SELF_TEST_START = 0, ///< Temperature sensors self-test start TEMPSENSORS_SELF_TEST_ADC_CHECK, ///< Temperature sensors self ADC check - TEMPSENSORS_SELF_TEST_CONSISTENCY_CHECK, ///< Temperature sensors self test consistency check - TEMPSENSORS_SELF_TEST_COMPLETE, ///< Temperature sensors self test complete - NUM_OF_TEMPSENSORS_SELF_TEST_STATES ///< Total number of self test states + TEMPSENSORS_SELF_TEST_CONSISTENCY_CHECK, ///< Temperature sensors self-test consistency check + TEMPSENSORS_SELF_TEST_COMPLETE, ///< Temperature sensors self-test complete + NUM_OF_TEMPSENSORS_SELF_TEST_STATES ///< Total number of self-test states } TEMPSENSORS_SELF_TEST_STATES_T; /// Temperature sensor exec states. @@ -113,8 +113,8 @@ // ********** private data ********** -static SELF_TEST_STATUS_T tempSensorsSelfTestResult; ///< Self test result of the TemperatureSensors module. -static TEMPSENSORS_SELF_TEST_STATES_T tempSensorsSelfTestState; ///< TemperatureSensor self test state. +static SELF_TEST_STATUS_T tempSensorsSelfTestResult; ///< Self-test result of the TemperatureSensors module. +static TEMPSENSORS_SELF_TEST_STATES_T tempSensorsSelfTestState; ///< TemperatureSensor self-test state. static TEMPSENSORS_EXEC_STATES_T tempSensorsExecState; ///< TemperatureSensor exec state. static TEMP_SENSOR_T tempSensors [ NUM_OF_TEMPERATURE_SENSORS ]; ///< Temperature sensors' data structure. @@ -246,7 +246,7 @@ /*********************************************************************//** * @brief * The execTemperatureSensorsSelfTest function runs the TemperatureSensors - * POST during the self test + * POST during the self-test. * @details * Inputs : tempSensorsSelfTestState * Outputs : tempSensorsSelfTestState @@ -269,7 +269,7 @@ break; case TEMPSENSORS_SELF_TEST_COMPLETE: - // Done with self test, do nothing + // Done with self-test, do nothing break; default: @@ -596,7 +596,7 @@ /*********************************************************************//** * @brief - * The handleSelfTestStart function transitions the self test state to check ADC. + * The handleSelfTestStart function transitions the self-test state to check ADC. * @details * Inputs : tempSensorsSelfTestResult * Outputs : none Index: firmware/App/Modes/ModeRecirculate.h =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Modes/ModeRecirculate.h (.../ModeRecirculate.h) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeRecirculate.h (.../ModeRecirculate.h) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -34,8 +34,8 @@ // ********** public function prototypes ********** void initRecirculateMode( void ); // initialize this module -void transitionToRecirculateMode( void ); // prepares for transition to recirculate mode -U32 execRecirculateMode( void ); // execute the recirculate mode state machine (call from OperationModes) +void transitionToRecirculateMode( void ); // prepares for transition to re-circulate mode +U32 execRecirculateMode( void ); // execute the re-circulate mode state machine (call from OperationModes) DG_RECIRCULATE_MODE_STATE_T getCurrentRecirculateState( void ); // get the current state of re-circulate mode Index: firmware/App/Services/WatchdogMgmt.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r748fbe2e4347126645d229f9dfed45de55526ef7 --- firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 748fbe2e4347126645d229f9dfed45de55526ef7) @@ -34,11 +34,11 @@ /// List of watchdog states. typedef enum Button_Self_Test_States { - WATCHDOG_SELF_TEST_STATE_START = 0, ///< Watchdog self test state start - WATCHDOG_SELF_TEST_STATE_IN_PROGRESS, ///< watchdog self test state in progress - WATCHDOG_SELF_TEST_STATE_RECOVER, ///< Watchdog self test state recover - WATCHDOG_SELF_TEST_STATE_COMPLETE, ///< Watchdog self test state complete - NUM_OF_WATCHDOG_SELF_TEST_STATES ///< Number of watchdog self test states + WATCHDOG_SELF_TEST_STATE_START = 0, ///< Watchdog self-test state start + WATCHDOG_SELF_TEST_STATE_IN_PROGRESS, ///< watchdog self-test state in progress + WATCHDOG_SELF_TEST_STATE_RECOVER, ///< Watchdog self-test state recover + WATCHDOG_SELF_TEST_STATE_COMPLETE, ///< Watchdog self-test state complete + NUM_OF_WATCHDOG_SELF_TEST_STATES ///< Number of watchdog self-test states } WATCHDOG_SELF_TEST_STATE_T; // ********** private data ********** @@ -47,9 +47,9 @@ static OVERRIDE_U32_T watchdogTaskCheckedIn[ NUM_OF_TASKS ]; ///< Array of flags indicating whether individual tasks have checked in with watchdog manager. -static WATCHDOG_SELF_TEST_STATE_T watchdogSelfTestState; ///< Watchdog self test current state. -static SELF_TEST_STATUS_T watchdogSelfTestStatus; ///< Watchdog self test status. -static U32 watchdogSelfTestTimerCount = 0; ///< Watchdog self test timer count. +static WATCHDOG_SELF_TEST_STATE_T watchdogSelfTestState; ///< Watchdog self-test current state. +static SELF_TEST_STATUS_T watchdogSelfTestStatus; ///< Watchdog self-test status. +static U32 watchdogSelfTestTimerCount = 0; ///< Watchdog self-test timer count. // ********** private function prototypes ********** @@ -146,7 +146,7 @@ * should be called periodically until a pass or fail result is returned. * @details * Inputs : watchdogSelfTestState - * Outputs : Executed watchdog self test + * Outputs : Executed watchdog self-test * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execWatchdogTest( void ) @@ -187,7 +187,7 @@ break; case WATCHDOG_SELF_TEST_STATE_COMPLETE: - // if we get called in this state, assume we're doing self test again + // if we get called in this state, assume we're doing self-test again watchdogSelfTestStatus = SELF_TEST_STATUS_IN_PROGRESS; watchdogSelfTestState = WATCHDOG_SELF_TEST_STATE_START; break;