RTC. Initial commit.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/rtc_dev@3586 35acf78f-673a-0410-8e92-d51de3d6d3f4

3 files changed, 484 insertions, 2 deletions

diff --git a/os/hal/platforms/STM32F4xx/platform.mk b/os/hal/platforms/STM32F4xx/platform.mk
index 449b40731..ce6f7bf57 100644
--- a/os/hal/platforms/STM32F4xx/platform.mk
+++ b/os/hal/platforms/STM32F4xx/platform.mk
@@ -2,6 +2,7 @@
 PLATFORMSRC = ${CHIBIOS}/os/hal/platforms/STM32F4xx/stm32_dma.c \

               ${CHIBIOS}/os/hal/platforms/STM32F4xx/hal_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32F4xx/adc_lld.c \

+              ${CHIBIOS}/os/hal/platforms/STM32F4xx/rtc_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32/ext_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32/gpt_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32/icu_lld.c \

@@ -10,9 +11,11 @@ PLATFORMSRC = ${CHIBIOS}/os/hal/platforms/STM32F4xx/stm32_dma.c \
               ${CHIBIOS}/os/hal/platforms/STM32/spi_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32/uart_lld.c \

               ${CHIBIOS}/os/hal/platforms/STM32/i2c_lld.c \

-              ${CHIBIOS}/os/hal/platforms/STM32/GPIOv2/pal_lld.c

+              ${CHIBIOS}/os/hal/platforms/STM32/GPIOv2/pal_lld.c \

 

 # Required include directories

 PLATFORMINC = ${CHIBIOS}/os/hal/platforms/STM32F4xx \

               ${CHIBIOS}/os/hal/platforms/STM32 \

-              ${CHIBIOS}/os/hal/platforms/STM32/GPIOv2

+              ${CHIBIOS}/os/hal/platforms/STM32/GPIOv2 \

+

+

diff --git a/os/hal/platforms/STM32F4xx/rtc_lld.c b/os/hal/platforms/STM32F4xx/rtc_lld.c
new file mode 100644
index 000000000..cae23525f
--- /dev/null
+++ b/os/hal/platforms/STM32F4xx/rtc_lld.c
@@ -0,0 +1,319 @@
+/*

+    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.c

+ * @brief   STM32 RTC subsystem low level driver header.

+ *

+ * @addtogroup RTC

+ * @{

+ */

+

+#include "ch.h"

+#include "hal.h"

+

+#if HAL_USE_RTC || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver exported variables.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief RTC driver identifier.

+ */

+RTCDriver RTCD1;

+

+/*===========================================================================*/

+/* Driver local variables.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local functions.                                                   */

+/*===========================================================================*/

+

+/**

+ * @brief   Shared IRQ handler.

+ *

+ * @param[in] rtcp    pointer to a @p RTCDriver object

+ *

+ * @notapi

+ */

+static void rtc_lld_serve_interrupt(RTCDriver *rtcp) {

+

+  chSysLockFromIsr();

+

+  if ((RTC->CRH & RTC_CRH_SECIE) && (RTC->CRL & RTC_CRL_SECF)) {

+    rtcp->rtc_cb(rtcp, RTC_EVENT_SECOND);

+    RTC->CRL &= ~RTC_CRL_SECF;

+  }

+  if ((RTC->CRH & RTC_CRH_ALRIE) && (RTC->CRL & RTC_CRL_ALRF)) {

+    rtcp->rtc_cb(rtcp, RTC_EVENT_ALARM);

+    RTC->CRL &= ~RTC_CRL_ALRF;

+  }

+  if ((RTC->CRH & RTC_CRH_OWIE) && (RTC->CRL & RTC_CRL_OWF)) {

+    rtcp->rtc_cb(rtcp, RTC_EVENT_OVERFLOW);

+    RTC->CRL &= ~RTC_CRL_OWF;

+  }

+

+  chSysUnlockFromIsr();

+}

+

+/**

+ * @brief   Waits for the previous registers write to finish.

+ *

+ * @notapi

+ */

+static void rtc_lld_wait_write(void) {

+

+  /* Waits registers write completion.*/

+  while (!(RTC->CRL & RTC_CRL_RTOFF))

+    ;

+}

+

+/*===========================================================================*/

+/* Driver interrupt handlers.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   RTC interrupt handler.

+ *

+ * @isr

+ */

+CH_IRQ_HANDLER(RTC_IRQHandler) {

+

+  CH_IRQ_PROLOGUE();

+

+  rtc_lld_serve_interrupt(&RTCD1);

+

+  CH_IRQ_EPILOGUE();

+}

+

+/*===========================================================================*/

+/* Driver exported functions.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   Enable access to registers and initialize RTC if BKP domain

+ *          was previously reseted.

+ * @note:   Cold start time of LSE oscillator on STM32 platform 

+ *          takes about 3 seconds.

+ *

+ * @notapi

+ */

+void rtc_lld_init(void){

+  uint32_t preload;

+

+  rccEnableBKPInterface(FALSE);

+

+  /* Enables access to BKP registers.*/

+  PWR->CR |= PWR_CR_DBP;

+

+  /* If the RTC is not enabled then performs a reset of the backup domain.*/

+  if (!(RCC->BDCR & RCC_BDCR_RTCEN)) {

+    RCC->BDCR = RCC_BDCR_BDRST;

+    RCC->BDCR = 0;

+  }

+

+#if STM32_RTC == STM32_RTC_LSE

+  if (!(RCC->BDCR & RCC_BDCR_LSEON)) {

+    RCC->BDCR |= RCC_BDCR_LSEON;

+    while (!(RCC->BDCR & RCC_BDCR_LSERDY))

+      ;

+  }

+  preload = STM32_LSECLK - 1;

+#elif STM32_RTC == STM32_RTC_LSI

+  /* TODO: Move the LSI clock initialization in the HAL low level driver.*/

+  RCC->CSR |= RCC_CSR_LSION;

+  while (!(RCC->CSR & RCC_CSR_LSIRDY))

+    ;

+  /* According to errata sheet we must wait additional 100 uS for

+     stabilization.

+     TODO: Change this code, software loops are not reliable.*/

+  uint32_t tmo = (STM32_SYSCLK / 1000000) * 100;

+  while (tmo--)

+    ;

+  preload = STM32_LSICLK - 1;

+#elif STM32_RTC == STM32_RTC_HSE

+  preload = (STM32_HSICLK / 128) - 1;

+#endif

+

+  /* Selects clock source (previously enabled and stabilized).*/

+  RCC->BDCR = (RCC->BDCR & ~RCC_BDCR_RTCSEL) | STM32_RTC;

+

+  /* RTC enabled regardless its previous status.*/

+  RCC->BDCR |= RCC_BDCR_RTCEN;

+

+  /* Ensure that RTC_CNT and RTC_DIV contain actual values after enabling

+     clocking on APB1, because these values only update when APB1

+     functioning.*/

+  RTC->CRL = 0;

+  while (!(RTC->CRL & RTC_CRL_RSF))

+    ;

+

+  /* Write preload register only if its value differs.*/

+  if (preload != ((((uint32_t)(RTC->PRLH)) << 16) + (uint32_t)RTC->PRLL)) {

+

+    rtc_lld_wait_write();

+

+    /* Enters configuration mode and writes PRLx registers then leaves the

+       configuration mode.*/

+    RTC->CRL |= RTC_CRL_CNF;

+    RTC->PRLH = (uint16_t)(preload >> 16);

+    RTC->PRLL = (uint16_t)(preload & 0xFFFF);

+    RTC->CRL &= ~RTC_CRL_CNF;

+  }

+

+  /* All interrupts initially disabled.*/

+  RTC->CRH = 0;

+

+  /* Callback initially disabled.*/

+  RTCD1.rtc_cb = NULL;

+}

+

+/**

+ * @brief   Set current time.

+ * @note    Fractional part will be silently ignored. There is no possibility

+ *          to change it on STM32F1xx platform.

+ *

+ * @param[in] rtcp      pointer to RTC driver structure

+ * @param[in] timespec  pointer to a @p RTCTime structure

+ *

+ * @notapi

+ */

+void rtc_lld_set_time(RTCDriver *rtcp, const RTCTime *timespec) {

+

+  (void)rtcp;

+

+  rtc_lld_wait_write();

+

+  RTC->CRL |= RTC_CRL_CNF;

+  RTC->CNTH = (uint16_t)(timespec->tv_sec >> 16);

+  RTC->CNTL = (uint16_t)(timespec->tv_sec & 0xFFFF);

+  RTC->CRL &= ~RTC_CRL_CNF;

+}

+

+/**

+ * @brief   Get current time.

+ *

+ * @param[in] rtcp      pointer to RTC driver structure

+ * @param[out] timespec pointer to a @p RTCTime structure

+ *

+ * @notapi

+ */

+void rtc_lld_get_time(RTCDriver *rtcp, RTCTime *timespec) {

+  uint32_t time_frac;

+

+  (void)rtcp;

+

+  time_frac = (((uint32_t)RTC->DIVH) << 16) + (uint32_t)RTC->DIVL;

+  timespec->tv_msec = (uint16_t)(((STM32_LSECLK - time_frac) * 1000) /

+                                 STM32_LSECLK);

+  timespec->tv_sec = (RTC->CNTH << 16) + RTC->CNTL;

+}

+

+/**

+ * @brief   Set alarm time.

+ *

+ * @note      Default value after BKP domain reset is 0xFFFFFFFF

+ *

+ * @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,

+                       const RTCAlarm *alarmspec) {

+

+  (void)rtcp;

+  (void)alarm;

+

+  rtc_lld_wait_write();

+

+  /* Enters configuration mode and writes ALRHx registers then leaves the

+     configuration mode.*/

+  RTC->CRL |= RTC_CRL_CNF;

+  if (alarmspec != NULL) {

+    RTC->ALRH = (uint16_t)(alarmspec->tv_sec >> 16);

+    RTC->ALRL = (uint16_t)(alarmspec->tv_sec & 0xFFFF);

+  }

+  else {

+    RTC->ALRH = 0;

+    RTC->ALRL = 0;

+  }

+  RTC->CRL &= ~RTC_CRL_CNF;

+}

+

+/**

+ * @brief   Get current alarm.

+ * @note    If an alarm has not been set then the returned alarm specification

+ *          is not meaningful.

+ *

+ * @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,

+                       RTCAlarm *alarmspec) {

+

+  (void)rtcp;

+  (void)alarm;

+

+  alarmspec->tv_sec = ((RTC->ALRH << 16) + RTC->ALRL);

+}

+

+/**

+ * @brief   Enables or disables RTC callbacks.

+ * @details This function enables or disables callbacks, use a @p NULL pointer

+ *          in order to disable a callback.

+ *

+ * @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) {

+

+  if (callback != NULL) {

+    rtcp->rtc_cb = callback;

+    NVICEnableVector(RTC_IRQn, CORTEX_PRIORITY_MASK(STM32_RTC_IRQ_PRIORITY));

+

+    /* Interrupts are enabled only after setting up the callback, this

+       way there is no need to check for the NULL callback pointer inside

+       the IRQ handler.*/

+    RTC->CRL &= ~(RTC_CRL_OWF | RTC_CRL_ALRF | RTC_CRL_SECF);

+    RTC->CRH |= RTC_CRH_OWIE | RTC_CRH_ALRIE | RTC_CRH_SECIE;

+  }

+  else {

+    NVICDisableVector(RTC_IRQn);

+    RTC->CRL = 0;

+    RTC->CRH = 0;

+  }

+}

+

+#endif /* HAL_USE_RTC */

+

+/** @} */

diff --git a/os/hal/platforms/STM32F4xx/rtc_lld.h b/os/hal/platforms/STM32F4xx/rtc_lld.h
new file mode 100644
index 000000000..e3ce0e365
--- /dev/null
+++ b/os/hal/platforms/STM32F4xx/rtc_lld.h
@@ -0,0 +1,160 @@
+/*

+    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   STM32 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 stamp.

+ */

+typedef struct RTCAlarm RTCAlarm;

+

+/**

+ * @brief   Type of an RTC alarm.

+ */

+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 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 specification.

+ */

+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, rtccb_t callback);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* HAL_USE_RTC */

+

+#endif /* _RTC_LLD_H_ */

+

+/** @} */