mcp7940.h

Go to the documentation of this file.

 
#ifndef MCP7940_H_
#define MCP7940_H_
    
    #ifndef MCP7940_HAL_PLATFORM
        #define MCP7940_HAL_PLATFORM avr0
    #endif
 
    #ifndef MCP7940_ADDRESS
        #define MCP7940_ADDRESS 0x6F
    #endif
 
    #ifndef MCP7940_USE_EXTOSC
        //#define MCP7940_USE_EXTOSC
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define MCP7940_USE_EXTOSC
        #endif
    #endif
 
    #ifndef MCP7940_BATTERY_BACKUP_EN
        //#define MCP7940_BATTERY_BACKUP_EN
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define MCP7940_BATTERY_BACKUP_EN
        #endif
    #endif
 
 
    #ifndef MCP7940_MFP_MODE
        #define MCP7940_MFP_MODE_OUTPUT      0x00
        #define MCP7940_MFP_MODE_SQUARE_WAVE 0x01
        #define MCP7940_MFP_MODE_ALARM       0x02

        #define MCP7940_MFP_MODE MCP7940_MFP_MODE_OUTPUT
    #endif
 
    #ifndef MCP7940_SQW_CRSTRIM_EN
        //#define MCP7940_SQW_CRSTRIM_EN
    #endif
 
    #ifndef MCP7940_CRSTRIM_EN
        #ifndef MCP7940_MFP_SQUARE_WAVE_PRESCALER
            #define MCP7940_MFP_SQUARE_WAVE_PRESCALER MCP7940_SQWFS_1HZ
        #endif
    #endif
 
    #ifndef MCP7940_MFP_ALARM_MODE
        #define MCP7940_MFP_ALARM_MODE_ALM0     (MCP7940_ALM0EN_bm)
        #define MCP7940_MFP_ALARM_MODE_ALM1     (MCP7940_ALM1EN_bm)
        #define MCP7940_MFP_ALARM_MODE_BOTH     (MCP7940_ALM1EN_bm | MCP7940_ALM0EN_bm)

        #define MCP7940_MFP_ALARM_MODE MCP7940_MFP_ALARM_MODE_BOTH
    #endif
 
    #define MCP7940_MFP_ALARM_POLARITY_NORMAL 0x00
    #define MCP7940_MFP_ALARM_POLARITY_INVERTED RTC_ALMPOL_bm
 
    #ifndef MCP7940_MFP_ALARM1_POLARITY

        #define MCP7940_MFP_ALARM1_POLARITY MCP7940_MFP_ALARM_POLARITY_NORMAL
    #endif
    
    #ifndef MCP7940_MFP_ALARM2_POLARITY

        #define MCP7940_MFP_ALARM2_POLARITY MCP7940_MFP_ALARM_POLARITY_NORMAL
    #endif
 
    #ifndef MCP7940_IO_TIMEOUT_MS
        #define MCP7940_IO_TIMEOUT_MS 1
    #endif
    
    #ifndef MCP7940_OSC_ENABLE_MS
        #define MCP7940_OSC_ENABLE_MS 1000UL
    #endif
    
    #ifndef MCP7940_RTCSEC
        #define MCP7940_RTCSEC 0x00
 
        #define MCP7940_ST_bm     0x80 
        #define MCP7940_SECTEN_bm 0x70 
        #define MCP7940_SECTEN_bp 4    
    #endif
 
    #ifndef MCP7940_RTCMIN
        #define MCP7940_RTCMIN 0x01
 
        #define MCP7940_MINTEN_bm 0x70 
        #define MCP7940_MINTEN_bp 4    
    #endif
 
    #ifndef MCP7940_RTCHOUR
        #define MCP7940_RTCHOUR 0x02
 
        #define MCP7940_FORMAT_bm 0x40 
        #define MCP7940_HRTEN_bm  0x30 
        #define MCP7940_HRTEN_bp  4    
    #endif
 
    #ifndef MCP7940_RTCWKDAY
        #define MCP7940_RTCWKDAY 0x03
 
        #define MCP7940_OSCRUN_bm  0x20 
        #define MCP7940_PWRFAIL_bm 0x10 
        #define MCP7940_VBATEN_bm  0x08 
        #define MCP7940_WKDAY_bp   0    
    #endif
 
    #ifndef MCP7940_RTCDATE
        #define MCP7940_RTCDATE 0x04
 
        #define MCP7940_DATETEN_bm 0x30 
        #define MCP7940_DATETEN_bp 4    
    #endif
 
    #ifndef MCP7940_RTCMTH
        #define MCP7940_RTCMTH 0x05
 
        #define MCP7940_LPYR_bm   0x20 
        #define MCP7940_MTHTEN_bm 0x10 
        #define MCP7940_LPYR_bp   5    
        #define MCP7940_MTHTEN_bp 4    
    #endif
 
    #ifndef MCP7940_RTCYEAR
        #define MCP7940_RTCYEAR 0x06
 
        #define MCP7940_YRTEN_bm 0xF0 
        #define MCP7940_YRTEN_bp 4    
    #endif
 
    #ifndef MCP7940_CONTROL
        #define MCP7940_CONTROL 0x07
 
        #define MCP7940_OUT_bm    0x80 
        #define MCP7940_SQWEN_bm  0x40 
        #define MCP7940_ALM1EN_bm 0x20 
        #define MCP7940_ALM0EN_bm 0x10 
        #define MCP7940_EXTOSC_bm 0x08 
        #define MCP7940_CSTRIM_bm 0x04 
        #define MCP7940_SQWFS1_bm 0x02 
        #define MCP7940_SQWFS0_bm 0x01 
 
        #define MCP7940_SQWFS_32768HZ (MCP7940_SQWFS1_bm | MCP7940_SQWFS0_bm)   
        #define MCP7940_SQWFS_8192HZ  MCP7940_SQWFS1_bm                             
        #define MCP7940_SQWFS_4096HZ  MCP7940_SQWFS0_bm                             
        #define MCP7940_SQWFS_1HZ     0x00                                              
    #endif
 
    #ifndef MCP7940_OSCTRIM
        #define MCP7940_OSCTRIM 0x08
 
        #define MCP7940_SIGN_bm 0x80 
    #endif
 
    // #############################################
 
    #ifndef MCP7940_WEEKDAY_bp
        #define MCP7940_WEEKDAY_MONDAY_gc    0x00 
        #define MCP7940_WEEKDAY_TUESDAY_gc   0x01 
        #define MCP7940_WEEKDAY_WEDNESDAY_gc 0x02 
        #define MCP7940_WEEKDAY_THURSDAY_gc  0x03 
        #define MCP7940_WEEKDAY_FRIDAY_gc    0x04 
        #define MCP7940_WEEKDAY_SATURDAY_gc  0x05 
        #define MCP7940_WEEKDAY_SUNDAY_gc    0x06 
    #endif
 
    #if !defined(MCP7940_ALM0SEC) && !defined(MCP7940_ALM1SEC)
        #define MCP7940_ALM_SECTEN_bp 4 
        #define MCP7940_ALM_SECONE_bp 0 

        #define MCP7940_ALM0SEC 0x0A

        #define MCP7940_ALM1SEC 0x11
    #endif
 
    #if !defined(MCP7940_ALM0MIN) && !defined(MCP7940_ALM1MIN)
        #define MCP7940_ALM_MINTEN_bp 4 
        #define MCP7940_ALM_MINONE_bp 0 

        #define MCP7940_ALM0MIN 0x0B

        #define MCP7940_ALM1MIN 0x12
    #endif
 
    #if !defined(MCP7940_ALM0HOUR) && !defined(MCP7940_ALM1HOUR)
        #define MCP7940_ALM_FORMAT_bm 0x40 
        #define MCP7940_ALM_HRTEN_bp  4    
        #define MCP7940_ALM_HRONE_bp  0    

        #define MCP7940_ALM0HOUR 0x0C

        #define MCP7940_ALM1HOUR 0x13
    #endif
 
    #if !defined(MCP7940_ALM0WKDAY) && !defined(MCP7940_ALM1WKDAY)
        #define MCP7940_ALARM_ALMPOL_bm  0x80   
        #define MCP7940_ALARM_ALMMSK2_bm 0x40   
        #define MCP7940_ALARM_ALMMSK1_bm 0x20   
        #define MCP7940_ALARM_ALMMSK0_bm 0x10   
        #define MCP7940_ALARM_ALMIF_bm   0x08   
 
        #define MCP7940_ALARM_WKDAY_bp   0    
 
        #define MCP7940_ALARM_ALMMSK_bp 4       
 
        #define MCP7940_ALARM_SECOND_MATCH_gc (0x00<<MCP7940_ALARM_ALMMSK_bp) 
        #define MCP7940_ALARM_MINUTE_MATCH    (0x01<<MCP7940_ALARM_ALMMSK_bp) 
        #define MCP7940_ALARM_HOUR_MATCH      (0x02<<MCP7940_ALARM_ALMMSK_bp) 
        #define MCP7940_ALARM_DAY_MATCH       (0x03<<MCP7940_ALARM_ALMMSK_bp) 
        #define MCP7940_ALARM_DATE_MATCH      (0x04<<MCP7940_ALARM_ALMMSK_bp) 
        #define MCP7940_ALARM_FULL_MATCH      (0x07<<MCP7940_ALARM_ALMMSK_bp) 

        #define MCP7940_ALM0WKDAY 0x0D

        #define MCP7940_ALM1WKDAY 0x14
    #endif
 
    #if !defined(MCP7940_ALM0DATE) && !defined(MCP7940_ALM1DATE)
        #define MCP7940_ALM_DATETEN_bp 4 
        #define MCP7940_ALM_DATEONE_bp 0 

        #define MCP7940_ALM0DATE 0x0E

        #define MCP7940_ALM1DATE 0x15
    #endif
 
    #if !defined(MCP7940_ALM0MTH) && !defined(MCP7940_ALM1MTH)
        #define MCP7940_ALM_MTHTEN_bp 4 
        #define MCP7940_ALM_MTHONE_bp 0 

        #define MCP7940_ALM0MTH 0x0F

        #define MCP7940_ALM1MTH 0x16
    #endif
 
    // #############################################
 
    #if !defined(MCP7940_PWRDNMIN) && !defined(MCP7940_PWRUPMIN)
        #define MCP7940_PWRDNMIN 0x18

        #define MCP7940_PWRUPMIN 0x1C
    #endif
 
    #if !defined(MCP7940_PWRDNHOUR) && !defined(MCP7940_PWRUPHOUR)
        #define MCP7940_PWRDNHOUR 0x19

        #define MCP7940_PWRUPHOUR 0x1D
    #endif
 
    #if !defined(MCP7940_PWRDNDATE) && !defined(MCP7940_PWRUPDATE)
        #define MCP7940_PWRDNDATE 0x1A

        #define MCP7940_PWRUPDATE 0x1E
    #endif
 
    #if !defined(MCP7940_PWRDNMTH) && !defined(MCP7940_PWRUPMTH)
        #define MCP7940_PWRWEEKDAY_bp 5 

        #define MCP7940_PWRDNMTH 0x1B

        #define MCP7940_PWRUPMTH 0x1F
    #endif
 
    #include "../../../core_types/format/time.h"
 
    #include "../../../utils/systick/systick.h"
    #include "../../../utils/time/validate.h"
    #include "../../../utils/macros/stringify.h"
 
    #include _STR(../../../hal/MCP7940_HAL_PLATFORM/twi/twi.h)
    
    enum MCP7940_Status_t
    {
        MCP7940_Status_None               = 0x00,               
        MCP7940_Status_Battery_Enabled    = MCP7940_VBATEN_bm,  
        MCP7940_Status_Power_Fail         = MCP7940_PWRFAIL_bm, 
        MCP7940_Status_Oscillator_Running = MCP7940_OSCRUN_bm   
    };
    
    typedef enum MCP7940_Status_t MCP7940_Status;

    enum MCP7940_Error_t
    {
        MCP7940_Error_None = 0, 
        MCP7940_Error_Fail      
    };

    typedef enum MCP7940_Error_t MCP7940_Error;

    enum MCP7940_Mode_t
    {
        MCP7940_Mode_Disable = 0, 
        MCP7940_Mode_Enable       
    };

    typedef enum MCP7940_Mode_t MCP7940_Mode;

    enum MCP7940_Trim_t
    {
        MCP7940_Trim_Substract = 0, 
        MCP7940_Trim_Add            
    };

    typedef enum MCP7940_Trim_t MCP7940_Trim;

    enum MCP7940_LeapYear_t
    {
        MCP7940_LeapYear_False = 0, 
        MCP7940_LeapYear_True       
    };

    typedef enum MCP7940_LeapYear_t MCP7940_LeapYear;

    enum MCP7940_Register_t
    {
        MCP7940_Register_Current_Time   = 0, 
        MCP7940_Register_Power_Down_Time,    
        MCP7940_Register_Power_Up_Time       
    };

    typedef enum MCP7940_Register_t MCP7940_Register;
 
 
                 void mcp7940_init(void);
        MCP7940_Error mcp7940_trimming(MCP7940_Trim mode, unsigned char value);
                 void mcp7940_oscillator(MCP7940_Mode mode);
       MCP7940_Status mcp7940_status(void);
 
    #if MCP7940_MFP_MODE == MCP7940_MFP_MODE_OUTPUT
                 void mcp7940_mfp_output(MCP7940_Mode output);
    #endif
 
          const char* mcp7940_weekday_string(unsigned char day);
        unsigned char mcp7940_weekday(MCP7940_Register data);
    
                 void mcp7940_time(FORMAT_Time *time, MCP7940_Register reg);
                 void mcp7940_date(FORMAT_Date *date, MCP7940_Register reg);
                 void mcp7940_datetime(FORMAT_DateTime *datetime, MCP7940_Register reg);
 
     MCP7940_LeapYear mcp7940_leapyear(void);
 
        MCP7940_Error mcp7940_setweekday(unsigned char weekday);
        MCP7940_Error mcp7940_settime(const FORMAT_Time *time);
        MCP7940_Error mcp7940_setdate(const FORMAT_Date *date);
        MCP7940_Error mcp7940_setdatetime(const FORMAT_DateTime *datetime);
 
#endif /* MCP7940_H_ */