Index: NVDataMgmt.h =================================================================== diff -u -r2a312d7c2448c2ad754532e71c27cbe91f671a15 -r6c500be6ac0c5adffc0d91b666862e35ba27e2db --- NVDataMgmt.h (.../NVDataMgmt.h) (revision 2a312d7c2448c2ad754532e71c27cbe91f671a15) +++ NVDataMgmt.h (.../NVDataMgmt.h) (revision 6c500be6ac0c5adffc0d91b666862e35ba27e2db) @@ -20,13 +20,22 @@ #include "Common.h" +/** + * @defgroup NVDataMgmt NVDataMgmt + * @brief Non-volatile data management module. Handles Bank 7 of the TI processor and the + * RAM of the RTC chip + * + * @addtogroup NVDataMgmt + * @{ + */ + // ********** public definitions ********** #define MAX_SYS_SERIAL_NUMBER_CHARACTERS 7U ///< Max number of characters for SYS serial number #define MAX_HW_SERIAL_NUMBER_CHARACTERS 5U ///< Max number of characters for HD serial number #define MAX_DATE_CHARACTERS 10U ///< Max number of characters for date -/// Log event enum +/// Log event enumeration. typedef enum LOG_EVENT { NVDATAMGMT_MODE_CHANGE = 0, ///< Mode change @@ -38,7 +47,7 @@ NVDATAMGMT_UI_CRASHED ///< UI crashed } NVDATAMGMT_LOG_EVENT_T; -/// Read status enum +/// Read status enumeration. typedef enum READ_STATUS { NVDATAMGMT_READ_IDLE = 0, ///< Read status idle @@ -47,15 +56,15 @@ } NVDATAMGMT_READ_STATUS_T; #pragma pack(push, 1) -/// Manufacturing data struct +/// Manufacturing data structure. typedef struct mfg_Data { char SYSSerialNumber [ MAX_SYS_SERIAL_NUMBER_CHARACTERS ]; ///< SYS serial number char HWSerialNumber [ MAX_HW_SERIAL_NUMBER_CHARACTERS ]; ///< HW serial number char mfgDate [ MAX_DATE_CHARACTERS ]; ///< Manufacturing date } MFG_DATA_T; -/// Calibration data struct +/// Calibration data structure. typedef struct calibration_Data { U32 calRecordRevision; ///< Revision of calibration record (rev when structure changes to determine compatibility with f/w version) @@ -73,21 +82,21 @@ char calDateAccel[ MAX_DATE_CHARACTERS ]; ///< Last calibration date of accelerometer } CALIBRATION_DATA_T; -/// Service dates struct +/// Service dates structure. typedef struct service_dates { char currentServiceDate [ MAX_DATE_CHARACTERS ]; ///< Current service date char nextServiceDate [ MAX_DATE_CHARACTERS ]; ///< Next service date } SERVICE_DATA_T; -/// Read data status +/// Read data status structure. typedef struct get_data { NVDATAMGMT_READ_STATUS_T status; ///< Read data status U08* externalBuffer; ///< External buffer address } READ_DATA_T; -/// Log data struct +/// Log data structure. typedef struct { U32 epochTime; ///< Log data time in epoch @@ -100,10 +109,10 @@ F32 data5; ///< Log data 5 } LOG_DATA_T; -/// Disinfection date struct +/// Disinfection date structure. typedef struct { - char disinfectionDate [ MAX_DATE_CHARACTERS ]; ///< Disinfection Date + char disinfectionDate [ MAX_DATE_CHARACTERS ]; ///< Disinfection Date } DISINFECTION_DATE_T; #pragma pack(pop) @@ -147,4 +156,6 @@ BOOL readLogData ( READ_DATA_T* buffer, U32 length ); -#endif /* FWCOMMON_NVDATAMGMT_H_ */ +/**@}*/ + +#endif