RTC. Code reorganization.

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

2 files changed, 431 insertions, 0 deletions

diff --git a/os/hal/platforms/STM32/RTCv2/rtc_lld.c b/os/hal/platforms/STM32/RTCv2/rtc_lld.c
new file mode 100644
index 000000000..cdf3aff81
--- /dev/null
+++ b/os/hal/platforms/STM32/RTCv2/rtc_lld.c
@@ -0,0 +1,258 @@
+/*

+    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__)

+

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

+/* Notes.                                                                    */

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

+/*

+This structure is used to hold the values representing a calendar time.

+It contains the following members, with the meanings as shown.

+

+int tm_sec      // seconds after minute [0-61] (61 allows for 2 leap-seconds)

+int tm_min      // minutes after hour [0-59] 

+int tm_hour     // hours after midnight [0-23] 

+int tm_mday     // day of the month [1-31] 

+int tm_mon      // month of year [0-11] 

+int tm_year     // current year-1900 

+int tm_wday     // days since Sunday [0-6] 

+int tm_yday     // days since January 1st [0-365] 

+int tm_isdst    // daylight savings indicator (1 = yes, 0 = no, -1 = unknown)

+*/

+

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

+/* Driver exported variables.                                                */

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

+

+/**

+ * @brief RTC driver identifier.

+ */

+RTCDriver RTCD1;

+

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

+/* Driver local variables.                                                   */

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

+

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

+/* Driver local functions.                                                   */

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

+

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

+/* Driver interrupt handlers.                                                */

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

+

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

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

+  /* Asynchronous part of preloader. Set it to maximum value. */

+  #define PREDIV_A ((uint32_t)0x7F)

+

+  /* Add async part to preload value. */

+  uint32_t preload = PREDIV_A << 16;

+

+  /* 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

+  #define RTC_CLK   STM32_LSECLK

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

+    RCC->BDCR |= RCC_BDCR_LSEON;

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

+      ;

+  }

+

+#elif STM32_RTC == STM32_RTC_LSI

+  #define RTC_CLK   STM32_LSICLK

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

+  RCC->CSR |= RCC_CSR_LSION;

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

+    ;

+

+#elif STM32_RTC == STM32_RTC_HSE

+  #define RTC_CLK   (STM32_HSICLK / 31)

+#endif

+

+  /* Add sync part to preload value. */

+  preload |= ((RTC_CLK / (PREDIV_A + 1)) - 1) & 0x7FFF;

+

+  /* 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;

+

+  /* If calendar not init yet. */

+  if (!(RTC->ISR & RTC_ISR_INITS)){

+    /* Disable write protection on RTC registers. */

+    RTC->WPR = 0xCA;

+    RTC->WPR = 0x53;

+

+    /* Enter in init mode. */

+    RTC->ISR |= RTC_ISR_INIT;

+    while(!(RTC->ISR & RTC_ISR_INITF))

+      ;

+    /* Prescaler registers must be written in by two separate writes. */

+    RTC->PRER = preload;

+    RTC->PRER = preload;

+    RTC->ISR &= ~RTC_ISR_INIT;

+  }

+

+  /* 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->ISR |= RTC_ISR_INIT;

+  while(!(RTC->ISR & RTC_ISR_INITF))

+    ;

+  RTC->TR = timespec->tv_time;

+  RTC->DR = timespec->tv_date;

+  RTC->ISR &= ~RTC_ISR_INIT;

+}

+

+/**

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

+  (void)rtcp;

+

+  /*  TODO: If the frequency of the APB1 clock is less than seven times

+   * the frequency of RTCCLK, BYPSHAD must be set to ‘1’ .*/

+

+  /* Wait until calendar data will updated. */

+  while(!(RTC->ISR & RTC_ISR_RSF))

+    ;

+

+  timespec->tv_time = RTC->TR;

+  timespec->tv_date = RTC->DR;

+#if RTC_HAS_SUBSECONDS

+  timespec->tv_msec = ((RTC->PRER & 0x7FFF) - RTC->SSR) / ((RTC->PRER & 0x7FFF) + 1);

+#else

+  timespec->tv_msec = 0;

+#endif /* STM32_RTC_HAS_SUBSECONDS */

+}

+

+

+/**

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

+  (void)alarmspec;

+}

+

+/**

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

+  (void)alarmspec;

+}

+

+/**

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

+  }

+  return;

+}

+

+#endif /* HAL_USE_RTC */

+

+/** @} */

diff --git a/os/hal/platforms/STM32/RTCv2/rtc_lld.h b/os/hal/platforms/STM32/RTCv2/rtc_lld.h
new file mode 100644
index 000000000..dd5a4160e
--- /dev/null
+++ b/os/hal/platforms/STM32/RTCv2/rtc_lld.h
@@ -0,0 +1,173 @@
+/*

+    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   Two alarm comparators available on STM32F4x.

+ */

+#define RTC_ALARMS                  2

+

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

+/* 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

+

+#if RTC_SUPPORTS_CALLBACKS && !(HAL_USE_EXT)

+#error "interrupts from STM32 RTC works only through EXTI"

+#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_WAKEUP = 0,           /** Triggered every wakeup event.          */

+  RTC_EVENT_ALARM_A = 1,          /** Triggered on alarm A.                  */

+  RTC_EVENT_ALARM_B = 2,          /** Triggered on alarm B.                  */

+  RTC_EVENT_TAMPER = 3,           /** Triggered on Tamper event.             */

+  RTC_EVENT_TIMESTAMP = 4,        /** Triggered on TimeStamp event.          */

+} 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 RTC date register in STM32 BCD format.

+   */

+  uint32_t tv_date;

+  /**

+   * @brief RTC time register in STM32 BCD format.

+   */

+  uint32_t tv_time;

+  /**

+   * @brief Fractional part of time.

+   * @note  If platform does not support subseconds than always zero.

+   */

+  uint16_t tv_msec;

+};

+

+

+/**

+ * @brief   Structure representing an RTC alarm specification.

+ */

+struct RTCAlarm {

+  /**

+   * @brief Date and time of alarm in STM32 BCD.

+   */

+  uint32_t tv_datetime;

+};

+

+

+/**

+ * @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_ */

+

+/** @} */