Index: firmware/App/Controllers/ConductivitySensors.c =================================================================== diff -u -r3e5c98eae83ce4efe2b36031d4e920bbf71fd098 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/ConductivitySensors.c (.../ConductivitySensors.c) (revision 3e5c98eae83ce4efe2b36031d4e920bbf71fd098) +++ firmware/App/Controllers/ConductivitySensors.c (.../ConductivitySensors.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -79,9 +79,8 @@ /*********************************************************************//** * @brief * The initConductivitySensors function initializes the ConductivitySensors module. - * @details - * Inputs : none - * Outputs : ConductivitySensors module initialized + * @details Inputs: none + * @details Outputs: ConductivitySensors module initialized * @return none *************************************************************************/ void initConductivitySensors( void ) @@ -115,9 +114,8 @@ * @brief * The execConductivitySensors function gets conductivity sensors' latest * readings from FPGA and advertises them over CAN. - * @details - * Inputs : none - * Outputs : Conductivity sensors' latest reading is updated and advertised. + * @details Inputs: none + * @details Outputs: Conductivity sensors' latest reading is updated and advertised. * @return none *************************************************************************/ void execConductivitySensors( void ) @@ -139,9 +137,8 @@ * @brief * The checkInletWaterConductivity checks inlet water conductivity value * and triggers an alarm when conductivity value is out of allowed range. - * @details - * Inputs : CPi sensor conductivity - * Outputs : Trigger alarms when conductivity is out of allowed range + * @details Inputs: CPi sensor conductivity + * @details Outputs: Trigger alarms when conductivity is out of allowed range * @return none *************************************************************************/ void checkInletWaterConductivity( void ) @@ -159,9 +156,8 @@ * The checkRORejectionRatio checks RO rejection ratio and outlet water * conductivity. The function triggers an alarm when RO rejection ratio or * outlet water conductivity is out of allowed range for period of time. - * @details - * Inputs : roRejectionRatio, CPo sensor conductivity - * Outputs : Triggered alarm + * @details Inputs: roRejectionRatio, CPo sensor conductivity + * @details Outputs: Triggered alarm * @return none *************************************************************************/ void checkRORejectionRatio( void ) @@ -175,9 +171,8 @@ * @brief * The getConductivityValue function gets the compensated conductivity * value for a given conductivity sensor id. - * @details - * Inputs : compensatedConductivityValues[] - * Outputs : none + * @details Inputs: compensatedConductivityValues[] + * @details Outputs: none * @param sensorId conductivity sensor id * @return compensated conductivity *************************************************************************/ @@ -209,9 +204,8 @@ * The calcCompensatedConductivity function calculates the compensated * conductivity based on given temperature and conductivity taken at * reference temperature of 25 Celcius. - * @details - * Inputs : conductivity, temperature - * Outputs : none + * @details Inputs: conductivity, temperature + * @details Outputs: none * @param conductivity conductivity value * @param temperature temperature to compensate conductivity with * @return compensated conductivity based on temperature @@ -228,9 +222,8 @@ * @brief * The calcRORejectionRatio function calculates the RO rejection ratio using * the CPi sensor conductivity value and CPo sensor conductivity value. - * @details - * Inputs: CPi sensor conductivity, CPo sensor conductivity - * Outputs: RO rejection ratio + * @details Inputs: CPi sensor conductivity, CPo sensor conductivity + * @details Outputs: RO rejection ratio * @return none *************************************************************************/ static void calcRORejectionRatio( void ) @@ -250,9 +243,8 @@ * The processCPiCPoSensorRead function checks if there is an error in FPGA * and FPGA read count. If there is any error in the FPGA error, it raises an * alarm. If the read count has changed, the new reading will be processed. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param sensorId Conductivity sensor id to process * @param fgpaRead FPGA conductivity reading value * @param fpgaReadCount FPGA read count @@ -294,9 +286,8 @@ * @brief * The getConductivityDataPublishInterval function gets the conductivity * data publication interval. - * @details - * Inputs : conductivityDataPublishInterval - * Outputs : none + * @details Inputs: conductivityDataPublishInterval + * @details Outputs: none * @return the current conductivity data publication interval (in ms/task interval). *************************************************************************/ static U32 getConductivityDataPublishInterval( void ) @@ -321,9 +312,8 @@ * @brief * The testSetConductivityOverride function overrides the compensated * conductivity value of given sensor id. - * @details - * Inputs : compensatedConductivityValues[] - * Outputs : compensatedConductivityValues[] + * @details Inputs: compensatedConductivityValues[] + * @details Outputs: compensatedConductivityValues[] * @param sensorId conductivity sensor id * @param value override compensated conductivity value * @return TRUE if override successful, FALSE if not @@ -349,9 +339,8 @@ * @brief * The testResetConductivityOverride function resets the override of the \n * conductivity sensor value. - * @details - * Inputs : compensatedConductivityValues[] - * Outputs : compensatedConductivityValues[] + * @details Inputs: compensatedConductivityValues[] + * @details Outputs: compensatedConductivityValues[] * @param sensorId conductivity sensor id * @return TRUE if reset successful, FALSE if not *************************************************************************/ @@ -376,9 +365,8 @@ * @brief * The testSetConductivityDataPublishIntervalOverride function overrides * the conductivity data publish interval. - * @details - * Inputs : conductivityDataPublishInterval - * Outputs : conductivityDataPublishInterval + * @details Inputs: conductivityDataPublishInterval + * @details Outputs: conductivityDataPublishInterval * @param value override conductivity data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -400,9 +388,8 @@ * @brief * The testResetConductivityDataPublishIntervalOverride function resets * the override of the conductivity data publish interval. - * @details - * Inputs : conductivityDataPublishInterval - * Outputs : conductivityDataPublishInterval + * @details Inputs: conductivityDataPublishInterval + * @details Outputs: conductivityDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetConductivityDataPublishIntervalOverride( void ) Index: firmware/App/Controllers/DrainPump.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -102,9 +102,8 @@ /*********************************************************************//** * @brief * The initDrainPump function initializes the DrainPump module. - * @details - * Inputs : none - * Outputs : DrainPump module initialized. + * @details Inputs: none + * @details Outputs: DrainPump module initialized. * @return none *************************************************************************/ void initDrainPump( void ) @@ -115,9 +114,8 @@ /*********************************************************************//** * @brief * The setDrainPumpTargetSpeed function sets a new target speed for the drain pump. - * @details - * Inputs : none - * Outputs : targetDrainPumpPressure + * @details Inputs: none + * @details Outputs: targetDrainPumpPressure * @param rpm new target drain pump speed (in RPM) * @return TRUE if new target speed is set, FALSE if not *************************************************************************/ @@ -144,9 +142,8 @@ /*********************************************************************//** * @brief * The signalDrainPumpHardStop function stops the Drain pump immediately. - * @details - * Inputs : none - * Outputs : Drain pump stopped, set point reset, state changed to off + * @details Inputs: none + * @details Outputs: Drain pump stopped, set point reset, state changed to off * @return none *************************************************************************/ void signalDrainPumpHardStop( void ) @@ -160,9 +157,8 @@ /*********************************************************************//** * @brief * The execDrainPumpMonitor function executes the drain pump monitor. - * @details - * Inputs : none - * Outputs : publish drain pump data + * @details Inputs: none + * @details Outputs: publish drain pump data * @return none *************************************************************************/ void execDrainPumpMonitor( void ) @@ -180,9 +176,8 @@ /*********************************************************************//** * @brief * The execDrainPumpController function executes the drain pump controller. - * @details - * Inputs : drainPumpState - * Outputs : drainPumpState + * @details Inputs: drainPumpState + * @details Outputs: drainPumpState * @return none *************************************************************************/ void execDrainPumpController( void ) @@ -208,9 +203,8 @@ * @brief * The handleDrainPumpOffState function handles the drain pump off state of * the drain pump controller state machine. - * @details - * Inputs : targetDrainPumpSpeed - * Outputs : drainPumpPWMDutyCyclePctSet, isDrainPumpOn + * @details Inputs: targetDrainPumpSpeed + * @details Outputs: drainPumpPWMDutyCyclePctSet, isDrainPumpOn * @return next state *************************************************************************/ static DRAIN_PUMP_STATE_T handleDrainPumpOffState( void ) @@ -256,9 +250,8 @@ * @brief * The handleDrainPumpControlToTargetState function handles the "control to * target" state of the drain pump controller state machine. - * @details - * Inputs : none - * Outputs : drainPumpState + * @details Inputs: none + * @details Outputs: drainPumpState * @return next state *************************************************************************/ static DRAIN_PUMP_STATE_T handleDrainPumpControlToTargetState( void ) @@ -306,9 +299,8 @@ /*********************************************************************//** * @brief * The stopDrainPump function sets the drain pump DAC to zero. - * @details - * Inputs : none - * Outputs : isDrainPumpOn, DAC zeroed, clear drain pump enable + * @details Inputs: none + * @details Outputs: isDrainPumpOn, DAC zeroed, clear drain pump enable * @return none *************************************************************************/ static void stopDrainPump( void ) @@ -324,9 +316,8 @@ * @brief * The getPublishDrainPumpDataInterval function gets the drain pump data * publication interval. - * @details - * Inputs : drainPumpDataPublishInterval - * Outputs : none + * @details Inputs: drainPumpDataPublishInterval + * @details Outputs: none * @return the current drain pump data publication interval (in ms). *************************************************************************/ static U32 getPublishDrainPumpDataInterval( void ) @@ -345,9 +336,8 @@ * @brief * The getTargetDrainPumpSpeed function gets the current target drain pump * speed. - * @details - * Inputs : targetDrainPumpSpeed - * Outputs : none + * @details Inputs: targetDrainPumpSpeed + * @details Outputs: none * @return the current target drain pump speed. *************************************************************************/ U32 getTargetDrainPumpSpeed( void ) @@ -365,9 +355,8 @@ /*********************************************************************//** * @brief * The publishDrainPumpData function publishes drain pump data at the set interval. - * @details - * Inputs : target speed - * Outputs : Drain pump data is published to CAN bus. + * @details Inputs: target speed + * @details Outputs: Drain pump data is published to CAN bus. * @return none *************************************************************************/ static void publishDrainPumpData( void ) @@ -385,9 +374,8 @@ * @brief * The execDrainPumpTest function executes the state machine for the drain * pump self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the drain pump self-test. *************************************************************************/ SELF_TEST_STATUS_T execDrainPumpTest( void ) @@ -409,9 +397,8 @@ * @brief * The testSetDrainPumpDataPublishIntervalOverride function overrides the * drain pump data publish interval. - * @details - * Inputs : none - * Outputs : drainPumpDataPublishInterval + * @details Inputs: none + * @details Outputs: drainPumpDataPublishInterval * @param value override drain pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -435,9 +422,8 @@ * @brief * The testResetDrainPumpDataPublishIntervalOverride function resets the * override of the drain pump data publish interval. - * @details - * Inputs : none - * Outputs : drainPumpDataPublishInterval + * @details Inputs: none + * @details Outputs: drainPumpDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetDrainPumpDataPublishIntervalOverride( void ) @@ -458,9 +444,8 @@ * @brief * The testSetTargetDrainPumpSpeedOverride function overrides the target * drain pump speed (in RPM). - * @details - * Inputs : none - * Outputs : targetDrainPumpSpeed + * @details Inputs: none + * @details Outputs: targetDrainPumpSpeed * @param value override target drain pump speed (in RPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -483,9 +468,8 @@ * @brief * The testResetTargetDrainPumpSpeedOverride function resets the override of the * target drain pump speed (in RPM). - * @details - * Inputs : none - * Outputs : targetDrainPumpSpeed + * @details Inputs: none + * @details Outputs: targetDrainPumpSpeed * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetTargetDrainPumpSpeedOverride( void ) Index: firmware/App/Controllers/Heaters.c =================================================================== diff -u -r0ab2c7bbd020dc4481b0727d785fd2b13bd90c13 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 0ab2c7bbd020dc4481b0727d785fd2b13bd90c13) +++ firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -151,9 +151,8 @@ * @brief * The initHeaters function initializes the variables and the PI controllers * for the primary and trimmer heaters. - * @details - * Inputs : none - * Outputs : Heaters module initialized + * @details Inputs: none + * @details Outputs: Heaters module initialized * @return none *************************************************************************/ void initHeaters( void ) @@ -183,9 +182,8 @@ * @brief * The setPrimaryHeaterTargetTemperature function sets the primary heater * target temperature. - * @details - * Inputs : none - * Outputs : primaryHeaterTargetTemperature + * @details Inputs: none + * @details Outputs: primaryHeaterTargetTemperature * @param targetTemp target temperature for the primary heater * @return none *************************************************************************/ @@ -198,9 +196,8 @@ * @brief * The setTrimmerHeaterTargetTemperature function sets the trimmer heater * target temperature. - * @details - * Inputs : none - * Outputs : trimmerHeaterTargetTemperature + * @details Inputs: none + * @details Outputs: trimmerHeaterTargetTemperature * @param targetTemp target temperature for the trimmer heater * @return none *************************************************************************/ @@ -213,9 +210,8 @@ * @brief * The startPrimaryHeater function starts the primary heaters. It resets * the primary heaters state and sets the main primary heater duty cycle. - * @details - * Inputs : primaryHeaterTargetTemperature - * Outputs : hasStartPrimaryHeaterRequested + * @details Inputs: primaryHeaterTargetTemperature + * @details Outputs: hasStartPrimaryHeaterRequested * @return status *************************************************************************/ BOOL startPrimaryHeater( void ) @@ -237,9 +233,8 @@ * @brief * The startTrimmerHeater function starts the trimmer heater. It resets the * trimmer heater's state and sets the duty cycle of the trimmer heater. - * @details - * Inputs : trimmerHeaterTargetTemperature - * Outputs : hasStartTrimmerHeaterRequested + * @details Inputs: trimmerHeaterTargetTemperature + * @details Outputs: hasStartTrimmerHeaterRequested * @return status *************************************************************************/ BOOL startTrimmerHeater( void ) @@ -260,9 +255,8 @@ /*********************************************************************//** * @brief * The stopPrimaryHeater function stops the primary heater. - * @details - * Inputs : none - * Outputs : Primary heater stops + * @details Inputs: none + * @details Outputs: Primary heater stops * @return none *************************************************************************/ void stopPrimaryHeater( void ) @@ -277,9 +271,8 @@ /*********************************************************************//** * @brief * The stopTrimmerHeater function stops the trimmer heater. - * @details - * Inputs : none - * Outputs : Trimmer heater stops + * @details Inputs: none + * @details Outputs: Trimmer heater stops * @return none *************************************************************************/ void stopTrimmerHeater( void ) @@ -292,9 +285,8 @@ /*********************************************************************//** * @brief * The execHeatersMonitor function turns off the heaters when RO pump is not on. - * @details - * Inputs : none - * Outputs : Turns off the heaters when RO pump is not on + * @details Inputs: none + * @details Outputs: Turns off the heaters when RO pump is not on * @return none *************************************************************************/ void execHeatersMonitor( void ) @@ -314,9 +306,8 @@ /*********************************************************************//** * @brief * The execHeatersSelfTest function executes the heaters' self-test state machine. - * @details - * Inputs : heatersSelfTestState - * Outputs : heatersSelfTestState + * @details Inputs: heatersSelfTestState + * @details Outputs: heatersSelfTestState * @return heatersSelfTestState *************************************************************************/ SELF_TEST_STATUS_T execHeatersSelfTest( void ) @@ -351,9 +342,8 @@ /*********************************************************************//** * @brief * The execPrimaryHeaters function executes the primary heaters' state machine. - * @details - * Inputs : primaryHeatersExecState - * Outputs : primaryHeatersExecState + * @details Inputs: primaryHeatersExecState + * @details Outputs: primaryHeatersExecState * @return none *************************************************************************/ void execPrimaryHeaters( void ) @@ -378,9 +368,8 @@ /*********************************************************************//** * @brief * The execTrimmerHeater function executes the trimmer heater's state machine. - * @details - * Inputs : trimmerHeaterExecState - * Outputs : trimmerHeaterExecState + * @details Inputs: trimmerHeaterExecState + * @details Outputs: trimmerHeaterExecState * @return none *************************************************************************/ void execTrimmerHeater( void ) @@ -406,9 +395,8 @@ * @brief * The handleHeatersSelfTestStart function starts the small primary and * the trimmer heaters for self-test. - * @details - * Inputs : heatersSelfTestResult, selfTestElapsedTime - * Outputs : heatersSelfTestResult, selfTestElapsedTime + * @details Inputs: heatersSelfTestResult, selfTestElapsedTime + * @details Outputs: heatersSelfTestResult, selfTestElapsedTime * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestStart( void ) @@ -435,9 +423,8 @@ * elapsed, it checks the thermocouple temperature shared among the two * heaters. If they are in range, it sets the main primary heater and transitions * to the next state. If it fails, it sets an alarm and fails the test. - * @details - * Inputs : heatersSelfTestResult, selfTestElapsedTime - * Outputs : heatersSelfTestResult, selfTestElapsedTime + * @details Inputs: heatersSelfTestResult, selfTestElapsedTime + * @details Outputs: heatersSelfTestResult, selfTestElapsedTime * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestSmallPrimaryAndTrimmerHeaters( void ) @@ -475,9 +462,8 @@ * on the main primary heater has elapsed. When the time has elapsed, it * checks to ensure the thermocouple temperature is within the tolerance * of the target temperature. It then transitions to the complete state. - * @details - * Inputs : heatersSelfTestResult - * Outputs : heatersSelfTestResult + * @details Inputs: heatersSelfTestResult + * @details Outputs: heatersSelfTestResult * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestMainPrimaryHeater( void ) @@ -511,9 +497,8 @@ * @brief * The handlePrimaryHeaterStateOff function handles the primary heaters at * off state. - * @details - * Inputs : hasStartPrimaryHeaterRequested, isPrimaryHeaterOn - * Outputs : state (PRIMARY_HEATERS_EXEC_STATES_T), isPrimaryHeaterOn + * @details Inputs: hasStartPrimaryHeaterRequested, isPrimaryHeaterOn + * @details Outputs: state (PRIMARY_HEATERS_EXEC_STATES_T), isPrimaryHeaterOn * @return state (PRIMARY_HEATERS_EXEC_STATES_T) *************************************************************************/ static PRIMARY_HEATERS_EXEC_STATES_T handlePrimaryHeaterStateOff( void ) @@ -558,10 +543,9 @@ * @brief * The handlePrimaryHeaterStateControlToTarget function handles the primary * heaters at control state when the heaters are active. - * @details - * Inputs : primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, + * @details Inputs: primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, * smallPrimaryHeaterDutyCycle, isPrimaryHeaterOn - * Outputs : primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, + * @details Outputs: primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, * smallPrimaryHeaterDutyCycle * @return state (PRIMARY_HEATERS_EXEC_STATES_T) *************************************************************************/ @@ -625,9 +609,8 @@ * @brief * The handleTrimmerHeaterStateOff function handles the trimmer heater at * off state. - * @details - * Inputs : hasStartTrimmerHeaterRequested, isTrimmerHeaterOn - * Outputs : state (TRIMMER_HEATER_EXEC_STATES_T), isTrimmerHeaterOn + * @details Inputs: hasStartTrimmerHeaterRequested, isTrimmerHeaterOn + * @details Outputs: state (TRIMMER_HEATER_EXEC_STATES_T), isTrimmerHeaterOn * @return state (TRIMMER_HEATER_EXEC_STATES_T) *************************************************************************/ static TRIMMER_HEATER_EXEC_STATES_T handleTrimmerHeaterStateOff( void ) @@ -675,9 +658,8 @@ * @brief * The handleTrimmerHeaterControlToTarget function handles the trimmer * heater at control state when the heater is active. - * @details - * Inputs : trimmerHeaterTimerCounter, trimmerHeaterDutyCycle - * Outputs : trimmerHeaterTimerCounter, trimmerHeaterDutyCycle, isTrimmerHeaterOn + * @details Inputs: trimmerHeaterTimerCounter, trimmerHeaterDutyCycle + * @details Outputs: trimmerHeaterTimerCounter, trimmerHeaterDutyCycle, isTrimmerHeaterOn * @return state (TRIMMER_HEATER_EXEC_STATES_T) *************************************************************************/ static TRIMMER_HEATER_EXEC_STATES_T handleTrimmerHeaterControlToTarget( void ) @@ -727,9 +709,8 @@ /*********************************************************************//** * @brief * The setMainPrimaryHeaterPWM function sets the PWM of the main primary heater. - * @details - * Inputs : none - * Outputs : Sets the PWM duty cycle for the main primary heater + * @details Inputs: none + * @details Outputs: Sets the PWM duty cycle for the main primary heater * @param pwm PWM duty cycle to set for 1st primary heater element * @return none *************************************************************************/ @@ -741,9 +722,8 @@ /*********************************************************************//** * @brief * The setSmallPrimaryHeaterPWM function sets the PWM of the small primary heater. - * @details - * Inputs : none - * Outputs : Sets the PWM duty cycle for the small primary heater + * @details Inputs: none + * @details Outputs: Sets the PWM duty cycle for the small primary heater * @param pwm PWM duty cycle to set for 2nd primary heater element * @return none *************************************************************************/ @@ -755,9 +735,8 @@ /*********************************************************************//** * @brief * The setTrimmerHeaterPWM function sets the PWM of the trimmer heater. - * @details - * Inputs : none - * Outputs : Sets the PWM duty cycle for the trimmer heater + * @details Inputs: none + * @details Outputs: Sets the PWM duty cycle for the trimmer heater * @param pwm PWM duty cycle to set for trimmer heater * @return none *************************************************************************/ @@ -769,9 +748,8 @@ /*********************************************************************//** * @brief * The resetHeaterState function resets the PI controller of the selected heater. - * @details - * Inputs : mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle - * Outputs : mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle + * @details Inputs: mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle + * @details Outputs: mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle * @param heater enumeration of the heater for which the PI controller will be reset * @return none *************************************************************************/ @@ -792,9 +770,8 @@ /*********************************************************************//** * @brief * The getPublishHeatersDataInterval function gets the publish interval. - * @details - * Inputs : heatersDataPublishInterval - * Outputs : none + * @details Inputs: heatersDataPublishInterval + * @details Outputs: none * @return result *************************************************************************/ U32 getPublishHeatersDataInterval( void ) @@ -813,9 +790,8 @@ * @brief * The publishTemperatureData function publishes the temperature sensors * data into the USB debug port at the defined time interval. - * @details - * Inputs : dataPublicationTimerCounter - * Outputs : Broadcast temperature sensors' data + * @details Inputs: dataPublicationTimerCounter + * @details Outputs: Broadcast temperature sensors' data * @return none *************************************************************************/ static void publishHeatersData( void ) @@ -856,9 +832,8 @@ * @brief * The testSetHeatersPublishIntervalOverride function overrides the heaters * publish data time interval. - * @details - * Inputs : heatersDataPublishInterval - * Outputs : heatersDataPublishInterval + * @details Inputs: heatersDataPublishInterval + * @details Outputs: heatersDataPublishInterval * @return result *************************************************************************/ BOOL testSetHeatersPublishIntervalOverride( U32 value ) @@ -881,9 +856,8 @@ * @brief * The testResetHeatersPublishIntervalOverride function resets the heaters * publish time interval to its previous time interval. - * @details - * Inputs : heatersDataPublishInterval - * Outputs : heatersDataPublishInterval + * @details Inputs: heatersDataPublishInterval + * @details Outputs: heatersDataPublishInterval * @return result *************************************************************************/ BOOL testResetHeatersPublishIntervalOverride( void ) Index: firmware/App/Controllers/LoadCell.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/LoadCell.c (.../LoadCell.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/LoadCell.c (.../LoadCell.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -51,9 +51,8 @@ /*********************************************************************//** * @brief * The initLoadCell function initializes the LoadCell module. - * @details - * Inputs : none - * Outputs : LoadCell module initialized. + * @details Inputs: none + * @details Outputs: LoadCell module initialized. * @return none *************************************************************************/ void initLoadCell( void ) @@ -76,9 +75,8 @@ * @brief * The execLoadCell function gets load cell data from FPGA, applies filters, * and advertises them over CAN. - * @details - * Inputs : none - * Outputs : Filtered and advertised load cell data. + * @details Inputs: none + * @details Outputs: Filtered and advertised load cell data. * @return none *************************************************************************/ void execLoadCell( void ) @@ -131,9 +129,8 @@ * @brief * The getLoadCellFilteredWeight function gets the measured filtered load cell * weight for a given load cell ID. - * @details - * Inputs : filteredLoadCellWeights[] - * Outputs : none + * @details Inputs: filteredLoadCellWeights[] + * @details Outputs: none * @param loadCellID ID of load cell to get filtered weight for * @return the filtered load cell weight for the given load cell ID. *************************************************************************/ @@ -163,9 +160,8 @@ /*********************************************************************//** * @brief * The getLoadCellDataPublishInterval function gets the load cell data publish interval. - * @details - * Inputs : loadCellDataPublishInterval - * Outputs : none + * @details Inputs: loadCellDataPublishInterval + * @details Outputs: none * @return the current load cell data publication interval (in ms/task interval). *************************************************************************/ static U32 getLoadCellDataPublishInterval( void ) @@ -189,9 +185,8 @@ /*********************************************************************//** * @brief * The testSetLoadCellOverride function overrides the measured load cell data. - * @details - * Inputs : none - * Outputs : filteredLoadCellWeights[] + * @details Inputs: none + * @details Outputs: filteredLoadCellWeights[] * @param loadCellID ID of the load cell to override * @param value override filtered load cell weight * @return TRUE if override successful, FALSE if not @@ -216,9 +211,8 @@ /*********************************************************************//** * @brief * The testResetLoadCellOverride function resets the override of the load cell. - * @details - * Inputs : none - * Outputs : filteredLoadCellWeights[] + * @details Inputs: none + * @details Outputs: filteredLoadCellWeights[] * @param loadCellID ID of the load cell to override * @return TRUE if reset successful, FALSE if not *************************************************************************/ @@ -243,9 +237,8 @@ * @brief * The testSetLoadCellDataPublishIntervalOverride function overrides the * load cell data publish interval. - * @details - * Inputs : none - * Outputs : loadCellDataPublishInterval + * @details Inputs: none + * @details Outputs: loadCellDataPublishInterval * @param value override load cell data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -269,9 +262,8 @@ * @brief * The testResetLoadCellDataPublishIntervalOverride function resets the override * of the load cell data publish interval. - * @details - * Inputs : none - * Outputs : loadCellDataPublishInterval + * @details Inputs: none + * @details Outputs: loadCellDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetLoadCellDataPublishIntervalOverride( void ) Index: firmware/App/Controllers/Pressures.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/Pressures.c (.../Pressures.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Controllers/Pressures.c (.../Pressures.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -88,9 +88,8 @@ /*********************************************************************//** * @brief * The initPressures function initializes the Pressures module. - * @details - * Inputs : none - * Outputs : Pressures module initialized. + * @details Inputs: none + * @details Outputs: Pressures module initialized. * @return none *************************************************************************/ void initPressures( void ) @@ -121,9 +120,8 @@ * @brief * The execPressures function executes the pressures' monitor state machine * and publish pressures' data. - * @details - * Inputs : pressuresState - * Outputs : pressuresState + * @details Inputs: pressuresState + * @details Outputs: pressuresState * @return none *************************************************************************/ void execPressures( void ) @@ -153,9 +151,8 @@ * @brief * The handlePressuresInitState function handles the pressures initialize state * of the pressures monitor state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePressuresInitState( void ) @@ -169,9 +166,8 @@ * @brief * The handlePressuresContReadState function handles the continuous read state * of the pressures monitor state machine. - * @details - * Inputs : pressureFilterCounter - * Outputs : pressure sensor values updated + * @details Inputs: pressureFilterCounter + * @details Outputs: pressure sensor values updated * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePressuresContReadState( void ) @@ -222,9 +218,8 @@ /*********************************************************************//** * @brief * The getPublishPressuresDataInterval function gets the pressure data publish internval. - * @details - * Inputs : pressuresDataPublishInterval - * Outputs : none + * @details Inputs: pressuresDataPublishInterval + * @details Outputs: none * @return the current pressures data publication interval (in task intervals). *************************************************************************/ static U32 getPublishPressuresDataInterval( void ) @@ -243,9 +238,8 @@ * @brief * The checkInletPressure function checks inlet water pressure value * and triggers an alarm when pressure value is out of allowed range. - * @details - * Inputs : RO pump inlet pressure sensor value - * Outputs : Triggers low pressure persistent alarm + * @details Inputs: RO pump inlet pressure sensor value + * @details Outputs: Triggers low pressure persistent alarm * @return none *************************************************************************/ void checkInletPressure( void ) @@ -260,9 +254,8 @@ * @brief * The checkInletPressureFault function checks inlet water pressure value * and triggers a machine fault when pressure value is out of allowed range. - * @details - * Inputs : RO pump inlet pressure sensor value - * Outputs : Triggers pressure fault persistent alarm + * @details Inputs: RO pump inlet pressure sensor value + * @details Outputs: Triggers pressure fault persistent alarm * @return none *************************************************************************/ void checkInletPressureFault( void ) @@ -276,9 +269,8 @@ /*********************************************************************//** * @brief * The getMeasuredArterialPressure function gets the current arterial pressure. - * @details - * Inputs : arterialPressure - * Outputs : none + * @details Inputs: arterialPressure + * @details Outputs: none * @param pressureID pressure sensor ID * @return the current arterial pressure (in mmHg). *************************************************************************/ @@ -308,9 +300,8 @@ /*********************************************************************//** * @brief * The publishPressuresData function publishes DG pressures data at a set interval. - * @details - * Inputs : pressuresDataPublicationTimerCounter - * Outputs : Pressures data are published to CAN bus + * @details Inputs: pressuresDataPublicationTimerCounter + * @details Outputs: Pressures data are published to CAN bus * @return none *************************************************************************/ static void publishPressuresData( void ) @@ -344,9 +335,8 @@ /*********************************************************************//** * @brief * The execPressureSelfTest function executes the pressures self-test's state machine. - * @details - * Inputs : pressuresSelfTestState - * Outputs : pressuresSelfTestState + * @details Inputs: pressuresSelfTestState + * @details Outputs: pressuresSelfTestState * @return PressuresSelfTestResult (SELF_TEST_STATUS_T) *************************************************************************/ SELF_TEST_STATUS_T execPressureSelfTest( void ) @@ -380,9 +370,8 @@ * The handleSelfTestADCCheck function checks whether the ADC reads and * report status back. If the reads are above the maximum 12bit ADC count * or equals zero, it will throw an alarm. - * @details - * Inputs : ADC reading for RO pump inlet pressure sensor - * Outputs : Performed ADC check self-test. + * @details Inputs: ADC reading for RO pump inlet pressure sensor + * @details Outputs: Performed ADC check self-test. * @return result (SELF_TEST_STATUS_T) *************************************************************************/ static SELF_TEST_STATUS_T handleSelfTestADCCheck( void ) @@ -409,9 +398,8 @@ * @brief * The testSetPressuresDataPublishIntervalOverride function overrides the * pressure data publish interval. - * @details - * Inputs : none - * Outputs : pressuresDataPublishInterval + * @details Inputs: none + * @details Outputs: pressuresDataPublishInterval * @param value value to override pressure data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -435,9 +423,8 @@ * @brief * The testResetPressuresDataPublishIntervalOverride function resets the override * of the pressure and occlusion data publish interval. - * @details - * Inputs : none - * Outputs : pressuresDataPublishInterval + * @details Inputs: none + * @details Outputs: pressuresDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetPressuresDataPublishIntervalOverride( void ) @@ -458,8 +445,8 @@ * @brief * The testSetDGPressureSensorOverride function overrides the value of the * specified pressure sensor with a given value. - * Inputs : none - * Outputs : pressures[] + * @details Inputs: none + * @details Outputs: pressures[] * @param sensor pressure sensor ID * @param value override value for pressure data * @return TRUE if override successful, FALSE if not @@ -485,9 +472,8 @@ * @brief * The testResetDGPressureSensorOverride function resets the override of the \n * specified DG pressure sensor. - * @details - * Inputs : none - * Outputs : pressures[] + * @details Inputs: none + * @details Outputs: pressures[] * @param sensor pressure sensor ID * @return TRUE if override successful, FALSE if not *************************************************************************/ Index: firmware/App/Controllers/ROPump.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -121,9 +121,8 @@ /*********************************************************************//** * @brief * The initROPump function initializes the ROPump module. - * @details - * Inputs : none - * Outputs : ROPump module initialized. + * @details Inputs: none + * @details Outputs: ROPump module initialized. * @return none *************************************************************************/ void initROPump( void ) @@ -138,9 +137,8 @@ /*********************************************************************//** * @brief * The setROPumpTargetPressure function sets a new target pressure for the RO pump. - * @details - * Inputs : none - * Outputs : targetROPumpPressure, roPumpPWMDutyCyclePct + * @details Inputs: none + * @details Outputs: targetROPumpPressure, roPumpPWMDutyCyclePct * @param roPressure new target RO pressure * @param mode new control mode * @return TRUE if new target pressure is set, FALSE if not @@ -174,9 +172,8 @@ /*********************************************************************//** * @brief * The signalROPumpHardStop function stops the RO pump immediately. - * @details - * Inputs : none - * Outputs : RO pump stopped, set point reset, state changed to off + * @details Inputs: none + * @details Outputs: RO pump stopped, set point reset, state changed to off * @return none *************************************************************************/ void signalROPumpHardStop( void ) @@ -192,9 +189,8 @@ /*********************************************************************//** * @brief * The execROPumpMonitor function executes the RO Pump monitor. - * @details - * Inputs : flowFilterCounter - * Outputs : measuredROPumpPressure, measuredROFlowRateLPM + * @details Inputs: flowFilterCounter + * @details Outputs: measuredROPumpPressure, measuredROFlowRateLPM * @return none *************************************************************************/ void execROPumpMonitor( void ) @@ -234,9 +230,8 @@ /*********************************************************************//** * @brief * The execROPumpController function executes the RO Pump controller. - * @details - * Inputs : roPumpState - * Outputs : roPumpState + * @details Inputs: roPumpState + * @details Outputs: roPumpState * @return none *************************************************************************/ void execROPumpController( void ) @@ -261,9 +256,8 @@ /*********************************************************************//** * @brief * The isROPumpOn function returns the status of RO pump. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return isROPumpOn *************************************************************************/ BOOL isReverseOsmosisPumpOn( void ) @@ -275,9 +269,8 @@ * @brief * The handleROPumpOffState function handles the RO pump off state of the * RO pump controller state machine. - * @details - * Inputs : targetROPumpPressure - * Outputs : roPumpPWMDutyCyclePctSet, isROPumpOn + * @details Inputs: targetROPumpPressure + * @details Outputs: roPumpPWMDutyCyclePctSet, isROPumpOn * @return next state *************************************************************************/ static RO_PUMP_STATE_T handleROPumpOffState( void ) @@ -329,9 +322,8 @@ * @brief * The handleROPumpControlToTargetState function handles the "control to * target" state of the RO pump controller state machine. - * @details - * Inputs : none - * Outputs : roPumpState + * @details Inputs: none + * @details Outputs: roPumpState * @return next state *************************************************************************/ static RO_PUMP_STATE_T handleROPumpControlToTargetState( void ) @@ -379,9 +371,8 @@ * @brief * The setROPumpControlSignalPWM function sets the PWM duty cycle for the * RO pump to a given %. - * @details - * Inputs : none - * Outputs : PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: PWM duty cycle zeroed * @param newPWM new duty cycle % to apply to PWM * @return none *************************************************************************/ @@ -393,9 +384,8 @@ /*********************************************************************//** * @brief * The stopROPump function sets the RO pump PWM to zero. - * @details - * Inputs : none - * Outputs : PWM duty cycle zeroed + * @details Inputs: none + * @details Outputs: PWM duty cycle zeroed * @return none *************************************************************************/ static void stopROPump( void ) @@ -408,9 +398,8 @@ /*********************************************************************//** * @brief * The getPublishROPumpDataInterval function gets the RO pump data publish interval. - * @details - * Inputs : roPumpDataPublishInterval - * Outputs : none + * @details Inputs: roPumpDataPublishInterval + * @details Outputs: none * @return the current RO pump data publication interval (in ms). *************************************************************************/ static U32 getPublishROPumpDataInterval( void ) @@ -428,9 +417,8 @@ /*********************************************************************//** * @brief * The getTargetROPumpPressure function gets the current target RO pump pressure. - * @details - * Inputs : targetROPumpPressure - * Outputs : none + * @details Inputs: targetROPumpPressure + * @details Outputs: none * @return the current target RO pressure (in PSI). *************************************************************************/ U32 getTargetROPumpPressure( void ) @@ -448,9 +436,8 @@ /*********************************************************************//** * @brief * The getMeasuredROFlowRate function gets the measured RO pump flow rate. - * @details - * Inputs : measuredROFlowRateLPM - * Outputs : none + * @details Inputs: measuredROFlowRateLPM + * @details Outputs: none * @return the current RO pump flow rate (in LPM). *************************************************************************/ F32 getMeasuredROFlowRate( void ) @@ -468,9 +455,8 @@ /*********************************************************************//** * @brief * The publishROPumpData function publishes RO pump data at the set interval. - * @details - * Inputs : target pressure, measured pressure, measured RO pump speed. - * Outputs : RO pump data is published to CAN bus. + * @details Inputs: target pressure, measured pressure, measured RO pump speed. + * @details Outputs: RO pump data is published to CAN bus. * @return none *************************************************************************/ static void publishROPumpData( void ) @@ -489,9 +475,8 @@ /*********************************************************************//** * @brief * The execROPumpTest function executes the state machine for the ROPump self-test. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the current state of the ROPump self-test. *************************************************************************/ SELF_TEST_STATUS_T execROPumpTest( void ) @@ -513,9 +498,8 @@ * @brief * The testSetROPumpDataPublishIntervalOverride function overrides the * RO pump data publish interval. - * @details - * Inputs : none - * Outputs : roPumpDataPublishInterval + * @details Inputs: none + * @details Outputs: roPumpDataPublishInterval * @param value override RO pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -539,9 +523,8 @@ * @brief * The testResetROPumpDataPublishIntervalOverride function resets the override * of the RO pump data publish interval. - * @details - * Inputs : none - * Outputs : roPumpDataPublishInterval + * @details Inputs: none + * @details Outputs: roPumpDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetROPumpDataPublishIntervalOverride( void ) @@ -562,9 +545,8 @@ * @brief * The testSetTargetROPumpPressureOverride function overrides the target * RO pressure. - * @details - * Inputs : none - * Outputs : targetROPumpPressure + * @details Inputs: none + * @details Outputs: targetROPumpPressure * @param value override target RO pressure (in PSI) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -587,9 +569,8 @@ * @brief * The testResetTargetROPumpPressureOverride function resets the override of the * target RO pressure. - * @details - * Inputs : none - * Outputs : targetROPumpPressure + * @details Inputs: none + * @details Outputs: targetROPumpPressure * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetTargetROPumpPressureOverride( void ) @@ -612,9 +593,8 @@ * @brief * The testSetMeasuredROFlowRateOverride function overrides the measured * RO flow rate. - * @details - * Inputs : none - * Outputs : measuredROFlowRateLPM + * @details Inputs: none + * @details Outputs: measuredROFlowRateLPM * @param value override measured RO pump motor speed (in LPM) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -636,9 +616,8 @@ * @brief * The testResetMeasuredROFlowRateOverride function resets the override of the * measured RO flow rate. - * @details - * Inputs : none - * Outputs : measuredROFlowRateLPM + * @details Inputs: none + * @details Outputs: measuredROFlowRateLPM * @return TRUE if override successful, FALSE if not *************************************************************************/ BOOL testResetMeasuredROFlowRateOverride( void ) Index: firmware/App/Controllers/TemperatureSensors.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/TemperatureSensors.c (.../TemperatureSensors.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Controllers/TemperatureSensors.c (.../TemperatureSensors.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -169,9 +169,8 @@ /*********************************************************************//** * @brief * The initTemperatureSensors function initializes the module - * @details - * Inputs : none - * Outputs : TemperatureSensors module initialized + * @details Inputs: none + * @details Outputs: TemperatureSensors module initialized * @return none *************************************************************************/ void initTemperatureSensors( void ) @@ -247,9 +246,8 @@ * @brief * The execTemperatureSensorsSelfTest function runs the TemperatureSensors * POST during the self-test. - * @details - * Inputs : tempSensorsSelfTestState - * Outputs : tempSensorsSelfTestState + * @details Inputs: tempSensorsSelfTestState + * @details Outputs: tempSensorsSelfTestState * @return tempSensorsSelfTestState *************************************************************************/ SELF_TEST_STATUS_T execTemperatureSensorsSelfTest( void ) @@ -284,9 +282,8 @@ /*********************************************************************//** * @brief * The execTemperatureSensors function executes the temperature sensors' state machine. - * @details - * Inputs : tempSensorsExecState - * Outputs : tempSensorsExecState + * @details Inputs: tempSensorsExecState + * @details Outputs: tempSensorsExecState * @return none *************************************************************************/ void execTemperatureSensors( void ) @@ -313,9 +310,8 @@ * @brief * The checkInletWaterTemperature checks inlet water temperature value * and triggers an alarm when temperature value is out of allowed range. - * @details - * Inputs : Inlet water temperature value - * Outputs : Trigger alarms when temperature is out of allowed range + * @details Inputs: Inlet water temperature value + * @details Outputs: Trigger alarms when temperature is out of allowed range * @return none *************************************************************************/ void checkInletWaterTemperature( void ) @@ -331,9 +327,8 @@ /*********************************************************************//** * @brief * The getTemperatureValue function gets the temperature of the requested sensor. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param sensor temperature sensor index * @return temperature *************************************************************************/ @@ -359,9 +354,8 @@ /*********************************************************************//** * @brief * The getADC2TempConversion function calculates the temperature from ADC read from FPGA. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param avgADC Running average ADC * @param gain ADC gain * @param refResistance ADC reference resistance @@ -392,9 +386,8 @@ /*********************************************************************//** * @brief * The getHeaterInternalTemp function calculates the heaters' internal temperature. - * @details - * Inputs : temperatureValues - * Outputs : temperatureValues + * @details Inputs: temperatureValues + * @details Outputs: temperatureValues * @param TCIndex thermocouple index * @param CJIndex cold junction index * @return none @@ -450,9 +443,8 @@ * read from FPGA and converts it to an S32. Then it calls another function * to check if the read ADC is valid or not and if it is, it calls another * function to process the ADC value and covert it to temperature. - * @details - * Inputs : none - * Outputs : Processed valid ADC reading + * @details Inputs: none + * @details Outputs: Processed valid ADC reading * @param sensorIndex ID of temperature sensor to process * @param adc ADC value for the temperature sensor * @param fpgaError reported FPGA error status @@ -476,9 +468,8 @@ * different bit shifts on them accordingly. Then it call another function to * check if the read ADC is valid and if it is, the function calls another function * process the ADC and convert it to temperature. - * @details - * Inputs : none - * Outputs : Processed heater ADC reading + * @details Inputs: none + * @details Outputs: Processed heater ADC reading * @param sensorIndex ID of temperature sensor to process * @param adc reported ADC value for temperature sensor * @param fpgaError reported error status by FPGA @@ -519,9 +510,8 @@ * count. If there is any FPGA, it raises an alarm. If the count has changed * and the ADC value is not the same as the previous ADC read, it returns a * TRUE, signaling that the ADC is valid to be processed. - * @details - * Inputs : readCount - * Outputs : readCount, internalErrorCount + * @details Inputs: readCount + * @details Outputs: readCount, internalErrorCount * @param sensorIndex Temperature sensor index * @param fpgaError FPGA error count * @param fpgaCount FPGA read count @@ -566,9 +556,8 @@ * The processADCRead function receives the ADC value and the sensor * index and calculates the running sum and the moving average of the ADCs * The temperatureSensorsADCRead and tempSensorsAvgADCValues are updated. - * @details - * Inputs : adcNextIndex, rawADCReads, adcRunningSum - * Outputs : adcNextIndex, rawADCReads, adcRunningSum, temperatureValues + * @details Inputs: adcNextIndex, rawADCReads, adcRunningSum + * @details Outputs: adcNextIndex, rawADCReads, adcRunningSum, temperatureValues * @param sensorIndex Temperature sensor index * @param adc adc reading from fpga * @return none @@ -597,9 +586,8 @@ /*********************************************************************//** * @brief * The handleSelfTestStart function transitions the self-test state to check ADC. - * @details - * Inputs : tempSensorsSelfTestResult - * Outputs : none + * @details Inputs: tempSensorsSelfTestResult + * @details Outputs: none * @return state (TEMPSENSORS_SELF_TEST_STATES_T) *************************************************************************/ static TEMPSENSORS_SELF_TEST_STATES_T handleSelfTestStart( void ) @@ -613,9 +601,8 @@ * The handleSelfTestADCCheck function checks whether the ADC reads. If the * reads are above the maximum 24bit ADC count, it will throw an alarm and * switches to the next state. - * @details - * Inputs : TPi ADC reading from FPGA - * Outputs : none + * @details Inputs: TPi ADC reading from FPGA + * @details Outputs: none * @return TEMPSENSORS_SELF_TEST_CONSISTENCY_CHECK (TEMPSENSORS_SELF_TEST_STATES_T) *************************************************************************/ static TEMPSENSORS_SELF_TEST_STATES_T handleSelfTestADCCheck( void ) @@ -637,9 +624,8 @@ * @brief * The handleSelfTestConsistencyCheck function checks the values of the * sensors to make sure they are within the allowed range from each other. - * @details - * Inputs : TPi and TPo ADC reading from FPGA - * Outputs : none + * @details Inputs: TPi and TPo ADC reading from FPGA + * @details Outputs: none * @return TEMPSENSORS_SELF_TEST_COMPLETE (TEMPSENSORS_SELF_TEST_STATES_T) *************************************************************************/ static TEMPSENSORS_SELF_TEST_STATES_T handleSelfTestConsistencyCheck( void ) @@ -676,9 +662,8 @@ * @brief * The handleExecStart function waits for a period of time and switches to * the state that reads the ADC values from FPGA. - * @details - * Inputs : none - * Outputs : elapsedTime + * @details Inputs: none + * @details Outputs: elapsedTime * @return state (TEMPSENSORS_EXEC_STATES_T) *************************************************************************/ static TEMPSENSORS_EXEC_STATES_T handleExecStart( void ) @@ -703,9 +688,8 @@ * The handleExecGetADCValues function reads the ADC values from FPGA and * at the specified time intervals and calls other functions to calculate * the internal temperature of the heaters. - * @details - * Inputs : none - * Outputs : internalHeatersConversionTimer, elapsedTime, temperatureValues + * @details Inputs: none + * @details Outputs: internalHeatersConversionTimer, elapsedTime, temperatureValues * @return state (TEMPSENSORS_EXEC_STATES_T) *************************************************************************/ static TEMPSENSORS_EXEC_STATES_T handleExecGetADCValues( void ) @@ -741,9 +725,8 @@ * @brief * The getPublishTemperatureSensorsDataInterval function returns the data * publication interval either from the data or from the override. - * @details - * Inputs : tempSensorsPublishInterval - * Outputs : none + * @details Inputs: tempSensorsPublishInterval + * @details Outputs: none * @return result *************************************************************************/ static U32 getPublishTemperatureSensorsDataInterval( void ) @@ -762,9 +745,8 @@ * @brief * The publishTemperatureSensorsData function broadcasts the temperature * sensors data at the publication interval - * @details - * Inputs : dataPublicationTimerCounter, tempValuesForPublication - * Outputs : dataPublicationTimerCounter, tempValuesForPublication + * @details Inputs: dataPublicationTimerCounter, tempValuesForPublication + * @details Outputs: dataPublicationTimerCounter, tempValuesForPublication * @return none *************************************************************************/ static void publishTemperatureSensorsData( void ) @@ -792,9 +774,8 @@ * @brief * The testSetMeasuredTemperatureOverride function sets the override value * for a specific temperature sensor. - * @details - * Inputs : temperatureValues - * Outputs : temperatureValues + * @details Inputs: temperatureValues + * @details Outputs: temperatureValues * @param sensorIndex temperature sensor index * @param temperature temperature value to override if testing activated * @return result @@ -820,9 +801,8 @@ * @brief * The testSetMeasuredTemperatureOverride function resets the override value * of a specified temperature sensor. - * @details - * Inputs : temperatureValues - * Outputs : temperatureValues + * @details Inputs: temperatureValues + * @details Outputs: temperatureValues * @param sensorIndex temperature sensor index * @return result *************************************************************************/ @@ -847,9 +827,8 @@ * @brief * The testSetTemperatureSensorsPublishIntervalOverride function overrides * the temperature sensors publish data interval. - * @details - * Inputs : tempSensorsPublishInterval - * Outputs : tempSensorsPublishInterval + * @details Inputs: tempSensorsPublishInterval + * @details Outputs: tempSensorsPublishInterval * @param value temperature sensor data broadcast interval (in ms) to override to * @return result *************************************************************************/ @@ -873,9 +852,8 @@ * @brief * The testResetTemperatureSensorsPublishIntervalOverride function resets * the override value of temperature sensors publish data interval. - * @details - * Inputs : tempSensorsPublishInterval - * Outputs : tempSensorsPublishInterval + * @details Inputs: tempSensorsPublishInterval + * @details Outputs: tempSensorsPublishInterval * @return result *************************************************************************/ BOOL testResetTemperatureSensorsPublishIntervalOverride( void ) Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -55,9 +55,8 @@ /*********************************************************************//** * @brief * The initValves function initializes the Valves module. - * @details - * Inputs : none - * Outputs : Valves module initialized + * @details Inputs: none + * @details Outputs: Valves module initialized * @return none *************************************************************************/ void initValves( void ) @@ -81,9 +80,8 @@ /*********************************************************************//** * @brief * The execValves function executes the valves driver. - * @details - * Inputs : valvesStates, valveStateMismatchCounter - * Outputs : valvesStates, valveStateMismatchCounter + * @details Inputs: valvesStates, valveStateMismatchCounter + * @details Outputs: valvesStates, valveStateMismatchCounter * @return none *************************************************************************/ void execValves( void ) @@ -116,9 +114,8 @@ * @brief * The checkValveStateName function checks the validity of requested valve * state name for given valve. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveID ID of valve to check a valve state name for * @param valveStateName valve state name to check for given valve ID * @return TRUE if given valveStateName is appropriate for given valve ID, FALSE if not. @@ -224,9 +221,8 @@ /*********************************************************************//** * @brief * The getPublishValveStateInterval function gets the valves states publication interval. - * @details - * Inputs : valvesStatesPublishInterval - * Outputs : none + * @details Inputs: valvesStatesPublishInterval + * @details Outputs: none * @return the current valves states publication interval (in task intervals) *************************************************************************/ static U32 getPublishValvesStatesInterval( void ) @@ -245,9 +241,8 @@ * @brief * The fromU32ArrayToU16 function converts an array of U32 valve states * to U16 valvesStates that can be passed to FPGA for setting valves. - * @details - * Inputs : valveStates[] - * Outputs : none + * @details Inputs: valveStates[] + * @details Outputs: none * @return converted U16 bit field for currently commanded valve states *************************************************************************/ static U16 fromU32ArrayToU16( void ) @@ -268,9 +263,8 @@ * @brief * The convertValveStateNameToValveState function converts valve state \n * name to its corresponding de-energized (0) or energized (1) valve state. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveStateName valve state name enumeration to convert to energized/de-energized * @return converted valve state for given valve state name *************************************************************************/ @@ -339,9 +333,8 @@ /*********************************************************************//** * @brief * The setValveState function sets the valve state for given valve. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param valveID ID of valve to set state for * @param valveStateName name of valve state to set given valve to * @return TRUE if new valve state is set for given valve ID, FALSE if not. @@ -369,9 +362,8 @@ /*********************************************************************//** * @brief * The getValveState function gets the current valve state for given valve. - * @details - * Inputs : valveStates[] - * Outputs : none + * @details Inputs: valveStates[] + * @details Outputs: none * @param valveID ID of valve to get state for * @return the current valve state for given valve *************************************************************************/ @@ -401,9 +393,8 @@ /*********************************************************************//** * @brief * The publishValvesStates function publishes DG valves states at the set interval. - * @details - * Inputs : valvesStatesPublicationTimerCounter - * Outputs : DG valves states are published to CAN bus on interval. + * @details Inputs: valvesStatesPublicationTimerCounter + * @details Outputs: DG valves states are published to CAN bus on interval. * @return none *************************************************************************/ static void publishValvesStates( void ) @@ -426,9 +417,8 @@ * @brief * The testSetValvesStatesPublishIntervalOverride function overrides the * valves states publish interval. - * @details - * Inputs : none - * Outputs : valvesStatesPublishInterval + * @details Inputs: none + * @details Outputs: valvesStatesPublishInterval * @param value override valves states publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -452,9 +442,8 @@ * @brief * The testResetValvesStatesPublishIntervalOverride function resets the override * of the valves states publish interval. - * @details - * Inputs : none - * Outputs : valvesStatesPublishInterval + * @details Inputs: none + * @details Outputs: valvesStatesPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetValvesStatesPublishIntervalOverride( void ) @@ -475,8 +464,8 @@ * @brief * The testSetValveStateOverride function overrides the value of the * specified valve with a given value. - * Inputs : none - * Outputs : valves[] + * @details Inputs: none + * @details Outputs: valves[] * @param valveID ID of valve to override for * @param value override value for the given valve ID * @return TRUE if override successful, FALSE if not @@ -501,9 +490,8 @@ /*********************************************************************//** * @brief * The testResetValveStateOverride function resets the override of the specified valve. - * @details - * Inputs : none - * Outputs : valves[] + * @details Inputs: none + * @details Outputs: valves[] * @param valveID ID of valve to reset override state for * @return TRUE if override successful, FALSE if not *************************************************************************/ Index: firmware/App/Drivers/CPLD.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -49,9 +49,8 @@ /*********************************************************************//** * @brief * The initCPLD function initializes the CPLD module. - * @details - * Inputs : none - * Outputs : CPLD module signal outputs set to initial states. + * @details Inputs: none + * @details Outputs: CPLD module signal outputs set to initial states. * @return none *************************************************************************/ void initCPLD( void ) @@ -68,9 +67,8 @@ /*********************************************************************//** * @brief * The toggleCPLDWatchdog function toggles the watchdog pet signal to CPLD. - * @details - * Inputs : none - * Outputs : watchdog pet signal toggled. + * @details Inputs: none + * @details Outputs: watchdog pet signal toggled. * @return none *************************************************************************/ void toggleCPLDWatchdog( void ) @@ -82,9 +80,8 @@ * @brief * The getCPLDWatchdogExpired function determines the current signal level * on the watchdog expired pin from the CPLD. - * @details - * Inputs : Signal from CPLD on watchdog expired pin. - * Outputs : none + * @details Inputs: Signal from CPLD on watchdog expired pin. + * @details Outputs: none * @return level (LOW or HIGH) *************************************************************************/ PIN_SIGNAL_STATE_T getCPLDWatchdogExpired( void ) @@ -97,9 +94,8 @@ /*********************************************************************//** * @brief * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD to given level. - * @details - * Inputs : none - * Outputs : alarm lamp green signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp green signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ @@ -118,9 +114,8 @@ /*********************************************************************//** * @brief * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD to given level. - * @details - * Inputs : none - * Outputs : alarm lamp blue signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp blue signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ @@ -139,9 +134,8 @@ /*********************************************************************//** * @brief * The setCPLDLampRed function sets the alarm lamp red signal to CPLD to given level. - * @details - * Inputs : none - * Outputs : alarm lamp red signal set to given level. + * @details Inputs: none + * @details Outputs: alarm lamp red signal set to given level. * @param level LOW or HIGH * @return none *************************************************************************/ Index: firmware/App/Drivers/Comm.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Drivers/Comm.c (.../Comm.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Drivers/Comm.c (.../Comm.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -37,9 +37,8 @@ /*********************************************************************//** * @brief * The signalCANXmitsInitiated function sets the CAN transmits in progress flag. - * @details - * Inputs : none - * Outputs : canXmitsInProgress + * @details Inputs: none + * @details Outputs: canXmitsInProgress * @return none *************************************************************************/ void signalCANXmitsInitiated( void ) @@ -50,9 +49,8 @@ /*********************************************************************//** * @brief * The signalCANXmitsCompleted function resets the CAN transmits in progress flag. - * @details - * Inputs : none - * Outputs : canXmitsInProgress + * @details Inputs: none + * @details Outputs: canXmitsInProgress * @return none *************************************************************************/ void signalCANXmitsCompleted( void ) @@ -63,9 +61,8 @@ /*********************************************************************//** * @brief * The signalSCI1XmitsInitiated function sets the SCI1 transmits in progress flag. - * @details - * Inputs : none - * Outputs : uartXmitsInProgress + * @details Inputs: none + * @details Outputs: uartXmitsInProgress * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -78,9 +75,8 @@ /*********************************************************************//** * @brief * The signalSCI1XmitsCompleted function resets the SCI1 transmits in progress flag. - * @details - * Inputs : none - * Outputs : uartXmitsInProgress + * @details Inputs: none + * @details Outputs: uartXmitsInProgress * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -94,9 +90,8 @@ * @brief * The setSCI1DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is enabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -110,9 +105,8 @@ * @brief * The setSCI1DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is enabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -126,9 +120,8 @@ * @brief * The clearSCI1DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is disabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -142,9 +135,8 @@ * @brief * The clearSCI1DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is disabled. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -158,9 +150,8 @@ * @brief * The setSCI2DMAReceiveInterrupt function enables DMA receive interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is enabled. * @return none *************************************************************************/ void setSCI2DMAReceiveInterrupt( void ) @@ -172,9 +163,8 @@ * @brief * The setSCI2DMATransmitInterrupt function enables DMA transmit interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is enabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is enabled. * @return none *************************************************************************/ void setSCI2DMATransmitInterrupt( void ) @@ -186,9 +176,8 @@ * @brief * The clearSCI2DMAReceiveInterrupt function disables DMA receive interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA receive interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA receive interrupt is disabled. * @return none *************************************************************************/ void clearSCI2DMAReceiveInterrupt( void ) @@ -200,9 +189,8 @@ * @brief * The clearSCI2DMATransmitInterrupt function disables DMA transmit interrupts * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : DMA transmit interrupt is disabled. + * @details Inputs: none + * @details Outputs: DMA transmit interrupt is disabled. * @return none *************************************************************************/ void clearSCI2DMATransmitInterrupt( void ) @@ -214,9 +202,8 @@ * @brief * The clearSCI1CommErrors function clears framing and/or overrun error flags * for the SCI1 peripheral. - * @details - * Inputs : none - * Outputs : SCI1 error flags cleared. + * @details Inputs: none + * @details Outputs: SCI1 error flags cleared. * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -231,9 +218,8 @@ * @brief * The clearSCI2CommErrors function clears framing and/or overrun error flags * for the SCI2 peripheral. - * @details - * Inputs : none - * Outputs : SCI2 error flags cleared. + * @details Inputs: none + * @details Outputs: SCI2 error flags cleared. * @return none *************************************************************************/ void clearSCI2CommErrors( void ) @@ -246,9 +232,8 @@ * @brief * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI1 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ #ifdef DEBUG_ENABLED @@ -266,9 +251,8 @@ * @brief * The isSCI2DMATransmitInProgress function determines whether a DMA transmit * is in progress on the SCI2 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ BOOL isSCI2DMATransmitInProgress( void ) @@ -283,9 +267,8 @@ * @brief * The isCAN1TransmitInProgress function determines whether a transmit * is in progress on the CAN1 peripheral. - * @details - * Inputs : status registers - * Outputs : none + * @details Inputs: status registers + * @details Outputs: none * @return TRUE if a transmit is in progress, FALSE if not *************************************************************************/ BOOL isCAN1TransmitInProgress( void ) Index: firmware/App/Drivers/InternalADC.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -72,9 +72,8 @@ /*********************************************************************//** * @brief * The initInternalADC function initializes the InternalADC module. - * @details - * Inputs : none - * Outputs : InternalADC module is initialized. + * @details Inputs: none + * @details Outputs: InternalADC module is initialized. * @return none *************************************************************************/ void initInternalADC( void ) @@ -104,9 +103,8 @@ * @brief * The adcNotification function handles an ADC conversion complete interrupt. * All channel readings in the FIFO are retrieved. - * @details - * Inputs : ADC FIFO - * Outputs : adcRawReadingsCount, adcRawReadings[] + * @details Inputs: ADC FIFO + * @details Outputs: adcRawReadingsCount, adcRawReadings[] * @param adc pointer to the ADC1 controller * @param group ADC channel group ID * @return none @@ -123,9 +121,8 @@ * @brief * The execInternalADC function processes the last set of raw ADC channel * readings and kicks off the next conversion of ADC channels. - * @details - * Inputs : adcRawReadingsCount, adcRawReadings[] - * Outputs : adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] + * @details Inputs: adcRawReadingsCount, adcRawReadings[] + * @details Outputs: adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] * @param adc pointer to the ADC1 controller * @param group ADC channel group ID * @return none @@ -160,9 +157,8 @@ /*********************************************************************//** * @brief * The getIntADCReading function gets the latest average reading for a given channel. - * @details - * Inputs : adcReadingsAvgs[] - * Outputs : none + * @details Inputs: adcReadingsAvgs[] + * @details Outputs: none * @param channel adc channel to retrieve a reading for * @return average reading for the given channel *************************************************************************/ Index: firmware/App/Drivers/SafetyShutdown.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -39,9 +39,8 @@ /*********************************************************************//** * @brief * The initSafetyShutdown function initializes the safety shutdown module. - * @details - * Inputs : none - * Outputs : Safety shutdown module signal output set to initial state. + * @details Inputs: none + * @details Outputs: Safety shutdown module signal output set to initial state. * @return none *************************************************************************/ void initSafetyShutdown( void ) @@ -52,9 +51,8 @@ /*********************************************************************//** * @brief * The activateSafetyShutdown function activates the safety shutdown signal. - * @details - * Inputs : none - * Outputs : Safety shutdown signal output set to active state. + * @details Inputs: none + * @details Outputs: Safety shutdown signal output set to active state. * @return none *************************************************************************/ void activateSafetyShutdown( void ) @@ -66,9 +64,8 @@ * @brief * The isSafetyShutdownActivated function returns whether the safety shutdown * signal has been activated. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return safetyShutdownActivated *************************************************************************/ BOOL isSafetyShutdownActivated( void ) @@ -79,9 +76,8 @@ /*********************************************************************//** * @brief * The testSetSafetyShutdownOverride function overrides the HD safety shutdown. - * @details - * Inputs : none - * Outputs : HD safety shutdown overridden + * @details Inputs: none + * @details Outputs: HD safety shutdown overridden * @param value TRUE to activate safety shutdown, FALSE to de-activate it * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -113,9 +109,8 @@ * @brief * The testResetSafetyShutdownOverride function resets the override of the * HD safety shutdown. - * @details - * Inputs : none - * Outputs : shutdown override reset + * @details Inputs: none + * @details Outputs: shutdown override reset * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetSafetyShutdownOverride( void ) Index: firmware/App/Modes/ModeChemicalDisinfect.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeChemicalDisinfect.c (.../ModeChemicalDisinfect.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Modes/ModeChemicalDisinfect.c (.../ModeChemicalDisinfect.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -35,9 +35,8 @@ /*********************************************************************//** * @brief * The initChemicalDisinfectMode function initializes the chemical disinfect mode module. - * @details - * Inputs : none - * Outputs : Module initialized. + * @details Inputs: none + * @details Outputs: Module initialized. * @return none *************************************************************************/ void initChemicalDisinfectMode( void ) @@ -49,9 +48,8 @@ * @brief * The transitionToChemicalDisinfectMode function prepares for transition to * chemical disinfect mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToChemicalDisinfectMode( void ) @@ -62,9 +60,8 @@ /*********************************************************************//** * @brief * The execChemicalDisinfectMode function executes the chemical disinfect mode state machine. - * @details - * Inputs : none - * Outputs : Chemical disinfect mode state machine executed + * @details Inputs: none + * @details Outputs: Chemical disinfect mode state machine executed * @return current state of chemical disinfect mode *************************************************************************/ U32 execChemicalDisinfectMode( void ) @@ -90,9 +87,8 @@ * @brief * The getCurrentChemicalDisinfectState function returns the current state of the * chemical disinfect mode. - * @details - * Inputs : chemState - * Outputs : none + * @details Inputs: chemState + * @details Outputs: none * @return current state of chemical disinfect mode *************************************************************************/ DG_CHEM_DISINFECT_STATE_T getCurrentChemicalDisinfectState( void ) Index: firmware/App/Modes/ModeDrain.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeDrain.c (.../ModeDrain.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeDrain.c (.../ModeDrain.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -45,9 +45,8 @@ /*********************************************************************//** * @brief * The initDrainMode function initializes the drain mode module. - * @details - * Inputs : none - * Outputs : drainState + * @details Inputs: none + * @details Outputs: drainState * @return none *************************************************************************/ void initDrainMode( void ) @@ -58,9 +57,8 @@ /*********************************************************************//** * @brief * The transitionToDrainMode function prepares for transition to drain mode. - * @details - * Inputs : none - * Outputs : Drain mode initialized + * @details Inputs: none + * @details Outputs: Drain mode initialized * @return none *************************************************************************/ void transitionToDrainMode( void ) @@ -76,9 +74,8 @@ /*********************************************************************//** * @brief * The execDrainMode function executes the drain mode state machine. - * @details - * Inputs : drainState - * Outputs : Check water quality, drain mode state machine executed + * @details Inputs: drainState + * @details Outputs: Check water quality, drain mode state machine executed * @return current state. *************************************************************************/ U32 execDrainMode( void ) @@ -112,9 +109,8 @@ /*********************************************************************//** * @brief * The handleDrainState function handles the drain state of the drain mode state machine. - * @details - * Inputs : none - * Outputs : Drain out from reservoir + * @details Inputs: none + * @details Outputs: Drain out from reservoir * @return the next state *************************************************************************/ static DG_DRAIN_STATE_T handleDrainState( void ) @@ -141,9 +137,8 @@ /*********************************************************************//** * @brief * The getCurrentDrainState function returns the current state of the drain mode. - * @details - * Inputs : drainState - * Outputs : none + * @details Inputs: drainState + * @details Outputs: none * @return the current state of drain mode. *************************************************************************/ DG_DRAIN_STATE_T getCurrentDrainState( void ) Index: firmware/App/Modes/ModeFault.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -34,9 +34,8 @@ /*********************************************************************//** * @brief * The initFaultMode function initializes the Fault Mode module. - * @details - * Inputs : none - * Outputs : Fault mode module initialized + * @details Inputs: none + * @details Outputs: Fault mode module initialized * @return none *************************************************************************/ void initFaultMode( void ) @@ -47,9 +46,8 @@ /*********************************************************************//** * @brief * The transitionToFaultMode function prepares for transition to fault mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToFaultMode( void ) @@ -59,9 +57,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the fault mode state machine. - * @details - * Inputs : none - * Outputs : Fault mode state machine executed + * @details Inputs: none + * @details Outputs: Fault mode state machine executed * @return current state of fault mode *************************************************************************/ U32 execFaultMode( void ) @@ -84,9 +81,8 @@ /*********************************************************************//** * @brief * The getCurrentFaultState function returns the current state of the fault mode. - * @details - * Inputs : faultState - * Outputs : none + * @details Inputs: faultState + * @details Outputs: none * @return current state of fault mode *************************************************************************/ DG_FAULT_STATE_T getCurrentFaultState( void ) Index: firmware/App/Modes/ModeFill.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeFill.c (.../ModeFill.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeFill.c (.../ModeFill.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -45,9 +45,8 @@ /*********************************************************************//** * @brief * The initFillMode function initializes the fill mode module. - * @details - * Inputs : none - * Outputs : Fill mode module initialized + * @details Inputs: none + * @details Outputs: Fill mode module initialized * @return none *************************************************************************/ void initFillMode( void ) @@ -58,9 +57,8 @@ /*********************************************************************//** * @brief * The transitionToFillMode function prepares for transition to fill mode. - * @details - * Inputs : none - * Outputs : Re-initialized fill mode + * @details Inputs: none + * @details Outputs: Re-initialized fill mode * @return none *************************************************************************/ void transitionToFillMode( void ) @@ -77,9 +75,8 @@ /*********************************************************************//** * @brief * The execFillMode function executes the fill mode state machine. - * @details - * Inputs : fillState - * Outputs : Check water quality, fill mode state machine executed + * @details Inputs: fillState + * @details Outputs: Check water quality, fill mode state machine executed * @return current state. *************************************************************************/ U32 execFillMode( void ) @@ -118,9 +115,8 @@ * @brief * The handleDialysateProductionState function executes the Dialysate production * state of the fill mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the next state *************************************************************************/ static DG_FILL_MODE_STATE_T handleDialysateProductionState( void ) @@ -141,9 +137,8 @@ * @brief * The handleDeliverDialysateState function executes the deliver Dialysate * state of the fill mode state machine. - * @details - * Inputs : none - * Outputs : Deliver Dialysate + * @details Inputs: none + * @details Outputs: Deliver Dialysate * @return the next state *************************************************************************/ static DG_FILL_MODE_STATE_T handleDeliverDialysateState( void ) @@ -176,9 +171,8 @@ /*********************************************************************//** * @brief * The getCurrentFillState function returns the current state of the fill mode. - * @details - * Inputs : fillState - * Outputs : none + * @details Inputs: fillState + * @details Outputs: none * @return current state of fill mode *************************************************************************/ DG_FILL_MODE_STATE_T getCurrentFillState( void ) Index: firmware/App/Modes/ModeFlush.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeFlush.c (.../ModeFlush.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Modes/ModeFlush.c (.../ModeFlush.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -35,9 +35,8 @@ /*********************************************************************//** * @brief * The initFlushMode function initializes flush mode module. - * @details - * Inputs : none - * Outputs : Initialized flush mode module + * @details Inputs: none + * @details Outputs: Initialized flush mode module * @return none *************************************************************************/ void initFlushMode( void ) @@ -48,9 +47,8 @@ /*********************************************************************//** * @brief * The transitionToFlushMode function prepares for transition to flush mode. - * @details - * Inputs : none - * Outputs : Prepares for transition to flush mode + * @details Inputs: none + * @details Outputs: Prepares for transition to flush mode * @return none *************************************************************************/ void transitionToFlushMode( void ) @@ -61,9 +59,8 @@ /*********************************************************************//** * @brief * The execFlushMode function executes the flush mode state machine. - * @details - * Inputs : none - * Outputs : Flush mode state machine executed + * @details Inputs: none + * @details Outputs: Flush mode state machine executed * @return current state *************************************************************************/ U32 execFlushMode( void ) @@ -88,9 +85,8 @@ /*********************************************************************//** * @brief * The getCurrentFlushState function returns the current state of the flush mode. - * @details - * Inputs : flushState - * Outputs : none + * @details Inputs: flushState + * @details Outputs: none * @return current state of flush mode. *************************************************************************/ DG_FLUSH_STATE_T getCurrentFlushState( void ) Index: firmware/App/Modes/ModeHeatDisinfect.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeHeatDisinfect.c (.../ModeHeatDisinfect.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Modes/ModeHeatDisinfect.c (.../ModeHeatDisinfect.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -35,9 +35,8 @@ /*********************************************************************//** * @brief * The initHeatDisinfectMode function initializes the heat disinfect mode module. - * @details - * Inputs : none - * Outputs : Initialized heat disinfect mode module + * @details Inputs: none + * @details Outputs: Initialized heat disinfect mode module * @return none *************************************************************************/ void initHeatDisinfectMode( void ) @@ -48,9 +47,8 @@ /*********************************************************************//** * @brief * The transitionToHeatDisinfectMode function prepares for transition to heat disinfect mode. - * @details - * Inputs : none - * Outputs : Prepare for transition to heat disinfect mode + * @details Inputs: none + * @details Outputs: Prepare for transition to heat disinfect mode * @return none *************************************************************************/ void transitionToHeatDisinfectMode( void ) @@ -61,9 +59,8 @@ /*********************************************************************//** * @brief * The execHeatDisinfectMode function executes the heat disinfect mode state machine. - * @details - * Inputs : none - * Outputs : Heat disinfect mode state machine executed + * @details Inputs: none + * @details Outputs: Heat disinfect mode state machine executed * @return current state *************************************************************************/ U32 execHeatDisinfectMode( void ) @@ -89,9 +86,8 @@ * @brief * The getCurrentHeatDisinfectState function returns the current state of the * heat disinfect mode. - * @details - * Inputs : heatState - * Outputs : none + * @details Inputs: heatState + * @details Outputs: none * @return the current state of heat disinfect mode. *************************************************************************/ DG_HEAT_DISINFECT_STATE_T getCurrentHeatDisinfectState( void ) Index: firmware/App/Modes/ModeInitPOST.c =================================================================== diff -u -r3e5c98eae83ce4efe2b36031d4e920bbf71fd098 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 3e5c98eae83ce4efe2b36031d4e920bbf71fd098) +++ firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -45,9 +45,8 @@ /*********************************************************************//** * @brief * The initInitAndPOSTMode function initializes the Initialization and POST mode module. - * @details - * Inputs : none - * Outputs : Initialization and POST mode module initialized + * @details Inputs: none + * @details Outputs: Initialization and POST mode module initialized * @return none *************************************************************************/ void initInitAndPOSTMode( void ) @@ -62,9 +61,8 @@ * @brief * The transitionToInitAndPOSTMode function prepares for transition to * initialization and POST mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToInitAndPOSTMode( void ) @@ -76,9 +74,8 @@ * @brief * The execInitAndPOSTMode function executes the initialization and POST * mode state machine. - * @details - * Inputs : postState - * Outputs : Initialization and POST mode state machine executed + * @details Inputs: postState + * @details Outputs: Initialization and POST mode state machine executed * @return current state. *************************************************************************/ U32 execInitAndPOSTMode( void ) @@ -171,9 +168,8 @@ * @brief * The isPOSTCompleted function determines whether all DG POST have been run * and completed. If true, call the isPOSTPassed() to see final result (pass/fail). - * @details - * Inputs : postCompleted - * Outputs : none + * @details Inputs: postCompleted + * @details Outputs: none * @return true if all HD POST tests have completed, false if not *************************************************************************/ BOOL isPOSTCompleted( void ) @@ -185,9 +181,8 @@ * @brief * The isPOSTPassed function determines whether all HD POST have passed. * Call this function after POST is complete (call isPOSTCompleted function). - * @details - * Inputs : postPassed - * Outputs : none + * @details Inputs: postPassed + * @details Outputs: none * @return true if all HD POST tests have passed, false if not *************************************************************************/ BOOL isPOSTPassed( void ) @@ -198,9 +193,8 @@ /*********************************************************************//** * @brief * The handlePOSTStatus function handles a status result returned by a POST function. - * @details - * Inputs : postPassed - * Outputs : none + * @details Inputs: postPassed + * @details Outputs: none * @param testStatus status reported by last test * @return recommended next POST state *************************************************************************/ @@ -224,9 +218,8 @@ * @brief * The getCurrentInitAndPOSTState function returns the current state of the * initialization and POST mode. - * @details - * Inputs : postState - * Outputs : none + * @details Inputs: postState + * @details Outputs: none * @return the current state of initialization and POST mode *************************************************************************/ DG_POST_STATE_T getCurrentInitAndPOSTState( void ) Index: firmware/App/Modes/ModeRecirculate.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeRecirculate.c (.../ModeRecirculate.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeRecirculate.c (.../ModeRecirculate.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -55,9 +55,8 @@ /*********************************************************************//** * @brief * The initRecirculateMode function initializes the re-circulate mode module. - * @details - * Inputs : none - * Outputs : Re-circulate mode module initialized + * @details Inputs: none + * @details Outputs: Re-circulate mode module initialized * @return none *************************************************************************/ void initRecirculateMode( void ) @@ -69,9 +68,8 @@ /*********************************************************************//** * @brief * The transitionToRecirculateMode function prepares for transition to re-circulate mode. - * @details - * Inputs : none - * Outputs : Re-initialized re-circulate mode + * @details Inputs: none + * @details Outputs: Re-initialized re-circulate mode * @return none *************************************************************************/ void transitionToRecirculateMode( void ) @@ -102,9 +100,8 @@ /*********************************************************************//** * @brief * The execRecirculateMode function executes the re-circulate mode state machine. - * @details - * Inputs : recircState - * Outputs : Check water quality, re-circulate mode state machine executed + * @details Inputs: recircState + * @details Outputs: Check water quality, re-circulate mode state machine executed * @return current state *************************************************************************/ U32 execRecirculateMode( void ) @@ -147,9 +144,8 @@ * @brief * The handleFlushLinesState function executes the flush lines state of the * re-circulate mode state machine. - * @details - * Inputs : none - * Outputs : Integrate volume of water moved through line + * @details Inputs: none + * @details Outputs: Integrate volume of water moved through line * @return the next state *************************************************************************/ static DG_RECIRCULATE_MODE_STATE_T handleFlushLinesState( void ) @@ -175,9 +171,8 @@ * @brief * The handleRecircWaterState function executes the re-circulate water state * of the re-circulate mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the next state *************************************************************************/ static DG_RECIRCULATE_MODE_STATE_T handleRecircWaterState( void ) @@ -191,9 +186,8 @@ * @brief * The handleRecircPauseState function executes the pause state of the * re-circulate mode state machine. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the next state *************************************************************************/ static DG_RECIRCULATE_MODE_STATE_T handleRecircPauseState( void ) @@ -206,9 +200,8 @@ /*********************************************************************//** * @brief * The requestDGStop function handles an HD request to stop (return to standby mode). - * @details - * Inputs : none - * Outputs : DG standby mode requested + * @details Inputs: none + * @details Outputs: DG standby mode requested * @return TRUE if request accepted, FALSE if not. *************************************************************************/ BOOL requestDGStop( void ) @@ -224,9 +217,8 @@ * @brief * The getCurrentRecirculateState function returns the current state of the * re-circulate mode. - * @details - * Inputs : recircState - * Outputs : none + * @details Inputs: recircState + * @details Outputs: none * @return the current state of re-circulate mode *************************************************************************/ DG_RECIRCULATE_MODE_STATE_T getCurrentRecirculateState( void ) Index: firmware/App/Modes/ModeService.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeService.c (.../ModeService.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeService.c (.../ModeService.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -34,9 +34,8 @@ /*********************************************************************//** * @brief * The initServiceMode function initializes the service mode module. - * @details - * Inputs : none - * Outputs : Service mode module initialized + * @details Inputs: none + * @details Outputs: Service mode module initialized * @return none *************************************************************************/ void initServiceMode( void ) @@ -47,9 +46,8 @@ /*********************************************************************//** * @brief * The transitionToServiceMode function prepares for transition to service mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void transitionToServiceMode( void ) @@ -59,9 +57,8 @@ /*********************************************************************//** * @brief * The execServiceMode function executes the service mode state machine. - * @details - * Inputs : none - * Outputs : Service mode state machine executed + * @details Inputs: none + * @details Outputs: Service mode state machine executed * @return current state. *************************************************************************/ U32 execServiceMode( void ) @@ -84,9 +81,8 @@ /*********************************************************************//** * @brief * The getCurrentServiceState function returns the current state of the service mode. - * @details - * Inputs : serviceState - * Outputs : none + * @details Inputs: serviceState + * @details Outputs: none * @return the current state of service mode *************************************************************************/ DG_SERVICE_STATE_T getCurrentServiceState( void ) Index: firmware/App/Modes/ModeSolo.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeSolo.c (.../ModeSolo.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeSolo.c (.../ModeSolo.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -38,9 +38,8 @@ /*********************************************************************//** * @brief * The initSoloMode function initializes the solo standby mode module. - * @details - * Inputs : none - * Outputs : Solo standby mode module initialized + * @details Inputs: none + * @details Outputs: Solo standby mode module initialized * @return none *************************************************************************/ void initSoloMode( void ) @@ -51,9 +50,8 @@ /*********************************************************************//** * @brief * The transitionToSoloMode function prepares for transition to solo standby mode. - * @details - * Inputs : none - * Outputs : Re-initialized solo standby mode + * @details Inputs: none + * @details Outputs: Re-initialized solo standby mode * @return none *************************************************************************/ void transitionToSoloMode( void ) @@ -64,9 +62,8 @@ /*********************************************************************//** * @brief * The execSoloMode function executes the solo standby mode state machine. - * @details - * Inputs : none - * Outputs : Solo standby mode state machine executed + * @details Inputs: none + * @details Outputs: Solo standby mode state machine executed * @return current state. *************************************************************************/ U32 execSoloMode( void ) @@ -94,9 +91,8 @@ /*********************************************************************//** * @brief * The handleIdleDGSoloStandbyState function handles the idle state of solo standby mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return the next state of solo standby mode. *************************************************************************/ static DG_SOLO_STANDBY_STATE_T handleIdleDGSoloStandbyState( void ) @@ -115,9 +111,8 @@ /*********************************************************************//** * @brief * The getCurrentSoloState function returns the current state of solo standby mode. - * @details - * Inputs : soloState - * Outputs : none + * @details Inputs: soloState + * @details Outputs: none * @return the current state of solo standby mode. *************************************************************************/ DG_SOLO_STANDBY_STATE_T getCurrentSoloState( void ) Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -49,9 +49,8 @@ /*********************************************************************//** * @brief * The initStandbyMode function initializes the standby mode module. - * @details - * Inputs : none - * Outputs : Standby mode module initialized + * @details Inputs: none + * @details Outputs: Standby mode module initialized * @return none *************************************************************************/ void initStandbyMode( void ) @@ -65,9 +64,8 @@ /*********************************************************************//** * @brief * The transitionToStandbyMode function prepares for transition to standby mode. - * @details - * Inputs : none - * Outputs : Re-initialized standby mode + * @details Inputs: none + * @details Outputs: Re-initialized standby mode * @return none *************************************************************************/ void transitionToStandbyMode( void ) @@ -92,9 +90,8 @@ /*********************************************************************//** * @brief * The execStandbyMode function executes the standby mode state machine. - * @details - * Inputs : none - * Outputs : Standby mode state machine executed + * @details Inputs: none + * @details Outputs: Standby mode state machine executed * @return current state *************************************************************************/ U32 execStandbyMode( void ) @@ -127,9 +124,8 @@ * @brief * The handleStandbyIdleState function executes the idle state of the * standby mode state machine. - * @details - * Inputs : pendingSampleWaterRequest, pendingStartDGRequest - * Outputs : Idle state of the standby mode executed + * @details Inputs: pendingSampleWaterRequest, pendingStartDGRequest + * @details Outputs: Idle state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbyIdleState( void ) @@ -163,9 +159,8 @@ * @brief * The handleStandbySampleWaterState function executes the sample water state * of the standby mode state machine. - * @details - * Inputs : none - * Outputs : Sample water state of the standby mode executed + * @details Inputs: none + * @details Outputs: Sample water state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbySampleWaterState( void ) @@ -186,9 +181,8 @@ /*********************************************************************//** * @brief * The requestWaterSample function handles an HD request to sample water. - * @details - * Inputs : standbyState - * Outputs : pendingSampleWaterRequest + * @details Inputs: standbyState + * @details Outputs: pendingSampleWaterRequest * @return TRUE if request accepted, FALSE if not. *************************************************************************/ BOOL requestWaterSample( void ) @@ -207,9 +201,8 @@ /*********************************************************************//** * @brief * The requestDGStart function handles an HD request to start (go to re-circulate mode). - * @details - * Inputs : standbyState - * Outputs : pendingSampleWaterRequest + * @details Inputs: standbyState + * @details Outputs: pendingSampleWaterRequest * @return TRUE if request accepted, FALSE if not. *************************************************************************/ BOOL requestDGStart( void ) @@ -228,9 +221,8 @@ /*********************************************************************//** * @brief * The getCurrentStandbyState function returns the current state of standby mode. - * @details - * Inputs : standbyState - * Outputs : none + * @details Inputs: standbyState + * @details Outputs: none * @return the current state of standby mode. *************************************************************************/ DG_STANDBY_MODE_STATE_T getCurrentStandbyState( void ) Index: firmware/App/Modes/OperationModes.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -76,9 +76,8 @@ /*********************************************************************//** * @brief * The initOperationModes function initializes the operation modes module. - * @details - * Inputs : none - * Outputs : Operation modes module initialized + * @details Inputs: none + * @details Outputs: Operation modes module initialized * @return none *************************************************************************/ void initOperationModes( void ) @@ -116,9 +115,8 @@ /*********************************************************************//** * @brief * The execOperationModes function executes the operation modes state machine. - * @details - * Inputs : currentMode - * Outputs : Operation modes' state machine executed + * @details Inputs: currentMode + * @details Outputs: Operation modes' state machine executed * @return none *************************************************************************/ void execOperationModes( void ) @@ -205,9 +203,8 @@ /*********************************************************************//** * @brief * The requestNewOperationMode function requests a new operation mode. - * @details - * Inputs : none - * Outputs : makes the requested mode "pending" + * @details Inputs: none + * @details Outputs: makes the requested mode "pending" * @param newMode requested mode * @return none *************************************************************************/ @@ -228,9 +225,8 @@ /*********************************************************************//** * @brief * The getCurrentOperationMode function returns the current operation mode. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return current mode *************************************************************************/ DG_OP_MODE_T getCurrentOperationMode( void ) @@ -242,9 +238,8 @@ * @brief * The arbitrateModeRequest function selects highest priority mode request * and clear all requests. - * @details - * Inputs : none - * Outputs : Arbitrated mode requests + * @details Inputs: none + * @details Outputs: Arbitrated mode requests * @return highest priority requested mode *************************************************************************/ static DG_OP_MODE_T arbitrateModeRequest( void ) @@ -281,9 +276,8 @@ * @brief * The transitionToNewOperationMode function undergo the process of transition * to new operation mode. - * @details - * Inputs : none - * Outputs : Transition to new mode + * @details Inputs: none + * @details Outputs: Transition to new mode * @param newMode new op mode to transition to * @return none *************************************************************************/ @@ -335,9 +329,8 @@ * @brief * The broadcastOperationMode function broadcasts the current operation mode at * the prescribed interval. - * @details - * Inputs : broadcastModeIntervalCtr - * Outputs : DG operation mode broadcast message sent + * @details Inputs: broadcastModeIntervalCtr + * @details Outputs: DG operation mode broadcast message sent * @return none *************************************************************************/ static void broadcastOperationMode( void ) Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -42,9 +42,8 @@ /*********************************************************************//** * @brief * The initAlarmMgmt function initializes the AlarmMgmt module. - * @details - * Inputs : none - * Outputs : AlarmMgmt module initialized. + * @details Inputs: none + * @details Outputs: AlarmMgmt module initialized. * @return none *************************************************************************/ void initAlarmMgmt( void ) @@ -64,9 +63,8 @@ /*********************************************************************//** * @brief * The execAlarmMgmt function executes the alarm management module. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ void execAlarmMgmt( void ) @@ -77,9 +75,8 @@ /*********************************************************************//** * @brief * The activateAlarm function activates a given alarm. - * @details - * Inputs : none - * Outputs : alarmIsActive[] + * @details Inputs: none + * @details Outputs: alarmIsActive[] * @param alarm ID of alarm to activate * @return none *************************************************************************/ @@ -105,9 +102,8 @@ * @brief * The activateAlarmNoData function activates a given alarm. An alarm message * is broadcast to the rest of the system. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @return none *************************************************************************/ @@ -138,9 +134,8 @@ * The activateAlarm1Data function activates a given alarm. An alarm message * is broadcast to the rest of the system. This function will include given * data in the broadcast message for logging. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @param alarmData supporting data to include in alarm message * @return none @@ -172,9 +167,8 @@ * The activateAlarm2Data function activates a given alarm. An alarm message * is broadcast to the rest of the system. This function will include * two given data in the broadcast message for logging. - * @details - * Inputs : none - * Outputs : alarm triggered message sent, alarm activated + * @details Inputs: none + * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @param alarmData1 supporting data to include in alarm message * @param alarmData2 supporting data to include in alarm message @@ -206,9 +200,8 @@ * @brief * The clearAlarm function clears a given alarm if it is recoverable. * An alarm message is broadcast to the rest of the system. - * @details - * Inputs : none - * Outputs : AlarmStatusTable[] + * @details Inputs: none + * @details Outputs: AlarmStatusTable[] * @param alarm ID of alarm to clear * @return none *************************************************************************/ @@ -244,9 +237,8 @@ /*********************************************************************//** * @brief * The isAlarmActive function determines whether a given alarm is currently active. - * @details - * Inputs : alarmIsActive[] - * Outputs : none + * @details Inputs: alarmIsActive[] + * @details Outputs: none * @param alarmID ID of alarm to check * @return TRUE if given alarm is active, FALSE if not *************************************************************************/ @@ -260,9 +252,8 @@ /*********************************************************************//** * @brief * The getAlarmActive function gets the active state of a given alarm. - * @details - * Inputs : alarmIsActive[] - * Outputs : none + * @details Inputs: alarmIsActive[] + * @details Outputs: none * @param alarmID ID of alarm to check * @return TRUE if given alarm is active, FALSE if not *************************************************************************/ @@ -298,9 +289,8 @@ * @brief * The testSetAlarmStateOverride function overrides the state of the alarm active * state for a given alarm with the alarm management with a given active state. - * @details - * Inputs : none - * Outputs : alarm activated or cleared + * @details Inputs: none + * @details Outputs: alarm activated or cleared * @param alarmID ID of alarm to activate or clear * @param value override state for the given alarm ID (1=activate, 0=clear) * @return TRUE if override successful, FALSE if not @@ -332,9 +322,8 @@ * @brief * The testResetAlarmStateOverride function resets the override of the * state of the active state for a given alarm with the alarm management. - * @details - * Inputs : none - * Outputs : alarm cleared + * @details Inputs: none + * @details Outputs: alarm cleared * @param alarmID ID of alarm to clear * @return TRUE if alarm clear successful, FALSE if not *************************************************************************/ Index: firmware/App/Services/CommBuffers.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/CommBuffers.c (.../CommBuffers.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -48,9 +48,8 @@ /*********************************************************************//** * @brief * The initCommBuffers function initializes the CommBuffers module. - * @details - * Inputs : none - * Outputs : CommBuffers module initialized. + * @details Inputs: none + * @details Outputs: CommBuffers module initialized. * @return none *************************************************************************/ void initCommBuffers( void ) @@ -68,9 +67,8 @@ * @brief * The clearBuffer function clears (empties) a given buffer. Caller should * ensure buffer won't be used while this function is clearing the buffer. - * @details - * Inputs : none - * Outputs : given buffer is cleared + * @details Inputs: none + * @details Outputs: given buffer is cleared * @param buffer the buffer to clear * @return none *************************************************************************/ @@ -101,9 +99,8 @@ * 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[] - * Outputs : commBuffers[], commBufferByteCount[] + * @details Inputs: commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: commBuffers[], commBufferByteCount[] * @param buffer which comm buffer to add data to * @param data pointer to byte array containing data to add * @param len length of data (in bytes) @@ -199,9 +196,8 @@ * 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 buffer. - * @details - * Inputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[] - * Outputs : commBuffers[], commBufferByteCount[], activeDoubleBuffer[], + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[], * and the given data array is populated with data from the buffer * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into @@ -258,9 +254,8 @@ * 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[] - * Outputs : given array populated with requested number of bytes from the buffer. + * @details Inputs: commBuffers[], commBufferByteCount[], activeDoubleBuffer[] + * @details Outputs: given array populated with requested number of bytes from the buffer. * @param buffer which comm buffer to retrieve data from * @param data pointer to byte array to stuff data into * @param len number of bytes to retrieve into given data array. @@ -312,9 +307,8 @@ * @brief * The numberOfBytesInCommBuffer function determines how many bytes are currently * contained in a given comm buffer. Both double buffers are considered for this. - * @details - * Inputs : activeDoubleBuffer[], commBufferByteCount[] - * Outputs : none + * @details Inputs: activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: none * @param buffer which comm buffer to get byte count for * @return the number of bytes in the given comm buffer. *************************************************************************/ @@ -343,9 +337,8 @@ * 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[] - * Outputs : activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: activeDoubleBuffer[] + * @details Outputs: activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer to switch double buffers on * @return the new active buffer for the given buffer. *************************************************************************/ @@ -368,9 +361,8 @@ * The getDataFromInactiveBuffer function retrieves a given number of bytes * from the inactive buffer of a given buffer. This function should only be * called by getFromCommBuffer(). Params will be pre-validated there. - * @details - * Inputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[] - * Outputs : commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Inputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] + * @details Outputs: commBuffers[], activeDoubleBuffer[], commBufferByteCount[] * @param buffer which comm buffer get data from * @param data pointer to byte array to populate with data * @param len number of bytes to get from comm buffer Index: firmware/App/Services/FPGA.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/FPGA.c (.../FPGA.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Services/FPGA.c (.../FPGA.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -221,9 +221,8 @@ /*********************************************************************//** * @brief * The initFPGA function initializes the FPGA module. - * @details - * Inputs : none - * Outputs : FPGA module initialized. + * @details Inputs: none + * @details Outputs: FPGA module initialized. * @return none *************************************************************************/ void initFPGA( void ) @@ -336,9 +335,8 @@ /*********************************************************************//** * @brief * The resetFPGACommFlags function resets the various fpga comm flags and counters. - * @details - * Inputs : none - * Outputs : fpga comm flags & counters reset + * @details Inputs: none + * @details Outputs: fpga comm flags & counters reset * @return none *************************************************************************/ static void resetFPGACommFlags( void ) @@ -356,9 +354,8 @@ * @brief * The signalFPGAReceiptCompleted function increments a counter to indicate * that another DMA receipt from the FPGA has completed. - * @details - * Inputs : none - * Outputs : fpgaReceiptCounter + * @details Inputs: none + * @details Outputs: fpgaReceiptCounter * @return none *************************************************************************/ void signalFPGAReceiptCompleted( void ) @@ -391,9 +388,8 @@ * @brief * The signalFPGATransmitCompleted function increments a counter to indicate * that another DMA transmit to the FPGA has completed. - * @details - * Inputs : none - * Outputs : fpgaReceiptCounter + * @details Inputs: none + * @details Outputs: fpgaReceiptCounter * @return none *************************************************************************/ void signalFPGATransmitCompleted( void ) @@ -404,9 +400,8 @@ /*********************************************************************//** * @brief * The execFPGA function manages incoming data exchanges with the FPGA. - * @details - * Inputs : fpgaState - * Outputs : fpgaState + * @details Inputs: fpgaState + * @details Outputs: fpgaState * @return none *************************************************************************/ void execFPGAIn( void ) @@ -457,9 +452,8 @@ /*********************************************************************//** * @brief * The execFPGAOut function manages outgoing data exchanges with the FPGA. - * @details - * Inputs : fpgaState - * Outputs : fpgaState + * @details Inputs: fpgaState + * @details Outputs: fpgaState * @return none *************************************************************************/ void execFPGAOut( void ) @@ -498,9 +492,8 @@ * @brief * The handleFPGAReadHeaderState function handles the FPGA state where * the read header registers command is sent to the FPGA. - * @details - * Inputs : none - * Outputs : read command sent to FPGA + * @details Inputs: none + * @details Outputs: read command sent to FPGA * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReadHeaderState( void ) @@ -530,9 +523,8 @@ * @brief * The handleFPGAReceiveHeaderState function handles the FPGA state * where the header registers read response should be ready to take in. - * @details - * Inputs : none - * Outputs : header register values updated + * @details Inputs: none + * @details Outputs: header register values updated * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveHeaderState( void ) @@ -582,9 +574,8 @@ * @brief * The handleFPGAWriteAllActuatorsState function handles the FPGA state * where the bulk write command is sent to the FPGA. - * @details - * Inputs : actuator set points - * Outputs : actuator set points sent to FPGA + * @details Inputs: actuator set points + * @details Outputs: actuator set points sent to FPGA * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAWriteAllActuatorsState( void ) @@ -633,9 +624,8 @@ * @brief * The handleFPGAReceiveAllSensorsState function handles the FPGA state * where the bulk read response should be ready to parse. - * @details - * Inputs : none - * Outputs : sensor values updated + * @details Inputs: none + * @details Outputs: sensor values updated * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveAllSensorsState( void ) @@ -690,9 +680,8 @@ /*********************************************************************//** * @brief * The execFPGATest function executes the FPGA self-test. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execFPGATest( void ) @@ -721,9 +710,8 @@ * @brief * The setupDMAForWriteCmd function sets the byte count for the next DMA * write command to the FPGA. - * @details - * Inputs : none - * Outputs : number of bytes for next FPGA write command is set + * @details Inputs: none + * @details Outputs: number of bytes for next FPGA write command is set * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA. * @return none *************************************************************************/ @@ -744,9 +732,8 @@ * @brief * The startDMAWriteCmd function initiates the DMA transmit for the next * DMA write command to the FPGA. - * @details - * Inputs : none - * Outputs : DMA write command to FPGA is initiated + * @details Inputs: none + * @details Outputs: DMA write command to FPGA is initiated * @return none *************************************************************************/ static void startDMAWriteCmd( void ) @@ -760,9 +747,8 @@ * @brief * The setupDMAForWriteResp function sets the expected byte count for the * next DMA write command response from the FPGA. - * @details - * Inputs : none - * Outputs : number of expected bytes for next FPGA write command response is set + * @details Inputs: none + * @details Outputs: number of expected bytes for next FPGA write command response is set * @param bytes2Receive number of bytes expected to be transmitted via DMA from the FPGA. * @return none *************************************************************************/ @@ -783,9 +769,8 @@ * @brief * The startDMAReceiptOfWriteResp function initiates readiness of the DMA * receiver for the next DMA write command response from the FPGA. - * @details - * Inputs : none - * Outputs : DMA write command response is ready to be received from the FPGA + * @details Inputs: none + * @details Outputs: DMA write command response is ready to be received from the FPGA * @return none *************************************************************************/ static void startDMAReceiptOfWriteResp( void ) @@ -799,9 +784,8 @@ * @brief * The setupDMAForReadCmd function sets the byte count for the next DMA * read command to the FPGA. - * @details - * Inputs : none - * Outputs : number of bytes for next FPGA read command is set + * @details Inputs: none + * @details Outputs: number of bytes for next FPGA read command is set * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA. * @return none *************************************************************************/ @@ -822,9 +806,8 @@ * @brief * The startDMAReadCmd function initiates the DMA transmit for the next * DMA read command to the FPGA. - * @details - * Inputs : none - * Outputs : DMA read command to FPGA is initiated + * @details Inputs: none + * @details Outputs: DMA read command to FPGA is initiated * @return none *************************************************************************/ static void startDMAReadCmd( void ) @@ -838,9 +821,8 @@ * @brief * The setupDMAForReadResp function sets the expected byte count for the * next DMA read command response from the FPGA. - * @details - * Inputs : none - * Outputs : number of expected bytes for next FPGA read command response is set + * @details Inputs: none + * @details Outputs: number of expected bytes for next FPGA read command response is set * @param bytes2Receive number of expected bytes to be transmitted via DMA from the FPGA. * @return none *************************************************************************/ @@ -861,9 +843,8 @@ * @brief * The startDMAReceiptOfReadResp function initiates readiness of the DMA * receiver for the next DMA read command response from the FPGA. - * @details - * Inputs : none - * Outputs : DMA read command response is ready to be received from the FPGA + * @details Inputs: none + * @details Outputs: DMA read command response is ready to be received from the FPGA * @return none *************************************************************************/ static void startDMAReceiptOfReadResp( void ) @@ -877,9 +858,8 @@ * @brief * The consumeUnexpectedData function checks to see if a byte is sitting in * the SCI2 received data register. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return fpgaDiag *************************************************************************/ static void consumeUnexpectedData( void ) @@ -911,9 +891,8 @@ * 10..11 - reserved (spare).\n * 12- VPd.\n * 13..15 - reserved or unused. - * @details - * Inputs : none - * Outputs : fpgaActuatorSetPoints.fpgaValveStates + * @details Inputs: none + * @details Outputs: fpgaActuatorSetPoints.fpgaValveStates * @param valveStates bit mask for the various valve states * @return none *************************************************************************/ @@ -926,9 +905,8 @@ * @brief * The setFPGADrainPumpSpeed function sets the drain pump target speed. * The drain pump DAC value should be set to 1 count for each 12.94 RPM desired. - * @details - * Inputs : none - * Outputs : fpgaActuatorSetPoints.fpgaDrainPumpSetSpeed + * @details Inputs: none + * @details Outputs: fpgaActuatorSetPoints.fpgaDrainPumpSetSpeed * @param drainPumpDAC DAC value to command for the drain pump * @return none *************************************************************************/ @@ -944,9 +922,8 @@ * @brief * The setFPGACPoProbeType function sets the CPo sensor probe type and * sets the control register to write probte type to the device. - * @details - * Inputs : none - * Outputs : fpgaActuatorSetPoints.fpgaCPoProbeType, fpgaActuatorSetPoints.fpgaCPoControlReg + * @details Inputs: none + * @details Outputs: fpgaActuatorSetPoints.fpgaCPoProbeType, fpgaActuatorSetPoints.fpgaCPoControlReg * @param probeType The probe cell constant value to set to * @return none *************************************************************************/ @@ -959,9 +936,8 @@ /*********************************************************************//** * @brief * The getFPGAVersions function gets the FPGA version numbers. - * @details - * Inputs : fpgaHeader - * Outputs : none + * @details Inputs: fpgaHeader + * @details Outputs: none * @return none *************************************************************************/ void getFPGAVersions( U08 *Id, U08 *Maj, U08 *Min, U08 *Lab ) @@ -975,9 +951,8 @@ /*********************************************************************//** * @brief * The getFPGALoadCellA1 function gets the latest load cell A 1 reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last load cell A 1 reading *************************************************************************/ U32 getFPGALoadCellA1( void ) @@ -988,9 +963,8 @@ /*********************************************************************//** * @brief * The getFPGALoadCellA2 function gets the latest load cell A 2 reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last load cell A 2 reading *************************************************************************/ U32 getFPGALoadCellA2( void ) @@ -1001,9 +975,8 @@ /*********************************************************************//** * @brief * The getFPGALoadCellB1 function gets the latest load cell B 1 reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last load cell B 1 reading *************************************************************************/ U32 getFPGALoadCellB1( void ) @@ -1014,9 +987,8 @@ /*********************************************************************//** * @brief * The getFPGALoadCellB2 function gets the latest load cell B 2 reading. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @return last load cell B 2 reading *************************************************************************/ U32 getFPGALoadCellB2( void ) @@ -1028,9 +1000,8 @@ * @brief * The getFPGAValveStates function gets the latest sensed valve states. * See setFPGAValveStates for valve state bit positions. - * @details - * Inputs : fpgaSensorReadings.fpgaValveStates - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaValveStates + * @details Outputs: none * @return last valve states reading *************************************************************************/ U16 getFPGAValveStates( void ) @@ -1041,9 +1012,8 @@ /*********************************************************************//** * @brief * The getFPGAROPumpFlowRate function gets the latest RO flow rate. - * @details - * Inputs : fpgaSensorReadings.fpgaROFlowRate - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaROFlowRate + * @details Outputs: none * @return last RO flow rate reading *************************************************************************/ U16 getFPGAROPumpFlowRate( void ) @@ -1054,9 +1024,8 @@ /*********************************************************************//** * @brief * The getFPGADrainPumpSpeed function gets the latest sensed drain pump speed. - * @details - * Inputs : fpgaSensorReadings.fpgaDrainPumpSpeed - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaDrainPumpSpeed + * @details Outputs: none * @return last drain pump speed reading *************************************************************************/ U16 getFPGADrainPumpSpeed( void ) @@ -1067,9 +1036,8 @@ /*********************************************************************//** * @brief * The getFPGATPiTemp function gets the latest primary heater inlet temperature reading. - * @details - * Inputs : fpgaSensorReadings.fpgaTPiTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTPiTemp + * @details Outputs: none * @return last primary heater inlet temperature reading *************************************************************************/ U32 getFPGATPiTemp( void ) @@ -1080,9 +1048,8 @@ /*********************************************************************//** * @brief * The getFPGATPoTemp function gets the latest primary heater outlet temperature reading. - * @details - * Inputs : fpgaSensorReadings.fpgaTPoTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTPoTemp + * @details Outputs: none * @return last primary heater outlet temperature reading *************************************************************************/ U32 getFPGATPoTemp( void ) @@ -1094,9 +1061,8 @@ * @brief * The getFPGATD1Temp function gets the latest conductivity sensor 1 * temperature reading in ADC. - * @details - * Inputs : fpgaSensorReadings.fpgaCD1Temp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCD1Temp + * @details Outputs: none * @return last conductivity sensor 1 outlet temperature reading *************************************************************************/ U32 getFPGACD1Temp( void ) @@ -1108,9 +1074,8 @@ * @brief * The getFPGATD2Temp function gets the latest conductivity sensor 2 * temperature reading in ADC. - * @details - * Inputs : fpgaSensorReadings.fpgaCD2Temp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCD2Temp + * @details Outputs: none * @return last conductivity sensor 2 outlet temperature reading *************************************************************************/ U32 getFPGACD2Temp( void ) @@ -1122,9 +1087,8 @@ * @brief * The getFPGARTDErrorCount function gets error count of the RTD. It covers * all the four temperature sensors associates with conductivity sensors. - * @details - * Inputs : fpgaSensorReadings.fpgaRTDErrorCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaRTDErrorCnt + * @details Outputs: none * @return Last error count of the RTD temperature sensors *************************************************************************/ U08 getFPGARTDErrorCount( void ) @@ -1137,9 +1101,8 @@ * The getFPGARTDReadCount function gets the read count of the RTD * temperature sensors. It covers all the four temperature sensors associates * with conductivity sensors. - * @details - * Inputs : fpgaSensorReadings.fpgaRTDReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaRTDReadCnt + * @details Outputs: none * @return Last read count of the RTC temperature sensors *************************************************************************/ U08 getFPGARTDReadCount( void ) @@ -1151,9 +1114,8 @@ * @brief * The getFPGATRoTemp function gets the latest redundant sensor outlet * temperature reading in ADC. - * @details - * Inputs : fpgaSensorReadings.fpgaTHDoTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTHDoTemp + * @details Outputs: none * @return Last redundant sensor outlet temperature reading *************************************************************************/ U32 getFPGATHDoTemp( void ) @@ -1164,9 +1126,8 @@ /*********************************************************************//** * @brief * The getFPGATHDoErrorCount gets the error count of the THDo (redundant) temperature sensor. - * @details - * Inputs : fpgaSensorReadings.fpgaTHDoErrorCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTHDoErrorCnt + * @details Outputs: none * @return Last redundant sensor outlet temperature error count *************************************************************************/ U08 getFPGATHDoErrorCount( void ) @@ -1177,9 +1138,8 @@ /*********************************************************************//** * @brief * The getFPGATHDoReadCount gets the read count of the THDo (redundant) temperature sensor. - * @details - * Inputs : fpgaSensorReadings.fpgaTHDoReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTHDoReadCnt + * @details Outputs: none * @return Last redundant sensor outlet temperature error count reading *************************************************************************/ U08 getFPGATHDoReadCount( void ) @@ -1190,9 +1150,8 @@ /*********************************************************************//** * @brief * The getFPGATDiTemp function gets the latest dialysate inlet temperature reading in ADC. - * @details - * Inputs : fpgaSensorReadings.fpgaTDiTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTDiTemp + * @details Outputs: none * @return last primary heater outlet temperature reading *************************************************************************/ U32 getFPGATDiTemp( void ) @@ -1203,9 +1162,8 @@ /*********************************************************************//** * @brief * The getFPGATDiErrorCount function gets the latest dialysate inlet temperature error count. - * @details - * Inputs : fpgaSensorReadings.fpgaTDiErrorCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTDiErrorCnt + * @details Outputs: none * @return Last dialysate inlet error count *************************************************************************/ U08 getFPGATDiErrorCount( void ) @@ -1216,9 +1174,8 @@ /*********************************************************************//** * @brief * The getFPGATDiReadCount function gets the latest dialysate inlet temperature read count. - * @details - * Inputs : fpgaSensorReadings.fpgaTDiReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTDiReadCnt + * @details Outputs: none * @return Last dialysate inlet read count *************************************************************************/ U08 getFPGATDiReadCount( void ) @@ -1230,9 +1187,8 @@ * @brief * The getFPGAPrimaryHeaterTemp function gets the latest primary heater * internal temperature reading. - * @details - * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterIntTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaPrimaryHeaterIntTemp + * @details Outputs: none * @return last primary heater temperature reading *************************************************************************/ U16 getFPGAPrimaryHeaterTemp( void ) @@ -1244,9 +1200,8 @@ * @brief * The getFPGAPrimaryHeaterFlags function gets the latest primary heater * internal temperature sensor flags read. - * @details - * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterFlags - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaPrimaryHeaterFlags + * @details Outputs: none * @return Last primary heater internal temperature sensor flag read *************************************************************************/ U08 getFPGAPrimaryHeaterFlags( void ) @@ -1258,9 +1213,8 @@ * @brief * The geetFPGAPrimaryHeaterReadCount function gets the latest primary heater * internal temperature sensor read count. - * @details - * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaPrimaryHeaterReadCnt + * @details Outputs: none * @return Last primary heater internal temperature sensor read count *************************************************************************/ U08 getFPGAPrimaryHeaterReadCount( void ) @@ -1272,9 +1226,8 @@ * @brief * The getFPGATrimmerHeaterTemp function gets the latest trimmer heater * internal temperature sensor reading. - * @details - * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterIntTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTrimmerHeaterIntTemp + * @details Outputs: none * @return last trimmer heater temperature reading *************************************************************************/ U16 getFPGATrimmerHeaterTemp( void ) @@ -1286,9 +1239,8 @@ * @brief * The getFPGATrimmerHeaterFlags function gets the latest trimmer heater * internal temperature flags read. - * @details - * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterFlags - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTrimmerHeaterFlags + * @details Outputs: none * @return Last trimmer heater internal temperature flags read *************************************************************************/ U08 getFPGATrimmerHeaterFlags( void ) @@ -1300,9 +1252,8 @@ * @brief * The getFPGATrimmerHeaterReadCount function gets the latest trimmer heater * internal temperature read count. - * @details - * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTrimmerHeaterReadCnt + * @details Outputs: none * @return Last trimmer heater internal temperature read count *************************************************************************/ U08 getFPGATrimmerHeaterReadCount( void ) @@ -1313,9 +1264,8 @@ /*********************************************************************//** * @brief * The getFPGAPrimaryColdJunctionTemp function gets primary cold junction temperature. - * @details - * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterIntJunctionTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaPrimaryHeaterIntJunctionTemp + * @details Outputs: none * @return Last primary cold junction temperature *************************************************************************/ U16 getFPGAPrimaryColdJunctionTemp( void ) @@ -1326,9 +1276,8 @@ /*********************************************************************//** * @brief * The getFPGATrimmerColdJunctionTemp function gets trimmer cold junction temperature. - * @details - * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterIntJunctionTemp - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaTrimmerHeaterIntJunctionTemp + * @details Outputs: none * @return Last trimmer cold junction temperature *************************************************************************/ U16 getFPGATrimmerColdJunctionTemp( void ) @@ -1340,9 +1289,8 @@ * @brief * The getFPGAAccelAxes function gets the accelerometer axis readings. * Axis readings are in ADC counts. 0.004 g per LSB. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param x Populate this param with X axis reading * @param y Populate this param with Y axis reading * @param z Populate this param with Z axis reading @@ -1359,9 +1307,8 @@ * @brief * The getFPGAAccelMaxes function gets the maximum accelerometer axis readings from * last FPGA read (every 10 ms). Axis readings are in ADC counts. 0.004 g per LSB. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param x Populate this param with maximum X axis reading * @param y Populate this param with maximum Y axis reading * @param z Populate this param with maximum Z axis reading @@ -1378,9 +1325,8 @@ * @brief * The getFPGAAccelStatus function gets the accelerometer reading count * and error register values. - * @details - * Inputs : fpgaSensorReadings - * Outputs : none + * @details Inputs: fpgaSensorReadings + * @details Outputs: none * @param cnt Populate this param with latest sample counter value * @param err Populate this param with latest error * @return none @@ -1394,9 +1340,8 @@ /*********************************************************************//** * @brief * The getFPGACPiFault function gets CPi conductivity sensor fault. - * @details - * Inputs : fpgaSensorReadings.fpgaCPiFault - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPiFault + * @details Outputs: none * @return Latest CPi conductivity sensor fault *************************************************************************/ U08 getFPGACPiFault( void ) @@ -1407,9 +1352,8 @@ /*********************************************************************//** * @brief * The getFPGACPiReadCount function gets CPi conductivity sensor read count. - * @details - * Inputs : fpgaSensorReadings.fpgaCPiReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPiReadCnt + * @details Outputs: none * @return Latest CPi conductivity sensor read count *************************************************************************/ U08 getFPGACPiReadCount( void ) @@ -1420,9 +1364,8 @@ /*********************************************************************//** * @brief * The getFPGACPiErrorCount function gets CPi conductivity sensor error count. - * @details - * Inputs : fpgaSensorReadings.fpgaCPiErrorCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPiErrorCnt + * @details Outputs: none * @return Latest CPi conductivity sensor read error count *************************************************************************/ U08 getFPGACPiErrorCount( void ) @@ -1433,9 +1376,8 @@ /*********************************************************************//** * @brief * The getFPGACPi function gets CPi conductivity sensor value. - * @details - * Inputs : fpgaSensorReadings.fpgaCPi - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPi + * @details Outputs: none * @return Latest CPi conductivity sensor value *************************************************************************/ U32 getFPGACPi( void ) @@ -1446,9 +1388,8 @@ /*********************************************************************//** * @brief * The getFPGACPoFault function gets CPo conductivity sensor fault. - * @details - * Inputs : fpgaSensorReadings.fpgaCPoFault - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPoFault + * @details Outputs: none * @return Latest CPo sensor fault *************************************************************************/ U08 getFPGACPoFault( void ) @@ -1459,9 +1400,8 @@ /*********************************************************************//** * @brief * The getFPGACPoReadCount function gets CPo conductivity sensor read count. - * @details - * Inputs : fpgaSensorReadings.fpgaCPoReadCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPoReadCnt + * @details Outputs: none * @return Latest CPo conductivity sensor read count *************************************************************************/ U08 getFPGACPoReadCount( void ) @@ -1473,9 +1413,8 @@ * @brief * The getFPGACPoErrorCount function gets CPo conductivity sensor error count. * error count - * @details - * Inputs : fpgaSensorReadings.fpgaCPoErrorCnt - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPoErrorCnt + * @details Outputs: none * @return Latest CPo conductivity sensor read error count *************************************************************************/ U08 getFPGACPoErrorCount( void ) @@ -1486,9 +1425,8 @@ /*********************************************************************//** * @brief * The getFPGACPo function gets CPo conductivity sensor value. - * @details - * Inputs : fpgaSensorReadings.fpgaCPo - * Outputs : none + * @details Inputs: fpgaSensorReadings.fpgaCPo + * @details Outputs: none * @return Latest CPo conductivity sensor value *************************************************************************/ U32 getFPGACPo( void ) Index: firmware/App/Services/Interrupts.c =================================================================== diff -u -r3e5c98eae83ce4efe2b36031d4e920bbf71fd098 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision 3e5c98eae83ce4efe2b36031d4e920bbf71fd098) +++ firmware/App/Services/Interrupts.c (.../Interrupts.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -60,9 +60,8 @@ /*********************************************************************//** * @brief * The initInterrupts function initializes the Interrupts module. - * @details - * Inputs : none - * Outputs : Interrupts module initialized + * @details Inputs: none + * @details Outputs: Interrupts module initialized * @return none *************************************************************************/ void initInterrupts( void ) @@ -85,9 +84,8 @@ /*********************************************************************//** * @brief * The phantomInterrupt function handles phantom interrupts. - * @details - * Inputs : none - * Outputs : phantom interrupt handled + * @details Inputs: none + * @details Outputs: phantom interrupt handled * @return none *************************************************************************/ void phantomInterrupt( void ) @@ -107,9 +105,8 @@ /*********************************************************************//** * @brief * The rtiNotification function handles real-time interrupt notifications. - * @details - * Inputs : none - * Outputs : RTI notification handled + * @details Inputs: none + * @details Outputs: RTI notification handled * @param notification Which RTI timer caused this interrupt * @return none *************************************************************************/ @@ -142,9 +139,8 @@ /*********************************************************************//** * @brief * The canMessageNotification function handles CAN message notifications. - * @details - * Inputs : none - * Outputs : CAN message notification handled + * @details Inputs: none + * @details Outputs: CAN message notification handled * @param node which CAN controller * @param messageBox which message box triggered the message notification * @return none @@ -160,9 +156,8 @@ /*********************************************************************//** * @brief * The canErrorNotification function handles CAN error notifications. - * @details - * Inputs : none - * Outputs : CAN error notification handled. + * @details Inputs: none + * @details Outputs: CAN error notification handled. * @param node which CAN controller * @param notification CAN error notification: * canLEVEL_PASSIVE (0x20) : When RX- or TX error counter are between 32 and 63 \n @@ -238,9 +233,8 @@ * @brief * The sciNotification function handles UART communication error interrupts. * Frame and Over-run errors are handled. - * @details - * Inputs : none - * Outputs : UART error interrupts handled. + * @details Inputs: none + * @details Outputs: UART error interrupts handled. * @param sci pointer to the SCI peripheral that detected the error * @param flags error flag(s) * @return none @@ -309,9 +303,8 @@ /*********************************************************************//** * @brief * The dmaGroupANotification function handles communication DMA interrupts. - * @details - * Inputs : none - * Outputs : DMA interrupt is handled. + * @details Inputs: none + * @details Outputs: DMA interrupt is handled. * @param inttype type of DMA interrupt * @param channel DMA channel that caused the interrupt * @return none Index: firmware/App/Services/MsgQueues.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/MsgQueues.c (.../MsgQueues.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -38,9 +38,8 @@ /*********************************************************************//** * @brief * The initMsgQueues function initializes the MsgQueues module. - * @details - * Inputs : none - * Outputs : MsgQueues module initialized + * @details Inputs: none + * @details Outputs: MsgQueues module initialized * @return none *************************************************************************/ void initMsgQueues( void ) @@ -64,9 +63,8 @@ * @brief * The addToMsgQueue function adds a message to a given message queue. * This function should only be called from the general task. - * @details - * Inputs : none - * Outputs : message added to queue + * @details Inputs: none + * @details Outputs: message added to queue * @param queue the message queue to add to * @param msg a pointer to a message structure to add to the queue * @return TRUE if message added to queue, FALSE if could not @@ -105,9 +103,8 @@ * @brief * The getFromMsgQueue function retrieves the next message from a given * message queue. This function should only be called from the general task. - * @details - * Inputs : queue - * Outputs : message retrieved from the queue + * @details Inputs: queue + * @details Outputs: message retrieved from the queue * @param queue the message queue to retrieve from * @param msg a pointer to a message structure to populate with the retrieved message. * @return TRUE if a message was found to retrieve, FALSE if not @@ -145,9 +142,8 @@ /*********************************************************************//** * @brief * The isMsgQueueEmpty function determines whether a given message queue is empty. - * @details - * Inputs : msgQueueCounts[] - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if a given message queue is empty, FALSE if not *************************************************************************/ @@ -174,9 +170,8 @@ /*********************************************************************//** * @brief * The isMsgQueueFull function determines whether a given message queue is full. - * @details - * Inputs : msgQueueCounts[] - * Outputs : none + * @details Inputs: msgQueueCounts[] + * @details Outputs: none * @param queue the message queue to check * @return TRUE if the given message queue is full, FALSE if not *************************************************************************/ @@ -203,9 +198,8 @@ /*********************************************************************//** * @brief * The blankMessage function blanks a given message. - * @details - * Inputs : none - * Outputs : Zeroed out the message + * @details Inputs: none + * @details Outputs: Zeroed out the message * @param message Pointer to the message to blank * @return none *************************************************************************/ @@ -225,9 +219,8 @@ /*********************************************************************//** * @brief * The blankMessageInWrapper function blanks a given message in a wrapper. - * @details - * Inputs : none - * Outputs : Zeroed out the message in wrapper + * @details Inputs: none + * @details Outputs: Zeroed out the message in wrapper * @param message pointer to the message in a wrapper to blank * @return none *************************************************************************/ Index: firmware/App/Services/PIControllers.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -60,8 +60,8 @@ * @brief * The initializePIController function initializes controller before operation. * Make sure to call it before first call to runController function. - * Inputs : none - * Outputs : PI controllers module initialized + * @details Inputs: none + * @details Outputs: PI controllers module initialized * @param controllerID ID filter number * @param initialControlSignal Value of the output on the first iteration * @param kP Coefficient for proportional @@ -102,8 +102,8 @@ * @brief * The resetPIController functions resets controller before new set point. * Make sure to call it before first call to runController function. - * Inputs : none - * Outputs : Reset a PI controller + * @details Inputs: none + * @details Outputs: Reset a PI controller * @param controllerID ID filter number * @param initialControlSignal Value of the output on the first iteration * @return none @@ -131,8 +131,8 @@ /*********************************************************************//** * @brief * The runPIController functions executes a PI controller with a new sampled measured signal. - * Inputs : none - * Outputs : Feeds new signal to PI controller + * @details Inputs: none + * @details Outputs: Feeds new signal to PI controller * @param controllerID ID filter number * @param referenceSignal reference signal value * @param measuredSignal latest measured sample @@ -179,8 +179,8 @@ /*********************************************************************//** * @brief * The getPIControllerSignals function returns the latest requested signal sample. - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @param controllerID ID filter number * @param signalID signal sample ID request * @return latest sample requested Index: firmware/App/Services/Reservoirs.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/Reservoirs.c (.../Reservoirs.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/Reservoirs.c (.../Reservoirs.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -56,9 +56,8 @@ /*********************************************************************//** * @brief * The initReservoirs function initializes the Reservoirs module. - * @details - * Inputs : none - * Outputs : Reservoirs module initialized + * @details Inputs: none + * @details Outputs: Reservoirs module initialized * @return none *************************************************************************/ void initReservoirs( void ) @@ -75,9 +74,8 @@ /*********************************************************************//** * @brief * The execReservoirs function manages periodic tasks for the Reservoirs module. - * @details - * Inputs : none - * Outputs : Reservoir data broadcast on interval + * @details Inputs: none + * @details Outputs: Reservoir data broadcast on interval * @return none *************************************************************************/ void execReservoirs( void ) @@ -97,9 +95,8 @@ * @brief * The setActiveReservoir function sets the given reservoir as active * (meaning HD will be drawing from this reservoir). - * @details - * Inputs : none - * Outputs : Specified reservoir is set as active. + * @details Inputs: none + * @details Outputs: Specified reservoir is set as active. * @param resID ID of reservoir to set as active * @return TRUE if set active reservoir command successful, FALSE if not. *************************************************************************/ @@ -142,9 +139,8 @@ /*********************************************************************//** * @brief * The startFill function handles a fill command from the HD. - * @details - * Inputs : none - * Outputs : move to fill mode + * @details Inputs: none + * @details Outputs: move to fill mode * @param fillToVolMl Target volume (in mL) to fill reservoir to * @return TRUE if fill command successful, FALSE if not. *************************************************************************/ @@ -171,9 +167,8 @@ /*********************************************************************//** * @brief * The stopFill function handles a stop fill command from the HD. - * @details - * Inputs : none - * Outputs : move to standby mode + * @details Inputs: none + * @details Outputs: move to standby mode * @return TRUE if stop fill command successful, FALSE if not. *************************************************************************/ BOOL stopFillCmd( void ) @@ -194,9 +189,8 @@ /*********************************************************************//** * @brief * The startDrain function handles a drain command from the HD. - * @details - * Inputs : none - * Outputs : Start draining in re-circulate mode + * @details Inputs: none + * @details Outputs: Start draining in re-circulate mode * @param drainToVolMl Target volume (in mL) to drain reservoir to * @return TRUE if drain command successful, FALSE if not. *************************************************************************/ @@ -222,9 +216,8 @@ /*********************************************************************//** * @brief * The stopDrain function handles a stop drain command from the HD. - * @details - * Inputs : none - * Outputs : move to standby mode + * @details Inputs: none + * @details Outputs: move to standby mode * @return TRUE if stop drain command successful, FALSE if not. *************************************************************************/ BOOL stopDrainCmd( void ) @@ -246,9 +239,8 @@ * @brief * The startTrimmerHeater function handles a start trimmer heater command * from the HD. - * @details - * Inputs : none - * Outputs : start trimmer heater + * @details Inputs: none + * @details Outputs: start trimmer heater * @return TRUE if stop drain command successful, FALSE if not. *************************************************************************/ BOOL startTrimmerHeaterCmd( void ) @@ -264,9 +256,8 @@ * @brief * The stopTrimmerHeater function handles a stop trimmer heater command * from the HD. - * @details - * Inputs : none - * Outputs : stop trimmer heater + * @details Inputs: none + * @details Outputs: stop trimmer heater * @return TRUE if stop drain command successful, FALSE if not. *************************************************************************/ BOOL stopTrimmerHeaterCmd( void ) @@ -281,9 +272,8 @@ /*********************************************************************//** * @brief * The getActiveReservoir function gets the active reservoir. - * @details - * Inputs : activeReservoir - * Outputs : none + * @details Inputs: activeReservoir + * @details Outputs: none * @return the currently active reservoir. *************************************************************************/ RESERVOIR_ID_T getActiveReservoir( void ) @@ -301,9 +291,8 @@ /*********************************************************************//** * @brief * The getReservoirFillVolumeTargetMl function gets the reservoir fill volume (in mL). - * @details - * Inputs : fillVolumeTargetMl - * Outputs : none + * @details Inputs: fillVolumeTargetMl + * @details Outputs: none * @return the current target reservoir fill volume (in mL). *************************************************************************/ U32 getReservoirFillVolumeTargetMl( void ) @@ -321,9 +310,8 @@ /*********************************************************************//** * @brief * The getReservoirDrainVolumeTargetMl function gets the reservoir drain volume (in mL). - * @details - * Inputs : drainVolumeTargetMl - * Outputs : none + * @details Inputs: drainVolumeTargetMl + * @details Outputs: none * @return the current target reservoir drain volume (in mL). *************************************************************************/ U32 getReservoirDrainVolumeTargetMl( void ) @@ -347,9 +335,8 @@ /*********************************************************************//** * @brief * The testSetDGActiveReservoirOverride function overrides the active reservoir. - * @details - * Inputs : activeReservoir - * Outputs : activeReservoir + * @details Inputs: activeReservoir + * @details Outputs: activeReservoir * @param value override active reservoir ID * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -370,9 +357,8 @@ /*********************************************************************//** * @brief * The activeReservoir function resets the override of the active reservoir. - * @details - * Inputs : activeReservoir - * Outputs : activeReservoir + * @details Inputs: activeReservoir + * @details Outputs: activeReservoir * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetDGActiveReservoirOverride( void ) @@ -393,9 +379,8 @@ * @brief * The testSetReservoirFillVolumeMlOverride function overrides the target * reservoir fill volume (in mL). - * @details - * Inputs : fillVolumeTargetMl - * Outputs : fillVolumeTargetMl + * @details Inputs: fillVolumeTargetMl + * @details Outputs: fillVolumeTargetMl * @param value override target reservoir fill volume (in mL) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -417,9 +402,8 @@ * @brief * The testResetReservoirFillVolumeMlOverride function resets the override of * the target reservoir fill volume. - * @details - * Inputs : fillVolumeTargetMl - * Outputs : fillVolumeTargetMl + * @details Inputs: fillVolumeTargetMl + * @details Outputs: fillVolumeTargetMl * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetReservoirFillVolumeMlOverride( void ) @@ -440,9 +424,8 @@ * @brief * The testSetReservoirDrainVolumeMlOverride function overrides the target * reservoir drain volume (in mL). - * @details - * Inputs : drainVolumeTargetMl - * Outputs : drainVolumeTargetMl + * @details Inputs: drainVolumeTargetMl + * @details Outputs: drainVolumeTargetMl * @param value override target reservoir drain volume (in mL) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -464,9 +447,8 @@ * @brief * The testResetReservoirDrainVolumeMlOverride function resets the override of * the target reservoir drain volume. - * @details - * Inputs : drainVolumeTargetMl - * Outputs : drainVolumeTargetMl + * @details Inputs: drainVolumeTargetMl + * @details Outputs: drainVolumeTargetMl * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetReservoirDrainVolumeMlOverride( void ) Index: firmware/App/Services/SystemComm.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -146,9 +146,8 @@ /*********************************************************************//** * @brief * The initSystemComm function initializes the SystemComm module. - * @details - * Inputs : none - * Outputs : SystemComm module initialized. + * @details Inputs: none + * @details Outputs: SystemComm module initialized. * @return none *************************************************************************/ void initSystemComm( void ) @@ -174,9 +173,8 @@ * @brief * The isHDCommunicating function determines whether the HD is communicating * with the DG. - * @details - * Inputs : hdIsCommunicating - * Outputs : none + * @details Inputs: hdIsCommunicating + * @details Outputs: none * @return TRUE if HD has broadcast since last call, FALSE if not *************************************************************************/ BOOL isHDCommunicating( void ) @@ -188,9 +186,8 @@ * @brief * The isDGOnlyCANNode function determines whether the DG is the only node * currently on the CAN bus. - * @details - * Inputs : dgIsOnlyCANNode - * Outputs : none + * @details Inputs: dgIsOnlyCANNode + * @details Outputs: none * @return TRUE if DG is only node on CAN bus, FALSE if not *************************************************************************/ BOOL isDGOnlyCANNode( void ) @@ -201,9 +198,8 @@ /*********************************************************************//** * @brief * The execSystemCommRx function manages received data from other sub-systems. - * @details - * Inputs : none - * Outputs : Incoming frames processed. + * @details Inputs: none + * @details Outputs: Incoming frames processed. * @return none *************************************************************************/ void execSystemCommRx( void ) @@ -224,9 +220,8 @@ /*********************************************************************//** * @brief * The execSystemCommTx function manages data to be transmitted to other sub-systems. - * @details - * Inputs : none - * Outputs : Next outgoing frame transmitted. + * @details Inputs: none + * @details Outputs: Next outgoing frame transmitted. * @return none *************************************************************************/ void execSystemCommTx( void ) @@ -292,9 +287,8 @@ * 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 - * Outputs : message interrupt handled + * @details Inputs: none + * @details Outputs: message interrupt handled * @param srcCANBox which CAN message box triggered this interrupt * @return none *************************************************************************/ @@ -338,9 +332,8 @@ * @brief * The handleUARTMsgRecvPacketInterrupt function handles a DMA UART receive * packet completed interrupt. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -359,9 +352,8 @@ * @brief * The handleUARTMsgXmitPacketInterrupt function handles a DMA UART transmit * packet completed interrupt. - * @details - * Inputs : none - * Outputs : none + * @details Inputs: none + * @details Outputs: none * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -380,9 +372,8 @@ * @brief * The initUARTAndDMA function initializes the SCI1 peripheral and the DMA * to go with it for PC communication. - * @details - * Inputs : none - * Outputs : SCI1 and DMA initialized + * @details Inputs: none + * @details Outputs: SCI1 and DMA initialized * @return none *************************************************************************/ #ifdef DEBUG_ENABLED @@ -445,9 +436,8 @@ * @brief * The isCANBoxForXmit function determines whether a given CAN message box * is configured for transmit. - * @details - * Inputs : CAN_OUT_BUFFERS[] - * Outputs : none + * @details Inputs: CAN_OUT_BUFFERS[] + * @details Outputs: none * @param srcCANBox which CAN message box to check * @return TRUE if the given CAN message box is configured for transmit, FALSE if not. *************************************************************************/ @@ -472,9 +462,8 @@ * @brief * The isCANBoxForRecv function determines whether a given CAN message box * is configured for receiving. - * @details - * Inputs : MSG_IN_BUFFERS[] - * Outputs : none + * @details Inputs: MSG_IN_BUFFERS[] + * @details Outputs: none * @param srcCANBox which CAN message box to check * @return TRUE if the given CAN message box is configured for receiving, FALSE if not. *************************************************************************/ @@ -498,9 +487,8 @@ /*********************************************************************//** * @brief * The clearCANXmitBuffers function clears all CAN transmit buffers. - * @details - * Inputs : CAN_OUT_BUFFERS[] - * Outputs : CAN transmit buffers cleared. + * @details Inputs: CAN_OUT_BUFFERS[] + * @details Outputs: CAN transmit buffers cleared. * @return none *************************************************************************/ static void clearCANXmitBuffers( void ) @@ -522,9 +510,8 @@ * @brief * The findNextHighestPriorityCANPacketToTransmit function gets the next * 8 byte packet and initiates a CAN transmit on the appropriate CAN channel. - * @details - * Inputs : Output CAN Comm Buffer(s) - * Outputs : none + * @details Inputs: Output CAN Comm Buffer(s) + * @details Outputs: none * @return buffer with highest priority CAN packet to transmit, * COMM_BUFFER_NOT_USED if not CAN packets pending transmit found *************************************************************************/ @@ -550,9 +537,8 @@ * @brief * The transmitNextCANPacket function gets the next 8 byte packet and initiates * a CAN transmit on the appropriate CAN channel. - * @details - * Inputs : Output CAN Comm Buffers - * Outputs : CAN packet transmit initiated. + * @details Inputs: Output CAN Comm Buffers + * @details Outputs: CAN packet transmit initiated. * @return number of bytes transmitted *************************************************************************/ static U32 transmitNextCANPacket( void ) @@ -600,9 +586,8 @@ * @brief * The transmitNextUARTPacket function sets up and initiates a DMA transmit * of the next packet pending transmit (if any) via UART. - * @details - * Inputs : Output UART Comm Buffer(s) - * Outputs : UART DMA transmit initiated. + * @details Inputs: Output UART Comm Buffer(s) + * @details Outputs: UART DMA transmit initiated. * @return number of bytes transmitted *************************************************************************/ #ifdef DEBUG_ENABLED @@ -639,9 +624,8 @@ * @brief * The processIncomingData function parses out messages from the input * comm buffers and adds them to the received message queue. - * @details - * Inputs : Input Comm Buffers - * Outputs : Parsed message(s) added to received message queue + * @details Inputs: Input Comm Buffers + * @details Outputs: Parsed message(s) added to received message queue * @return none *************************************************************************/ static void processIncomingData( void ) @@ -723,9 +707,8 @@ * @brief * The consumeBufferPaddingBeforeSync function removes any bytes in a given * buffer that lie before a sync byte. - * @details - * Inputs : none - * Outputs : Any padding at front of comm buffer is consumed. + * @details Inputs: none + * @details Outputs: Any padding at front of comm buffer is consumed. * @param buffer the comm buffer to process * @return none *************************************************************************/ @@ -754,9 +737,8 @@ * @brief * The parseMessageFromBuffer function looks for a complete message in a * given buffer. If a message is found, its size is returned. - * @details - * Inputs : none - * Outputs : If a complete message can be found in buffer contents, it is parsed out. + * @details Inputs: none + * @details Outputs: If a complete message can be found in buffer contents, it is parsed out. * @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, @@ -806,9 +788,8 @@ * @brief * The processReceivedMessages function processes any messages in the * received message queues. - * @details - * Inputs : Received Message Queues - * Outputs : Message(s) processed. + * @details Inputs: Received Message Queues + * @details Outputs: Message(s) processed. * @return none *************************************************************************/ static void processReceivedMessages( void ) @@ -851,9 +832,8 @@ /*********************************************************************//** * @brief * The checkForCommTimeouts function checks for sub-system communication timeout errors. - * @details - * Inputs : timeOfLastDGCheckIn, timeOfLastUICheckIn - * Outputs : possibly a comm t/o alarm + * @details Inputs: timeOfLastDGCheckIn, timeOfLastUICheckIn + * @details Outputs: possibly a comm t/o alarm * @return none *************************************************************************/ static void checkForCommTimeouts( void ) @@ -872,9 +852,8 @@ * The checkTooManyBadMsgCRCs function checks for too many bad message CRCs * within a set period of time. Assumed function is being called when a new * bad CRC is detected so a new bad CRC will be added to the list. - * @details - * Inputs : badCRCTimeStamps[], badCRCListIdx, badCRCListCount - * Outputs : possibly a "too many bad CRCs" alarm + * @details Inputs: badCRCTimeStamps[], badCRCListIdx, badCRCListCount + * @details Outputs: possibly a "too many bad CRCs" alarm * @return none *************************************************************************/ static void checkTooManyBadMsgCRCs( void ) @@ -898,9 +877,8 @@ * The addMsgToPendingACKList function adds a given message to the pending * ACK list. Messages in this list will require receipt of an ACK message * for this particular message within a limited time. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @param msg pointer to msg within the message data * @param msgData pointer to message data to add to pending ACK list * @param len number of bytes of message data @@ -944,9 +922,8 @@ * The matchACKtoPendingACKList function searches the pending ACK list to * see if the sequence number from a received ACK msg matches any. If found, * the list entry is removed. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @param seqNo sequence number to match to an entry in the list * @return TRUE if a match was found, FALSE if not *************************************************************************/ @@ -974,9 +951,8 @@ * The checkPendingACKList function searches the pending ACK list to see if * any have expired. Any such messages will be queued for retransmission * and if max retries reached a fault is triggered. - * @details - * Inputs : pendingAckList[] - * Outputs : pendingAckList[] + * @details Inputs: pendingAckList[] + * @details Outputs: pendingAckList[] * @return none *************************************************************************/ static void checkPendingACKList( void ) @@ -1010,9 +986,8 @@ /*********************************************************************//** * @brief * The processReceivedMessage function processes a given message. - * @details - * Inputs : none - * Outputs : message processed + * @details Inputs: none + * @details Outputs: message processed * @param message pointer to message to process * @return none *************************************************************************/ Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -73,9 +73,8 @@ * bit of the sequence # is set if ACK is required per parameter. A sync byte * is inserted at the beginning of the message and an 8-bit CRC is appended to * the end of the message. The message is queued for transmission in the given buffer. - * @details - * Inputs : none - * Outputs : given data array populated with serialized message data and queued for transmit. + * @details Inputs: none + * @details Outputs: given data array populated with serialized message data and queued for transmit. * @param msg message to serialize * @param buffer outgoing buffer that message should be queued in * @param ackReq is an acknowledgement from receiver required? @@ -153,9 +152,8 @@ * @brief * The sendACKMsg function constructs and queues for transmit an ACK message * for a given received message. - * @details - * Inputs : none - * Outputs : ACK message queued for transmit on broadcast CAN channel. + * @details Inputs: none + * @details Outputs: ACK message queued for transmit on broadcast CAN channel. * @param message message to send an ACK for * @return TRUE if ACK message queued successfully, FALSE if not *************************************************************************/ @@ -183,9 +181,8 @@ * @brief * The sendTestAckResponseMsg function constructs a simple response message for * a handled test message and queues it for transmit on the appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param buffer outgoing buffer that message should be queued in * @param ack TRUE if test message was handled successfully, FALSE if not @@ -217,9 +214,8 @@ * @brief * The broadcastAlarmTriggered function constructs an alarm triggered msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm triggered msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm triggered msg constructed and queued. * @param alarm ID of alarm triggered * @param almData1 1st data associated with alarm * @param almData2 2nd data associated with alarm @@ -252,9 +248,8 @@ * @brief * The broadcastAlarmCleared function constructs an alarm cleared msg to be * broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : alarm cleared msg constructed and queued. + * @details Inputs: none + * @details Outputs: alarm cleared msg constructed and queued. * @param alarm ID of alarm cleared * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -281,9 +276,8 @@ * @brief * The broadcastAccelData function constructs an accelerometer data msg to * be broadcast and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : accelerometer data broadcast msg constructed and queued. + * @details Inputs: none + * @details Outputs: accelerometer data broadcast msg constructed and queued. * @param x X axis vector magnitude (in g) * @param y Y axis vector magnitude (in g) * @param z Z axis vector magnitude (in g) @@ -328,9 +322,8 @@ * @brief * The broadcastRTCEpoch function constructs an epoch msg to be broadcast * and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : RTC time and date in epoch + * @details Inputs: none + * @details Outputs: RTC time and date in epoch * @param epoch Current time and date in epoch * @return TRUE if msg successfully queued for transmit, FALSE if not *************************************************************************/ @@ -357,9 +350,8 @@ * @brief * The broadcastDGHDOperationMode function constructs a DG operation mode * broadcast message and queues the msg for transmit on the appropriate CAN channel. - * @details - * Inputs : none - * Outputs : DG operation mode msg constructed and queued + * @details Inputs: none + * @details Outputs: DG operation mode msg constructed and queued * @param mode current operation mode of the DG. * @param subMode current sub-mode of the current operation mode of the DG. * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -388,9 +380,8 @@ /*********************************************************************//** * @brief * The broadcastLoadCellData function sends out load cell data. - * @details - * Inputs : none - * Outputs : load cell data msg constructed and queued + * @details Inputs: none + * @details Outputs: load cell data msg constructed and queued * @param loadCellA1 load cell A 1 data in grams * @param loadCellA2 load cell A 2 data in grams * @param loadCellB1 load cell B 1 data in grams @@ -425,9 +416,8 @@ /*********************************************************************//** * @brief * The broadcastValvesStates function sends out DG valves states. - * @details - * Inputs : none - * Outputs : Valves states msg constructed and queued + * @details Inputs: none + * @details Outputs: Valves states msg constructed and queued * @param valvesStates valves states * refer to setFPGAValveStates function in FPGA.c for details * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -454,9 +444,8 @@ /*********************************************************************//** * @brief * The broadcastHeatersData function sends out DG heaters data - * @details - * Inputs : heaters data - * Outputs : heatears data msg constructed and queued + * @details Inputs: heaters data + * @details Outputs: heatears data msg constructed and queued * @param mainPrimaryDC main primary heater duty cycle * @param smallPrimaryDC small primary heater duty cycle * @param trimmerDC trimmer heater duty cycle @@ -489,9 +478,8 @@ /*********************************************************************//** * @brief * The broadcastROPumpData function sends out RO pump data. - * @details - * Inputs : none - * Outputs : RO pump data msg constructed and queued + * @details Inputs: none + * @details Outputs: RO pump data msg constructed and queued * @param tgtPressure target pressure for RO pump in PSI * @param measFlow measure RO flow rate in LPM * @param setPWM set PWM duty cycle in % @@ -524,9 +512,8 @@ /*********************************************************************//** * @brief * The broadcastDrainPumpData function sends out RO pump data. - * @details - * Inputs : none - * Outputs : Drain pump data msg constructed and queued + * @details Inputs: none + * @details Outputs: Drain pump data msg constructed and queued * @param tgtSpeed target speed for drain pump in RPM * @param dac set DAC value * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -557,9 +544,8 @@ /*********************************************************************//** * @brief * The broadcastPressureSensorsData function sends out DG pressure data. - * @details - * Inputs : none - * Outputs : Pressure data msg constructed and queued + * @details Inputs: none + * @details Outputs: Pressure data msg constructed and queued * @param measROIn measured RO pump inlet pressure in PSI * @param measROOut measured RO pump outlet pressure in PSI * @param measDrainIn measured Drain pump inlet pressure in PSI @@ -594,9 +580,8 @@ /*********************************************************************//** * @brief * The broadcastReservoirData function broadcasts the DG reservoir data. - * @details - * Inputs : none - * Outputs : Reservoir data msg constructed and queued + * @details Inputs: none + * @details Outputs: Reservoir data msg constructed and queued * @param resID ID of currently active reservoir * @param fillToVol Current target fill to volume for inactive reservoir * @param drainToVol Current target drain to volume for inactive reservoir @@ -630,8 +615,8 @@ * @brief * The broadcastTemperatureSensorsData function sends out DG temperature * sensors data. - * Inputs : none - * Outputs : temperature sensors data message constructed and queued + * @details Inputs: none + * @details Outputs: temperature sensors data message constructed and queued * @param sensorsValue sensors value array * @param byteLength payload length in bytes * @return TRUE if msg successfully queued for transmit, FALSE if not @@ -658,9 +643,8 @@ /*********************************************************************//** * @brief * The broadcastConductivityData function sends out conductivity data. - * @details - * Inputs : none - * Outputs : conductivity data message constructed and queued + * @details Inputs: none + * @details Outputs: conductivity data message constructed and queued * @param roRejectionRatio RO rejection ratio * @param cpi water inlet conductivity data * @param cpo water outlet conductivity data @@ -699,9 +683,8 @@ * @brief * The handlePowerOffWarning function handles a power off warning message * from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -717,9 +700,8 @@ * @brief * The handleSetDialysateTemperatureCmd function handles a dialysate temperature * set points message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -742,9 +724,8 @@ /*********************************************************************//** * @brief * The handleFWVersionCmd function handles a FW version request message. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -777,9 +758,8 @@ * @brief * The handleSwitchReservoirCmd function handles a switch reservoirs command * from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -804,9 +784,8 @@ /*********************************************************************//** * @brief * The handleFillCmd function handles a fill command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -829,9 +808,8 @@ /*********************************************************************//** * @brief * The handleDrainCmd function handles a drain command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -856,9 +834,8 @@ * @brief * The handleStartStopTreatmentMsg function handles a treatment start/stop * message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -889,9 +866,8 @@ * @brief * The handleStartStopTrimmerHeaterCmd function handles a trimmer heater start/stop * command message from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -921,9 +897,8 @@ /*********************************************************************//** * @brief * The handleSampleWaterCmd function handles a sample water command from the HD. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -946,9 +921,8 @@ * @brief * The handleSetRTCTimestamp function handles a request to write time and * date to RTC - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -973,9 +947,8 @@ * @brief * The handleStartStopPrimaryHeater function handles a request start or * stop the primary heater - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return result *************************************************************************/ @@ -1016,8 +989,8 @@ * @brief * The sendDebugData function sends debug data out to the PC port. * @details - * Inputs : none - * Outputs : PC serial port + * @details Inputs: none + * @details Outputs: PC serial port * @param dbgData Pointer to debug data * @param len number of bytes of debug data * @return TRUE if debug data was successfully queued for transmit, FALSE if not @@ -1036,8 +1009,8 @@ * @brief * The sendDebugDataToUI function sends debug string to the UI for logging. * @details - * Inputs : none - * Outputs : Message constructed and queued for transmit + * @details Inputs: none + * @details Outputs: Message constructed and queued for transmit * @param str Pointer to debug string * @return none *************************************************************************/ @@ -1065,9 +1038,8 @@ * @brief * The isTestingActivated function determines whether a tester has successfully * logged in to activate testing functionality. - * @details - * Inputs : testerLoggedIn - * Outputs : none + * @details Inputs: testerLoggedIn + * @details Outputs: none * @return TRUE if a tester has logged in to activate testing, FALSE if not *************************************************************************/ BOOL isTestingActivated( void ) @@ -1079,9 +1051,8 @@ * @brief * The sendTestAckResponseMsg function constructs a simple response message for * a handled test message and queues it for transmit on the appropriate UART channel. - * @details - * Inputs : none - * Outputs : response message constructed and queued for transmit. + * @details Inputs: none + * @details Outputs: response message constructed and queued for transmit. * @param msgID ID of handled message that we are responding to * @param ack TRUE if test message was handled successfully, FALSE if not * @return TRUE if response message successfully queued for transmit, FALSE if not @@ -1106,9 +1077,8 @@ /*********************************************************************//** * @brief * The handleTesterLogInRequest function handles a request to login as a tester. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1132,9 +1102,8 @@ * @brief * The handleTestWatchdogCheckInStateOverrideRequest function handles a * request to override the check-in status of a given task. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1165,9 +1134,8 @@ * @brief * The handleTestAlarmStateOverrideRequest function handles a request to * override the active status of a given alarm. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1198,9 +1166,8 @@ * @brief * The handleTestLoadCellOverrideRequest function handles a request to * override the value read from the given load cell. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1231,9 +1198,8 @@ * @brief * The handleTestTemperatureSensorsOverrideRequest function handles a * request to override a temperatures sensor's value. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1265,8 +1231,8 @@ * The handleTestTemperatureSensorsDataPublishOverrideRequest function handles * a request to override the publish interval of temperature sensors data. * @details -* Inputs : none -* Outputs : message handled +* @details Inputs: none +* @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1297,9 +1263,8 @@ * @brief * The handleTestHeatersDataPublishOverrideRequest function handles * a request to override the publish interval of heaters data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1330,9 +1295,8 @@ * @brief * The handleTestLoadCellDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for load cell data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1363,9 +1327,8 @@ * @brief * The handleTestPressureSensorOverrideRequest function handles a request to * override the value read from the given pressure sensor. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1396,9 +1359,8 @@ * @brief * The handleTestPressureDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for load cell data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1429,9 +1391,8 @@ * @brief * The handleTestROPumpSetPointOverrideRequest function handles a request to * override the RO pump pressure set point (in PSI). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1462,9 +1423,8 @@ * @brief * The handleTestROMeasuredFlowOverrideRequest function handles a request to * override the RO flow rate. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1495,9 +1455,8 @@ * @brief * The handleTestROPumpDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for RO pump data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1528,9 +1487,8 @@ * @brief * The handleTestDrainPumpSetPointOverrideRequest function handles a request to * override the drain pump speed set point (in RPM). - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1561,9 +1519,8 @@ * @brief * The handleTestDrainPumpDataBroadcastIntervalOverrideRequest function handles * a request to override the broadcast interval for drain pump data. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1594,9 +1551,8 @@ * @brief * The handleTestValveStateOverrideRequest function handles a request to * override the state value read from the given valve. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1627,9 +1583,8 @@ * @brief * The handleTestValvesStatesPublishIntervalOverrideRequest function handles * a request to override the publish interval of valves states from the given valve. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1660,9 +1615,8 @@ * @brief * The handleTestDGSafetyShutdownOverrideRequest function handles a * request to override the safety shutdown signal. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1693,9 +1647,8 @@ * @brief * The handleTestDGAccelOverrideRequest function handles a request to * override the measured accelerometer sensor readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1726,9 +1679,8 @@ * @brief * The handleTestDGAccelMaxOverrideRequest function handles a request to * override the measured accelerometer sensor maximum readings. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1759,9 +1711,8 @@ * @brief * The handleTestDGAccelBroadcastIntervalOverrideRequest function handles a * request to override the broadcast interval for accelerometer data messages. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1792,9 +1743,8 @@ * @brief * The handleSetAccelCalibration function handles a request to set * accelerometer calibration factors. - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1818,9 +1768,8 @@ * @brief * The handleTestSetConductivityOverrideRequest function handles a * request to override a conductivity sensor's value - * @details - * Inputs : none - * Outputs : message handled + * @details Inputs: none + * @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ @@ -1852,8 +1801,8 @@ * The handleTestSetConductivityDataPublishIntervalOverrideRequest function * handles a request to override the publish interval of conductivity sensors data * @details -* Inputs : none -* Outputs : message handled +* @details Inputs: none +* @details Outputs: message handled * @param message a pointer to the message to handle * @return none *************************************************************************/ Index: firmware/App/Services/WatchdogMgmt.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Services/WatchdogMgmt.c (.../WatchdogMgmt.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -61,9 +61,8 @@ /*********************************************************************//** * @brief * The initWatchdogMgmt function initializes the WatchdogMgmt module. - * @details - * Inputs : none - * Outputs : WatchdogMgmt module initialized. + * @details Inputs: none + * @details Outputs: WatchdogMgmt module initialized. * @return none *************************************************************************/ void initWatchdogMgmt( void ) @@ -87,9 +86,8 @@ /*********************************************************************//** * @brief * The execWatchdogMgmt function executes the watchdog management service. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : Pets watchdog when all tasks checked in + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: Pets watchdog when all tasks checked in * @return none *************************************************************************/ void execWatchdogMgmt( void ) @@ -126,9 +124,8 @@ * @brief * The checkInWithWatchdogMgmt function checks a given task in with the * watchdog management service. - * @details - * Inputs : none - * Outputs : task is checked in with the watchdog management + * @details Inputs: none + * @details Outputs: task is checked in with the watchdog management * @param task the task that is checking in with the watchdog management * @return none *************************************************************************/ @@ -144,9 +141,8 @@ * @brief * The execWatchdogTest function executes the watchdog test. This function * should be called periodically until a pass or fail result is returned. - * @details - * Inputs : watchdogSelfTestState - * Outputs : Executed watchdog self-test + * @details Inputs: watchdogSelfTestState + * @details Outputs: Executed watchdog self-test * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execWatchdogTest( void ) @@ -204,9 +200,8 @@ /*********************************************************************//** * @brief * The resetWDTaskCheckIns function resets the task check-ins with the watchdog. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] array reset to all false. + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] array reset to all false. * @return none *************************************************************************/ static void resetWDTaskCheckIns( void ) @@ -224,9 +219,8 @@ * @brief * The haveAllTasksCheckedIn function determines whether all tasks have * checked in with watchdog mgmt. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : none + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: none * @return TRUE if all tasks have checked in since last watchdog pet, FALSE if not. *************************************************************************/ static BOOL haveAllTasksCheckedIn( void ) @@ -250,9 +244,8 @@ /*********************************************************************//** * @brief * The hasTaskGeneralCheckedIn function gets the check-in state of a given task. - * @details - * Inputs : watchdogTaskCheckedIn[] - * Outputs : none + * @details Inputs: watchdogTaskCheckedIn[] + * @details Outputs: none * @param task ID of task to check * @return TRUE if given task has checked in, FALSE if not *************************************************************************/ @@ -282,9 +275,8 @@ /*********************************************************************//** * @brief * The petWatchdog function pets the watchdog by pulsing the CPLD WD pet signal. - * @details - * Inputs : none - * Outputs : CPLD WD pet signal is pulsed + * @details Inputs: none + * @details Outputs: CPLD WD pet signal is pulsed * @return none *************************************************************************/ static void petWatchdog( void ) @@ -306,9 +298,8 @@ * @brief * The testSetWatchdogTaskCheckInOverride function overrides the state of the * task check-in with the watchdog management with a given check-in state. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] * @param task ID of task to override check-in state for * @param value override state for the given task ID * @return TRUE if override successful, FALSE if not @@ -334,9 +325,8 @@ * @brief * The testResetWatchdogTaskCheckInOverride function resets the override of the * state of the check-in with the watchdog management. - * @details - * Inputs : none - * Outputs : watchdogTaskCheckedIn[] + * @details Inputs: none + * @details Outputs: watchdogTaskCheckedIn[] * @param task ID of task to override check-in state for * @return TRUE if override reset successful, FALSE if not *************************************************************************/ Index: firmware/App/Tasks/TaskBG.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -28,9 +28,8 @@ /*********************************************************************//** * @brief * The taskBackground function handles the idle background task loop. - * @details - * Inputs : none - * Outputs : Executes the watchdog manangement service + * @details Inputs: none + * @details Outputs: Executes the watchdog manangement service * return none *************************************************************************/ void taskBackground( void ) Index: firmware/App/Tasks/TaskGeneral.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -45,9 +45,8 @@ * The taskGeneral function handles the scheduled general task interrupt. * Calls the executive functions for most monitors and controllers, the * operation modes, the system communications, and alarms. - * @details - * Inputs : none - * Outputs : Executed all general task functions. + * @details Inputs: none + * @details Outputs: Executed all general task functions. * @return none *************************************************************************/ void taskGeneral( void ) Index: firmware/App/Tasks/TaskPriority.c =================================================================== diff -u -r54f45c387430e440ab4607451fc84dea61f273f1 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 54f45c387430e440ab4607451fc84dea61f273f1) +++ firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -47,9 +47,8 @@ * @brief * The taskPriority function handles the scheduled priority task interrupt. * Calls the executive functions for FPGA, pumps, valves, and buttons. - * @details - * Inputs : none - * Outputs : Executive for the FPGA, pumps, valves, and buttons called. + * @details Inputs: none + * @details Outputs: Executive for the FPGA, pumps, valves, and buttons called. *************************************************************************/ void taskPriority( void ) { Index: firmware/App/Tasks/TaskTimer.c =================================================================== diff -u -rc1ef106ed0f97dc998230c6e154aa2362aa476d8 -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision c1ef106ed0f97dc998230c6e154aa2362aa476d8) +++ firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -31,9 +31,8 @@ * The taskTimer function handles the scheduled Timer Task interrupt. * Calls the Timers executive to maintain a 1 ms timer counter to * support timer and timeout functions. - * @details - * Inputs : none - * Outputs : Executive for Timers called. + * @details Inputs: none + * @details Outputs: Executive for Timers called. *************************************************************************/ void taskTimer( void ) { Index: firmware/source/sys_main.c =================================================================== diff -u -r9f03f8819187df2f9200c240c794ad69f4882d4a -r4d7d40a27130dc813d653f044cbb856b1b7d8481 --- firmware/source/sys_main.c (.../sys_main.c) (revision 9f03f8819187df2f9200c240c794ad69f4882d4a) +++ firmware/source/sys_main.c (.../sys_main.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) @@ -127,9 +127,8 @@ * @brief initProcessor * The initProcessor function initializes and configures the processor \n * peripherals. - * @details - * Inputs : none - * Outputs : Processor peripherals initialized and configured. + * @details Inputs: none + * @details Outputs: Processor peripherals initialized and configured. * @return none *************************************************************************/ static void initProcessor( void ) @@ -153,9 +152,8 @@ /************************************************************************* * @brief initSoftware * The initSoftware function calls all software module initialize functions. - * @details - * Inputs : none - * Outputs : All modules initialized. + * @details Inputs: none + * @details Outputs: All modules initialized. * @return none *************************************************************************/ static void initSoftware( void ) @@ -188,9 +186,8 @@ /************************************************************************* * @brief initHardware * The initHardware function initializes and configures external hardware. - * @details - * Inputs : none - * Outputs : External hardware initialized and configured. + * @details Inputs: none + * @details Outputs: External hardware initialized and configured. * @return none *************************************************************************/ static void initHardware( void ) @@ -200,9 +197,8 @@ /************************************************************************* * @brief initTasks * The initTasks function sets up and starts the scheduled tasks. - * @details - * Inputs : none - * Outputs : Scheduled tasks set up and started. + * @details Inputs: none + * @details Outputs: Scheduled tasks set up and started. * @return none *************************************************************************/ static void initTasks( void )