mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_LPC546XX/TOOLCHAIN_IAR/fsl_rtc.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * The Clear BSD License
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 4 * Copyright 2016-2017 NXP
AnnaBridge 171:3a7713b1edbc 5 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 171:3a7713b1edbc 9 * that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 12 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 16 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 171:3a7713b1edbc 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 20 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 171:3a7713b1edbc 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 33 */
AnnaBridge 171:3a7713b1edbc 34 #ifndef _FSL_RTC_H_
AnnaBridge 171:3a7713b1edbc 35 #define _FSL_RTC_H_
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 38
AnnaBridge 171:3a7713b1edbc 39 /*!
AnnaBridge 171:3a7713b1edbc 40 * @addtogroup rtc
AnnaBridge 171:3a7713b1edbc 41 * @{
AnnaBridge 171:3a7713b1edbc 42 */
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 /*! @file */
AnnaBridge 171:3a7713b1edbc 45
AnnaBridge 171:3a7713b1edbc 46 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 47 * Definitions
AnnaBridge 171:3a7713b1edbc 48 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 49
AnnaBridge 171:3a7713b1edbc 50 /*! @name Driver version */
AnnaBridge 171:3a7713b1edbc 51 /*@{*/
AnnaBridge 171:3a7713b1edbc 52 #define FSL_RTC_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Version 2.0.0 */
AnnaBridge 171:3a7713b1edbc 53 /*@}*/
AnnaBridge 171:3a7713b1edbc 54
AnnaBridge 171:3a7713b1edbc 55 /*! @brief List of RTC interrupts */
AnnaBridge 171:3a7713b1edbc 56 typedef enum _rtc_interrupt_enable
AnnaBridge 171:3a7713b1edbc 57 {
AnnaBridge 171:3a7713b1edbc 58 kRTC_AlarmInterruptEnable = RTC_CTRL_ALARMDPD_EN_MASK, /*!< Alarm interrupt.*/
AnnaBridge 171:3a7713b1edbc 59 kRTC_WakeupInterruptEnable = RTC_CTRL_WAKEDPD_EN_MASK /*!< Wake-up interrupt.*/
AnnaBridge 171:3a7713b1edbc 60 } rtc_interrupt_enable_t;
AnnaBridge 171:3a7713b1edbc 61
AnnaBridge 171:3a7713b1edbc 62 /*! @brief List of RTC flags */
AnnaBridge 171:3a7713b1edbc 63 typedef enum _rtc_status_flags
AnnaBridge 171:3a7713b1edbc 64 {
AnnaBridge 171:3a7713b1edbc 65 kRTC_AlarmFlag = RTC_CTRL_ALARM1HZ_MASK, /*!< Alarm flag*/
AnnaBridge 171:3a7713b1edbc 66 kRTC_WakeupFlag = RTC_CTRL_WAKE1KHZ_MASK /*!< 1kHz wake-up timer flag*/
AnnaBridge 171:3a7713b1edbc 67 } rtc_status_flags_t;
AnnaBridge 171:3a7713b1edbc 68
AnnaBridge 171:3a7713b1edbc 69 /*! @brief Structure is used to hold the date and time */
AnnaBridge 171:3a7713b1edbc 70 typedef struct _rtc_datetime
AnnaBridge 171:3a7713b1edbc 71 {
AnnaBridge 171:3a7713b1edbc 72 uint16_t year; /*!< Range from 1970 to 2099.*/
AnnaBridge 171:3a7713b1edbc 73 uint8_t month; /*!< Range from 1 to 12.*/
AnnaBridge 171:3a7713b1edbc 74 uint8_t day; /*!< Range from 1 to 31 (depending on month).*/
AnnaBridge 171:3a7713b1edbc 75 uint8_t hour; /*!< Range from 0 to 23.*/
AnnaBridge 171:3a7713b1edbc 76 uint8_t minute; /*!< Range from 0 to 59.*/
AnnaBridge 171:3a7713b1edbc 77 uint8_t second; /*!< Range from 0 to 59.*/
AnnaBridge 171:3a7713b1edbc 78 } rtc_datetime_t;
AnnaBridge 171:3a7713b1edbc 79
AnnaBridge 171:3a7713b1edbc 80 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 81 * API
AnnaBridge 171:3a7713b1edbc 82 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 83
AnnaBridge 171:3a7713b1edbc 84 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 85 extern "C" {
AnnaBridge 171:3a7713b1edbc 86 #endif
AnnaBridge 171:3a7713b1edbc 87
AnnaBridge 171:3a7713b1edbc 88 /*!
AnnaBridge 171:3a7713b1edbc 89 * @name Initialization and deinitialization
AnnaBridge 171:3a7713b1edbc 90 * @{
AnnaBridge 171:3a7713b1edbc 91 */
AnnaBridge 171:3a7713b1edbc 92
AnnaBridge 171:3a7713b1edbc 93 /*!
AnnaBridge 171:3a7713b1edbc 94 * @brief Ungates the RTC clock and enables the RTC oscillator.
AnnaBridge 171:3a7713b1edbc 95 *
AnnaBridge 171:3a7713b1edbc 96 * @note This API should be called at the beginning of the application using the RTC driver.
AnnaBridge 171:3a7713b1edbc 97 *
AnnaBridge 171:3a7713b1edbc 98 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 99 */
AnnaBridge 171:3a7713b1edbc 100 void RTC_Init(RTC_Type *base);
AnnaBridge 171:3a7713b1edbc 101
AnnaBridge 171:3a7713b1edbc 102 /*!
AnnaBridge 171:3a7713b1edbc 103 * @brief Stop the timer and gate the RTC clock
AnnaBridge 171:3a7713b1edbc 104 *
AnnaBridge 171:3a7713b1edbc 105 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 106 */
AnnaBridge 171:3a7713b1edbc 107 static inline void RTC_Deinit(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 108 {
AnnaBridge 171:3a7713b1edbc 109 /* Stop the RTC timer */
AnnaBridge 171:3a7713b1edbc 110 base->CTRL &= ~RTC_CTRL_RTC_EN_MASK;
AnnaBridge 171:3a7713b1edbc 111
AnnaBridge 171:3a7713b1edbc 112 #if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL)
AnnaBridge 171:3a7713b1edbc 113 /* Gate the module clock */
AnnaBridge 171:3a7713b1edbc 114 CLOCK_DisableClock(kCLOCK_Rtc);
AnnaBridge 171:3a7713b1edbc 115 #endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */
AnnaBridge 171:3a7713b1edbc 116 }
AnnaBridge 171:3a7713b1edbc 117
AnnaBridge 171:3a7713b1edbc 118 /*! @}*/
AnnaBridge 171:3a7713b1edbc 119
AnnaBridge 171:3a7713b1edbc 120 /*!
AnnaBridge 171:3a7713b1edbc 121 * @name Current Time & Alarm
AnnaBridge 171:3a7713b1edbc 122 * @{
AnnaBridge 171:3a7713b1edbc 123 */
AnnaBridge 171:3a7713b1edbc 124
AnnaBridge 171:3a7713b1edbc 125 /*!
AnnaBridge 171:3a7713b1edbc 126 * @brief Sets the RTC date and time according to the given time structure.
AnnaBridge 171:3a7713b1edbc 127 *
AnnaBridge 171:3a7713b1edbc 128 * The RTC counter must be stopped prior to calling this function as writes to the RTC
AnnaBridge 171:3a7713b1edbc 129 * seconds register will fail if the RTC counter is running.
AnnaBridge 171:3a7713b1edbc 130 *
AnnaBridge 171:3a7713b1edbc 131 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 132 * @param datetime Pointer to structure where the date and time details to set are stored
AnnaBridge 171:3a7713b1edbc 133 *
AnnaBridge 171:3a7713b1edbc 134 * @return kStatus_Success: Success in setting the time and starting the RTC
AnnaBridge 171:3a7713b1edbc 135 * kStatus_InvalidArgument: Error because the datetime format is incorrect
AnnaBridge 171:3a7713b1edbc 136 */
AnnaBridge 171:3a7713b1edbc 137 status_t RTC_SetDatetime(RTC_Type *base, const rtc_datetime_t *datetime);
AnnaBridge 171:3a7713b1edbc 138
AnnaBridge 171:3a7713b1edbc 139 /*!
AnnaBridge 171:3a7713b1edbc 140 * @brief Gets the RTC time and stores it in the given time structure.
AnnaBridge 171:3a7713b1edbc 141 *
AnnaBridge 171:3a7713b1edbc 142 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 143 * @param datetime Pointer to structure where the date and time details are stored.
AnnaBridge 171:3a7713b1edbc 144 */
AnnaBridge 171:3a7713b1edbc 145 void RTC_GetDatetime(RTC_Type *base, rtc_datetime_t *datetime);
AnnaBridge 171:3a7713b1edbc 146
AnnaBridge 171:3a7713b1edbc 147 /*!
AnnaBridge 171:3a7713b1edbc 148 * @brief Sets the RTC alarm time
AnnaBridge 171:3a7713b1edbc 149 *
AnnaBridge 171:3a7713b1edbc 150 * The function checks whether the specified alarm time is greater than the present
AnnaBridge 171:3a7713b1edbc 151 * time. If not, the function does not set the alarm and returns an error.
AnnaBridge 171:3a7713b1edbc 152 *
AnnaBridge 171:3a7713b1edbc 153 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 154 * @param alarmTime Pointer to structure where the alarm time is stored.
AnnaBridge 171:3a7713b1edbc 155 *
AnnaBridge 171:3a7713b1edbc 156 * @return kStatus_Success: success in setting the RTC alarm
AnnaBridge 171:3a7713b1edbc 157 * kStatus_InvalidArgument: Error because the alarm datetime format is incorrect
AnnaBridge 171:3a7713b1edbc 158 * kStatus_Fail: Error because the alarm time has already passed
AnnaBridge 171:3a7713b1edbc 159 */
AnnaBridge 171:3a7713b1edbc 160 status_t RTC_SetAlarm(RTC_Type *base, const rtc_datetime_t *alarmTime);
AnnaBridge 171:3a7713b1edbc 161
AnnaBridge 171:3a7713b1edbc 162 /*!
AnnaBridge 171:3a7713b1edbc 163 * @brief Returns the RTC alarm time.
AnnaBridge 171:3a7713b1edbc 164 *
AnnaBridge 171:3a7713b1edbc 165 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 166 * @param datetime Pointer to structure where the alarm date and time details are stored.
AnnaBridge 171:3a7713b1edbc 167 */
AnnaBridge 171:3a7713b1edbc 168 void RTC_GetAlarm(RTC_Type *base, rtc_datetime_t *datetime);
AnnaBridge 171:3a7713b1edbc 169
AnnaBridge 171:3a7713b1edbc 170 /*! @}*/
AnnaBridge 171:3a7713b1edbc 171
AnnaBridge 171:3a7713b1edbc 172 /*!
AnnaBridge 171:3a7713b1edbc 173 * @brief Enable the RTC high resolution timer and set the wake-up time.
AnnaBridge 171:3a7713b1edbc 174 *
AnnaBridge 171:3a7713b1edbc 175 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 176 * @param wakeupValue The value to be loaded into the RTC WAKE register
AnnaBridge 171:3a7713b1edbc 177 */
AnnaBridge 171:3a7713b1edbc 178 static inline void RTC_SetWakeupCount(RTC_Type *base, uint16_t wakeupValue)
AnnaBridge 171:3a7713b1edbc 179 {
AnnaBridge 171:3a7713b1edbc 180 /* Enable the 1kHz RTC timer */
AnnaBridge 171:3a7713b1edbc 181 base->CTRL |= RTC_CTRL_RTC1KHZ_EN_MASK;
AnnaBridge 171:3a7713b1edbc 182
AnnaBridge 171:3a7713b1edbc 183 /* Set the start count value into the wake-up timer */
AnnaBridge 171:3a7713b1edbc 184 base->WAKE = wakeupValue;
AnnaBridge 171:3a7713b1edbc 185 }
AnnaBridge 171:3a7713b1edbc 186
AnnaBridge 171:3a7713b1edbc 187 /*!
AnnaBridge 171:3a7713b1edbc 188 * @brief Read actual RTC counter value.
AnnaBridge 171:3a7713b1edbc 189 *
AnnaBridge 171:3a7713b1edbc 190 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 191 */
AnnaBridge 171:3a7713b1edbc 192 static inline uint16_t RTC_GetWakeupCount(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 193 {
AnnaBridge 171:3a7713b1edbc 194 /* Read wake-up counter */
AnnaBridge 171:3a7713b1edbc 195 return RTC_WAKE_VAL(base->WAKE);
AnnaBridge 171:3a7713b1edbc 196 }
AnnaBridge 171:3a7713b1edbc 197
AnnaBridge 171:3a7713b1edbc 198 /*!
AnnaBridge 171:3a7713b1edbc 199 * @name Interrupt Interface
AnnaBridge 171:3a7713b1edbc 200 * @{
AnnaBridge 171:3a7713b1edbc 201 */
AnnaBridge 171:3a7713b1edbc 202
AnnaBridge 171:3a7713b1edbc 203 /*!
AnnaBridge 171:3a7713b1edbc 204 * @brief Enables the selected RTC interrupts.
AnnaBridge 171:3a7713b1edbc 205 *
AnnaBridge 171:3a7713b1edbc 206 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 207 * @param mask The interrupts to enable. This is a logical OR of members of the
AnnaBridge 171:3a7713b1edbc 208 * enumeration ::rtc_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 209 */
AnnaBridge 171:3a7713b1edbc 210 static inline void RTC_EnableInterrupts(RTC_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 211 {
AnnaBridge 171:3a7713b1edbc 212 uint32_t reg = base->CTRL;
AnnaBridge 171:3a7713b1edbc 213
AnnaBridge 171:3a7713b1edbc 214 /* Clear flag bits to prevent accidentally clearing anything when writing back */
AnnaBridge 171:3a7713b1edbc 215 reg &= ~(RTC_CTRL_ALARM1HZ_MASK | RTC_CTRL_WAKE1KHZ_MASK);
AnnaBridge 171:3a7713b1edbc 216 reg |= mask;
AnnaBridge 171:3a7713b1edbc 217
AnnaBridge 171:3a7713b1edbc 218 base->CTRL = reg;
AnnaBridge 171:3a7713b1edbc 219 }
AnnaBridge 171:3a7713b1edbc 220
AnnaBridge 171:3a7713b1edbc 221 /*!
AnnaBridge 171:3a7713b1edbc 222 * @brief Disables the selected RTC interrupts.
AnnaBridge 171:3a7713b1edbc 223 *
AnnaBridge 171:3a7713b1edbc 224 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 225 * @param mask The interrupts to enable. This is a logical OR of members of the
AnnaBridge 171:3a7713b1edbc 226 * enumeration ::rtc_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 227 */
AnnaBridge 171:3a7713b1edbc 228 static inline void RTC_DisableInterrupts(RTC_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 229 {
AnnaBridge 171:3a7713b1edbc 230 uint32_t reg = base->CTRL;
AnnaBridge 171:3a7713b1edbc 231
AnnaBridge 171:3a7713b1edbc 232 /* Clear flag bits to prevent accidentally clearing anything when writing back */
AnnaBridge 171:3a7713b1edbc 233 reg &= ~(RTC_CTRL_ALARM1HZ_MASK | RTC_CTRL_WAKE1KHZ_MASK | mask);
AnnaBridge 171:3a7713b1edbc 234
AnnaBridge 171:3a7713b1edbc 235 base->CTRL = reg;
AnnaBridge 171:3a7713b1edbc 236 }
AnnaBridge 171:3a7713b1edbc 237
AnnaBridge 171:3a7713b1edbc 238 /*!
AnnaBridge 171:3a7713b1edbc 239 * @brief Gets the enabled RTC interrupts.
AnnaBridge 171:3a7713b1edbc 240 *
AnnaBridge 171:3a7713b1edbc 241 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 242 *
AnnaBridge 171:3a7713b1edbc 243 * @return The enabled interrupts. This is the logical OR of members of the
AnnaBridge 171:3a7713b1edbc 244 * enumeration ::rtc_interrupt_enable_t
AnnaBridge 171:3a7713b1edbc 245 */
AnnaBridge 171:3a7713b1edbc 246 static inline uint32_t RTC_GetEnabledInterrupts(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 247 {
AnnaBridge 171:3a7713b1edbc 248 return (base->CTRL & (RTC_CTRL_ALARMDPD_EN_MASK | RTC_CTRL_WAKEDPD_EN_MASK));
AnnaBridge 171:3a7713b1edbc 249 }
AnnaBridge 171:3a7713b1edbc 250
AnnaBridge 171:3a7713b1edbc 251 /*! @}*/
AnnaBridge 171:3a7713b1edbc 252
AnnaBridge 171:3a7713b1edbc 253 /*!
AnnaBridge 171:3a7713b1edbc 254 * @name Status Interface
AnnaBridge 171:3a7713b1edbc 255 * @{
AnnaBridge 171:3a7713b1edbc 256 */
AnnaBridge 171:3a7713b1edbc 257
AnnaBridge 171:3a7713b1edbc 258 /*!
AnnaBridge 171:3a7713b1edbc 259 * @brief Gets the RTC status flags
AnnaBridge 171:3a7713b1edbc 260 *
AnnaBridge 171:3a7713b1edbc 261 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 262 *
AnnaBridge 171:3a7713b1edbc 263 * @return The status flags. This is the logical OR of members of the
AnnaBridge 171:3a7713b1edbc 264 * enumeration ::rtc_status_flags_t
AnnaBridge 171:3a7713b1edbc 265 */
AnnaBridge 171:3a7713b1edbc 266 static inline uint32_t RTC_GetStatusFlags(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 267 {
AnnaBridge 171:3a7713b1edbc 268 return (base->CTRL & (RTC_CTRL_ALARM1HZ_MASK | RTC_CTRL_WAKE1KHZ_MASK));
AnnaBridge 171:3a7713b1edbc 269 }
AnnaBridge 171:3a7713b1edbc 270
AnnaBridge 171:3a7713b1edbc 271 /*!
AnnaBridge 171:3a7713b1edbc 272 * @brief Clears the RTC status flags.
AnnaBridge 171:3a7713b1edbc 273 *
AnnaBridge 171:3a7713b1edbc 274 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 275 * @param mask The status flags to clear. This is a logical OR of members of the
AnnaBridge 171:3a7713b1edbc 276 * enumeration ::rtc_status_flags_t
AnnaBridge 171:3a7713b1edbc 277 */
AnnaBridge 171:3a7713b1edbc 278 static inline void RTC_ClearStatusFlags(RTC_Type *base, uint32_t mask)
AnnaBridge 171:3a7713b1edbc 279 {
AnnaBridge 171:3a7713b1edbc 280 uint32_t reg = base->CTRL;
AnnaBridge 171:3a7713b1edbc 281
AnnaBridge 171:3a7713b1edbc 282 /* Clear flag bits to prevent accidentally clearing anything when writing back */
AnnaBridge 171:3a7713b1edbc 283 reg &= ~(RTC_CTRL_ALARM1HZ_MASK | RTC_CTRL_WAKE1KHZ_MASK);
AnnaBridge 171:3a7713b1edbc 284
AnnaBridge 171:3a7713b1edbc 285 /* Write 1 to the flags we wish to clear */
AnnaBridge 171:3a7713b1edbc 286 reg |= mask;
AnnaBridge 171:3a7713b1edbc 287
AnnaBridge 171:3a7713b1edbc 288 base->CTRL = reg;
AnnaBridge 171:3a7713b1edbc 289 }
AnnaBridge 171:3a7713b1edbc 290
AnnaBridge 171:3a7713b1edbc 291 /*! @}*/
AnnaBridge 171:3a7713b1edbc 292
AnnaBridge 171:3a7713b1edbc 293 /*!
AnnaBridge 171:3a7713b1edbc 294 * @name Timer Start and Stop
AnnaBridge 171:3a7713b1edbc 295 * @{
AnnaBridge 171:3a7713b1edbc 296 */
AnnaBridge 171:3a7713b1edbc 297
AnnaBridge 171:3a7713b1edbc 298 /*!
AnnaBridge 171:3a7713b1edbc 299 * @brief Starts the RTC time counter.
AnnaBridge 171:3a7713b1edbc 300 *
AnnaBridge 171:3a7713b1edbc 301 * After calling this function, the timer counter increments once a second provided SR[TOF] or
AnnaBridge 171:3a7713b1edbc 302 * SR[TIF] are not set.
AnnaBridge 171:3a7713b1edbc 303 *
AnnaBridge 171:3a7713b1edbc 304 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 305 */
AnnaBridge 171:3a7713b1edbc 306 static inline void RTC_StartTimer(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 307 {
AnnaBridge 171:3a7713b1edbc 308 base->CTRL |= RTC_CTRL_RTC_EN_MASK;
AnnaBridge 171:3a7713b1edbc 309 }
AnnaBridge 171:3a7713b1edbc 310
AnnaBridge 171:3a7713b1edbc 311 /*!
AnnaBridge 171:3a7713b1edbc 312 * @brief Stops the RTC time counter.
AnnaBridge 171:3a7713b1edbc 313 *
AnnaBridge 171:3a7713b1edbc 314 * RTC's seconds register can be written to only when the timer is stopped.
AnnaBridge 171:3a7713b1edbc 315 *
AnnaBridge 171:3a7713b1edbc 316 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 317 */
AnnaBridge 171:3a7713b1edbc 318 static inline void RTC_StopTimer(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 319 {
AnnaBridge 171:3a7713b1edbc 320 base->CTRL &= ~RTC_CTRL_RTC_EN_MASK;
AnnaBridge 171:3a7713b1edbc 321 }
AnnaBridge 171:3a7713b1edbc 322
AnnaBridge 171:3a7713b1edbc 323 /*! @}*/
AnnaBridge 171:3a7713b1edbc 324
AnnaBridge 171:3a7713b1edbc 325 /*!
AnnaBridge 171:3a7713b1edbc 326 * @brief Performs a software reset on the RTC module.
AnnaBridge 171:3a7713b1edbc 327 *
AnnaBridge 171:3a7713b1edbc 328 * This resets all RTC registers to their reset value. The bit is cleared by software explicitly clearing it.
AnnaBridge 171:3a7713b1edbc 329 *
AnnaBridge 171:3a7713b1edbc 330 * @param base RTC peripheral base address
AnnaBridge 171:3a7713b1edbc 331 */
AnnaBridge 171:3a7713b1edbc 332 static inline void RTC_Reset(RTC_Type *base)
AnnaBridge 171:3a7713b1edbc 333 {
AnnaBridge 171:3a7713b1edbc 334 base->CTRL |= RTC_CTRL_SWRESET_MASK;
AnnaBridge 171:3a7713b1edbc 335 base->CTRL &= ~RTC_CTRL_SWRESET_MASK;
AnnaBridge 171:3a7713b1edbc 336 }
AnnaBridge 171:3a7713b1edbc 337
AnnaBridge 171:3a7713b1edbc 338 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 339 }
AnnaBridge 171:3a7713b1edbc 340 #endif
AnnaBridge 171:3a7713b1edbc 341
AnnaBridge 171:3a7713b1edbc 342 /*! @}*/
AnnaBridge 171:3a7713b1edbc 343
AnnaBridge 171:3a7713b1edbc 344 #endif /* _FSL_RTC_H_ */