449 lines
12 KiB
C
449 lines
12 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
|
|
ChibiOS - Copyright (C) 2021 Stefan Kerkmann
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
/*
|
|
Concepts and parts of this file have been contributed by Uladzimir Pylinsky
|
|
aka barthess.
|
|
*/
|
|
|
|
/**
|
|
* @file RTC/hal_rtc_lld.c
|
|
* @brief GD32 RTC subsystem low level driver header.
|
|
*
|
|
* @addtogroup RTC
|
|
* @{
|
|
*/
|
|
|
|
#include "hal.h"
|
|
|
|
#if HAL_USE_RTC || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver local definitions. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver exported variables. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief RTC driver identifier.
|
|
*/
|
|
RTCDriver RTCD1;
|
|
|
|
/*===========================================================================*/
|
|
/* Driver local variables and types. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver local functions. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Wait for synchronization of RTC registers with APB1 bus.
|
|
* @details This function must be invoked before trying to read RTC registers
|
|
* in the backup domain: DIV, CNT, ALR. CR registers can always
|
|
* be read.
|
|
*
|
|
* @notapi
|
|
*/
|
|
static void rtc_apb1_sync(void) {
|
|
|
|
while ((RTC->CTL & RTC_CTL_RSYNF) == 0)
|
|
;
|
|
}
|
|
|
|
/**
|
|
* @brief Wait for for previous write operation complete.
|
|
* @details This function must be invoked before writing to any RTC registers
|
|
*
|
|
* @notapi
|
|
*/
|
|
static void rtc_wait_write_completed(void) {
|
|
|
|
while ((RTC->CTL & RTC_CTL_LWOFF) == 0)
|
|
;
|
|
}
|
|
|
|
/**
|
|
* @brief Acquires write access to RTC registers.
|
|
* @details Before writing to the backup domain RTC registers the previous
|
|
* write operation must be completed. Use this function before
|
|
* writing to PRL, CNT, ALR registers.
|
|
*
|
|
* @notapi
|
|
*/
|
|
static void rtc_acquire_access(void) {
|
|
|
|
rtc_wait_write_completed();
|
|
RTC->CTL |= RTC_CTL_CMF;
|
|
}
|
|
|
|
/**
|
|
* @brief Releases write access to RTC registers.
|
|
*
|
|
* @notapi
|
|
*/
|
|
static void rtc_release_access(void) {
|
|
|
|
RTC->CTL &= ~RTC_CTL_CMF;
|
|
}
|
|
|
|
/**
|
|
* @brief Converts time from timespec to seconds counter.
|
|
*
|
|
* @param[in] timespec pointer to a @p RTCDateTime structure
|
|
* @return the TR register encoding.
|
|
*
|
|
* @notapi
|
|
*/
|
|
static time_t rtc_encode(const RTCDateTime *timespec) {
|
|
struct tm tim;
|
|
|
|
rtcConvertDateTimeToStructTm(timespec, &tim, NULL);
|
|
return mktime(&tim);
|
|
}
|
|
|
|
/**
|
|
* @brief Converts time from seconds/milliseconds to timespec.
|
|
*
|
|
* @param[in] tv_sec seconds value
|
|
* @param[in] tv_msec milliseconds value
|
|
* @param[out] timespec pointer to a @p RTCDateTime structure
|
|
*
|
|
* @notapi
|
|
*/
|
|
static void rtc_decode(uint32_t tv_sec,
|
|
uint32_t tv_msec,
|
|
RTCDateTime *timespec) {
|
|
struct tm tim;
|
|
struct tm *t;
|
|
const time_t time = (const time_t)tv_sec; /* Could be 64 bits.*/
|
|
|
|
/* If the conversion is successful the function returns a pointer
|
|
to the object the result was written into.*/
|
|
#if defined(__GNUC__) || defined(__CC_ARM)
|
|
t = localtime_r(&time, &tim);
|
|
osalDbgAssert(t != NULL, "conversion failed");
|
|
#else
|
|
t = localtime(&time);
|
|
memcpy(&tim, t, sizeof(struct tm));
|
|
#endif
|
|
|
|
rtcConvertStructTmToDateTime(&tim, tv_msec, timespec);
|
|
}
|
|
|
|
/*===========================================================================*/
|
|
/* Driver interrupt handlers. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief RTC interrupt handler.
|
|
*
|
|
* @isr
|
|
*/
|
|
OSAL_IRQ_HANDLER(GD32_RTC1_HANDLER) {
|
|
uint16_t flags;
|
|
|
|
OSAL_IRQ_PROLOGUE();
|
|
|
|
/* Code hits this wait only when AHB1 bus was previously powered off by any
|
|
reason (standby, reset, etc). In other cases there is no waiting.*/
|
|
rtc_apb1_sync();
|
|
|
|
/* Mask of all enabled and pending sources.*/
|
|
flags = RTCD1.rtc->INTEN & RTCD1.rtc->CTL;
|
|
RTCD1.rtc->CTL &= ~(RTC_CTL_SCIF | RTC_CTL_ALRMIF | RTC_CTL_OVIF);
|
|
|
|
if (flags & RTC_CTL_SCIF)
|
|
RTCD1.callback(&RTCD1, RTC_EVENT_SECOND);
|
|
|
|
if (flags & RTC_CTL_ALRMIF)
|
|
RTCD1.callback(&RTCD1, RTC_EVENT_ALARM);
|
|
|
|
if (flags & RTC_CTL_OVIF)
|
|
RTCD1.callback(&RTCD1, RTC_EVENT_OVERFLOW);
|
|
|
|
OSAL_IRQ_EPILOGUE();
|
|
}
|
|
|
|
/*===========================================================================*/
|
|
/* Driver exported functions. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Load value of RTCCLK to prescaler registers.
|
|
* @note The pre-scaler must not be set on every reset as RTC clock
|
|
* counts are lost when it is set.
|
|
* @note This function designed to be called from
|
|
* hal_lld_backup_domain_init(). Because there is only place
|
|
* where possible to detect BKP domain reset event reliably.
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_set_prescaler(void) {
|
|
syssts_t sts;
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
rtc_acquire_access();
|
|
RTC->PSCH = (uint16_t)((GD32_RTCCLK - 1) >> 16) & 0x000F;
|
|
RTC->PSCL = (uint16_t)(((GD32_RTCCLK - 1)) & 0xFFFF);
|
|
rtc_release_access();
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
}
|
|
|
|
/**
|
|
* @brief Initialize RTC.
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_init(void) {
|
|
|
|
/* RTC object initialization.*/
|
|
rtcObjectInit(&RTCD1);
|
|
|
|
/* RTC pointer initialization.*/
|
|
RTCD1.rtc = RTC;
|
|
|
|
/* RSF bit must be cleared by software after an APB1 reset or an APB1 clock
|
|
stop. Otherwise its value will not be actual. */
|
|
RTCD1.rtc->CTL &= ~RTC_CTL_RSYNF;
|
|
|
|
/* Required because access to PRL.*/
|
|
rtc_apb1_sync();
|
|
|
|
/* All interrupts initially disabled.*/
|
|
rtc_wait_write_completed();
|
|
RTCD1.rtc->INTEN = 0;
|
|
|
|
/* Callback initially disabled.*/
|
|
RTCD1.callback = NULL;
|
|
|
|
/* IRQ vector permanently assigned to this driver.*/
|
|
eclicEnableVector(GD32_RTC1_NUMBER, GD32_RTC_IRQ_PRIORITY, GD32_RTC_IRQ_TRIGGER);
|
|
}
|
|
|
|
/**
|
|
* @brief Set current time.
|
|
* @note Fractional part will be silently ignored. There is no possibility
|
|
* to change it on GD32F1xx platform.
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] timespec pointer to a @p RTCDateTime structure
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_set_time(RTCDriver *rtcp, const RTCDateTime *timespec) {
|
|
time_t tv_sec = rtc_encode(timespec);
|
|
|
|
rtcGD32SetSec(rtcp, tv_sec);
|
|
}
|
|
|
|
/**
|
|
* @brief Get current time.
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] timespec pointer to a @p RTCDateTime structure
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_get_time(RTCDriver *rtcp, RTCDateTime *timespec) {
|
|
uint32_t tv_sec, tv_msec;
|
|
|
|
rtcGD32GetSecMsec(rtcp, &tv_sec, &tv_msec);
|
|
rtc_decode(tv_sec, tv_msec, timespec);
|
|
}
|
|
|
|
/**
|
|
* @brief Set alarm time.
|
|
*
|
|
* @note Default value after BKP domain reset is 0xFFFFFFFF
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] alarm alarm identifier
|
|
* @param[in] alarmspec pointer to a @p RTCAlarm structure
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_set_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm_number,
|
|
const RTCAlarm *alarmspec) {
|
|
syssts_t sts;
|
|
(void)alarm_number;
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
rtc_acquire_access();
|
|
if (alarmspec != NULL) {
|
|
rtcp->rtc->ALRMH = (uint16_t)(alarmspec->tv_sec >> 16);
|
|
rtcp->rtc->ALRML = (uint16_t)(alarmspec->tv_sec & 0xFFFF);
|
|
}
|
|
else {
|
|
rtcp->rtc->ALRMH = 0;
|
|
rtcp->rtc->ALRML = 0;
|
|
}
|
|
rtc_release_access();
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
}
|
|
|
|
/**
|
|
* @brief Get current alarm.
|
|
* @note If an alarm has not been set then the returned alarm specification
|
|
* is not meaningful.
|
|
* @note The function can be called from any context.
|
|
* @note Default value after BKP domain reset is 0xFFFFFFFF.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] alarm alarm identifier
|
|
* @param[out] alarmspec pointer to a @p RTCAlarm structure
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_get_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm_number,
|
|
RTCAlarm *alarmspec) {
|
|
syssts_t sts;
|
|
(void)alarm_number;
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
/* Required because access to ALR.*/
|
|
rtc_apb1_sync();
|
|
|
|
alarmspec->tv_sec = ((rtcp->rtc->ALRMH << 16) + rtcp->rtc->ALRML);
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
}
|
|
|
|
/**
|
|
* @brief Enables or disables RTC callbacks.
|
|
* @details This function enables or disables callbacks, use a @p NULL pointer
|
|
* in order to disable a callback.
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] callback callback function pointer or @p NULL
|
|
*
|
|
* @notapi
|
|
*/
|
|
void rtc_lld_set_callback(RTCDriver *rtcp, rtccb_t callback) {
|
|
syssts_t sts;
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
if (callback != NULL) {
|
|
|
|
/* IRQ sources enabled only after setting up the callback.*/
|
|
rtcp->callback = callback;
|
|
|
|
rtc_wait_write_completed();
|
|
rtcp->rtc->CTL &= ~(RTC_CTL_OVIF | RTC_CTL_ALRMIF | RTC_CTL_SCIF);
|
|
rtcp->rtc->INTEN = RTC_INTEN_OVIE | RTC_INTEN_ALRMIE | RTC_INTEN_SCIE;
|
|
}
|
|
else {
|
|
rtc_wait_write_completed();
|
|
rtcp->rtc->INTEN = 0;
|
|
|
|
/* Callback set to NULL only after disabling the IRQ sources.*/
|
|
rtcp->callback = NULL;
|
|
}
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
}
|
|
|
|
/**
|
|
* @brief Get seconds and (optionally) milliseconds from RTC.
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[out] tv_sec pointer to seconds value
|
|
* @param[out] tv_msec pointer to milliseconds value, set it
|
|
* to @p NULL if not needed
|
|
*
|
|
* @api
|
|
*/
|
|
void rtcGD32GetSecMsec(RTCDriver *rtcp, uint32_t *tv_sec, uint32_t *tv_msec) {
|
|
uint32_t time_frac;
|
|
syssts_t sts;
|
|
|
|
osalDbgCheck((NULL != tv_sec) && (NULL != rtcp));
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
/* Required because access to CNT and DIV.*/
|
|
rtc_apb1_sync();
|
|
|
|
/* wait for previous write accesses to complete.*/
|
|
rtc_wait_write_completed();
|
|
|
|
/* Loops until two consecutive read returning the same value.*/
|
|
do {
|
|
*tv_sec = ((uint32_t)(rtcp->rtc->CNTH) << 16) + rtcp->rtc->CNTL;
|
|
time_frac = (((uint32_t)rtcp->rtc->DIVH) << 16) + (uint32_t)rtcp->rtc->DIVL;
|
|
} while ((*tv_sec) != (((uint32_t)(rtcp->rtc->CNTH) << 16) + rtcp->rtc->CNTL));
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
|
|
if (NULL != tv_msec)
|
|
*tv_msec = (((uint32_t)GD32_RTCCLK - 1 - time_frac) * 1000) / GD32_RTCCLK;
|
|
}
|
|
|
|
/**
|
|
* @brief Set seconds in RTC.
|
|
* @note The function can be called from any context.
|
|
*
|
|
* @param[in] rtcp pointer to RTC driver structure
|
|
* @param[in] tv_sec seconds value
|
|
*
|
|
* @api
|
|
*/
|
|
void rtcGD32SetSec(RTCDriver *rtcp, uint32_t tv_sec) {
|
|
syssts_t sts;
|
|
|
|
osalDbgCheck(NULL != rtcp);
|
|
|
|
/* Entering a reentrant critical zone.*/
|
|
sts = osalSysGetStatusAndLockX();
|
|
|
|
rtc_acquire_access();
|
|
rtcp->rtc->CNTH = (uint16_t)(tv_sec >> 16);
|
|
rtcp->rtc->CNTL = (uint16_t)(tv_sec & 0xFFFF);
|
|
rtc_release_access();
|
|
|
|
/* Leaving a reentrant critical zone.*/
|
|
osalSysRestoreStatusX(sts);
|
|
}
|
|
|
|
#endif /* HAL_USE_RTC */
|
|
|
|
/** @} */
|