csl_rtc.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 25-Sep-2008 Created
 * 04-May-2009 Added RTC_setCompensation API for C5505 PG1.4
 * 25-May-2009 Modified based on the review comments
 * ============================================================================
 */

#ifndef _CSL_RTC_H_
#define _CSL_RTC_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "cslr.h"
#include "csl_error.h"
#include "csl_types.h"
#include "soc.h"
#include "csl_general.h"

/*****************************************************************************\
          RTC global macro declarations
\*****************************************************************************/

#define CSL_RTC_BIT_SET                 (1u)

#define CSL_RTC_BIT_RESET               (0)

#define CSL_RTC_WAIT_CYCLE              (50u)

#define CSL_RTC_SCRATCH1_MASK           (0x8000u)

#define CSL_RTC_STATUS_MASK             (0x803Fu)

#define CSL_RTC_DISPATCH_TABLE_SIZE     (0x07u)

#define CSL_RTC_COMPENSATION_MAX        (1024u)

#define CSL_RTC_TIME_OUT                (0x1FFu)

/**************************************************************************\
* RTC global typedef declarations                                         *
\**************************************************************************/

typedef enum
{
    CSL_RTC_DAY_PERIODIC_INTERRUPT,   /* day periodic Interrupt enable */
    CSL_RTC_HR_PERIODIC_INTERRUPT,    /* hour periodic Interrupt enable */
    CSL_RTC_MINS_PERIODIC_INTERRUPT,  /* minute periodic Interrupt enable */
    CSL_RTC_SEC_PERIODIC_INTERRUPT,   /* second periodic Interrupt enable */
    CSL_RTC_MS_PERIODIC_INTERRUPT  /* milli second periodic Interrupt enable*/
} CSL_RTCPeriodicInterruptType;

typedef enum
{
    CSL_RTC_MSEVENT_INTERRUPT,     /* milli second int enable      */
    CSL_RTC_SECEVENT_INTERRUPT,    /* second event int enable      */
    CSL_RTC_MINSEVENT_INTERRUPT,   /* minute event int enable      */
    CSL_RTC_HREVENT_INTERRUPT,     /* hour event int enable        */
    CSL_RTC_DAYEVENT_INTERRUPT,    /* day event int enable         */
    CSL_RTC_EXTEVENT_INTERRUPT,    /* external event int enable    */
    CSL_RTC_ALARM_INTERRUPT,       /* alarm int enable             */
    CSL_RTC_INTERRUPT_NONE         /*  No interrupt enable         */
} CSL_RTCEventType;

typedef enum
{
    CSL_RTC_COMPENSATION_NEGATIVE = 0,   /* Negative drift in the msec value */
    CSL_RTC_COMPENSATION_POSITIVE,       /* Positive drift in the msec value */
    CSL_RTC_COMPENSATION_INVALID         /* Invalid value for error checking */
} CSL_RTCCompType;

typedef struct {
    Uint16 rtcmSec;  
    Uint16 rtcsec;   
    Uint16 rtcmin;   
    Uint16 rtchour;  
    Uint16 rtcday;   
    Uint16 rtcmonth; 
    Uint16 rtcyear;  
    Uint16 rtcmSeca; 
    Uint16 rtcseca;  
    Uint16 rtcmina;  
    Uint16 rtchoura; 
    Uint16 rtcdaya;  
    Uint16 rtcmontha;
    Uint16 rtcyeara; 
    Uint16 rtcintcr; 
} CSL_RtcConfig;

typedef struct
{
    Uint16 year;  
    Uint16 month; 
    Uint16 day;   
} CSL_RtcDate;

typedef struct {
    Uint16 hours; 
    Uint16 mins;  
    Uint16 secs;  
    Uint16 mSecs; 
} CSL_RtcTime;

typedef struct {
    Uint16 year;   
    Uint16 month;  
    Uint16 day;    
    Uint16 hours;  
    Uint16 mins;   
    Uint16 secs;   
    Uint16 mSecs;  
} CSL_RtcAlarm;

typedef struct
{
    void (*MilEvtAddr)(void);     
    void (*SecEvtAddr)(void);     
    void (*MinEvtAddr)(void);     
    void (*HourEvtAddr)(void);    
    void (*DayEvtAddr)(void);     
    void (*ExtEvtAddr)(void);     
    void (*AlarmEvtAddr)(void);   
} CSL_RtcIsrAddr;

typedef void (* CSL_RTCCallBackPtr)(void);

typedef struct {
   CSL_RTCCallBackPtr isr[CSL_RTC_DISPATCH_TABLE_SIZE];
} CSL_RtcIsrDispatchTable;

/******************************************************************************
 * CSL RTC Inline function
 *****************************************************************************/
static inline
Uint16 rtcDivFun(
          Uint16 dividend,
          Uint16 divisor  )
{
    Uint16 quoitient;

    quoitient = 0;
    while (dividend >= divisor)
    {
        quoitient++;
        dividend = dividend - divisor;
    }
    return quoitient;
}

static inline
Uint16 rtcModuloDivFun(
          Uint16 dividend,
          Uint16 divisor  )
{
    while (dividend >= divisor)
    {
        dividend = dividend - divisor;
    }
    return dividend;
}
static inline
Uint16 rtc_pow(
           Uint16  var,
           Uint16  pow )
{
    Uint16 result;
    Uint16 looper;

    result = 1;
    for (looper = 0 ; looper < pow; looper++)
    {
        result  = result * var;
    }
    return result;
}

/******************************************************************************
 * RTC function declarations
 *****************************************************************************/
void RTC_reset(void);

void RTC_start(void);

void RTC_stop(void);

CSL_Status RTC_config (
               CSL_RtcConfig    *pConfig);

CSL_Status RTC_getConfig (
               CSL_RtcConfig    *pGetConfig);

CSL_Status RTC_setTime (
               CSL_RtcTime    *pRtcTime);

CSL_Status RTC_getTime (
                  CSL_RtcTime     *pGetRtcTime);

CSL_Status RTC_setDate (
               CSL_RtcDate    *pRtcDate);

CSL_Status RTC_getDate (
                  CSL_RtcDate     *pGetRtcDate);

CSL_Status RTC_setAlarm (
               CSL_RtcAlarm    *pRtcAlarm);

CSL_Status RTC_setPeriodicInterval (
               CSL_RTCPeriodicInterruptType    periodicInterruptType);

CSL_Status RTC_eventEnable (
               CSL_RTCEventType    rtcEvent);

CSL_Status RTC_eventDisable (
               CSL_RTCEventType    rtcEvent);

CSL_RTCEventType RTC_getEventId(void);

Uint16 RTC_decToBcd (
               Uint16    decVal);

Uint16 RTC_bcdToDec (
               Uint16    hexVal);

CSL_Status RTC_setCallback(
               CSL_RtcIsrDispatchTable      *rtcDispatchTable,
               CSL_RtcIsrAddr                *isrAddr           );

CSL_Status RTC_setCompensation(CSL_RTCCompType    compType,
                               Uint16             compVal);


#ifdef __cplusplus
}
#endif
#endif /* _CSL_RTC_H_ */