Chau Vo / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/hal/TARGET_STM/TARGET_STM32F4/rtc_api.c@103:173fc4c67e73, 2016-04-01 (annotated)

Committer:
mbed_official
Date:
Fri Apr 01 17:45:12 2016 +0100
Revision:
103:173fc4c67e73
Parent:
87:444eeba2d452
Child:
144:ef7eb2e8f9f7
Synchronized with git revision 47c580be869fde4174bc01e0086d51df4bedd852



Full URL: https://github.com/mbedmicro/mbed/commit/47c580be869fde4174bc01e0086d51df4bedd852/



[XXX_F3XX] enhance RTC API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 *******************************************************************************
bogdanm 0:9b334a45a8ff 3 * Copyright (c) 2014, STMicroelectronics
bogdanm 0:9b334a45a8ff 4 * All rights reserved.
bogdanm 0:9b334a45a8ff 5 *
bogdanm 0:9b334a45a8ff 6 * Redistribution and use in source and binary forms, with or without
bogdanm 0:9b334a45a8ff 7 * modification, are permitted provided that the following conditions are met:
bogdanm 0:9b334a45a8ff 8 *
bogdanm 0:9b334a45a8ff 9 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 0:9b334a45a8ff 10 * this list of conditions and the following disclaimer.
bogdanm 0:9b334a45a8ff 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 0:9b334a45a8ff 12 * this list of conditions and the following disclaimer in the documentation
bogdanm 0:9b334a45a8ff 13 * and/or other materials provided with the distribution.
bogdanm 0:9b334a45a8ff 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 0:9b334a45a8ff 15 * may be used to endorse or promote products derived from this software
bogdanm 0:9b334a45a8ff 16 * without specific prior written permission.
bogdanm 0:9b334a45a8ff 17 *
bogdanm 0:9b334a45a8ff 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 0:9b334a45a8ff 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 0:9b334a45a8ff 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 0:9b334a45a8ff 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 0:9b334a45a8ff 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 0:9b334a45a8ff 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 0:9b334a45a8ff 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 0:9b334a45a8ff 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 0:9b334a45a8ff 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 0:9b334a45a8ff 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 0:9b334a45a8ff 28 *******************************************************************************
bogdanm 0:9b334a45a8ff 29 */
bogdanm 0:9b334a45a8ff 30 #include "rtc_api.h"
bogdanm 0:9b334a45a8ff 31
bogdanm 0:9b334a45a8ff 32 #if DEVICE_RTC
bogdanm 0:9b334a45a8ff 33
bogdanm 0:9b334a45a8ff 34 #include "mbed_error.h"
bogdanm 0:9b334a45a8ff 35
mbed_official 87:444eeba2d452 36 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 37 static int rtc_inited = 0;
mbed_official 87:444eeba2d452 38 #endif
bogdanm 0:9b334a45a8ff 39
bogdanm 0:9b334a45a8ff 40 static RTC_HandleTypeDef RtcHandle;
bogdanm 0:9b334a45a8ff 41
bogdanm 0:9b334a45a8ff 42 void rtc_init(void)
bogdanm 0:9b334a45a8ff 43 {
bogdanm 0:9b334a45a8ff 44 RCC_OscInitTypeDef RCC_OscInitStruct;
bogdanm 0:9b334a45a8ff 45 uint32_t rtc_freq = 0;
bogdanm 0:9b334a45a8ff 46
mbed_official 87:444eeba2d452 47 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 48 rtc_inited = 1;
mbed_official 87:444eeba2d452 49 #endif
bogdanm 0:9b334a45a8ff 50
bogdanm 0:9b334a45a8ff 51 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 52
mbed_official 87:444eeba2d452 53 #if !DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 54 // Enable LSE Oscillator
bogdanm 0:9b334a45a8ff 55 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSE;
bogdanm 0:9b334a45a8ff 56 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; /* Mandatory, otherwise the PLL is reconfigured! */
bogdanm 0:9b334a45a8ff 57 RCC_OscInitStruct.LSEState = RCC_LSE_ON; /* External 32.768 kHz clock on OSC_IN/OSC_OUT */
bogdanm 0:9b334a45a8ff 58 if (HAL_RCC_OscConfig(&RCC_OscInitStruct) == HAL_OK) {
bogdanm 0:9b334a45a8ff 59 // Connect LSE to RTC
bogdanm 0:9b334a45a8ff 60 __HAL_RCC_RTC_CLKPRESCALER(RCC_RTCCLKSOURCE_LSE);
bogdanm 0:9b334a45a8ff 61 __HAL_RCC_RTC_CONFIG(RCC_RTCCLKSOURCE_LSE);
bogdanm 0:9b334a45a8ff 62 rtc_freq = LSE_VALUE;
mbed_official 87:444eeba2d452 63 }
mbed_official 87:444eeba2d452 64 else {
mbed_official 87:444eeba2d452 65 error("RTC error: LSE clock initialization failed.");
mbed_official 87:444eeba2d452 66 }
mbed_official 87:444eeba2d452 67 #else
mbed_official 103:173fc4c67e73 68 // Enable Power clock
mbed_official 103:173fc4c67e73 69 __PWR_CLK_ENABLE();
mbed_official 103:173fc4c67e73 70
mbed_official 103:173fc4c67e73 71 // Enable access to Backup domain
mbed_official 103:173fc4c67e73 72 HAL_PWR_EnableBkUpAccess();
mbed_official 103:173fc4c67e73 73
mbed_official 103:173fc4c67e73 74 // Reset Backup domain
mbed_official 103:173fc4c67e73 75 __HAL_RCC_BACKUPRESET_FORCE();
mbed_official 103:173fc4c67e73 76 __HAL_RCC_BACKUPRESET_RELEASE();
mbed_official 103:173fc4c67e73 77
mbed_official 103:173fc4c67e73 78 // Enable LSI clock
mbed_official 103:173fc4c67e73 79 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI | RCC_OSCILLATORTYPE_LSE;
mbed_official 103:173fc4c67e73 80 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; // Mandatory, otherwise the PLL is reconfigured!
mbed_official 103:173fc4c67e73 81 RCC_OscInitStruct.LSEState = RCC_LSE_OFF;
mbed_official 103:173fc4c67e73 82 RCC_OscInitStruct.LSIState = RCC_LSI_ON;
mbed_official 103:173fc4c67e73 83 if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
mbed_official 103:173fc4c67e73 84 error("RTC error: LSI clock initialization failed.");
mbed_official 103:173fc4c67e73 85 }
mbed_official 103:173fc4c67e73 86 // Connect LSI to RTC
mbed_official 103:173fc4c67e73 87 __HAL_RCC_RTC_CLKPRESCALER(RCC_RTCCLKSOURCE_LSI);
mbed_official 103:173fc4c67e73 88 __HAL_RCC_RTC_CONFIG(RCC_RTCCLKSOURCE_LSI);
mbed_official 103:173fc4c67e73 89 // [TODO] This value is LSI typical value. To be measured precisely using a timer input capture
mbed_official 103:173fc4c67e73 90 rtc_freq = LSI_VALUE;
mbed_official 87:444eeba2d452 91 #endif
mbed_official 48:b854a29e778d 92
bogdanm 0:9b334a45a8ff 93 // Enable RTC
bogdanm 0:9b334a45a8ff 94 __HAL_RCC_RTC_ENABLE();
bogdanm 0:9b334a45a8ff 95
bogdanm 0:9b334a45a8ff 96 RtcHandle.Init.HourFormat = RTC_HOURFORMAT_24;
bogdanm 0:9b334a45a8ff 97 RtcHandle.Init.AsynchPrediv = 127;
bogdanm 0:9b334a45a8ff 98 RtcHandle.Init.SynchPrediv = (rtc_freq / 128) - 1;
bogdanm 0:9b334a45a8ff 99 RtcHandle.Init.OutPut = RTC_OUTPUT_DISABLE;
bogdanm 0:9b334a45a8ff 100 RtcHandle.Init.OutPutPolarity = RTC_OUTPUT_POLARITY_HIGH;
bogdanm 0:9b334a45a8ff 101 RtcHandle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
bogdanm 0:9b334a45a8ff 102
bogdanm 0:9b334a45a8ff 103 if (HAL_RTC_Init(&RtcHandle) != HAL_OK) {
bogdanm 0:9b334a45a8ff 104 error("RTC error: RTC initialization failed.");
bogdanm 0:9b334a45a8ff 105 }
bogdanm 0:9b334a45a8ff 106 }
bogdanm 0:9b334a45a8ff 107
bogdanm 0:9b334a45a8ff 108 void rtc_free(void)
bogdanm 0:9b334a45a8ff 109 {
mbed_official 103:173fc4c67e73 110 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 111 // Enable Power clock
bogdanm 0:9b334a45a8ff 112 __PWR_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 113
bogdanm 0:9b334a45a8ff 114 // Enable access to Backup domain
bogdanm 0:9b334a45a8ff 115 HAL_PWR_EnableBkUpAccess();
bogdanm 0:9b334a45a8ff 116
bogdanm 0:9b334a45a8ff 117 // Reset Backup domain
bogdanm 0:9b334a45a8ff 118 __HAL_RCC_BACKUPRESET_FORCE();
bogdanm 0:9b334a45a8ff 119 __HAL_RCC_BACKUPRESET_RELEASE();
bogdanm 0:9b334a45a8ff 120
bogdanm 0:9b334a45a8ff 121 // Disable access to Backup domain
bogdanm 0:9b334a45a8ff 122 HAL_PWR_DisableBkUpAccess();
mbed_official 103:173fc4c67e73 123 #endif
bogdanm 0:9b334a45a8ff 124
bogdanm 0:9b334a45a8ff 125 // Disable LSI and LSE clocks
bogdanm 0:9b334a45a8ff 126 RCC_OscInitTypeDef RCC_OscInitStruct;
bogdanm 0:9b334a45a8ff 127 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI | RCC_OSCILLATORTYPE_LSE;
bogdanm 0:9b334a45a8ff 128 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
bogdanm 0:9b334a45a8ff 129 RCC_OscInitStruct.LSIState = RCC_LSI_OFF;
bogdanm 0:9b334a45a8ff 130 RCC_OscInitStruct.LSEState = RCC_LSE_OFF;
bogdanm 0:9b334a45a8ff 131 HAL_RCC_OscConfig(&RCC_OscInitStruct);
mbed_official 87:444eeba2d452 132 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 133 rtc_inited = 0;
mbed_official 87:444eeba2d452 134 #endif
bogdanm 0:9b334a45a8ff 135 }
bogdanm 0:9b334a45a8ff 136
bogdanm 0:9b334a45a8ff 137 int rtc_isenabled(void)
bogdanm 0:9b334a45a8ff 138 {
mbed_official 87:444eeba2d452 139 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 140 return rtc_inited;
mbed_official 87:444eeba2d452 141 #else
mbed_official 87:444eeba2d452 142 if ((RTC->ISR & RTC_ISR_INITS) == RTC_ISR_INITS) return 1;
mbed_official 87:444eeba2d452 143 else return 0;
mbed_official 87:444eeba2d452 144 #endif
bogdanm 0:9b334a45a8ff 145 }
bogdanm 0:9b334a45a8ff 146
bogdanm 0:9b334a45a8ff 147 /*
bogdanm 0:9b334a45a8ff 148 RTC Registers
bogdanm 0:9b334a45a8ff 149 RTC_WeekDay 1=monday, 2=tuesday, ..., 7=sunday
bogdanm 0:9b334a45a8ff 150 RTC_Month 1=january, 2=february, ..., 12=december
bogdanm 0:9b334a45a8ff 151 RTC_Date day of the month 1-31
bogdanm 0:9b334a45a8ff 152 RTC_Year year 0-99
bogdanm 0:9b334a45a8ff 153 struct tm
bogdanm 0:9b334a45a8ff 154 tm_sec seconds after the minute 0-61
bogdanm 0:9b334a45a8ff 155 tm_min minutes after the hour 0-59
bogdanm 0:9b334a45a8ff 156 tm_hour hours since midnight 0-23
bogdanm 0:9b334a45a8ff 157 tm_mday day of the month 1-31
bogdanm 0:9b334a45a8ff 158 tm_mon months since January 0-11
bogdanm 0:9b334a45a8ff 159 tm_year years since 1900
bogdanm 0:9b334a45a8ff 160 tm_wday days since Sunday 0-6
bogdanm 0:9b334a45a8ff 161 tm_yday days since January 1 0-365
bogdanm 0:9b334a45a8ff 162 tm_isdst Daylight Saving Time flag
bogdanm 0:9b334a45a8ff 163 */
bogdanm 0:9b334a45a8ff 164 time_t rtc_read(void)
bogdanm 0:9b334a45a8ff 165 {
bogdanm 0:9b334a45a8ff 166 RTC_DateTypeDef dateStruct;
bogdanm 0:9b334a45a8ff 167 RTC_TimeTypeDef timeStruct;
bogdanm 0:9b334a45a8ff 168 struct tm timeinfo;
bogdanm 0:9b334a45a8ff 169
bogdanm 0:9b334a45a8ff 170 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 171
bogdanm 0:9b334a45a8ff 172 // Read actual date and time
bogdanm 0:9b334a45a8ff 173 // Warning: the time must be read first!
bogdanm 0:9b334a45a8ff 174 HAL_RTC_GetTime(&RtcHandle, &timeStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 175 HAL_RTC_GetDate(&RtcHandle, &dateStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 176
bogdanm 0:9b334a45a8ff 177 // Setup a tm structure based on the RTC
bogdanm 0:9b334a45a8ff 178 timeinfo.tm_wday = dateStruct.WeekDay;
bogdanm 0:9b334a45a8ff 179 timeinfo.tm_mon = dateStruct.Month - 1;
bogdanm 0:9b334a45a8ff 180 timeinfo.tm_mday = dateStruct.Date;
bogdanm 0:9b334a45a8ff 181 timeinfo.tm_year = dateStruct.Year + 100;
bogdanm 0:9b334a45a8ff 182 timeinfo.tm_hour = timeStruct.Hours;
bogdanm 0:9b334a45a8ff 183 timeinfo.tm_min = timeStruct.Minutes;
bogdanm 0:9b334a45a8ff 184 timeinfo.tm_sec = timeStruct.Seconds;
bogdanm 0:9b334a45a8ff 185
bogdanm 0:9b334a45a8ff 186 // Convert to timestamp
bogdanm 0:9b334a45a8ff 187 time_t t = mktime(&timeinfo);
bogdanm 0:9b334a45a8ff 188
bogdanm 0:9b334a45a8ff 189 return t;
bogdanm 0:9b334a45a8ff 190 }
bogdanm 0:9b334a45a8ff 191
bogdanm 0:9b334a45a8ff 192 void rtc_write(time_t t)
bogdanm 0:9b334a45a8ff 193 {
bogdanm 0:9b334a45a8ff 194 RTC_DateTypeDef dateStruct;
bogdanm 0:9b334a45a8ff 195 RTC_TimeTypeDef timeStruct;
bogdanm 0:9b334a45a8ff 196
bogdanm 0:9b334a45a8ff 197 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 198
bogdanm 0:9b334a45a8ff 199 // Convert the time into a tm
bogdanm 0:9b334a45a8ff 200 struct tm *timeinfo = localtime(&t);
bogdanm 0:9b334a45a8ff 201
bogdanm 0:9b334a45a8ff 202 // Fill RTC structures
bogdanm 0:9b334a45a8ff 203 dateStruct.WeekDay = timeinfo->tm_wday;
bogdanm 0:9b334a45a8ff 204 dateStruct.Month = timeinfo->tm_mon + 1;
bogdanm 0:9b334a45a8ff 205 dateStruct.Date = timeinfo->tm_mday;
bogdanm 0:9b334a45a8ff 206 dateStruct.Year = timeinfo->tm_year - 100;
bogdanm 0:9b334a45a8ff 207 timeStruct.Hours = timeinfo->tm_hour;
bogdanm 0:9b334a45a8ff 208 timeStruct.Minutes = timeinfo->tm_min;
bogdanm 0:9b334a45a8ff 209 timeStruct.Seconds = timeinfo->tm_sec;
bogdanm 0:9b334a45a8ff 210 timeStruct.TimeFormat = RTC_HOURFORMAT12_PM;
bogdanm 0:9b334a45a8ff 211 timeStruct.DayLightSaving = RTC_DAYLIGHTSAVING_NONE;
bogdanm 0:9b334a45a8ff 212 timeStruct.StoreOperation = RTC_STOREOPERATION_RESET;
bogdanm 0:9b334a45a8ff 213
bogdanm 0:9b334a45a8ff 214 // Change the RTC current date/time
bogdanm 0:9b334a45a8ff 215 HAL_RTC_SetDate(&RtcHandle, &dateStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 216 HAL_RTC_SetTime(&RtcHandle, &timeStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 217 }
bogdanm 0:9b334a45a8ff 218
bogdanm 0:9b334a45a8ff 219 #endif