Index: Accel.c =================================================================== diff -u -r7ff7e715f7a15da5f4055b33e186d58cf96fe909 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- Accel.c (.../Accel.c) (revision 7ff7e715f7a15da5f4055b33e186d58cf96fe909) +++ Accel.c (.../Accel.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -96,9 +96,8 @@ /*********************************************************************//** * @brief * The initAccel function initializes the Accel module. - * @details - * Inputs: none - * Outputs: Accel module initialized + * @details Inputs: none + * @details Outputs: Accel module initialized * @return none *************************************************************************/ void initAccel( void ) @@ -125,9 +124,8 @@ /*********************************************************************//** * @brief * The execAccel function executes the accelerometer monitor state machine. - * @details - * Inputs: accelState - * Outputs: accelState, alarm if software fault happened + * @details Inputs: accelState + * @details Outputs: accelState, alarm if software fault happened * @return none *************************************************************************/ void execAccel( void ) @@ -159,10 +157,9 @@ * @brief * The handleAccelMonitorState function handles the accelerometer monitor * state of the accelerometer monitor state machine. - * @details - * Inputs: accelNoNewSampleTimerCounter, accelFPGASampleCtr, accelAxes, + * @details Inputs: accelNoNewSampleTimerCounter, accelFPGASampleCtr, accelAxes, * accelFPGAFaultReg, accelCalOffsets - * Outputs: accelNoNewSampleTimerCounter, accelFPGASampleCtr, accelAxes + * @details Outputs: accelNoNewSampleTimerCounter, accelFPGASampleCtr, accelAxes * alarm if accelerometer failed * @return next state *************************************************************************/ @@ -241,9 +238,8 @@ * @brief * The getPublishAccelDataInterval function gets the accelerometer vector * data publication interval. - * @details - * Inputs: accelDataPublishInterval - * Outputs: none + * @details Inputs: accelDataPublishInterval + * @details Outputs: none * @return the current accelerometer vector data publication interval * (in priority task periods). *************************************************************************/ @@ -263,9 +259,8 @@ * @brief * The getMeasuredAccelAxis function gets the current magnitude for * the given accelerometer axis. - * @details - * Inputs: accelAxes - * Outputs: alarm if software fault happened + * @details Inputs: accelAxes + * @details Outputs: alarm if software fault happened * @param axis the axis to measure the acceleration from * @return the current magnitude for the given accelerometer axis (in g). *************************************************************************/ @@ -300,9 +295,8 @@ * @brief * The getMaxAccelAxis function gets the current max magnitude for the given * accelerometer axis. - * @details - * Inputs: accelMaxs - * Outputs: alarm software fault if happened + * @details Inputs: accelMaxs + * @details Outputs: alarm software fault if happened * @param axis the axis to get the max acceleration * @return the current maximum magnitude for the given accelerometer axis (in g). *************************************************************************/ @@ -337,9 +331,8 @@ * @brief * The publishAccelData function publishes accelerometer data at the set * interval. - * @details - * Inputs: accelAvgVector, accelTilt, accelAxes, accelDataPublicationTimerCounter - * Outputs: accelAxes, accelDataPublicationTimerCounter + * @details Inputs: accelAvgVector, accelTilt, accelAxes, accelDataPublicationTimerCounter + * @details Outputs: accelAxes, accelDataPublicationTimerCounter * @return none *************************************************************************/ static void publishAccelData( void ) @@ -371,10 +364,9 @@ * @brief * The resetAccelMovingAverage function re-initializes the accelerometer * moving average sample buffer. - * @details - * Inputs: accelReadingsTotal, accelAvgVector, accelReadings, accelReadingsIdx, + * @details Inputs: accelReadingsTotal, accelAvgVector, accelReadings, accelReadingsIdx, * accelReadingsCount - * Outputs: accelReadingsTotal, accelAvgVector, accelReadings, accelReadingsIdx, + * @details Outputs: accelReadingsTotal, accelAvgVector, accelReadings, accelReadingsIdx, * accelReadingsCount * @return none *************************************************************************/ @@ -399,10 +391,9 @@ /*********************************************************************//** * @brief * The filterAccelReadings function adds a new axis samples to the filter. - * @details - * Inputs: accelReadingsCount, accelReadingsTotal, accelReadings, + * @details Inputs: accelReadingsCount, accelReadingsTotal, accelReadings, * accelReadings, accelReadingsCount - * Outputs: accelReadingsCount, accelReadingsTotal, accelReadings, + * @details Outputs: accelReadingsCount, accelReadingsTotal, accelReadings, * accelReadings, accelReadingsCount * @return none *************************************************************************/ @@ -449,9 +440,8 @@ * @brief * The calcVectorLength function calculates the length of a vector with * given vector axis magnitudes. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param x X axis magnitude of vector * @param y Y axis magnitude of vector * @param z Z axis magnitude of vector @@ -467,9 +457,8 @@ /*********************************************************************//** * @brief * The checkForTiltError function checks for a tilt error. - * @details - * Inputs: accelTilt, accelTiltErrorTimerCounter - * Outputs: accelTiltErrorTimerCounter, alarm if persistent excessive + * @details Inputs: accelTilt, accelTiltErrorTimerCounter + * @details Outputs: accelTiltErrorTimerCounter, alarm if persistent excessive * tilt detected * @return none *************************************************************************/ @@ -509,9 +498,8 @@ /*********************************************************************//** * @brief * The checkForShockError function checks for a shock error. - * @details - * Inputs: none - * Outputs: alarm if excessive shock detected + * @details Inputs: none + * @details Outputs: alarm if excessive shock detected * @return none *************************************************************************/ static void checkForShockError( void ) @@ -552,9 +540,8 @@ * @brief * The execAccelTest function executes the state machine for the * accelerometer self-test. - * @details - * Inputs: accelSelfTestState, accelCalOffsets - * Outputs: accelSelfTestState, accelCalOffsets, Alarm is self-test failed + * @details Inputs: accelSelfTestState, accelCalOffsets + * @details Outputs: accelSelfTestState, accelCalOffsets, Alarm is self-test failed * @return the current state of the accelerometer self-test. *************************************************************************/ SELF_TEST_STATUS_T execAccelTest( void ) @@ -633,9 +620,8 @@ * @brief * The setAccelCalibration function sets the accelerometer calibration * factors and has them stored in non-volatile memory. - * @details - * Inputs: accelCalOffsets - * Outputs: accelCalOffsets + * @details Inputs: accelCalOffsets + * @details Outputs: accelCalOffsets * @param offsetX offset calibration factor for X axis * @param offsetY offset calibration factor for Y axis * @param offsetZ offset calibration factor for Z axis @@ -669,9 +655,8 @@ * @brief * The getAccelCalibration function retrieves the current accelerometer * calibration factors. - * @details - * Inputs: accelCalOffsets - * Outputs: none + * @details Inputs: accelCalOffsets + * @details Outputs: none * @param offsetX value to populate with X axis offset calibration factor * @param offsetY value to populate with Y axis offset calibration factor * @param offsetZ value to populate with Z axis offset calibration factor @@ -688,9 +673,8 @@ * @brief * The testSetAccelDataPublishIntervalOverride function overrides the * accelerometer data publish interval. - * @details - * Inputs: accelDataPublishInterval - * Outputs: accelDataPublishInterval + * @details Inputs: accelDataPublishInterval + * @details Outputs: accelDataPublishInterval * @param value override accelerometer data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -714,9 +698,8 @@ * @brief * The testResetAccelDataPublishIntervalOverride function resets the * override of the accelerometer data publish interval. - * @details - * Inputs: accelDataPublishInterval - * Outputs: accelDataPublishInterval + * @details Inputs: accelDataPublishInterval + * @details Outputs: accelDataPublishInterval * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetAccelDataPublishIntervalOverride( void ) @@ -737,8 +720,8 @@ * @brief * The testSetAccelAxisOverride function overrides the value of the * specified accelerometer axis with a given value. - * Inputs: accelAxes - * Outputs: accelAxes + * @details Inputs: accelAxes + * @details Outputs: accelAxes * @param axis ID of sensor axis to override for * @param value override value for the given axis * @return TRUE if override successful, FALSE if not @@ -764,9 +747,8 @@ * @brief * The testResetAccelAxisOverride function resets the override of the * specified accelerometer axis. - * @details - * Inputs: accelAxes - * Outputs: accelAxes + * @details Inputs: accelAxes + * @details Outputs: accelAxes * @param axis ID of accelerometer axis to reset override for * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -791,8 +773,8 @@ * @brief * The testSetAccelMaxOverride function overrides the max. value of the * specified accelerometer axis with a given value. - * Inputs: accelMaxs - * Outputs: accelMaxs + * @details Inputs: accelMaxs + * @details Outputs: accelMaxs * @param axis ID of sensor axis to override for * @param value override value for the given axis maximum * @return TRUE if override successful, FALSE if not @@ -818,9 +800,8 @@ * @brief * The testResetAccelMaxOverride function resets the override of the * specified accelerometer axis maximum. - * @details - * Inputs: accelMaxs - * Outputs: accelMaxs + * @details Inputs: accelMaxs + * @details Outputs: accelMaxs * @param axis ID of accelerometer axis to reset override for * @return TRUE if override successful, FALSE if not *************************************************************************/ Index: NVDataMgmt.c =================================================================== diff -u -r7ff7e715f7a15da5f4055b33e186d58cf96fe909 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- NVDataMgmt.c (.../NVDataMgmt.c) (revision 7ff7e715f7a15da5f4055b33e186d58cf96fe909) +++ NVDataMgmt.c (.../NVDataMgmt.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -270,10 +270,9 @@ /*********************************************************************//** * @brief * The initNVDataMgmt function initializes the module. - * @details - * Inputs: NVDataMgmtSelfTestState, NVDataMgmtExecState, NVDataMgmtSelfTestResult, + * @details Inputs: NVDataMgmtSelfTestState, NVDataMgmtExecState, NVDataMgmtSelfTestResult, * queueRearIndex, queueFrontIndex, queueCount - * Outputs: NVDataMgmtSelfTestState, NVDataMgmtExecState, NVDataMgmtSelfTestResult, + * @details Outputs: NVDataMgmtSelfTestState, NVDataMgmtExecState, NVDataMgmtSelfTestResult, * queueRearIndex, queueFrontIndex, queueCount * @return none *************************************************************************/ @@ -294,9 +293,8 @@ * The signalPowerOffWarning signals this module that system power off is * imminent and any non-volatile data writes in progress should be wrapped up * quickly and any pending non-volatile data writes should not be started. - * @details - * Inputs: none - * Outputs: powerOffIsImminent + * @details Inputs: none + * @details Outputs: powerOffIsImminent * @return none *************************************************************************/ void signalPowerOffWarning( void ) @@ -310,9 +308,8 @@ * calls another function to calculate the CRC for the provided data and * calls another function to erase sector 0 and write the new manufacturing * data. - * @details - * Inputs: mfgRecord - * Outputs: mfgRecord + * @details Inputs: mfgRecord + * @details Outputs: mfgRecord * @return TRUE is the enqueue was successfully scheduled *************************************************************************/ BOOL setMfgData ( MFG_DATA_T data ) @@ -327,9 +324,8 @@ * @brief * The getMfgData returns the data in the structure that holds manufacturing * record to buffer that the caller has provided. - * @details - * Inputs: mfgRecord - * Outputs: none + * @details Inputs: mfgRecord + * @details Outputs: none * @param buffer address of manufacturing data buffer * @return TRUE if the buffer pointer was not null and the copy was successful *************************************************************************/ @@ -352,9 +348,8 @@ * calls another function to calculate the CRC for the provided data and * calls another function to erase sector 0 and write the new manufacturing * data. - * @details - * Inputs: calibrationRecord - * Outputs: calibrationRecord + * @details Inputs: calibrationRecord + * @details Outputs: calibrationRecord * @param data calibration data structure * @return TRUE if updating was successfully scheduled *************************************************************************/ @@ -374,9 +369,8 @@ * @brief * The getCalibrationData returns the data in the structure that hold * calibration record to buffer that the caller has provided. - * @details - * Inputs: calibrationRecord - * Outputs: none + * @details Inputs: calibrationRecord + * @details Outputs: none * @param buffer address of calibration data buffer * @return TRUE if calibration record valid *************************************************************************/ @@ -398,9 +392,8 @@ * The setServiceDate updates the structure that holds the calibration data, * calls another function to calculate the CRC for the provided data if * there is enough queues available, it schedules a write to RTC RAM. - * @details - * Inputs: serviceRecord - * Outputs: serviceRecord + * @details Inputs: serviceRecord + * @details Outputs: serviceRecord * @param data service data buffer * @return TRUE if the queue had enough space to schedule the job *************************************************************************/ @@ -424,9 +417,8 @@ * @brief * The getServiceDate returns the data in the structure that holds service * date to buffer that the caller has provided. - * @details - * Inputs: serviceRecord - * Outputs: none + * @details Inputs: serviceRecord + * @details Outputs: none * @param buffer address of service data buffer * @return TRUE if the buffer address was not null *************************************************************************/ @@ -447,9 +439,8 @@ * @brief * The writeLogData checks if the queue is not full and if it is not, it calls * enqueue to schedule a job for writing the log data. - * @details - * Inputs: logRecord - * Outputs: none + * @details Inputs: logRecord + * @details Outputs: none * @param data address of log data buffer * @return TRUE if the queue is not full and if the log header is not corrupted *************************************************************************/ @@ -471,9 +462,8 @@ * @brief * The readLogData checks if the queue is not full and if it is not, it calls * enqueue to schedule a job for writing the log data. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param buffer address of read data buffer * @param length length of the data log * @return TRUE if there are enough queues available for the job @@ -496,9 +486,8 @@ * @brief * The setTreatmentTime sets a queue job to write the treatment time in * the specified RAM address. - * @details - * Inputs: treatmentTimeRecord - * Outputs: treatmentTimeRecord + * @details Inputs: treatmentTimeRecord + * @details Outputs: treatmentTimeRecord * @param hours treatmet time in hours * @return TRUE if the queue was not full so the job was scheduled successfully *************************************************************************/ @@ -522,8 +511,7 @@ * @brief * The getTreatmentTime returns the total number treatment hours of the * HD device. - * @details - * Inputs: none + * @details Inputs: none * Output: none * @return treatment time as U32 *************************************************************************/ @@ -536,9 +524,8 @@ * @brief * The setWaterConsumption sets a queue job to write the amount of water * that has been consumed in DG. - * @details - * Inputs: waterConsumptionRecord - * Outputs: waterConsumptionRecord + * @details Inputs: waterConsumptionRecord + * @details Outputs: waterConsumptionRecord * @param liters consumed water is liters * @return TRUE if queue is not full *************************************************************************/ @@ -561,9 +548,8 @@ /*********************************************************************//** * @brief * The getWaterConsumption returns the amount of consumed water. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return water consumption as a U32 *************************************************************************/ U32 getWaterConsumption ( void ) @@ -576,9 +562,8 @@ * The setDisinfectionDate gets the last disinfection date, calculates the * CRC for it and if the queue is not full, it schedules a write to RTC RAM * to store the last date. - * @details - * Inputs: lastDisinfectionRecord - * Outputs: lastDisinfectionRecord + * @details Inputs: lastDisinfectionRecord + * @details Outputs: lastDisinfectionRecord * @param date disinfection date buffer * @return TRUE if the queue was not full *************************************************************************/ @@ -602,9 +587,8 @@ * @brief * The getDisinfectionDate populates the provided buffer with the last * disinfection date. - * @details - * Inputs: lastDisinfectionRecord - * Outputs: none + * @details Inputs: lastDisinfectionRecord + * @details Outputs: none * @param buffer address of disinfection date buffer * @return TRUE if the buffer address was not null *************************************************************************/ @@ -624,9 +608,8 @@ /*********************************************************************//** * @brief * The execNVDataMgmtSelfTest runs the NVDataMgmt POST during the self-test. - * @details - * Inputs: NVDataMgmtSelfTestState - * Outputs: NVDataMgmtSelfTestState, alarm if there was a software fault + * @details Inputs: NVDataMgmtSelfTestState + * @details Outputs: NVDataMgmtSelfTestState, alarm if there was a software fault * @return NVDataMgmtSelfTestResult the result of self-test *************************************************************************/ SELF_TEST_STATUS_T execNVDataMgmtSelfTest ( void ) @@ -712,9 +695,8 @@ /*********************************************************************//** * @brief * The setBootloaderFlag sets the bootloader flag to RTC RAM. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param flag the bootloader flag * @return TRUE if the queue was not full *************************************************************************/ @@ -735,9 +717,8 @@ /*********************************************************************//** * @brief * The getBootloaderFlag gets the bootloader flag from RTC RAM. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return bootloader flag as a U32 *************************************************************************/ U32 getBootloaderFlag( void ) @@ -748,9 +729,8 @@ /*********************************************************************//** * @brief * The execNVDataMgmt runs the NVDataMgmt main tasks. - * @details - * Inputs: NVDataMgmtExecState - * Outputs: NVDataMgmtExecState, alarm if exec state was invalid + * @details Inputs: NVDataMgmtExecState + * @details Outputs: NVDataMgmtExecState, alarm if exec state was invalid * @return none *************************************************************************/ void execNVDataMgmt( void ) @@ -810,9 +790,8 @@ /*********************************************************************//** * @brief * The handleSelfTestStart enables the EEPROM bank sectors. - * @details - * Inputs: currentTime - * Outputs: currentTime + * @details Inputs: currentTime + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestStart ( void ) @@ -831,9 +810,8 @@ * @brief * The handleSelfTestEnableEEPROM waits for EEPROM to return with ready from * enabling the EEPROM command. - * @details - * Inputs: currentTime - * Outputs: currentTime + * @details Inputs: currentTime + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestEnableEEPROM ( void ) @@ -860,9 +838,8 @@ * @brief * The handleSelfTestReadBootloaderFlag reads the bootloader flag * from RTC RAM. - * @details - * Inputs: currentTime, bootloaderFlag - * Outputs: currentTime + * @details Inputs: currentTime, bootloaderFlag + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadBootloaderFlag ( void ) @@ -900,9 +877,8 @@ * @brief * The handleSelfTestReadHDTreatmentTime reads the HD treatment time * from RTC RAM. - * @details - * Inputs: currentTime, treatmentTimeRecord - * Outputs: currentTime + * @details Inputs: currentTime, treatmentTimeRecord + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadHDTreatmentTime ( void ) @@ -930,9 +906,8 @@ * @brief * The handleSelfTestReadDGWaterConsumption reads the DG water consumption * from RTC RAM. - * @details - * Inputs: currentTime, waterConsumptionRecord - * Outputs: currentTime + * @details Inputs: currentTime, waterConsumptionRecord + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadDGWaterConsumption ( void ) @@ -958,9 +933,8 @@ /*********************************************************************//** * @brief * The handleSelfTestReadLogRecord reads the log record from RTC RAM. - * @details - * Inputs: currentTime, logRecord, mfgRecord - * Outputs: currentTime + * @details Inputs: currentTime, logRecord, mfgRecord + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadLogRecord ( void ) @@ -989,9 +963,8 @@ * @brief * The handleSelfTestReadMfgRecords reads the manufacturing record from * EEPROM. - * @details - * Inputs: currentTime, calibrationRecord - * Outputs: currentTime + * @details Inputs: currentTime, calibrationRecord + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadMfgRecord ( void ) @@ -1016,9 +989,8 @@ * @brief * The handleSelfTestReadCalibrationRecord reads the calibration record * from EEPROM. - * @details - * Inputs: currentTime - * Outputs: currentTime + * @details Inputs: currentTime + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadCalibrationRecord ( void ) @@ -1045,9 +1017,8 @@ * @brief * The handleSelfTestReadServiceRecord reads the service dates from RTC * RAM. - * @details - * Inputs: currentTime, serviceRecord - * Outputs: currentTime + * @details Inputs: currentTime, serviceRecord + * @details Outputs: currentTime * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadServiceRecord ( void ) @@ -1073,9 +1044,8 @@ * @brief * The handleSelfTestReadLastDisinfectionDate reads the last disinfection date * from RTC RAM. - * @details - * Inputs: lastDisinfectionRecord - * Outputs: none + * @details Inputs: lastDisinfectionRecord + * @details Outputs: none * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestReadLastDisinfectionDate ( void ) @@ -1097,11 +1067,10 @@ * @brief * The handleSelfTestCheckCRC calculates the CRC of the records and compares * them to the CRC that was read. If they don't match, it will fail POST. - * @details - * Inputs: treatmentTimeRecord, waterConsumptionRecord, lastDisinfectionRecord, + * @details Inputs: treatmentTimeRecord, waterConsumptionRecord, lastDisinfectionRecord, * logRecord, mfgRecord, calibrationRecord, calibrationRecord, serviceRecord, * NVDataMgmtSelfTestResult - * Outputs: NVDataMgmtSelfTestResult, alarm if any of the CRC checks failed + * @details Outputs: NVDataMgmtSelfTestResult, alarm if any of the CRC checks failed * @return next state *************************************************************************/ static NVDATAMGMT_SELF_TEST_STATE_T handleSelfTestCheckCRC ( void ) @@ -1200,9 +1169,8 @@ /*********************************************************************//** * @brief * The handleExecWaitForPostState waits for POST to be completed. - * @details - * Inputs: NVDataMgmtSelfTestState - * Outputs: none + * @details Inputs: NVDataMgmtSelfTestState + * @details Outputs: none * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecWaitForPostState ( void ) @@ -1221,9 +1189,8 @@ * @brief * The handleExecIdleState checks if the queue is empty and if it is not * empty, it sets the state of the job. - * @details - * Inputs: currentJob, currentTime - * Outputs: currentJob + * @details Inputs: currentJob, currentTime + * @details Outputs: currentJob * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecIdleState ( void ) @@ -1289,9 +1256,8 @@ * @brief * The handleExecWriteToEEPROMState issues a write command to EEPROM on entry * and if the write was successful, it sets the state to Idle. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecWriteToEEPROMState ( void ) @@ -1311,9 +1277,8 @@ * @brief handleExecReadFromEEPROMState * The handleExecReadFromEEPROMState issues a read command to EEPROM on entry * and if the read was successful, it sets the state to Idle. - * @details - * Inputs: currentJob - * Outputs: currentJob + * @details Inputs: currentJob + * @details Outputs: currentJob * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecReadFromEEPROMState ( void ) @@ -1334,9 +1299,8 @@ * @brief * The handleExecEraseState issues an erase command to EEPROM on entry * and if the erase was successful, it sets the state to Idle. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecEraseState ( void ) @@ -1357,9 +1321,8 @@ * The handleExecWriteToRAMState issues a write command to RTC RAM if the * RAM was ready, and if the RAM got back to Idle after the write command, * it sets the state to Idle. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecWriteToRAMState ( void ) @@ -1381,9 +1344,8 @@ * RAM was ready, and if the RAM got back to Idle after the read command, * it calls another function to read the data back from RTC RAM and * it sets the state to Idle. - * @details - * Inputs: currentJob - * Outputs: currentJob + * @details Inputs: currentJob + * @details Outputs: currentJob * @return next state *************************************************************************/ static NVDATAMGMT_EXEC_STATE_T handleExecReadFromRAMState ( void ) @@ -1409,9 +1371,8 @@ * read or write. The function then checks for the length of the buffer and if * it is greater than the specified max buffer, it breaks the operation into * multiple jobs. - * @details - * Inputs: jobQueue, queueCount, queueRearIndex - * Outputs: jobQueue, queueCount, queueRearIndex + * @details Inputs: jobQueue, queueCount, queueRearIndex + * @details Outputs: jobQueue, queueCount, queueRearIndex * @param ops type of operation (i.e. write to EEPROM) * @param location location of operation (i.e. RTC RAM) * @param startAddress start address of operation @@ -1453,9 +1414,8 @@ * is at edge of the any of the sectors and if yes, it will update the log * header accordingly. If the write is not at the edge, it will prepare a * normal write to EEPROM job. - * @details - * Inputs: logRecord - * Outputs: logRecord + * @details Inputs: logRecord + * @details Outputs: logRecord * @param data address of data buffer * @return address of the next write as a U32 *************************************************************************/ @@ -1506,9 +1466,8 @@ * @brief * The prepareReadLogJobAndGetStartAddress prepares a read from the specified * address of the EEPROM. - * @details - * Inputs: logRecord - * Outputs: logRecord + * @details Inputs: logRecord + * @details Outputs: logRecord * @return address of the next read as a U32 *************************************************************************/ static U32 prepareReadLogJobAndGetStartAddress ( void ) @@ -1550,9 +1509,8 @@ * is at the beginning of the next sector, it schedules and erase first and then * it schedules the write jobs. The function breaks the write to EEPROM jobs to * 16 bytes at the time. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param ops type of operation (i.e. write to EEPROM) * @param location location of operation (i.e. RTC RAM) * @param startAddress start address of operation @@ -1623,9 +1581,8 @@ * @brief * The dequeue increments the front index counter and if it is equal to * rear index, it sets it to -1, meaning that the queue is empty. - * @details - * Inputs: queueFrontIndex, queueCount - * Outputs: queueFrontIndex, queueCount + * @details Inputs: queueFrontIndex, queueCount + * @details Outputs: queueFrontIndex, queueCount * @return none *************************************************************************/ static void dequeue ( void ) @@ -1650,9 +1607,8 @@ * @brief * The isQueueEmpty checks whether the queue is empty and if it is empty, * it will return a false. - * @details - * Inputs: queueCount - * Outputs: none + * @details Inputs: queueCount + * @details Outputs: none * @return TRUE if queue is not empty *************************************************************************/ static BOOL isQueueEmpty ( void ) @@ -1671,9 +1627,8 @@ * @brief * The isQueueFull checks whether the queue is full and if it is full, * it will return a true. - * @details - * Inputs: queueCount - * Outputs: none + * @details Inputs: queueCount + * @details Outputs: none * @return TRUE is queue is full *************************************************************************/ static BOOL isQueueFull ( void ) @@ -1691,9 +1646,8 @@ /*********************************************************************//** * @brief * The getAvailableQueueCount returns the number of available queues left. - * @details - * Inputs: queueCount - * Outputs: none + * @details Inputs: queueCount + * @details Outputs: none * @return available queue counts as a U32 *************************************************************************/ static U32 getAvailableQueueCount ( void ) @@ -1707,9 +1661,8 @@ * queues for erasing and setting the records. If there are enough queues, * it schedules an erase job and then schdules jobs to write all the records * back to Bank 7 Sector 0. - * @details - * Inputs: mfgRecord, calibrationRecord - * Outputs: none + * @details Inputs: mfgRecord, calibrationRecord + * @details Outputs: none * @return TRUE if there are enough queue jobs available *************************************************************************/ static BOOL enqueueBank7Sector0Records( void ) @@ -1734,9 +1687,8 @@ * The didCommandTimedout checks whether the a command whether RTC RAM or * EEPROM has timedout. If it has timedout, it sets the alarm and turns * flag to TRUE. - * @details - * Inputs: none - * Outputs: alarm if command timed out + * @details Inputs: none + * @details Outputs: alarm if command timed out * @param alarm alarm ID * @param state the state that the command timed out * @return TRUE if a command timed out @@ -1763,9 +1715,8 @@ * @brief * The eraseDataLogSectors checks whether there are enough queues available * and if there are, it schedules 3 erases to erase sectors 1,2, and 3. - * @details - * Inputs: none - * Outputs: non + * @details Inputs: none + * @details Outputs: non * @return TRUE if there are enough queues available *************************************************************************/ static BOOL eraseDataLogSectors ( void ) Index: PersistentAlarm.c =================================================================== diff -u -rd738232bc2e11aee687d4c62fc457577825a1b30 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- PersistentAlarm.c (.../PersistentAlarm.c) (revision d738232bc2e11aee687d4c62fc457577825a1b30) +++ PersistentAlarm.c (.../PersistentAlarm.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -48,7 +48,6 @@ * @brief * The initPersistentAlarm function initializes the PersistentAlarm module * when the alarm count lower than maximum persistent alarm allowed. - * @details * Inputs : none * Outputs : PersistentAlarm module initialized * @param alarmIndex Persistent alarm index @@ -85,7 +84,6 @@ * The checkPersistentAlarm function check whether data is out of range or * not. Then the function set or clear alarm once the persistent counter * exceeds the limit. - * @details * Inputs : none * Outputs : Checks for out of range data and set/clear alarm * @param alarmIndex Persistent alarm index Index: RTC.c =================================================================== diff -u -r7ff7e715f7a15da5f4055b33e186d58cf96fe909 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- RTC.c (.../RTC.c) (revision 7ff7e715f7a15da5f4055b33e186d58cf96fe909) +++ RTC.c (.../RTC.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -230,9 +230,8 @@ /*********************************************************************//** * @brief * The initRTC initializes the RTC module. - * @details - * Inputs: RTCSelfTestState, RTCSelfTestState - * Outputs: RTCSelfTestState, RTCSelfTestState + * @details Inputs: RTCSelfTestState, RTCSelfTestState + * @details Outputs: RTCSelfTestState, RTCSelfTestState * @return none *************************************************************************/ void initRTC( void ) @@ -245,9 +244,8 @@ * @brief * The setRTCTimestamp gets the timestamp values from caller, converts them * into BCD format and inserts them into the txBuffer to be written into the RTC. - * @details - * Inputs: RTCNewTimestampStruct, hasWriteToRTCRequested, isTimestampBufferReady - * Outputs: RTCNewTimestampStruct, hasWriteToRTCRequested, isTimestampBufferReady + * @details Inputs: RTCNewTimestampStruct, hasWriteToRTCRequested, isTimestampBufferReady + * @details Outputs: RTCNewTimestampStruct, hasWriteToRTCRequested, isTimestampBufferReady * @param secs seconds * @param mins minutes * @param hours hours @@ -303,9 +301,8 @@ /*********************************************************************//** * @brief * The execRTCSelfTest runs the RTC POST during the self-test. - * @details - * Inputs: RTCSelfTestState - * Outputs: RTCSelfTestState, alarm if invalid state was called + * @details Inputs: RTCSelfTestState + * @details Outputs: RTCSelfTestState, alarm if invalid state was called * @return RTCSelfTestResult the result of self-test *************************************************************************/ SELF_TEST_STATUS_T execRTCSelfTest( void ) @@ -360,9 +357,8 @@ /*********************************************************************//** * @brief * The execRTC function executes a signle pass of the RTC monitor state machine. - * @details - * Inputs: RTCExecState - * Outputs: RTCExecState, alarm if invalid state was called + * @details Inputs: RTCExecState + * @details Outputs: RTCExecState, alarm if invalid state was called * @return none *************************************************************************/ void execRTC( void ) @@ -419,9 +415,8 @@ /*********************************************************************//** * @brief * The getRTCTimestamp returns the current time in epoch format. - * @details - * Inputs: lastEpochTime - * Outputs: none + * @details Inputs: lastEpochTime + * @details Outputs: none * @return lastEpochTime the time in epoch as a U32 *************************************************************************/ U32 getRTCTimestamp( void ) @@ -435,10 +430,9 @@ * will check input address and length to make sure they are within the * range. If everything is fine, it will prepare the txBuffer and set the * RAM status to busy. - * @details - * Inputs: RTCRAMStatus, RTCRAMState, hasWriteToRAMRequested, RAMBufferLength, + * @details Inputs: RTCRAMStatus, RTCRAMState, hasWriteToRAMRequested, RAMBufferLength, * prepRAMBuffer, txBuffer - * Outputs: RTCRAMStatus, RTCRAMState, hasWriteToRAMRequested, RAMBufferLength, + * @details Outputs: RTCRAMStatus, RTCRAMState, hasWriteToRAMRequested, RAMBufferLength, * prepRAMBuffer, txBuffer * @param address address of the RTC RAM to write to * @param data address of the data buffer to be written to RAM @@ -490,10 +484,9 @@ * will check input address and length to make sure they are within the * range. If everything is fine, it will prepare the txBuffer and set the * RAM status to busy. - * @details - * Inputs: RTCRAMStatus, RTCRAMState, hasReadFromRAMRequested, RAMBufferLength, + * @details Inputs: RTCRAMStatus, RTCRAMState, hasReadFromRAMRequested, RAMBufferLength, * prepRAMBuffer, txBuffer - * Outputs: RTCRAMStatus, RTCRAMState, hasReadFromRAMRequested, RAMBufferLength, + * @details Outputs: RTCRAMStatus, RTCRAMState, hasReadFromRAMRequested, RAMBufferLength, * prepRAMBuffer, txBuffer * @param address address of the RTC RAM to read data from * @param length length of data to be read from RAM @@ -540,9 +533,8 @@ /*********************************************************************//** * @brief * The getRTCRAMState returns the RAM state. - * @details - * Inputs: RTCRAMState - * Outputs: none + * @details Inputs: RTCRAMState + * @details Outputs: none * @return RTC RAM state *************************************************************************/ RTC_RAM_STATE_T getRTCRAMState( void ) @@ -554,9 +546,8 @@ * @brief * The getRTCRAMStatus returns the RAM status. If the RAM status is complete * it will set the RAM status to Idle and the RAM state to Ready. - * @details - * Inputs: RTCRAMStatus, RTCRAMState - * Outputs: RTCRAMStatus, RTCRAMState + * @details Inputs: RTCRAMStatus, RTCRAMState + * @details Outputs: RTCRAMStatus, RTCRAMState * @return RTC RAM status *************************************************************************/ RTC_RAM_STATUS_T getRTCRAMStatus( void ) @@ -574,9 +565,8 @@ * @brief * The getDataFromRAM populates the provided external buffer with the data * in the specified address in the RTC RAM. - * @details - * Inputs: RAMBuffer - * Outputs: none + * @details Inputs: RAMBuffer + * @details Outputs: none * @param externalBuffer address of the external buffer to copy data into * @param length length of data to be copied into buffer * @return none @@ -610,10 +600,9 @@ * If it was not called for the first time, it will wait to the buffer * to be transmitted and then it will populate the provided receive buffer * If the transaction failed, it will try 3 time before it fails. - * @details * Inputs : isRTCServiceOnEntry, RTCServiceState, numberOfFailedRTCTransfers, * previousTransferLength - * Outputs: isRTCServiceOnEntry, RTCServiceState, numberOfFailedRTCTransfers, + * @details Outputs: isRTCServiceOnEntry, RTCServiceState, numberOfFailedRTCTransfers, * previousTransferLength * @return TRUE if RTC operation was successful *************************************************************************/ @@ -695,9 +684,8 @@ * The isRTCFunctional checks whether the RTC is still functional by checking * the bits in the first 3 control registers. The function ignore the clear * flags. - * @details - * Inputs: rxBuffer - * Outputs: alarm if any of the control registers are at fault + * @details Inputs: rxBuffer + * @details Outputs: alarm if any of the control registers are at fault * @return TRUE if the control registers are normal *************************************************************************/ static BOOL isRTCFunctional( void ) @@ -755,9 +743,8 @@ /*********************************************************************//** * @brief * The convertBCD2Decimal converts the BCD values to decimal. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param bcd the number in bcd * @return number is decimal a U08 *************************************************************************/ @@ -785,9 +772,8 @@ /*********************************************************************//** * @brief * The convertDecimal2BCD converts the decimal values to BCD. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param decimal number if decimal * @return number in bcd as a U08 *************************************************************************/ @@ -812,9 +798,8 @@ /*********************************************************************//** * @brief * The convertTime2Epoch converts the time into epoch (seconds from Jan 1 1970). - * @details - * Inputs: RTCTimestampStruct - * Outputs: none + * @details Inputs: RTCTimestampStruct + * @details Outputs: none * @return time in epoch as a U32 *************************************************************************/ static U32 convertTime2Epoch( void ) @@ -851,9 +836,8 @@ * @brief * The updateReadTimestampStruct function updates the time structure * after every read. - * @details - * Inputs: RTCTimestampStruct - * Outputs: RTCTimestampStruct + * @details Inputs: RTCTimestampStruct + * @details Outputs: RTCTimestampStruct * @return none *************************************************************************/ static void updateReadTimestampStruct( void ) @@ -871,9 +855,8 @@ * @brief * The setMibSPIBufferLength sets the MibSPI buffer length prior to every * RTC transaction. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param length length of data transfer in bytes * @return TRUE if the buffer length was set successfully *************************************************************************/ @@ -943,9 +926,8 @@ /*********************************************************************//** * @brief * The prepBufferForReadCommand sets the txBuffer for a read. - * @details - * Inputs: txBuffer - * Outputs: txBuffer + * @details Inputs: txBuffer + * @details Outputs: txBuffer * @param length length of buffer to read * @return none *************************************************************************/ @@ -964,9 +946,8 @@ * @brief * The handleExecWaitForPostState checks whether POST has completed and what * was the result of the POST test. It will either go to Idle of Fault. - * @details - * Inputs: RTCSelfTestState - * Outputs: none + * @details Inputs: RTCSelfTestState + * @details Outputs: none * @return next state *************************************************************************/ static RTC_EXEC_STATE_T handleExecWaitForPostState( void ) @@ -986,10 +967,9 @@ * The handleExecIdleState checks whether read or write to RTC or RAM has * been requested. If none of them have been requested, it will increment the * timer. - * @details - * Inputs: nohasWriteToRTCRequested, hasWriteToRAMRequested, + * @details Inputs: nohasWriteToRTCRequested, hasWriteToRAMRequested, * hasReadFromRAMRequested, timeCounter - * Outputs: timeCounter + * @details Outputs: timeCounter * @return next state *************************************************************************/ static RTC_EXEC_STATE_T handleExecIdleState( void ) @@ -1024,10 +1004,9 @@ /*********************************************************************//** * @brief * The handleExecWriteState writes timestamp to RTC. - * @details - * Inputs: isTimestampBufferReady, txBuffer, hasWriteToRTCRequested, + * @details Inputs: isTimestampBufferReady, txBuffer, hasWriteToRTCRequested, * timeCounter, RTCServiceState - * Outputs: isTimestampBufferReady, txBuffer, hasWriteToRTCRequested, + * @details Outputs: isTimestampBufferReady, txBuffer, hasWriteToRTCRequested, * timeCounter, alarm if any RTC RAM operations occurred * @return next state *************************************************************************/ @@ -1072,10 +1051,9 @@ /*********************************************************************//** * @brief * The handleExecPrepRAMState prepares the RAM for read or write. - * @details - * Inputs: RTCServiceState, hasWriteToRAMRequested, hasReadFromRAMRequested, + * @details Inputs: RTCServiceState, hasWriteToRAMRequested, hasReadFromRAMRequested, * prepRAMBuffer, RAMBuffer - * Outputs: alarm if any RTC RAM operations error occurred + * @details Outputs: alarm if any RTC RAM operations error occurred * @return next state *************************************************************************/ static RTC_EXEC_STATE_T handleExecPrepRAMState( void ) @@ -1106,10 +1084,9 @@ /*********************************************************************//** * @brief * The handleExecWriteToRAMState writes to RAM. - * @details - * Inputs: RTCServiceState, hasWriteToRAMRequested, RTCRAMStatus, txBuffer, + * @details Inputs: RTCServiceState, hasWriteToRAMRequested, RTCRAMStatus, txBuffer, * RAMBuffer, RAMBufferLength - * Outputs: hasWriteToRAMRequested, RTCRAMStatus, alarm if any RTC RAM + * @details Outputs: hasWriteToRAMRequested, RTCRAMStatus, alarm if any RTC RAM * operations errors occurred * @return next state *************************************************************************/ @@ -1138,10 +1115,9 @@ /*********************************************************************//** * @brief * The handleExecReadFromRAMState read from RAM. - * @details - * Inputs: RTCServiceState, hasReadFromRAMRequested, RTCRAMStatus, txBuffer, + * @details Inputs: RTCServiceState, hasReadFromRAMRequested, RTCRAMStatus, txBuffer, * RAMBuffer, RAMBufferLength - * Outputs: hasReadFromRAMRequested, RTCRAMStatus, alarm if any RTC RAM + * @details Outputs: hasReadFromRAMRequested, RTCRAMStatus, alarm if any RTC RAM * operations errors occurred * @return next state *************************************************************************/ @@ -1172,9 +1148,8 @@ * The handleExecReadState reads timestamp from RTC. The function calls * other functions to update the time structure and convert the latest time * to epoch. - * @details - * Inputs: RTCServiceState, lastEpochTime, timeCounter, txBuffer, rxBuffer - * Outputs: lastEpochTime, timeCounter, alarm if any RTC operations error + * @details Inputs: RTCServiceState, lastEpochTime, timeCounter, txBuffer, rxBuffer + * @details Outputs: lastEpochTime, timeCounter, alarm if any RTC operations error * occurred * @return next state *************************************************************************/ @@ -1208,9 +1183,8 @@ * @brief * The handleSelfTestStart calls another function to prepare the txBuffer * for a read and sets the state to control registers. - * @details - * Inputs: RTCSelfTestResult - * Outputs: RTCSelfTestResult + * @details Inputs: RTCSelfTestResult + * @details Outputs: RTCSelfTestResult * @return next state *************************************************************************/ static RTC_SELF_TEST_STATE_T handleSelfTestStart( void ) @@ -1229,10 +1203,9 @@ * another function to check whether RTC is function or not. If the RTC is * functional, it will update the RTCPreviousSecond variable and sets the * state machine to the next state. - * @details - * Inputs: RTCServiceState, txBuffer, rxBuffer, RTCPreviousSecond, + * @details Inputs: RTCServiceState, txBuffer, rxBuffer, RTCPreviousSecond, * RTCSelfTestResult - * Outputs: RTCPreviousSecond, RTCSelfTestResult + * @details Outputs: RTCPreviousSecond, RTCSelfTestResult * @return next state *************************************************************************/ static RTC_SELF_TEST_STATE_T handleSelfTestCheckCtrlRegs( void ) @@ -1268,10 +1241,9 @@ * The handleSelfTestWaitForFirstSecond continuously reads the RTC and compares * latest second from RTC to the previous second and if it has changed, it will * start the timer and set the state machine to the next state. - * @details - * Inputs: RTCServiceState, txBuffer, rxBuffer, RTCCurrentSecond, RTCSelfTestTimer, + * @details Inputs: RTCServiceState, txBuffer, rxBuffer, RTCCurrentSecond, RTCSelfTestTimer, * RTCPreviousSecond - * Outputs: RTCCurrentSecond, RTCSelfTestTimer, RTCPreviousSecond + * @details Outputs: RTCCurrentSecond, RTCSelfTestTimer, RTCPreviousSecond * @return next state *************************************************************************/ static RTC_SELF_TEST_STATE_T handleSelfTestWaitForFirstSecond( void ) @@ -1313,9 +1285,8 @@ * The handleSelfTestWaitForSecondSecond continuously reads the RTC and compares * latest second from RTC to the previous second and if it has changed, it will * set the state machine to the next state. - * @details - * Inputs: RTCServiceState, txBuffer, rxBuffer, RTCCurrentSecond - * Outputs: RTCCurrentSecond + * @details Inputs: RTCServiceState, txBuffer, rxBuffer, RTCCurrentSecond + * @details Outputs: RTCCurrentSecond * @return next state *************************************************************************/ static RTC_SELF_TEST_STATE_T handleSelfTestWaitForSecondSecond( void ) @@ -1355,8 +1326,7 @@ * within the specified time tolerance. It will call another function to check * whether one second has elapsed. If the time has elapsed, how much time has * passed since the last second that was read from RTC. - * @details - * Inputs: RTCSelfTestTimer, RTCSelfTestResult + * @details Inputs: RTCSelfTestTimer, RTCSelfTestResult * Outputs : RTCSelfTestTimer, RTCSelfTestResult, alarm if RTC time accuracy * test failed * @return Next state Index: Timers.c =================================================================== diff -u -r7ff7e715f7a15da5f4055b33e186d58cf96fe909 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- Timers.c (.../Timers.c) (revision 7ff7e715f7a15da5f4055b33e186d58cf96fe909) +++ Timers.c (.../Timers.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -31,9 +31,8 @@ /*********************************************************************//** * @brief * The initTimers function initializes the Timers module. - * @details - * Inputs: msTimerCount - * Outputs: msTimerCount + * @details Inputs: msTimerCount + * @details Outputs: msTimerCount * @return none *************************************************************************/ void initTimers( void ) @@ -44,9 +43,8 @@ /*********************************************************************//** * @brief * The incMSTimerCount function increments the ms timer count. - * @details - * Inputs: msTimerCount - * Outputs: msTimerCount + * @details Inputs: msTimerCount + * @details Outputs: msTimerCount * @return none *************************************************************************/ void incMSTimerCount( void ) @@ -57,9 +55,8 @@ /*********************************************************************//** * @brief * The getMSTimerCount function returns the current ms timer count. - * @details - * Inputs: msTimerCount - * Outputs: none + * @details Inputs: msTimerCount + * @details Outputs: none * @return msTimerCount as a U32 *************************************************************************/ U32 getMSTimerCount( void ) @@ -71,9 +68,8 @@ * @brief * The didTimeout function determines whether a timeout has occurred between * a given start count and a given timeout period (in ms). - * @details - * Inputs: msTimerCount - * Outputs: none + * @details Inputs: msTimerCount + * @details Outputs: none * @param startMSCount the ms count at the start of the timeout period * @param timeoutPeriod the period for the timeout (in ms) * @return TRUE if a timeout has occurred, FALSE if not @@ -109,9 +105,8 @@ * @brief * The calcTimeSince function calculates the time (in ms) from a given start * time until now. - * @details - * Inputs: msTimerCount - * Outputs: none + * @details Inputs: msTimerCount + * @details Outputs: none * @param startMSCount the ms count at the start of the period * @return ms since given start time *************************************************************************/ @@ -137,9 +132,8 @@ * @brief * The calcTimeBetween function calculates the time (in ms) from a given start * time until a given end time. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param startMSCount the ms count at the start of the period * @param endMSCount the ms count at the end of the period * @return ms between two given times Index: Utilities.c =================================================================== diff -u -r7ff7e715f7a15da5f4055b33e186d58cf96fe909 -rb28e0e05a9632cc46fc12378f2993a69d861a4cb --- Utilities.c (.../Utilities.c) (revision 7ff7e715f7a15da5f4055b33e186d58cf96fe909) +++ Utilities.c (.../Utilities.c) (revision b28e0e05a9632cc46fc12378f2993a69d861a4cb) @@ -100,9 +100,8 @@ * @brief * The crc16 function calculates a 16-bit CRC for a given range of bytes * in memory. Poly = 0x1021. Not reflected. Initial value = 0xFFFF. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param address pointer to start address of memory range to calculate CRC for * @param len number of bytes in the memory range to calculate CRC for * @return CRC as a U16 @@ -124,9 +123,8 @@ * @brief * The crc8 function calculates a 8-bit CRC for a given range of bytes * in memory. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param address pointer to start address of memory range to calculate CRC for * @param len number of bytes in the memory range to calculate CRC for * @return CRC as a U08 @@ -147,9 +145,8 @@ /*********************************************************************//** * @brief * The initTimeWindowedCount function initializes a given time windowed count. - * @details - * Inputs: timeWindowedCountsMaxCount, timeWindowedCountsInitialized - * Outputs: timeWindowedCountsMaxCount, timeWindowedCountsInitialized, alarm if + * @details Inputs: timeWindowedCountsMaxCount, timeWindowedCountsInitialized + * @details Outputs: timeWindowedCountsMaxCount, timeWindowedCountsInitialized, alarm if * software fault occurred * @param cnt ID of the time windowed count to initialize * @param maxCnt maximum number of instances in the time window for this count @@ -202,9 +199,8 @@ * function for a given time windowed count. * *Note - thread protection not provided - assumed function will be called * by one task for a given time windowed count. - * @details - * Inputs: timeWindowedCounts, timeWindowedCountIndexes, timeWindowedCountCounts - * Outputs: timeWindowedCounts, timeWindowedCountIndexes, timeWindowedCountCounts, + * @details Inputs: timeWindowedCounts, timeWindowedCountIndexes, timeWindowedCountCounts + * @details Outputs: timeWindowedCounts, timeWindowedCountIndexes, timeWindowedCountCounts, * alarm if a software fault occurred * @param cnt ID of the time windowed count to add an instance to * @return TRUE if this instances brings the count to the maximum within @@ -247,9 +243,8 @@ * The getCriticalData function gets the value for a given critical data * record. The integrity of the critical data is checked first. If the * critical data record fails the integrity check, a fault is triggered. - * @details - * Inputs: none - * Outputs: alarm if HD critical error occurred + * @details Inputs: none + * @details Outputs: alarm if HD critical error occurred * @param data Ptr to a critical data record * @return The data from a critical data record *************************************************************************/ @@ -284,9 +279,8 @@ * @brief * The isCriticalDataInRange function determines whether a critical data * value is within the range set for that critical data. - * @details - * Inputs: none - * Outputs: none + * @details Inputs: none + * @details Outputs: none * @param data Ptr to a critical data record * @return TRUE if given data is in range, FALSE if not *************************************************************************/ @@ -323,9 +317,8 @@ * @brief * The setCriticalData function sets the value for a given critical data * record. - * @details - * Inputs: none - * Outputs: alarm if HD critical error occurred + * @details Inputs: none + * @details Outputs: alarm if HD critical error occurred * @param data Ptr to a critical data record * @param value a value to set * @return TRUE if set was successful, FALSE if not (out of range) @@ -365,9 +358,8 @@ /*********************************************************************//** * @brief * The resetCriticalData function resets a critical data record. - * @details - * Inputs: none - * Outputs: Given critical data record is reset to unset w/ default value. + * @details Inputs: none + * @details Outputs: Given critical data record is reset to unset w/ default value. * @param data Ptr to a critical data record * @return none *************************************************************************/