155 lines
4.9 KiB
C
155 lines
4.9 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.h
|
|
* @brief GD32 RTC subsystem low level driver header.
|
|
*
|
|
* @addtogroup RTC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_RTC_LLD_H
|
|
#define HAL_RTC_LLD_H
|
|
|
|
#if HAL_USE_RTC || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Implementation capabilities
|
|
*/
|
|
/**
|
|
* @brief This RTC implementation supports callbacks.
|
|
*/
|
|
#define RTC_SUPPORTS_CALLBACKS TRUE
|
|
|
|
/**
|
|
* @brief One alarm comparator available.
|
|
*/
|
|
#define RTC_ALARMS 1
|
|
|
|
/**
|
|
* @brief Presence of a local persistent storage.
|
|
*/
|
|
#define RTC_HAS_STORAGE FALSE
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Configuration options
|
|
* @{
|
|
*/
|
|
/*
|
|
* RTC driver system settings.
|
|
*/
|
|
#define GD32_RTC_IRQ_PRIORITY 15
|
|
#define GD32_RTC_IRQ_TRIGGER ECLIC_TRIGGER_DEFAULT
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if HAL_USE_RTC && !GD32_HAS_RTC
|
|
#error "RTC not present in the selected device"
|
|
#endif
|
|
|
|
#if GD32_RTCCLK == 0
|
|
#error "RTC clock not enabled"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Type of an RTC event.
|
|
*/
|
|
typedef enum {
|
|
RTC_EVENT_SECOND = 0, /** Triggered every second. */
|
|
RTC_EVENT_ALARM = 1, /** Triggered on alarm. */
|
|
RTC_EVENT_OVERFLOW = 2 /** Triggered on counter overflow. */
|
|
} rtcevent_t;
|
|
|
|
/**
|
|
* @brief Type of a generic RTC callback.
|
|
*/
|
|
typedef void (*rtccb_t)(RTCDriver *rtcp, rtcevent_t event);
|
|
|
|
/**
|
|
* @brief Type of a structure representing an RTC alarm time stamp.
|
|
*/
|
|
typedef struct hal_rtc_alarm {
|
|
/**
|
|
* @brief Seconds since UNIX epoch.
|
|
*/
|
|
uint32_t tv_sec;
|
|
} RTCAlarm;
|
|
|
|
/**
|
|
* @brief Implementation-specific @p RTCDriver fields.
|
|
*/
|
|
#define rtc_lld_driver_fields \
|
|
/* Pointer to the RTC registers block.*/ \
|
|
RTC_TypeDef *rtc; \
|
|
/* Callback pointer.*/ \
|
|
rtccb_t callback
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void rtc_lld_set_prescaler(void);
|
|
void rtc_lld_init(void);
|
|
void rtc_lld_set_time(RTCDriver *rtcp, const RTCDateTime *timespec);
|
|
void rtc_lld_get_time(RTCDriver *rtcp, RTCDateTime *timespec);
|
|
void rtc_lld_set_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm_number,
|
|
const RTCAlarm *alarmspec);
|
|
void rtc_lld_get_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm_number,
|
|
RTCAlarm *alarmspec);
|
|
void rtc_lld_set_callback(RTCDriver *rtcp, rtccb_t callback);
|
|
void rtcGD32GetSecMsec(RTCDriver *rtcp, uint32_t *tv_sec, uint32_t *tv_msec);
|
|
void rtcGD32SetSec(RTCDriver *rtcp, uint32_t tv_sec);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_RTC */
|
|
|
|
#endif /* HAL_RTC_LLD_H */
|
|
|
|
/** @} */
|