rtc.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef SRC_RTC_H_
#define SRC_RTC_H_

 
#include "i2c/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                    */
/* ========================================================================== */


 
        
    typedef enum {
        RTC_OK          = 0,    
        RTC_ERR         = 1,    
        RTC_USER_ERR    = 2,    
        RTC_SKIP        = 3,    
    } rtc_status_t;
 // End of RTC_ENUM group
 
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */

    typedef struct rtc_instance rtc_instance_t;

    typedef struct {
        u8 seconds;         
        u8 minutes;         
        u8 hours;           
        u8 PM;              
        u8 timesystem;      
        u8 weekdays;        
        u8 days;            
        u8 months;          
        u8 years;           
    }rtc_data_t;

    typedef struct {
        rtc_status_t (*applyConfig) (rtc_instance_t *rtc);              
        rtc_status_t (*enableErrorInterrupt)(rtc_instance_t *rtc);      
        rtc_status_t (*getTime)(rtc_instance_t *rtc);                   
        rtc_status_t (*setTime)(rtc_instance_t *rtc);                   
        rtc_status_t (*setTimeSystem)(rtc_instance_t *rtc, u8 mode);    
    }rtc_api_t;

    struct rtc_instance {
        i2c_instance_t  *inst;          
        const rtc_api_t *drv;           
        rtc_data_t      current_time;   
    };
 // End of RTC_Types group
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */

    rtc_status_t rtc_applyConfig(rtc_instance_t *rtc);
    rtc_status_t rtc_enableErrorInterrupt(rtc_instance_t *rtc);
    u8 convert_hour_register(u8 old_reg_val, u8 to_12h);
        static inline u8 bcd2bin(u8 val) { return (val & 0x0F) + ((val >> 4) * 10); }
        static inline u8 bin2bcd(u8 val) { return ((val / 10) << 4) + (val % 10); } // End of RTC Internal Functions group

        extern const char* Day_ordinal [];
        extern const char* const DayStrings[];
        extern const char* const MonthStrings[];
        extern const char* const  meridiem[];
        extern const char* get_ordinal(u8 day); // End of RTC Public API - String Based Functions group
 // End of RTC_Funcs group
 
/* ========================================================================== */
/* SUB-GROUP: RTC CONFIGURATION                                               */
/* ========================================================================== */

    #include "rtc/rtc_config.h"
 
#ifdef __cplusplus
 
}
#endif // End of MAIN RTC Group
 
#endif /* SRC_RTC_H_ */