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_MAX32630FTHR/TOOLCHAIN_ARM_STD/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 * @file
AnnaBridge 171:3a7713b1edbc 3 * @brief Real-Time Clock data types, definitions and function prototypes.
AnnaBridge 171:3a7713b1edbc 4 */
AnnaBridge 171:3a7713b1edbc 5 /* ****************************************************************************
AnnaBridge 171:3a7713b1edbc 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 9 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 10 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 12 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 13 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 14 *
AnnaBridge 171:3a7713b1edbc 15 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 16 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 24 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 25 *
AnnaBridge 171:3a7713b1edbc 26 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 28 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 29 *
AnnaBridge 171:3a7713b1edbc 30 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 31 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 32 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 34 * ownership rights.
AnnaBridge 171:3a7713b1edbc 35 *
AnnaBridge 171:3a7713b1edbc 36 * $Date: 2016-10-10 19:28:26 -0500 (Mon, 10 Oct 2016) $
AnnaBridge 171:3a7713b1edbc 37 * $Revision: 24670 $
AnnaBridge 171:3a7713b1edbc 38 *
AnnaBridge 171:3a7713b1edbc 39 **************************************************************************** */
AnnaBridge 171:3a7713b1edbc 40
AnnaBridge 171:3a7713b1edbc 41 /* Define to prevent redundant inclusion */
AnnaBridge 171:3a7713b1edbc 42 #ifndef _RTC_H_
AnnaBridge 171:3a7713b1edbc 43 #define _RTC_H_
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /* **** Includes **** */
AnnaBridge 171:3a7713b1edbc 46 #include "mxc_config.h"
AnnaBridge 171:3a7713b1edbc 47 #include "rtc_regs.h"
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 50 extern "C" {
AnnaBridge 171:3a7713b1edbc 51 #endif
AnnaBridge 171:3a7713b1edbc 52
AnnaBridge 171:3a7713b1edbc 53 /**
AnnaBridge 171:3a7713b1edbc 54 * @ingroup periphlibs
AnnaBridge 171:3a7713b1edbc 55 * @defgroup rtc Real-Time Clock (RTC)
AnnaBridge 171:3a7713b1edbc 56 * @brief Functions, types, and registers for the Real-Time Clock Peripheral.
AnnaBridge 171:3a7713b1edbc 57 * @{
AnnaBridge 171:3a7713b1edbc 58 */
AnnaBridge 171:3a7713b1edbc 59
AnnaBridge 171:3a7713b1edbc 60 /* **** Definitions **** */
AnnaBridge 171:3a7713b1edbc 61 /**
AnnaBridge 171:3a7713b1edbc 62 * Enumeration type for scaling down the 4096Hz input clock to the RTC.
AnnaBridge 171:3a7713b1edbc 63 */
AnnaBridge 171:3a7713b1edbc 64 typedef enum {
AnnaBridge 171:3a7713b1edbc 65 RTC_PRESCALE_DIV_2_0 = MXC_V_RTC_PRESCALE_DIV_2_0, /**< \f$ f_{RTC} = \frac {4096} {2^{0}} = 4096Hz \f$ */
AnnaBridge 171:3a7713b1edbc 66 RTC_PRESCALE_DIV_2_1 = MXC_V_RTC_PRESCALE_DIV_2_1, /**< \f$ f_{RTC} = \frac {4096} {2^{1}} = 2048Hz \f$ */
AnnaBridge 171:3a7713b1edbc 67 RTC_PRESCALE_DIV_2_2 = MXC_V_RTC_PRESCALE_DIV_2_2, /**< \f$ f_{RTC} = \frac {4096} {2^{2}} = 1024Hz \f$ */
AnnaBridge 171:3a7713b1edbc 68 RTC_PRESCALE_DIV_2_3 = MXC_V_RTC_PRESCALE_DIV_2_3, /**< \f$ f_{RTC} = \frac {4096} {2^{3}} = 512Hz \f$ */
AnnaBridge 171:3a7713b1edbc 69 RTC_PRESCALE_DIV_2_4 = MXC_V_RTC_PRESCALE_DIV_2_4, /**< \f$ f_{RTC} = \frac {4096} {2^{4}} = 256Hz \f$ */
AnnaBridge 171:3a7713b1edbc 70 RTC_PRESCALE_DIV_2_5 = MXC_V_RTC_PRESCALE_DIV_2_5, /**< \f$ f_{RTC} = \frac {4096} {2^{5}} = 128Hz \f$ */
AnnaBridge 171:3a7713b1edbc 71 RTC_PRESCALE_DIV_2_6 = MXC_V_RTC_PRESCALE_DIV_2_6, /**< \f$ f_{RTC} = \frac {4096} {2^{6}} = 64Hz \f$ */
AnnaBridge 171:3a7713b1edbc 72 RTC_PRESCALE_DIV_2_7 = MXC_V_RTC_PRESCALE_DIV_2_7, /**< \f$ f_{RTC} = \frac {4096} {2^{7}} = 32Hz \f$ */
AnnaBridge 171:3a7713b1edbc 73 RTC_PRESCALE_DIV_2_8 = MXC_V_RTC_PRESCALE_DIV_2_8, /**< \f$ f_{RTC} = \frac {4096} {2^{8}} = 16Hz \f$ */
AnnaBridge 171:3a7713b1edbc 74 RTC_PRESCALE_DIV_2_9 = MXC_V_RTC_PRESCALE_DIV_2_9, /**< \f$ f_{RTC} = \frac {4096} {2^{9}} = 8Hz \f$ */
AnnaBridge 171:3a7713b1edbc 75 RTC_PRESCALE_DIV_2_10 = MXC_V_RTC_PRESCALE_DIV_2_10, /**< \f$ f_{RTC} = \frac {4096} {2^{10}} = 4Hz \f$ */
AnnaBridge 171:3a7713b1edbc 76 RTC_PRESCALE_DIV_2_11 = MXC_V_RTC_PRESCALE_DIV_2_11, /**< \f$ f_{RTC} = \frac {4096} {2^{11}} = 2Hz \f$ */
AnnaBridge 171:3a7713b1edbc 77 RTC_PRESCALE_DIV_2_12 = MXC_V_RTC_PRESCALE_DIV_2_12, /**< \f$ f_{RTC} = \frac {4096} {2^{12}} = 1Hz \f$ */
AnnaBridge 171:3a7713b1edbc 78 } rtc_prescale_t;
AnnaBridge 171:3a7713b1edbc 79
AnnaBridge 171:3a7713b1edbc 80 /**
AnnaBridge 171:3a7713b1edbc 81 * Mask of the RTC Flags for the Active Transaction.
AnnaBridge 171:3a7713b1edbc 82 */
AnnaBridge 171:3a7713b1edbc 83 #define RTC_CTRL_ACTIVE_TRANS (MXC_F_RTC_CTRL_RTC_ENABLE_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 84 MXC_F_RTC_CTRL_OSC_GOTO_LOW_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 85 MXC_F_RTC_CTRL_OSC_FRCE_SM_EN_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 86 MXC_F_RTC_CTRL_OSC_FRCE_ST_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 87 MXC_F_RTC_CTRL_RTC_SET_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 88 MXC_F_RTC_CTRL_RTC_CLR_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 89 MXC_F_RTC_CTRL_ROLLOVER_CLR_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 90 MXC_F_RTC_CTRL_PRESCALE_CMPR0_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 91 MXC_F_RTC_CTRL_PRESCALE_UPDATE_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 92 MXC_F_RTC_CTRL_CMPR1_CLR_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 93 MXC_F_RTC_CTRL_CMPR0_CLR_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 94 MXC_F_RTC_CTRL_TRIM_ENABLE_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 95 MXC_F_RTC_CTRL_TRIM_SLOWER_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 96 MXC_F_RTC_CTRL_TRIM_CLR_ACTIVE | \
AnnaBridge 171:3a7713b1edbc 97 MXC_F_RTC_CTRL_ACTIVE_TRANS_0)
AnnaBridge 171:3a7713b1edbc 98
AnnaBridge 171:3a7713b1edbc 99 /**
AnnaBridge 171:3a7713b1edbc 100 * Mask used to clear all RTC interrupt flags, see \ref RTC_FLAGS_Register Register.
AnnaBridge 171:3a7713b1edbc 101 */
AnnaBridge 171:3a7713b1edbc 102 #define RTC_FLAGS_CLEAR_ALL (MXC_F_RTC_FLAGS_COMP0 | \
AnnaBridge 171:3a7713b1edbc 103 MXC_F_RTC_FLAGS_COMP1| \
AnnaBridge 171:3a7713b1edbc 104 MXC_F_RTC_FLAGS_PRESCALE_COMP | \
AnnaBridge 171:3a7713b1edbc 105 MXC_F_RTC_FLAGS_OVERFLOW | \
AnnaBridge 171:3a7713b1edbc 106 MXC_F_RTC_FLAGS_TRIM)
AnnaBridge 171:3a7713b1edbc 107 /**
AnnaBridge 171:3a7713b1edbc 108 * Enumeration type to select the type of RTC Snooze Mode for an alarm condition.
AnnaBridge 171:3a7713b1edbc 109 */
AnnaBridge 171:3a7713b1edbc 110 typedef enum {
AnnaBridge 171:3a7713b1edbc 111 RTC_SNOOZE_DISABLE = MXC_V_RTC_CTRL_SNOOZE_DISABLE, /**< Snooze Mode Disabled */
AnnaBridge 171:3a7713b1edbc 112 RTC_SNOOZE_MODE_A = MXC_V_RTC_CTRL_SNOOZE_MODE_A, /**< \f$ COMP1 = COMP1 + RTC\_SNZ\_VALUE \f$ when snooze flag is set */
AnnaBridge 171:3a7713b1edbc 113 RTC_SNOOZE_MODE_B = MXC_V_RTC_CTRL_SNOOZE_MODE_B, /**< \f$ COMP1 = RTC\_TIMER + RTC\_SNZ\_VALUE \f$ when snooze flag is set */
AnnaBridge 171:3a7713b1edbc 114 } rtc_snooze_t;
AnnaBridge 171:3a7713b1edbc 115
AnnaBridge 171:3a7713b1edbc 116 /**
AnnaBridge 171:3a7713b1edbc 117 * Number of RTC Compare registers for this peripheral instance.
AnnaBridge 171:3a7713b1edbc 118 */
AnnaBridge 171:3a7713b1edbc 119 #define RTC_NUM_COMPARE 2
AnnaBridge 171:3a7713b1edbc 120
AnnaBridge 171:3a7713b1edbc 121 /**
AnnaBridge 171:3a7713b1edbc 122 * Structure type that represents the current configuration of the RTC.
AnnaBridge 171:3a7713b1edbc 123 */
AnnaBridge 171:3a7713b1edbc 124
AnnaBridge 171:3a7713b1edbc 125 typedef struct {
AnnaBridge 171:3a7713b1edbc 126 rtc_prescale_t prescaler; /**< prescale value for the input 4096Hz clock. */
AnnaBridge 171:3a7713b1edbc 127 rtc_prescale_t prescalerMask; /**< Mask value used to compare to the rtc prescale value, when the \f$ (Count_{prescaler}\,\&\,Prescale\,Mask) == 0 \f$, the prescale compare flag will be set. */
AnnaBridge 171:3a7713b1edbc 128 uint32_t compareCount[RTC_NUM_COMPARE]; /**< Values used for setting the RTC alarms. See RTC_SetCompare() and RTC_GetCompare(). */
AnnaBridge 171:3a7713b1edbc 129 uint32_t snoozeCount; /**< The number of RTC ticks to snooze if enabled. */
AnnaBridge 171:3a7713b1edbc 130 rtc_snooze_t snoozeMode; /**< The desired snooze mode, see #rtc_snooze_t. */
AnnaBridge 171:3a7713b1edbc 131 } rtc_cfg_t;
AnnaBridge 171:3a7713b1edbc 132
AnnaBridge 171:3a7713b1edbc 133 /**
AnnaBridge 171:3a7713b1edbc 134 * @brief Initializes the RTC
AnnaBridge 171:3a7713b1edbc 135 * @note Must setup clocking and power prior to this function.
AnnaBridge 171:3a7713b1edbc 136 *
AnnaBridge 171:3a7713b1edbc 137 * @param cfg RTC configuration object.
AnnaBridge 171:3a7713b1edbc 138 *
AnnaBridge 171:3a7713b1edbc 139 * @retval #E_NO_ERROR RTC initialized successfully.
AnnaBridge 171:3a7713b1edbc 140 * @retval #E_NULL_PTR \p cfg pointer is NULL.
AnnaBridge 171:3a7713b1edbc 141 * @retval #E_INVALID if comparison index, prescaler mask or snooze mask
AnnaBridge 171:3a7713b1edbc 142 * are out of bounds, see #rtc_cfg_t.
AnnaBridge 171:3a7713b1edbc 143 */
AnnaBridge 171:3a7713b1edbc 144 int RTC_Init(const rtc_cfg_t *cfg);
AnnaBridge 171:3a7713b1edbc 145
AnnaBridge 171:3a7713b1edbc 146 /**
AnnaBridge 171:3a7713b1edbc 147 * @brief Enable and start the real-time clock continuing from its current value.
AnnaBridge 171:3a7713b1edbc 148 */
AnnaBridge 171:3a7713b1edbc 149 __STATIC_INLINE void RTC_Start(void)
AnnaBridge 171:3a7713b1edbc 150 {
AnnaBridge 171:3a7713b1edbc 151 MXC_RTCTMR->ctrl |= MXC_F_RTC_CTRL_ENABLE;
AnnaBridge 171:3a7713b1edbc 152
AnnaBridge 171:3a7713b1edbc 153 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 154 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 155 }
AnnaBridge 171:3a7713b1edbc 156
AnnaBridge 171:3a7713b1edbc 157 /**
AnnaBridge 171:3a7713b1edbc 158 * @brief Disable and stop the real-time clock counting.
AnnaBridge 171:3a7713b1edbc 159 */
AnnaBridge 171:3a7713b1edbc 160 __STATIC_INLINE void RTC_Stop(void)
AnnaBridge 171:3a7713b1edbc 161 {
AnnaBridge 171:3a7713b1edbc 162 MXC_RTCTMR->ctrl &= ~(MXC_F_RTC_CTRL_ENABLE);
AnnaBridge 171:3a7713b1edbc 163
AnnaBridge 171:3a7713b1edbc 164 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 165 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 166 }
AnnaBridge 171:3a7713b1edbc 167
AnnaBridge 171:3a7713b1edbc 168 /**
AnnaBridge 171:3a7713b1edbc 169 * @brief Returns the state (running or disabled) for the RTC.
AnnaBridge 171:3a7713b1edbc 170 *
AnnaBridge 171:3a7713b1edbc 171 * @retval 0 Disabled.
AnnaBridge 171:3a7713b1edbc 172 * @retval Non-zero Active.
AnnaBridge 171:3a7713b1edbc 173 */
AnnaBridge 171:3a7713b1edbc 174 __STATIC_INLINE uint32_t RTC_IsActive(void)
AnnaBridge 171:3a7713b1edbc 175 {
AnnaBridge 171:3a7713b1edbc 176 return (MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_ENABLE);
AnnaBridge 171:3a7713b1edbc 177 }
AnnaBridge 171:3a7713b1edbc 178
AnnaBridge 171:3a7713b1edbc 179 /**
AnnaBridge 171:3a7713b1edbc 180 * @brief Set the current count of the RTC
AnnaBridge 171:3a7713b1edbc 181 *
AnnaBridge 171:3a7713b1edbc 182 * @param count The desired count value to set for the RTC count.
AnnaBridge 171:3a7713b1edbc 183 */
AnnaBridge 171:3a7713b1edbc 184 __STATIC_INLINE void RTC_SetCount(uint32_t count)
AnnaBridge 171:3a7713b1edbc 185 {
AnnaBridge 171:3a7713b1edbc 186 MXC_RTCTMR->timer = count;
AnnaBridge 171:3a7713b1edbc 187
AnnaBridge 171:3a7713b1edbc 188 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 189 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 190 }
AnnaBridge 171:3a7713b1edbc 191
AnnaBridge 171:3a7713b1edbc 192 /**
AnnaBridge 171:3a7713b1edbc 193 * @brief Get the current count value of the RTC.
AnnaBridge 171:3a7713b1edbc 194 *
AnnaBridge 171:3a7713b1edbc 195 * @retval The value of the RTC counter.
AnnaBridge 171:3a7713b1edbc 196 */
AnnaBridge 171:3a7713b1edbc 197 __STATIC_INLINE uint32_t RTC_GetCount(void)
AnnaBridge 171:3a7713b1edbc 198 {
AnnaBridge 171:3a7713b1edbc 199 return (MXC_RTCTMR->timer);
AnnaBridge 171:3a7713b1edbc 200 }
AnnaBridge 171:3a7713b1edbc 201
AnnaBridge 171:3a7713b1edbc 202 /**
AnnaBridge 171:3a7713b1edbc 203 * @brief Sets the compare value for the RTC.
AnnaBridge 171:3a7713b1edbc 204 *
AnnaBridge 171:3a7713b1edbc 205 * @param compareIndex Index of comparator to set, see #RTC_NUM_COMPARE
AnnaBridge 171:3a7713b1edbc 206 * for the total number of compare registers
AnnaBridge 171:3a7713b1edbc 207 * available.
AnnaBridge 171:3a7713b1edbc 208 * @param counts The value to set for the compare.
AnnaBridge 171:3a7713b1edbc 209 * @retval #E_NO_ERROR Compare count register set successfully for
AnnaBridge 171:3a7713b1edbc 210 * requested comparator.
AnnaBridge 171:3a7713b1edbc 211 * @retval #E_INVALID compareIndex is @>= RTC_NUM_COMPARE.
AnnaBridge 171:3a7713b1edbc 212 */
AnnaBridge 171:3a7713b1edbc 213 int RTC_SetCompare(uint8_t compareIndex, uint32_t counts);
AnnaBridge 171:3a7713b1edbc 214
AnnaBridge 171:3a7713b1edbc 215 /**
AnnaBridge 171:3a7713b1edbc 216 * @brief Gets the compare value for the RTC.
AnnaBridge 171:3a7713b1edbc 217 *
AnnaBridge 171:3a7713b1edbc 218 * @param compareIndex Index of the compare value to return. See #RTC_NUM_COMPARE
AnnaBridge 171:3a7713b1edbc 219 * for the total number of compare registers available.
AnnaBridge 171:3a7713b1edbc 220 *
AnnaBridge 171:3a7713b1edbc 221 * @returns The current value of the specified compare register for the RTC.
AnnaBridge 171:3a7713b1edbc 222 */
AnnaBridge 171:3a7713b1edbc 223 uint32_t RTC_GetCompare(uint8_t compareIndex);
AnnaBridge 171:3a7713b1edbc 224
AnnaBridge 171:3a7713b1edbc 225 /**
AnnaBridge 171:3a7713b1edbc 226 * @brief Set the prescale reload value for the real-time clock.
AnnaBridge 171:3a7713b1edbc 227 * @details The prescale reload value determines the number of 4kHz ticks
AnnaBridge 171:3a7713b1edbc 228 * that will occur before the timer is incremented.
AnnaBridge 171:3a7713b1edbc 229 * <table>
AnnaBridge 171:3a7713b1edbc 230 * <caption id="prescaler_val">Prescaler Settings and Corresponding RTC Resolutions</caption>
AnnaBridge 171:3a7713b1edbc 231 * <tr><th>PRESCALE <th>Prescale Reload <th>4kHz ticks in LSB <th>Min Timer Value (sec) <th> Max Timer Value (sec) <th>Max Timer Value (Days) <th> Max Timer Value (Years)
AnnaBridge 171:3a7713b1edbc 232 * <tr><td align="right">0h<td align="center">RTC_PRESCALE_DIV_2_0<td align="right">1<td align="right">0.00024<td align="right">1048576<td align="right">12<td align="right">0.0
AnnaBridge 171:3a7713b1edbc 233 * <tr><td align="right">1h<td align="center">RTC_PRESCALE_DIV_2_1<td align="right">2<td align="right">0.00049<td align="right">2097152<td align="right">24<td align="right">0.1
AnnaBridge 171:3a7713b1edbc 234 * <tr><td align="right">2h<td align="center">RTC_PRESCALE_DIV_2_2<td align="right">4<td align="right">0.00098<td align="right">4194304<td align="right">49<td align="right">0.1
AnnaBridge 171:3a7713b1edbc 235 * <tr><td align="right">3h<td align="center">RTC_PRESCALE_DIV_2_3<td align="right">8<td align="right">0.00195<td align="right">8388608<td align="right">97<td align="right">0.3
AnnaBridge 171:3a7713b1edbc 236 * <tr><td align="right">4h<td align="center">RTC_PRESCALE_DIV_2_4<td align="right">16<td align="right">0.00391<td align="right">16777216<td align="right">194 <td align="right">0.5
AnnaBridge 171:3a7713b1edbc 237 * <tr><td align="right">5h<td align="center">RTC_PRESCALE_DIV_2_5<td align="right">32<td align="right">0.00781<td align="right">33554432<td align="right">388 <td align="right">1.1
AnnaBridge 171:3a7713b1edbc 238 * <tr><td align="right">6h<td align="center">RTC_PRESCALE_DIV_2_6<td align="right">64<td align="right">0.01563<td align="right">67108864<td align="right">777 <td align="right">2.2
AnnaBridge 171:3a7713b1edbc 239 * <tr><td align="right">7h<td align="center">RTC_PRESCALE_DIV_2_7<td align="right">128<td align="right">0.03125<td align="right">134217728<td align="right">1553 <td align="right">4.4
AnnaBridge 171:3a7713b1edbc 240 * <tr><td align="right">8h<td align="center">RTC_PRESCALE_DIV_2_8<td align="right">256<td align="right">0.06250<td align="right">268435456<td align="right">3107 <td align="right">8.7
AnnaBridge 171:3a7713b1edbc 241 * <tr><td align="right">9h<td align="center">RTC_PRESCALE_DIV_2_9<td align="right">512<td align="right">0.12500<td align="right">536870912<td align="right">6214 <td align="right">17.5
AnnaBridge 171:3a7713b1edbc 242 * <tr><td align="right">Ah<td align="center">RTC_PRESCALE_DIV_2_10<td align="right">1024 <td align="right">0.25000<td align="right">1073741824<td align="right">12428<td align="right">34.9
AnnaBridge 171:3a7713b1edbc 243 * <tr><td align="right">Bh<td align="center">RTC_PRESCALE_DIV_2_11<td align="right">2048 <td align="right">0.50000<td align="right">2147483648<td align="right">24855<td align="right">69.8
AnnaBridge 171:3a7713b1edbc 244 * <tr><td align="right">Ch<td align="center">RTC_PRESCALE_DIV_2_12<td align="right">4096 <td align="right">1.00000<td align="right">4294967296<td align="right">49710<td align="right">139.6
AnnaBridge 171:3a7713b1edbc 245 * </table>
AnnaBridge 171:3a7713b1edbc 246 *
AnnaBridge 171:3a7713b1edbc 247 * @param prescaler Prescale value to set, see #rtc_prescale_t.
AnnaBridge 171:3a7713b1edbc 248 */
AnnaBridge 171:3a7713b1edbc 249 __STATIC_INLINE void RTC_SetPrescaler(rtc_prescale_t prescaler)
AnnaBridge 171:3a7713b1edbc 250 {
AnnaBridge 171:3a7713b1edbc 251 MXC_RTCTMR->prescale = prescaler;
AnnaBridge 171:3a7713b1edbc 252
AnnaBridge 171:3a7713b1edbc 253 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 254 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 255 }
AnnaBridge 171:3a7713b1edbc 256
AnnaBridge 171:3a7713b1edbc 257 /**
AnnaBridge 171:3a7713b1edbc 258 * @brief Get the current value of the real-time clock prescaler.
AnnaBridge 171:3a7713b1edbc 259 *
AnnaBridge 171:3a7713b1edbc 260 * @retval rtc_prescale_t Returns the current RTC prescaler setting,
AnnaBridge 171:3a7713b1edbc 261 * See #rtc_prescale_t for values of the prescaler.
AnnaBridge 171:3a7713b1edbc 262 */
AnnaBridge 171:3a7713b1edbc 263 __STATIC_INLINE rtc_prescale_t RTC_GetPrescaler(void)
AnnaBridge 171:3a7713b1edbc 264 {
AnnaBridge 171:3a7713b1edbc 265 return (rtc_prescale_t)(MXC_RTCTMR->prescale);
AnnaBridge 171:3a7713b1edbc 266 }
AnnaBridge 171:3a7713b1edbc 267
AnnaBridge 171:3a7713b1edbc 268 /**
AnnaBridge 171:3a7713b1edbc 269 * @brief Set the prescaler mask, which is used to set the RTC prescale counter
AnnaBridge 171:3a7713b1edbc 270 * compare flag when the prescaler timer matches the bits indicated
AnnaBridge 171:3a7713b1edbc 271 * by the mask.
AnnaBridge 171:3a7713b1edbc 272 * @param mask A bit mask that is used to set the prescale compare flag if the
AnnaBridge 171:3a7713b1edbc 273 * prescale timer has the corresponding bits set. @note This mask must
AnnaBridge 171:3a7713b1edbc 274 * be less than or equal to the prescaler reload value.
AnnaBridge 171:3a7713b1edbc 275 * See RTC_SetPrescaler()
AnnaBridge 171:3a7713b1edbc 276 * @details When \f$ Count_{prescaler}\,\&\,Prescale\,Mask = 0 \f$, the prescale compare flag is set
AnnaBridge 171:3a7713b1edbc 277 * @retval int Returns #E_NO_ERROR if prescale value is valid and is set.
AnnaBridge 171:3a7713b1edbc 278 * @retval int Returns #E_INVALID if mask is \> than prescaler value
AnnaBridge 171:3a7713b1edbc 279 */
AnnaBridge 171:3a7713b1edbc 280 __STATIC_INLINE int RTC_SetPrescalerMask(rtc_prescale_t mask)
AnnaBridge 171:3a7713b1edbc 281 {
AnnaBridge 171:3a7713b1edbc 282 if (mask > ((rtc_prescale_t)(MXC_RTCTMR->prescale)))
AnnaBridge 171:3a7713b1edbc 283 {
AnnaBridge 171:3a7713b1edbc 284 return E_INVALID;
AnnaBridge 171:3a7713b1edbc 285 }
AnnaBridge 171:3a7713b1edbc 286 MXC_RTCTMR->prescale_mask = mask;
AnnaBridge 171:3a7713b1edbc 287
AnnaBridge 171:3a7713b1edbc 288 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 289 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 290 return E_NO_ERROR;
AnnaBridge 171:3a7713b1edbc 291 }
AnnaBridge 171:3a7713b1edbc 292
AnnaBridge 171:3a7713b1edbc 293 /**
AnnaBridge 171:3a7713b1edbc 294 * @brief Set the count for snooze mode. See RTC_Snooze().
AnnaBridge 171:3a7713b1edbc 295 * @details This value is used to set the snooze count. The meaning of this value is dependant on the snooze mode. p
AnnaBridge 171:3a7713b1edbc 296 * See RTC_SetSnoozeMode() for details of calculating the snooze time period based on the mode and snooze count.
AnnaBridge 171:3a7713b1edbc 297 * @param count Sets the count used for snooze when snooze mode is
AnnaBridge 171:3a7713b1edbc 298 * enabled and the snooze flag is set.
AnnaBridge 171:3a7713b1edbc 299 * @retval #E_NO_ERROR Snooze value is set correctly and value is valid.
AnnaBridge 171:3a7713b1edbc 300 * @retval #E_INVALID SnoozeCount exceeds maximum supported, see
AnnaBridge 171:3a7713b1edbc 301 * MXC_F_RTC_SNZ_VAL_VALUE
AnnaBridge 171:3a7713b1edbc 302 */
AnnaBridge 171:3a7713b1edbc 303 __STATIC_INLINE int RTC_SetSnoozeCount(uint32_t count)
AnnaBridge 171:3a7713b1edbc 304 {
AnnaBridge 171:3a7713b1edbc 305 // Check to make sure max value is not being exceeded
AnnaBridge 171:3a7713b1edbc 306 if (count > MXC_F_RTC_SNZ_VAL_VALUE)
AnnaBridge 171:3a7713b1edbc 307 return E_INVALID;
AnnaBridge 171:3a7713b1edbc 308
AnnaBridge 171:3a7713b1edbc 309 MXC_RTCTMR->snz_val = count;
AnnaBridge 171:3a7713b1edbc 310
AnnaBridge 171:3a7713b1edbc 311 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 312 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 313 return E_NO_ERROR;
AnnaBridge 171:3a7713b1edbc 314 }
AnnaBridge 171:3a7713b1edbc 315
AnnaBridge 171:3a7713b1edbc 316 /**
AnnaBridge 171:3a7713b1edbc 317 * @brief Gets the current Snooze Count value.
AnnaBridge 171:3a7713b1edbc 318 * @details Returns the current value for the Snooze Count. This value is
AnnaBridge 171:3a7713b1edbc 319 * used as part of the snooze calculation depending on the snooze
AnnaBridge 171:3a7713b1edbc 320 * mode. See RTC_SetSnoozeMode() for details of calculating the
AnnaBridge 171:3a7713b1edbc 321 * snooze time period based on the mode and count.
AnnaBridge 171:3a7713b1edbc 322 * @return Value of the snooze register.
AnnaBridge 171:3a7713b1edbc 323 */
AnnaBridge 171:3a7713b1edbc 324 __STATIC_INLINE uint32_t RTC_GetSnoozeCount(void)
AnnaBridge 171:3a7713b1edbc 325 {
AnnaBridge 171:3a7713b1edbc 326 return MXC_RTCTMR->snz_val;
AnnaBridge 171:3a7713b1edbc 327 }
AnnaBridge 171:3a7713b1edbc 328
AnnaBridge 171:3a7713b1edbc 329 /**
AnnaBridge 171:3a7713b1edbc 330 * @brief Activates snooze mode.
AnnaBridge 171:3a7713b1edbc 331 * @details Begins a snooze of the RTC. When this function is called
AnnaBridge 171:3a7713b1edbc 332 * the snooze time period is determined based on the snooze mode and the count.
AnnaBridge 171:3a7713b1edbc 333 * See RTC_GetCount() and RTC_SetSnoozeMode()
AnnaBridge 171:3a7713b1edbc 334 */
AnnaBridge 171:3a7713b1edbc 335 __STATIC_INLINE void RTC_Snooze(void)
AnnaBridge 171:3a7713b1edbc 336 {
AnnaBridge 171:3a7713b1edbc 337 MXC_RTCTMR->flags = MXC_F_RTC_FLAGS_SNOOZE_A | MXC_F_RTC_FLAGS_SNOOZE_B;
AnnaBridge 171:3a7713b1edbc 338
AnnaBridge 171:3a7713b1edbc 339 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 340 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 341 }
AnnaBridge 171:3a7713b1edbc 342
AnnaBridge 171:3a7713b1edbc 343 /**
AnnaBridge 171:3a7713b1edbc 344 * @brief Sets the Snooze Mode.
AnnaBridge 171:3a7713b1edbc 345 * @details <table> <caption id="snoozeModesTable">Snooze Modes</caption>
AnnaBridge 171:3a7713b1edbc 346 * <tr><th>Mode<th>Snooze Time Calculation
AnnaBridge 171:3a7713b1edbc 347 * <tr><td>RTC_SNOOZE_DISABLE<td>Snooze Disabled
AnnaBridge 171:3a7713b1edbc 348 * <tr><td>RTC_SNOOZE_MODE_A<td>\f$ compare1 = compare1 + snoozeCount \f$
AnnaBridge 171:3a7713b1edbc 349 * <tr><td>RTC_SNOOZE_MODE_B<td>\f$ compare1 = count + snoozeCount \f$
AnnaBridge 171:3a7713b1edbc 350 * </table>
AnnaBridge 171:3a7713b1edbc 351 * @note @a count is the value of the RTC counter when RTC_Snooze()
AnnaBridge 171:3a7713b1edbc 352 * is called to start a snooze cycle and @a snoozeCount is the value set by the RTC_SetSnoozeCount(uint32_t count) function.
AnnaBridge 171:3a7713b1edbc 353 *
AnnaBridge 171:3a7713b1edbc 354 * @param mode Specifies the desired snooze mode, see #rtc_snooze_t.
AnnaBridge 171:3a7713b1edbc 355 *
AnnaBridge 171:3a7713b1edbc 356 */
AnnaBridge 171:3a7713b1edbc 357 __STATIC_INLINE void RTC_SetSnoozeMode(rtc_snooze_t mode)
AnnaBridge 171:3a7713b1edbc 358 {
AnnaBridge 171:3a7713b1edbc 359 uint32_t ctrl;
AnnaBridge 171:3a7713b1edbc 360 // Get the control register and mask off the non-snooze bits
AnnaBridge 171:3a7713b1edbc 361 ctrl = (MXC_RTCTMR->ctrl & ~(MXC_F_RTC_CTRL_SNOOZE_ENABLE));
AnnaBridge 171:3a7713b1edbc 362 // set the requested snooze mode bits and save the settings
AnnaBridge 171:3a7713b1edbc 363 MXC_RTCTMR->ctrl = (ctrl | (mode << MXC_F_RTC_CTRL_SNOOZE_ENABLE_POS));
AnnaBridge 171:3a7713b1edbc 364
AnnaBridge 171:3a7713b1edbc 365 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 366 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 367 }
AnnaBridge 171:3a7713b1edbc 368
AnnaBridge 171:3a7713b1edbc 369 /**
AnnaBridge 171:3a7713b1edbc 370 * @brief Enables the interrupts specified for the RTC.
AnnaBridge 171:3a7713b1edbc 371 * @details <table>
AnnaBridge 171:3a7713b1edbc 372 * <caption id="RTC_interrupts">RTC Interrupts</caption>
AnnaBridge 171:3a7713b1edbc 373 * <tr><th>Interrupt<th>Mask
AnnaBridge 171:3a7713b1edbc 374 * <tr><td>Compare 0<td>#MXC_F_RTC_INTEN_COMP0
AnnaBridge 171:3a7713b1edbc 375 * <tr><td>Compare 1 and Snooze<td>#MXC_F_RTC_INTEN_COMP1
AnnaBridge 171:3a7713b1edbc 376 * <tr><td>Prescale Comp<td>#MXC_F_RTC_INTEN_PRESCALE_COMP
AnnaBridge 171:3a7713b1edbc 377 * <tr><td>RTC Count Overflow<td>#MXC_F_RTC_INTEN_OVERFLOW
AnnaBridge 171:3a7713b1edbc 378 * <tr><td>Trim<td>#MXC_F_RTC_INTEN_TRIM
AnnaBridge 171:3a7713b1edbc 379 * </table>
AnnaBridge 171:3a7713b1edbc 380 * @param mask A mask of the RTC interrupts to enable, 1 = Enable. See
AnnaBridge 171:3a7713b1edbc 381 * @ref RTC_FLAGS_Register Register for the RTC interrupt enable bit masks and positions.
AnnaBridge 171:3a7713b1edbc 382 */
AnnaBridge 171:3a7713b1edbc 383 __STATIC_INLINE void RTC_EnableINT(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 384 {
AnnaBridge 171:3a7713b1edbc 385 MXC_RTCTMR->inten |= mask;
AnnaBridge 171:3a7713b1edbc 386 }
AnnaBridge 171:3a7713b1edbc 387
AnnaBridge 171:3a7713b1edbc 388 /**
AnnaBridge 171:3a7713b1edbc 389 * @brief Disable the interrupts specified for the RTC. See the
AnnaBridge 171:3a7713b1edbc 390 * @ref RTC_INTEN_Register Register for the RTC interrupt enable bit masks and positions.
AnnaBridge 171:3a7713b1edbc 391 *
AnnaBridge 171:3a7713b1edbc 392 * @param mask A mask of the RTC interrupts to disable, 1 = Disable.
AnnaBridge 171:3a7713b1edbc 393 */
AnnaBridge 171:3a7713b1edbc 394 __STATIC_INLINE void RTC_DisableINT(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 395 {
AnnaBridge 171:3a7713b1edbc 396 MXC_RTCTMR->inten &= ~mask;
AnnaBridge 171:3a7713b1edbc 397 }
AnnaBridge 171:3a7713b1edbc 398
AnnaBridge 171:3a7713b1edbc 399 /**
AnnaBridge 171:3a7713b1edbc 400 * @brief Returns the current interrupt flags that are set.
AnnaBridge 171:3a7713b1edbc 401 *
AnnaBridge 171:3a7713b1edbc 402 * @return A mask of the current interrupt flags, see the
AnnaBridge 171:3a7713b1edbc 403 * @ref RTC_FLAGS_Register Register for the details of the RTC interrupt
AnnaBridge 171:3a7713b1edbc 404 * flags.
AnnaBridge 171:3a7713b1edbc 405 */
AnnaBridge 171:3a7713b1edbc 406 __STATIC_INLINE uint32_t RTC_GetFlags(void)
AnnaBridge 171:3a7713b1edbc 407 {
AnnaBridge 171:3a7713b1edbc 408 return (MXC_RTCTMR->flags);
AnnaBridge 171:3a7713b1edbc 409 }
AnnaBridge 171:3a7713b1edbc 410
AnnaBridge 171:3a7713b1edbc 411 /**
AnnaBridge 171:3a7713b1edbc 412 * @brief Clears the interrupt flags specified.
AnnaBridge 171:3a7713b1edbc 413 *
AnnaBridge 171:3a7713b1edbc 414 * @param mask A mask of interrupts to clear, see the @ref RTC_FLAGS_Register
AnnaBridge 171:3a7713b1edbc 415 * Register for the interrupt flag bit masks and positions.
AnnaBridge 171:3a7713b1edbc 416 */
AnnaBridge 171:3a7713b1edbc 417 __STATIC_INLINE void RTC_ClearFlags(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 418 {
AnnaBridge 171:3a7713b1edbc 419 MXC_RTCTMR->flags = mask;
AnnaBridge 171:3a7713b1edbc 420
AnnaBridge 171:3a7713b1edbc 421 //wait for pending actions to complete
AnnaBridge 171:3a7713b1edbc 422 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
AnnaBridge 171:3a7713b1edbc 423 }
AnnaBridge 171:3a7713b1edbc 424
AnnaBridge 171:3a7713b1edbc 425 /**
AnnaBridge 171:3a7713b1edbc 426 * @brief Gets the active transaction flags, see @ref RTC_CTRL_Register Register for the list of ACTIVE flags.
AnnaBridge 171:3a7713b1edbc 427 *
AnnaBridge 171:3a7713b1edbc 428 * @retval 0 No active transactions.
AnnaBridge 171:3a7713b1edbc 429 * @retval nonzero A mask of active transaction bits.
AnnaBridge 171:3a7713b1edbc 430 */
AnnaBridge 171:3a7713b1edbc 431 __STATIC_INLINE uint32_t RTC_GetActiveTrans(void)
AnnaBridge 171:3a7713b1edbc 432 {
AnnaBridge 171:3a7713b1edbc 433 return (MXC_RTCTMR->ctrl & RTC_CTRL_ACTIVE_TRANS);
AnnaBridge 171:3a7713b1edbc 434 }
AnnaBridge 171:3a7713b1edbc 435
AnnaBridge 171:3a7713b1edbc 436 /**
AnnaBridge 171:3a7713b1edbc 437 * @brief Sets the trim value and trim slow/fast option.
AnnaBridge 171:3a7713b1edbc 438 * @warning The RTC must be disabled prior to calling this function, see RTC_Stop(void) to disable the RTC.
AnnaBridge 171:3a7713b1edbc 439 *
AnnaBridge 171:3a7713b1edbc 440 * @param trim The desired trim value. @note The maximum trim value setting is 0x03FFFF.
AnnaBridge 171:3a7713b1edbc 441 * @param trimSlow 1 = trim slow, 0 = trim fast
AnnaBridge 171:3a7713b1edbc 442 *
AnnaBridge 171:3a7713b1edbc 443 * @return #E_NO_ERROR Trim value is valid and set.
AnnaBridge 171:3a7713b1edbc 444 * @return #E_INVALID Trim value exceeds max trim.
AnnaBridge 171:3a7713b1edbc 445 * @return #E_BAD_STATE RTC is active.
AnnaBridge 171:3a7713b1edbc 446 */
AnnaBridge 171:3a7713b1edbc 447 int RTC_SetTrim(uint32_t trim, uint8_t trimSlow);
AnnaBridge 171:3a7713b1edbc 448
AnnaBridge 171:3a7713b1edbc 449 /**
AnnaBridge 171:3a7713b1edbc 450 * @brief Gets the current trim value.
AnnaBridge 171:3a7713b1edbc 451 * @note Ensure RTC is disabled prior to calling this function, see RTC_Stop(void).
AnnaBridge 171:3a7713b1edbc 452 *
AnnaBridge 171:3a7713b1edbc 453 * @retval uint32_t Current trim value of RTC.
AnnaBridge 171:3a7713b1edbc 454 */
AnnaBridge 171:3a7713b1edbc 455 uint32_t RTC_GetTrim(void);
AnnaBridge 171:3a7713b1edbc 456
AnnaBridge 171:3a7713b1edbc 457 /**
AnnaBridge 171:3a7713b1edbc 458 * @brief Enable the trim.
AnnaBridge 171:3a7713b1edbc 459 * @warning The RTC must be disabled prior to calling this function, see RTC_Stop(void) to disable the RTC.
AnnaBridge 171:3a7713b1edbc 460 * @retval #E_NO_ERROR Trim is enabled.
AnnaBridge 171:3a7713b1edbc 461 * @retval #E_INVALID RTC is active, see RTC_Stop(void).
AnnaBridge 171:3a7713b1edbc 462 */
AnnaBridge 171:3a7713b1edbc 463 int RTC_TrimEnable(void);
AnnaBridge 171:3a7713b1edbc 464
AnnaBridge 171:3a7713b1edbc 465 /**
AnnaBridge 171:3a7713b1edbc 466 * @brief Disable the trim.
AnnaBridge 171:3a7713b1edbc 467 */
AnnaBridge 171:3a7713b1edbc 468 void RTC_TrimDisable(void);
AnnaBridge 171:3a7713b1edbc 469
AnnaBridge 171:3a7713b1edbc 470 /**@}*/
AnnaBridge 171:3a7713b1edbc 471
AnnaBridge 171:3a7713b1edbc 472 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 473 }
AnnaBridge 171:3a7713b1edbc 474 #endif
AnnaBridge 171:3a7713b1edbc 475
AnnaBridge 171:3a7713b1edbc 476 #endif /* _RTC_H */