Index: firmware/App/Services/FPGA.c =================================================================== diff -u -r777d38c1f794e05052f47c3ed1826487722e0335 -r8e6488e189349e0f87f2fb21fa8176aced0b5a43 --- firmware/App/Services/FPGA.c (.../FPGA.c) (revision 777d38c1f794e05052f47c3ed1826487722e0335) +++ firmware/App/Services/FPGA.c (.../FPGA.c) (revision 8e6488e189349e0f87f2fb21fa8176aced0b5a43) @@ -217,7 +217,6 @@ * @details * Inputs : none * Outputs : FPGA module initialized. - * @param none * @return none *************************************************************************/ void initFPGA( void ) @@ -334,7 +333,6 @@ * @details * Inputs : none * Outputs : fpga comm flags & counters reset - * @param none * @return none *************************************************************************/ static void resetFPGACommFlags( void ) @@ -355,7 +353,6 @@ * @details * Inputs : none * Outputs : fpgaReceiptCounter - * @param none * @return none *************************************************************************/ void signalFPGAReceiptCompleted( void ) @@ -391,7 +388,6 @@ * @details * Inputs : none * Outputs : fpgaReceiptCounter - * @param none * @return none *************************************************************************/ void signalFPGATransmitCompleted( void ) @@ -405,7 +401,6 @@ * @details * Inputs : fpgaState * Outputs : fpgaState - * @param none * @return none *************************************************************************/ void execFPGAIn( void ) @@ -459,7 +454,6 @@ * @details * Inputs : fpgaState * Outputs : fpgaState - * @param none * @return none *************************************************************************/ void execFPGAOut( void ) @@ -501,7 +495,6 @@ * @details * Inputs : none * Outputs : read command sent to FPGA - * @param none * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReadHeaderState( void ) @@ -534,7 +527,6 @@ * @details * Inputs : none * Outputs : header register values updated - * @param none * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveHeaderState( void ) @@ -587,7 +579,6 @@ * @details * Inputs : actuator set points * Outputs : actuator set points sent to FPGA - * @param none * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAWriteAllActuatorsState( void ) @@ -635,7 +626,6 @@ * @details * Inputs : none * Outputs : sensor values updated - * @param none * @return next FPGA state *************************************************************************/ static FPGA_STATE_T handleFPGAReceiveAllSensorsState( void ) @@ -693,7 +683,6 @@ * @details * Inputs : fpgaHeader * Outputs : none - * @param none * @return passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execFPGATest( void ) @@ -725,7 +714,7 @@ * @details * Inputs : none * Outputs : # of bytes for next FPGA write command is set - * @param bytes2Transmit : # of bytes to be transmitted via DMA to the FPGA. + * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA. * @return none *************************************************************************/ static void setupDMAForWriteCmd( U32 bytes2Transmit ) @@ -748,7 +737,6 @@ * @details * Inputs : none * Outputs : DMA write command to FPGA is initiated - * @param none * @return none *************************************************************************/ static void startDMAWriteCmd( void ) @@ -765,7 +753,7 @@ * @details * Inputs : none * Outputs : # of expected bytes for next FPGA write command response is set - * @param bytes2Receive : # of bytes expected to be transmitted via DMA from the FPGA. + * @param bytes2Receive number of bytes expected to be transmitted via DMA from the FPGA. * @return none *************************************************************************/ static void setupDMAForWriteResp( U32 bytes2Receive ) @@ -788,7 +776,6 @@ * @details * Inputs : none * Outputs : DMA write command response is ready to be received from the FPGA - * @param none * @return none *************************************************************************/ static void startDMAReceiptOfWriteResp( void ) @@ -805,7 +792,7 @@ * @details * Inputs : none * Outputs : # of bytes for next FPGA read command is set - * @param bytes2Transmit : # of bytes to be transmitted via DMA to the FPGA. + * @param bytes2Transmit number of bytes to be transmitted via DMA to the FPGA. * @return none *************************************************************************/ static void setupDMAForReadCmd( U32 bytes2Transmit ) @@ -828,7 +815,6 @@ * @details * Inputs : none * Outputs : DMA read command to FPGA is initiated - * @param none * @return none *************************************************************************/ static void startDMAReadCmd( void ) @@ -845,7 +831,7 @@ * @details * Inputs : none * Outputs : # of expected bytes for next FPGA read command response is set - * @param bytes2Receive : # of expected bytes to be transmitted via DMA from the FPGA. + * @param bytes2Receive number of expected bytes to be transmitted via DMA from the FPGA. * @return none *************************************************************************/ static void setupDMAForReadResp( U32 bytes2Receive ) @@ -868,7 +854,6 @@ * @details * Inputs : none * Outputs : DMA read command response is ready to be received from the FPGA - * @param none * @return none *************************************************************************/ static void startDMAReceiptOfReadResp( void ) @@ -885,7 +870,6 @@ * @details * Inputs : fpgaHeader * Outputs : none - * @param none * @return fpgaDiag *************************************************************************/ static void consumeUnexpectedData( void ) @@ -920,7 +904,7 @@ * @details * Inputs : none * Outputs : fpgaActuatorSetPoints.fpgaValveStates - * @param valveStates + * @param valveStates bit mask for the various valve states * @return none *************************************************************************/ void setFPGAValveStates( U16 valveStates ) @@ -935,7 +919,7 @@ * @details * Inputs : none * Outputs : fpgaActuatorSetPoints.fpgaDrainPumpSetSpeed - * @param drainPumpDAC + * @param drainPumpDAC DAC value to command for the drain pump * @return none *************************************************************************/ void setFPGADrainPumpSpeed( U08 drainPumpDAC ) @@ -953,7 +937,6 @@ * @details * Inputs : fpgaHeader * Outputs : none - * @param none * @return Id *************************************************************************/ U08 getFPGAId( void ) @@ -968,7 +951,6 @@ * @details * Inputs : fpgaHeader * Outputs : none - * @param none * @return Revision *************************************************************************/ U08 getFPGARev( void ) @@ -998,7 +980,6 @@ * @details * Inputs : fpgaSensorReadings * Outputs : none - * @param none * @return last load cell A 1 reading *************************************************************************/ U32 getFPGALoadCellA1( void ) @@ -1012,7 +993,6 @@ * @details * Inputs : fpgaSensorReadings * Outputs : none - * @param none * @return last load cell A 2 reading *************************************************************************/ U32 getFPGALoadCellA2( void ) @@ -1026,7 +1006,6 @@ * @details * Inputs : fpgaSensorReadings * Outputs : none - * @param none * @return last load cell B 1 reading *************************************************************************/ U32 getFPGALoadCellB1( void ) @@ -1040,7 +1019,6 @@ * @details * Inputs : fpgaSensorReadings * Outputs : none - * @param none * @return last load cell B 2 reading *************************************************************************/ U32 getFPGALoadCellB2( void ) @@ -1055,7 +1033,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaValveStates * Outputs : none - * @param none * @return last valve states reading *************************************************************************/ U16 getFPGAValveStates( void ) @@ -1069,7 +1046,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaROFlowRate * Outputs : none - * @param none * @return last RO flow rate reading *************************************************************************/ U16 getFPGAROPumpFlowRate( void ) @@ -1083,7 +1059,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaDrainPumpSpeed * Outputs : none - * @param none * @return last drain pump speed reading *************************************************************************/ U16 getFPGADrainPumpSpeed( void ) @@ -1098,7 +1073,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTPiTemp * Outputs : none - * @param none * @return last primary heater inlet temperature reading *************************************************************************/ U32 getFPGATPiTemp( void ) @@ -1113,7 +1087,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTPoTemp * Outputs : none - * @param none * @return last primary heater outlet temperature reading *************************************************************************/ U32 getFPGATPoTemp( void ) @@ -1128,7 +1101,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaCD1Temp * Outputs : none - * @param none * @return last conductivity sensor 1 outlet temperature reading *************************************************************************/ U32 getFPGACD1Temp( void ) @@ -1143,7 +1115,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaCD2Temp * Outputs : none - * @param none * @return last conductivity sensor 2 outlet temperature reading *************************************************************************/ U32 getFPGACD2Temp( void ) @@ -1158,7 +1129,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaRTDErrorCnt * Outputs : none - * @param none * @return Last error count of the RTD conductivity sensors *************************************************************************/ U08 getFPGARTDErrorCount( void ) @@ -1173,7 +1143,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaRTDReadCnt * Outputs : none - * @param none * @return Last read count of the RTC conductivity sensors *************************************************************************/ U08 getFPGARTDReadCount( void ) @@ -1188,7 +1157,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTHDoTemp * Outputs : none - * @param none * @return Last redundant sensor outlet temperature reading *************************************************************************/ U32 getFPGATHDoTemp( void ) @@ -1203,7 +1171,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTHDoErrorCnt * Outputs : none - * @param none * @return Last redundant sensor outlet temperature error count *************************************************************************/ U08 getFPGATHDoErrorCount( void ) @@ -1217,7 +1184,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTHDoReadCnt * Outputs : none - * @param none * @return Last redundant sensor outlet temperature error count reading *************************************************************************/ U08 getFPGATHDoReadCount( void ) @@ -1232,7 +1198,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTDiTemp * Outputs : none - * @param none * @return last primary heater outlet temperature reading *************************************************************************/ U32 getFPGATDiTemp( void ) @@ -1247,7 +1212,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTDiErrorCnt * Outputs : none - * @param none * @return Last dialysate inlet error count *************************************************************************/ U08 getFPGATDiErrorCount( void ) @@ -1262,7 +1226,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTDiReadCnt * Outputs : none - * @param none * @return Last dialysate inlet read count *************************************************************************/ U08 getFPGATDiReadCount( void ) @@ -1277,7 +1240,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterIntTemp * Outputs : none - * @param none * @return last primary heater temperature reading *************************************************************************/ U16 getFPGAPrimaryHeaterTemp( void ) @@ -1292,7 +1254,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterFlags * Outputs : none - * @param none * @return Last primary heater internal temperature sensor flag read *************************************************************************/ U08 getFPGAPrimaryHeaterFlags( void ) @@ -1307,7 +1268,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterReadCnt * Outputs : none - * @param none * @return Last primary heater internal temperature sensor read count *************************************************************************/ U08 getFPGAPrimaryHeaterReadCount( void ) @@ -1322,7 +1282,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterIntTemp * Outputs : none - * @param none * @return last trimmer heater temperature reading *************************************************************************/ U16 getFPGATrimmerHeaterTemp( void ) @@ -1337,7 +1296,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterFlags * Outputs : none - * @param none * @return Last trimmer heater internal temperature flags read *************************************************************************/ U08 getFPGATrimmerHeaterFlags( void ) @@ -1352,7 +1310,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterReadCnt * Outputs : none - * @param none * @return Last trimmer heater internal temperature read count *************************************************************************/ U08 getFPGATrimmerHeaterReadCount( void ) @@ -1367,7 +1324,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaPrimaryHeaterIntJunctionTemp * Outputs : none - * @param none * @return Last primary cold junction temperature *************************************************************************/ U16 getFPGAPRimaryColdJunctionTemp ( void ) @@ -1382,7 +1338,6 @@ * @details * Inputs : fpgaSensorReadings.fpgaTrimmerHeaterIntJunctionTemp * Outputs : none - * @param none * @return Last trimmer cold junction temperature *************************************************************************/ U16 getFPGATrimmerColdJunctionTemp ( void ) @@ -1397,9 +1352,9 @@ * @details * Inputs : fpgaSensorReadings * 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 + * @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 * @return none *************************************************************************/ void getFPGAAccelAxes( S16 *x, S16 *y, S16 *z ) @@ -1417,9 +1372,9 @@ * @details * Inputs : fpgaSensorReadings * 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 + * @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 * @return none *************************************************************************/ void getFPGAAccelMaxes( S16 *xmax, S16*ymax, S16*zmax ) @@ -1436,8 +1391,8 @@ * @details * Inputs : fpgaSensorReadings * Outputs : none - * @param cnt : Populate this param with latest sample counter value - * @param err : Populate this param with latest error + * @param cnt Populate this param with latest sample counter value + * @param err Populate this param with latest error * @return none *************************************************************************/ void getFPGAAccelStatus( U16 *cnt, U16 *err )