Index: RTC.h =================================================================== diff -u -re8828d66e4a76e0590c3f06b7f6235f33df64e80 -r2da9d757cef985b4ad1e8adee3e19fa3430cc4fb --- RTC.h (.../RTC.h) (revision e8828d66e4a76e0590c3f06b7f6235f33df64e80) +++ RTC.h (.../RTC.h) (revision 2da9d757cef985b4ad1e8adee3e19fa3430cc4fb) @@ -20,23 +20,32 @@ #include "Common.h" -/// RTC RAM status +/** + * @defgroup RTC RTC + * @brief Real time clock module. This module controls the clock and + * the RAM of the RTC chip + * + * @addtogroup RTC + * @{ + */ + +/// RTC RAM status enumeration. typedef enum RTC_RAM_STATUS { RTC_RAM_STATUS_IDLE = 0, ///< Status idle - RTC_RAM_STATUS_IN_PROGRESS, ///< Status in progress - RTC_RAM_STATUS_BYTES_EXCEEDED, ///< Status bytes exceeded - RTC_RAM_STATUS_ILLEGAL_ADDRESS, ///< Status illegal address - RTC_RAM_STATUS_FAILED, ///< Status failed - RTC_RAM_STATUS_COMPLETE ///< Status complete + RTC_RAM_STATUS_IN_PROGRESS, ///< Status RAM operations are in progress + RTC_RAM_STATUS_BYTES_EXCEEDED, ///< Status number of bytes for last operation exceeded maximum + RTC_RAM_STATUS_ILLEGAL_ADDRESS, ///< Status address given for last operation invalid + RTC_RAM_STATUS_FAILED, ///< Status last operation failed + RTC_RAM_STATUS_COMPLETE ///< Status last operation completed } RTC_RAM_STATUS_T; -/// RTC RAM states +/// RTC RAM states enumeration. typedef enum RTC_RAM_STATE { - RTC_RAM_STATE_READY = 0, ///< RAM ready - RTC_RAM_STATE_BUSY ///< RAM busy + RTC_RAM_STATE_READY = 0, ///< RTC RAM is ready for the next operation + RTC_RAM_STATE_BUSY ///< RTC RAM is busy } RTC_RAM_STATE_T; @@ -60,4 +69,6 @@ void getDataFromRAM( U08* externalBuffer, U32 length ); +/**@}*/ + #endif