aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/rtc.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/rtc.h')
-rw-r--r--os/hal/include/rtc.h104
1 files changed, 104 insertions, 0 deletions
diff --git a/os/hal/include/rtc.h b/os/hal/include/rtc.h
new file mode 100644
index 000000000..1264c5bd8
--- /dev/null
+++ b/os/hal/include/rtc.h
@@ -0,0 +1,104 @@
+/*
+ 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 rtc.h
+ * @brief RTC Driver macros and structures.
+ *
+ * @addtogroup RTC
+ * @{
+ */
+
+#ifndef _RTC_H_
+#define _RTC_H_
+
+#if HAL_USE_RTC || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/**
+ * @name Date/Time bit masks
+ * @{
+ */
+#define RTC_TIME_SECONDS_MASK 0x0000001F /* @brief Seconds mask. */
+#define RTC_TIME_MINUTES_MASK 0x000007E0 /* @brief Minutes mask. */
+#define RTC_TIME_HOURS_MASK 0x0000F800 /* @brief Hours mask. */
+#define RTC_DATE_DAYS_MASK 0x001F0000 /* @brief Days mask. */
+#define RTC_DATE_MONTHS_MASK 0x01E00000 /* @brief Months mask. */
+#define RTC_DATE_YEARS_MASK 0xFE000000 /* @brief Years mask. */
+/** @} */
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Type of a structure representing an RTC driver.
+ */
+typedef struct RTCDriver RTCDriver;
+
+/**
+ * @brief Type of a structure representing an RTC time stamp.
+ */
+typedef struct RTCTime RTCTime;
+
+#include "rtc_lld.h"
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void rtcInit(void);
+ void rtcSetTime(RTCDriver *rtcp, const RTCTime *timespec);
+ void rtcGetTime(RTCDriver *rtcp, RTCTime *timespec);
+#if RTC_ALARMS > 0
+ void rtcSetAlarm(RTCDriver *rtcp,
+ rtcalarm_t alarm,
+ const RTCAlarm *alarmspec);
+ void rtcGetAlarm(RTCDriver *rtcp, rtcalarm_t alarm, RTCAlarm *alarmspec);
+#endif
+#if RTC_SUPPORTS_CALLBACKS
+ void rtcSetCallback(RTCDriver *rtcp, rtccb_t callback);
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_RTC */
+#endif /* _RTC_H_ */
+
+/** @} */