Index: firmware/App/Controllers/Valves.c =================================================================== diff -u -ra72cc92cae2b043fadc8ed9a1d065cfb403185a0 -rd3f1ffdc9d0e3e68359a2ce27f19d3f872a51ac5 --- firmware/App/Controllers/Valves.c (.../Valves.c) (revision a72cc92cae2b043fadc8ed9a1d065cfb403185a0) +++ firmware/App/Controllers/Valves.c (.../Valves.c) (revision d3f1ffdc9d0e3e68359a2ce27f19d3f872a51ac5) @@ -132,7 +132,7 @@ typedef enum valve_modes { VALVE_CONTROL_MODE_ENABLE_PID = 0, ///< Valve control mode enable PID - VALVE_CONTORL_MODE_ENABLE_BYPASS, ///< Valve control mode enable bypass + VALVE_CONTROL_MODE_ENABLE_BYPASS, ///< Valve control mode enable bypass VALVE_CONTROL_MODE_DISABLE_ALL, ///< Valve control mode disable all modes NUM_OF_VALVE_CONTROL_MODES, ///< Number of valve control modes } VALVE_MODE_T; @@ -259,9 +259,9 @@ /*********************************************************************//** * @brief * The initValves function initializes the valves driver. - * @details Inputs: valveSelfTestState, valvesSelfTestResult, valvesStatus, + * @details Inputs: none + * @details Outputs: valveSelfTestState, valvesSelfTestResult, valvesStatus, * valvesControlSetBits - * @details Outputs: valveSelfTestState, valvesSelfTestResult, valvesStatus * @return none *************************************************************************/ void initValves( void ) @@ -295,7 +295,7 @@ /*********************************************************************//** * @brief * The homeValve function sets the homing request flag of a valve to TRUE. - * @details Inputs: valvesStatus + * @details Inputs: none * @details Outputs: valvesStatus (The flag that sets the homing request) * @param valve that is set to be homed * @return none @@ -320,7 +320,7 @@ /*********************************************************************//** * @brief * The setValvePosition function sets the requested position of a valve. - * @details Inputs: valvesStatus + * @details Inputs: none * @details Outputs: valvesStatus * @param valve that its position is set * @param position that the valve is set @@ -373,7 +373,7 @@ /*********************************************************************//** * @brief * The getValveCurrent function returns the current of a valve. - * @details Inputs: none + * @details Inputs: valvesStatus * @details Outputs: valvesStatus * @param valve that the current is requested * @return returns the current of the valve in float @@ -394,7 +394,7 @@ * @brief * The setValveBloodTrap function set the blood trap valve to open or close * position. - * @details Inputs: valveAirTrapStatus + * @details Inputs: none * @details Outputs: valveAirTrapStatus * @param state enumeration of open or close for valve * @return: none @@ -533,8 +533,8 @@ /*********************************************************************//** * @brief * The handleValveSelfTestEnableValves function starts the valves self test. - * @details Inputs: valvesSelfTestResult, valvesSelfTestResult - * @details Outputs: valvesSelfTestResult, valvesSelfTestResult + * @details Inputs: none + * @details Outputs: valvesStatus, valvesSelfTestResult * @return next state of the self test state machine *************************************************************************/ static VALVE_SELF_TEST_STATE_T handleValveSelfTestEnableValves( void ) @@ -560,7 +560,7 @@ * @brief * The handleValveSelfTestConfirmEnable function checks to make sure the * valves are enabled properly. - * @details Inputs: valvesSelfTestResult + * @details Inputs: none * @details Outputs: valvesSelfTestResult * @return next state of the self test state machine *************************************************************************/ @@ -807,8 +807,8 @@ else if ( ( TRUE == valvesStatus[ valve ].hasValveBeenHomed ) && ( TRUE == valvesStatus[ valve ].bypassModeStatus.hasBypassModeBeenRequeseted ) ) { // Set the valve control mode to bypass and set the PWM - setValveControlMode( valve, VALVE_CONTORL_MODE_ENABLE_BYPASS ); - valvesStatus[ valve ].controlMode = VALVE_CONTORL_MODE_ENABLE_BYPASS; + setValveControlMode( valve, VALVE_CONTROL_MODE_ENABLE_BYPASS ); + valvesStatus[ valve ].controlMode = VALVE_CONTROL_MODE_ENABLE_BYPASS; valvesStatus[ valve ].bypassModeStatus.hasChangeBeenRequested = FALSE; setFPGAValvePWM( valve ); @@ -921,8 +921,7 @@ /*********************************************************************//** * @brief * The setValveControlMode function sets the valves control mode. - * @details Inputs: valvesControlSetBits, valvesControlModesSetBits, - * valvesControlModesResetBits + * @details Inputs: none * @details Outputs: valvesControlSetBits * @param valve that its control mode is set * @param mode the control mode that the valve will be set to @@ -979,7 +978,7 @@ * The areValvesEnabled function checks the current valves status from FPGA * to the enable bit mask of each valve. If any of the valves is not enabled * the function raises an alarm. - * @details Inputs: valvesStatus, valvesControlStatusBits + * @details Inputs: valvesStatus * @details Outputs: none * @return Returns TRUE if all the valves are enabled properly *************************************************************************/ @@ -1012,7 +1011,7 @@ result = FALSE; } } - else if ( mode == VALVE_CONTORL_MODE_ENABLE_BYPASS ) + else if ( mode == VALVE_CONTROL_MODE_ENABLE_BYPASS ) { if ( ! ( status & VALVE_CONTROL_STATUS_BITS[ valve ][ VALVE_CONTROL_STATUS_BYPASS_ENABLED ] ) ) { @@ -1043,7 +1042,7 @@ /*********************************************************************//** * @brief - * The setFPGAValue function sets the position of a valve to FPGA. + * The setFPGAValveSetPoint function sets the position of a valve to FPGA. * @details Inputs: none * @details Outputs: none * @param valve that its FPGA set point is updated @@ -1381,7 +1380,7 @@ * @brief * The getValvesCurrentPWM function gets the PWM counts from the FPGA module * and converts them in to duty cycle in percent. - * @details Inputs: valvesStatus + * @details Inputs: none * @details Outputs: valvesStatus * @return none *************************************************************************/ @@ -1451,7 +1450,7 @@ * @brief * The testResetValvesDataPublishInterval function resets the override * of the valves publish interval. - * @details Inputs: valvesDataPublishInterval + * @details Inputs: none * @details Outputs: valvesDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ @@ -1472,7 +1471,7 @@ /*********************************************************************//** * @brief * The testSetValvesPositionOverride function overrides the valves position. - * @details Inputs: valvesPositionOverride, valvesStatus + * @details Inputs: none * @details Outputs: valvesPositionOverride * @param valve to override its position * @param position of the valve that will be overridden @@ -1562,7 +1561,7 @@ * @brief * The testResetValvePWMOverride function resets the override PWM in bypass * control mode. - * @details Inputs: valvesStatus + * @details Inputs: none * @details Outputs: valvesStatus * @param valve that its PWM override will be reset * @return TRUE if override reset successful, FALSE if not @@ -1635,8 +1634,8 @@ * @brief * The testSetValvesPositionCountOverride function overrides the valves * position in counts. - * @details Inputs: valvesPositionOverride, valvesStatus - * @details Outputs: valvesPositionOverride + * @details Inputs: valvesStatus + * @details Outputs: none * @param valve to override its position * @param position of the valve that will be overridden * @return TRUE if override successful, FALSE if not @@ -1661,7 +1660,7 @@ * @brief * The testResetValvesPositionCountOverride function resets the override * of the valves' position in counts. - * @details Inputs: valvesStatus + * @details Inputs: none * @details Outputs: valvesStatus * @param valve that its position count override will be reset * @return TRUE if override reset successful, FALSE if not