lpc17xx_rtc.h

Go to the documentation of this file.

/***********************************************************************/
/* Peripheral group ----------------------------------------------------------- */
#ifndef LPC17XX_RTC_H_
#define LPC17XX_RTC_H_

/* Includes ------------------------------------------------------------------- */
#include "LPC17xx.h"
#include "lpc_types.h"


#ifdef __cplusplus
extern "C"
{
#endif


/* Private Macros ------------------------------------------------------------- */
/* ----------------------- BIT DEFINITIONS ----------------------------------- */
/* Miscellaneous register group --------------------------------------------- */
/**********************************************************************
* ILR register definitions
**********************************************************************/
#define RTC_ILR_BITMASK         ((0x00000003))

#define RTC_IRL_RTCCIF          ((1<<0))

#define RTC_IRL_RTCALF          ((1<<1))

/**********************************************************************
* CCR register definitions
**********************************************************************/
#define RTC_CCR_BITMASK         ((0x00000013))

#define RTC_CCR_CLKEN           ((1<<0))

#define RTC_CCR_CTCRST          ((1<<1))

#define RTC_CCR_CCALEN          ((1<<4))

/**********************************************************************
* CIIR register definitions
**********************************************************************/
#define RTC_CIIR_IMSEC          ((1<<0))

#define RTC_CIIR_IMMIN          ((1<<1))

#define RTC_CIIR_IMHOUR         ((1<<2))

#define RTC_CIIR_IMDOM          ((1<<3))

#define RTC_CIIR_IMDOW          ((1<<4))

#define RTC_CIIR_IMDOY          ((1<<5))

#define RTC_CIIR_IMMON          ((1<<6))

#define RTC_CIIR_IMYEAR         ((1<<7))

#define RTC_CIIR_BITMASK        ((0xFF))

/**********************************************************************
* AMR register definitions
**********************************************************************/
#define RTC_AMR_AMRSEC          ((1<<0))

#define RTC_AMR_AMRMIN          ((1<<1))

#define RTC_AMR_AMRHOUR         ((1<<2))

#define RTC_AMR_AMRDOM          ((1<<3))

#define RTC_AMR_AMRDOW          ((1<<4))

#define RTC_AMR_AMRDOY          ((1<<5))

#define RTC_AMR_AMRMON          ((1<<6))

#define RTC_AMR_AMRYEAR         ((1<<7))

#define RTC_AMR_BITMASK         ((0xFF))

/**********************************************************************
* RTC_AUX register definitions
**********************************************************************/
#define RTC_AUX_RTC_OSCF        ((1<<4))

/**********************************************************************
* RTC_AUXEN register definitions
**********************************************************************/
#define RTC_AUXEN_RTC_OSCFEN    ((1<<4))

/* Consolidated time register group ----------------------------------- */
/**********************************************************************
* Consolidated Time Register 0 definitions
**********************************************************************/
#define RTC_CTIME0_SECONDS_MASK     ((0x3F))
#define RTC_CTIME0_MINUTES_MASK     ((0x3F00))
#define RTC_CTIME0_HOURS_MASK       ((0x1F0000))
#define RTC_CTIME0_DOW_MASK         ((0x7000000))

/**********************************************************************
* Consolidated Time Register 1 definitions
**********************************************************************/
#define RTC_CTIME1_DOM_MASK         ((0x1F))
#define RTC_CTIME1_MONTH_MASK       ((0xF00))
#define RTC_CTIME1_YEAR_MASK        ((0xFFF0000))

/**********************************************************************
* Consolidated Time Register 2 definitions
**********************************************************************/
#define RTC_CTIME2_DOY_MASK         ((0xFFF))

/**********************************************************************
* Time Counter Group and Alarm register group
**********************************************************************/
#define RTC_SEC_MASK            (0x0000003F)

#define RTC_MIN_MASK            (0x0000003F)

#define RTC_HOUR_MASK           (0x0000001F)

#define RTC_DOM_MASK            (0x0000001F)

#define RTC_DOW_MASK            (0x00000007)

#define RTC_DOY_MASK            (0x000001FF)

#define RTC_MONTH_MASK          (0x0000000F)

#define RTC_YEAR_MASK           (0x00000FFF)

#define RTC_SECOND_MAX      59 
#define RTC_MINUTE_MAX      59 
#define RTC_HOUR_MAX        23 
#define RTC_MONTH_MIN       1 
#define RTC_MONTH_MAX       12 
#define RTC_DAYOFMONTH_MIN  1 
#define RTC_DAYOFMONTH_MAX  31 
#define RTC_DAYOFWEEK_MAX   6 
#define RTC_DAYOFYEAR_MIN   1 
#define RTC_DAYOFYEAR_MAX   366 
#define RTC_YEAR_MAX        4095 
/**********************************************************************
* Calibration register
**********************************************************************/
/* Calibration register */
#define RTC_CALIBRATION_CALVAL_MASK     ((0x1FFFF))

#define RTC_CALIBRATION_LIBDIR          ((1<<17))

#define RTC_CALIBRATION_MAX             ((0x20000))

#define RTC_CALIB_DIR_FORWARD           ((uint8_t)(0))
#define RTC_CALIB_DIR_BACKWARD          ((uint8_t)(1))


/* ---------------- CHECK PARAMETER DEFINITIONS ---------------------------- */
#define PARAM_RTCx(x)   (((uint32_t *)x)==((uint32_t *)LPC_RTC))

/* Macro check RTC interrupt type */
#define PARAM_RTC_INT(n)    ((n==RTC_INT_COUNTER_INCREASE) || (n==RTC_INT_ALARM))

/* Macro check RTC time type */
#define PARAM_RTC_TIMETYPE(n)   ((n==RTC_TIMETYPE_SECOND) || (n==RTC_TIMETYPE_MINUTE) \
|| (n==RTC_TIMETYPE_HOUR) || (n==RTC_TIMETYPE_DAYOFWEEK) \
|| (n==RTC_TIMETYPE_DAYOFMONTH) || (n==RTC_TIMETYPE_DAYOFYEAR) \
|| (n==RTC_TIMETYPE_MONTH) || (n==RTC_TIMETYPE_YEAR))

/* Macro check RTC calibration type */
#define PARAM_RTC_CALIB_DIR(n)  ((n==RTC_CALIB_DIR_FORWARD) || (n==RTC_CALIB_DIR_BACKWARD))

/* Macro check RTC GPREG type */
#define PARAM_RTC_GPREG_CH(n)   ((n>=0) && (n<=4))

/* Public Types --------------------------------------------------------------- */
typedef struct {
    uint32_t SEC;       
    uint32_t MIN;       
    uint32_t HOUR;      
    uint32_t DOM;       
    uint32_t DOW;       
    uint32_t DOY;       
    uint32_t MONTH;     
    uint32_t YEAR;      
} RTC_TIME_Type;

typedef enum {
    RTC_INT_COUNTER_INCREASE = RTC_IRL_RTCCIF,  
    RTC_INT_ALARM = RTC_IRL_RTCALF,                 
} RTC_INT_OPT;


typedef enum {
    RTC_TIMETYPE_SECOND = 0,        
    RTC_TIMETYPE_MINUTE = 1,        
    RTC_TIMETYPE_HOUR = 2,          
    RTC_TIMETYPE_DAYOFWEEK = 3,     
    RTC_TIMETYPE_DAYOFMONTH = 4,    
    RTC_TIMETYPE_DAYOFYEAR = 5,     
    RTC_TIMETYPE_MONTH = 6,         
    RTC_TIMETYPE_YEAR = 7,          
} RTC_TIMETYPE_Num;

/* Public Functions ----------------------------------------------------------- */
void RTC_Init (LPC_RTC_TypeDef *RTCx);
void RTC_DeInit(LPC_RTC_TypeDef *RTCx);
void RTC_ResetClockTickCounter(LPC_RTC_TypeDef *RTCx);
void RTC_Cmd (LPC_RTC_TypeDef *RTCx, FunctionalState NewState);
void RTC_CntIncrIntConfig (LPC_RTC_TypeDef *RTCx, uint32_t CntIncrIntType, \
                                FunctionalState NewState);
void RTC_AlarmIntConfig (LPC_RTC_TypeDef *RTCx, uint32_t AlarmTimeType, \
                                FunctionalState NewState);
void RTC_SetTime (LPC_RTC_TypeDef *RTCx, uint32_t Timetype, uint32_t TimeValue);
uint32_t RTC_GetTime(LPC_RTC_TypeDef *RTCx, uint32_t Timetype);
void RTC_SetFullTime (LPC_RTC_TypeDef *RTCx, RTC_TIME_Type *pFullTime);
void RTC_GetFullTime (LPC_RTC_TypeDef *RTCx, RTC_TIME_Type *pFullTime);
void RTC_SetAlarmTime (LPC_RTC_TypeDef *RTCx, uint32_t Timetype, uint32_t ALValue);
uint32_t RTC_GetAlarmTime (LPC_RTC_TypeDef *RTCx, uint32_t Timetype);
void RTC_SetFullAlarmTime (LPC_RTC_TypeDef *RTCx, RTC_TIME_Type *pFullTime);
void RTC_GetFullAlarmTime (LPC_RTC_TypeDef *RTCx, RTC_TIME_Type *pFullTime);
IntStatus RTC_GetIntPending (LPC_RTC_TypeDef *RTCx, uint32_t IntType);
void RTC_ClearIntPending (LPC_RTC_TypeDef *RTCx, uint32_t IntType);
void RTC_CalibCounterCmd(LPC_RTC_TypeDef *RTCx, FunctionalState NewState);
void RTC_CalibConfig(LPC_RTC_TypeDef *RTCx, uint32_t CalibValue, uint8_t CalibDir);
void RTC_WriteGPREG (LPC_RTC_TypeDef *RTCx, uint8_t Channel, uint32_t Value);
uint32_t RTC_ReadGPREG (LPC_RTC_TypeDef *RTCx, uint8_t Channel);

#ifdef __cplusplus
}
#endif

#endif /* LPC17XX_RTC_H_ */

/* --------------------------------- End Of File ------------------------------ */