Index: firmware/App/Drivers/PinchValve.c =================================================================== diff -u -r2c9f7442169ce34dd4a2fffe91e293efab255826 -r025a6b4b0c26b644cd25072864398cb851f2d3fc --- firmware/App/Drivers/PinchValve.c (.../PinchValve.c) (revision 2c9f7442169ce34dd4a2fffe91e293efab255826) +++ firmware/App/Drivers/PinchValve.c (.../PinchValve.c) (revision 025a6b4b0c26b644cd25072864398cb851f2d3fc) @@ -368,7 +368,7 @@ * The execPinchValveCommand function executes the low level FPGA command * state machine. * @details \b Inputs: commandState[] -* @details \b Outputs: commandFailed [] +* @details \b Outputs: commandState[] * @return current state (sub-mode) *************************************************************************/ void execPinchValveCommand( void ) @@ -419,7 +419,7 @@ * The execPinchValveFunction function executes the pinch valve * homing and position command sequence state machine. * @details \b Inputs: functionState[] -* @details \b Outputs: commandFailed[] +* @details \b Outputs: functionState[], commandFailed[] * @return current state (sub-mode) *************************************************************************/ void execPinchValveFunction( void ) @@ -454,7 +454,7 @@ * @brief * The handlePinchValveCmdIdleState function handles the command * IDLE state. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return next Pinch Valve command state machine. @@ -468,7 +468,7 @@ * @brief * The handlePinchValveCmdSetCmdState function writes the active command * registers and captures the FPGA error count before transmission. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: errorCountAtCommandStart[] * @param valve H1_VALV or H19_VALV. * @return next Pinch Valve command state machine. @@ -490,7 +490,7 @@ * @brief * The handlePinchValveCmdXmitCmdState function starts the FPGA command * transaction and starts the command timeout timer. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: executeStartTime[] * @param valve H1_VALV or H19_VALV. * @return next Pinch Valve command state machine. @@ -512,7 +512,7 @@ * @brief * The handlePinchValveCmdWaitDoneState function waits for the FPGA command * transaction to complete and validates command status. -* @details \b Inputs: valve, executeStartTime[] +* @details \b Inputs: executeStartTime[] * @details \b Outputs: commandSpiStatus[], commandErrorCount[] * @param valve H1_VALV or H19_VALV. * @return next Pinch Valve command state machine. @@ -557,7 +557,7 @@ * @brief * The handlePinchValveCmdReadWordsState function validates and processes the * completed command response. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: commandOutputWord1[], commandOutputWord2[], * commandOutputWord3[], commandSpiStatus[], commandFailed[] * @param valve H1_VALV or H19_VALV. @@ -605,7 +605,7 @@ * @brief * The handlePinchValveCmdErrorState function clears the failed FPGA command * transaction and reports the command failure. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: commandFailed[] * @param valve H1_VALV or H19_VALV. * @return next Pinch Valve command state machine. @@ -625,7 +625,7 @@ * @brief * The handlePinchValveFunctionIdleState function starts a pending homing or * stored position command sequence. -* @details \b Inputs: valve, pendingValveHomeRequest[], +* @details \b Inputs: pendingValveHomeRequest[], * pendingValvePositionRequest[], pendingValvePosition[], h1HomingCommands[], * h19HomingCommands[], positionCommands[] * @details \b Outputs: pendingValvePositionRequest[], homingInProgress[], positionInProgress[], @@ -688,7 +688,7 @@ * @brief * The handlePinchValveFunctionSendState function submits the next command * in the active homing or position sequence. -* @details \b Inputs: valve, activeCommandArray[], activeCommandCount[], +* @details \b Inputs: activeCommandArray[], activeCommandCount[], * activeCommandIndex[], commandState[] * @details \b Outputs: commandFailed[], activeCommand[] * @param valve H1_VALV or H19_VALV. @@ -727,7 +727,7 @@ * @brief * The handlePinchValveFunctionWaitState function waits for the active * command to finish and advances to the next command in sequence. -* @details \b Inputs: valve, commandState[], commandFailed[], +* @details \b Inputs: commandState[], commandFailed[], * activeCommandIndex[], activeCommandCount[] * @details \b Outputs: activeCommandIndex[] * @param valve H1_VALV or H19_VALV. @@ -822,7 +822,7 @@ * @brief * The getPinchValvePosition function returns the latest actual encoder * position for the selected pinch valve. -* @details \b Inputs: valve, currentValvePosition[] +* @details \b Inputs: currentValvePosition[] * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return Latest signed encoder position, or 0 for an invalid valve. @@ -888,7 +888,7 @@ * @brief * The isPinchValveBusy function checks whether the selected pinch valve is * executing or waiting for a command. -* @details \b Inputs: valve, functionState[], commandState[] +* @details \b Inputs: functionState[], commandState[] * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return TRUE if the valve is busy or invalid, FALSE otherwise. @@ -936,7 +936,7 @@ * @brief * The getPinchValveStoredPosition function returns the stored encoder count * for the selected pinch valve position. -* @details \b Inputs: position, valvePositions[] +* @details \b Inputs: valvePositions[] * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @param position Stored valve position to read. @@ -958,7 +958,7 @@ * @brief * The movePinchValveToStoredPosition function requests movement to a stored * pinch valve position. -* @details \b Inputs: valve, position +* @details \b Inputs: none * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @param position Stored valve position to command. @@ -980,7 +980,7 @@ * @brief * The setPinchValveCommand function loads the selected command into the * command state machine. -* @details \b Inputs: valve, command, commandState[] +* @details \b Inputs: commandState[] * @details \b Outputs: activeCommand[], commandOutputWord1[], * commandOutputWord2[], commandOutputWord3[], commandSpiStatus[], * commandErrorCount[], commandFailed[], commandState[] @@ -1056,7 +1056,7 @@ * @brief * The transmitPinchValveCommand function starts the active FPGA command * transaction. -* @details \b Inputs: valve, fpgaCommandValue[] +* @details \b Inputs: fpgaCommandValue[] * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return TRUE if the FPGA start command is written, FALSE otherwise. @@ -1089,7 +1089,7 @@ * @brief * The readPinchValveCommandResponse function reads the command output words * for the selected pinch valve. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: commandOutputWord1[], commandOutputWord2[], * commandOutputWord3[] * @param valve H1_VALV or H19_VALV. @@ -1115,7 +1115,7 @@ * @brief * The processPinchValveCommandOutput function processes the active command * response and determines the next low level command state. -* @details \b Inputs: valve, activeCommand[], activeCommandIndex[], +* @details \b Inputs: activeCommand[], activeCommandIndex[], * commandOutputWord1[], motionStartTime[], homingInProgress[], valvePositions[] * @details \b Outputs: motionStartTime[], activityStatus[], eventStatus[], * currentValvePosition[], valvePositions[] @@ -1230,7 +1230,7 @@ * @brief * The clearPinchValveFpgaCommand function clears the active valve FPGA command * register. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: fpgaCommandValue[] * @param valve H1_VALV or H19_VALV. * @return none @@ -1257,7 +1257,7 @@ * from the command word counts and write only setting. * @details \b Inputs: command->inputWordCount,command->outputWordCount, * command->writeOnly -* @details \b Outputs: fpgaCommand +* @details \b Outputs: none * @param command Pointer to the pinch valve command. * @param fpgaCommand Pointer to the generated FPGA command byte. * @return TRUE if the command byte is generated, FALSE otherwise. @@ -1386,7 +1386,7 @@ * @brief * The readPinchValveErrorCount function reads the current error count for * the selected valve. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return Current error count, or 0 for an invalid valve. @@ -1454,7 +1454,7 @@ /*********************************************************************//** * @brief * The isValidPinchValve function validates the selected valve ID. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: none * @param valve Valve to validate. * @return TRUE for H1_VALV or H19_VALV, FALSE otherwise. @@ -1472,7 +1472,7 @@ * @brief * The isValidPinchValveCommand function validates the command pointer and * command word counts. -* @details \b Inputs: command, command->inputWordCount, +* @details \b Inputs: command->inputWordCount, * command->outputWordCount * @details \b Outputs: none * @param command Pointer to the pinch valve command. @@ -1501,7 +1501,7 @@ * @brief * The isValidPinchValvePosition function validates the selected stored valve * position. -* @details \b Inputs: position +* @details \b Inputs: none * @details \b Outputs: none * @param position Valve position ID to validate. * @return TRUE for Position A, B, or C, FALSE otherwise. @@ -1526,7 +1526,7 @@ * @brief * The setSigned32CommandWords function stores a signed 32 bit value in two * 16 bit command input words. -* @details \b Inputs: command, value +* @details \b Inputs: none * @details \b Outputs: command->inputWord1, command->inputWord2 * @param command Pointer to the command to update. * @param value Signed 32 bit value to store. @@ -1547,7 +1547,7 @@ * @brief * The getSigned32OutputValue function combines two 16 bit command output * words into a signed 32 bit value. -* @details \b Inputs: valve, commandOutputWord1[], commandOutputWord2[] +* @details \b Inputs: commandOutputWord1[], commandOutputWord2[] * @details \b Outputs: none * @param valve H1_VALV or H19_VALV. * @return Signed 32 bit command output value. @@ -1565,7 +1565,7 @@ * @brief * The clearActivePinchValveCommand function clears the active command record * for the selected pinch valve. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: activeCommand[] * @param valve H1_VALV or H19_VALV. * @return none @@ -1588,7 +1588,7 @@ * @brief * The clearPinchValveCommandRegisters function clears the selected pinch * valve FPGA command registers. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: fpgaCommandValue[] * @param valve H1_VALV or H19_VALV. * @return none @@ -1621,7 +1621,7 @@ * @brief * The resetPinchValveFunctionSequence function resets the active homing or * position command sequence for the selected pinch valve. -* @details \b Inputs: valve +* @details \b Inputs: none * @details \b Outputs: activeCommandArray[], activeCommandCount[], * activeCommandIndex[], homingInProgress[], positionInProgress[], * functionState[]