179 lines
5.2 KiB
C
179 lines
5.2 KiB
C
/*
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
|
2011 Giovanni Di Sirio.
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
ChibiOS/RT is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
ChibiOS/RT is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @file STM32/RTCv1/rtc_lld.h
|
|
* @brief STM32F1xx RTC subsystem low level driver header.
|
|
*
|
|
* @addtogroup RTC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _RTC_LLD_H_
|
|
#define _RTC_LLD_H_
|
|
|
|
#if HAL_USE_RTC || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief This RTC implementation supports callbacks.
|
|
*/
|
|
#define RTC_SUPPORTS_CALLBACKS TRUE
|
|
|
|
/**
|
|
* @brief One alarm comparator available.
|
|
*/
|
|
#define RTC_ALARMS 1
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if HAL_USE_RTC && !STM32_HAS_RTC
|
|
#error "RTC not present in the selected device"
|
|
#endif
|
|
|
|
#if !(STM32_RTC == STM32_RTC_LSE) && !(STM32_RTC == STM32_RTC_LSI) && \
|
|
!(STM32_RTC == STM32_RTC_HSE)
|
|
#error "invalid source selected for RTC clock"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Type of a structure representing an RTC alarm time stamp.
|
|
*/
|
|
typedef struct RTCAlarm RTCAlarm;
|
|
|
|
/**
|
|
* @brief Type of a structure representing an RTC callbacks config.
|
|
*/
|
|
typedef struct RTCCallbackConfig RTCCallbackConfig;
|
|
|
|
/**
|
|
* @brief Type of an RTC alarm.
|
|
* @details Meaningful on platforms with more than 1 alarm comparator.
|
|
*/
|
|
typedef uint32_t rtcalarm_t;
|
|
|
|
/**
|
|
* @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 Structure representing an RTC callbacks config.
|
|
*/
|
|
struct RTCCallbackConfig{
|
|
#if RTC_SUPPORTS_CALLBACKS
|
|
/**
|
|
* @brief Generic RTC callback pointer.
|
|
*/
|
|
rtccb_t rtc_cb;
|
|
#endif /* RTC_SUPPORTS_CALLBACKS */
|
|
};
|
|
|
|
/**
|
|
* @brief Structure representing an RTC time stamp.
|
|
*/
|
|
struct RTCTime {
|
|
/**
|
|
* @brief Seconds since UNIX epoch.
|
|
*/
|
|
uint32_t tv_sec;
|
|
/**
|
|
* @brief Fractional part.
|
|
*/
|
|
uint32_t tv_msec;
|
|
};
|
|
|
|
/**
|
|
* @brief Structure representing an RTC alarm time stamp.
|
|
*/
|
|
struct RTCAlarm {
|
|
/**
|
|
* @brief Seconds since UNIX epoch.
|
|
*/
|
|
uint32_t tv_sec;
|
|
};
|
|
|
|
/**
|
|
* @brief Structure representing an RTC driver.
|
|
*/
|
|
struct RTCDriver{
|
|
/**
|
|
* @brief Callback pointer.
|
|
*/
|
|
rtccb_t rtc_cb;
|
|
};
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if !defined(__DOXYGEN__)
|
|
extern RTCDriver RTCD1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void rtc_lld_init(void);
|
|
void rtc_lld_set_time(RTCDriver *rtcp, const RTCTime *timespec);
|
|
void rtc_lld_get_time(RTCDriver *rtcp, RTCTime *timespec);
|
|
void rtc_lld_set_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm,
|
|
const RTCAlarm *alarmspec);
|
|
void rtc_lld_get_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm,
|
|
RTCAlarm *alarmspec);
|
|
void rtc_lld_set_callback(RTCDriver *rtcp, RTCCallbackConfig *cb_cfg);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_RTC */
|
|
|
|
#endif /* _RTC_LLD_H_ */
|
|
|
|
/** @} */
|