diff options
| author | edolomb <none@example.com> | 2017-11-10 18:58:43 +0000 |
|---|---|---|
| committer | edolomb <none@example.com> | 2017-11-10 18:58:43 +0000 |
| commit | 715198c1d5a7159ae2092eea7aa1dbfd5ca94980 (patch) | |
| tree | 81a7c882ccb0fb0599cd74f82869e3cf87898fed /os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h | |
| parent | 681a0de4c1b5e1c63327b7b65e67a4dcf0e27132 (diff) | |
| download | ChibiOS-715198c1d5a7159ae2092eea7aa1dbfd5ca94980.tar.gz ChibiOS-715198c1d5a7159ae2092eea7aa1dbfd5ca94980.tar.bz2 ChibiOS-715198c1d5a7159ae2092eea7aa1dbfd5ca94980.zip | |
SAMA RTC driver
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10981 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h')
| -rw-r--r-- | os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h b/os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h new file mode 100644 index 000000000..a6ffaa9c9 --- /dev/null +++ b/os/hal/ports/SAMA/LLD/RTCv1/hal_rtc_lld.h @@ -0,0 +1,213 @@ +/*
+ ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
+
+ 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 RTCv1/hal_rtc_lld.h
+ * @brief SAMA RTC low level driver header.
+ *
+ * @addtogroup RTC
+ * @{
+ */
+
+#ifndef HAL_RTC_LLD_H
+#define HAL_RTC_LLD_H
+
+#if HAL_USE_RTC || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+#define SYSC_WPMR (0xF80480E4u)
+#define SYSC_WPMR_WPKEY_PASSWD (0x535943u << 8)
+#define SYSC_WPMR_WPEN (0x1u << 0)
+
+/**
+ * @name Implementation capabilities
+ */
+/**
+ * @brief Number of available alarms.
+ */
+#define RTC_ALARMS 1
+
+/**
+ * @brief Presence of a local persistent storage.
+ */
+#define RTC_HAS_STORAGE FALSE
+
+/**
+ * @brief Callback supported.
+ */
+#define RTC_SUPPORTS_CALLBACKS TRUE
+/** @} */
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name Configuration options
+ * @{
+ */
+/*
+ * RTC driver system settings.
+ */
+#define SAMA_RTC_IRQ_PRIORITY 7
+/** @} */
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief FileStream specific methods.
+ */
+#define _rtc_driver_methods \
+ _file_stream_methods
+
+/**
+ * @brief Type of an RTC alarm number.
+ */
+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. */
+} 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 {
+ /**
+ * @brief Type of an alarm as encoded in RTC registers.
+ */
+ uint32_t timralrm;
+ uint32_t calralrm;
+} RTCAlarm;
+
+#if RTC_HAS_STORAGE || defined(__DOXYGEN__)
+/**
+ * @extends FileStream
+ *
+ * @brief @p RTCDriver virtual methods table.
+ */
+struct RTCDriverVMT {
+ _rtc_driver_methods
+};
+#endif
+
+/**
+ * @brief Structure representing an RTC driver.
+ */
+struct RTCDriver {
+#if RTC_HAS_STORAGE || defined(__DOXYGEN__)
+ /**
+ * @brief Virtual Methods Table.
+ */
+ const struct RTCDriverVMT *vmt;
+#endif
+ /* End of the mandatory fields.*/
+ /**
+ * @brief Pointer to the RTC registers block.
+ */
+ Rtc *rtc;
+ /**
+ * @brief Callback pointer.
+ */
+ rtccb_t callback;
+};
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+/**
+ * @brief Enable write protection on SYSC registers block.
+ *
+ * @notapi
+ */
+#define syscEnableWP() { \
+ *(uint32_t *)(SYSC_WPMR) = SYSC_WPMR_WPKEY_PASSWD | SYSC_WPMR_WPEN; \
+}
+
+/**
+ * @brief Disable write protection on SYSC registers block.
+ *
+ * @notapi
+ */
+#define syscDisableWP() { \
+ *(uint32_t *)(SYSC_WPMR) = SYSC_WPMR_WPKEY_PASSWD; \
+}
+
+/**
+ * @brief Configure RTC_MR register.
+ *
+ * @param[in] rtcp pointer to RTC driver structure
+ * @param[in] value value to be written in the MR register
+ *
+ */
+#define rtcConfigureMode(rtcp, value) { \
+ (rtcp)->rtc->RTC_MR = value; \
+}
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#if !defined(__DOXYGEN__)
+extern RTCDriver RTCD0;
+#if RTC_HAS_STORAGE
+extern struct RTCDriverVMT _rtc_lld_vmt;
+#endif
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ 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,
+ const RTCAlarm *alarmspec);
+ void rtc_lld_get_alarm(RTCDriver *rtcp,
+ rtcalarm_t alarm,
+ RTCAlarm *alarmspec);
+ void rtc_lld_set_callback(RTCDriver *rtcp, rtccb_t callback);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_RTC */
+
+#endif /* HAL_RTC_LLD_H */
+
+/** @} */
|