hpm_rtc_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2024 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
#ifndef HPM_RTC_DRV_H
#define HPM_RTC_DRV_H
 
#include "hpm_common.h"
#include "hpm_rtc_regs.h"
#ifndef __ICCRISCV__
#include <sys/time.h>
#endif
#include <time.h>
 
typedef struct {
    uint16_t index;         
    uint16_t type;          
    time_t period;          
} rtc_alarm_config_t;
 
#define RTC_ALARM_TYPE_ONE_SHOT (0U) 
#define RTC_ALARM_TYPE_PERIODIC (1U) 
#define RTC_ALARM_TYPE_ABSOLUTE_TIME_ONE_SHOT (2U) 
#define ALARM_PERIOD_ONE_SEC  (1UL)                             
#define ALARM_PERIOD_ONE_MIN  (60UL)                            
#define ALARM_PERIOD_ONE_HOUR (3600U)                           
#define ALARM_PERIOD_ONE_DAY  (ALARM_PERIOD_ONE_HOUR * 24UL)    
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_stat_t rtc_config_time(RTC_Type *base, time_t time);
 
hpm_stat_t rtc_config_alarm(RTC_Type *base, rtc_alarm_config_t *config);
 
time_t rtc_get_time(RTC_Type *base);
 
 
struct timeval rtc_get_timeval(RTC_Type *base);
 
static inline void rtc_enable_alarm_interrupt(RTC_Type *base, uint32_t index, bool enable)
{
    if (index > 1) {
        return;
    }
 
    uint32_t mask = (index == 0U) ? RTC_ALARM_EN_ENABLE0_MASK : RTC_ALARM_EN_ENABLE1_MASK;
 
    if (enable) {
        base->ALARM_EN |= mask;
    } else {
        base->ALARM_EN &= ~mask;
    }
}
 
static inline void rtc_clear_alarm_flag(RTC_Type *base, uint32_t index)
{
    if (index > 1) {
        return;
    }
    uint32_t mask = (index == 0U) ? RTC_ALARM_FLAG_ALARM0_MASK : RTC_ALARM_FLAG_ALARM1_MASK;
 
    base->ALARM_FLAG = mask;
}
 
static inline void rtc_clear_alarm_flags(RTC_Type *base, uint32_t masks)
{
    base->ALARM_FLAG = masks;
}
 
static inline bool rtc_is_alarm_flag_asserted(RTC_Type *base, uint32_t index)
{
    if (index > 1) {
        return false;
    }
    uint32_t mask = (index == 0U) ? RTC_ALARM_FLAG_ALARM0_MASK : RTC_ALARM_FLAG_ALARM1_MASK;
 
    return IS_HPM_BITMASK_SET(base->ALARM_FLAG, mask);
}
 
static inline uint32_t rtc_get_alarm_flags(RTC_Type *base)
{
    return base->ALARM_FLAG;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* HPM_RTC_DRV_H */