Index: RTC.h =================================================================== diff -u -re1f9404958c9ddab9b004399fb0870e09e37512b -r0f1d0c443daee3e30ae823711e85f3410bbf49fe --- RTC.h (.../RTC.h) (revision e1f9404958c9ddab9b004399fb0870e09e37512b) +++ RTC.h (.../RTC.h) (revision 0f1d0c443daee3e30ae823711e85f3410bbf49fe) @@ -1,41 +1,51 @@ /************************************************************************** - * - * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. - * - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN - * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * - * @file RTC.h - * - * @date 27-NOV-2019 - * @author D. Navaei - * - * @brief RTC header file. - * - **************************************************************************/ +* +* Copyright (c) 2019-2021 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file RTC.h +* +* @author (last) Sean Nash +* @date (last) 08-Sep-2020 +* +* @author (original) Dara Navaei +* @date (original) 11-Jan-2020 +* +***************************************************************************/ #ifndef _RTC_H_ #define _RTC_H_ #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; @@ -59,4 +69,6 @@ void getDataFromRAM( U08* externalBuffer, U32 length ); +/**@}*/ + #endif