Index: firmware/App/Drivers/NVDriver.h =================================================================== diff -u -rb878faee61a0800b767d053ab3f65afb3790dacb -r63c3a65e681810f037718377c6ed5a28c897d0ca --- firmware/App/Drivers/NVDriver.h (.../NVDriver.h) (revision b878faee61a0800b767d053ab3f65afb3790dacb) +++ firmware/App/Drivers/NVDriver.h (.../NVDriver.h) (revision 63c3a65e681810f037718377c6ed5a28c897d0ca) @@ -19,52 +19,53 @@ /** * @defgroup NVDriver NVDriver - * @brief + * @brief Non Volatile Memory Driver module provides an abstraction layer for + * accessing Flash memory, ncluding initialization, sector erase, read, and write operations. * * @addtogroup NVDriver * @{ */ // ********** public definitions ********** -#define BANK7_SECTOR0_START_ADDRESS 0xF0200000 ///< Bank7 sector 0 start address. -#define BANK7_SECTOR0_END_ADDRESS 0xF0203FFF ///< Bank7 sector 0 end address. +#define BANK7_SECTOR0_START_ADDRESS 0xF0200000 ///< Bank7 sector 0 start address. +#define BANK7_SECTOR0_END_ADDRESS 0xF0203FFF ///< Bank7 sector 0 end address. -#define BANK7_SECTOR1_START_ADDRESS 0xF0204000 ///< Bank7 sector 1 start address. -#define BANK7_SECTOR1_END_ADDRESS 0xF0207FFF ///< Bank7 sector 1 end address. +#define BANK7_SECTOR1_START_ADDRESS 0xF0204000 ///< Bank7 sector 1 start address. +#define BANK7_SECTOR1_END_ADDRESS 0xF0207FFF ///< Bank7 sector 1 end address. -#define BANK7_SECTOR2_START_ADDRESS 0xF0208000 ///< Bank7 sector 2 start address. -#define BANK7_SECTOR2_END_ADDRESS 0xF020BFFF ///< Bank7 sector 2 end address. +#define BANK7_SECTOR2_START_ADDRESS 0xF0208000 ///< Bank7 sector 2 start address. +#define BANK7_SECTOR2_END_ADDRESS 0xF020BFFF ///< Bank7 sector 2 end address. -#define BANK7_SECTOR3_START_ADDRESS 0xF020C000 ///< Bank7 sector 3 start address. -#define BANK7_SECTOR3_END_ADDRESS 0xF020FFFF ///< Bank7 sector 3 end address. +#define BANK7_SECTOR3_START_ADDRESS 0xF020C000 ///< Bank7 sector 3 start address. +#define BANK7_SECTOR3_END_ADDRESS 0xF020FFFF ///< Bank7 sector 3 end address. /// NVDataMgmt memory operation modes enumeration. typedef enum NVDataMgmt_Operation { - NVDATAMGMT_NONE = 0, ///< Default mode to prevent any accidental ops. - NVDATAMGMT_WRITE, ///< Operation mode write. - NVDATAMGMT_READ, ///< Operation mode read. - NVDATAMGMT_ERASE_SECTOR, ///< Operation mode erase a sector (EEPROM). - NUM_OF_NVDATAMGMT_OPS_STATES ///< Total number of operation states. + NVDATAMGMT_NONE = 0, ///< Default mode to prevent any accidental ops. + NVDATAMGMT_WRITE, ///< Operation mode write. + NVDATAMGMT_READ, ///< Operation mode read. + NVDATAMGMT_ERASE_SECTOR, ///< Operation mode erase a sector (EEPROM). + NUM_OF_NVDATAMGMT_OPS_STATES ///< Total number of operation states. } NVDATAMGMT_OPERATION_STATE_T; /// NVDataMgmt records' jobs states typedef enum NVDataMgmt_Records_Jobs { - NVDATAMGMT_SYSTEM_RECORD = 0, ///< NVDataMgmt process write system record. - NVDATAMGMT_SERVICE_RECORD, ///< NVDataMgmt process service record. - NVDATAMGMT_CALIBRATION_RECORD, ///< NVDataMgmt process write calibration record. - NVDATAMGMT_INSTITUTIONAL_RECORD, ///< NVDataMgmt process institutional record. - NVDATAMGMT_USAGE_INFO_RECORD, ///< NVDataMgmt process usage info record. - NUM_OF_NVDATMGMT_RECORDS_JOBS ///< Number of NVDataMgmt records jobs. + NVDATAMGMT_SYSTEM_RECORD = 0, ///< NVDataMgmt process system record. + NVDATAMGMT_SERVICE_RECORD, ///< NVDataMgmt process service record. + NVDATAMGMT_CALIBRATION_RECORD, ///< NVDataMgmt process calibration record. + NVDATAMGMT_INSTITUTIONAL_RECORD, ///< NVDataMgmt process institutional record. + NVDATAMGMT_USAGE_INFO_RECORD, ///< NVDataMgmt process usage info record. + NUM_OF_NVDATMGMT_RECORDS_JOBS ///< Number of NVDataMgmt records jobs. } RECORD_JOBS_STATE_T; /// Process records job structure typedef struct { - NVDATAMGMT_OPERATION_STATE_T memoryOperation; ///< Memory operation. - RECORD_JOBS_STATE_T recordJob; ///< Record job (i.e sector 0). + NVDATAMGMT_OPERATION_STATE_T memoryOperation; ///< Memory operation. + RECORD_JOBS_STATE_T recordJob; ///< Record job (i.e sector 0). } PROCESS_RECORD_JOB_T; // ********** public function prototypes **********