Johannes Stratmann / 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_STM32L1/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:
48:b854a29e778d
Child:
105:364b35371a11
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 103:173fc4c67e73 36 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 37 static int rtc_inited = 0;
mbed_official 103:173fc4c67e73 38 #endif
bogdanm 0:9b334a45a8ff 39
bogdanm 0:9b334a45a8ff 40 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 103:173fc4c67e73 47 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 48 if (rtc_inited) return;
bogdanm 0:9b334a45a8ff 49 rtc_inited = 1;
mbed_official 103:173fc4c67e73 50 #endif
bogdanm 0:9b334a45a8ff 51
bogdanm 0:9b334a45a8ff 52 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 53
bogdanm 0:9b334a45a8ff 54 // Enable Power clock
bogdanm 0:9b334a45a8ff 55 __PWR_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 56
bogdanm 0:9b334a45a8ff 57 // Enable access to Backup domain
bogdanm 0:9b334a45a8ff 58 HAL_PWR_EnableBkUpAccess();
bogdanm 0:9b334a45a8ff 59
bogdanm 0:9b334a45a8ff 60 // Reset Backup domain
bogdanm 0:9b334a45a8ff 61 __HAL_RCC_BACKUPRESET_FORCE();
bogdanm 0:9b334a45a8ff 62 __HAL_RCC_BACKUPRESET_RELEASE();
bogdanm 0:9b334a45a8ff 63
mbed_official 103:173fc4c67e73 64 #if !DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 65 // Enable LSE Oscillator
mbed_official 103:173fc4c67e73 66 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI | RCC_OSCILLATORTYPE_LSE;
bogdanm 0:9b334a45a8ff 67 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; // Mandatory, otherwise the PLL is reconfigured!
bogdanm 0:9b334a45a8ff 68 RCC_OscInitStruct.LSEState = RCC_LSE_ON; // External 32.768 kHz clock on OSC_IN/OSC_OUT
mbed_official 103:173fc4c67e73 69 RCC_OscInitStruct.LSIState = RCC_LSI_OFF;
mbed_official 103:173fc4c67e73 70 if (HAL_RCC_OscConfig(&RCC_OscInitStruct) == HAL_OK) { // Check if LSE has started correctly
bogdanm 0:9b334a45a8ff 71 // Connect LSE to RTC
bogdanm 0:9b334a45a8ff 72 __HAL_RCC_RTC_CLKPRESCALER(RCC_RTCCLKSOURCE_LSE);
bogdanm 0:9b334a45a8ff 73 __HAL_RCC_RTC_CONFIG(RCC_RTCCLKSOURCE_LSE);
bogdanm 0:9b334a45a8ff 74 rtc_freq = LSE_VALUE;
bogdanm 0:9b334a45a8ff 75 } else {
mbed_official 103:173fc4c67e73 76 error("Cannot initialize RTC with LSE\n");
bogdanm 0:9b334a45a8ff 77 }
mbed_official 103:173fc4c67e73 78 #else
mbed_official 103:173fc4c67e73 79 // Enable LSI clock
mbed_official 103:173fc4c67e73 80 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI | RCC_OSCILLATORTYPE_LSE;
mbed_official 103:173fc4c67e73 81 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; // Mandatory, otherwise the PLL is reconfigured!
mbed_official 103:173fc4c67e73 82 RCC_OscInitStruct.LSEState = RCC_LSE_OFF;
mbed_official 103:173fc4c67e73 83 RCC_OscInitStruct.LSIState = RCC_LSI_ON;
mbed_official 103:173fc4c67e73 84 if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
mbed_official 103:173fc4c67e73 85 error("Cannot initialize RTC with LSI\n");
mbed_official 103:173fc4c67e73 86 }
mbed_official 103:173fc4c67e73 87 // Connect LSI to RTC
mbed_official 103:173fc4c67e73 88 __HAL_RCC_RTC_CLKPRESCALER(RCC_RTCCLKSOURCE_LSI);
mbed_official 103:173fc4c67e73 89 __HAL_RCC_RTC_CONFIG(RCC_RTCCLKSOURCE_LSI);
mbed_official 103:173fc4c67e73 90 // This value is LSI typical value. To be measured precisely using a timer input capture for example.
mbed_official 103:173fc4c67e73 91 rtc_freq = 40000;
mbed_official 103:173fc4c67e73 92 #endif
mbed_official 48:b854a29e778d 93
bogdanm 0:9b334a45a8ff 94 // Enable RTC
bogdanm 0:9b334a45a8ff 95 __HAL_RCC_RTC_ENABLE();
bogdanm 0:9b334a45a8ff 96
bogdanm 0:9b334a45a8ff 97 RtcHandle.Init.HourFormat = RTC_HOURFORMAT_24;
bogdanm 0:9b334a45a8ff 98 #ifdef TARGET_MOTE_L152RC
bogdanm 0:9b334a45a8ff 99 /* SubSecond resolution of 16384Hz */
bogdanm 0:9b334a45a8ff 100 RtcHandle.Init.AsynchPrediv = 1;
bogdanm 0:9b334a45a8ff 101 RtcHandle.Init.SynchPrediv = (rtc_freq / 2) - 1;
bogdanm 0:9b334a45a8ff 102 #else
bogdanm 0:9b334a45a8ff 103 RtcHandle.Init.AsynchPrediv = 127;
bogdanm 0:9b334a45a8ff 104 RtcHandle.Init.SynchPrediv = (rtc_freq / 128) - 1;
bogdanm 0:9b334a45a8ff 105 #endif
bogdanm 0:9b334a45a8ff 106 RtcHandle.Init.OutPut = RTC_OUTPUT_DISABLE;
bogdanm 0:9b334a45a8ff 107 RtcHandle.Init.OutPutPolarity = RTC_OUTPUT_POLARITY_HIGH;
bogdanm 0:9b334a45a8ff 108 RtcHandle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
bogdanm 0:9b334a45a8ff 109
bogdanm 0:9b334a45a8ff 110 if (HAL_RTC_Init(&RtcHandle) != HAL_OK) {
bogdanm 0:9b334a45a8ff 111 error("RTC error: RTC initialization failed.");
bogdanm 0:9b334a45a8ff 112 }
bogdanm 0:9b334a45a8ff 113 }
bogdanm 0:9b334a45a8ff 114
bogdanm 0:9b334a45a8ff 115 void rtc_free(void)
bogdanm 0:9b334a45a8ff 116 {
bogdanm 0:9b334a45a8ff 117 // Enable Power clock
bogdanm 0:9b334a45a8ff 118 __PWR_CLK_ENABLE();
bogdanm 0:9b334a45a8ff 119
bogdanm 0:9b334a45a8ff 120 // Enable access to Backup domain
bogdanm 0:9b334a45a8ff 121 HAL_PWR_EnableBkUpAccess();
bogdanm 0:9b334a45a8ff 122
bogdanm 0:9b334a45a8ff 123 // Reset Backup domain
bogdanm 0:9b334a45a8ff 124 __HAL_RCC_BACKUPRESET_FORCE();
bogdanm 0:9b334a45a8ff 125 __HAL_RCC_BACKUPRESET_RELEASE();
bogdanm 0:9b334a45a8ff 126
bogdanm 0:9b334a45a8ff 127 // Disable access to Backup domain
bogdanm 0:9b334a45a8ff 128 HAL_PWR_DisableBkUpAccess();
bogdanm 0:9b334a45a8ff 129
bogdanm 0:9b334a45a8ff 130 // Disable LSI and LSE clocks
bogdanm 0:9b334a45a8ff 131 RCC_OscInitTypeDef RCC_OscInitStruct;
bogdanm 0:9b334a45a8ff 132 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI | RCC_OSCILLATORTYPE_LSE;
bogdanm 0:9b334a45a8ff 133 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
bogdanm 0:9b334a45a8ff 134 RCC_OscInitStruct.LSIState = RCC_LSI_OFF;
bogdanm 0:9b334a45a8ff 135 RCC_OscInitStruct.LSEState = RCC_LSE_OFF;
bogdanm 0:9b334a45a8ff 136 HAL_RCC_OscConfig(&RCC_OscInitStruct);
bogdanm 0:9b334a45a8ff 137
mbed_official 103:173fc4c67e73 138 #if DEVICE_RTC_LSI
bogdanm 0:9b334a45a8ff 139 rtc_inited = 0;
mbed_official 103:173fc4c67e73 140 #endif
bogdanm 0:9b334a45a8ff 141 }
bogdanm 0:9b334a45a8ff 142
bogdanm 0:9b334a45a8ff 143 int rtc_isenabled(void)
bogdanm 0:9b334a45a8ff 144 {
mbed_official 103:173fc4c67e73 145 #if DEVICE_RTC_LSI
mbed_official 103:173fc4c67e73 146 return rtc_inited;
mbed_official 103:173fc4c67e73 147 #else
mbed_official 103:173fc4c67e73 148 if ((RTC->ISR & RTC_ISR_INITS) == RTC_ISR_INITS) {
mbed_official 103:173fc4c67e73 149 return 1;
mbed_official 103:173fc4c67e73 150 } else {
mbed_official 103:173fc4c67e73 151 return 0;
mbed_official 103:173fc4c67e73 152 }
mbed_official 103:173fc4c67e73 153 #endif
bogdanm 0:9b334a45a8ff 154 }
bogdanm 0:9b334a45a8ff 155
bogdanm 0:9b334a45a8ff 156 /*
bogdanm 0:9b334a45a8ff 157 RTC Registers
bogdanm 0:9b334a45a8ff 158 RTC_WeekDay 1=monday, 2=tuesday, ..., 7=sunday
bogdanm 0:9b334a45a8ff 159 RTC_Month 1=january, 2=february, ..., 12=december
bogdanm 0:9b334a45a8ff 160 RTC_Date day of the month 1-31
bogdanm 0:9b334a45a8ff 161 RTC_Year year 0-99
bogdanm 0:9b334a45a8ff 162 struct tm
bogdanm 0:9b334a45a8ff 163 tm_sec seconds after the minute 0-61
bogdanm 0:9b334a45a8ff 164 tm_min minutes after the hour 0-59
bogdanm 0:9b334a45a8ff 165 tm_hour hours since midnight 0-23
bogdanm 0:9b334a45a8ff 166 tm_mday day of the month 1-31
bogdanm 0:9b334a45a8ff 167 tm_mon months since January 0-11
bogdanm 0:9b334a45a8ff 168 tm_year years since 1900
bogdanm 0:9b334a45a8ff 169 tm_wday days since Sunday 0-6
bogdanm 0:9b334a45a8ff 170 tm_yday days since January 1 0-365
bogdanm 0:9b334a45a8ff 171 tm_isdst Daylight Saving Time flag
bogdanm 0:9b334a45a8ff 172 */
bogdanm 0:9b334a45a8ff 173 time_t rtc_read(void)
bogdanm 0:9b334a45a8ff 174 {
bogdanm 0:9b334a45a8ff 175 RTC_DateTypeDef dateStruct;
bogdanm 0:9b334a45a8ff 176 RTC_TimeTypeDef timeStruct;
bogdanm 0:9b334a45a8ff 177 struct tm timeinfo;
bogdanm 0:9b334a45a8ff 178
bogdanm 0:9b334a45a8ff 179 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 180
bogdanm 0:9b334a45a8ff 181 // Read actual date and time
bogdanm 0:9b334a45a8ff 182 // Warning: the time must be read first!
bogdanm 0:9b334a45a8ff 183 HAL_RTC_GetTime(&RtcHandle, &timeStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 184 HAL_RTC_GetDate(&RtcHandle, &dateStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 185
bogdanm 0:9b334a45a8ff 186 // Setup a tm structure based on the RTC
bogdanm 0:9b334a45a8ff 187 timeinfo.tm_wday = dateStruct.WeekDay;
bogdanm 0:9b334a45a8ff 188 timeinfo.tm_mon = dateStruct.Month - 1;
bogdanm 0:9b334a45a8ff 189 timeinfo.tm_mday = dateStruct.Date;
bogdanm 0:9b334a45a8ff 190 timeinfo.tm_year = dateStruct.Year + 100;
bogdanm 0:9b334a45a8ff 191 timeinfo.tm_hour = timeStruct.Hours;
bogdanm 0:9b334a45a8ff 192 timeinfo.tm_min = timeStruct.Minutes;
bogdanm 0:9b334a45a8ff 193 timeinfo.tm_sec = timeStruct.Seconds;
bogdanm 0:9b334a45a8ff 194
bogdanm 0:9b334a45a8ff 195 // Convert to timestamp
bogdanm 0:9b334a45a8ff 196 time_t t = mktime(&timeinfo);
bogdanm 0:9b334a45a8ff 197
bogdanm 0:9b334a45a8ff 198 return t;
bogdanm 0:9b334a45a8ff 199 }
bogdanm 0:9b334a45a8ff 200
bogdanm 0:9b334a45a8ff 201 void rtc_write(time_t t)
bogdanm 0:9b334a45a8ff 202 {
bogdanm 0:9b334a45a8ff 203 RTC_DateTypeDef dateStruct;
bogdanm 0:9b334a45a8ff 204 RTC_TimeTypeDef timeStruct;
bogdanm 0:9b334a45a8ff 205
bogdanm 0:9b334a45a8ff 206 RtcHandle.Instance = RTC;
bogdanm 0:9b334a45a8ff 207
bogdanm 0:9b334a45a8ff 208 // Convert the time into a tm
bogdanm 0:9b334a45a8ff 209 struct tm *timeinfo = localtime(&t);
bogdanm 0:9b334a45a8ff 210
bogdanm 0:9b334a45a8ff 211 // Fill RTC structures
bogdanm 0:9b334a45a8ff 212 dateStruct.WeekDay = timeinfo->tm_wday;
bogdanm 0:9b334a45a8ff 213 dateStruct.Month = timeinfo->tm_mon + 1;
bogdanm 0:9b334a45a8ff 214 dateStruct.Date = timeinfo->tm_mday;
bogdanm 0:9b334a45a8ff 215 dateStruct.Year = timeinfo->tm_year - 100;
bogdanm 0:9b334a45a8ff 216 timeStruct.Hours = timeinfo->tm_hour;
bogdanm 0:9b334a45a8ff 217 timeStruct.Minutes = timeinfo->tm_min;
bogdanm 0:9b334a45a8ff 218 timeStruct.Seconds = timeinfo->tm_sec;
bogdanm 0:9b334a45a8ff 219 timeStruct.TimeFormat = RTC_HOURFORMAT12_PM;
bogdanm 0:9b334a45a8ff 220 timeStruct.DayLightSaving = RTC_DAYLIGHTSAVING_NONE;
bogdanm 0:9b334a45a8ff 221 timeStruct.StoreOperation = RTC_STOREOPERATION_RESET;
bogdanm 0:9b334a45a8ff 222
bogdanm 0:9b334a45a8ff 223 // Change the RTC current date/time
bogdanm 0:9b334a45a8ff 224 HAL_RTC_SetDate(&RtcHandle, &dateStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 225 HAL_RTC_SetTime(&RtcHandle, &timeStruct, FORMAT_BIN);
bogdanm 0:9b334a45a8ff 226 }
bogdanm 0:9b334a45a8ff 227
bogdanm 0:9b334a45a8ff 228 #endif